dci-ruby 0.4.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2"
+  gem "rdoc",  "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    rake (0.9.2.2)
+    rcov (1.0.0)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.4)
+  rcov
+  rdoc (~> 3.12)
+  rspec (~> 2)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Lorenzo Tello
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= 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.
+
+== Copyright
+
+Copyright (c) 2012 Lorenzo Tello. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+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 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name        = "dci-ruby"
+  gem.homepage    = "http://github.com/ltello/dci-ruby"
+  gem.license     = "MIT"
+  gem.summary     = %Q{Make DCI paradigm available to Ruby applications by enabling developers defining contexts suclassing the new class Context. You define roles inside the definition. Match roles and player objects in context instanciation.}
+  gem.description = %Q{Make DCI paradigm available to Ruby applications}
+  gem.email       = "ltello8a@gmail.com"
+  gem.authors     = ["Lorenzo Tello"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dci-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/dci-ruby.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "dci-ruby"
+  s.version = "0.4.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.description = "Make DCI paradigm available to Ruby applications"
+  s.email = "ltello8a@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "dci-ruby.gemspec",
+    "example/example.rb",
+    "lib/dci-ruby.rb",
+    "lib/dci-ruby/kernel.rb",
+    "spec/context_spec.rb",
+    "spec/interaction_spec.rb",
+    "spec/role_spec.rb",
+    "spec/roleplayers_spec.rb",
+    "spec/spec_helper.rb",
+    "test/helper.rb",
+    "test/test_dci-ruby.rb"
+  ]
+  s.homepage = "http://github.com/ltello/dci-ruby"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Make DCI paradigm available to Ruby applications by enabling developers defining contexts suclassing the new class Context. You define roles inside the definition. Match roles and player objects in context instanciation."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/example/example.rb

@@ -0,0 +1,55 @@
+require 'dci-ruby'
+
+
+class CheckingAccount
+  attr_reader   :account_id
+  attr_accessor :balance
+
+  def initialize(account_id)
+    @account_id, @balance = account_id, 0
+  end
+end
+
+
+class MoneyTransferContext < Context
+
+  # Roles Definitions
+
+    role :source_account do
+      def run_transfer_of(amount)
+        self.balance -= amount
+        puts "Source Account #{account_id} sent $#{amount} to Target Account #{target_account.account_id}."
+      end
+    end
+
+    role :target_account do
+      def run_transfer_of(amount)
+        self.balance += amount
+        puts "Target Account #{account_id} received $#{amount} from Source Account #{source_account.account_id}."
+      end
+    end
+
+
+  # Interactions
+
+    def run(amount)
+      puts "Balances Before: #{balances}"
+      source_account.run_transfer_of(amount)
+      target_account.run_transfer_of(amount)
+      puts "Balances After:  #{balances}"
+    end
+
+
+  private
+
+    def accounts
+      [source_account, target_account]
+    end
+
+    def balances
+      accounts.map {|account| "$#{account.balance}"}.join(' - ')
+    end
+end
+
+MoneyTransferContext.new(:source_account => CheckingAccount.new(1),
+                         :target_account => CheckingAccount.new(2)).run(100)

data/lib/dci-ruby/kernel.rb

@@ -0,0 +1,8 @@
+module Kernel
+  def singleton_class
+    class << self
+      self
+    end
+  end unless respond_to?(:singleton_class)
+end
+

data/lib/dci-ruby.rb

@@ -0,0 +1,83 @@
+require 'forwardable'
+require 'dci-ruby/kernel'
+
+
+class Context
+
+  class << self
+
+    # Every subclass of Context has is own class and instance method roles defined.
+    # The instance method delegates value to the class.
+    def inherited(subklass)
+      subklass.class_eval do
+        def self.roles; {} end
+        def roles; self.class.roles end
+      end
+    end
+
+
+    private
+
+      # The macro role is defined to allow a subclass of Context to define roles in its definition.
+      # Every new role redefines the role class method to contain a hash accumulating all defined roles in that subclass.
+      # An accessor to the object playing the new role is also defined and available in every instance of the context subclass.
+      def role(role_key, &block)
+        raise "role name must be a symbol" unless role_key.is_a?(Symbol)
+        updated_roles = roles.merge(role_key => Module.new(&block))
+        singleton_class.class_exec(updated_roles) do |new_roles|
+          remove_method(:roles) rescue nil
+          define_method(:roles) { new_roles }
+        end
+        attr_reader role_key
+      end
+
+  end
+
+
+  # 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)
+    assign_roles_to_players(players)
+  end
+
+
+  private
+
+    # 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={})
+      missing_roles = missing_roles(players)
+      raise "missing roles #{missing_roles}" unless missing_roles.empty?
+    end
+
+    # The list of roles with no player provided
+    def missing_roles(players={})
+      (roles.keys - players.keys)
+    end
+
+    # Associates every role to the intended player.
+    def assign_roles_to_players(players={})
+      roles.keys.each do |role_key|
+        assign_role_to_player(role_key, players[role_key])
+      end
+    end
+
+    # Associates a role to an intended player:
+    #   - The object to play the role extends the defined module for that role, so it now respond to the methods
+    #       defined in the role definition.
+    #   - The object to play the role has access to the context it is playing.
+    #   - The object to play the role has access to the rest of players in its context.
+    #   - The context instance has access to this new player through a new instance variable defined with the name of the role.
+    def assign_role_to_player(role_key, player)
+      role_module     = roles[role_key]
+      other_role_keys = roles.keys - [role_key]
+      player.extend(role_module, ::SingleForwardable)
+      player.singleton_class.class_exec(self) do |context|
+        define_method(:context) {context}
+      end
+      player.def_delegators(:context, *other_role_keys)
+      instance_variable_set(:"@#{role_key}", player)
+    end
+end

data/spec/context_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Context do
+
+  context "Definition" do
+    context "When Inherit from Context" do
+      before(:all) do
+        class ExampleContext < Context
+          role :rolename do
+          end
+
+          def interaction1
+          end
+        end
+      end
+
+      it("A new context subclass is ready to be used...") {ExampleContext.superclass.should be(Context)}
+      it("...in which the developer can define roles...") {ExampleContext.private_methods.should include("role")}
+      it("...but privately inside the class.") {ExampleContext.should_not respond_to(:role)}
+      it("He can also define contextmethods (instance methods) that acts as interactions.") {ExampleContext.public_instance_methods(false).should include('interaction1')}
+    end
+  end
+
+  context "Use" do
+    context "To use a Context" do
+      before(:all) do
+        class AnotherContext < Context
+          role :role1 do
+          end
+          role :role2 do
+          end
+
+          def interaction1
+            role1
+          end
+
+          def interaction2
+            role1.object_id - role2.object_id
+          end
+        end
+        @player1, @player2 = Object.new, Object.new
+        @example_context   = AnotherContext.new(:role1 => @player1, :role2 => @player2)
+      end
+
+      it("You instanciate it...") {@example_context.class.should be(AnotherContext)}
+      it("...providing a hash of type {:rolename1 => player1, ... }") do
+        expect {AnotherContext.new(@player1, @player2)}.to raise_error
+      end
+      it("...with ALL rolenames as keys...") do
+        expect {AnotherContext.new(:role1 => @player1)}.to raise_error('missing roles role2')
+      end
+      it("...and the objects to play those roles as values.") do
+        [@player1, @player2].should include(@example_context.role1, @example_context.role2)
+      end
+      it("Once instanciated...") {@example_context.class.should be(AnotherContext)}
+      it("...you call an interaction (instance method) on it") {@example_context.should respond_to(:interaction1)}
+      it("...to start interaction among roleplayers inside the context") do
+        @example_context.interaction2.should be_instance_of(Fixnum)
+      end
+
+    end
+  end
+
+end

data/spec/interaction_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'Interaction' do
+
+  context "Inside a contextmethod(interaction)" do
+    before(:all) do
+      class AnotherContext < Context
+        role :role1 do
+        end
+        role :role2 do
+        end
+
+        def interaction1
+          role1
+        end
+      end
+      @player1, @player2 = Object.new, Object.new
+      @example_context = AnotherContext.new(:role1 => @player1, :role2 => @player2)
+    end
+
+    it("The developer has access to all the roleplayers...") {@example_context.interaction1.should be(@player1)}
+    it("...named after the rolenames.") {@example_context.methods.should include('role1', 'role2')}
+  end
+
+
+end

data/spec/role_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'Role' do
+
+  context "When defining roles inside a Context subclass..." do
+    before(:all) do
+      class ExampleContext < Context
+        role :rolename do
+        end
+        role :anotherrolename do
+        end
+      end
+    end
+    it("You can define as many as you want") {ExampleContext.roles.keys.size.should eql(2)}
+    it("Each rolename must be provided as a symbol...") {ExampleContext.roles.keys.should include(:rolename)}
+    it("...and not as a string") {expect {class ExampleContext < Context; role "rolename" do; end; end}.to raise_error}
+    it("A block defining rolemethods can also be provided.") {ExampleContext.roles[:rolename].class.should be(Module)}
+  end
+
+end

data/spec/roleplayers_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'ostruct'
+
+describe 'RolePlayers' do
+
+  context "Are Ruby objects inside a context instance" do
+    before(:all) do
+      class AnotherContext < Context
+        role :role1 do
+          def rolemethod1
+            :rolemethod1_executed
+          end
+        end
+        role :role2 do
+          def rolemethod2
+            role1
+          end
+        end
+
+        def interaction1
+          role1
+        end
+
+        def interaction2
+          role1.object_id - role2.object_id
+        end
+      end
+      @player1, @player2 = OpenStruct.new(:field1 => 'value1'), OpenStruct.new(:field2 => 'value2')
+      @example_context   = AnotherContext.new(:role1 => @player1, :role2 => @player2)
+    end
+
+    it("that besides their normal behaviour...") do
+      @player1.field1.should eql('value1')
+    end
+    it("...also respond to the rolemethods defined in their playing role.") do
+      @example_context.role1.rolemethod1.should eql(:rolemethod1_executed)
+    end
+    it("Roleplayers can access other roleplayers in their context...") do
+      @example_context.role2.rolemethod2.should eql(@example_context.role1)
+    end
+    it("...and even the context itself.") do
+      @example_context.role2.context.should eql(@example_context)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'dci-ruby'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+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

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

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification 
+name: dci-ruby
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Lorenzo Tello
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  version_requirements: *id001
+  name: rspec
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  version_requirements: *id002
+  name: rdoc
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id003
+  name: bundler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 1
+        - 8
+        - 4
+        version: 1.8.4
+  version_requirements: *id004
+  name: jeweler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id005
+  name: rcov
+  prerelease: false
+  type: :development
+description: Make DCI paradigm available to Ruby applications
+email: ltello8a@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- dci-ruby.gemspec
+- example/example.rb
+- lib/dci-ruby.rb
+- lib/dci-ruby/kernel.rb
+- spec/context_spec.rb
+- spec/interaction_spec.rb
+- 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
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Make DCI paradigm available to Ruby applications by enabling developers defining contexts suclassing the new class Context. You define roles inside the definition. Match roles and player objects in context instanciation.
+test_files: []
+