dci-ruby 0.4.0 → 0.4.1

data/README.rdoc

@@ -1,16 +1,57 @@
 = dci-ruby
 
-Description goes here.
-
-== Contributing to dci-ruby
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+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.
+
+
+== Installation
+
+Install as usual, either with rubygems or including it in your Gemfile and running bundle install:
+    gem install dci-ruby
+or
+    # Gemfile
+    gem "dci-ruby"
+
+
+== Use
+
+dci-ruby gives you the class Context to inherit from to create your own contexts:
+
+    class MoneyTransfer < Context
+
+      # Roles
+          role :source_account do
+            def transfer(amount)
+               balance -= amount
+               target_account.get_transfer(amount)
+            end
+          end
+
+          role :target_account do
+            def get_transfer(amount)
+              balance += amount
+            end
+          end
+
+      # Interactions
+          def run(amount)
+            source_account.transfer(amount)
+          end
+    end
+
+Every context defines some roles to be played by external objects (players) and their interactions. This way
+you have the whole agents and operations in a user case wrapped in just one entity instead of spreaded througout the
+whole application code.
+
+Use the defined contexts in your application, instantiating them wherever you need them in your code:
+
+    MoneyTransfer.new(:source_account => Account.new(1),
+                      :target_account => Account.new(2)).run(100)
+
+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.
+
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/dci-ruby.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "dci-ruby"
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lorenzo Tello"]
@@ -33,9 +33,7 @@ Gem::Specification.new do |s|
     "spec/interaction_spec.rb",
     "spec/role_spec.rb",
     "spec/roleplayers_spec.rb",
-    "spec/spec_helper.rb",
-    "test/helper.rb",
-    "test/test_dci-ruby.rb"
+    "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/ltello/dci-ruby"
   s.licenses = ["MIT"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dci-ruby
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Lorenzo Tello
@@ -119,8 +119,6 @@ files:
 - spec/role_spec.rb
 - spec/roleplayers_spec.rb
 - spec/spec_helper.rb
-- test/helper.rb
-- test/test_dci-ruby.rb
 homepage: http://github.com/ltello/dci-ruby
 licenses: 
 - MIT

data/test/helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'dci-ruby'
-
-class Test::Unit::TestCase
-end

data/test/test_dci-ruby.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestDciRuby < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end