surrounded 1.1.0 → 1.1.1

data/lib/surrounded/context.rb

@@ -1,15 +1,14 @@
-require 'set'
-require 'surrounded/exceptions'
-require 'surrounded/context/role_map'
-require 'surrounded/context/seclusion'
-require 'surrounded/context/role_builders'
-require 'surrounded/context/initializing'
-require 'surrounded/context/forwarding'
-require 'surrounded/context/trigger_controls'
-require 'surrounded/access_control'
-require 'surrounded/shortcuts'
-require 'surrounded/east_oriented'
-require 'surrounded/context/name_collision_detector'
+require "surrounded/exceptions"
+require "surrounded/context/role_map"
+require "surrounded/context/seclusion"
+require "surrounded/context/role_builders"
+require "surrounded/context/initializing"
+require "surrounded/context/forwarding"
+require "surrounded/context/trigger_controls"
+require "surrounded/access_control"
+require "surrounded/shortcuts"
+require "surrounded/east_oriented"
+require "surrounded/context/name_collision_detector"
 
 # Extend your classes with Surrounded::Context to handle their
 # initialization and application of behaviors to the role players
@@ -27,16 +26,13 @@ module Surrounded
         include InstanceMethods
 
         trigger_mod = Module.new
-        const_set('TriggerMethods', trigger_mod)
+        const_set(:TriggerMethods, trigger_mod)
         include trigger_mod
 
         extend TriggerControls
-
       }
     end
 
-    private
-
     # Set the default type of implementation for role methods for all contexts.
     def self.default_role_type
       @default_role_type ||= :module
@@ -46,6 +42,8 @@ module Surrounded
       attr_writer :default_role_type
     end
 
+    private
+
     def default_role_type
       @default_role_type ||= Surrounded::Context.default_role_type
     end
@@ -56,13 +54,19 @@ module Surrounded
     end
 
     # Provide the ability to create access control methods for your triggers.
-    def protect_triggers;  self.extend(::Surrounded::AccessControl); end
+    def protect_triggers
+      extend(::Surrounded::AccessControl)
+    end
 
     # Automatically create class methods for each trigger method.
-    def shortcut_triggers; self.extend(::Surrounded::Shortcuts); end
+    def shortcut_triggers
+      extend(::Surrounded::Shortcuts)
+    end
 
     # Automatically return the context object from trigger methods.
-    def east_oriented_triggers; self.extend(::Surrounded::EastOriented); end
+    def east_oriented_triggers
+      extend(::Surrounded::EastOriented)
+    end
 
     # === Utility shortcuts
 
@@ -91,7 +95,7 @@ module Surrounded
       # is allowed to inquire about the roles.
       def role?(name, &block)
         return false unless role_map.role?(name)
-        accessor = block.binding.eval('self')
+        accessor = block.binding.eval("self")
         role_map.role_player?(accessor) && role_map.assigned_player(name)
       end
 
@@ -119,7 +123,7 @@ module Surrounded
       private
 
       def clear_instance_variables
-        instance_variables.each{|ivar| remove_instance_variable(ivar) }
+        instance_variables.each { |ivar| remove_instance_variable(ivar) }
       end
 
       def role_map
@@ -129,8 +133,8 @@ module Surrounded
       def map_roles(role_object_array)
         detect_collisions role_object_array
         role_object_array.to_a.each do |role, object|
-          if self.respond_to?("map_role_#{role}")
-            self.send("map_role_#{role}", object)
+          if respond_to?("map_role_#{role}")
+            send("map_role_#{role}", object)
           else
             map_role(role, role_behavior_name(role), object)
             map_role_collection(role, role_behavior_name(role), object)
@@ -155,13 +159,13 @@ module Surrounded
 
       def apply_behavior(role, behavior, object)
         if behavior && role_const_defined?(behavior)
-          applicator = if self.respond_to?("apply_behavior_#{role}")
-                          method("apply_behavior_#{role}")
-                        elsif role_const(behavior).is_a?(Class)
-                          method(:apply_class_behavior)
-                        else
-                          method(:apply_module_behavior)
-                        end
+          applicator = if respond_to?("apply_behavior_#{role}")
+            method("apply_behavior_#{role}")
+          elsif role_const(behavior).is_a?(Class)
+            method(:apply_class_behavior)
+          else
+            method(:apply_module_behavior)
+          end
 
           role_player = applicator.call(role_const(behavior), object)
           map_role(role, behavior, role_player)
@@ -170,7 +174,7 @@ module Surrounded
       end
 
       def apply_module_behavior(mod, obj)
-        adder_name = module_extension_methods.find{|meth| obj.respond_to?(meth) }
+        adder_name = module_extension_methods.find { |meth| obj.respond_to?(meth) }
         return obj unless adder_name
 
         obj.method(adder_name).call(mod)
@@ -178,7 +182,7 @@ module Surrounded
       end
 
       def apply_class_behavior(klass, obj)
-        wrapper_name = wrap_methods.find{|meth| klass.respond_to?(meth) }
+        wrapper_name = wrap_methods.find { |meth| klass.respond_to?(meth) }
         return obj if !wrapper_name
         klass.method(wrapper_name).call(obj)
       end
@@ -190,11 +194,11 @@ module Surrounded
           end
         end
 
-        role_player = if self.respond_to?("remove_behavior_#{role}")
-                        self.send("remove_behavior_#{role}", role_const(behavior), object)
-                      elsif remover_name
-                        object.send(remover_name)
-                      end
+        role_player = if respond_to?("remove_behavior_#{role}")
+          send("remove_behavior_#{role}", role_const(behavior), object)
+        elsif remover_name
+          object.send(remover_name)
+        end
 
         role_player || object
       end
@@ -203,7 +207,7 @@ module Surrounded
         role_map.each do |role, mod_name, object|
           player = apply_behavior(role, mod_name, object)
           if player.respond_to?(:store_context, true)
-            player.__send__(:store_context) do; end
+            player.__send__(:store_context) {}
           end
         end
       end
@@ -211,7 +215,7 @@ module Surrounded
       def remove_behaviors
         role_map.each do |role, mod_name, player|
           if player.respond_to?(:remove_context, true)
-            player.__send__(:remove_context) do; end
+            player.__send__(:remove_context) {}
           end
           remove_behavior(role, mod_name, player)
         end
@@ -242,7 +246,7 @@ module Surrounded
       end
 
       def role_module_basename(mod)
-        mod.to_s.split('::').last
+        mod.to_s.split("::").last
       end
 
       def role_const(name)
@@ -262,33 +266,34 @@ module Surrounded
           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
+          string = name.to_s.dup
+          if string.end_with?("ies")
+            string.sub(/ies\z/, "y")
+          elsif string.end_with?("s")
+            string.sub(/s\z/, "")
+          else
+            string
           end
         end
       end
     end
 
     class RoleName
-      def initialize(string, suffix=nil)
-        @string = string.
-                    to_s.
-                    split(/_/).
-                    map{|part|
-                      part.capitalize
-                    }.
-                    join.
-                    sub(/_\d+/,'') + suffix.to_s
+      def initialize(string, suffix = nil)
+        @string = string
+          .to_s
+          .split("_")
+          .map { |part|
+          part.capitalize
+        }
+          .join
+          .sub(/_\d+/, "") + suffix.to_s
       end
 
       def to_str
         @string
       end
-      alias to_s to_str
+      alias_method :to_s, :to_str
 
       def to_sym
         @string.to_sym

data/lib/surrounded/east_oriented.rb

@@ -3,11 +3,11 @@ module Surrounded
     # Always return the context object to ensure that a context may
     # not be asked for information.
     def trigger_return_content(name, *args, &block)
-      %{
+      %(
         #{super}
-        
+
         self
-      }
+      )
     end
   end
-end
+end

data/lib/surrounded/exceptions.rb

@@ -1,7 +1,7 @@
 module Surrounded
   module Exceptions
     def self.define(klass, exceptions:, namespace: Surrounded::Context)
-      Array(exceptions).each{ |exception|
+      Array(exceptions).each { |exception|
         unless klass.const_defined?(exception)
           klass.const_set(exception, Class.new(namespace.const_get(exception)))
         end

data/lib/surrounded/shortcuts.rb

@@ -1,21 +1,19 @@
 module Surrounded
   module Shortcuts
     private
-    
+
     def define_shortcut(name)
       # if keyword initialize
-      if instance_method(:initialize).parameters.dig(0,0) == :keyreq
+      if instance_method(:initialize).parameters.dig(0, 0) == :keyreq
         singleton_class.send(:define_method, name) do |**args|
-          instance = begin
-            self.new(**args)
-          end
+          instance = new(**args)
+
           instance.public_send(name)
         end
       else # non-keyword initialize
         singleton_class.send(:define_method, name) do |*args|
-          instance = begin
-            self.new(*args)
-          end
+          instance = new(*args)
+
           instance.public_send(name)
         end
       end

data/lib/surrounded/version.rb

@@ -1,5 +1,5 @@
 module Surrounded
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 
   def self.version
     VERSION

data/lib/surrounded.rb

@@ -3,23 +3,22 @@ require "surrounded/context"
 require "singleton"
 
 # This module should be added to objects which will enter
-# into context objects. 
+# into context objects.
 #
 # Its main purpose is to keep a reference to the context
 # and to implement method_missing to handle the relationship
 # to other objects in the context.
 module Surrounded
-
   private
 
   def store_context(&block)
-    accessor = block.binding.eval('self')
+    accessor = block.binding.eval("self")
     surroundings.unshift(accessor)
     self
   end
 
   def remove_context(&block)
-    accessor = block.binding.eval('self')
+    accessor = block.binding.eval("self")
     surroundings.shift if surroundings.include?(accessor)
     self
   end
@@ -33,15 +32,16 @@ module Surrounded
   end
 
   def method_missing(meth, *args, &block)
-    context.role?(meth){} || super
+    context.role?(meth) {} || super
   end
 
-  def respond_to_missing?(meth, include_private=false)
-    !!context.role?(meth){} || super
+  def respond_to_missing?(meth, include_private = false)
+    !!context.role?(meth) {} || super
   end
 
   class NullContext
     include Singleton
+
     def role?(*args)
       nil
     end

data/surrounded.gemspec

@@ -1,24 +1,30 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'surrounded/version'
+require "surrounded/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "surrounded"
-  spec.version       = Surrounded.version
-  spec.authors       = ["'Jim Gay'"]
-  spec.email         = ["jim@saturnflyer.com"]
-  spec.description   = %q{Gives an object implicit access to other objects in it's environment.}
-  spec.summary       = %q{Create encapsulated environments for your objects.}
-  spec.homepage      = "http://github.com/saturnflyer/surrounded"
-  spec.license       = "MIT"
+  spec.name = "surrounded"
+  spec.version = Surrounded.version
+  spec.authors = ["'Jim Gay'"]
+  spec.email = ["jim@saturnflyer.com"]
+  spec.description = "Gives an object implicit access to other objects in it's environment."
+  spec.summary = "Create encapsulated environments for your objects."
+  spec.homepage = "http://github.com/saturnflyer/surrounded"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files = Dir[
+    "lib/**/*",
+    "Rakefile",
+    "README.md",
+    "Changelog.md",
+    "LICENSE.txt",
+    "test/**/*",
+    "surrounded.gemspec"
+  ]
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "triad",  "~> 0.3.0"
+  spec.add_dependency "triad", ">= 0.3.0"
 
   spec.add_development_dependency "rake"
 end

data/test/{casting_role_player_test.rb → casting_test_helper.rb}

@@ -1,7 +1,8 @@
-require 'test_helper'
+require "test_helper"
 
-require 'casting'
+require "casting"
 class CastingUser < User
   include Casting::Client
+
   delegate_missing_methods
-end
+end

data/test/collection_role_players_test.rb

@@ -1,4 +1,5 @@
-require 'test_helper'
+require "test_helper"
+require "casting_test_helper"
 
 class CollectionContext
   extend Surrounded::Context
@@ -10,7 +11,7 @@ class CollectionContext
   end
 
   trigger :get_member_show do
-    members.map(&:show).join(', ')
+    members.map(&:show).join(", ")
   end
 
   role :members do
@@ -25,27 +26,26 @@ class CollectionContext
     end
   end
 
-  role :others do; end
-  role :other do; end
-
+  role :others, &proc {}
+  role :other, &proc {}
 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] }
+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(:other_one) { User.new("Guille") }
+  let(:other_two) { User.new("Jason") }
+  let(:others) { [other_one, other_two] }
 
-  let(:context){ CollectionContext.new(members: members, others: others) }
+  let(:context) { CollectionContext.new(members: members, others: others) }
 
-  it 'assigns the collection role to collections' do
+  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
+  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
+end

data/test/context_access_test.rb

@@ -1,62 +1,63 @@
-require 'test_helper'
-require 'minitest/mock'
+require "test_helper"
+require "minitest/mock"
 
 class FilteredContext
   extend Surrounded::Context
+
   protect_triggers
-  
+
   initialize :user, :other_user
-  
+
   trigger :if_ready do
-    'ready'
+    "ready"
   end
-  
+
   guard :if_ready do
-    user.name != 'Amy'
+    user.name != "Amy"
   end
-  
+
   trigger :check_disallow_behavior do
     # used for disallow check
   end
-  
+
   disallow :check_disallow_behavior do
     user.special
   end
-  
+
   trigger :unguarded do
     # used for disallow check
   end
 
   role :user do
     def special
-      'special user method'
+      "special user method"
     end
   end
 end
 
-describe Surrounded::Context, 'access control' do
-  let(:user){ User.new("Jim") }
-  let(:other_user){ User.new("Guille") }
-  let(:context){ FilteredContext.new(user: user, other_user: other_user) }
-  
-  it 'includes triggers when allowed' do
+describe Surrounded::Context, "access control" do
+  let(:user) { User.new("Jim") }
+  let(:other_user) { User.new("Guille") }
+  let(:context) { FilteredContext.new(user: user, other_user: other_user) }
+
+  it "includes triggers when allowed" do
     context.stub(:disallow_if_ready?, false) do
       assert context.triggers.include?(:if_ready)
     end
   end
 
-  it 'excludes triggers when not allowed' do
+  it "excludes triggers when not allowed" do
     refute context.triggers.include?(:if_ready)
   end
-  
-  it 'raises error specific to the context class when trigger method not allowed' do
-    error = assert_raises(::FilteredContext::AccessError){
+
+  it "raises error specific to the context class when trigger method not allowed" do
+    error = assert_raises(::FilteredContext::AccessError) {
       context.if_ready
     }
     assert_match(/access to FilteredContext#if_ready is not allowed/i, error.message)
   end
-  
-  it 'supports rescuing from Surrounded defined error when trigger method not allowed' do
+
+  it "supports rescuing from Surrounded defined error when trigger method not allowed" do
     begin
       context.if_ready
     rescue ::Surrounded::Context::AccessError => error
@@ -64,20 +65,20 @@ describe Surrounded::Context, 'access control' do
     end
     assert_match(/access to FilteredContext#if_ready is not allowed/i, error.message)
   end
-  
-  it 'applies roles in disallow blocks' do
-    assert_equal 'special user method', context.disallow_check_disallow_behavior?
+
+  it "applies roles in disallow blocks" do
+    assert_equal "special user method", context.disallow_check_disallow_behavior?
   end
 
-  it 'lets you ask if the object will allow a method' do
+  it "lets you ask if the object will allow a method" do
     assert context.allow?(:unguarded)
     refute context.allow?(:check_disallow_behavior)
   end
 
-  it 'complains if you ask about an undefined method' do
-    error = assert_raises(NoMethodError){
+  it "complains if you ask about an undefined method" do
+    error = assert_raises(NoMethodError) {
       context.allow?(:not_a_defined_method)
     }
     assert_match(/undefined method `not_a_defined_method' for #<#{context.class}/, error.message)
   end
-end
+end