dsl_maker 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd8b809906f6bde7d8b1839095dc2ad018148190
-  data.tar.gz: 13708d81d5f96de3f5744736c77f4b55ef2d5748
+  metadata.gz: 0338de58f7a2ecf13d08d203c4682bde172292f5
+  data.tar.gz: cc00e4a818b4aeb8b84841874878cd0851611703
 SHA512:
-  metadata.gz: d0c2f6464bc5d08693a7298dae3074c9f89f00c9f2959bb1366b86a5cfdf211bc6fc779c045cb111fd04f0e0e7aff1aa8304ccd895d084fa32119e4fdba7c951
-  data.tar.gz: c9ecc30fba1b36b6c6aac878de49a6191df39180ef05dd96996a411e82c5c52e44ef202254ba08736755e95fe9d8df3fba94ad512adc51ddc6d139d96f1a987a
+  metadata.gz: 5b272b83ae0a2485dbe1890172fbf03ac7cf4885cfd97d21b853008f7cbd30c930b2f7734f1ec886c5d2924e46fc41bc1853bccec8223997e7f9af9bd45f8e0a
+  data.tar.gz: 1cf59abb5d74f12358e234dde90d072348b938e993ab0884487a0715215ab15a5909abc17b11b0954035e81fe32edd11d2ad872dbb17dbd8fdc8aeadcc94b16b

data/Changes

@@ -1,5 +1,10 @@
 Revision history for DSL::Maker (ordered by revision number).
 
+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
+     the same thing.
+
 0.0.8 Aug 07 2015
    - Make sure to provide a unique value for each type name.
       - Allow 'Object' to be used as an alias for 'Any'

data/README.md

@@ -402,15 +402,28 @@ were encountered.
 
 ### Type Coercions
 
-There are four pre-defined type coercions for use within `generate_dsl()`:
+There are four pre-defined standard type coercions available for `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.
-  * `generate_dsl()` - This descends into another level of DSL.
+  Standard coercions:
+    * 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.
 
-You can add additional type coercions using `add_type()` as described above.
+You can add additional standard type coercions using `add_type()` as described
+above.
+
+There are also three special type coercions that are not creatable with
+`add_type()` because they do special manipulations within DSL::Maker.
+
+  Special coercions:
+    * `generate_dsl()` - This descends into another level of DSL.
+    * ArrayOf[<type>] - This creates an array coerced as the <type>. Successive
+      invocations are concatenated. <type> can be a DSL.
+    * AliasOf(<name>) - this creates an additional name that is synonomous with
+      the <name> item. You can use either this name or <name>.
+
+These are special-cased within `build_dsl_element()`.
 
 ### Helpers
 

data/lib/dsl/maker.rb

@@ -65,6 +65,38 @@ class DSL::Maker
   Yes = On = True = true
   No = Off = False = false
 
+  class Alias
+    attr_reader :real_name
+    def initialize(real_name)
+      @real_name = real_name
+    end
+  end
+  @@aliases = {}
+  def self.AliasOf(name)
+    @@aliases[name] ||= Alias.new(name)
+  end
+  def self.is_alias(type)
+    type.instance_of? Alias
+  end
+
+  class ArrayType
+    attr_reader :base_type
+    def initialize(base_type)
+      @base_type = base_type
+    end
+  end
+  @@arrays = {}
+  ArrayOf = Class.new do
+    def self.[](type)
+      raise "Cannot make an array of an alias" if DSL::Maker.is_alias(type)
+      raise "Unknown type provided to ArrayOf" unless @@types.has_key?(type) || DSL::Maker.is_dsl(type)
+      @@arrays[type] ||= ArrayType.new(type)
+    end
+  end
+  def self.is_array(type)
+    type.instance_of? ArrayType
+  end
+
   # Parse the DSL provided in the parameter.
   #
   # @note If the DSL contains multiple entrypoints, then this will return an
@@ -114,13 +146,7 @@ class DSL::Maker
     raise "Block required for add_type" unless block_given?
     raise "'#{type}' is already a type coercion" if @@types.has_key? type
 
-    @@types[type] = ->(klass, name, type) {
-      klass.class_eval do
-        define_method(name.to_sym) do |*args|
-          instance_exec('@' + name.to_s, *args, &block)
-        end
-      end
-    }
+    @@types[type] = block
 
     return
   end
@@ -290,6 +316,8 @@ class DSL::Maker
   #   * Integer - the integer value of whatever you give is returned.
   #   * Boolean - the truthiness of whatever you give is returned.
   #   * generate_dsl() - this represents a new level of the DSL.
+  #   * AliasOf(<name>) - this aliases a name to another name.
+  #   * ArrayOf[<type>] - this creates an array of the <type> coercion.
   #
   # @param klass [Class]  The class representing this level in the DSL.
   # @param name  [String] The name of the element we're working on.
@@ -299,7 +327,11 @@ class DSL::Maker
   # @return   nil
   def self.build_dsl_element(klass, name, type)
     if @@types.has_key?(type)
-      @@types[type].call(klass, name, type)
+      klass.class_eval do
+        define_method(name.to_sym) do |*args|
+          instance_exec('@' + name.to_s, *args, &@@types[type])
+        end
+      end
     elsif is_dsl(type)
       as_attr = '@' + name.to_s
       klass.class_eval do
@@ -329,6 +361,46 @@ class DSL::Maker
           ___get(as_attr)
         end
       end
+    elsif is_alias(type)
+      klass.class_eval do
+        alias_method name, type.real_name
+      end
+    elsif is_array(type)
+      as_attr = '@' + name.to_s
+
+      klass.class_eval do
+        define_method(name.to_sym) do |*args, &dsl_block|
+          rv = ___get(as_attr)
+          ___set(as_attr, rv = []) unless rv
+
+          if dsl_block
+            # This code is copy-pasted from the is_dsl() section above. Figure out
+            # how to hoist this code into something reusable. But, we don't need
+            # the parent_class section (do we?)
+            obj = type.base_type.new
+            Docile.dsl_eval(obj, &dsl_block)
+            dsl_value = obj.__apply(*args)
+
+            if v = type.base_type.instance_variable_get(:@verifications)
+              v.each do |verify|
+                failure = verify.call(dsl_value)
+                raise failure if failure
+              end
+            end
+
+            rv.push(dsl_value)
+          elsif !args.empty?
+            rv.concat(
+              args.map do |item|
+                # Assumption: 10x_ will never be used as an attribute name.
+                klass.new.instance_exec('@__________', item, &@@types[type.base_type])
+              end
+            )
+          end
+
+          rv
+        end
+      end
     else
       raise "Unrecognized element type '#{type}'"
     end
@@ -356,7 +428,6 @@ class DSL::Maker
 
   def self.is_entrypoint(name)
     @entrypoints && @entrypoints.has_key?(name.to_sym)
-    #@klass && @klass.new.respond_to?(name.to_sym)
   end
 end
 

data/lib/dsl/maker/version.rb

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

data/spec/alias_type_spec.rb

@@ -0,0 +1,91 @@
+# This is to test the AliasOf(:name) type
+
+describe "Packager DSL AliasOf" do
+  # This uses $toppings defined in spec/spec_helper.rb
+  def verify_pizza(pizza, values={})
+    expect(pizza).to be_instance_of(Structs::Pizza)
+    $toppings.each do |topping|
+      expect(pizza.send(topping)).to eq(values[topping])
+    end
+  end
+
+  it "can alias a Boolean" do
+    dsl_class = Class.new(DSL::Maker) do
+      add_entrypoint(:pizza, {
+        :cheese => DSL::Maker::Boolean,
+        :cheeseyness => DSL::Maker::AliasOf(:cheese),
+      }) {
+        Structs::Pizza.new(cheeseyness)
+      }
+    end
+
+    pizza = dsl_class.execute_dsl {
+      pizza { cheese yes }
+    }
+    verify_pizza(pizza, :cheese => true)
+  end
+
+  it "can alias multiple times" do
+    dsl_class = Class.new(DSL::Maker) do
+      add_entrypoint(:pizza, {
+        :cheese => DSL::Maker::Boolean,
+        :cheeseyness => DSL::Maker::AliasOf(:cheese),
+        :fromage => DSL::Maker::AliasOf(:cheese),
+      }) {
+        Structs::Pizza.new(cheeseyness)
+      }
+    end
+
+    pizza = dsl_class.execute_dsl {
+      pizza { fromage yes }
+    }
+    verify_pizza(pizza, :cheese => true)
+  end
+
+  it "can have many different aliases" do
+    dsl_class = Class.new(DSL::Maker) do
+      add_entrypoint(:pizza, {
+        :cheese => DSL::Maker::Boolean,
+        :fromage => DSL::Maker::AliasOf(:cheese),
+        :bacon => DSL::Maker::Boolean,
+        :panceta => DSL::Maker::AliasOf(:bacon),
+      }) {
+        Structs::Pizza.new(fromage, nil, panceta)
+      }
+    end
+
+    pizza = dsl_class.execute_dsl {
+      pizza {
+        cheese yes
+        bacon yes
+      }
+    }
+    verify_pizza(pizza, :cheese => true, :bacon => true)
+  end
+
+  it "can alias a DSL" do
+    dsl_class = Class.new(DSL::Maker) do
+      add_entrypoint(:pizza, {
+        :cheese => generate_dsl({
+          :type => String,
+          :color => String,
+        }) do
+          Structs::Cheese.new(type, color)
+        end,
+        :cheeseyness => DSL::Maker::AliasOf(:cheese)
+      }) {
+        Structs::Pizza.new(cheeseyness)
+      }
+    end
+
+    pizza = dsl_class.execute_dsl {
+      pizza {
+        cheese {
+          type 'mozzarrella'
+          color 'white'
+        }
+      }
+    }
+    verify_pizza(pizza, :cheese => Structs::Cheese.new('mozzarrella', 'white'))
+  end
+end

data/spec/array_type_spec.rb

@@ -0,0 +1,135 @@
+describe "Packager DSL ArrayOf" do
+  # This uses $toppings defined in spec/spec_helper.rb
+  def verify_pizza(pizza, values={})
+    expect(pizza).to be_instance_of(Structs::Pizza)
+    $toppings.each do |topping|
+      expect(pizza.send(topping)).to eq(values[topping])
+    end
+  end
+
+  it "can array a String" do
+    dsl_class = Class.new(DSL::Maker) do
+      add_entrypoint(:pizza, {
+        :cheeses => DSL::Maker::ArrayOf[String],
+        :cheese => DSL::Maker::AliasOf(:cheeses),
+      }) {
+        Structs::Pizza.new(cheeses)
+      }
+    end
+
+    pizza = dsl_class.execute_dsl {
+      pizza {
+        cheeses :cheddar
+        cheeses 'mozzarrella'
+      }
+    }
+    verify_pizza(pizza, :cheese => %w(cheddar mozzarrella))
+
+    pizza = dsl_class.execute_dsl {
+      pizza {
+        cheeses 'cheddar', 'mozzarrella'
+      }
+    }
+    verify_pizza(pizza, :cheese => %w(cheddar mozzarrella))
+  end
+
+  it "can array a DSL" do
+    dsl_class = Class.new(DSL::Maker) do
+      cheese_dsl = generate_dsl({
+        :type => String,
+        :color => String,
+      }) do
+        Structs::Cheese.new(type, color)
+      end
+
+      add_entrypoint(:pizza, {
+        :cheeses => DSL::Maker::ArrayOf[cheese_dsl],
+        :cheese => DSL::Maker::AliasOf(:cheeses),
+      }) {
+        Structs::Pizza.new(cheeses)
+      }
+    end
+
+    pizza = dsl_class.execute_dsl {
+      pizza {
+        cheese {
+          type 'mozzarrella'
+          color 'white'
+        }
+        cheese {
+          type 'cheddar'
+          color 'orange'
+        }
+      }
+    }
+    verify_pizza(pizza, :cheese => [
+      Structs::Cheese.new('mozzarrella', 'white'),
+      Structs::Cheese.new('cheddar', 'orange'),
+    ])
+  end
+
+  it "can array a DSL with verifications" do
+    dsl_class = Class.new(DSL::Maker) do
+      cheese_dsl = generate_dsl({
+        :type => String,
+        :color => String,
+      }) do
+        Structs::Cheese.new(type, color)
+      end
+      cheese_dsl.add_verification do |item|
+        return "Cheese must have a color" unless item.color
+      end
+
+      add_entrypoint(:pizza, {
+        :cheeses => DSL::Maker::ArrayOf[cheese_dsl],
+        :cheese => DSL::Maker::AliasOf(:cheeses),
+      }) {
+        Structs::Pizza.new(cheeses)
+      }
+    end
+
+    expect {
+      dsl_class.execute_dsl {
+        pizza {
+          cheese {
+            type 'mozzarrella'
+          }
+        }
+      }
+    }.to raise_error("Cheese must have a color")
+  end
+
+  it "can array a DSL with arguments" do
+    dsl_class = Class.new(DSL::Maker) do
+      cheese_dsl = generate_dsl({
+        :type => String,
+        :color => String,
+      }) do |*args|
+        default(:type, args, 0)
+        Structs::Cheese.new(type, color)
+      end
+
+      add_entrypoint(:pizza, {
+        :cheeses => DSL::Maker::ArrayOf[cheese_dsl],
+        :cheese => DSL::Maker::AliasOf(:cheeses),
+      }) {
+        Structs::Pizza.new(cheeses)
+      }
+    end
+
+    pizza = dsl_class.execute_dsl {
+      pizza {
+        cheese 'mozzarrella' do
+          color 'white'
+        end
+        cheese 'cheddar' do
+          color 'orange'
+        end
+      }
+    }
+    verify_pizza(pizza, :cheese => [
+      Structs::Cheese.new('mozzarrella', 'white'),
+      Structs::Cheese.new('cheddar', 'orange'),
+    ])
+  end
+end

data/spec/error_spec.rb

@@ -167,5 +167,25 @@ describe "DSL::Maker validation" do
         dsl_class.add_type(String) {}
       }.to raise_error("'String' is already a type coercion")
     end
+
+    it "rejects an ArrayOf[type] if type isn't known" do
+      expect {
+        Class.new(DSL::Maker) do
+          generate_dsl({
+            :foo => DSL::Maker::ArrayOf[:does_not_exist]
+          }) {}
+        end
+      }.to raise_error("Unknown type provided to ArrayOf")
+    end
+
+    it "rejects an ArrayOf[type] if type is an alias" do
+      expect {
+        Class.new(DSL::Maker) do
+          generate_dsl({
+            :foo => DSL::Maker::ArrayOf[DSL::Maker::AliasOf(:foo)]
+          }) {}
+        end
+      }.to raise_error("Cannot make an array of an alias")
+    end
   end
 end

data/spec/spec_helper.rb

@@ -40,6 +40,7 @@ module Structs
 
   $toppings = [:cheese, :pepperoni, :bacon, :sauce]
   Pizza = Struct.new(*$toppings)
+  Cheese = Struct.new(:type, :color)
 
   Color = Struct.new(:name)
   Fruit = Struct.new(:name, :color)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsl_maker
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Rob Kinyon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-07 00:00:00.000000000 Z
+date: 2015-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -154,7 +154,9 @@ files:
 - lib/dsl/maker.rb
 - lib/dsl/maker/version.rb
 - on_what.rb
+- spec/alias_type_spec.rb
 - spec/args_spec.rb
+- spec/array_type_spec.rb
 - spec/class_as_subdsl_spec.rb
 - spec/error_spec.rb
 - spec/helper_spec.rb