dsl_maker 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0338de58f7a2ecf13d08d203c4682bde172292f5
-  data.tar.gz: cc00e4a818b4aeb8b84841874878cd0851611703
+  metadata.gz: 99ee47867d6b31ded1c99a54a01aa793a61592f3
+  data.tar.gz: 5e11770909897a850465398142d13ea52e533f54
 SHA512:
-  metadata.gz: 5b272b83ae0a2485dbe1890172fbf03ac7cf4885cfd97d21b853008f7cbd30c930b2f7734f1ec886c5d2924e46fc41bc1853bccec8223997e7f9af9bd45f8e0a
-  data.tar.gz: 1cf59abb5d74f12358e234dde90d072348b938e993ab0884487a0715215ab15a5909abc17b11b0954035e81fe32edd11d2ad872dbb17dbd8fdc8aeadcc94b16b
+  metadata.gz: 9106d1d87a86d23e4eccb86b39d4a972e413cf3ce1dd7c469f36889de039f4162494da84abc0a5247312f61e64ca2c1b5b33e5ac694e3428d8640771d8de6504
+  data.tar.gz: 9e1084f369c61cc4029b90ff76a555f17203b3c52913d5aaca1168b93f7725d1b8f2696170b12047e12fb936a7dc24acb0cf8e2ad24688493249a3b17db03b7e

data/Changes

@@ -1,5 +1,10 @@
 Revision history for DSL::Maker (ordered by revision number).
 
+0.1.0 Aug 11 2015
+   BREAKING CHANGE:
+   - parse_dsl() and execute_dsl() now always return an array, even if there is
+     only one value. This simplifies code to handle error cases.
+
 0.0.9 Aug 11 2015
    - Added the ArrayOf[<type>] type to allow for arrays to concatenate properly.
    - Added the AliasOf(<name>) type to allow for use of multiple names to refer to

data/README.md

@@ -158,7 +158,7 @@ class PizzaBuilder < DSL::Maker
   end
 end
 
-pizza = PizzaBuilder.parse_dsl("
+pizzas = PizzaBuilder.parse_dsl("
   pizza {
     cheese yes
     pepperoni Yes
@@ -199,7 +199,7 @@ class FamilyTree < DSL::Maker
   end
 end
 
-john_smith = FamilyTree.parse_dsl("
+people = FamilyTree.parse_dsl("
   person {
     name 'John Smith'
     mother {
@@ -210,6 +210,7 @@ john_smith = FamilyTree.parse_dsl("
     }
   }
 ")
+john_smith = people[0]
 ```
 
 Pretty easy. We can even refactor that a bit and end up with:
@@ -261,7 +262,7 @@ class FamilyTreeDSL < DSL::Maker
   end
 end
 
-john_smith = FamilyTreeDSL.parse_dsl("
+people = FamilyTreeDSL.parse_dsl("
   person 'John Smith' do
     age 20
     mother 'Mary Smith' do
@@ -273,6 +274,7 @@ john_smith = FamilyTreeDSL.parse_dsl("
     }
   end
 ")
+john_smith = people[0]
 ```
 
 The result is exactly the same as before.
@@ -304,8 +306,10 @@ Now, we can handle an arbitrarily-deep family tree.
 
 ### Handling multiple items
 
-Chef's recipe files have many entries of different types in them. It doesn't do
-you any good if you can't do the same thing.
+You'll note we've been receiving an Array from `parse_dsl()`. This is because 
+DSL::Maker automagically handles files with multiple entries. Chef's recipe files
+have many entries of different types in them. It doesn't do you any good if you
+can't do the same thing.
 
 ```ruby
 Car = Struct.new(:make, :model)
@@ -341,8 +345,8 @@ vehicles = VehicleDSL.parse_dsl("
 ```
 
 `vehicles` is an `Array` with a `Car` and a `Truck` in it, in that order. If your
-DSL snippet has only one item, you get back that item. If it has multiple items,
-you get back an `Array` with everything in the right order.
+DSL snippet has only one item, you get back an Array with just that item. If it
+has multiple items, you get back an `Array` with everything in the right order.
 
 ## API
 
@@ -394,11 +398,12 @@ This creates global helpers that are available at every level of your DSLs.
 * `parse_dsl(String)` / `execute_dsl(&block)`
 
 You call this on your DSL class when you're ready to invoke your DSL. It will
-return whatever the block provided to `add_entrypoint()` returns.
+return an array containing whatever the block provided to `add_entrypoint()`
+returns.
 
-In the case of multiple DSL entrypoints (for example, a normal Chef recipe),
-these methods will return an array with all the return values in the order they
-were encountered.
+It returns an array for the case of multiple DSL entrypoints (for example, a
+normal Chef recipe). The array will contain the values in the order they were
+encountered.
 
 ### Type Coercions
 
@@ -444,7 +449,6 @@ $ gem install dsl_maker
 
 ## TODO
 
-* Add support for Arrays (ArrayOf[Type]?)
 * Add support for generating useful errors (ideally with line numbers ... ?)
 * Add support for auto-generating documentation
 * Add default block that returns a Struct-of-Structs named after entrypoints

data/lib/dsl/maker.rb

@@ -109,7 +109,7 @@ class DSL::Maker
     raise 'Must call add_entrypoint before parse_dsl' unless @klass
     raise 'String required for parse_dsl' unless dsl.instance_of? String
 
-    run_dsl() { eval dsl, @klass.new.get_binding }
+    run_dsl { eval dsl, @klass.new.get_binding }
   end
 
   # Execute the DSL provided in the block.
@@ -124,7 +124,7 @@ class DSL::Maker
     raise 'Must call add_entrypoint before execute_dsl' unless @klass
     raise 'Block required for execute_dsl' unless block_given?
 
-    run_dsl() { @klass.new.instance_eval(&block) }
+    run_dsl { @klass.new.instance_eval(&block) }
   end
 
   # This adds a type coercion that's used when creating the DSL.
@@ -416,9 +416,6 @@ class DSL::Maker
 
     yield
 
-    if @accumulator.length <= 1
-      return @accumulator[0]
-    end
     return @accumulator
   end
 

data/lib/dsl/maker/version.rb

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

data/spec/alias_type_spec.rb

@@ -22,7 +22,7 @@ describe "Packager DSL AliasOf" do
     pizza = dsl_class.execute_dsl {
       pizza { cheese yes }
     }
-    verify_pizza(pizza, :cheese => true)
+    verify_pizza(pizza[0], :cheese => true)
   end
 
   it "can alias multiple times" do
@@ -39,7 +39,7 @@ describe "Packager DSL AliasOf" do
     pizza = dsl_class.execute_dsl {
       pizza { fromage yes }
     }
-    verify_pizza(pizza, :cheese => true)
+    verify_pizza(pizza[0], :cheese => true)
   end
 
   it "can have many different aliases" do
@@ -60,7 +60,7 @@ describe "Packager DSL AliasOf" do
         bacon yes
       }
     }
-    verify_pizza(pizza, :cheese => true, :bacon => true)
+    verify_pizza(pizza[0], :cheese => true, :bacon => true)
   end
 
   it "can alias a DSL" do
@@ -86,6 +86,6 @@ describe "Packager DSL AliasOf" do
         }
       }
     }
-    verify_pizza(pizza, :cheese => Structs::Cheese.new('mozzarrella', 'white'))
+    verify_pizza(pizza[0], :cheese => Structs::Cheese.new('mozzarrella', 'white'))
   end
 end

data/spec/args_spec.rb

@@ -16,7 +16,7 @@ describe "A DSL with argument handling describing fruit" do
     it "can handle nil" do
       fruit = dsl_class.parse_dsl("
         fruit {}
-      ")
+      ")[0]
       expect(fruit).to be_instance_of(Structs::Fruit)
       expect(fruit.name).to be_nil
     end
@@ -24,7 +24,7 @@ describe "A DSL with argument handling describing fruit" do
     it "can handle the name in the attribute" do
       fruit = dsl_class.parse_dsl("
         fruit { name 'banana' }
-      ")
+      ")[0]
       expect(fruit).to be_instance_of(Structs::Fruit)
       expect(fruit.name).to eq('banana')
     end
@@ -32,7 +32,7 @@ describe "A DSL with argument handling describing fruit" do
     it "can handle the name in the args" do
       fruit = dsl_class.parse_dsl("
         fruit 'banana'
-      ")
+      ")[0]
       expect(fruit).to be_instance_of(Structs::Fruit)
       expect(fruit.name).to eq('banana')
     end
@@ -43,7 +43,7 @@ describe "A DSL with argument handling describing fruit" do
         fruit 'buh-nana!' do
           name 'banana'
         end
-      ")
+      ")[0]
       expect(fruit).to be_instance_of(Structs::Fruit)
       expect(fruit.name).to eq('banana')
     end
@@ -67,7 +67,7 @@ describe "A DSL with argument handling describing fruit" do
     it "can handle no arguments" do
       fruit = dsl_class.parse_dsl("
         fruit {}
-      ")
+      ")[0]
       expect(fruit).to be_instance_of(Structs::Fruit)
       expect(fruit.name).to be_nil
       expect(fruit.color).to be_nil
@@ -79,7 +79,7 @@ describe "A DSL with argument handling describing fruit" do
         fruit('banana') {
           color 'yellow'
         }
-      ")
+      ")[0]
       expect(fruit).to be_instance_of(Structs::Fruit)
       expect(fruit.name).to eq('banana')
       expect(fruit.color).to eq('yellow')
@@ -89,7 +89,7 @@ describe "A DSL with argument handling describing fruit" do
         fruit 'plantain' do
           color 'green'
         end
-      ")
+      ")[0]
       expect(fruit).to be_instance_of(Structs::Fruit)
       expect(fruit.name).to eq('plantain')
       expect(fruit.color).to eq('green')
@@ -98,7 +98,7 @@ describe "A DSL with argument handling describing fruit" do
     it "can handle everything in the args" do
       fruit = dsl_class.parse_dsl("
         fruit 'banana', 'yellow'
-      ")
+      ")[0]
       expect(fruit).to be_instance_of(Structs::Fruit)
       expect(fruit.name).to eq('banana')
       expect(fruit.color).to eq('yellow')
@@ -130,7 +130,7 @@ describe "A DSL with argument handling describing fruit" do
             name 'yellow'
           }
         end
-      ")
+      ")[0]
       expect(fruit).to be_instance_of(Structs::Fruit)
       expect(fruit.name).to eq('banana')
       expect(fruit.color).to be_instance_of(Structs::Color)
@@ -142,7 +142,7 @@ describe "A DSL with argument handling describing fruit" do
         fruit 'banana' do
           color 'yellow'
         end
-      ")
+      ")[0]
       expect(fruit).to be_instance_of(Structs::Fruit)
       expect(fruit.name).to eq('banana')
       expect(fruit.color).to be_instance_of(Structs::Color)
@@ -156,7 +156,7 @@ describe "A DSL with argument handling describing fruit" do
             name 'green'
           end
         end
-      ")
+      ")[0]
       expect(fruit).to be_instance_of(Structs::Fruit)
       expect(fruit.name).to eq('banana')
       expect(fruit.color).to be_instance_of(Structs::Color)

data/spec/array_type_spec.rb

@@ -23,14 +23,14 @@ describe "Packager DSL ArrayOf" do
         cheeses 'mozzarrella'
       }
     }
-    verify_pizza(pizza, :cheese => %w(cheddar mozzarrella))
+    verify_pizza(pizza[0], :cheese => %w(cheddar mozzarrella))
 
     pizza = dsl_class.execute_dsl {
       pizza {
         cheeses 'cheddar', 'mozzarrella'
       }
     }
-    verify_pizza(pizza, :cheese => %w(cheddar mozzarrella))
+    verify_pizza(pizza[0], :cheese => %w(cheddar mozzarrella))
   end
 
   it "can array a DSL" do
@@ -62,7 +62,7 @@ describe "Packager DSL ArrayOf" do
         }
       }
     }
-    verify_pizza(pizza, :cheese => [
+    verify_pizza(pizza[0], :cheese => [
       Structs::Cheese.new('mozzarrella', 'white'),
       Structs::Cheese.new('cheddar', 'orange'),
     ])
@@ -127,7 +127,7 @@ describe "Packager DSL ArrayOf" do
         end
       }
     }
-    verify_pizza(pizza, :cheese => [
+    verify_pizza(pizza[0], :cheese => [
       Structs::Cheese.new('mozzarrella', 'white'),
       Structs::Cheese.new('cheddar', 'orange'),
     ])

data/spec/class_as_subdsl_spec.rb

@@ -29,7 +29,7 @@ describe "Passing a class into generate_dsl" do
           size 26
         end
       end
-    end
+    end[0]
     expect(car).to be_instance_of(Structs::Car)
     expect(car.maker).to eq('honda')
     expect(car.wheel).to be_instance_of(Structs::Wheel)
@@ -70,7 +70,7 @@ describe "Passing a class into generate_dsl" do
           size 26
         end
       end
-    end
+    end[0]
     expect(car).to be_instance_of(Structs::Car)
     expect(car.maker).to eq('honda')
     expect(car.wheel).to be_instance_of(Structs::Wheel)

data/spec/helper_spec.rb

@@ -18,7 +18,7 @@ describe "A DSL with helpers" do
       car {
         maker transform('Honda')
       }
-    ")
+    ")[0]
     expect(car).to be_instance_of(Structs::Car)
     expect(car.maker).to eq('HONDA')
   end
@@ -51,7 +51,7 @@ describe "A DSL with helpers" do
           maker transform2('goodyear')
         }
       }
-    ")
+    ")[0]
     expect(car).to be_instance_of(Structs::Car)
     expect(car.maker).to eq('Honda')
     expect(car.wheel).to be_instance_of(Structs::Wheel)

data/spec/multi_level_spec.rb

@@ -18,7 +18,7 @@ describe 'A multi-level DSL making family-trees' do
       end
     end
 
-    person = dsl_class.parse_dsl('person { name "Tom" }')
+    person = dsl_class.parse_dsl('person { name "Tom" }')[0]
     expect(person).to be_instance_of(Structs::Person)
     expect(person.name).to eq('Tom')
     expect(person.child).to be_nil
@@ -45,7 +45,7 @@ describe 'A multi-level DSL making family-trees' do
           name 'Bill'
         }
       }
-    ")
+    ")[0]
     expect(person).to be_instance_of(Structs::Person)
     expect(person.name).to eq('Tom')
     expect(person.child).to be_instance_of(Structs::Person)
@@ -81,7 +81,7 @@ describe 'A multi-level DSL making family-trees' do
           }
         }
       }
-    ")
+    ")[0]
     expect(person).to be_instance_of(Structs::Person)
     expect(person.name).to eq('Tom')
     expect(person.child).to be_instance_of(Structs::Person)
@@ -137,7 +137,7 @@ describe 'A multi-level DSL making family-trees' do
             }
           }
         }
-      ")
+      ")[0]
 
       [
         'Adam', 'Seth', 'Enos', 'Cainan', 'Mahalaleel', 'Jared',
@@ -170,7 +170,7 @@ describe 'A multi-level DSL making family-trees' do
             name 'Tom Smith'
           }
         }
-      ")
+      ")[0]
 
       expect(person).to be_instance_of(Structs::OtherPerson)
       expect(person.name).to eq('John Smith')

data/spec/single_level_spec.rb

@@ -28,7 +28,7 @@ describe 'A single-level DSL for pizza' do
       end
 
       pizza = dsl_class.parse_dsl('')
-      expect(pizza).to be(nil)
+      expect(pizza[0]).to be(nil)
     end
 
     it 'with :execute_dsl' do
@@ -39,7 +39,7 @@ describe 'A single-level DSL for pizza' do
       end
 
       pizza = dsl_class.execute_dsl {}
-      expect(pizza).to be(nil)
+      expect(pizza[0]).to be(nil)
     end
   end
 
@@ -51,7 +51,7 @@ describe 'A single-level DSL for pizza' do
     end
 
     pizza = dsl_class.parse_dsl('pizza {}')
-    verify_pizza(pizza)
+    verify_pizza(pizza[0])
   end
 
   # This tests all the possible Boolean invocations
@@ -68,39 +68,39 @@ describe 'A single-level DSL for pizza' do
     # retrieve the value from within the DSL. Therefore, we assume it's a getter
     # and don't default the value to true. Otherwise, false values wouldn't work.
     pizza = dsl_class.parse_dsl('pizza { cheese }')
-    verify_pizza(pizza, :cheese => false)
+    verify_pizza(pizza[0], :cheese => false)
 
     # Test the Ruby booleans and falsey's.
     [ true, false, nil ].each do |cheese|
       pizza = dsl_class.parse_dsl("pizza { cheese #{cheese} }")
-      verify_pizza(pizza, :cheese => !!cheese)
+      verify_pizza(pizza[0], :cheese => !!cheese)
     end
 
     # Test the true values we provide
     %w(Yes On True yes on).each do |cheese|
       pizza = dsl_class.parse_dsl("pizza { cheese #{cheese} }")
-      verify_pizza(pizza, :cheese => true)
+      verify_pizza(pizza[0], :cheese => true)
     end
 
     # Test the false values we provide
     %w(No Off False no off).each do |cheese|
       pizza = dsl_class.parse_dsl("pizza { cheese #{cheese} }")
-      verify_pizza(pizza, :cheese => false)
+      verify_pizza(pizza[0], :cheese => false)
     end
 
     # Test the boolean-ized strings we provide
     %w(Yes On True yes on true).each do |cheese|
       pizza = dsl_class.parse_dsl("pizza { cheese '#{cheese}' }")
-      verify_pizza(pizza, :cheese => true)
+      verify_pizza(pizza[0], :cheese => true)
     end
     %w(No Off False no off false nil).each do |cheese|
       pizza = dsl_class.parse_dsl("pizza { cheese '#{cheese}' }")
-      verify_pizza(pizza, :cheese => false)
+      verify_pizza(pizza[0], :cheese => false)
     end
 
     # Test some other things which should all be true
     pizza = dsl_class.parse_dsl("pizza { cheese 5 }")
-    verify_pizza(pizza, :cheese => true)
+    verify_pizza(pizza[0], :cheese => true)
   end
 
   it 'makes a saucy pizza' do
@@ -121,7 +121,7 @@ describe 'A single-level DSL for pizza' do
         else
           raise "Unexpected class #{level.class}"
       end
-      verify_pizza(pizza, :sauce => level.to_s)
+      verify_pizza(pizza[0], :sauce => level.to_s)
     end
   end
 
@@ -147,7 +147,7 @@ describe 'A single-level DSL for pizza' do
         sauce :extra
       }
     ")
-    verify_pizza(pizza,
+    verify_pizza(pizza[0],
       :sauce => 'extra',
       :pepperoni => true,
       :bacon => false,
@@ -177,7 +177,7 @@ describe 'A single-level DSL for pizza' do
         sauce :extra
       }
     end
-    verify_pizza(pizza,
+    verify_pizza(pizza[0],
       :sauce => 'extra',
       :pepperoni => true,
       :bacon => false,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dsl_maker
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Rob Kinyon