ObjectProxy 1.0.1

data/History.txt

@@ -0,0 +1,10 @@
+=== 1.0.1 / 2008-03-06
+
+* Added test for ObjectProxySafeHash
+
+=== 1.0.0 / 2008-03-05
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/object_proxy.rb
+lib/object_proxy_safe_hash.rb
+test/test_object_proxy.rb

data/README.txt

@@ -0,0 +1,77 @@
+= ObjectProxy
+
+* http://github.com/JackDanger/object_proxy/tree/master
+
+== DESCRIPTION
+
+ObjectProxy provides a proxied interface to Ruby objects.  It lets you add methods to objects that don't normally support them.
+
+== USAGE
+
+A simple extension to a fixnum:
+
+    fixnum = ObjectProxy.new(1234)
+    # => 1234
+    fixnum.proxy_class.class_eval do
+     define_method :hi_there do
+       'Ahoy!'
+     end
+    end
+    # => #<Proc:0x018f58f8>
+    fixnum.size
+    # => 4
+    fixnum.hi_there
+    # => Ahoy!
+
+A more complex example where a string is able to update itself from a text file
+
+    class FetchedString < ObjectProxy
+      def initialize(target, filename)
+        @target = target
+        @filename = filename
+      end
+      
+      def update
+        @target = File.read(filename)
+      end
+    end
+    
+    # write a string into a file
+    File.open('/tmp/greeting.txt', 'w') {|f| f.write('welcome')}
+    
+    string = FetchedString.new('hey there', '/tmp/greeting.txt')
+    # => 'hey there'
+    string.class
+    # => String
+    string.update
+    # => 'welcome'
+
+
+== INSTALL:
+
+* sudo gem install object_proxy
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/object_proxy.rb'
+
+Hoe.new('ObjectProxy', ObjectProxy::VERSION) do |p|
+  # p.rubyforge_name = 'ObjectProxyx' # if different than lowercase project name
+  p.remote_rdoc_dir = '' # Release to root
+  p.developer('Jack Danger Canty', 'rubygems_object_proxy@6brand.com')
+end
+
+# vim: syntax=Ruby

data/lib/object_proxy.rb

@@ -0,0 +1,40 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'object_proxy_safe_hash'
+
+class ObjectProxy
+  
+  VERSION = '1.0.1'
+
+  SAFE_METHODS = [:__id__, :__send__, :nil, :nil?, :send, :send!, :proxy_class, :proxy_respond_to?]
+  
+  alias_method :proxy_class, :class
+  alias_method :proxy_respond_to?, :respond_to?
+  
+  instance_methods.each do |method|
+    undef_method method unless SAFE_METHODS.include?(method.to_sym)
+  end
+  
+  def initialize(target)
+    @target = target
+  end
+  
+  def is_object_proxy?
+    true
+  end
+  
+  def target
+    @target
+  end
+  
+  def respond_to?(*args)
+    proxy_respond_to?(*args) || @target.respond_to?(*args)
+  end
+
+  protected
+
+    # delegate nearly all method calls to the @target object
+    def method_missing(method, *args, &block)
+      @target.send(method, *args, &block)
+    end
+end

data/lib/object_proxy_safe_hash.rb

@@ -0,0 +1,30 @@
+# This extension fixes that object proxies aren't interchangeable with their target
+# value for the purposes of hash lookup
+# The following becomes true in MRI:
+# 
+# {'some_string' => true}[ObjectProxy.new('some_string')]
+# 
+
+module ObjectProxySafeHash
+  def self.included(klass)
+    klass.class_eval do
+
+      define_method "[]_with_object_proxy" do |value|
+        if value.respond_to?(:is_object_proxy?) && value.is_object_proxy?
+          value = value.target
+        end
+        send "[]_without_object_proxy", value
+      end
+      
+      alias_method '[]_without_object_proxy', '[]'
+      alias_method '[]', '[]_with_object_proxy'
+    end
+
+  end
+end
+
+class Hash
+  unless included_modules.include?(ObjectProxySafeHash)
+    include ObjectProxySafeHash
+  end
+end

data/test/test_object_proxy.rb

@@ -0,0 +1,59 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/object_proxy'
+
+class OneHundredProxy < ObjectProxy
+  def initialize
+    @target = 100
+  end
+end
+
+class ObjectProxyTest < Test::Unit::TestCase
+  def test_does_not_respond_to_target
+    assert_raises(NoMethodError) { ObjectProxy.new('some_value').responds_to?(:target) }
+  end
+  
+  def test_has_target_method_that_returns_the_provided_value
+    assert_equal 'target', ObjectProxy.new('target')
+  end
+  
+  def test_target_object_does_not_have_identity_with_initialized_object
+    object = Object.new
+    assert !object.equal?(ObjectProxy.new(object))
+  end
+  
+  def test_class_method_is_passed_to_target
+    assert_equal String, ObjectProxy.new('some value').class
+  end
+  
+  def test_send_is_passed_to_target
+    object = 'ABCDEF'
+    assert_equal object.send(:length), ObjectProxy.new(object).send(:length)
+  end
+  
+  def test_proxy_class_accesses_the_class_of_the_object_proxy
+    assert_equal ObjectProxy, ObjectProxy.new('value').proxy_class
+  end
+  
+  def test_proxy_class_allows_methods_added_to_the_proxy_class
+    object = 'ABCDEF'
+    proxy = ObjectProxy.new(object)
+    proxy.proxy_class.class_eval do
+      define_method :return_target do
+        @target
+      end
+    end
+    assert_equal object, proxy.return_target
+  end
+  
+  def test_method_missing_errors_are_raised_from_the_target_object
+    begin
+      ObjectProxy.new(12345).howzitgoin
+    rescue => e
+      assert_equal %Q(undefined method `howzitgoin' for 12345:Fixnum), e.message
+    end
+  end
+  
+  def test_subclass_of_object_proxy_can_set_target_however_it_wants
+    assert_equal 100, OneHundredProxy.new.target
+  end
+end

data/test/test_object_proxy_safe_hash.rb

@@ -0,0 +1,10 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/object_proxy'
+
+class ObjectProxySafeHashTest < Test::Unit::TestCase
+  def test_object_proxy_identifies_as_target_for_hash_lookup
+    object = 'a string'
+    hash = {object => true}
+    assert hash[ObjectProxy.new(object)]
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: ObjectProxy
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Jack Danger Canty
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-06 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: ObjectProxy provides a proxied interface to Ruby objects.  It lets you add methods to objects that don't normally support them.
+email: 
+- rubygems_object_proxy@6brand.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/object_proxy.rb
+- lib/object_proxy_safe_hash.rb
+- test/test_object_proxy.rb
+has_rdoc: true
+homepage: http://github.com/JackDanger/object_proxy/tree/master
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: objectproxy
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: ObjectProxy provides a proxied interface to Ruby objects
+test_files: 
+- test/test_object_proxy.rb
+- test/test_object_proxy_safe_hash.rb