surrounded 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dcba3d11c7217ae50aa36d19f84c1a835734a22
-  data.tar.gz: c6981dbd112701103491e1919fa2819a334aedc5
+  metadata.gz: 3ebcadc33e8f51d132862e8b648a6d4a2bd15cc0
+  data.tar.gz: 1626655dd9057674364a2e3ba8ced482e89b156e
 SHA512:
-  metadata.gz: 887d99c878678e8f8a49dd71b8214fc4766ba5028ff65071f9c0634946256503e0aee8ff1c55ef37751aee730026a117db76d9f6424239333b4fcdbe56f6435b
-  data.tar.gz: cf09e9f3710d6f726c9c58dbd08cb3087b14873aa9248a37f1d753d9c004a5a568d3a1204e14ccc2ed053f74f7be32e8d91764187e0e5cc8af64612f1b23f1b3
+  metadata.gz: 514db8e6ef0df0df0e9ffba94df4ea3217c6fd8eb37d4bc187913599695b4bfdfd5610062ffb8a31f700d884eef4ef91890204052906f60641ff164e46f19046
+  data.tar.gz: a982f5d589c10ca7984273f4ced59520252a8425b5266b35beca3e1fdd5e93823ec80ce65f2397fb460514625c2c9c6a1883e95d106c6e41906cfe28f6e4520b

data/README.md

@@ -553,8 +553,8 @@ Using the `role` method to define modules and classes takes care of the setup fo
   role :source, :interface do
     def transfer
       self.balance -= amount
-      # not able to access destination
-      # destination.balance += amount
+      # not able to access destination unless the object playing source is Surrounded
+      destination.balance += amount
       self
     end
   end
@@ -564,7 +564,7 @@ The `:interface` option is a special object which has all of the standard Object
 
 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 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.
+The downside of using an interface is that it is still a wrapper and it only has access to the other objects in the context if the wrapped object already includes Surrounded. 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:
 
@@ -572,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 = :wrapper # also :wrap, :interface, or :module
+  self.default_role_type = :interface # also :wrap, :wrapper, or :module
 
   role :source do
     def transfer
       self.balance -= amount
       destination.balance += amount
-      __getobj__
+      self
     end
   end
 end
@@ -587,7 +587,7 @@ end
 Or, if you like, you can choose the default for your entire project:
 
 ```ruby
-Surrounded::Context.default_role_type = :wrap
+Surrounded::Context.default_role_type = :interface
 
 class MoneyTransfer
   extend Surrounded::Context
@@ -596,7 +596,7 @@ class MoneyTransfer
     def transfer
       self.balance -= amount
       destination.balance += amount
-      __getobj__
+      self
     end
   end
 end
@@ -614,7 +614,9 @@ would be given behavior from a `Member` behavior module or class if you create o
 
 ```ruby
 class Organization
-  initialize :leader, :members
+  extend Surrounded::Context
+
+  initialize_without_keywords :leader, :members
   
   role :members do
     # special behavior for the collection
@@ -626,6 +628,15 @@ class Organization
 end
 ```
 
+## Reusing context objects
+
+If you create a context object and need to use the same type of object with new role players, you may use the `rebind` method. It will clear any instance_variables from your context object and map the given objects to their names:
+
+```ruby
+context = Employment.new(current_user, the_boss)
+context.rebind(employee: another_user, boss: someone_else) # same context, new players
+```
+
 ## Overview in code
 
 Here's a view of the possibilities in code.
@@ -747,6 +758,19 @@ class ActiviatingAccount
   forward_triggers :role_name, :list, :of, :methods, :to, :forward
   forwarding [:list, :of, :methods, :to, :forward] => :role_name
 end
+
+# with keyword_initialize (will be changed to initialize)
+context = ActiviatingAccount.new(activator: some_object, account: some_account)
+# with initialize (this will be moved to initialize_without_keywords)
+context = ActiviatingAccount.new(some_object, some_account)
+context.triggers # => lists a Set of triggers
+# when using protect_triggers
+context.triggers # => lists a Set of triggers which may currently be called
+context.triggers # => lists a Set of all triggers (the same as if protect_triggers was _not_ used)
+context.allow?(:trigger_name) # => returns a boolean if the trigger may be run
+
+# reuse the context object with new role players
+context.rebind(activator: another_object, account: another_account)
 ```
 
 ## Dependencies

data/lib/surrounded/context/negotiator.rb

@@ -7,16 +7,19 @@ module Surrounded
         # This prevents hits to method_missing.
         def for_role(mod)
           klass = Class.new(self)
+          # Define access to the provided module
+          klass.send(:define_method, :__behaviors__) do
+            mod
+          end
+          # For each method in the module, directly forward to the wrapped object to
+          # circumvent method_missing
           mod.instance_methods(false).each do |meth|
             num = __LINE__; klass.class_eval %{
               def #{meth}(*args, &block)
-                @behaviors.instance_method(:#{meth}).bind(@object).call(*args, &block)
+                __behaviors__.instance_method(:#{meth}).bind(@object).call(*args, &block)
               end
             }, __FILE__, num
           end
-          klass.send(:define_method, :__behaviors__) do
-            mod
-          end
           klass
         end
       end
@@ -27,17 +30,31 @@ module Surrounded
 
       reserved_methods = (identity + method_access).join('|')
 
-      # Remove all methods except the identity methods
+      # Remove all methods except the reserved methods
       instance_methods.reject{ |m|
         m.to_s =~ /#{reserved_methods}/
       }.each do |meth|
         undef_method meth
       end
 
+      include Surrounded
+
       private
 
+      # Store the context in the wrapped object if it can do so
+      def store_context(&block)
+        if @object.respond_to?(__method__, true)
+          @object.send(__method__, &block)
+        else
+          super
+        end
+        self
+      end
+      # These only differ in the message they send
+      alias remove_context store_context
+
       def initialize(object)
-        @object, @behaviors = object, __behaviors__
+        @object = object
       end
 
       def method_missing(meth, *args, &block)
@@ -48,10 +65,5 @@ module Surrounded
         @object.respond_to?(meth, include_private)
       end
     end
-
-    # The method_missing definition from Surrounded will apply
-    # before the one defined above. This allows the methods for
-    # the objects in the context to work properly
-    Negotiator.send(:prepend, Surrounded)
   end
 end

data/lib/surrounded/context.rb

@@ -118,7 +118,7 @@ module Surrounded
 
       def rebind(options_hash)
         clear_instance_variables
-        initialize(options_hash.to_a)
+        initialize(options_hash)
       rescue ArgumentError
         initialize(*options_hash.values)
         self

data/lib/surrounded/version.rb

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

data/test/example_proxy_test.rb

@@ -87,6 +87,10 @@ describe ProxyContext do
     assert_equal :talking_to_others, context.get_admin_method.name
   end
 
+  it 'allows Surrounded objects to interact with others' do
+    assert context.rebind(user: User.new('Surrounded'), task: task).talking
+  end
+
   it 'works with frozen and primitive objects' do
     context.rebind(admin: "brrr".freeze, task: task)
     assert context.get_admin_method

metadata

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