bzproxies 0.0.2 → 0.1.0

data/README.md

@@ -3,37 +3,68 @@ Bz proxies
 
 Description
 -----------
-Simple proxy and it's holder class module Owner
+Several proxies and it's holder class module Owner
+This bunch of proxies is just a result of my first steps and experiments with ruby metaprogramming.
+It has some issues (perfomance and others), so it will be nesessary to fork project if you would like to use it in production.
+
+Simple proxies use
+------------------
+First of all make a require call:
 
-Use
-----
     require 'bzproxies'
     
+Then, write your custom proxy (if needed), or just use Proxies::Base
+
     class MyProxy < Proxies::Base #alias Proxy
       def additional_methods
         "additional from proxy"
       end
     end
     
+You can use some objects that mimics objects covered by proxies:
+
     class SameFunctionalityClass
       include Proxies::Stub
       def additional_methods
         "additional from stub"
       end
     end
-    
+
+#TODO: create global function creting stub for concrete proxy (as same one in Delegate class).
+
+Than you may use proxy_accessor to specify attribute that will cover some given values with proxy:
+
     class MyProxyOwner
-      include Proxies::Owner #alias Owner
-      
       proxy_accessor :test, :proxy => MyProxy
     end
     
-    
     owner = MyProxyOwner.new
     
     owner.test = "test"
     owner.test.additional # => "additional from proxy"
-    owner.test.proxie? # => true
+    owner.test.proxy? # => true
     owner.test = SameFunctionalityClass.new
     owner.test.additional # => "additional from stub"
-    owner.test.proxie? # => false
+    owner.test.proxy? # => false
+    
+Array proxy use
+---------------
+Array proxy is an example of how you can implement your own proxy derived from Proxies::Base.
+This proxy covers each element with other proxy on initialization, push, unshift, << and other operations:
+    
+    class MyProxyOwner
+      proxy_accessor :children, :proxies => [ArrayProxy, MyProxy]
+      def initialize
+        self.children = []
+      end
+    end
+    
+    owner = MyProxyOwner.new
+    owner.children << "some test" << 123 << true
+    owner.children.map{|i| i.proxy?} # => [true,true,true]
+    
+Limitations
+-----------
+- You can't use proxied boolean and nil objects in boolean expressions.
+Ruby doesn't support weak references so covered object will always return true even if it's target is nil or false.
+- To setup object variables in methods use self.<accessor_name>= to stay them covered by proxy.

data/lib/bzproxies/array_proxy.rb

@@ -0,0 +1,37 @@
+require 'bzproxies/base'
+module Proxies
+  class ArrayProxy < Base
+    
+    def initialize *args
+      super
+      raise ::ArgumentError, "expected Array, given #{@target.class}" unless @target.kind_of? ::Array
+      unless @proxies.empty? || @target.nil?
+        proxy = @proxies.first
+        @target = @target.map do |i|
+          unless i.respond_to? :stub?
+            proxy.new i, :proxies => @proxies[1..-1]
+          else
+            i
+          end
+        end        
+      end
+    end
+    
+    [:concat, :fill, :flatten!, :insert, :map!, :push, :replace, :unshift, :<<].each do |meth|
+      define_method meth do |*args, &block|
+        @target.send meth, *args, &block
+        unless @proxies.empty? || @target.nil?
+          proxy = @proxies.first
+          @target = @target.map do |i|
+            unless i.respond_to? :stub?
+              proxy.new i, :proxies => @proxies[1..-1]
+            else
+              i
+            end
+          end
+        end
+      end
+    end
+    
+  end
+end

data/lib/bzproxies/base.rb

@@ -1,32 +1,54 @@
 require 'bzproxies/stub'
 require 'bzproxies/basic_object'
+require 'bzproxies/core_ext'
 
 module Proxies
   class Base < BasicObject
     include Stub
     
     attr_accessor :target
+    attr_reader :proxies
     
     alias non_recursive_target target
     
     def target
       begin
         @target.target
-      rescue
+      rescue ::NoMethodError
         non_recursive_target
-      end      
+      end
     end
     
     def proxy?
       true
+    end  
+
+    def respond_to? meth, hidden = false
+      metaclass = class << self; self; end
+      (metaclass.method_defined? meth) || (@target.respond_to? meth, hidden)
     end
     
-    def initialize entity = nil
-      @target = entity
+    def eql? any
+      class1 = (any.respond_to? :proxy?) ? (class << any; self; end).superclass : any.class
+      class2 = (class << self; self; end).superclass
+      (self == any) && (class1 == class2)
+    end
+    
+    def == any
+      (any.respond_to? :proxy?) ? @target == any.target : @target == any 
+    end
+          
+    def initialize *args
+      @target = args.first
+      @proxies = []
+      @proxies << args.last[:proxy] << args.last[:proxies] if (args.last.kind_of?(::Hash) && (args.length > 1))
+      @proxies.flatten!
+      @proxies.compact!
     end
     
     def method_missing m, *args, &block
-      @target.send m, *args, &block unless @target.nil?
+      @target.__send__ m, *args, &block
     end
+    
   end
 end

data/lib/bzproxies/basic_object.rb

@@ -1,5 +1,5 @@
 if RUBY_VERSION.gsub(/\D/, "").to_i < 190
   class BasicObject    
-    instance_methods.each { |m| undef_method m unless m =~ /(^__|^nil?$|^send$|^object_id$|^equal?$)/ }
+    instance_methods.each { |m| undef_method m unless m =~ /(^__|^send$|^object_id$|^equal?$)/ }
   end
 end

data/lib/bzproxies/core_ext.rb

@@ -1,5 +1,26 @@
+require 'bzproxies/owner'
+
 class Object
-  def stub?
-    false
+  include Proxies::Owner
+end
+
+class NilClass
+  alias old_equality ==
+  def == any
+    (any.respond_to? :target) ? old_equality(any.target) : old_equality(any) 
+  end
+end
+
+class TrueClass
+  alias old_equality ==
+  def == any
+    (any.respond_to? :target) ? old_equality(any.target) : old_equality(any) 
+  end
+end
+
+class FalseClass
+  alias old_equality ==
+  def == any
+    (any.respond_to? :target) ? old_equality(any.target) : old_equality(any) 
   end
 end

data/lib/bzproxies/owner.rb

@@ -1,28 +1,39 @@
-require "bzproxies/base"
 
 module Proxies
   module Owner
     
     def self.included(base)
-      base.send :extend, ClassMethods
+      base.send :extend, Accessors
     end
     
-    module ClassMethods
+    module Accessors
+      
       def proxy_reader(*args)
         args.pop if args.last.kind_of? Hash
         attr_reader *args
       end
       
       def proxy_writer(*args)
-        proxy = (args.pop[:proxy] if args.last.kind_of? Hash) || Proxies::Base
-        raise ArgumentError, "Unexpected proxy class. Expected class, given #{proxy.inspect}" unless proxy.respond_to? :new
+        proxies = []
+        if (args.last.kind_of?(::Hash) && (args.length > 1))
+          opts = args.pop
+          proxies << opts[:proxy] << opts[:proxies]
+        end
+        proxies.flatten!
+        proxies.compact!
+        proxy = proxies.shift || Proxies::Base
+        unless proxy.instance_methods.include? :proxy?
+          raise ArgumentError, "Expected proxy, given #{proxy.inspect} #{proxy.class}"
+        end
         args.each do |name|
-          raise ArgumentError, "Unexpected argument. Expected String or Symbol" unless name.kind_of? String or name.kind_of? Symbol
+          unless name.kind_of? String or name.kind_of? Symbol
+            raise ArgumentError, "Expected String or Symbol, given #{name.inspect} #{name.class}"
+          end
           define_method("#{name}=") do |v|
-            if v.stub?
+            if v.respond_to? :stub?
               val = v
             else
-              val = proxy.send :new, v
+              val = proxy.send :new, v, :proxies => proxies
             end
             instance_variable_set("@#{name}", val)
           end
@@ -32,9 +43,8 @@ module Proxies
       def proxy_accessor(*args)
         proxy_reader(*args)
         proxy_writer(*args)
-      end      
+      end
       
     end
-
   end
-end
+end

data/lib/bzproxies/version.rb

@@ -1,3 +1,3 @@
 module Bzproxies
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/bzproxies.rb

@@ -1,5 +1,7 @@
 require "bzproxies/version"
 require "bzproxies/base"
 require "bzproxies/owner"
-require "bzproxies/core_ext"
-Proxy = Proxies::Base
+require "bzproxies/array_proxy"
+Proxy = Proxies::Base
+Owner = Proxies::Owner
+ArrayProxy = Proxies::ArrayProxy

data/spec/{owner_spec.rb → accessors_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 
-describe Proxies::Owner do
+describe Proxies::Owner::Accessors do
   
   it "works when options hash ommited" do
     expect {Ex2.new}.not_to raise_error
@@ -11,7 +11,7 @@ describe Proxies::Owner do
     it "creates proxy object attr_accessor" do
       a = "source"
       owner = Ex1.new
-      owner.methods.should include :test
+      owner.methods.should include_one_of :test, "test"
       owner.test = Proxy.new(a)
       owner.test.proxy?.should be_true  #testing method
     end
@@ -20,7 +20,7 @@ describe Proxies::Owner do
   describe "proxy_writer" do
     it "creates attr write method" do
       owner = Ex2.new
-      owner.methods.should include :test=
+      owner.methods.should include_one_of :test=, "test="
     end
     
     it "covers non-proxy object with proxy" do
@@ -39,17 +39,47 @@ describe Proxies::Owner do
       owner.test = b
       owner.test.equal?(b).should be_true
     end
+    
+    it "should raise an exception while non-proxy class given" do
+      expect do
+        class Ex4
+          include Proxies::Owner
+          proxy_writer :test, :proxy => Array
+        end
+      end.to raise_exception(ArgumentError)
+    end
   end
   
-  it "could have it's own proxy for each attribute" do
+  it "have it's own proxy for each attribute" do
     owner = Ex3.new
     owner.test1 = "test"
     owner.test2 = "test"
-    
     owner.test1.check.should == MyProxy1
     owner.test2.check.should == MyProxy2
-    
   end
   
+  it "parse plural proxies option form" do
+    owner = Ex4.new
+    owner.test1 = "test"
+    owner.test1.check.should == MyProxy1
+  end
+  
+  it "parse multiple proxies" do
+    owner = Ex4.new
+    owner.test2 = "test"
+    owner.test2.check.should == MyProxy1
+  end
+  
+  it "passes additional proxies hash options to proxy instance" do
+    owner = Ex4.new
+    owner.test2 = "test"
+    owner.test2.proxies.should == [MyProxy2]
+  end
+  
+  it "works properly with array proxy" do
+    owner = Ex5.new
+    owner.children = [1,2]
+    owner.children.should each_respond_to :check
+  end
   
 end

data/spec/array_proxy_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe Proxies::ArrayProxy do  
+  
+  describe "initialization" do
+    it "raises an exception when initializing with non array" do
+      expect {Proxies::ArrayProxy.new "test"}.to raise_exception(ArgumentError)
+    end
+    
+    it "doesn't raise an exception while initializing with array" do
+      expect {Proxies::ArrayProxy.new ["test"]}.not_to raise_exception
+    end
+    
+    it "covers each element of given array with proxy" do
+      test = Proxies::ArrayProxy.new [1, 'two', :three], :proxies => TestCovering
+      test.should each_respond_to :test?
+      test.should_not each_respond_to :testother?
+    end
+  end
+  
+  def check any_array_proxy
+    
+  end
+  context "if proxies" do
+    before(:all) do
+      @test = [1,2,3]
+      @proxy = Proxies::ArrayProxy.new @test, :proxies => TestCovering
+    end
+    
+    it "have a copy of given array" do
+      @test.each do |i|
+        expect {i.proxy?}.to raise_exception(NoMethodError)
+      end
+      @test.should_not be_equal @proxy.target
+    end
+    
+    it "covers with this proxy each element that inserted into array" do
+      # [:replace, :unshift]
+      @proxy.should each_respond_to :test?
+      test1 = ["one", :two, [3]]
+      
+      @proxy.concat test1
+      @proxy.should each_respond_to :test?
+      
+      @proxy << "four"
+      @proxy.should each_respond_to :test?
+      
+      @proxy.fill "five"
+      @proxy.should each_respond_to :test?
+      
+      @proxy.insert 33, 33
+      @proxy.should each_respond_to :test?
+      
+      @proxy << [[["ababa"]]]
+      @proxy.flatten!
+      @proxy.should each_respond_to :test?
+      
+      @proxy.uniq!
+      (@proxy == ["five", nil, 33, "ababa"]).should be_true
+      (["five", nil, 33, "ababa"] == @proxy).should be_true
+      @proxy.should each_respond_to :test?
+      
+      @proxy.push "six"
+      @proxy.should each_respond_to :test?
+      
+      @proxy.unshift 7
+      @proxy.should each_respond_to :test?
+      
+      @proxy.map! {|i| i.to_s}
+      (@proxy == ["7", "five", "", "33", "ababa", "six"]).should be_true
+      @proxy.should each_respond_to :test?
+      
+      @proxy.replace [1,2,3,4,5]
+      @proxy.should each_respond_to :test?
+            
+    end
+  end
+  
+  context "if doesn't proxy" do
+    before(:all) do
+      @test = [1,2,3]
+      @proxy = Proxies::ArrayProxy.new @test
+    end
+    
+    it "have a given array" do
+      @test.should be_equal @proxy.target
+    end
+    
+    it "should not cover elements with proxies" do
+      @proxy.should_not any_respond_to :test?
+    end
+  end
+  
+end

data/spec/base_spec.rb

@@ -9,8 +9,10 @@ describe Proxies::Base do
     ((test.methods)+(test.class.methods)).should == meth
   end
   
-  it "stub? methods returns true" do
-    Proxy.new("source").stub?.should be_true
+  it "stub? and proxy? methods returns true" do
+    pr = Proxy.new("source")
+    pr.stub?.should be_true
+    pr.proxy?.should be_true
   end
   
   it "used by inherited proxy and doesnt proxy its own methods" do
@@ -38,4 +40,46 @@ describe Proxies::Base do
     two_level = Inherited.new(Proxy.new(a))
     a.should be_equal two_level.target
   end
+  
+  it "can take instance proxies hash while creating" do
+    a = "source"
+    test = Inherited.new(a, :proxies => Proxy)
+    test.proxies.should == [Proxy]
+    test2 = Proxy.new(a, :proxies => [Proxy, Proxy])
+    test2.proxies.should == [Proxy, Proxy]
+  end
+  
+  it "covers respond_to with it's own" do
+    a = "source"
+    test = Inherited.new a
+    (test.respond_to? :proxy?).should be_true
+    (test.respond_to? :some_other_than_proxy?).should be_false
+  end
+  
+  
+  it "should be eql and == for same and equal object proxies" do
+    a = false
+    test1 = Proxy.new a
+    test2 = Proxy.new a
+    test3 = Proxy.new false    
+      
+    (a == test1).should be_true
+    (a == test3).should be_true
+    (test1 == a).should be_true
+    (test3 == a).should be_true
+    
+    a.should_not be_eql test1
+    (test1.eql? a).should be_false
+    
+    (test1 == test2).should be_true
+    (test2 == test1).should be_true
+    (test1 == test3).should be_true
+    (test3 == test1).should be_true
+    
+    (test1.eql? test2).should be_true
+    (test2.eql? test1).should be_true
+    (test1.eql? test3).should be_true
+    (test3.eql? test1).should be_true
+  end
+  
 end

data/spec/fixtures/{owner.rb → accessors.rb}

@@ -1,7 +1,6 @@
 require 'bzproxies'
 
 class Ex1
-  include Proxies::Owner
   proxy_reader :test, :proxy => Proxies::Base
   def test= any
     @test = any
@@ -9,14 +8,13 @@ class Ex1
 end
 
 class Ex2
-  include Proxies::Owner
   proxy_writer :test
   def test
     @test
   end
 end
 
-class MyProxy1 < Proxy
+class MyProxy1 < Proxy  
   def check
     return ::MyProxy1
   end
@@ -29,7 +27,15 @@ class MyProxy2 < Proxy
 end
 
 class Ex3
-  include Proxies::Owner
   proxy_accessor :test1, :proxy => MyProxy1
   proxy_accessor :test2, :proxy => MyProxy2
+end
+
+class Ex4
+  proxy_accessor :test1, :proxies => MyProxy1
+  proxy_accessor :test2, :proxies => [MyProxy1, MyProxy2]
+end
+
+class Ex5
+  proxy_accessor :children, :proxies => [ArrayProxy, MyProxy1]
 end

data/spec/fixtures/array_proxy.rb

@@ -0,0 +1,7 @@
+require 'bzproxies'
+
+class TestCovering < Proxies::Base
+  def test?
+    true
+  end
+end

data/spec/fixtures/base.rb

@@ -1,4 +1,4 @@
-require "bzproxies"
+require 'bzproxies'
 
 class Inherited < Proxy
   def proxy_method

data/spec/matchers.rb

@@ -0,0 +1,46 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :include_one_of do |*params|
+  match do |enum|
+    result = false
+    params.each do |p|
+      if enum.include? p
+        result = true
+        break
+      end
+    end
+    result
+  end
+end
+
+RSpec::Matchers.define :each_respond_to do |*methods|
+  match do |enum|
+    result = true
+    methods.each do |meth|
+      enum.each do |elem|
+        unless elem.respond_to? meth.to_s
+          result = false
+          break
+        end
+      end
+      break if result == false
+    end
+    result
+  end
+end
+
+RSpec::Matchers.define :any_respond_to do |*methods|
+  match do |enum|
+    result = false
+    methods.each do |meth|
+      enum.each do |elem|
+        if elem.respond_to? meth.to_s
+          result = true
+          break
+        end
+      end
+      break if result == true
+    end
+    result
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 $:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 require 'bzproxies'
 require 'pathname'
+require 'matchers'
 
 #loading fixtures
 fpath = Pathname.new(File.dirname(__FILE__)) + "fixtures"

metadata

@@ -1,48 +1,44 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bzproxies
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Bombazook
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-10 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &75069720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *75069720
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &75069470 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.6"
+      - !ruby/object:Gem::Version
+        version: '2.6'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *75069470
 description: collection of reusable proxies and accessorsetc.
 email: bombazook@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - Gemfile
@@ -50,43 +46,43 @@ files:
 - Rakefile
 - bzproxies.gemspec
 - lib/bzproxies.rb
+- lib/bzproxies/array_proxy.rb
 - lib/bzproxies/base.rb
 - lib/bzproxies/basic_object.rb
 - lib/bzproxies/core_ext.rb
 - lib/bzproxies/owner.rb
 - lib/bzproxies/stub.rb
 - lib/bzproxies/version.rb
+- spec/accessors_spec.rb
+- spec/array_proxy_spec.rb
 - spec/base_spec.rb
+- spec/fixtures/accessors.rb
+- spec/fixtures/array_proxy.rb
 - spec/fixtures/base.rb
-- spec/fixtures/owner.rb
-- spec/owner_spec.rb
+- spec/matchers.rb
 - spec/spec_helper.rb
 homepage: http://github.com/bombazook/bzproxies
 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 
-      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 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: bzproxies
-rubygems_version: 1.8.10
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: collection of reusable proxies and accessors
 test_files: []
-