surrounded 0.9.11 → 1.1.0

data/examples/bottles.rb

@@ -1,145 +1,135 @@
-require 'surrounded'
+require "surrounded"
+class CountdownSong
+  def initialize(max:, min:)
+    @max = max
+    @min = min
+  end
+  attr_reader :max, :min
+
+  def sing_with(verse_template)
+    max.downto(min).map { |num| verse(num, verse_template) }
+  end
+
+  def verse(number, verse_template)
+    verse_template.lyrics(number)
+  end
+end
+
+class BottleVerse
+  def self.lyrics(number)
+    new(bottle_number: number).lyrics
+  end
 
-class Countdown
   extend Surrounded::Context
-  
-  initialize :singer, :number, :location
-  
-  trigger :start do
-    singer.start
-  end
-  
-  trigger :continue do
-    singer.continue
-  end
-  
-  trigger :finish do
-    singer.announce_status
-  end
-  
-  role :singer do
-    def start
-      announce_full_status
-      take_action
-    end
-    
-    def continue
-      announce_status
-      pause
-      start
-    end
-    
-    def announce_full_status
-      output %{#{location.status}, #{location.inventory}}.capitalize
-    end
-    
-    def announce_status
-      output %{#{location.status}}.capitalize
+
+  initialize :bottle_number
+
+  trigger :lyrics do
+    "#{bottle_number} of beer on the wall, ".capitalize +
+    "#{bottle_number} of beer.\n" +
+    "#{bottle_number.action}, " +
+    "#{bottle_number.successor} of beer on the wall.\n"
+  end
+
+  role :bottle_number, :wrapper do
+    def self.handles(number)
+      BottleVerse.register_bottle_role(number, self)
     end
-    
-    def take_action
-      if location.empty?
-        output %{Go to the store and get some more}
-        next_part.finish
-      else
-        output %{#{location.subtraction}, pass it around}.capitalize
-        next_part.continue
-      end
+
+    def to_s
+      "#{quantity} #{container}"
     end
-    
-    def pause
-      output ""
+
+    def quantity
+      __getobj__.to_s
     end
-    
-    def next_part
-      context.class.new(singer, number.pred, location)
+
+    def container
+      "bottles"
     end
-  end
-  
-  role :number, :wrap do
-    def name
-      self.zero? ? 'no more' : to_i
+
+    def action
+      "Take #{pronoun} down and pass it around"
     end
-    
+
     def pronoun
-      self == 1 ? 'it' : 'one'
-    end
-    
-    def container
-      self == 1 ? 'bottle' : 'bottles'
+      "one"
     end
-    
-    def pred
-      self.zero? ? 99 : super
+
+    def successor
+      context.bottle_role_player(pred)
     end
   end
-  
-  role :location do
-    def empty?
-      number.zero?
-    end
-    
-    def inventory
-      %{#{number.name} #{number.container} of beer}
-    end
-    
-    def status
-      %{#{inventory} #{placement} #{name}}
-    end
-    
-    def subtraction
-      %{take #{number.pronoun} #{removal_strategy}}
-    end
+
+  # Inherit from existing role
+  def self.bottle_role(name, &block)
+    mod_name = RoleName(name)
+    klass = Class.new(BottleNumber, &block)
+    const_set(mod_name, klass)
   end
-end
 
-class Location
-  include Surrounded
-  
-  def placement
-    'on'
+  def self.register_bottle_role(number, klass)
+    @@registry ||= Hash.new { BottleNumber }
+    @@registry[number] = klass
   end
-  
-  def removal_strategy
-    'off'
+
+  def bottle_role_for(number)
+    @@registry[number]
   end
-  
-  def name
-    "the " + self.class.to_s.downcase
+
+  def map_role_bottle_number(num)
+    map_role(:bottle_number, bottle_role_for(num), num)
   end
-end
 
-class Wall < Location
-  def removal_strategy
-    'down'
+  def bottle_role_player(number)
+    bottle_role_for(number).new(number)
   end
-end
 
-class Box < Location
-  def placement
-    'in'
+  role :bottle_number_0, :bottle_role do
+    handles 0
+
+    def quantity
+      "no more"
+    end
+
+    def action
+      "Go to the store and buy some more"
+    end
+
+    def successor
+      context.bottle_role_player(99)
+    end
   end
-  
-  def removal_strategy
-    'out'
+
+  role :bottle_number_1, :bottle_role do
+    handles 1
+
+    def container
+      "bottle"
+    end
+
+    def pronoun
+      "it"
+    end
   end
 end
 
-class Chorus
-  include Surrounded
-  def output(value)
-    STDOUT.puts(value)
+class Bottles
+  def song_template(upper: 99, lower: 0)
+    CountdownSong.new(max: upper, min: lower)
   end
-end
 
-class Sheet
-  include Surrounded
-  def output(value)
-    File.open('bottles.txt', 'a') do |f|
-      f.puts(value)
-    end
+  def song
+    song_template.sing_with(BottleVerse)
+  end
+
+  def verses(upper, lower)
+    song_template(upper: upper, lower: lower).sing_with(BottleVerse)
+  end
+
+  def verse(number)
+    song_template.verse(number, BottleVerse)
   end
 end
 
-Countdown.new(Chorus.new, 3, Wall.new).start
-# Countdown.new(Sheet.new, 3, Box.new).start
+puts Bottles.new.song

data/lib/surrounded/access_control.rb

@@ -33,12 +33,10 @@ module Surrounded
       mod = Module.new
       mod.class_eval {
         define_method "disallow_#{name}?" do
-          begin
-            apply_behaviors
-            instance_exec(&block)
-          ensure
-            remove_behaviors
-          end
+          apply_behaviors
+          instance_exec(&block)
+        ensure
+          remove_behaviors
         end
       }
       const_set("SurroundedAccess#{name}", mod)
@@ -55,22 +53,16 @@ module Surrounded
       # in disallow blocks.
       def triggers
         all_triggers.select {|name|
-          method_restrictor = "disallow_#{name}?"
-          !self.respond_to?(method_restrictor, true) || !self.send(method_restrictor)
+          allow?(name)
         }.to_set
       end
 
       # Ask if the context will allow access to a trigger given the current players.
       def allow?(name)
-        unless self.respond_to?(name)
-          raise NoMethodError, %{undefined method `#{name}' for #{self.inspect}}
-        end
-        if self.respond_to?("disallow_#{name}?")
-          !self.public_send("disallow_#{name}?")
-        else
-          true
-        end
+        raise NoMethodError, %{undefined method `#{name}' for #{self.inspect}} unless self.respond_to?(name)
+        predicate = "disallow_#{name}?"
+        !self.respond_to?(predicate) || !self.public_send(predicate)
       end
     end
   end
-end
+end

data/lib/surrounded/context/initializing.rb

@@ -1,22 +1,19 @@
 module Surrounded
   module Context
     module Initializing
+      extend Seclusion
       # Shorthand for creating an instance level initialize method which
       # handles the mapping of the given arguments to their named role.
       def initialize_without_keywords(*setup_args, &block)
         parameters = setup_args.join(',')
         default_initializer(parameters, setup_args, &block)
       end
-      def initialize(*setup_args, &block)
-        warn "Deprecated: The behavior of 'initialize' will require keywords in the future
-            Consider using keyword arguments or switching to 'initialize_without_keywords'\n\n"
-        initialize_without_keywords(*setup_args, &block)
-      end
 
-      def keyword_initialize(*setup_args, &block)
+      def initialize(*setup_args, &block)
         parameters = setup_args.map{|a| "#{a}:"}.join(',')
         default_initializer(parameters, setup_args, &block)
       end
+      alias keyword_initialize initialize
       alias initialize_with_keywords keyword_initialize
 
       def initializer_block
@@ -45,4 +42,4 @@ module Surrounded
       end
     end
   end
-end
+end

data/lib/surrounded/context/negotiator.rb

@@ -15,8 +15,9 @@ module Surrounded
           # 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)
+              def #{meth}(...)
+                @#{meth}_method ||= __behaviors__.instance_method(:#{meth}).bind(@object)
+                @#{meth}_method.call(...)
               end
             }, __FILE__, num
           end
@@ -57,8 +58,8 @@ module Surrounded
         @object = object
       end
 
-      def method_missing(meth, *args, &block)
-        @object.send(meth, *args, &block)
+      def method_missing(meth, ...)
+        @object.send(meth, ...)
       end
 
       def respond_to_missing?(meth, include_private=false)
@@ -66,4 +67,4 @@ module Surrounded
       end
     end
   end
-end
+end

data/lib/surrounded/context/role_builders.rb

@@ -1,16 +1,9 @@
 module Surrounded
   module Context
-    class InvalidRoleType < ::StandardError
-      unless method_defined?(:cause)
-        def initialize(msg=nil)
-          super
-          @cause = $!
-        end
-        attr_reader :cause
-      end
-    end
+    class InvalidRoleType < ::StandardError; end
 
     module RoleBuilders
+      extend Seclusion
 
       def self.extended(base)
         Surrounded::Exceptions.define(base, exceptions: :InvalidRoleType)
@@ -67,7 +60,7 @@ module Surrounded
         # Admin
         private_const_set(RoleName(name), Negotiator.for_role(behavior))
       end
-      
+
       private
       def RoleName(text, suffix=nil)
         RoleName.new(text, suffix)
@@ -75,4 +68,4 @@ module Surrounded
 
     end
   end
-end
+end

data/lib/surrounded/context/role_map.rb

@@ -6,12 +6,16 @@ module Surrounded
       extend Forwardable
 
       class << self
+        # Get the role map container and provide an alternative if desired
+        # Ex: RoleMap.from_base(SomeCustomContainer)
         def from_base(klass=::Triad)
-          role_mapper = Class.new(self)
-          Surrounded::Exceptions.define(role_mapper, exceptions: :ItemNotPresent, namespace: klass)
-          role_mapper.container_class=(klass)
-          role_mapper.def_delegators :container, :update, :each, :values, :keys
-          role_mapper
+          unless const_defined?(:Container)
+            role_mapper = Class.new(self)
+            role_mapper.container_class=(klass)
+            Surrounded::Exceptions.define(role_mapper, exceptions: :ItemNotPresent, namespace: klass)
+            const_set(:Container, role_mapper)
+          end
+          const_get(:Container)
         end
 
         def container_class=(klass)
@@ -19,23 +23,28 @@ module Surrounded
         end
       end
 
+      def_delegators :container, :update, :each, :values, :keys
+
       def container
         @container ||= self.class.instance_variable_get(:@container_class).new
       end
 
+      # Check if a role exists in the map
       def role?(role)
         keys.include?(role)
       end
 
+      # Check if an object is playing a role in this map
       def role_player?(object)
         !values(object).empty?
-      rescue ::StandardError
+      rescue self.container.class::ItemNotPresent
         false
       end
 
+      # Get the object playing the given role
       def assigned_player(role)
         values(role).first
       end
     end
   end
-end
+end

data/lib/surrounded/context/seclusion.rb

@@ -0,0 +1,20 @@
+module Surrounded
+  module Context
+    module Seclusion
+      # Set a named constant and make it private
+      def private_const_set(name, const)
+        unless role_const_defined?(name)
+          const = const_set(name, const)
+          private_constant name.to_sym
+        end
+        const
+      end
+
+      # Create attr_reader for the named methods and make them private
+      def private_attr_reader(*method_names)
+        attr_reader(*method_names)
+        private(*method_names)
+      end
+    end
+  end
+end

data/lib/surrounded/context/trigger_controls.rb

@@ -54,7 +54,7 @@ module Surrounded
 
       def define_trigger(name)
         line = __LINE__; self.class_eval %{
-          def #{name}(*args, &block)
+          def #{name}(...)
             begin
               apply_behaviors
 
@@ -71,7 +71,7 @@ module Surrounded
         if method_defined?(name)
           %{super}
         else
-          %{self.send("__trigger_#{name}", *args, &block)}
+          %{self.send("__trigger_#{name}", ...)}
         end
       end
       
@@ -85,4 +85,4 @@ module Surrounded
       end
     end
   end
-end
+end

data/lib/surrounded/context.rb

@@ -1,6 +1,7 @@
 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'
@@ -20,7 +21,7 @@ module Surrounded
   module Context
     def self.extended(base)
       base.class_eval {
-        extend RoleBuilders, Initializing, Forwarding, NameCollisionDetector
+        extend Seclusion, RoleBuilders, Initializing, Forwarding, NameCollisionDetector
 
         @triggers = Set.new
         include InstanceMethods
@@ -53,7 +54,7 @@ module Surrounded
     def default_role_type=(type)
       @default_role_type = type
     end
-    
+
     # Provide the ability to create access control methods for your triggers.
     def protect_triggers;  self.extend(::Surrounded::AccessControl); end
 
@@ -68,21 +69,6 @@ module Surrounded
     def role_const_defined?(name)
       const_defined?(name, false)
     end
-    
-    # Set a named constant and make it private
-    def private_const_set(name, const)
-      unless role_const_defined?(name)
-        const = const_set(name, const)
-        private_constant name.to_sym
-      end
-      const
-    end
-
-    # Create attr_reader for the named methods and make them private
-    def private_attr_reader(*method_names)
-      attr_reader(*method_names)
-      private(*method_names)
-    end
 
     # Conditional const_get for a named role behavior
     def role_const(name)
@@ -119,11 +105,14 @@ module Surrounded
         self.class.triggers
       end
 
-      def rebind(options_hash)
+      # Reuse the same context object but pass new values
+      def rebind(**options_hash)
         clear_instance_variables
-        initialize(**options_hash)
-      rescue ArgumentError
-        initialize(*options_hash.values)
+        begin
+          initialize(**options_hash)
+        rescue ArgumentError
+          initialize(*options_hash.values)
+        end
         self
       end
 
@@ -193,7 +182,7 @@ module Surrounded
         return obj if !wrapper_name
         klass.method(wrapper_name).call(obj)
       end
-      
+
       def remove_behavior(role, behavior, object)
         if behavior && role_const_defined?(behavior)
           remover_name = (module_removal_methods + unwrap_methods).find do |meth|
@@ -306,4 +295,4 @@ module Surrounded
       end
     end
   end
-end
+end

data/lib/surrounded/shortcuts.rb

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

data/lib/surrounded/version.rb

@@ -1,6 +1,6 @@
 module Surrounded
-  VERSION = "0.9.11"
-  
+  VERSION = "1.1.0"
+
   def self.version
     VERSION
   end

data/surrounded.gemspec

@@ -20,6 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "triad",  "~> 0.3.0"
 
-  spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake"
 end

data/test/collection_role_players_test.rb

@@ -39,7 +39,7 @@ describe Surrounded::Context, 'auto-assigning roles for collections' do
   let(:other_two){ User.new('Jason') }
   let(:others){ [other_one, other_two] }
 
-  let(:context){ CollectionContext.new(members, others) }
+  let(:context){ CollectionContext.new(members: members, others: others) }
 
   it 'assigns the collection role to collections' do
     assert_equal members.size, context.get_members_count

data/test/context_access_test.rb

@@ -37,7 +37,7 @@ end
 describe Surrounded::Context, 'access control' do
   let(:user){ User.new("Jim") }
   let(:other_user){ User.new("Guille") }
-  let(:context){ FilteredContext.new(user, other_user) }
+  let(:context){ FilteredContext.new(user: user, other_user: other_user) }
   
   it 'includes triggers when allowed' do
     context.stub(:disallow_if_ready?, false) do

data/test/context_forwarding_test.rb

@@ -38,7 +38,7 @@ end
 describe Surrounded::Context, 'forwarding triggers' do
   let(:user){ User.new("Jim") }
   let(:other_user){ User.new("Guille") }
-  let(:context){ Sending.new(user, other_user) }
+  let(:context){ Sending.new(one: user, two: other_user) }
   
   it 'forwards multiple configured instance methods as triggers' do
     assert_equal 'hello', context.hello

data/test/context_reuse_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 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) }
+  let(:context){ TestContext.new(user: user, other_user: other_user) }
 
   it 'allows rebinding new players' do
     expect(context.access_other_object).must_equal 'Guille'