dsl_maker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99ee47867d6b31ded1c99a54a01aa793a61592f3
-  data.tar.gz: 5e11770909897a850465398142d13ea52e533f54
+  metadata.gz: ee345a0ba8d01c3d91f40755ba0c18ac527c57eb
+  data.tar.gz: 515dae62c2f621d2ae8c12df517231d209e460a8
 SHA512:
-  metadata.gz: 9106d1d87a86d23e4eccb86b39d4a972e413cf3ce1dd7c469f36889de039f4162494da84abc0a5247312f61e64ca2c1b5b33e5ac694e3428d8640771d8de6504
-  data.tar.gz: 9e1084f369c61cc4029b90ff76a555f17203b3c52913d5aaca1168b93f7725d1b8f2696170b12047e12fb936a7dc24acb0cf8e2ad24688493249a3b17db03b7e
+  metadata.gz: 0983a84dbed2c14f98b7f1d8d2ce6c76bfe59a24f4c74c604f52e8877e830286523de6e4cf3f7747d354e313235689e84dd1fb1bebdb2f3472645740b3217b97
+  data.tar.gz: b59a9f5d5e9095e5fcddbdbbdc0df8a43488a3d9d93ab2a58dcf435f681dd1fff97c5a6ec415352464ad2c7703931b767d5b08e3c54c49bda4b5aef636e57d9e

data/Changes

@@ -1,5 +1,10 @@
 Revision history for DSL::Maker (ordered by revision number).
 
+0.1.1 Aug 24 2015
+   - add_helper() no longer pollutes DSL::Maker::Base
+   - Add remove_helper() and has_helper?()
+   - Rename is_dsl() to is_dsl?()
+
 0.1.0 Aug 11 2015
    BREAKING CHANGE:
    - parse_dsl() and execute_dsl() now always return an array, even if there is

data/lib/dsl/maker.rb

@@ -89,7 +89,7 @@ class DSL::Maker
   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)
+      raise "Unknown type provided to ArrayOf" unless @@types.has_key?(type) || DSL::Maker.is_dsl?(type)
       @@arrays[type] ||= ArrayType.new(type)
     end
   end
@@ -99,12 +99,9 @@ class DSL::Maker
 
   # Parse the DSL provided in the parameter.
   #
-  # @note If the DSL contains multiple entrypoints, then this will return an
-  # Array. This is desirable.
-  #
   # @param dsl [String] The DSL to be parsed by this class.
   #
-  # @return    [Object] Whatever is returned by the block defined in this class.
+  # @return    [Array] Whatever is returned by the block defined in this class.
   def self.parse_dsl(dsl=nil)
     raise 'Must call add_entrypoint before parse_dsl' unless @klass
     raise 'String required for parse_dsl' unless dsl.instance_of? String
@@ -114,12 +111,9 @@ class DSL::Maker
 
   # Execute the DSL provided in the block.
   #
-  # @note If the DSL contains multiple entrypoints, then this will return an
-  # Array. This is desirable.
-  #
   # @param &block [Block] The DSL to be executed by this class.
   #
-  # @return    [Object] Whatever is returned by &block
+  # @return    [Array] Whatever is returned by the block defined in this class.
   def self.execute_dsl(&block)
     raise 'Must call add_entrypoint before execute_dsl' unless @klass
     raise 'Block required for execute_dsl' unless block_given?
@@ -140,7 +134,7 @@ class DSL::Maker
   # and ___set() available for your use. These are aliases to
   # instance_variable_get and instance_variable_set, respectively. Please read the
   # coercions provided for you in this source file as examples.
-  # 
+  #
   # @return nil
   def self.add_type(type, &block)
     raise "Block required for add_type" unless block_given?
@@ -166,7 +160,7 @@ class DSL::Maker
   def self.generate_dsl(args={}, &defn_block)
     raise 'Block required for generate_dsl' unless block_given?
 
-    dsl_class = Class.new(DSL::Maker::Base) do
+    dsl_class = Class.new(base_class) do
       include DSL::Maker::Boolean
 
       class << self
@@ -199,7 +193,7 @@ class DSL::Maker
   # @param name  [String] the name of the entrypoint
   # @param args  [Hash]   the elements of the DSL block (passed to generate_dsl)
   # @param defn_block [Proc]   what is executed once the DSL block is parsed.
-  # 
+  #
   # @return      [Class]  The class that implements this level's DSL definition.
   def self.add_entrypoint(name, args={}, &defn_block)
     symname = name.to_sym
@@ -208,7 +202,7 @@ class DSL::Maker
       raise "'#{name.to_s}' is already an entrypoint"
     end
 
-    if is_dsl(args)
+    if is_dsl?(args)
       dsl_class = args
     else
       # Without defn_block, there's no way to give back the result of the
@@ -218,7 +212,7 @@ class DSL::Maker
       raise "Block required for add_entrypoint" unless block_given?
       dsl_class = generate_dsl(args, &defn_block)
     end
-    
+
     if @klass
       build_dsl_element(@klass, symname, dsl_class)
     else
@@ -241,7 +235,7 @@ class DSL::Maker
   # This returns the DSL corresponding to the entrypoint's name.
   #
   # @param name  [String] the name of the entrypoint
-  # 
+  #
   # @return      [Class]  The class that implements this name's DSL definition.
   def self.entrypoint(name)
     unless is_entrypoint(name)
@@ -257,22 +251,46 @@ class DSL::Maker
   #
   # @param name   [String] the name of the helper
   # @param &block [Block]  The function to be executed when the helper is called.
-  # 
+  #
   # @return nil
   def self.add_helper(name, &block)
     raise "Block required for add_helper" unless block_given?
 
-    if DSL::Maker::Base.new.respond_to? name.to_sym
+    if has_helper? name
       raise "'#{name.to_s}' is already a helper"
     end
 
-    DSL::Maker::Base.class_eval do
+    base_class.class_eval do
       define_method(name.to_sym, &block)
     end
 
     return
   end
 
+  # This removes a helper function that's been added with #add_helper
+  #
+  # @param name   [String] the name of the helper
+  #
+  # @return nil
+  def self.remove_helper(name)
+    unless has_helper? name
+      raise "'#{name.to_s}' is not a helper"
+    end
+
+    base_class.class_eval do
+      remove_method(name.to_sym)
+    end
+  end
+
+  # This returns if the helper has been added with #add_helper
+  #
+  # @param name   [String] the name of the helper
+  #
+  # @return Boolean
+  def self.has_helper?(name)
+    base_class.method_defined?(name.to_sym)
+  end
+
   # This adds a verification that's executed after the DSL is finished parsing.
   #
   # The verification will be called with the value(s) returned by the entrypoint's
@@ -289,7 +307,7 @@ class DSL::Maker
   #
   # @param name   [String] the name of the entrypoint to add a verification to
   # @param &block [Block]  The function to be executed when verifications execute
-  # 
+  #
   # @return nil
   def self.add_verification(name, &block)
     raise "Block required for add_verification" unless block_given?
@@ -332,7 +350,7 @@ class DSL::Maker
           instance_exec('@' + name.to_s, *args, &@@types[type])
         end
       end
-    elsif is_dsl(type)
+    elsif is_dsl?(type)
       as_attr = '@' + name.to_s
       klass.class_eval do
         define_method(name.to_sym) do |*args, &dsl_block|
@@ -374,7 +392,7 @@ class DSL::Maker
           ___set(as_attr, rv = []) unless rv
 
           if dsl_block
-            # This code is copy-pasted from the is_dsl() section above. Figure out
+            # 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
@@ -419,13 +437,28 @@ class DSL::Maker
     return @accumulator
   end
 
-  def self.is_dsl(proto)
+  def self.is_dsl?(proto)
     proto.is_a?(Class) && proto.ancestors.include?(DSL::Maker::Base)
   end
 
   def self.is_entrypoint(name)
     @entrypoints && @entrypoints.has_key?(name.to_sym)
   end
+
+  def self.base_class
+    # This is the only time we *know* that the :default helper doesn't exist yet.
+    unless @base_class
+      @base_class = Class.new(DSL::Maker::Base)
+      add_helper(:default) do |method_name, args, position=0|
+        method = method_name.to_sym
+        if args.length >= (position + 1) && !self.send(method)
+          self.send(method, args[position])
+        end
+        return
+      end
+    end
+    @base_class
+  end
 end
 
 # These are the default setups
@@ -447,18 +480,3 @@ DSL::Maker.add_type(DSL::Maker::Boolean) do |attr, *args|
   # Ensure that the default nil also returns as false.
   !!___get(attr)
 end
-
-# A helper method for handling defaults from args easily.
-#
-# @param method_name [String]  The name of the attribute being defaulted.
-# @param args        [Array]   The arguments provided to the block.
-# @param position    [Integer] The index in args to work with, default 0.
-#
-# @return nil
-DSL::Maker.add_helper(:default) do |method_name, args, position=0|
-  method = method_name.to_sym
-  if args.length >= (position + 1) && !self.send(method)
-    self.send(method, args[position])
-  end
-  return
-end

data/lib/dsl/maker/version.rb

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

data/spec/error_spec.rb

@@ -125,29 +125,41 @@ describe "DSL::Maker validation" do
   end
 
   describe "for helpers" do
-    it "rejects a helper without a block" do
-      dsl_class = Class.new(DSL::Maker)
+    context "#add_helper" do
+      it "rejects a helper without a block" do
+        dsl_class = Class.new(DSL::Maker)
 
-      expect {
-        dsl_class.add_helper(:x)
-      }.to raise_error('Block required for add_helper')
-    end
+        expect {
+          dsl_class.add_helper(:x)
+        }.to raise_error('Block required for add_helper')
+      end
 
-    it "rejects the helper name default" do
-      dsl_class = Class.new(DSL::Maker)
+      it "rejects the helper name default" do
+        dsl_class = Class.new(DSL::Maker)
 
-      expect {
-        dsl_class.add_helper(:default) {}
-      }.to raise_error("'default' is already a helper")
+        expect {
+          dsl_class.add_helper(:default) {}
+        }.to raise_error("'default' is already a helper")
+      end
+
+      it "rejects a helper name already in use" do
+        dsl_class = Class.new(DSL::Maker)
+        dsl_class.add_helper(:x) {}
+
+        expect {
+          dsl_class.add_helper(:x) {}
+        }.to raise_error("'x' is already a helper")
+      end
     end
 
-    it "rejects a helper name already in use" do
-      dsl_class = Class.new(DSL::Maker)
-      dsl_class.add_helper(:x) {}
+    context "#remove_helper" do
+      it "rejects a helper name not already in use" do
+        dsl_class = Class.new(DSL::Maker)
 
-      expect {
-        dsl_class.add_helper(:x) {}
-      }.to raise_error("'x' is already a helper")
+        expect {
+          dsl_class.remove_helper(:x)
+        }.to raise_error("'x' is not a helper")
+      end
     end
   end
 

data/spec/helper_spec.rb

@@ -1,60 +1,84 @@
 # This uses a DSL that also provides a set of useful helpers.
 #
-describe "A DSL with helpers" do
-  it "can add a helper that's useful" do
-    dsl_class = Class.new(DSL::Maker) do
-      add_entrypoint(:car, {
-        :maker => String,
-      }) do
-        Structs::Car.new(maker)
-      end
+describe 'A DSL with helpers' do
+  context '#add_helper' do
+    it "can add a helper that's useful" do
+      dsl_class = Class.new(DSL::Maker) do
+        add_entrypoint(:car, {
+          :maker => String,
+        }) do
+          Structs::Car.new(maker)
+        end
 
-      add_helper(:transform) do |name|
-        name.upcase
+        add_helper(:transform) do |name|
+          name.upcase
+        end
       end
+
+      car = dsl_class.parse_dsl("
+        car {
+          maker transform('Honda')
+        }
+      ")[0]
+      expect(car).to be_instance_of(Structs::Car)
+      expect(car.maker).to eq('HONDA')
     end
 
-    car = dsl_class.parse_dsl("
-      car {
-        maker transform('Honda')
-      }
-    ")[0]
-    expect(car).to be_instance_of(Structs::Car)
-    expect(car.maker).to eq('HONDA')
+    it 'adds the helper to every level' do
+      dsl_class = Class.new(DSL::Maker) do
+        add_entrypoint(:car, {
+          :maker => String,
+          :wheel => generate_dsl({
+            :maker => String,
+          }) do
+            Structs::Wheel.new(maker)
+          end
+        }) do
+          Structs::Car.new(maker, wheel)
+        end
+
+        add_helper(:transform) do |name|
+          name.upcase
+        end
+      end
+
+      car = dsl_class.parse_dsl("
+        car {
+          maker 'Honda'
+          wheel {
+            maker transform('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)
+      expect(car.wheel.maker).to eq('GOODYEAR')
+    end
   end
 
-  # TODO: There is a wart here. We cannot call add_helper() twice in our tests
-  # for the same name even in different specs. The specs should be able to reset
-  # the class, but I'm not sure how.
-  it "adds the helper to every level" do
-    dsl_class = Class.new(DSL::Maker) do
-      add_entrypoint(:car, {
-        :maker => String,
-        :wheel => generate_dsl({
+  context '#remove_helper' do
+    it 'can remove a helper' do
+      dsl_class = Class.new(DSL::Maker) do
+        add_entrypoint(:car, {
           :maker => String,
         }) do
-          Structs::Wheel.new(maker)
+          Structs::Car.new(maker)
         end
-      }) do
-        Structs::Car.new(maker, wheel)
-      end
 
-      add_helper(:transform2) do |name|
-        name.upcase
+        remove_helper(:default)
+        add_helper(:default) do |name|
+          name.upcase
+        end
       end
-    end
 
-    car = dsl_class.parse_dsl("
-      car {
-        maker 'Honda'
-        wheel {
-          maker transform2('goodyear')
+      car = dsl_class.parse_dsl("
+        car {
+          maker default('Honda')
         }
-      }
-    ")[0]
-    expect(car).to be_instance_of(Structs::Car)
-    expect(car.maker).to eq('Honda')
-    expect(car.wheel).to be_instance_of(Structs::Wheel)
-    expect(car.wheel.maker).to eq('GOODYEAR')
+      ")[0]
+      expect(car).to be_instance_of(Structs::Car)
+      expect(car.maker).to eq('HONDA')
+    end
   end
 end

metadata

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