surrounded 0.5.1 → 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b50df20142b16850a46c0824115d7286d5c5db0
+  data.tar.gz: bbf2f02bc6d2bf089f8a1a6c33627cac0efb8e43
+SHA512:
+  metadata.gz: 4d1badd06972d938d14bc50ea50d8d074c882a4ebf2728724de48131e875f55f75dcdd019fbcdd64322eb6591d414ec9fccbe12cc106518fa3d309a93ab31294
+  data.tar.gz: b3aa0cfaaec0178fbe799fff2b64d16f4565be58eb6d95e29eb46542a7ef35a7bc50ddc80bae8b51ff5b614277ff3079846d4a872697e8d2c11364f3984781ea

data/README.md

@@ -244,17 +244,21 @@ You might find that useful for dynamically defining user interfaces.
 
 Sometimes I'd rather not use this DSL, however. I want to just write regular methods. 
 
-We can do that too. You'll need to opt in to this by specifying `set_methods_as_triggers` for the context class.
+We can do that too. You'll need to opt in to this by specifying `trigger :your_method_name` for the methods you want to use.
 
 ```ruby
 class MyEnvironment
   # other stuff from above is still here...
-  
-  set_methods_as_triggers
 
   def shove_it
     employee.quit
   end
+  trigger :shove_it
+  
+  # or in Ruby 2.x
+  trigger def shove_it
+    employee.quit
+  end
 
   role :employee do
     def quit
@@ -269,7 +273,7 @@ end
 
 This will allow you to write methods like you normally would. They are aliased internally with a prefix and the method name that you use is rewritten to add and remove the context for the objects in this context. The public API of your class remains the same, but the extra feature of wrapping your method is handled for you.
 
-This will treat all instance methods defined on your context the same way, so be aware of that.
+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.
 
 ## Where roles exist
 
@@ -367,7 +371,7 @@ of your context.
 Here's how it works:
 
 ```ruby
-class ActiviatingAccount
+class ActivatingAccount
   extend Surrounded::Context
 
   apply_roles_on(:trigger) # this is the default
@@ -423,12 +427,17 @@ class ActiviatingAccount
   apply_roles_on(:trigger) # this is the default
   # apply_roles_on(:initialize) # set this to apply behavior from the start
   
-  set_methods_as_triggers # allows you to skip the 'trigger' dsl
-  
   # set the default role type only for this class
   self.default_role_type = :module # also :wrap, :wrapper, or :interface
 
+  # shortcut initialization code
   initialize(:activator, :account)
+  # or handle it yourself
+  def initialize(activator, account)
+    # this must be done to handle the mapping of roles to objects
+    # pass an array of arrays with role name symbol and the object for that role
+    map_roles([[:activator, activator],[:account, account]])
+  end
 
   role :activator do # module by default
     def some_behavior; end
@@ -463,6 +472,15 @@ class ActiviatingAccount
   trigger :some_trigger_method do
     activator.some_behavior # behavior always available
   end
+  
+  trigger def some_other_trigger
+    activator.some_behavior # behavior always available
+  end
+  
+  def regular_non_trigger
+    activator.some_behavior # behavior always available with the following line
+  end
+  trigger :regular_non_trigger # turns the method into a trigger  
 end
 ```
 

data/examples/rails.rb

@@ -2,9 +2,13 @@
 
 # First, be guarded against changes in third-party libraries
 module Awareness
-  include Surrounded
-  include Casting::Client
-  delegate_missing_methods
+  def self.included(base)
+    base.class_eval {
+      include Surrounded
+      include Casting::Client
+      delegate_missing_methods
+    }
+  end
 end
 
 class User
@@ -18,7 +22,7 @@ end
 class SomeUseCase
   extend Surrounded::Context
 
-  setup(:admin, :other_user, :listener)
+  initialize(:admin, :other_user, :listener)
 
   trigger :do_something do
     admin.something

data/lib/surrounded/context.rb

@@ -18,7 +18,6 @@ module Surrounded
     def self.extended(base)
       base.class_eval {
         @triggers = Set.new
-        @methods_as_triggers = Surrounded::Context.methods_as_triggers
         include InstanceMethods
       }
       base.singleton_class.send(:alias_method, :setup, :initialize)
@@ -29,18 +28,7 @@ module Surrounded
     end
 
     class << self
-      attr_writer :default_role_type, :methods_as_triggers
-    end
-
-    attr_reader :methods_as_triggers
-
-    def self.methods_as_triggers
-      return @methods_as_triggers if defined?(@methods_as_triggers)
-      @methods_as_triggers = false
-    end
-
-    def set_methods_as_triggers
-      @methods_as_triggers = true
+      attr_writer :default_role_type
     end
 
     def new(*args, &block)
@@ -105,6 +93,7 @@ module Surrounded
     rescue NameError => e
       raise e.extend(InvalidRoleType)
     end
+    alias_method :role_methods, :role
 
     def apply_roles_on(which)
       @__apply_role_policy = which
@@ -132,18 +121,31 @@ module Surrounded
       private(*method_names)
     end
 
-    def trigger(name, *args, &block)
-      store_trigger(name)
+    def trigger(*names, &block)
+      if block.nil?
+        names.each do |name|
+          unless triggers.include?(name) || name.nil?
+            alias_method :"__trigger_#{name}", :"#{name}"
+            private :"__trigger_#{name}"
+            remove_method :"#{name}"
+            redo_method(name)
+            store_trigger(name)
+          end
+        end
+      else
+        name = names.first
 
-      define_method(:"__trigger_#{name}", *args, &block)
+        define_method(:"__trigger_#{name}", &block)
 
-      private :"__trigger_#{name}"
+        private :"__trigger_#{name}"
+        store_trigger(name)
 
-      redo_method(name, args)
+        redo_method(name)
+      end
     end
 
-    def store_trigger(name)
-      @triggers << name
+    def store_trigger(*names)
+      @triggers.merge(names)
     end
 
     def role_const(name)
@@ -152,13 +154,13 @@ module Surrounded
       end
     end
 
-    def redo_method(name, args)
+    def redo_method(name)
       class_eval %{
-        def #{name}(#{args.join(', ')})
+        def #{name}
           begin
             apply_roles if __apply_role_policy == :trigger
 
-            self.send("__trigger_#{name}", #{args.join(', ')})
+            self.send("__trigger_#{name}")
 
           ensure
             remove_roles if __apply_role_policy == :trigger
@@ -167,20 +169,6 @@ module Surrounded
       }
     end
 
-    def method_added(name)
-      if methods_as_triggers
-        unless name.to_s.match(/^__trigger|initialize/) || (@triggers && triggers.include?(name))
-          store_trigger(name)
-          args = self.instance_method(name).parameters.map{|p| p.last }
-          alias_method :"__trigger_#{name}", :"#{name}"
-          private :"__trigger_#{name}"
-          remove_method :"#{name}"
-          redo_method(name, args)
-        end
-      end
-      super
-    end
-
     module InstanceMethods
       def role?(name, &block)
         return false unless role_map.role?(name)

data/lib/surrounded/version.rb

@@ -1,3 +1,3 @@
 module Surrounded
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/test/role_context_method_test.rb

@@ -4,7 +4,7 @@ describe Surrounded::Context, '.role' do
   class RoleContextTester
     extend Surrounded::Context
 
-    role :admin do
+    role_methods :admin do
     end
   end
 

data/test/surrounded_context_test.rb

@@ -90,21 +90,21 @@ end
 
 class RoleAssignmentContext
   extend Surrounded::Context
-  set_methods_as_triggers
 
   initialize(:user, :other_user)
 
-  trigger :user_ancestors do
+  def user_ancestors
     user.singleton_class.ancestors
   end
 
-  trigger :other_user_ancestors do
+  def other_user_ancestors
     other_user.singleton_class.ancestors
   end
 
-  trigger :check_user_response do
+  trigger def check_user_response
     user.respond_to?(:a_method!)
   end
+  trigger :check_user_response # should not raise error
 
   trigger :check_other_user_response do
     user.respond_to?(:a_method!)
@@ -113,6 +113,8 @@ class RoleAssignmentContext
   def regular_method_trigger
     user.respond_to?(:a_method!)
   end
+  
+  trigger :user_ancestors, :other_user_ancestors, :regular_method_trigger
 
   module User
     def a_method!; end
@@ -175,4 +177,8 @@ describe Surrounded::Context, 'assigning roles' do
   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

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: surrounded
 version: !ruby/object:Gem::Version
-  version: 0.5.1
-  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors:
-- '''Jim Gay'''
+- "'Jim Gay'"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2013-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: triad
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Gives an object implicit access to other objects in it's environment.
@@ -66,9 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .simplecov
-- .travis.yml
+- ".gitignore"
+- ".simplecov"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -91,33 +84,26 @@ files:
 homepage: http://github.com/saturnflyer/surrounded
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2352251997784321563
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2352251997784321563
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.26
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Create encapsulated environments for your objects.
 test_files:
 - test/example_proxy_test.rb