surrounded 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a0524827a23eeb3aa9829988d8d5bc7773e81ca
-  data.tar.gz: ad49086b9e50454fbfb31c143d5428d52d46c0f9
+  metadata.gz: fcd5a235a5131c97780460591911ce275b460907
+  data.tar.gz: e5662f4dfbfdae0f22f3832b7d259c7bb6daa9e0
 SHA512:
-  metadata.gz: d84eaf1f7907b2b6c6a80e585721104916142f47fb79b4d5ccee6abdd6516868b7c08463234a38ea0d5f713914c11facef87abff0434ff3b9dc140e03da22100
-  data.tar.gz: eeb0bd64cf19f0d7e8ecd17df70d77f2ecc4e193ec95f952f95fda2f504e1fd8182beb92c953e6a4ab0e64475795b38f6c253bab820a705bb61901131d38db10
+  metadata.gz: 6ee26aa514d524c218dde785998a696b90686e3d3952a094613920ff987e2da1abf387c1d6e44b114e8f5093299979a9d7c26f721956ab036a4a67e55a32bcfb
+  data.tar.gz: f16d747a27f0af4fdfe0b4b9376a87d3d1a2a026b91d6c8019fc89ca9256805a9ad6bc911405677b19c89d1089a5310f3fed375046d6734b5249b724ad5698f5

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.1
   - jruby-19mode # JRuby in 1.9 mode
   - ruby-head
   - jruby-head

data/README.md

@@ -340,7 +340,7 @@ Using the `role` method to define modules and classes takes care of the setup fo
 
 ```ruby
 
-  # this uses modules
+  # this uses modules which include Surrounded
   role :source do
     def transfer
       self.balance -= amount
@@ -409,6 +409,30 @@ class MoneyTransfer
 end
 ```
 
+## Working with collections
+
+If you want to use an Array of objects (for example) as a role player in your context,
+you may do so. If you want each item in your collection to gain behavior, you merely need to
+create a role for the items.
+
+Surrounded will attempt to guess at the singular role name. For example, a role player named `members` would
+be given the behaviors from a `Members` behavior module or class. Each item in your `members` collection
+would be given behavior from a `Member` behavior module or class if you create one.
+
+```ruby
+class Organization
+  initialize :leader, :members
+  
+  role :members do
+    # special behavior for the collection
+  end
+  
+  role :member do
+    # special behavior to be applied to each member in the collection
+  end  
+end
+```
+
 ## Policies for the application of role methods
 
 There are 2 approaches to applying new behavior to your objects.

data/lib/surrounded.rb

@@ -16,6 +16,7 @@ module Surrounded
     if accessor.role_player?(self)
       surroundings.unshift(ctxt)
     end
+    self
   end
 
   def remove_context(&block)
@@ -23,6 +24,7 @@ module Surrounded
     if accessor.role_player?(self)
       surroundings.shift
     end
+    self
   end
 
   def surroundings

data/lib/surrounded/access_control.rb

@@ -14,25 +14,18 @@ module Surrounded
         define_access_method(name, &block)
       end
     end
+    alias_method :guard, :disallow
     
-    def redo_method(name)
-      class_eval %{
-        def #{name}
-          begin
-            apply_roles if __apply_role_policy == :trigger
-            
-            method_restrictor = "disallow_#{name}?"
-            if self.respond_to?(method_restrictor, true) && self.send(method_restrictor)
-              raise ::#{self.to_s}::AccessError.new("access to #{self.name}##{name} is not allowed")
-            end
-            
-            #{trigger_return_content(name)}
+    def trigger_return_content(name)
+      %{
 
-          ensure
-            remove_roles if __apply_role_policy == :trigger
-          end
+        method_restrictor = "disallow_#{name}?"
+        if self.respond_to?(method_restrictor, true) && self.send(method_restrictor)
+          raise ::#{self.to_s}::AccessError.new("access to #{self.name}##{name} is not allowed")
         end
-      }, __FILE__, __LINE__
+
+      #{super}
+      }
     end
     
     def define_access_method(name, &block)
@@ -49,10 +42,13 @@ module Surrounded
     end
     
     module AccessMethods
+      # Return a Set of all defined triggers regardless of any disallow blocks
       def all_triggers
         self.class.triggers
       end
     
+      # Return a Set of triggers which may be run according to any restrictions defined
+      # in disallow blocks.
       def triggers
         all_triggers.select {|name|
           method_restrictor = "disallow_#{name}?"

data/lib/surrounded/context.rb

@@ -133,7 +133,9 @@ module Surrounded
       role_type = type || default_role_type
       if role_type == :module
         mod_name = name.to_s.gsub(/(?:^|_)([a-z])/){ $1.upcase }
-        private_const_set(mod_name, Module.new(&block))
+        mod = Module.new(&block)
+        mod.send(:include, ::Surrounded)
+        private_const_set(mod_name, mod)
       else
         meth = method(role_type)
         meth.call(name, &block)
@@ -162,17 +164,12 @@ module Surrounded
     def trigger(*names, &block)
       if block.nil?
         names.each do |name|
-          define_trigger_method(name, &block)
+          convert_method_to_trigger(name)
         end
       else
         name = names.first
-
-        define_method(:"__trigger_#{name}", &block)
-
-        private :"__trigger_#{name}"
-        store_trigger(name)
-
-        redo_method(name)
+        define_method(name, &block)
+        convert_method_to_trigger(name)
       end
     end
 
@@ -180,17 +177,17 @@ module Surrounded
       @triggers.merge(names)
     end
     
-    def define_trigger_method(name, &block)
+    def convert_method_to_trigger(name)
       unless triggers.include?(name) || name.nil?
         alias_method :"__trigger_#{name}", :"#{name}"
         private :"__trigger_#{name}"
         remove_method :"#{name}"
-        redo_method(name)
+        define_trigger_wrap_method(name)
         store_trigger(name)
       end
     end
 
-    def redo_method(name)
+    def define_trigger_wrap_method(name)
       class_eval %{
         def #{name}
           begin
@@ -248,6 +245,7 @@ module Surrounded
         role_map.role_player?(obj)
       end
 
+      # Return a Set of all defined triggers
       def triggers
         self.class.triggers
       end
@@ -269,6 +267,15 @@ module Surrounded
       def map_roles(role_object_array)
         role_object_array.each do |role, object|
           map_role(role, role_behavior_name(role), object)
+
+          singular_role_name = singularize_name(role)
+          singular_behavior_name = singularize_name(role_behavior_name(role))
+
+          if object.respond_to?(:each_with_index) && role_const_defined?(singular_behavior_name)
+            object.each_with_index do |item, index|
+              map_role(:"#{singular_role_name}_#{index + 1}", singular_behavior_name, item)
+            end
+          end
         end
       end
 
@@ -307,14 +314,13 @@ module Surrounded
 
       def remove_interface(role, behavior, object)
         remover_name = (module_removal_methods + unwrap_methods).find{|meth| object.respond_to?(meth) }
-        return object if !remover_name
-
         object.send(:remove_context) do; end
-        role_player = object.method(remover_name).call
 
-        map_role(role, role_module_basename(behavior), role_player) if behavior
+        if remover_name
+          role_player = object.send(remover_name)
+        end
 
-        role_player
+        return role_player || object
       end
 
       def apply_roles
@@ -368,6 +374,21 @@ module Surrounded
       def role_const_defined?(name)
         self.class.const_defined?(name)
       end
+
+      def singularize_name(name)
+        if name.respond_to?(:singularize)
+          name.singularize
+        else
+          # good enough for now but should be updated with better rules
+          name.to_s.tap do |string|
+            if string =~ /ies\z/
+              string.sub!(/ies\z/,'y')
+            elsif string =~ /s\z/
+              string.sub!(/s\z/,'')
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/surrounded/east_oriented.rb

@@ -4,7 +4,7 @@ module Surrounded
     # not be asked for information.
     def trigger_return_content(name)
       %{
-        self.send("__trigger_#{name}")
+        #{super}
         
         self
       }

data/lib/surrounded/version.rb

@@ -1,3 +1,3 @@
 module Surrounded
-  VERSION = "0.8.2"
+  VERSION = "0.8.3"
 end

data/test/context_access_test.rb

@@ -11,7 +11,7 @@ class FilteredContext
     'ready'
   end
   
-  disallow :if_ready do
+  guard :if_ready do
     user.name != 'Amy'
   end
   

data/test/example_threaded_test.rb

@@ -3,28 +3,22 @@ require 'test_helper'
 class ThreadedContext
   extend Surrounded::Context
 
-  def initialize(leader, members)
-    role_names = [:leader, :members]
-    role_players = [leader, members]
-
-    role_names.concat(members.map{|member| :"member_#{member.object_id}" })
-    role_players.concat(members)
-
-    map_roles(role_names.zip(role_players))
-
-  end
-  private_attr_reader :leader, :members
+  initialize :leader, :members
 
   trigger :meet do
-    result = []
-    result << leader.greet
-    result << members.concurrent_map do |member|
-      result << member.greet
-    end
-    result.flatten.join(' ')
+    leader.welcome
   end
 
   module Leader
+    def welcome
+      result = []
+      result << leader.greet
+      result << members.concurrent_map do |member|
+        result << member.greet
+      end
+      result.flatten.join(' ')
+    end
+
     def greet
       "Hello everyone. I am #{name}"
     end

data/test/surrounded_context_test.rb

@@ -173,12 +173,59 @@ describe Surrounded::Context, 'assigning roles' do
 
     assert context.check_user_response
   end
-  
+
   it 'allows usage of regular methods for triggers' do
     assert context.regular_method_trigger
   end
-  
+
   it 'ignores nil trigger names' do
     assert context.class.send(:trigger)
   end
-end
+end
+
+class CollectionContext
+  extend Surrounded::Context
+
+  initialize :members, :others
+
+  trigger :get_members_count do
+    members.member_count
+  end
+
+  trigger :get_member_show do
+    members.map(&:show).join(', ')
+  end
+
+  role :members do
+    def member_count
+      size
+    end
+  end
+
+  role :member do
+    def show
+      "member show"
+    end
+  end
+
+end
+
+describe Surrounded::Context, 'auto-assigning roles for collections' do
+  let(:member_one){ User.new('Jim') }
+  let(:member_two){ User.new('Amy') }
+  let(:members){ [member_one, member_two] }
+
+  let(:other_one){ User.new('Guille') }
+  let(:other_two){ User.new('Jason') }
+  let(:others){ [other_one, other_two] }
+
+  let(:context){ CollectionContext.new(members, others) }
+
+  it 'assigns the collection role to collections' do
+    assert_equal members.size, context.get_members_count
+  end
+
+  it 'assigns a defined role to each item in a role player collection' do
+    assert_equal "member show, member show", context.get_member_show
+  end
+end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: surrounded
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - '''Jim Gay'''
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-09 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: triad
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.1.2
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.1.2
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: bundler
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-  prerelease: false
-  type: :development
 - !ruby/object:Gem::Dependency
   name: rake
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
-  type: :development
 description: Gives an object implicit access to other objects in it's environment.
 email:
 - jim@saturnflyer.com
@@ -91,7 +91,7 @@ homepage: http://github.com/saturnflyer/surrounded
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -106,9 +106,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.1.9
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
 specification_version: 4
 summary: Create encapsulated environments for your objects.
 test_files: