dsl_block 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c00534daad8cd4a27d4f3855c4d9a03fad82595
-  data.tar.gz: 4dfb593b99f4653aecd81b661e4a04533068a87e
+  metadata.gz: fc76bcc8987040d930830d224d9c95db5bd212ab
+  data.tar.gz: 03de7ce19db4372f7bf411488db80033ff4ae2a4
 SHA512:
-  metadata.gz: bb9421a382aca361db5ff31e801d5f064a5789077d68b994aee65a92d87e4385c26631da68466203c5030f6271371db9444a59c9da991e46fcd41f111da462bf
-  data.tar.gz: 227ebf931eca9fdb584fc51dea8a422a74bfa9fad5823af7127937ef69f0c277efc3c152ebd781f19f4a75cd76c5e0e802d65cfbd5e3783f0215868a965a4376
+  metadata.gz: 1abb915845cd07c6384daf018d5bb7fe76515514d85dafd32b2fe7aba723adda356d3b8edca9b5478061c54db0d80cd9196e0879c94d09228f0224f7b8764ecb
+  data.tar.gz: acfbb43fe8257490e374801bf0ecf68237e1df6b37f1d4885147bf3dfe0a3ec15effce3f28bbe78264159c86f0fe7ab1b0b530c94088fee510284c8767918df6

data/.gitignore

@@ -1,17 +1,17 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -1,2 +1,2 @@
---colour
---format documentation
+--colour
+--format documentation

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in dsl_block.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dsl_block.gemspec
+gemspec

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2013 Frank Hall
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2013 Frank Hall
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,82 +1,82 @@
-# DslBlock
-
-DslBlock allows you to use classes to define blocks with commands for a Domain Specific Language. The commands are automatically relayed to your instance method.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'dsl_block'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install dsl_block
-
-## Usage
-
-    class Foo < DslBlock
-      commands :show_foo
-      def show_foo(x)
-        puts "Mr. T says you are a foo times #{x.to_i}"
-      end
-    end
-
-    class Bar < DslBlock
-      commands :show_bar
-      def show_bar(x)
-        puts "Ordering #{x.to_i} Shirley Temples from the bar"
-      end
-    end
-
-    class Baz < DslBlock
-      commands :show_baz
-      def show_baz(x)
-        puts "Baz spaz #{x.inspect}"
-      end
-    end
-
-    Baz.add_command_to(Bar)
-    Bar.add_command_to(Foo, true)
-    Foo.add_command_to(self)
-
-
-    foo do
-      puts self.inspect       # => #<Foo:0x007f98f187e240 @block=#<Proc:0x...>, @parent=nil>
-      x = 10/10
-      show_foo x              # => Mr. T says you are a foo times 1
-
-      bar do
-        x *= 2
-        show_bar x            # => Ordering 2 Shirley Temples from the bar
-        x += 1
-        show_foo x            # => Mr. T says you are a foo times 3
-
-        baz do
-          x *= 4
-          x /= 3
-          show_baz x          # => Baz spaz 4
-          begin
-            x += 1
-            show_bar 5        # This will throw a NameError
-          rescue NameError
-            puts 'No bar for us'
-          end
-
-        end
-
-      end
-
-    end
-
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+# DslBlock
+
+DslBlock allows you to use classes to define blocks with commands for a Domain Specific Language. The commands are automatically relayed to your instance method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dsl_block'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dsl_block
+
+## Usage
+
+    class Foo < DslBlock
+      commands :show_foo
+      def show_foo(x)
+        puts "Mr. T says you are a foo times #{x.to_i}"
+      end
+    end
+
+    class Bar < DslBlock
+      commands :show_bar
+      def show_bar(x)
+        puts "Ordering #{x.to_i} Shirley Temples from the bar"
+      end
+    end
+
+    class Baz < DslBlock
+      commands :show_baz
+      def show_baz(x)
+        puts "Baz spaz #{x.inspect}"
+      end
+    end
+
+    Baz.add_command_to(Bar)
+    Bar.add_command_to(Foo, true)
+    Foo.add_command_to(self)
+
+
+    foo do
+      puts self.inspect       # => #<Foo:0x007f98f187e240 @block=#<Proc:0x...>, @parent=nil>
+      x = 10/10
+      show_foo x              # => Mr. T says you are a foo times 1
+
+      bar do
+        x *= 2
+        show_bar x            # => Ordering 2 Shirley Temples from the bar
+        x += 1
+        show_foo x            # => Mr. T says you are a foo times 3
+
+        baz do
+          x *= 4
+          x /= 3
+          show_baz x          # => Baz spaz 4
+          begin
+            x += 1
+            show_bar 5        # This will throw a NameError
+          rescue NameError
+            puts 'No bar for us'
+          end
+
+        end
+
+      end
+
+    end
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,16 +1,16 @@
-require 'bundler/gem_tasks'
-require 'rdoc/task'
-require 'rspec/core/rake_task'
-require 'rdoc/task'
-
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = 'doc'
-  rdoc.main = 'DslBlock.html'
-  rdoc.rdoc_files.include 'lib'
-end
-
-
-RSpec::Core::RakeTask.new
-
-task :default => :spec
+require 'bundler/gem_tasks'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.main = 'DslBlock.html'
+  rdoc.rdoc_files.include 'lib'
+end
+
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
 task :test => :spec

data/dsl_block.gemspec

@@ -1,29 +1,29 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'dsl_block/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'dsl_block'
-  spec.version       = DslBlock::VERSION
-  spec.authors       = ['Frank Hall']
-  spec.email         = ['ChapterHouse.Dune@gmail.com']
-  spec.summary       = %q{Quick and simple DSL creator.}
-  spec.description   = %q{DslBlock is a quick and simple DSL creator.}
-  spec.homepage      = 'http://chapterhouse.github.io/dsl_block'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'activesupport', '~> 4.0'
-
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 2.14.1'
-  spec.add_development_dependency 'simplecov', '~> 0.7.1'
-  spec.add_development_dependency 'rdoc', '~> 4.0.0'
-
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dsl_block/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dsl_block'
+  spec.version       = DslBlock::VERSION
+  spec.authors       = ['Frank Hall']
+  spec.email         = ['ChapterHouse.Dune@gmail.com']
+  spec.summary       = %q{Quick and simple DSL creator.}
+  spec.description   = %q{DslBlock is a quick and simple DSL creator.}
+  spec.homepage      = 'http://chapterhouse.github.io/dsl_block'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14.1'
+  spec.add_development_dependency 'simplecov', '~> 0.7.1'
+  spec.add_development_dependency 'rdoc', '~> 4.0.0'
+
+end

data/lib/dsl_block.rb

@@ -1,159 +1,168 @@
-require 'dsl_block/version'
-require 'dsl_block/executor'
-require 'active_support/core_ext/string/inflections'
-
-# DslBlock is a base class for defining a Domain Specific Language. Subclasses of DslBlock define the desired dsl.
-# These methods become available to ruby code running in the context of the subclass.
-# The block execution is automatically isolated to prevent the called block from accessing instance methods unless
-# specifically designated as callable. DslBlocks can be nested and parent blocks can allow their methods to be exposed to child block.
-#
-# ==== Example
-#    # Define three DslBlocks each with at least one command in each block
-#    class Foo < DslBlock
-#      commands :show_foo
-#      def show_foo(x)
-#        "Mr. T says you are a foo times #{x.to_i}"
-#      end
-#    end
-#
-#    class Bar < DslBlock
-#      commands :show_bar
-#      def show_bar(x)
-#        "Ordering #{x.to_i} Shirley Temples from the bar"
-#      end
-#    end
-#
-#    class Baz < DslBlock
-#      commands :show_baz
-#      def show_baz(x)
-#        "Baz spaz #{x.inspect}"
-#      end
-#    end
-#
-#    # Connect the blocks to each other so they can be easily nested
-#    Baz.add_command_to(Bar)
-#    Bar.add_command_to(Foo, true) # Let Bar blocks also respond to foo methods
-#    Foo.add_command_to(self)
-#
-#    # Use the new DSL
-#    foo do
-#      self.inspect       # => #<Foo:0x007fdbd52b54e0 @block=#<Proc:0x007fdbd52b5530@/home/fhall/wonderland/alice.rb:29>, @parent=nil>
-#      x = 10/10
-#      show_foo x         # => Mr. T says you are a foo times 1
-#
-#      bar do
-#        x *= 2
-#        show_bar x       # => Ordering 2 Shirley Temples from the bar
-#
-#        x += 1
-#        show_foo x       # => Mr. T says you are a foo times 3
-#
-#        baz do
-#
-#          x *= 4
-#          x /= 3
-#          show_baz x     # => Baz spaz 4
-#
-#          begin
-#            x += 1
-#            show_bar x   # => NameError
-#          rescue NameError
-#            'No bar for us'
-#          end
-#        end
-#
-#      end
-#
-#    end
-#
-class DslBlock
-  # Parent object providing additional commands to the block.
-  attr_accessor :parent
-  # Block of code that will be executed upon yield.
-  attr_accessor :block
-
-  # With no arguments, returns an array of command names that this DslBlock makes available to blocks either directly or indirectly.
-  # With arguments, adds new names to the array of command names, then returns the new array.
-  def self.commands(*args)
-    @commands ||= []
-    @commands = (@commands + args.map(&:to_sym)).uniq
-    @commands
-  end
-
-  # This is a convenience command that allows this DslBlock to inject itself as a method into another DslBlock or Object.
-  # If the parent is also a DslBlock, the new method will automatically be added to the available commands.
-  #
-  # Params:
-  # +destination+:: The object to receive the new method
-  # +propigate_local_commands+:: Allow methods in the destination to be called by the block. (default: false)
-  # +command_name+:: The name of the method to be created or nil to use the default which is based off of the class name. (default: nil)
-  def self.add_command_to(destination, propigate_local_commands=false, command_name=nil)
-    # Determine the name of the method to create
-    command_name = (command_name || name).to_s.underscore.to_sym
-    # Save a reference to our self so we will have something to call in a bit when self will refer to someone else.
-    this_class = self
-    # Define the command in the destination.
-    destination.send(:define_method, command_name) do |&block|
-      # Create a new instance of our self with the callers 'self' passed in as an optional parent.
-      # Immediately after initialization, yield the block.
-      this_class.new(propigate_local_commands ? self : nil, &block).yield
-    end
-    # Add the new command to the parent if it is a DslBlock.
-    destination.commands << command_name if destination.is_a?(Class) && destination < DslBlock
-  end
-
-  # Create a new DslBlock instance.
-  # +parent+:: Optional parent DslBlock or Object that is providing additional commands to the block. (default: nil)
-  # +block+:: Required block of code that will be executed when yield is called on the new DslBlock instance.
-  def initialize(parent = nil, &block)
-    raise ArgumentError, 'block must be provided' unless block_given?
-    @block = block
-    @parent = parent
-  end
-
-  # This is the entire list of commands that this instance makes available to the block of code to be run.
-  # It is a combination of three distinct sources.
-  # 1. The class's declared commands
-  # 2. If there is a parent of this DslBock instance...
-  #    * The parents declared commands if it is a DslBlock
-  #    * The parents public_methods if it is any other type of object
-  # 3. Kernel.methods
-  #
-  # This method is prefixed with an underscore in an attempt to avoid collisions with commands in the given block.
-  def _commands
-    cmds = self.class.commands.dup
-    if @parent
-      if @parent.is_a?(DslBlock)
-        cmds += @parent._commands
-      else
-        cmds +=  @parent.public_methods
-      end
-    end
-    (cmds + Kernel.methods).uniq
-  end
-
-  # Yield the block given.
-  def yield
-    begin
-      # Evaluate the block in an executor to provide isolation
-      # and prevent accidental interference with ourselves.
-      Executor.new(self).instance_eval(&@block)
-    rescue Exception => e
-      e.set_backtrace(caller.select { |x| !x.include?(__FILE__)})
-      raise e
-    end
-  end
-
-  # :nodoc:
-  def respond_to_missing?(method, include_all)
-    @parent && @parent.respond_to?(method, include_all) || super
-  end
-
-  def method_missing(name, *args, &block)
-    if @parent && @parent.respond_to?(name)
-      @parent.send(name, *args, &block)
-    else
-      super
-    end
-  end
-end
+require 'dsl_block/version'
+require 'dsl_block/executor'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/array/extract_options'
+
+
+# DslBlock is a base class for defining a Domain Specific Language. Subclasses of DslBlock define the desired dsl.
+# These methods become available to ruby code running in the context of the subclass.
+# The block execution is automatically isolated to prevent the called block from accessing instance methods unless
+# specifically designated as callable. DslBlocks can be nested and parent blocks can allow their methods to be exposed to child block.
+#
+# ==== Example
+#    # Define three DslBlocks each with at least one command in each block
+#    class Foo < DslBlock
+#      commands :show_foo
+#      def show_foo(x)
+#        "Mr. T says you are a foo times #{x.to_i}"
+#      end
+#    end
+#
+#    class Bar < DslBlock
+#      commands :show_bar
+#      def show_bar(x)
+#        "Ordering #{x.to_i} Shirley Temples from the bar"
+#      end
+#    end
+#
+#    class Baz < DslBlock
+#      commands :show_baz
+#      def show_baz(x)
+#        "Baz spaz #{x.inspect}"
+#      end
+#    end
+#
+#    # Connect the blocks to each other so they can be easily nested
+#    Baz.add_command_to(Bar)
+#    Bar.add_command_to(Foo, :propagate => true) # Let Bar blocks also respond to foo methods
+#    Foo.add_command_to(self)
+#
+#    # Use the new DSL
+#    foo do
+#      self.inspect       # => #<Foo:0x007fdbd52b54e0 @block=#<Proc:0x007fdbd52b5530@/home/fhall/wonderland/alice.rb:29>, @parent=nil>
+#      x = 10/10
+#      show_foo x         # => Mr. T says you are a foo times 1
+#
+#      bar do
+#        x *= 2
+#        show_bar x       # => Ordering 2 Shirley Temples from the bar
+#
+#        x += 1
+#        show_foo x       # => Mr. T says you are a foo times 3
+#
+#        baz do
+#
+#          x *= 4
+#          x /= 3
+#          show_baz x     # => Baz spaz 4
+#
+#          begin
+#            x += 1
+#            show_bar x   # => NameError
+#          rescue NameError
+#            'No bar for us'
+#          end
+#        end
+#
+#      end
+#
+#    end
+#
+class DslBlock
+  # Parent object providing additional commands to the block.
+  attr_accessor :parent
+  # Block of code that will be executed upon yield.
+  attr_accessor :block
+
+  # With no arguments, returns an array of command names that this DslBlock makes available to blocks either directly or indirectly.
+  # With arguments, adds new names to the array of command names, then returns the new array.
+  def self.commands(*args)
+    @commands ||= []
+    @commands = (@commands + args.map(&:to_sym)).uniq
+    @commands
+  end
+
+  # This is a convenience command that allows this DslBlock to inject itself as a method into another DslBlock or Object.
+  # If the parent is also a DslBlock, the new method will automatically be added to the available commands.
+  #
+  # Params:
+  # +destination+:: The object to receive the new method
+  # +options+:: A hash of options configuring the command
+  #
+  # Options:
+  # +:propagate+:: Allow methods in the destination to be called by the block. (default: false)
+  # +:command_name+:: The name of the method to be created or nil to use the default which is based off of the class name. (default: nil)
+  def self.add_command_to(destination, options={})
+    # Determine the name of the method to create
+    command_name = (options[:command_name] || name).to_s.underscore.to_sym
+    # Save a reference to our self so we will have something to call in a bit when self will refer to someone else.
+    this_class = self
+    # Define the command in the destination.
+    destination.send(:define_method, command_name) do |&block|
+      # Create a new instance of our self with the callers 'self' passed in as an optional parent.
+      # Immediately after initialization, yield the block.
+      this_class.new(:parent => options[:propagate] ? self : nil, &block).yield
+    end
+    # Add the new command to the parent if it is a DslBlock.
+    destination.commands << command_name if destination.is_a?(Class) && destination < DslBlock
+  end
+
+  # Create a new DslBlock instance.
+  # +block+:: Required block of code that will be executed when yield is called on the new DslBlock instance.
+  #
+  # Options:
+  # +:parent+:: Optional parent DslBlock or Object that is providing additional commands to the block. (default: nil)
+  # +:block+:: Optional method of passing in a block.
+  def initialize(*args, &block)
+    options = args.extract_options!
+    @block = block_given? ? block : options[:block]
+    raise ArgumentError, 'block must be provided' unless @block
+    @parent = options[:parent]
+  end
+
+  # This is the entire list of commands that this instance makes available to the block of code to be run.
+  # It is a combination of three distinct sources.
+  # 1. The class's declared commands
+  # 2. If there is a parent of this DslBock instance...
+  #    * The parents declared commands if it is a DslBlock
+  #    * The parents public_methods if it is any other type of object
+  # 3. Kernel.methods
+  #
+  # This method is prefixed with an underscore in an attempt to avoid collisions with commands in the given block.
+  def _commands
+    cmds = self.class.commands.dup
+    if @parent
+      if @parent.is_a?(DslBlock)
+        cmds += @parent._commands
+      else
+        cmds +=  @parent.public_methods
+      end
+    end
+    (cmds + Kernel.methods).uniq
+  end
+
+  # Yield the block given.
+  def yield
+    begin
+      # Evaluate the block in an executor to provide isolation
+      # and prevent accidental interference with ourselves.
+      Executor.new(self).instance_eval(&@block)
+    rescue Exception => e
+      e.set_backtrace(caller.select { |x| !x.include?(__FILE__)})
+      raise e
+    end
+  end
+
+  # :nodoc:
+  def respond_to_missing?(method, include_all)
+    @parent && @parent.respond_to?(method, include_all) || super
+  end
+
+  def method_missing(name, *args, &block)
+    if @parent && @parent.respond_to?(name)
+      @parent.send(name, *args, &block)
+    else
+      super
+    end
+  end
+end