role_playing 0.0.3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in role_playing.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 John Axel Eriksson
+
+MIT License
+
+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.md

@@ -0,0 +1,83 @@
+# RolePlaying
+
+A ruby DCI implementation using SimpleDelegator. This was extracted from a Rails app I'm working on. It's a very simple and straightforward implementation.
+
+I'm well aware that this is not "true" DCI but I believe it to be in the spirit of DCI while avoiding the awfulness that is object.extend.
+
+Using object.extend in Ruby has two severe problems, one that makes it not true DCI and another that makes it really really slow:
+
+1. There is no unextend
+2. It blows rubys method cache when used
+
+A further comment on 2 is that it means EVERY time you call extend it blows Rubys ENTIRE method cache - it doesn't mean just the object you're extending, it means everything.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'role_playing'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install role_playing
+
+## Usage
+
+Using it is as simple as defining (usually) a context like so:
+
+    class MoneyTransfer
+      def initialize(from_account, to_account)
+        @from_account = from_account
+        @to_account = to_account
+      end
+      def call(amount)
+        withdrawal = @from_account.in_role(SourceAccount).withdraw(amount)
+        @to_account.in_role(DestinationAccount).deposit(withdrawal)
+      end
+    
+      class SourceAccount < RolePlaying::Role
+        def withdraw(amount)
+          self.amount=self.amount-amount
+          amount
+        end
+      end
+    
+      class DestinationAccount < RolePlaying::Role
+        def deposit(amount)
+          self.amount=self.amount+amount
+        end
+      end
+    
+    end
+
+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
+
+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.
+
+## Links
+
+http://dci-in-ruby.info
+
+http://www.clean-ruby.com
+
+http://tonyarcieri.com/dci-in-ruby-is-completely-broken - on why extend is bad
+
+http://rubysource.com/dci-the-evolution-of-the-object-oriented-paradigm/
+
+http://vimeo.com/8235394 - the inventor himself talks about DCI
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/role_playing.rb

@@ -0,0 +1,2 @@
+require "role_playing/version"
+require "role_playing/dci"

data/lib/role_playing/dci.rb

@@ -0,0 +1,33 @@
+require 'delegate'
+
+module RolePlaying
+  class Role < SimpleDelegator
+    def class
+      role_player.class ## this makes self.class return the extended objects class instead of DCIRole - should make the extension completely transparent
+    end
+
+    ## return the FINAL wrapped object
+    def role_player
+      player = self
+      while player.respond_to?(:__getobj__)
+        player = player.__getobj__
+      end
+      player
+    end
+
+  end
+end
+
+## 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) }
+    extended.instance_eval(&block) if block_given?
+    extended
+  end
+  def in_role(role, &block)
+    in_roles(*role, &block)
+  end
+end

data/lib/role_playing/rspec_role.rb

@@ -0,0 +1,13 @@
+module RolePlaying
+  module RspecRole
+    def self.included(base)
+      base.instance_eval do
+        alias :role :context
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include(RolePlaying::RspecRole)
+end

data/lib/role_playing/version.rb

@@ -0,0 +1,3 @@
+module RolePlaying
+  VERSION = "0.0.3"
+end

data/role_playing.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'role_playing/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "role_playing"
+  gem.version       = RolePlaying::VERSION
+  gem.authors       = ["John Axel Eriksson"]
+  gem.email         = ["john@insane.se"]
+  gem.description   = %q{A ruby DCI implementation}
+  gem.summary       = %q{A ruby DCI implementation}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency("rspec", ">= 2.12.0")
+  gem.add_development_dependency("bundler", "~> 1.2.0")
+end

data/spec/role_playing/dci_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+class DataObject
+  attr_accessor :field_1
+  attr_accessor :field_2
+  def initialize(field1, field2)
+    self.field_1=field1
+    self.field_2=field2
+  end
+end
+
+class Account
+  attr_accessor :amount
+  def initialize(amount)
+    self.amount = amount
+  end
+end
+
+class MyRole < RolePlaying::Role
+  def two_fields
+    "#{field_1} #{field_2}"
+  end
+end
+
+## a context
+class MoneyTransfer
+  def initialize(from_account, to_account)
+    @from_account = from_account
+    @to_account = to_account
+  end
+  def call(amount)
+    withdrawal = @from_account.in_role(SourceAccount).withdraw(amount)
+    @to_account.in_role(DestinationAccount).deposit(withdrawal)
+  end
+
+  class SourceAccount < RolePlaying::Role
+    def withdraw(amount)
+      self.amount=self.amount-amount
+      amount
+    end
+  end
+
+  class DestinationAccount < RolePlaying::Role
+    def deposit(amount)
+      self.amount=self.amount+amount
+    end
+  end
+
+end
+
+describe RolePlaying do
+  role MyRole do
+    let(:field_1) { 'Data' }
+    let(:field_2) { 'Object' }
+    let(:bare_object) { DataObject.new(field_1, field_2) }
+    subject { MyRole.new(bare_object) }
+
+    it "should be of same class as wrapped object" do
+      subject.class.should == bare_object.class
+    end
+
+    it "should be equal to wrapped object" do
+      subject.should == bare_object
+    end
+
+    it "should respond_to additional methods" do
+      subject.should respond_to(:two_fields)
+    end
+
+    it "#two_fields should concatenate data objects two fields" do
+      subject.two_fields.should == "#{bare_object.field_1} #{bare_object.field_2}"
+    end
+
+    it "#role_player should not respond_to additional methods" do
+      subject.role_player.should_not respond_to(:two_fields)
+    end
+
+  end
+
+  context MoneyTransfer do
+
+    role MoneyTransfer::SourceAccount do
+      let(:original_amount) { 50 }
+      let(:bare_account) {Account.new(original_amount)}
+      subject { MoneyTransfer::SourceAccount.new(bare_account) }
+      it "adds a withdraw method to data object" do
+        bare_account.should_not respond_to(:withdraw)
+        subject.should respond_to(:withdraw)
+      end
+      it "withdraws a specified amount" do
+        subject.withdraw(10)
+        subject.amount.should == original_amount-10
+        bare_account.amount.should == original_amount-10
+      end
+    end
+
+    role MoneyTransfer::DestinationAccount do
+      let(:original_amount) { 50 }
+      let(:bare_account) {Account.new(original_amount)}
+      subject { MoneyTransfer::DestinationAccount.new(bare_account) }
+      it "adds a deposit method to data object" do
+        bare_account.should_not respond_to(:deposit)
+        subject.should respond_to(:deposit)
+      end
+      it "deposits a specified amount" do
+        subject.deposit(10)
+        subject.amount.should == original_amount+10
+        bare_account.amount.should == original_amount+10
+      end
+    end
+
+    let(:original_source_account_amount) { 100 }
+    let(:original_destination_account_amount) { 40 }
+    let(:source_account) { Account.new(original_source_account_amount) }
+    let(:destination_account) { Account.new(original_destination_account_amount) }
+    let(:transfer_amount) { 50 }
+    subject { MoneyTransfer.new(source_account, destination_account) }
+
+    it "transfers a specified amount from a SourceAccount to a DestinationAccount" do
+      source_account.amount.should == original_source_account_amount
+      destination_account.amount.should == original_destination_account_amount
+      subject.call(transfer_amount)
+      source_account.amount.should == original_source_account_amount-transfer_amount
+      destination_account.amount.should == original_destination_account_amount+transfer_amount
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+
+require 'bundler/setup'
+require 'fileutils'
+
+role_playing_path = File.expand_path('./lib', File.dirname(__FILE__))
+$:.unshift(role_playing_path) if File.directory?(role_playing_path) && !$:.include?(role_playing_path)
+
+require 'role_playing'
+require 'role_playing/rspec_role'
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  config.mock_with :rspec
+
+  ## perhaps this should be removed as well
+  ## and done in Rakefile?
+  config.color_enabled = true
+  ## dont do this, do it in Rakefile instead
+  #config.formatter = 'd'
+
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: role_playing
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- John Axel Eriksson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: A ruby DCI implementation
+email:
+- john@insane.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/role_playing.rb
+- lib/role_playing/dci.rb
+- lib/role_playing/rspec_role.rb
+- lib/role_playing/version.rb
+- role_playing.gemspec
+- spec/role_playing/dci_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A ruby DCI implementation
+test_files:
+- spec/role_playing/dci_spec.rb
+- spec/spec_helper.rb
+has_rdoc: