cooperator 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92514ccba0d6cd8eba54cfb1ed6b674da68b0e1d
-  data.tar.gz: 5e36f0a442b5e6e67e452994a2dbadb9388ca542
+  metadata.gz: 3d6944ab9d458de00ea6f81e9b1f213dd7ad56f7
+  data.tar.gz: 7d1f04792af4096867c25e8bf64211655db50955
 SHA512:
-  metadata.gz: 9ec7b8b5db064b39a54ee47dee4751c586f7592ba6d14abd23f2294219bd85aa31f5744af01a9c616addabc4e3a7ac06db6299e794ac3d315c671042054ecbb0
-  data.tar.gz: 41e688708acd72c321679e3c509f0f8c0067ce9d0b94be2359289c016d4412594378725e2ca52e9935465897fadce5b635500c10981cb72b072dab2f857ab327
+  metadata.gz: 53bffa767b3a518725020964b50036b17ad847ef1947f9681c9582f8edc286fd615700e02c4fd044cd78ac412f2db74c76b897036e495cf377f0e969fbee69ac
+  data.tar.gz: 2ed544a93ca8b55abfc04000c1041a2d882e8a17ae727f89ad2ee8707ad3fd95c0647ec676d3deecc54ff21874a49f6d66e07cdf96ab004ec8c47faec0553717

data/README.md

@@ -1,4 +1,4 @@
-[![Code Climate](https://codeclimate.com/github/Erol/cooperator.png)](https://codeclimate.com/github/Erol/cooperator)
+[![Code Climate Score](http://img.shields.io/codeclimate/github/Erol/cooperator.svg?style=flat)](https://codeclimate.com/github/Erol/cooperator)
 
 # Cooperator
 

data/lib/cooperator/version.rb

@@ -1,3 +1,3 @@
 module Cooperator
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/cooperator.rb

@@ -3,13 +3,63 @@ require 'cooperator/context'
 
 module Cooperator
   module ClassMethods
+    def expected
+      @_expected ||= []
+    end
+
+    def accepted
+      @_accepted ||= []
+    end
+
+    def committed
+      @_committed ||= []
+    end
+
+    def expects(*properties)
+      properties.each do |property|
+        define_method property do
+          context.send property
+        end
+
+        expected << property
+      end
+    end
+
+    def accepts(*properties)
+      properties.each do |property|
+        define_method property do
+          if context.include? property
+            context.send property
+          else
+            nil
+          end
+        end
+
+        accepted << property
+      end
+    end
+
+    def commits(*properties)
+      properties.each do |property|
+        committed << property
+      end
+    end
+
     def perform(context = {})
+      expected.each do |property|
+        raise Exception, "missing expected property: #{expect}" unless context.include? expect
+      end
+
       action = new context
 
       catch :_finish do
         action.perform
       end
 
+      committed.each do |property|
+        raise Exception, "missing committed property: #{expect}" unless context.include? expect
+      end
+
       action.context
     end
   end
@@ -45,14 +95,20 @@ module Cooperator
     throw :_finish
   end
 
+  def success?
+    context.success?
+  end
+
   def failure!(messages = {})
     context.failure! messages
     throw :_finish
   end
 
-  def method_missing(method, *args, &block)
-    return context.send method, *args, &block if context.respond_to? method
+  def failure?
+    context.failure?
+  end
 
-    super
+  def include?(property)
+    context.include?(property)
   end
 end

data/spec/failure.rb

@@ -10,6 +10,14 @@ class Failure
   end
 end
 
+class FailureWithErrors
+  prepend Cooperator
+
+  def perform
+    failure! action: 'Failure!'
+  end
+end
+
 prepare do
   $before = false
   $after = false
@@ -30,3 +38,9 @@ spec '.perform returns a failure context' do
   assert context, :failure?
   refute context, :success?
 end
+
+spec '.perform returns a failure with errors context' do
+  context = FailureWithErrors.perform
+
+  assert context.errors, :==, action: ['Failure!']
+end

data/spec/perform.rb

@@ -0,0 +1,22 @@
+require 'cooperator'
+
+class Interactor
+  prepend Cooperator
+
+  expects :input
+  commits :output
+end
+
+scope '.perform' do
+  spec 'raises an exception when an expected input is missing' do
+    raises Exception do
+      Interactor.perform
+    end
+  end
+
+  spec 'raises an exception when a committed output is missing' do
+    raises Exception do
+      Interactor.perform
+    end
+  end
+end

data/spec/{cooperator.rb → predicates.rb}

@@ -39,18 +39,3 @@ spec '#include? delegates to context.include?' do
 
   assert interactor, :include?, :name
 end
-
-spec 'delegate to the current context' do
-  interactor = Interactor.new name: 'Apple'
-
-  assert interactor.name, :==, 'Apple'
-end
-
-spec '#failure! accepts an error key and message' do
-  context = Cooperator::Context.new
-  interactor = Interactor.new context
-
-  interactor.failure! action: 'Failure!'
-
-  assert context.errors, :==, action: ['Failure!']
-end

data/spec/properties.rb

@@ -0,0 +1,58 @@
+require 'cooperator'
+
+class Interactor
+  prepend Cooperator
+
+  expects :apple, :banana
+  accepts :coconut, :durian
+
+  commits :fig
+
+  def perform
+    value = apple
+    value = banana
+    value = coconut
+    value = durian
+  end
+end
+
+scope '.expects' do
+  spec 'adds given properties as expected/required input' do
+    assert Interactor.expected, :include?, :apple
+    assert Interactor.expected, :include?, :banana
+  end
+
+  spec 'delegate given properties to the current context' do
+    interactor = Interactor.new apple: 'Apple', banana: 'Banana'
+
+    assert interactor.apple, :==, 'Apple'
+    assert interactor.banana, :==, 'Banana'
+  end
+end
+
+scope '.accepts' do
+  spec 'adds given properties as accepted/optional input' do
+    assert Interactor.accepted, :include?, :coconut
+    assert Interactor.accepted, :include?, :durian
+  end
+
+  spec 'delegate given properties to the current context' do
+    interactor = Interactor.new coconut: 'Coconut', durian: 'Durian'
+
+    assert interactor.coconut, :==, 'Coconut'
+    assert interactor.durian, :==, 'Durian'
+  end
+
+  spec 'return nil for properties not included in the current context' do
+    interactor = Interactor.new
+
+    assert interactor.coconut, :==, nil
+    assert interactor.durian, :==, nil
+  end
+end
+
+scope '.commits' do
+  spec 'adds given properties as committed/required output' do
+    assert Interactor.committed, :include?, :fig
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cooperator
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Erol Fornoles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-11 00:00:00.000000000 Z
+date: 2014-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,8 +56,10 @@ files:
 - lib/cooperator/version.rb
 - spec/context.rb
 - spec/cooperate.rb
-- spec/cooperator.rb
 - spec/failure.rb
+- spec/perform.rb
+- spec/predicates.rb
+- spec/properties.rb
 - spec/success.rb
 homepage: ''
 licenses:
@@ -86,6 +88,8 @@ summary: Simple cooperative interactors for Ruby
 test_files:
 - spec/context.rb
 - spec/cooperate.rb
-- spec/cooperator.rb
 - spec/failure.rb
+- spec/perform.rb
+- spec/predicates.rb
+- spec/properties.rb
 - spec/success.rb