dsl_maker 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a60b85736172ba9bfbd06b14f39a8d0163bd6cf1
-  data.tar.gz: 32d6433a84322447e8104e921c9a47e354a60f11
+  metadata.gz: 2f42b67736e6299fee74ad059d995f9f0e9e71dc
+  data.tar.gz: cc54596f31ec4278eb33c5a11d504b1774556634
 SHA512:
-  metadata.gz: e99238cb102708130d8ea95967c5acf0764988b9db5123e395f67a9f3213c8cdff94e7807d835884d6e9efb07af931a708bd69fdc9c3d66ae5e384a8543a62cb
-  data.tar.gz: 233cd1b86c6a0cee61a04ade5f947aa2b78ee35a69d14750bf4fb020f3137d5d8854548110d6483650ee9cb4d570f61be4b1999764fe6a84b0888e45f1bb0d43
+  metadata.gz: ffe540380885b22fd3dc7a7d118ada0ae1ac958502619cbbea19f2c42b2546ccd60e9147a3475dc58d83c2b69982c87f08a7e6251ea172b141b7bf5bcda6e007
+  data.tar.gz: a0950aa163fe8b9c8b41b311c85ee369c229bd32099f6ce742a2e7f62f3b954effefcbfc7a90777287dc67ea84a482951dd5672a567cfb3d3ae10ad845dc6556

data/Changes

@@ -1,16 +1,20 @@
 Revision history for DSL::Maker (ordered by revision number).
 
-0.0.6 Aug ?? 2015
-   - Added add_verification(name?) to allow for runtime verifications
+0.0.7 Aug 06 2015
+   - Added the 'Any' type coercion.
+   - Added a TL;DR section at the top of the README.
+
+0.0.6 Aug 03 2015
+   - Added add_verification(name) to allow for runtime verifications
    - Don't require a dummy block when passing a DSL class to add_entrypoint.
    - Refactored several items into private methods
    - Pulled the provided types and helpers out of the class definition
 
 0.0.5 Jul 30 2015
    - Added missing YaRDOC for new features in 0.0.4
-   - Added add_coercion() to allow the user to define new coercions for use when
+   - Added add_type() to allow the user to define new type coercions for use when
      creating their DSL.
-   - Eat our own dogfood vis-a-vis helpers and coercions.
+   - Eat our own dogfood vis-a-vis helpers and type coercions.
 
 0.0.4 Jul 29 2015
    - Added add_helper() to allow the user to define new helper methods for use

data/README.md

@@ -9,6 +9,83 @@
 [![Code Coverage](https://img.shields.io/codecov/c/github/robkinyon/ruby-dsl-maker.svg)](https://codecov.io/github/robkinyon/ruby-dsl-maker)
 [![Inline docs](http://inch-ci.org/github/robkinyon/ruby-dsl-maker.png)](http://inch-ci.org/github/robkinyon/ruby-dsl-maker)
 
+## TL;DR
+
+```ruby
+require 'dsl/maker'
+
+Car = Struct.new(:maker, :engine)
+Engine = Struct.new(:is_hemi)
+Truck = Struct.new(:maker, :engine, :towing)
+
+class Vehicle::DSL < DSL::Maker
+  dsl_engine = generate_dsl({
+    :hemi => Boolean,
+  }) do
+    Engine.new(hemi)
+  end
+
+  add_entrypoint(:car, {
+    :maker => String,
+    :engine => dsl_engine,
+  }) do |*args|
+    default(maker, args, 0)
+    Car.new(maker, engine)
+  end
+
+  add_entrypoint(:truck, {
+    :maker => String,
+    :towing => Integer,
+    :engine => dsl_engine,
+  }) do |*args|
+    default(maker, args, 0)
+    Truck.new(maker, engine, towing)
+  end
+
+  add_verification(:car) do |item|
+    return "Cars need engines" unless item.engine
+  end
+  add_verification(:truck) do |item|
+    return "Trucks need engines" unless item.engine
+    return "Trucks aren't wimps" unless item.towing > 1000
+  end
+end
+```
+
+Then, use it as so:
+
+```ruby
+#!/usr/bin/env ruby
+
+require ‘vehicle/dsl’
+
+filename = ARGV.shift || raise “No filename provided.”
+
+# This raises the error
+vehicles = Vehicle::DSL.parse_dsl(
+  IO.read(filename),
+)
+```
+
+with a file that could look like:
+
+```ruby
+car do
+  make 'Honda Civic'
+  engine {
+    hemi no
+  }
+end
+
+truck 'Ford F-150' do
+  engine {
+    hemi On
+  }
+end
+```
+
+## Rationale
+
 Writing single-level Ruby-like DSLs is really easy. Ruby practically builds them
 for you with a little meta-programming. [Docile](https://github.com/ms-ati/docile)
 makes it ridiculously easy and there are nearly a dozen other modules to do so.
@@ -327,6 +404,7 @@ were encountered.
 
 There are four pre-defined type coercions for use within `generate_dsl()`:
 
+  * Any - This takes whatever you give it and returns it back.
   * String - This takes whatever you give it and returns the string within it.
   * Integer - This takes whatever you give it and returns the integer within it.
   * Boolean - This takes whatever you give it and returns the truthiness of it.
@@ -358,8 +436,6 @@ $ gem install dsl_maker
 * Add support for auto-generating documentation
 * Add default block that returns a Struct-of-Structs named after entrypoints
 * Add example of binary to execute a DSL
-* Add example of/link to validation and production of data structure
-   * 3-part DSL handling
 * DSL for DSL construction
 * Add "include" helper that loads another file and continues the execution
    * Should provide useful directory searching
@@ -376,10 +452,11 @@ Works on [all ruby versions since 1.9.3](https://github.com/robkinyon/ruby-dsl-m
 
 ## Note on Patches/Pull Requests
 
-  * Fork the project.
+  * Fork the project on GitHub.
   * Setup your development environment with:
       `gem install bundler; bundle install`
   * Make your feature addition or bug fix in a branch.
+    * I will only accept PRs from branches, never master.
   * Add tests for it. This is important so I don't break it in a future version
       unintentionally. Plus, I maintain 100% code coverage.
   * Commit.

data/lib/dsl/maker/version.rb

@@ -1,6 +1,6 @@
 module DSL
   class Maker
     # The current version of this library
-    VERSION = '0.0.6'
+    VERSION = '0.0.7'
   end
 end

data/lib/dsl/maker.rb

@@ -13,6 +13,9 @@ class DSL::Maker
     alias :___get :instance_variable_get
   end
 
+  # Create the DSL::Maker::Any type identifier
+  Any = nil
+
   # This is a useful module that contains all the Boolean handling we need.
   module Boolean
     {
@@ -320,6 +323,10 @@ end
 
 # These are the default setups.
 
+DSL::Maker.add_type(DSL::Maker::Any) do |attr, *args|
+  ___set(attr, args[0]) unless args.empty?
+  ___get(attr)
+end
 DSL::Maker.add_type(Integer) do |attr, *args|
   ___set(attr, args[0].to_i) unless args.empty?
   ___get(attr)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsl_maker
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Rob Kinyon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-03 00:00:00.000000000 Z
+date: 2015-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile