indifferent_eval 0.1.1 → 0.2.0

data/.ci

@@ -0,0 +1,7 @@
+#! /bin/sh
+set -ex
+for ruby in ree 1.9.3; do
+	use-ruby $ruby
+	bundle
+	bundle exec rake test
+done

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+*.gem
+
+# Ignore Gemfile.lock because RubyGems doesn't know about versions
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.markdown

@@ -0,0 +1,93 @@
+Indifferent Eval
+================
+
+When you're making a Ruby DSL, you often have to decide between:
+
+```ruby
+# Use a block variable to access the MyConfig instance.
+# This gives you the benefit of having access to the outer "self" inside of the block.
+MyApp.config do |config|
+  config.verbosity true
+  config.foo       :bar
+end
+```
+
+and:
+
+```ruby
+# Don't pass a block variable.  All method calls are sent to the MyConfig instance.
+# This has the benefit of looking really clean (but no access to "self" inside the block).
+MyApp.config do
+  verbosity true
+  foo       :bar
+end
+```
+
+There are a number of pros and cons to each of these approaches.
+
+Wouldn't it be nice if you could support both?  That's what `#indifferent_eval` is for!
+
+Install
+-------
+
+```ruby
+# In your Gemfile
+gem "indifferent_eval"
+```
+
+The Code
+--------
+
+The code is tiny.  This gem exists only for convenience.
+
+```ruby
+module IndifferentEval
+  def indifferent_eval(object_to_eval_on = self, &block)
+    if block.arity == 0 || block.arity == -1
+      object_to_eval_on.instance_eval &block
+    else  
+      block.call object_to_eval_on
+    end
+  end
+end
+```  
+
+([Annotated source code](https://github.com/remi/indifferent_eval/blob/master/lib/indifferent_eval/module.rb))
+
+Usage
+-----
+
+```ruby
+require "indifferent_eval"
+
+class MyLibrary
+  def self.config(&block)
+    @config = MyConfig.new.indifferent_eval(&block)
+  end
+
+  class MyConfig
+    attr_writer :some_setting
+
+    def some_setting(value = nil)
+      @some_setting = value if value
+      @some_setting
+    end
+  end
+end
+
+# Use a block variable to access the MyConfig instance.
+# This gives you the benefit of having access to the outer "self" inside of the block.
+MyLibrary.config do |config|
+  config.some_setting = "Called a method with a block variable"
+end
+
+# Don't pass a block variable.  All method calls are sent to the MyConfig instance.
+# This has the benefit of looking really clean (but no access to "self" inside the block).
+MyLibrary.config do
+  some_setting "Called a method without a block variable"
+end
+```
+
+## License
+
+indifferent_eval is released under the MIT license.

data/Rakefile

@@ -0,0 +1,15 @@
+require "rspec/core/rake_task"
+
+desc 'Default: run specs'
+task :default => :spec
+
+desc 'Run tests'
+task :test => :spec
+
+desc 'Run sample.rb'
+task :sample do
+  exec "bundle exec ruby sample.rb"
+end
+
+desc "Run specs"
+RSpec::Core::RakeTask.new

data/indifferent_eval.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/indifferent_eval/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "indifferent_eval"
+  gem.author      = "remi"
+  gem.email       = "remi@remitaylor.com"
+  gem.homepage    = "http://github.com/remi/indifferent_eval"
+  gem.summary     = "Can't decide between instance_eval and block.call?  Why not support both!?"
+
+  gem.description = <<-desc.gsub(/^\s+/, '')
+    Can't decide between instance_eval and block.call?  Why not support both!?
+  desc
+
+  files = `git ls-files`.split("\n")
+  gem.files         = files
+  gem.executables   = files.grep(%r{^bin/.*}).map {|f| File.basename(f) }
+  gem.test_files    = files.grep(%r{^spec/.*})
+  gem.require_paths = ["lib"]
+  gem.version       = IndifferentEval::VERSION
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

data/lib/indifferent_eval/module.rb

@@ -1,16 +1,9 @@
 module IndifferentEval
-
-  def indifferent_eval object_to_eval_on = self, &block
-    
-    if block.arity == -1
-      # no block variable, use instance_eval
-      object_to_eval_on.instance_eval &block
-
+  def indifferent_eval(object_to_eval_on = self, &block)
+    if block.arity == 0 || block.arity == -1 # Blocks with no arguments return -1 in Ruby 1.8 but 0 in Ruby 1.9.
+      object_to_eval_on.instance_eval &block # No block variable so use instance_eval on the object.
     else  
-      # we were passed a variable, so #call the block
-      block.call object_to_eval_on
+      block.call object_to_eval_on # Block variable passed so #call the block with the object as the variable.
     end
-
   end
-
 end

data/lib/indifferent_eval/version.rb

@@ -0,0 +1,8 @@
+module IndifferentEval
+  begin
+    old, $VERBOSE = $VERBOSE, nil
+    VERSION = "0.2.0"
+  ensure
+    $VERBOSE = old
+  end
+end

data/lib/indifferent_eval.rb

@@ -1,3 +1,3 @@
-require File.dirname(__FILE__) + '/indifferent_eval/module'
+require 'indifferent_eval/module'
 
 Object.send :include, IndifferentEval

data/sample.rb

@@ -0,0 +1,32 @@
+# Run via: bundle exec rake sample
+require "indifferent_eval"
+
+class MyLibrary
+  def self.config(&block)
+    @config = MyConfig.new.indifferent_eval(&block) if block
+    @config
+  end
+
+  class MyConfig
+    attr_writer :some_setting
+
+    def some_setting(value = nil)
+      @some_setting = value if value
+      @some_setting
+    end
+  end
+end
+
+puts MyLibrary.config.inspect
+
+MyLibrary.config do |config|
+  config.some_setting = "Called a method with a block variable"
+end
+
+puts MyLibrary.config.inspect
+
+MyLibrary.config do
+  some_setting "Called a method without a block variable"
+end
+
+puts MyLibrary.config.inspect

data/spec/indifferent_eval_spec.rb

@@ -0,0 +1,86 @@
+require 'indifferent_eval'
+require 'rspec'
+
+# sample configuration object
+class SampleConfig
+  attr_accessor :value
+  def set_value(val) self.value = val end
+end
+
+# sample App class that has configuration
+class App
+  class << self; attr_accessor :config; end
+  @config = SampleConfig.new
+
+  def self.configure &block
+    indifferent_eval self.config, &block
+  end
+end
+
+# this one has built-in config variables and we'll call
+# indifferent_eval without an argument, so it should 
+# default to evaluating on self (the class)
+class App2
+  class << self; attr_accessor :value; end
+  def self.set_value(val) self.value = val end
+  
+  def self.configure &block
+    indifferent_eval &block
+  end
+end
+
+describe 'indifferent_eval' do
+
+  it 'should work with a block variable' do
+    App.config.value = nil
+    App2.value.should == nil
+
+    App.configure do |config|
+      config.set_value 'Hello'
+    end
+
+    App.config.value.should == 'Hello'
+  end
+
+  it 'should work without a block variable' do
+    App.config.value = nil
+    App2.value.should == nil
+
+    App.configure do
+      set_value 'Hello'
+    end
+
+    App.config.value.should == 'Hello'
+  end
+
+  it 'should have a good default (self) (should work with block variable)' do
+    App2.value = nil
+    App2.value.should == nil
+
+    App2.configure do |c|
+      c.set_value 'Hello'
+    end
+    App2.value.should == 'Hello'
+
+    App2.configure do |c|
+      c.value = 'There'
+    end
+    App2.value.should == 'There'
+  end
+
+  it 'should have a good default (self) (should work without block variable)' do
+    App2.value = nil
+    App2.value.should == nil
+
+    App2.configure do
+      set_value 'Hello'
+    end
+    App2.value.should == 'Hello'
+
+    App2.configure do
+      self.value = 'There'
+    end
+    App2.value.should == 'There'
+  end
+
+end

metadata

@@ -1,68 +1,92 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: indifferent_eval
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - remi
 autorequire: 
 bindir: bin
 cert_chain: []
+date: 2012-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Can''t decide between instance_eval and block.call?  Why not support
+  both!?
 
-date: 2011-02-04 00:00:00 -07:00
-default_executable: 
-dependencies: []
-
-description: Can't decide between instance_eval and block.call?  Why not support both!?
+'
 email: remi@remitaylor.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- .ci
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- indifferent_eval.gemspec
 - lib/indifferent_eval.rb
 - lib/indifferent_eval/module.rb
-has_rdoc: true
+- lib/indifferent_eval/version.rb
+- sample.rb
+- spec/indifferent_eval_spec.rb
 homepage: http://github.com/remi/indifferent_eval
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Can't decide between instance_eval and block.call?  Why not support both!?
-test_files: []
-
+test_files:
+- spec/indifferent_eval_spec.rb
+has_rdoc: