surrounded 0.9.8 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5e41776a1619ac88e5a77857ae85f6d0ef7bbf1
-  data.tar.gz: 2e39e542b1955af150bf148dc4b15fd29bd7dd46
+  metadata.gz: 676d57f548d17fbf0d9112208472938b7c5a2e82
+  data.tar.gz: 830bf96b8114f786840315b24fba5f90450be813
 SHA512:
-  metadata.gz: 2bbac0d9d89de2880aee0c54b8916a37d7862d4071f0d9a24f9e93cc7df53733fc9b9e206fbe7552736ef0c90f1320e728fe0990deeda8a03e5921b6080ccc59
-  data.tar.gz: 94765d82ed5d64e8d2318ddb53cafd2ad633e3288157df9528df6a40687d04dda66f50b432572a1dc9f361bb73f0549e7d5453b9f5872ab69c4a5c2f6f8aeeab
+  metadata.gz: 1bc24e149d0fefd9961ea08c92a01390cbdc24d94a42fa6a06e542a219838572f3c75fa8e65ec6e54324236a53950461e4b81afd7e732a0a6765220e4c5a27d6
+  data.tar.gz: dd4ee61d04717d8418e011e6421031196bada55ae25d6fb04e24c9913fc06ccc2c199a443c4f554618f3298ef6e7319d81467ee69e43b135cf7da6aa2214f0cd

data/README.md

@@ -475,7 +475,7 @@ This will allow you to write methods like you normally would. They are aliased i
 
 This works like Ruby's `public`,`protected`, and `private` keywords in that you can send symbols of method names to it. But `trigger` does not alter the parsing of the document like those core keywords do. In other words, you can't merely type `trigger` on one line, and have methods added afterward be treated as trigger methods.
 
-## Access Control for Triggers
+## Access Control / Permissions for Triggers
 
 If you decide to build a user interface from the available triggers, you'll find you need to know what triggers are available.
 
@@ -647,6 +647,35 @@ context = Employment.new(current_user, the_boss)
 context.rebind(employee: another_user, boss: someone_else) # same context, new players
 ```
 
+## Background Processing
+
+While there's no specific support for background processing, your context objects make it easy for you to add your own by remembering what arguments were provided during initialization.
+
+When you initialize a context, it will keep track of the parameters and their matching arguments in a private hash called `initializer_arguments`. This allows you to write methods to create a context object and have itself sent to a background processor.
+
+```ruby
+class ExpensiveCalculation
+  extend Surrounded::Context
+
+  initialize :leader, :members
+
+  def send_to_background(trigger_method)
+    background_arguments = initializer_arguments.merge(trigger: trigger_method)
+    BackgroundProcessor.enqueue(self.class.name, **background_arguments)
+  end
+
+  class BackgroundProcessor
+    def perform(**args)
+      trigger_name = args.delete(:trigger)
+      job_class.new(args).send(trigger_name)
+    end
+  end
+end
+ExpensiveCalculation.new(some_object, some_collection).send_to_background(:do_expensive_calculation)
+```
+
+The above example is merely pseudo-code to show how `initializer_arguments` can be used. Customize it according to your own needs.
+
 ## Overview in code
 
 Here's a view of the possibilities in code.

data/lib/surrounded/context/initializing.rb

@@ -36,12 +36,14 @@ module Surrounded
         line = __LINE__; mod.class_eval %{
           def initialize(#{params})
             @role_map = role_mapper_class.new
-            map_roles(#{setup_args.to_s}.zip([#{setup_args.join(',')}]))
+            @initializer_arguments = Hash[#{setup_args.to_s}.zip([#{setup_args.join(',')}])]
+            map_roles(@initializer_arguments)
             self.class.apply_initializer_block(self)
           end
         }, __FILE__, line
         const_set("ContextInitializer", mod)
         include mod
+        private_attr_reader :initializer_arguments
       end
     end
   end

data/lib/surrounded/version.rb

@@ -1,5 +1,5 @@
 module Surrounded
-  VERSION = "0.9.8"
+  VERSION = "0.9.9"
   
   def self.version
     VERSION

data/test/casting_role_player_test.rb

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

data/test/collection_role_players_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+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
+
+  role :others do; end
+  role :other do; 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

data/test/context_reuse_test.rb

@@ -0,0 +1,22 @@
+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) }
+
+  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

data/test/initialization_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+
+class InitContext
+  extend Surrounded::Context
+
+  initialize(:user, :other_user) do
+    @defined_by_initializer_block = 'yup'
+  end
+end
+
+describe Surrounded::Context, '.initialize' do
+  it 'defines an initialize method accepting the same arguments' do
+    assert_equal 2, InitContext.instance_method(:initialize).arity
+  end
+
+  it 'applies a provided block to the instance' do
+    context = InitContext.new(User.new('Jim'), User.new('Amy'))
+    assert_equal 'yup', context.instance_variable_get(:@defined_by_initializer_block)
+  end
+
+  it 'keeps track of the original initialize arguments' do
+    jim = User.new('Jim')
+    amy = User.new('Amy')
+    context = InitContext.new(jim, amy)
+    tracked = context.send(:initializer_arguments)
+    assert_equal jim, tracked[:user]
+    assert_equal amy, tracked[:other_user]
+  end
+end
+
+begin
+  class Keyworder
+    extend Surrounded::Context
+
+    keyword_initialize :this, :that do
+      self.instance_variable_set(:@defined_by_initializer_block, 'yes')
+    end
+  end
+
+  describe Surrounded::Context, 'keyword initializers' do
+    it 'works with keyword arguments' do
+      assert Keyworder.new(this: User.new('Jim'), that: User.new('Guille'))
+    end
+
+    it 'raises errors with missing keywords' do
+      err = assert_raises(ArgumentError){
+        Keyworder.new(this: User.new('Amy'))
+      }
+      assert_match(/missing keyword: that/, err.message)
+    end
+
+    it 'evaluates a given block' do
+      assert_equal 'yes', Keyworder.new(this: User.new('Jim'), that: User.new('Guille')).instance_variable_get(:@defined_by_initializer_block)
+    end
+  end
+rescue SyntaxError
+  STDOUT.puts "No support for keywords"
+end

data/test/non_surrounded_role_player_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class BareObjectContext
+  extend Surrounded::Context
+
+  def initialize(number, string, user)
+    map_roles(:number => number, :string => string, :user => user)
+  end
+  private_attr_reader :number, :string, :user
+
+  role :user do
+    def output
+      [number.to_s, string, name].join(' - ')
+    end
+  end
+
+  trigger :output do
+    user.output
+  end
+end
+
+describe Surrounded::Context, 'skips affecting non-surrounded objects' do
+  it 'works with non-surrounded objects' do
+    context = BareObjectContext.new(123,'hello', User.new('Jim'))
+    assert_equal '123 - hello - Jim', context.output
+  end
+end

data/test/surrounded_context_test.rb

@@ -97,18 +97,10 @@ describe Surrounded::Context, '#role?' do
   end
 end
 
-require 'casting'
-class CastingUser < User
-  include Casting::Client
-  delegate_missing_methods
-end
-
 class RoleAssignmentContext
   extend Surrounded::Context
 
-  initialize(:user, :other_user) do
-    self.instance_variable_set(:@defined_by_initializer_block, 'yup')
-  end
+  initialize(:user, :other_user)
 
   def user_ancestors
     user.singleton_class.ancestors
@@ -152,12 +144,6 @@ class IgnoreExternalConstantsContext
   end
 end
 
-describe Surrounded::Context, '.initialize' do
-  it 'defines an initialize method accepting the same arguments' do
-    assert_equal 2, RoleAssignmentContext.instance_method(:initialize).arity
-  end
-end
-
 class ClassRoleAssignmentContext
   extend Surrounded::Context
 
@@ -209,134 +195,4 @@ describe Surrounded::Context, 'assigning roles' do
     context = IgnoreExternalConstantsContext.new(user, special, other)
     assert_equal User, context.check_special
   end
-
-  it 'applies a provided block to the instance' do
-    assert_equal 'yup', context.instance_variable_get(:@defined_by_initializer_block)
-  end
-end
-
-class BareObjectContext
-  extend Surrounded::Context
-
-  def initialize(number, string, user)
-    map_roles(:number => number, :string => string, :user => user)
-  end
-  private_attr_reader :number, :string, :user
-
-  role :user do
-    def output
-      [number.to_s, string, name].join(' - ')
-    end
-  end
-
-  trigger :output do
-    user.output
-  end
-end
-
-describe Surrounded::Context, 'skips affecting non-surrounded objects' do
-  it 'works with non-surrounded objects' do
-    context = BareObjectContext.new(123,'hello', User.new('Jim'))
-    assert_equal '123 - hello - Jim', context.output
-  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
-
-  role :others do; end
-  role :other do; 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
-
-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
-
-    keyword_initialize :this, :that do
-      self.instance_variable_set(:@defined_by_initializer_block, 'yes')
-    end
-  end
-
-  describe Surrounded::Context, 'keyword initializers' do
-    it 'works with keyword arguments' do
-      assert Keyworder.new(this: User.new('Jim'), that: User.new('Guille'))
-    end
-
-    it 'raises errors with missing keywords' do
-      err = assert_raises(ArgumentError){
-        Keyworder.new(this: User.new('Amy'))
-      }
-      assert_match(/missing keyword: that/, err.message)
-    end
-
-    it 'evaluates a given block' do
-      assert_equal 'yes', Keyworder.new(this: User.new('Jim'), that: User.new('Guille')).instance_variable_get(:@defined_by_initializer_block)
-    end
-  end
-rescue SyntaxError
-  STDOUT.puts "No support for keywords"
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surrounded
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.9.9
 platform: ruby
 authors:
 - "'Jim Gay'"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: triad
@@ -83,14 +83,19 @@ files:
 - lib/surrounded/shortcuts.rb
 - lib/surrounded/version.rb
 - surrounded.gemspec
+- test/casting_role_player_test.rb
+- test/collection_role_players_test.rb
 - test/context_access_test.rb
 - test/context_forwarding_test.rb
+- test/context_reuse_test.rb
 - test/context_shortcuts_test.rb
 - test/east_oriented_triggers_test.rb
 - test/example_delegate_class_test.rb
 - test/example_proxy_test.rb
 - test/example_threaded_test.rb
 - test/example_wrapper_test.rb
+- test/initialization_test.rb
+- test/non_surrounded_role_player_test.rb
 - test/override_methods_test.rb
 - test/role_context_method_test.rb
 - test/surrounded_context_test.rb
@@ -121,14 +126,19 @@ signing_key:
 specification_version: 4
 summary: Create encapsulated environments for your objects.
 test_files:
+- test/casting_role_player_test.rb
+- test/collection_role_players_test.rb
 - test/context_access_test.rb
 - test/context_forwarding_test.rb
+- test/context_reuse_test.rb
 - test/context_shortcuts_test.rb
 - test/east_oriented_triggers_test.rb
 - test/example_delegate_class_test.rb
 - test/example_proxy_test.rb
 - test/example_threaded_test.rb
 - test/example_wrapper_test.rb
+- test/initialization_test.rb
+- test/non_surrounded_role_player_test.rb
 - test/override_methods_test.rb
 - test/role_context_method_test.rb
 - test/surrounded_context_test.rb