dci-ruby 0.4.1 → 1.0.0

data/README.rdoc

@@ -1,14 +1,14 @@
 = dci-ruby
 
 Trygve Reenskaug, the parent of MVC, proposes an evolution to traditional OO paradigm. (http://www.artima.com/articles/dci_vision.html).
-This gem makes Data-Context-Interaction paradigm ready to be used in your Ruby application.
+This gem makes Data-Context-Interaction paradigm ready to be used in your Ruby application. See also (http://rubysource.com/dci-the-evolution-of-the-object-oriented-paradigm/).
 
 
 == Installation
 
-Install as usual, either with rubygems or including it in your Gemfile and running bundle install:
+Install as usual, either with rubygems
     gem install dci-ruby
-or
+or including it in your Gemfile and then running bundle install:
     # Gemfile
     gem "dci-ruby"
 
@@ -37,6 +37,10 @@ dci-ruby gives you the class Context to inherit from to create your own contexts
           def run(amount)
             source_account.transfer(amount)
           end
+
+          def run_default
+            source_account.transfer(default_amount)
+          end
     end
 
 Every context defines some roles to be played by external objects (players) and their interactions. This way
@@ -51,7 +55,15 @@ Use the defined contexts in your application, instantiating them wherever you ne
 Role player objects (the two account instances above) respond to their corresponding role methods inside the context.
 Moreover, every role player has access to the rest of role players. That's why target_account is reachable inside source_account#transfer
 rolemethod.
+When instanciating a Context, the extra no-role pairs given as arguments are read-only attributes accessible inside the instance:
+
+    MoneyTransfer.new(:source_account => Account.new(1),
+                      :target_account => Account.new(2),
+                      :default_amount => 500).run_default
+
+here, default_amount is not a roleplayer (has no associated role) but is still accessible in the interactions.
 
+See the examples[https://github.com/ltello/dci-ruby/tree/master/examples] folder for examples of use and the DCI-Sample[https://github.com/ltello/DCI-Sample] repository for a sample application using DCI through this gem.
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.4.1
+1.0.0

data/dci-ruby.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "dci-ruby"
-  s.version = "0.4.1"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lorenzo Tello"]
-  s.date = "2012-10-23"
+  s.date = "2012-10-25"
   s.description = "Make DCI paradigm available to Ruby applications"
   s.email = "ltello8a@gmail.com"
   s.extra_rdoc_files = [
@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "dci-ruby.gemspec",
-    "example/example.rb",
+    "examples/money_transfer.rb",
     "lib/dci-ruby.rb",
     "lib/dci-ruby/kernel.rb",
     "spec/context_spec.rb",

data/{example/example.rb → examples/money_transfer.rb}

@@ -32,7 +32,7 @@ class MoneyTransferContext < Context
 
   # Interactions
 
-    def run(amount)
+    def run
       puts "Balances Before: #{balances}"
       source_account.run_transfer_of(amount)
       target_account.run_transfer_of(amount)
@@ -52,4 +52,5 @@ class MoneyTransferContext < Context
 end
 
 MoneyTransferContext.new(:source_account => CheckingAccount.new(1),
-                         :target_account => CheckingAccount.new(2)).run(100)
+                         :target_account => CheckingAccount.new(2),
+                         :amount         => 500).run

data/lib/dci-ruby.rb

@@ -37,9 +37,12 @@ class Context
   # Instances of a defined subclass of Context are initialized checking first that all subclass defined roles
   # are provided in the creation invocation raising an error if any of them is missing.
   # Once the previous check is met, every object playing in the context instance is associated to the stated role.
-  def initialize(players={})
-    check_all_roles_provided_in(players)
+  # Non players args are associated to instance_variables and readers defined.
+  def initialize(args={})
+    check_all_roles_provided_in!(args)
+    players, noplayers = args.partition {|key, value| roles.keys.include?(key)}.map {|group| Hash[*group.flatten]}
     assign_roles_to_players(players)
+    define_attr_readers_for_no_players(noplayers)
   end
 
 
@@ -47,7 +50,7 @@ class Context
 
     # Checks there is an intented player for every role.
     # Raises and error message in case of missing roles.
-    def check_all_roles_provided_in(players={})
+    def check_all_roles_provided_in!(players={})
       missing_roles = missing_roles(players)
       raise "missing roles #{missing_roles}" unless missing_roles.empty?
     end
@@ -80,4 +83,14 @@ class Context
       player.def_delegators(:context, *other_role_keys)
       instance_variable_set(:"@#{role_key}", player)
     end
+
+    def define_attr_readers_for_no_players(vars={})
+      vars.each do |name, value|
+        instance_variable_set(:"@#{name}", value)
+        singleton_class.class_exec(name.to_sym) do |varkey|
+          attr_reader varkey
+        end
+      end
+
+    end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dci-ruby
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 23
   prerelease: 
   segments: 
-  - 0
-  - 4
   - 1
-  version: 0.4.1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Lorenzo Tello
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-23 00:00:00 Z
+date: 2012-10-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -111,7 +111,7 @@ files:
 - Rakefile
 - VERSION
 - dci-ruby.gemspec
-- example/example.rb
+- examples/money_transfer.rb
 - lib/dci-ruby.rb
 - lib/dci-ruby/kernel.rb
 - spec/context_spec.rb