role_playing 0.0.8 → 0.0.9

data/README.md

@@ -37,19 +37,19 @@ Using it is as simple as defining (usually) a context like so:
         @to_account = to_account
       end
       def call(amount)
-        withdrawal = SourceAccount(@from_account) do |source_account|
+        SourceAccount(@from_account) do |source_account|
           DestinationAccount(@to_account).deposit(source_account.withdraw(amount))
         end
       end
     
-      role SourceAccount do
+      role :SourceAccount do
         def withdraw(amount)
           self.amount=self.amount-amount
           amount
         end
       end
     
-      role DestinationAccount do
+      role :DestinationAccount do
         def deposit(amount)
           self.amount=self.amount+amount
         end
@@ -57,11 +57,53 @@ Using it is as simple as defining (usually) a context like so:
     
     end
 
+Basically a role is a class inheriting from RolePlayer::Role, roles can also be defined by themselves(outside a context) like this:
+
+    class MyRole < RolePlayer::Role
+      def my_additional_method
+      end
+    end
+    
+    class MyOtherRole < RolePlayer::Role
+      def my_other_method
+      end
+    end
+
+And, if defined by themselves, they can be applied in a few ways:
+
+    ## our data object which will play different roles (eg. get new/different behavior within a context)
+    class MyDataObject
+    end
+    
+    MyRole.played_by(MyDataObject) do |role|
+      role.my_additional_method
+    end
+
+or
+
+    role = MyRole.played_by(MyDataObject)
+    role.my_additional_method
+
+several roles can be applied too like so:
+
+    [MyRole, MyOtherRole].played_by(MyDataObject) do |role|
+      role.my_additional_method
+      role.my_other_method
+    end
+
+or
+
+    role = [MyRole, MyOtherRole].played_by(MyDataObject)
+    role.my_additional_method
+    role.my_other_method
+
+Within a context a role is defined by the role class method. The syntax sugar of applying a role - eg. MyRole(MyDataObject) do |role| - is only available within classes including the RolePlayer::Context module. This was the way I envisioned it - to basically keep all code concerning a context within the same file (and inside the context class).
+
 Please read the specs for a better understanding. Also please look up DCI (data, context, interaction) for a better understanding of what this is trying to accomplish.
 
-## Rspec
+## RSpec
 
-Theres an Rspec extension included which basically aliases Rspecs context to role so the language used in Rspec can be closer to DCI when testing these things.
+Theres an RSpec extension included which basically aliases RSpecs context to role so the language used in RSpec can be closer to DCI when testing these things.
 To use that extension just do require 'role_playing/rspec_role' in your spec_helper. Look at the specs in this gem to see what I mean.
 
 ## Rails

data/lib/role_playing/context.rb

@@ -4,9 +4,13 @@ module RolePlaying
       base.extend(ClassMethods)
     end
     module ClassMethods
-      def const_missing(sym)
-        sym
-      end
+      ## this seemed to dangerous to use
+      ## it enabled us to use Constants when
+      ## defining roles but would also not
+      ## warn about missing constants - which is pretty bad
+      #def const_missing(sym)
+      #  sym
+      #end
       def role(name, parent=nil, &block)
         parent = parent || RolePlaying::Role
         klass = Class.new(parent, &block)

data/lib/role_playing/core_ext.rb

@@ -1,15 +1,6 @@
 ## PLEASE NOTE: This is almost completely unnecessary except for some syntax sugar which I like.
 ## It basically does this: TheRole.new(theObject) and returns it and also runs an instance_eval
 ## if a block was given. It can also take many Roles, not just one so you could do theObject.as(SomeRole, AnotherRole).
-class Object
-  def in_roles(*roles, &block)
-    extended = roles.inject(self) { |extended, role| role.new(extended) }
-    block_given? ? yield(extended) : extended
-  end
-  def in_role(role, &block)
-    in_roles(*role, &block)
-  end
-end
 
 class Array
   def played_by(object)

data/lib/role_playing/role.rb

@@ -4,9 +4,9 @@ module RolePlaying
   class Role < SimpleDelegator
 
     class << self
-      def played_by(object, &block)
-        extended = new(object)
-        block_given? ? yield(extended) : extended
+      def played_by(object)
+        role = new(object)
+        block_given? ? yield(role) : role
       end
     end
 

data/lib/role_playing/version.rb

@@ -1,3 +1,3 @@
 module RolePlaying
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/spec/role_playing/role_playing_spec.rb

@@ -31,19 +31,19 @@ class MoneyTransferring
     @to_account = to_account
   end
   def call(amount)
-    withdrawal = SourceAccount(@from_account) do |source_account|
+    SourceAccount(@from_account) do |source_account|
       DestinationAccount(@to_account).deposit(source_account.withdraw(amount))
     end
   end
 
-  role SourceAccount do
+  role :SourceAccount do
     def withdraw(amount)
       self.amount=self.amount-amount
       amount
     end
   end
 
-  role DestinationAccount do
+  role :DestinationAccount do
     def deposit(amount)
       self.amount=self.amount+amount
     end
@@ -79,7 +79,7 @@ describe RolePlaying do
     end
 
     it "#in_role takes a block and returns the result" do
-      two_fields = bare_object.in_role(MyRole) do |role|
+      two_fields = MyRole.played_by(bare_object) do |role|
         role.two_fields
       end
       two_fields.should == "#{bare_object.field_1} #{bare_object.field_2}"
@@ -87,6 +87,34 @@ describe RolePlaying do
 
   end
 
+  context "playing roles" do
+    let(:role_class_1) do
+      Class.new(RolePlaying::Role) do
+        def role_1
+        end
+      end
+    end
+    let(:role_class_2) do
+      Class.new(RolePlaying::Role) do
+        def role_2
+        end
+      end
+    end
+    let(:player_class) do
+      Class.new do
+        def base
+        end
+      end
+    end
+
+    it "an array of roles can be applied using Array#played_by" do
+      role = [role_class_1, role_class_2].played_by(player_class.new)
+      role.should respond_to(:role_1)
+      role.should respond_to(:role_2)
+      role.should respond_to(:base)
+    end
+  end
+
   context MoneyTransferring do
 
     role MoneyTransferring::SourceAccount do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: role_playing
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-08 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec