neo-dci 0.2.0 → 0.3.0

data/README.md

@@ -1,6 +1,11 @@
 # Neo::DCI [![Build Status](https://secure.travis-ci.org/neopoly/neo-dci.png?branch=master)](http://travis-ci.org/neopoly/neo-dci)
 
-Simple DCI
+Simple DCI (Data Context Interaction).
+Includes Data, Roles and Context.
+
+[Gem](https://rubygems.org/gems/neo-dci) |
+[Source](https://github.com/neopoly/neo-dci) |
+[Documentation](http://rubydoc.info/github/neopoly/neo-dci/master/file/README.md)
 
 ## Installation
 
@@ -39,17 +44,20 @@ class Context < Neo::DCI::Context
 end
 
 class RenameUserContext < Context
+  # Define callbacks called inside a context.
+  callbacks :success, :failure
+
   def initialize(user_id, new_name)
     @user     = User.find(user_id)
     @new_name = new_name
   end
 
-  def call(result)
+  def call
     @user.role_as(Renamer)
     if @user.rename_to(@new_name)
-      result.success! :new_name => @new_name
+      callback.call :success, @new_name
     else
-      result.failure! "renaming failed"
+      callback.call :failure, "renaming failed"
     end
   end
 end
@@ -73,13 +81,13 @@ end
 ```ruby
 class UsersController < ApplicationController
   def rename
-    result = RenameUserContext.call(current_user.id, params[:name])
-    if result.success?
-      new_name = result.data.new_name
-      redirect_to users_path, :notice => "Renamed successfully to #{new_name}"
-    else
-      error = result.error
-      render :alert => "Renaming failed: #{error}!"
+    RenameUserContext.call(current_user.id, params[:name]) do |callback|
+      callback.on :success do |new_name|
+        redirect_to users_path, :notice => "Renamed successfully to #{new_name}"
+      end
+      callback.on :failure do |error_message|
+        render :alert => "Renaming failed: #{error_message}!"
+      end
     end
   end
 end

data/Rakefile

@@ -1,5 +1,5 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/setup'
+require 'bundler/gem_tasks'
 
 task :default => :test
 
@@ -9,3 +9,12 @@ Rake::TestTask.new do |t|
   t.test_files = FileList['test/**/*_test.rb']
   t.verbose = true
 end
+
+# RDoc
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.title    = "Neo::DCI"
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.main     = 'README.md'
+  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+end

data/lib/neo/dci.rb

@@ -2,7 +2,6 @@ require 'neo/dci/version'
 
 require 'neo/dci/data'
 require 'neo/dci/role'
-require 'neo/dci/context_result'
 require 'neo/dci/context'
 
 require 'neo/dci/task_loader' if defined?(::Rails::Railtie)

data/lib/neo/dci/context.rb

@@ -1,27 +1,38 @@
+require 'on'
+
 module Neo
   module DCI
     class Context
-
       class << self
         private :new
       end
 
+      attr_accessor :callback
+
+      def self.callbacks(*args)
+        @callbacks ||= []
+        @callbacks = args unless args.empty?
+        @callbacks
+      end
+
       def self.call(*args, &block)
-        context = new(*args, &block)
-        result  = ContextResult.new
-        context.call(result)
-        raise UnprocessedError unless result.processed?
-        result
+        context = new(*args)
+        context.callback = On.new(*callbacks, &block)
+        context.call
+        raise NoCallbackCalled, callbacks unless context.callback.callback
       rescue NotImplementedError
         raise
       end
 
-
-      def call(result)
+      def call
         raise NotImplementedError
       end
 
-      class UnprocessedError < StandardError; end
+      class NoCallbackCalled < StandardError
+        def initialize(callbacks)
+          super("No callback called. Available callbacks: #{callbacks.join(', ')}")
+        end
+      end
     end
   end
 end

data/lib/neo/dci/version.rb

@@ -1,5 +1,5 @@
 module Neo
   module DCI
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/neo-dci.gemspec

@@ -15,7 +15,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Neo::DCI::VERSION
 
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "minitest"
-  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rdoc'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'testem'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'on', '~> 0.2.0'
 end

data/test/context_test.rb

@@ -1,56 +1,69 @@
 require 'helper'
 
 class ContextTest < NeoDCICase
-  class DummyContext < Neo::DCI::Context
-    def initialize(&block)
-      @block = block
-    end
-
-    def call(result)
-      @block.call(result)
+  class TestContext < Neo::DCI::Context
+    def initialize(*args)
+      @args = args
     end
   end
 
-  let(:data)  { {:foo => :bar }  }
-  let(:error) { RuntimeError.new }
-
   test "initialize is private" do
     assert_raises NoMethodError do
-      DummyContext.new
+      TestContext.new
     end
   end
 
   test "raises not implement error" do
     assert_raises NotImplementedError do
-      Class.new(Neo::DCI::Context).call
+      Class.new(Neo::DCI::Context) do
+        callbacks :foo
+      end.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
+  test "yields callback" do
+    context = Class.new(TestContext) do
+      callbacks :success
+
+      def call
+        callback.call :success, @args
+      end
     end
-  end
 
-  test "returns context result if success" do
-    result = DummyContext.call do |result|
-      result.success!(data)
+    block_called = false
+    result = nil
+
+    context.call(:foo, :bar) do |callback|
+      block_called = true
+      callback.on :success do |args|
+        result = args
+      end
     end
-    assert result.success?
-    refute result.failure?
-    assert_equal :bar, result.data.foo
+
+    assert_equal true, block_called
+    assert_equal [ :foo, :bar ], result
   end
 
-  test "returns context result if failure" do
-    result = DummyContext.call do |result|
-      result.failure!(error, data)
+  test "ensure callback called" do
+    context = Class.new(TestContext) do
+      callbacks :success
+
+      def call
+      end
     end
-    assert result.failure?
-    refute result.success?
-    assert_same  error, result.error
-    assert_equal :bar, result.data.foo
+
+    e = assert_raises Neo::DCI::Context::NoCallbackCalled do
+      context.call do |callback|
+      end
+    end
+    assert_equal "No callback called. Available callbacks: success", e.message
   end
 
+  test "do not overwrite callbacks in subclasses" do
+    context1 = Class.new(TestContext) { callbacks :foo }
+    context2 = Class.new(TestContext) { callbacks :bar }
+
+    assert_equal [ :foo ], context1.callbacks
+    assert_equal [ :bar ], context2.callbacks
+  end
 end

data/test/helper.rb

@@ -1,12 +1,9 @@
 require 'simplecov' if ENV['COVERAGE']
 
 require 'minitest/autorun'
+require 'testem'
 
 require 'neo/dci'
 
-class NeoDCICase < MiniTest::Spec
-  class << self
-    alias :context :describe
-    alias :test :it
-  end
+class NeoDCICase < Testem
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neo-dci
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-06 00:00:00.000000000 Z
+date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -29,6 +29,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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
@@ -45,6 +61,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: testem
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -61,6 +93,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: 'on'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 description: Simple DCI
 email:
 - ps@neopoly.de
@@ -80,7 +128,6 @@ files:
 - 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/task_loader.rb
@@ -89,7 +136,6 @@ files:
 - lib/tasks/share/app/contexts/context.rb
 - lib/tasks/share/app/roles/role.rb
 - neo-dci.gemspec
-- test/context_result_test.rb
 - test/context_test.rb
 - test/helper.rb
 - test/role_test.rb
@@ -105,12 +151,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3362418473646590166
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3362418473646590166
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -118,8 +170,6 @@ 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
-has_rdoc: 

data/lib/neo/dci/context_result.rb

@@ -1,43 +0,0 @@
-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/test/context_result_test.rb

@@ -1,73 +0,0 @@
-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
-
-  test "returns data as hash" do
-    result.success!(data)
-    assert_equal data, result.data.to_hash
-  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 do
-        result.success!
-      end
-    end
-
-    test "with failure!" do
-      assert_raises ArgumentError do
-        result.failure!(error)
-      end
-    end
-  end
-end