neo-dci 0.3.0 → 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a0fd6e30874980cc150a48995e912165343d425fc24254e0f3f9b97e49fdf13
+  data.tar.gz: bfa3c369b56c93a5e4ecfc7c915e26f6c52655245e4d5ea979280e70279e4f71
+SHA512:
+  metadata.gz: f53b2c7652fa22003c46c002d2ebd2b717d4290294017c3c73cd85b6accf1a2abcb122c6c68b8c29508f1178209d1432f2b95a2b4c509ffcb5e93fa42bd3d1b2
+  data.tar.gz: 2aca570d841b0898e41e7138048abf5e9fc3a36c961d11ff3213db1db7dd580c147426967330f10e8faa88395132fa6b0b5fb38968f304657419127bbb38c2e7

data/.travis.yml

@@ -1,5 +1,30 @@
 language: ruby
+sudo: false
+cache: bundler
 rvm:
-  - 1.9.3
-  - jruby-19mode
-  - rbx-19mode
+  - ruby-head
+  - 2.7.0
+  - 2.6
+  - 2.5
+  - jruby
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: jruby
+    - rvm: jruby-head
+    - rvm: ruby-head
+env:
+  global:
+    - CODECLIMATE_REPO_TOKEN=70820b2c9137bc6411ae1a2e0c6861028c70ce373eec87ad46d9b7c14dce3401
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/556fa7e78f49c2f0016e
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: false     # default: false

data/README.md

@@ -1,11 +1,24 @@
-# Neo::DCI [![Build Status](https://secure.travis-ci.org/neopoly/neo-dci.png?branch=master)](http://travis-ci.org/neopoly/neo-dci)
+[github]: https://github.com/neopoly/neo-dci
+[doc]: http://rubydoc.info/github/neopoly/neo-dci/master/file/README.md
+[gem]: https://rubygems.org/gems/neo-dci
+[travis]: https://travis-ci.org/neopoly/neo-dci
+[codeclimate]: https://codeclimate.com/github/neopoly/neo-dci
+[inchpages]: https://inch-ci.org/github/neopoly/neo-dci
+
+# Neo::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)
+[![Travis](https://img.shields.io/travis/neopoly/neo-dci.svg?branch=master)][travis]
+[![Gem Version](https://img.shields.io/gem/v/neo-dci.svg)][gem]
+[![Code Climate](https://img.shields.io/codeclimate/github/neopoly/neo-dci.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/neopoly/neo-dci/badges/coverage.svg)][codeclimate]
+[![Inline docs](https://inch-ci.org/github/neopoly/neo-dci.svg?branch=master&style=flat)][inchpages]
+
+[Gem][gem] |
+[Source][github] |
+[Documentation][doc]
 
 ## Installation
 
@@ -95,8 +108,8 @@ end
 
 ## Contributing
 
-1. Fork it
+1. Fork it ( https://github.com/neopoly/neo-dci/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some 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
+5. Create a new Pull Request

data/lib/neo/dci.rb

@@ -1,7 +1,12 @@
+module Neo
+  module DCI
+  end
+end
+ 
 require 'neo/dci/version'
-
 require 'neo/dci/data'
 require 'neo/dci/role'
 require 'neo/dci/context'
+require 'neo/dci/context_result'
 
 require 'neo/dci/task_loader' if defined?(::Rails::Railtie)

data/lib/neo/dci/context.rb

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

data/lib/neo/dci/context_result.rb

@@ -0,0 +1,12 @@
+require 'on'
+
+module Neo
+  module DCI
+    # Result emitted by the Context.
+    class ContextResult < On
+      def called?
+        !!callback
+      end
+    end
+  end
+end

data/lib/neo/dci/version.rb

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

data/lib/ruby2_keywords.rb

@@ -0,0 +1,24 @@
+# A compatible delegation that works on Ruby 2.6, 2.7 and Ruby 3:
+#
+#    ruby2_keywords def foo(*args, &block)
+#      target(*args, &block)
+#    end
+#
+# Ruby <= 2.6 does not handle the new delegation style correctly, so the old-style delegation
+# must be used.
+#
+# `ruby2_keywords` allows you to run the old style even in Ruby 2.7 and 3.0.
+#
+# More informations:
+# https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/
+#
+# Discussion about adding `ruby2_keywords` semantics by default in 2.7.1:
+# https://bugs.ruby-lang.org/issues/16463
+#
+#
+# We need to remove this method if we no longer support Ruby versions < 2.7.
+#
+module Kernel
+  def ruby2_keywords(*)
+  end if RUBY_VERSION < "2.7"
+end

data/neo-dci.gemspec

@@ -15,10 +15,12 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Neo::DCI::VERSION
 
+  gem.add_runtime_dependency 'on', '~> 1.0.0'
+
   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'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.0'
 end

data/test/context_test.rb

@@ -1,4 +1,4 @@
-require 'helper'
+require "helper"
 
 class ContextTest < NeoDCICase
   class TestContext < Neo::DCI::Context
@@ -17,7 +17,7 @@ class ContextTest < NeoDCICase
     assert_raises NotImplementedError do
       Class.new(Neo::DCI::Context) do
         callbacks :foo
-      end.call {}
+      end.call { }
     end
   end
 
@@ -41,7 +41,7 @@ class ContextTest < NeoDCICase
     end
 
     assert_equal true, block_called
-    assert_equal [ :foo, :bar ], result
+    assert_equal [:foo, :bar], result
   end
 
   test "ensure callback called" do
@@ -63,7 +63,122 @@ class ContextTest < NeoDCICase
     context1 = Class.new(TestContext) { callbacks :foo }
     context2 = Class.new(TestContext) { callbacks :bar }
 
-    assert_equal [ :foo ], context1.callbacks
-    assert_equal [ :bar ], context2.callbacks
+    assert_equal [:foo], context1.callbacks
+    assert_equal [:bar], context2.callbacks
+  end
+
+  test "define own context result class" do
+    $success_callback_arg = nil
+
+    listener = Class.new do
+      def register_callbacks(result)
+        result.on :success do |arg|
+          $success_callback_arg = arg
+        end
+      end
+    end
+
+    context_result = Class.new(Neo::DCI::ContextResult) do
+      def register(listener)
+        listener.register_callbacks(self)
+      end
+    end
+
+    context = Class.new(TestContext) do
+      callbacks :success
+      result_class context_result
+
+      def call
+        callback.call :success, :ok
+      end
+    end
+
+    context.call do |my_result|
+      my_result.register listener.new
+    end
+
+    assert_equal :ok, $success_callback_arg
+  end
+
+  test "pass attributes and kwargs do context" do
+    context = Class.new(TestContext) do
+      callbacks :success
+
+      def initialize(attribute, kwarg:)
+        @attribute = attribute
+        @kwarg = kwarg
+      end
+
+      def call
+        callback.call :success, @attribute, @kwarg
+      end
+    end
+
+    context.call("attribute", kwarg: "kwarg") do |result|
+      result.on :success do |attr, kwarg|
+        assert_equal "attribute", attr
+        assert_equal "kwarg", kwarg
+      end
+    end
+  end
+
+  test "pass only attributes do context" do
+    context = Class.new(TestContext) do
+      callbacks :success
+
+      def initialize(attribute)
+        @attribute = attribute
+      end
+
+      def call
+        callback.call :success, @attribute
+      end
+    end
+
+    context.call("attribute") do |result|
+      result.on :success do |attr|
+        assert_equal "attribute", attr
+      end
+    end
+  end
+
+  test "pass hash as attribute do context" do
+    context = Class.new(TestContext) do
+      callbacks :success
+
+      def initialize(uid, attribute)
+        @attribute = attribute
+      end
+
+      def call
+        callback.call :success, @attribute
+      end
+    end
+
+    context.call("1", {}) do |result|
+      result.on :success do |attr|
+        assert_equal ({}), attr
+      end
+    end
+  end
+
+  test "pass only kwargs do context" do
+    context = Class.new(TestContext) do
+      callbacks :success
+
+      def initialize(kwarg:)
+        @kwarg = kwarg
+      end
+
+      def call
+        callback.call :success, @kwarg
+      end
+    end
+
+    context.call(kwarg: "kwarg") do |result|
+      result.on :success do |kwarg|
+        assert_equal "kwarg", kwarg
+      end
+    end
   end
 end

data/test/helper.rb

@@ -1,4 +1,5 @@
-require 'simplecov' if ENV['COVERAGE']
+require "simplecov"
+SimpleCov.start
 
 require 'minitest/autorun'
 require 'testem'

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neo-dci
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors:
 - Peter Suschlik
@@ -11,104 +10,106 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-29 00:00:00.000000000 Z
+date: 2020-06-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: 'on'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !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: 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
-    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: 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
-    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: 'on'
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 1.0.0
 description: Simple DCI
 email:
 - ps@neopoly.de
@@ -118,9 +119,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .simplecov
-- .travis.yml
+- ".gitignore"
+- ".simplecov"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -128,10 +129,12 @@ 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
 - lib/neo/dci/version.rb
+- lib/ruby2_keywords.rb
 - lib/tasks/neo-dci_tasks.rake
 - lib/tasks/share/app/contexts/context.rb
 - lib/tasks/share/app/roles/role.rb
@@ -141,33 +144,25 @@ files:
 - test/role_test.rb
 homepage: https://github.com/neopoly/neo-dci
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !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
+rubygems_version: 3.1.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Includes Data, Roles and Context.
 test_files:
 - test/context_test.rb