neo-dci 0.0.1

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/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+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,29 @@
+# Neo::DCI [![Build Status](https://secure.travis-ci.org/neopoly/neo-dci.png?branch=master)](http://travis-ci.org/neopoly/neo-dci)
+
+Simple DCI
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'neo-dci'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install neo-dci
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end

data/lib/neo-dci.rb

@@ -0,0 +1 @@
+require "neo/dci"

data/lib/neo/dci.rb

@@ -0,0 +1,6 @@
+require 'neo/dci/version'
+
+require 'neo/dci/data'
+require 'neo/dci/role'
+require 'neo/dci/context_result'
+require 'neo/dci/context'

data/lib/neo/dci/context.rb

@@ -0,0 +1,27 @@
+module Neo
+  module DCI
+    class Context
+
+      class << self
+        private :new
+      end
+
+      def self.call(*args, &block)
+        context = new(*args, &block)
+        result  = ContextResult.new
+        context.call(result)
+        raise UnprocessedError unless result.processed?
+        result
+      rescue NotImplementedError
+        raise
+      end
+
+
+      def call(result)
+        raise NotImplementedError
+      end
+
+      class UnprocessedError < StandardError; end
+    end
+  end
+end

data/lib/neo/dci/context_result.rb

@@ -0,0 +1,43 @@
+require 'ostruct'
+
+module Neo
+  module DCI
+    class ContextResult
+      attr_reader :error, :data
+
+      def success!(data = {})
+        self.data = data
+      end
+
+      def failure!(error, data = {})
+        @error = error
+        self.data  = data
+      end
+
+      def data= (data)
+        raise ArgumentError, "Data is already set. Call success! or failure! only once." if @data
+        @data = Data.new(data)
+        @data.freeze
+      end
+      private :data=
+
+      def success?
+        processed? && !error
+      end
+
+      def failure?
+        processed? && !!error
+      end
+
+      def processed?
+        !!@data
+      end
+
+      class Data < OpenStruct
+        def to_hash
+          @table
+        end
+      end
+    end
+  end
+end

data/lib/neo/dci/data.rb

@@ -0,0 +1,16 @@
+module Neo
+  module DCI
+    module Data
+      # Enhances an object with the Role +role+.
+      def role_as(role, *params)
+        if role.assignable_to?(self, *params)
+          extend role
+          role.role_assigned(self, *params)
+          self
+        else
+          raise Neo::DCI::Role::NotAssignable.new role, self, params
+        end
+      end
+    end
+  end
+end

data/lib/neo/dci/role.rb

@@ -0,0 +1,58 @@
+# A Role gives an object (e.g. an User) specific behaviour (or methods).
+#
+# == Example
+#
+#   module TeamMember
+#     extend Neo::DCI::Role
+#
+#     def self.assignable_to?(user, team)
+#       team.member?(user)
+#     end
+#
+#     def leave_team!(team)
+#       # ...
+#     end
+#   end
+#
+#   class User
+#     include Neo::DCI::Data
+#   end
+#
+#   team_member = team.members.first
+#   team_member.role_as TeamMember
+#   team_member.leave_team!(team)
+#
+#   non_member = User.find(1)
+#   non_member.role_as TeamMember # => raises Role::NotAssignable
+#
+module Neo
+  module DCI
+    module Role
+      # Decides if the role is assignable to +object+.
+      #
+      # The decision can determined by +object+ and +params+.
+      #
+      # Returns +true+ by default so every +object+ can have that role.
+      def assignable_to?(object, *params)
+        true
+      end
+
+      # Hook after a role has been assigned.
+      #
+      # Useful for extend the role with other roles.
+      def role_assigned(object, *params)
+      end
+
+      class NotAssignable < StandardError
+        attr_reader :role, :object, :params
+
+        def initialize(role, object, params)
+          super "Role #{role} not assignable to #{object} with params #{params.inspect}"
+          @role   = role
+          @object = object
+          @params = params
+        end
+      end
+    end
+  end
+end

data/lib/neo/dci/version.rb

@@ -0,0 +1,5 @@
+module Neo
+  module DCI
+    VERSION = "0.0.1"
+  end
+end

data/neo-dci.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/neo/dci/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Peter Suschlik"]
+  gem.email         = ["ps@neopoly.de"]
+  gem.description   = %q{Simple DCI}
+  gem.summary       = %q{Includes Data, Roles and Context.}
+  gem.homepage      = "https://github.com/neopoly/neo-dci"
+
+  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.name          = "neo-dci"
+  gem.require_paths = ["lib"]
+  gem.version       = Neo::DCI::VERSION
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "simple_assertions"
+end

data/test/context_result_test.rb

@@ -0,0 +1,68 @@
+require 'helper'
+
+class ContextResultTest < NeoDCICase
+  let(:result) { Neo::DCI::ContextResult.new }
+  let(:error)  { RuntimeError.new  }
+  let(:data)   { {:foo  => :bar}   }
+
+  test "returns success? when no error present" do
+    result.success!
+    assert result.success?
+    assert result.processed?
+    refute result.failure?
+    assert_nil result.error
+  end
+
+  test "returns failure? on error" do
+    result.failure!(error)
+    refute result.success?
+    assert result.failure?
+    assert result.processed?
+    assert_same error, result.error
+  end
+
+  test "returns not processed? on default" do
+    refute result.processed?
+    refute result.success?
+    refute result.failure?
+  end
+
+  test "returns data as payload on success" do
+    result.success!(data)
+    assert_equal data[:foo], result.data.foo
+  end
+
+  test "returns data as payload on failure" do
+    result.failure!(error, data)
+    assert_equal data[:foo], result.data.foo
+  end
+
+  context "frozen data" do
+    test "after success!" do
+      result.success!
+      assert result.data.frozen?
+    end
+    test "after failure!" do
+      result.failure!(error)
+      assert result.data.frozen?
+    end
+  end
+
+  context "can only be called once" do
+    before do
+      result.success!
+    end
+
+    test "with success!" do
+      assert_raises ArgumentError, :message => /once/ do
+        result.success!
+      end
+    end
+
+    test "with failure!" do
+      assert_raises ArgumentError, :message => /once/ do
+        result.failure!(error)
+      end
+    end
+  end
+end

data/test/context_test.rb

@@ -0,0 +1,56 @@
+require 'helper'
+
+class ContextTest < NeoDCICase
+  class DummyContext < Neo::DCI::Context
+    def initialize(&block)
+      @block = block
+    end
+
+    def call(result)
+      @block.call(result)
+    end
+  end
+
+  let(:data)  { {:foo => :bar }  }
+  let(:error) { RuntimeError.new }
+
+  test "initialize is private" do
+    assert_raises NoMethodError do
+      DummyContext.new
+    end
+  end
+
+  test "raises not implement error" do
+    assert_raises NotImplementedError do
+      Class.new(Neo::DCI::Context).call
+    end
+  end
+
+  test "raises unprocessed error if result is not processed" do
+    assert_raises Neo::DCI::Context::UnprocessedError do
+      Class.new(Neo::DCI::Context) do
+        def call(result); end
+      end.call
+    end
+  end
+
+  test "returns context result if success" do
+    result = DummyContext.call do |result|
+      result.success!(data)
+    end
+    assert result.success?
+    refute result.failure?
+    assert_equal :bar, result.data.foo
+  end
+
+  test "returns context result if failure" do
+    result = DummyContext.call do |result|
+      result.failure!(error, data)
+    end
+    assert result.failure?
+    refute result.success?
+    assert_same  error, result.error
+    assert_equal :bar, result.data.foo
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'minitest/autorun'
+require 'simple_assertions'
+
+require 'neo/dci'
+
+class NeoDCICase < MiniTest::Spec
+  include SimpleAssertions::AssertRaises
+
+  class << self
+    alias :context :describe
+    alias :test :it
+  end
+end

data/test/role_test.rb

@@ -0,0 +1,82 @@
+require 'helper'
+
+class RoleTest < NeoDCICase
+  module Human
+    extend Neo::DCI::Role
+
+    def live!
+      :live
+    end
+  end
+
+  module CryBaby
+    extend Neo::DCI::Role
+    include Human
+
+    def self.assignable_to?(user, emo=false)
+      emo || user.gender == :female
+    end
+
+    def cry!
+      :me_a_river
+    end
+  end
+
+  module EmoCore
+    extend Neo::DCI::Role
+
+    def self.role_assigned(user, *args)
+      user.role_as(CryBaby, *args)
+    end
+
+    def growl!
+      :breee
+    end
+  end
+
+  User = Struct.new(:gender) do
+    include Neo::DCI::Data
+  end
+
+  let(:male) { User.new(:male) }
+  let(:emo) { User.new(:male) }
+  let(:female) { User.new(:female) }
+
+  context :usage do
+    test "all humans can live" do
+      male.role_as Human
+      female.role_as Human
+      assert_equal :live, male.live!
+      assert_equal :live, female.live!
+    end
+
+    test "female can cry!" do
+      female.role_as CryBaby
+      assert_equal :me_a_river, female.cry!
+    end
+
+    test "emo can cry!" do
+      emo.role_as CryBaby, true
+      assert_equal :me_a_river, emo.cry!
+    end
+
+    test "boys don't cry!" do
+      assert_raises Neo::DCI::Role::NotAssignable, :role => CryBaby, :object => male do
+        male.role_as CryBaby
+      end
+    end
+
+    test "emo cores can cry! and growl!" do
+      emo.role_as EmoCore, true
+      assert_equal :me_a_river, emo.cry!
+      assert_equal :breee, emo.growl!
+    end
+  end
+
+  context :role_as do
+    test "returns object itself" do
+      actual = female.role_as CryBaby
+      assert_same female, actual
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: neo-dci
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Peter Suschlik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simple_assertions
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple DCI
+email:
+- ps@neopoly.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/neo-dci.rb
+- lib/neo/dci.rb
+- lib/neo/dci/context.rb
+- lib/neo/dci/context_result.rb
+- lib/neo/dci/data.rb
+- lib/neo/dci/role.rb
+- lib/neo/dci/version.rb
+- neo-dci.gemspec
+- test/context_result_test.rb
+- test/context_test.rb
+- test/helper.rb
+- test/role_test.rb
+homepage: https://github.com/neopoly/neo-dci
+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.24
+signing_key: 
+specification_version: 3
+summary: Includes Data, Roles and Context.
+test_files:
+- test/context_result_test.rb
+- test/context_test.rb
+- test/helper.rb
+- test/role_test.rb