selective_binding 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2010-10-18
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+bin/selective_binding
+lib/selective_binding.rb
+test/test_selective_binding.rb

data/README.rdoc

@@ -0,0 +1,67 @@
+= selective_binding
+
+* http://github.com/yaksnrainbows/selective_binding
+
+== DESCRIPTION:
+
+Create Bindings with selective mappings to an object's methods and attributes.
+
+== SYNOPSIS:
+
+Creates a selective binding instance for self and returns
+the newly created binding:
+
+  selective_binding :attr1, :method1
+  #=> <#Binding>
+
+Passing a hash as the last argument allows for setting custom attributes.
+These override any previously defined forwarded methods:
+
+  selective_binding :attr1 => "custom value"
+  #=> <#Binding>
+
+Passing a block is also supported to set the default value for undefined
+attributes or methods:
+
+  selective_binding do
+    "default value"
+  end
+  #=> <#Binding>
+
+== INSTALL:
+
+* sudo gem install selective_binding
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Jeremie Castagna
+
+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/Rakefile

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'selective_binding' do
+  developer 'Jeremie Castagna', 'yaksnrainbows@gmail.com'
+  self.summary =
+    "Bindings with selective mappings to object methods and attributes."
+end
+
+# vim: syntax=ruby

data/bin/selective_binding

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+abort "you need to write me"

data/lib/selective_binding.rb

@@ -0,0 +1,150 @@
+##
+# Create a selective binding. Useful for controlling ERB builds.
+# The following will allow MyObj instances to provide a binding that will only
+# expose MyObj#my_attr and MyObj#get_some_value:
+#
+#   require 'selective_binding'
+#
+#   class MyObj
+#     attr_accessor :my_attr
+#
+#     def modify_something
+#       # Don't want this exposed in binding!
+#     end
+#
+#     def get_some_value
+#       # Want this exposed in binding.
+#       "some value"
+#     end
+#
+#     def get_binding
+#       selective_binding :my_attr, :get_some_value
+#     end
+#   end
+#
+#   my_obj = MyObj.new
+#
+#   eval "get_some_value", my_obj.get_binding
+#   #=> "some value"
+#
+#   eval "modify_something", my_obj.get_binding
+#   #=> NameError: undefined local variable or method `modify_something'
+#
+# Additionally, a block can be passed to selective bindings to fill the role of
+# a default value, or method_missing.
+
+class SelectiveBinding
+
+  # Gem Version
+  VERSION = '1.0.0'
+
+  ##
+  # Creates a new selective binding with the target object to
+  # create a binding to.
+
+  def initialize target
+    @target = target
+  end
+
+
+  ##
+  # Set the binding instance variable and accessor method.
+  #   selective_binding.set :server_name, "blah.com"
+
+  def set key, value=nil, &block
+    value ||= block if block_given?
+
+    instance_variable_set("@#{key}", value)
+
+    eval_str = <<-STR
+      undef #{key} if defined?(#{key})
+      def #{key}(*args, &block)
+        if Proc === @#{key}
+          @#{key}.call(*args, &block)
+        else
+          @#{key}
+        end
+      end
+    STR
+
+    instance_eval eval_str, __FILE__, __LINE__ + 1
+  end
+
+
+  ##
+  # Takes a hash and assign each hash key/value as an attribute:
+  #   selective_binding.import_hash :attr1 => "value1",
+  #                                 :attr2 => "value2"
+
+  def import_hash hash
+    hash.each{|k, v| self.set(k, v)}
+  end
+
+
+  ##
+  # Forward a method to the server instance.
+  #   binder.forward :method1, :method2, ...
+
+  def forward *method_names
+    method_names.each do |method_name|
+      instance_eval <<-STR, __FILE__, __LINE__ + 1
+      undef #{method_name} if defined?(#{method_name})
+      def #{method_name}(*args, &block)
+        @target.send(#{method_name.to_sym.inspect}, *args, &block)
+      end
+      STR
+    end
+  end
+
+
+  ##
+  # Sets the default value for undefined attributes or methods.
+
+  def set_default value=nil, &block
+    set :method_missing, value, &block if value || block_given?
+  end
+
+
+  ##
+  # Retrieve the object's binding.
+
+  def get_binding
+    binding
+  end
+end
+
+
+class Object
+
+  ##
+  # Creates a selective binding instance for self and returns
+  # the newly created binding:
+  #
+  #   selective_binding :attr1, :method1
+  #   #=> <#Binding>
+  #
+  # Passing a hash as the last argument allows for setting custom attributes.
+  # These override any previously defined forwarded methods:
+  #
+  #   selective_binding :attr1 => "custom value"
+  #   #=> <#Binding>
+  #
+  # Passing a block is also supported to set the default value for undefined
+  # attributes or methods:
+  #
+  #   selective_binding do
+  #     "default value"
+  #   end
+  #   #=> <#Binding>
+
+  def selective_binding *methods, &block
+    hash_attrib = methods.delete_at(-1) if Hash === methods.last
+
+    binder = SelectiveBinding.new self
+
+    binder.forward(*methods)       unless methods.empty?
+    binder.import_hash hash_attrib if hash_attrib
+    binder.set_default(&block)     if block_given?
+    binder.get_binding
+  end
+end

data/test/test_selective_binding.rb

@@ -0,0 +1,142 @@
+require "test/unit"
+require "selective_binding"
+
+class TestSelectiveBinding < Test::Unit::TestCase
+
+  class MockObj
+    attr_accessor :obj_attr1, :obj_attr2, :obj_attr3
+  end
+
+
+  def setup
+    @obj = MockObj.new
+    @obj.obj_attr1 = "value1"
+    @obj.obj_attr2 = "value2"
+    @obj.obj_attr3 = "value3"
+    @binder = SelectiveBinding.new @obj
+  end
+
+
+  def test_set
+    @binder.set :other_attr, "my_value"
+    assert_binding_value @binder, :other_attr => "my_value"
+  end
+
+
+  def test_set_block
+    @binder.set :other_attr do
+      "something else"
+    end
+
+    assert_binding_value @binder, :other_attr => "something else"
+  end
+
+
+  def test_set_value_block
+    @binder.set :other_attr, "thing" do
+      "block value"
+    end
+
+    assert_binding_value @binder, :other_attr => "thing"
+  end
+
+
+  def test_import_hash
+    @binder.import_hash :attr1 => "val1",
+                        :attr2 => "val2"
+
+    assert_binding_value @binder, :attr1 => "val1",
+                                  :attr2 => "val2"
+  end
+
+
+  def test_forward
+    @binder.forward :obj_attr1, :obj_attr2
+
+    assert_binding_value @binder, :obj_attr1 => @obj.obj_attr1,
+                                  :obj_attr2 => @obj.obj_attr2
+
+    assert_not_binding_value @binder, :obj_attr3
+
+    @binder.forward :obj_attr3
+    assert_binding_value @binder, :obj_attr3 => @obj.obj_attr3
+  end
+
+
+  def test_set_default
+    @binder.forward :obj_attr1, :obj_attr2
+    @binder.set_default "DEFAULT VALUE!"
+
+    assert_binding_value @binder, :undefined => "DEFAULT VALUE!",
+                                  :obj_attr1 => @obj.obj_attr1,
+                                  :obj_attr2 => @obj.obj_attr2
+  end
+
+
+  def test_set_default_block
+    @binder.forward :obj_attr1, :obj_attr2
+
+    @binder.set_default do
+      "NEW DEFAULT VALUE!"
+    end
+
+    assert_binding_value @binder, :undefined => "NEW DEFAULT VALUE!",
+                                  :obj_attr1 => @obj.obj_attr1,
+                                  :obj_attr2 => @obj.obj_attr2
+  end
+
+
+  def test_obj_selective_binding
+    b = selective_binding :forwarded_method
+    assert_binding_value b, :forwarded_method => forwarded_method
+    assert_not_binding_value b, :not_forwarded
+  end
+
+
+  def test_obj_selective_binding_hash
+    b = selective_binding :forwarded_method, :forwarded_method => "custom attr"
+
+    assert_binding_value b, :forwarded_method => "custom attr"
+
+    assert_not_binding_value b, :not_forwarded
+  end
+
+
+  def test_obj_selective_binding_block
+    b = selective_binding do
+          "DEFAULT VALUE!"
+        end
+
+    assert_binding_value b, :forwarded_method => "DEFAULT VALUE!"
+  end
+
+
+  private
+
+  def not_forwarded
+    raise "This method should not be accessible from the binding"
+  end
+
+
+  def forwarded_method
+    "FORWARDED METHOD"
+  end
+
+
+  def assert_binding_value binding, hash
+    binding = binding.get_binding if SelectiveBinding === binding
+    hash.each do |key, value|
+      assert_equal eval("#{key}", binding), value
+    end
+  end
+
+
+  def assert_not_binding_value binding, *keys
+    binding = binding.get_binding if SelectiveBinding === binding
+    keys.each do |key|
+      assert_raises NameError do
+        eval("#{key}", binding)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: selective_binding
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jeremie Castagna
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 6
+        - 2
+        version: 2.6.2
+  type: :development
+  version_requirements: *id002
+description: ""
+email: 
+- yaksnrainbows@gmail.com
+executables: 
+- selective_binding
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/selective_binding
+- lib/selective_binding.rb
+- test/test_selective_binding.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: selective_binding
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Bindings with selective mappings to object methods and attributes.
+test_files: 
+- test/test_selective_binding.rb