surrounded 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63bac757a4c7f7b9cb953a51123e31dc3612fa22
-  data.tar.gz: 1afa12d700b0756ce4e22becf4555169d8e4fa10
+  metadata.gz: 8dcba3d11c7217ae50aa36d19f84c1a835734a22
+  data.tar.gz: c6981dbd112701103491e1919fa2819a334aedc5
 SHA512:
-  metadata.gz: 4d508948a224105b736246b96f0a0a8dec5d9bccd9f2000429071135481fe09a3ecac7963e37e684940411a1d02bf89f5697810593469acbc47b7013e4a95820
-  data.tar.gz: 1f68568474713853a086aef3c3e09ce292fbd66dca77c00c68f32afe11a30af593d159ba76c56f31765dd049063646b214f0bf556a302f9fd07be242274f4db1
+  metadata.gz: 887d99c878678e8f8a49dd71b8214fc4766ba5028ff65071f9c0634946256503e0aee8ff1c55ef37751aee730026a117db76d9f6424239333b4fcdbe56f6435b
+  data.tar.gz: cf09e9f3710d6f726c9c58dbd08cb3087b14873aa9248a37f1d753d9c004a5a568d3a1204e14ccc2ed053f74f7be32e8d91764187e0e5cc8af64612f1b23f1b3

data/README.md

@@ -553,17 +553,18 @@ Using the `role` method to define modules and classes takes care of the setup fo
   role :source, :interface do
     def transfer
       self.balance -= amount
-      destination.balance += amount
+      # not able to access destination
+      # destination.balance += amount
       self
     end
   end
 ```
 
-The `:interface` option is a special object which has all of the standard Object methods removed (excepting `__send__` and `object_id`) so that other methods will be pulled from the ones that you define, or from the object it attempts to proxy.
+The `:interface` option is a special object which has all of the standard Object methods removed (excepting ones like `__send__` and `object_id`) so that other methods will be pulled from the ones that you define, or from the object it attempts to proxy.
 
 Notice that the `:interface` allows you to return `self` whereas the `:wrap` acts more like a wrapper and forces you to deal with that shortcoming by using it's wrapped-object-accessor method: `__getobj__`.
 
-The downside of using an interface is that it is still a wrapper. All of your defined role methods are executed in the context of the object playing the role, but the interface has it's own identity.
+The downside of using an interface is that it is still a wrapper and it doesn't have access to the other objects in the context. All of your defined role methods are executed in the context of the object playing the role, but the interface has it's own identity.
 
 If you'd like to choose one and use it all the time, you can set the default:
 
@@ -571,13 +572,13 @@ If you'd like to choose one and use it all the time, you can set the default:
 class MoneyTransfer
   extend Surrounded::Context
 
-  self.default_role_type = :interface # also :wrap, :wrapper, or :module
+  self.default_role_type = :wrapper # also :wrap, :interface, or :module
 
   role :source do
     def transfer
       self.balance -= amount
       destination.balance += amount
-      self
+      __getobj__
     end
   end
 end
@@ -586,7 +587,7 @@ end
 Or, if you like, you can choose the default for your entire project:
 
 ```ruby
-Surrounded::Context.default_role_type = :interface
+Surrounded::Context.default_role_type = :wrap
 
 class MoneyTransfer
   extend Surrounded::Context
@@ -595,7 +596,7 @@ class MoneyTransfer
     def transfer
       self.balance -= amount
       destination.balance += amount
-      self
+      __getobj__
     end
   end
 end
@@ -717,6 +718,7 @@ class ActiviatingAccount
   disallow :some_trigger_method do
     # whatever conditional code for the instance of the context
   end
+  # you could also use `guard` instead of `disallow`
   
   # or define your own method without the `disallow` keyword
   def disallow_some_trigger_method?

data/lib/surrounded.rb

@@ -1,5 +1,6 @@
 require "surrounded/version"
 require "surrounded/context"
+require "singleton"
 
 # This module should be added to objects which will enter
 # into context objects. 
@@ -28,7 +29,7 @@ module Surrounded
   end
 
   def context
-    surroundings.first || NullContext.new
+    surroundings.first || NullContext.instance
   end
 
   def method_missing(meth, *args, &block)
@@ -40,6 +41,7 @@ module Surrounded
   end
 
   class NullContext
+    include Singleton
     def role?(*args)
       nil
     end

data/lib/surrounded/access_control.rb

@@ -14,7 +14,7 @@ module Surrounded
         define_access_method(name, &block)
       end
     end
-    alias_method :guard, :disallow
+    alias guard disallow
     
     def trigger_return_content(name, *args, &block)
       %{

data/lib/surrounded/context.rb

@@ -116,8 +116,20 @@ module Surrounded
         self.class.triggers
       end
 
+      def rebind(options_hash)
+        clear_instance_variables
+        initialize(options_hash.to_a)
+      rescue ArgumentError
+        initialize(*options_hash.values)
+        self
+      end
+
       private
 
+      def clear_instance_variables
+        instance_variables.each{|ivar| remove_instance_variable(ivar) }
+      end
+
       def role_map
         @role_map ||= role_mapper_class.new
       end

data/lib/surrounded/context/initializing.rb

@@ -10,7 +10,6 @@ module Surrounded
         line = __LINE__
         mod.class_eval "
           def initialize(#{setup_args.join(',')})
-            @role_map = role_mapper_class.new
             map_roles(#{setup_args.to_s}.zip([#{setup_args.join(',')}]))
           end
         ", __FILE__, line

data/lib/surrounded/context/negotiator.rb

@@ -14,24 +14,30 @@ module Surrounded
               end
             }, __FILE__, num
           end
+          klass.send(:define_method, :__behaviors__) do
+            mod
+          end
           klass
         end
       end
 
 
-      identity = "__send__|object_id"
+      identity = %w[__send__ object_id equal?]
+      method_access = %w[respond_to? method __behaviors__]
+
+      reserved_methods = (identity + method_access).join('|')
 
       # Remove all methods except the identity methods
       instance_methods.reject{ |m|
-        m.to_s =~ /#{identity}/
+        m.to_s =~ /#{reserved_methods}/
       }.each do |meth|
         undef_method meth
       end
 
       private
 
-      def initialize(object, behaviors)
-        @object, @behaviors = object, behaviors
+      def initialize(object)
+        @object, @behaviors = object, __behaviors__
       end
 
       def method_missing(meth, *args, &block)

data/lib/surrounded/context/role_builders.rb

@@ -13,7 +13,7 @@ module Surrounded
           meth.call(name, &block)
         end
       rescue NameError => e
-        raise e.extend(InvalidRoleType)
+        raise InvalidRoleType, e.message
       end
       alias_method :role_methods, :role
 
@@ -36,20 +36,22 @@ module Surrounded
         klass.send(:include, Surrounded)
       end
 
-      # Create an object which will bind methods to the role player
+      # Create an object which will bind methods to the role player.
+      #
+      # This object will behave differently that a wrapper or delegate_class.
+      # The interface object should only be used for objects whose methods
+      # _will not_ call to the other objects in the context.
+      # Because the interface methods are applied individually to an object,
+      # that object is unaware of the other objects in the context and cannot
+      # access them from any of its methods.
       def interface(name, &block)
         # AdminInterface
         interface_name = RoleName(name, 'Interface')
         behavior = private_const_set(interface_name, Module.new(&block))
 
         require 'surrounded/context/negotiator'
-        undef_method(name)
-
-        # AdminInterfaceProxy
-        proxy = private_const_set(RoleName(interface_name, 'Proxy'), Negotiator.for_role(behavior))
-        define_method(name) do
-          instance_variable_set("@#{name}", proxy.new(role_map.assigned_player(name), behavior))
-        end
+        # Admin
+        private_const_set(RoleName(name), Negotiator.for_role(behavior))
       end
       
       private

data/lib/surrounded/context_errors.rb

@@ -2,7 +2,15 @@ require 'triad'
 module Surrounded
   module Context
     class InvalidRole < ::Triad::ItemNotPresent; end
-    module InvalidRoleType; end
+    class InvalidRoleType < ::StandardError
+      unless method_defined?(:cause)
+        def initialize(msg=nil)
+          super
+          @cause = $!
+        end
+        attr_reader :cause
+      end
+    end
     class AccessError < ::StandardError; end
   end
 end

data/lib/surrounded/version.rb

@@ -1,5 +1,5 @@
 module Surrounded
-  VERSION = "0.9.4"
+  VERSION = "0.9.5"
   
   def self.version
     VERSION

data/test/example_proxy_test.rb

@@ -1,6 +1,5 @@
 require 'test_helper'
 
-# If you want to use wrappers, here's how you could
 class ProxyContext
   extend Surrounded::Context
 
@@ -34,10 +33,17 @@ class ProxyContext
   trigger :admin_missing_method do
     admin.method_that_does_not_exist
   end
+
+  trigger :admin_responds? do
+    admin.respond_to?(:talking_to_others)
+  end
+
+  trigger :get_admin_method do
+    admin.method(:talking_to_others)
+  end
 end
 
 ProxyUser = Class.new do
-  include Surrounded
   def initialize(name)
     @name = name
   end
@@ -68,7 +74,25 @@ describe ProxyContext do
     assert_match(/ProxyUser.*name="Jim"/, err.message)
   end
 
-  it 'allows access to other objects in the context' do
-    assert_equal 'GTD', context.talking
+  it 'fails access to other objects in the context' do
+    err = _{ context.talking }.must_raise NameError
+    assert_match(%r{undefined local variable or method `task'}, err.message)
+  end
+
+  it 'sets roles to respond to role methods' do
+    assert context.admin_responds?
+  end
+
+  it 'is able to grab methods from the object' do
+    assert_equal :talking_to_others, context.get_admin_method.name
+  end
+
+  it 'works with frozen and primitive objects' do
+    context.rebind(admin: "brrr".freeze, task: task)
+    assert context.get_admin_method
+    context.rebind(admin: nil, task: task)
+    assert context.get_admin_method
+    context.rebind(admin: true, task: task)
+    assert context.get_admin_method
   end
 end

data/test/role_context_method_test.rb

@@ -89,14 +89,15 @@ describe Surrounded::Context, '.role' do
  
   describe 'unknown' do
     it 'raises an error' do
-      assert_raises(Surrounded::Context::InvalidRoleType){
+      err = _{
         class UnknownRole
           extend Surrounded::Context
  
           role :admin, :unknown do
           end
         end
-      }
+      }.must_raise Surrounded::Context::InvalidRoleType
+      _(err.cause).must_be_kind_of NameError
     end
   end
  

data/test/surrounded_context_test.rb

@@ -259,6 +259,27 @@ describe Surrounded::Context, 'auto-assigning roles for collections' do
   end
 end
 
+describe Surrounded::Context, 'reusing context object' do
+  let(:user){ User.new("Jim") }
+  let(:other_user){ User.new("Guille") }
+  let(:context){ TestContext.new(user, other_user) }
+
+  it 'allows rebinding new players' do
+    expect(context.access_other_object).must_equal 'Guille'
+    context.rebind(user: User.new('Amy'), other_user: User.new('Elizabeth'))
+    expect(context.access_other_object).must_equal 'Elizabeth'
+  end
+
+  it 'clears internal storage when rebinding' do
+    originals = context.instance_variables.map{|var| context.instance_variable_get(var) }
+    context.rebind(user: User.new('Amy'), other_user: User.new('Elizabeth'))
+    new_ivars = context.instance_variables.map{|var| context.instance_variable_get(var) }
+    originals.zip(new_ivars).each do |original_ivar, new_ivar|
+      expect(original_ivar).wont_equal new_ivar
+    end
+  end
+end
+
 begin
   class Keyworder
     extend Surrounded::Context

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surrounded
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - "'Jim Gay'"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-15 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: triad