Repository is archived
No commit activity in last 3 years
No release in over 3 years
Hecks JSON Schema Validations
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

Code Climate Test Coverage Gem Version

Hecks

Use Hecks to build scalable software that matches the language of your business.

Hecks standardizes the creation of domains in code so that generalized solutions can be developed to adapt to both drive and receive data from business domains. Hecks describes domains using a small subset of the patterns described in the blue book.

Usage

PizzaBuilder is an ridiculously simplified application built using Hecks. We'll use PizzaBuilder as an example for building a domain model standing up a resource server.

Install

$ gem install hecks
$ hecks help

hecks commands:
hecks console         # REPL with domain helpers
hecks generate        # generate
hecks help [COMMAND]  # Describe available commands or one specific command
hecks new             # Create a new Domain

Create a HECKS file in an empty project directory:

HecksDomainBuilder.build "pizza_builder" do |pizza_builder|
	pizza_builder.module 'Pizzas' do |pizzas|
	  pizzas.head("Pizza").attributes('name:string', 'description:string', 'toppings:[topping]')
	  pizzas.value("Topping").attributes('name:string')
	end

	pizza_builder.module 'Orders' do |orders|
	  orders.head("Order").attributes('line_items:[LineItem]')
	  orders.value("LineItem").attributes('pizza_name:value', 'quantity:Value', 'price:Value')
	end
end

Now just run this command in the same directory as the HECKS file $ hecks new

You should see a bunch of output as hecks builds the Objects that you'll use to interact with the domain.

Resource Server

$ hecks generate:resource_server
$ rackup config.ru
$ curl -H "Content-Type: application/json" -d '{"name": "white", "description":"yummy", "toppings": [{"name":"pepperoni"}]}' localhost:9292/pizzas

Ruby Console

Move into your domain's directory (the one creared with hecks new)

$ hecks console
:001 > pp app[:pizzas].create({name: 'White Pizza' ... }]})

Contribute to Hecks

Here are some commands that will be helpful if you would like to develop new features for Hecks

$ hecks build # Builds and installs the hecks gem locally
$ hecks test ci # run the full test suite for continuous integration
$ rspec # run the spec suite (fast)