forwarding_dsl 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56f4ed6636f4c824723c54c6322fbe0d05cc0c77
+  data.tar.gz: 46851768bf87d94b96d4fefe26b624c061a4e939
+SHA512:
+  metadata.gz: e174af406edd12c441f90f1a8349a07303c9ad384bf4e5f22708ce67c729bd37052fbec15c24db2face489d8b045895f62390ccf8be4828d1fb4ba12e4b6e1b7
+  data.tar.gz: cf69df76a986390947eadbf5c791e060e369dcc4ca58deb3f644f8b74d8c30227981468d2c927fdad7e363f0c9ebbdf406ca92180c63b386dd85d6b6ca7b7bcd

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+.yardoc
+*.gem

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test, :development do
+  gem 'gem-release'
+  gem 'rspec'
+  gem 'pry'
+  gem 'rerun'
+  gem 'yard'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Manuel Morales, Workshare ltd., et al.
+
+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

@@ -0,0 +1,113 @@
+# ForwardingDsl
+
+ForwardingDsl makes it easy to build user friendly DSLs.
+While `ForwardingDsl.run` will allow you to create a DSL from a regular object,
+`ForwardingDsl::Getsetter` will make easy to declare attributes for it.
+It is inspired by the blog post [instance_eval with access to outside scope](http://djellemah.com/blog/2013/10/09/instance-eval-with-access-to-outside-scope/).
+
+Benefits:
+
+* Makes it trivial to provide a DSL. Wrap anything with `ForwardingDsl.run()` and you are done.
+* Unlike `instance_eval`, only the public API of your object is reachable from the DSL.
+* Unlike `instance_eval`, methods available outside of the DSL are still available inside.
+* Compatible with the explicit `yield(self)`, no DSL, style.
+
+
+## Usage
+
+Wrap any object to make a DSL out of it:
+
+```ruby
+require 'forwarding_dsl'
+
+App = Struct.new(:host, :port)
+app = App.new("localhost", 80)
+
+ForwardingDsl.run app do
+  host
+end
+# => "localhost"
+```
+
+Use `ForwardingDsl::Getsetter` to declare attributes that receive values
+on a declarative way:
+
+```ruby
+class MyApp
+  include ForwardingDsl::Getsetter
+
+  getsetter :host, :port
+
+  def initialize &block
+    ForwardingDsl.run(my_object, &block)
+  end
+end
+
+app = MyApp.new do
+  host 'localhost'
+  port 80
+end
+
+app.host # => 'localhost'
+app.port # => 80
+```
+
+`ForwardingDsl` is also compatible with the classic `yield(self)`.
+The context of the block will remain untouched in that case:
+
+```ruby
+app = MyApp.new do |a|
+  a.host 'localhost'
+  a.port = 80
+end
+```
+
+Methods available outside of the DSL block are also available inside:
+
+```ruby
+def port_configuration
+  configuration[:port]
+end
+
+app = MyApp.new do
+  port port_configuration
+end
+```
+
+If needed, the yielded object is available explicitly through `this`
+and the outer context through `that`:
+
+```ruby
+def port_configuration
+  configuration[:port]
+end
+
+app = MyApp.new do
+  this.port = that.port_configuration
+end
+```
+
+
+## Contributing
+
+Do not forget to run the tests with:
+
+```bash
+rake
+```
+
+And bump the version with any of:
+
+```bash
+$ gem bump --version 1.1.1       # Bump the gem version to the given version number
+$ gem bump --version major       # Bump the gem version to the next major level (e.g. 0.0.1 to 1.0.0)
+$ gem bump --version minor       # Bump the gem version to the next minor level (e.g. 0.0.1 to 0.1.0)
+$ gem bump --version patch       # Bump the gem version to the next patch level (e.g. 0.0.1 to 0.0.2)
+```
+
+
+## License
+
+Released under the MIT License.
+See the [LICENSE](LICENSE.txt) file for further details.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake'
+
+require 'rspec/core/rake_task'
+task :default => :spec
+task :test => :spec
+desc 'Run all specs'
+RSpec::Core::RakeTask.new('spec') do |spec|
+  spec.rspec_opts = %w{}
+end

data/forwarding_dsl.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+gem_name = "forwarding_dsl" # TODO: Rename this
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "#{gem_name}/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = gem_name
+  spec.version       = ForwardingDsl::VERSION
+  spec.authors       = ["Manuel Morales"]
+  spec.email         = ['manuelmorales@gmail.com']
+  spec.description   = File.read('README.md').split("\n").reject{|l| l.length == 0 || l =~ /^[#=]+/ }.first
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/manuelmorales/#{spec.name.gsub('_','-')}"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/forwarding_dsl.rb

@@ -0,0 +1,10 @@
+require "forwarding_dsl/version"
+
+module ForwardingDsl
+  autoload :Dsl, 'forwarding_dsl/dsl'
+  autoload :Getsetter, 'forwarding_dsl/getsetter'
+
+  def self.run *args, &block
+    Dsl.run *args, &block
+  end
+end

data/lib/forwarding_dsl/dsl.rb

@@ -0,0 +1,39 @@
+module ForwardingDsl
+  class Dsl
+    attr_accessor :this
+    attr_accessor :that
+
+    def self.run target, &block
+      return target unless block_given?
+
+      case block.arity
+      when 0 then
+        new(target, block.binding.eval('self')).
+          send(:instance_exec, &block)
+      when 1 then
+        block.call target
+      else
+        raise ArgumentError.new "Wrong number of arguments. Pass 1 or none."
+      end
+    end
+
+    def initialize this, that
+      @this = this
+      @that = that
+    end
+
+    def method_missing name, *args, &block
+      if this.respond_to? name
+        this.public_send name, *args, &block
+      else
+        that.public_send name, *args, &block
+      end
+    end
+
+    def respond_to_missing? name, *args
+      this.respond_to?(name, *args) ||
+        that.respond_to?(name, *args) ||
+        super
+    end
+  end
+end

data/lib/forwarding_dsl/getsetter.rb

@@ -0,0 +1,27 @@
+module ForwardingDsl
+  module Getsetter
+    NOT_SET = Object.new
+
+    def self.included klass
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      def getsetter *names
+        names.each do |name|
+          define_method name do |value = NOT_SET|
+            if value == NOT_SET
+              instance_variable_get "@#{name}"
+            else
+              instance_variable_set "@#{name}", value
+            end
+          end
+
+          define_method "#{name}=" do |value|
+            instance_variable_set "@#{name}", value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/forwarding_dsl/version.rb

@@ -0,0 +1,3 @@
+module ForwardingDsl
+  VERSION = "1.0.1"
+end

data/spec/forwarding_dsl/dsl_spec.rb

@@ -0,0 +1,132 @@
+require_relative '../spec_helper'
+
+describe ForwardingDsl::Dsl do
+  let(:target_class) do
+    Class.new do
+      def a_method
+      end
+
+      private
+
+      def a_private_emthod
+      end
+    end
+  end
+
+  let(:target) { target_class.new }
+
+  let(:an_external_method) { :external_result }
+
+  describe '.run' do
+    subject{ ForwardingDsl::Dsl }
+
+    describe 'with no args' do
+      it 'forwards messages to the target' do
+        expect(target).to receive(:a_method).with(42)
+
+        subject.run target do
+          a_method 42
+        end
+      end
+
+      it 'responds_to? target methods' do
+        subject.run target do
+          expect(respond_to?(:a_method)).to be true
+        end
+      end
+
+      it 'hides private methods' do
+        expect do
+          subject.run target do
+            a_private_method
+          end
+        end.to raise_error(NoMethodError)
+      end
+
+      it 'allows calling methods from the outside' do
+        expect(target).to receive(:a_method).with :external_result
+
+        subject.run target do
+          a_method an_external_method
+        end
+      end
+
+      it 'responds_to? external methods' do
+        subject.run target do
+          expect(respond_to?(:an_external_method)).to be true
+        end
+      end
+
+      it 'allows using this' do
+        subject.run target do
+          expect(this).to be target
+        end
+      end
+
+      it 'allows using that' do
+        outer_context = self
+
+        subject.run target do
+          expect(that).to be outer_context
+        end
+      end
+    end
+
+    describe 'with 1 arg' do
+      it 'forwards no messages to the target' do
+        expect(target).not_to receive(:a_method)
+
+        expect do
+          subject.run target do |t|
+            a_method 42
+          end
+        end.to raise_error(NoMethodError)
+      end
+
+      it 'yields the target' do
+        subject.run target do |t|
+          expect(t).to be target
+        end
+      end
+
+      it 'runs in the outer context' do
+        outer_context = self
+
+        subject.run target do |t|
+          expect(self).to be outer_context
+        end
+      end
+    end
+
+    describe 'with more args' do
+      it 'raises exception' do
+        expect(target).not_to receive(:a_method)
+
+        expect do
+          subject.run target do |t, x|
+          end
+        end.to raise_error(ArgumentError)
+      end
+    end
+
+    describe 'with no block' do
+      it 'returns the target' do
+        expect(subject.run target).to be target
+      end
+    end
+
+    describe 'with a zero arity lambda' do
+      it 'works normally' do
+        expect(target).to receive(:a_method)
+        block = lambda { a_method }
+
+        subject.run target, &block
+      end
+    end
+
+    it 'returns the result of the last line' do
+      expect(target).to receive(:a_method).and_return(:something)
+      expect(subject.run(target){ a_method }).to be :something
+    end
+  end
+end

data/spec/forwarding_dsl/getsetter_spec.rb

@@ -0,0 +1,35 @@
+require_relative '../spec_helper'
+
+RSpec.describe ForwardingDsl::Getsetter do
+  subject { subject_class.new }
+  let(:subject_class) { Class.new { include ForwardingDsl::Getsetter } }
+
+  describe 'getsetter()' do
+    it 'allows setting an attribute passing it as an argument' do
+      subject_class.class_eval do
+        getsetter :name
+      end
+
+      subject.name 'Test'
+      expect(subject.name).to eq 'Test'
+    end
+
+    it 'allows setting an attribute by equality' do
+      subject_class.class_eval do
+        getsetter :name
+      end
+
+      subject.name = 'Test'
+      expect(subject.name).to eq 'Test'
+    end
+
+    it 'allows passing several names' do
+      subject_class.class_eval do
+        getsetter :name, :surname
+      end
+
+      subject.surname 'Test'
+      expect(subject.surname).to eq 'Test'
+    end
+  end
+end

data/spec/forwarding_dsl_spec.rb

@@ -0,0 +1,16 @@
+require_relative 'spec_helper'
+
+describe ForwardingDsl do
+  it 'has a version' do
+    expect(ForwardingDsl::VERSION).not_to be_nil
+  end
+
+  it 'delegates .run() to Dsl' do
+    target = double('target')
+    expect(target).to receive(:some_method)
+
+    ForwardingDsl.run target do
+      some_method
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rspec'
+require 'pry'
+
+RSpec.configure do |config|
+   config.color = true
+   config.tty = true
+   config.formatter = :documentation # :documentation, :progress, :html, :textmate
+end
+
+$LOAD_PATH.unshift File.expand_path('lib')
+require 'forwarding_dsl'
+
+$LOAD_PATH.unshift File.expand_path('spec/support')
+

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: forwarding_dsl
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Manuel Morales
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ForwardingDsl makes it easy to build user friendly DSLs.
+email:
+- manuelmorales@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- forwarding_dsl-0.0.1.gem
+- forwarding_dsl.gemspec
+- lib/forwarding_dsl.rb
+- lib/forwarding_dsl/dsl.rb
+- lib/forwarding_dsl/getsetter.rb
+- lib/forwarding_dsl/version.rb
+- spec/forwarding_dsl/dsl_spec.rb
+- spec/forwarding_dsl/getsetter_spec.rb
+- spec/forwarding_dsl_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/manuelmorales/forwarding-dsl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ForwardingDsl makes it easy to build user friendly DSLs.
+test_files:
+- spec/forwarding_dsl/dsl_spec.rb
+- spec/forwarding_dsl/getsetter_spec.rb
+- spec/forwarding_dsl_spec.rb
+- spec/spec_helper.rb
+has_rdoc: