cooperator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6671fcd41b0cea041ba1f0191cd5760d1cf2bab3
+  data.tar.gz: 9beb667615a70908cecba636f6ae3b0a80d9d119
+SHA512:
+  metadata.gz: e2779ddbd074fc07515eeb3ec9494f2367463627748826df8a71747eacb1dcd96c12e5e253ba94cb7d77ba79f43cfca38619af734c60b317fbf3d40c1db18fd3
+  data.tar.gz: fcc74dba7a8c3e156ffd3095a8c521b41fb22c26a42bba8054dd0e38f393b130d9bb9c1a195b452d643bb726610777b1b46b97d661da08735dbf9f4bf6236e8a

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.gs
+.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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cooperator.gemspec
+gemspec
+
+gem 'specter', github: 'Erol/specter', branch: 'master'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Erol Fornoles
+
+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,37 @@
+[![Code Climate](https://codeclimate.com/github/Erol/cooperator.png)](https://codeclimate.com/github/Erol/cooperator)
+
+# Cooperator
+
+Simple cooperative interactors for Ruby
+
+Inspired by the following:
+
+* [LightService](https://github.com/adomokos/light-service) by [Atilla Domokos](https://github.com/adomokos)
+* [Interactor](https://github.com/collectiveidea/interactor) from [Collective Idea](https://github.com/collectiveidea)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cooperator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cooperator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch ( `git checkout -b my-new-feature` )
+3. Create tests and make them pass ( `rake test` )
+4. Commit your changes ( `git commit -am 'Added some feature'` )
+5. Push to the branch ( `git push origin my-new-feature` )
+6. Create a new Pull Request

data/Rakefile

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

data/cooperator.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cooperator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cooperator'
+  spec.version       = Cooperator::VERSION
+  spec.authors       = ['Erol Fornoles']
+  spec.email         = ['erol.fornoles@gmail.com']
+  spec.summary       = %q{Simple cooperative interactors for Ruby}
+  spec.description   = %q{Simple cooperative interactors for Ruby}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', "~> 1.5"
+  spec.add_development_dependency 'rake'
+end

data/lib/cooperator/context.rb

@@ -0,0 +1,57 @@
+module Cooperator
+  class Context
+    def initialize(attributes = {})
+      @_attributes = {_failure: false}
+
+      attributes.each do |k, v|
+        send :"#{k}=", v
+      end
+    end
+
+    def errors
+      @_errors ||= []
+    end
+
+    def success!
+      self._failure = false
+    end
+
+    def failure!(*args)
+      args.each do |error|
+        errors.push error
+      end
+
+      self._failure = true
+    end
+
+    def success?
+      not failure?
+    end
+
+    def failure?
+      _failure
+    end
+
+    def include?(key)
+      @_attributes.include? key
+    end
+
+    def method_missing(method, *args, &block)
+      return @_attributes.fetch method if @_attributes.include? method
+
+      name = String method
+
+      if name.include? '='
+        name.gsub!(/=/, '')
+
+        @_attributes[:"#{name}"] = args.shift
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, private = false)
+      @_attributes.include?(method) || super
+    end
+  end
+end

data/lib/cooperator/version.rb

@@ -0,0 +1,3 @@
+module Cooperator
+  VERSION = '0.1.0'
+end

data/lib/cooperator.rb

@@ -0,0 +1,58 @@
+require 'cooperator/version'
+require 'cooperator/context'
+
+module Cooperator
+  module ClassMethods
+    def perform(context = {})
+      action = new context
+
+      catch :_finish do
+        action.perform
+      end
+
+      action.context
+    end
+  end
+
+  def context
+    @_context
+  end
+
+  def initialize(context = Context.new)
+    @_context = if context.is_a? Context
+                  context
+                else
+                  Context.new context
+                end
+  end
+
+  def cooperate(*actions)
+    actions.each do |action|
+      action.perform context
+
+      break if context.failure?
+    end
+  end
+
+  def self.prepended(base)
+    base.extend ClassMethods
+  end
+
+  private
+
+  def success!
+    context.success!
+    throw :_finish
+  end
+
+  def failure!
+    context.failure!
+    throw :_finish
+  end
+
+  def method_missing(method, *args, &block)
+    return context.send method, *args, &block if context.respond_to? method
+
+    super
+  end
+end

data/spec/context.rb

@@ -0,0 +1,57 @@
+require 'cooperator'
+
+subject Cooperator::Context
+
+spec 'dynamic setter and getter' do
+  context = Cooperator::Context.new
+  context.name = 'Apple'
+
+  assert context.name, :==, 'Apple'
+end
+
+spec '.new accepts a hash' do
+  context = Cooperator::Context.new name: 'Apple'
+
+  assert context.name, :==, 'Apple'
+end
+
+spec '#errors is an array' do
+  context = Cooperator::Context.new
+  
+  assert context.errors, :is_a?, Array
+end
+
+spec '#success! marks the context as a success' do
+  context = Cooperator::Context.new
+  context.success!
+
+  assert context, :success?
+  refute context, :failure?
+end
+
+spec '#failure! marks the context as a failure' do
+  context = Cooperator::Context.new
+  context.failure!
+
+  assert context, :failure?
+  refute context, :success?
+end
+
+spec '#failure! accepts an error message' do
+  context = Cooperator::Context.new
+  context.failure! 'Failure!'
+
+  assert context.errors, :include?, 'Failure!'
+end
+
+spec '#include? returns true for an existing attribute' do
+  context = Cooperator::Context.new name: 'Apple'
+
+  assert context, :include?, :name
+end
+
+spec '#include? returns false for a non-existing attribute' do
+  context = Cooperator::Context.new
+
+  refute context, :include?, :name
+end

data/spec/cooperate.rb

@@ -0,0 +1,77 @@
+require 'cooperator'
+
+class First
+  prepend Cooperator
+
+  def perform
+    context.first = 'first'
+  end
+end
+
+class Second
+  prepend Cooperator
+
+  def perform
+    context.second = 'second'
+  end
+end
+
+class Third
+  prepend Cooperator
+
+  def perform
+    context.third = 'third'
+    failure!
+  end
+end
+
+class Fourth
+  prepend Cooperator
+
+  def perform
+    context.fourth = 'fourth'
+  end
+end
+
+class Success
+  prepend Cooperator
+
+  def perform
+    cooperate First,
+              Second
+  end
+end
+
+class Failure
+  prepend Cooperator
+
+  def perform
+    cooperate First,
+              Second,
+              Third,
+              Fourth
+  end
+end
+
+subject Cooperator
+
+scope 'no failure' do
+  spec '#cooperate performs the given actions' do
+    context = Success.perform
+
+    assert context.first, :==, 'first'
+    assert context.second, :==, 'second'
+  end
+end
+
+scope 'has failure' do
+  spec '#cooperate performs the given actions until a failure is met' do
+    context = Failure.perform
+
+    assert context.first, :==, 'first'
+    assert context.second, :==, 'second'
+    assert context.third, :==, 'third'
+    refute context, :include?, :fourth
+  end
+end
+

data/spec/cooperator.rb

@@ -0,0 +1,47 @@
+require 'cooperator'
+
+class Interactor
+  prepend Cooperator
+end
+
+subject Cooperator
+
+spec '#success? delegates to context.success?' do
+  interactor = Interactor.new
+
+  interactor.context.success!
+
+  assert interactor, :success?
+
+  interactor.context.failure!
+
+  refute interactor, :success?
+end
+
+spec '#failure? delegates to context.failure?' do
+  interactor = Interactor.new
+
+  interactor.context.failure!
+
+  assert interactor, :failure?
+
+  interactor.context.success!
+
+  refute interactor, :failure?
+end
+
+spec '#include? delegates to context.include?' do
+  interactor = Interactor.new
+
+  refute interactor, :include?, :name
+
+  interactor.context.name = 'Apple'
+
+  assert interactor, :include?, :name
+end
+
+spec 'delegate to the current context' do
+  interactor = Interactor.new name: 'Apple'
+
+  assert interactor.name, :==, 'Apple'
+end

data/spec/failure.rb

@@ -0,0 +1,32 @@
+require 'cooperator'
+
+class Failure
+  prepend Cooperator
+
+  def perform
+    $before = true
+    failure!
+    $after = true
+  end
+end
+
+prepare do
+  $before = false
+  $after = false
+end
+
+subject Cooperator
+
+spec '.perform runs until #failure! is called' do
+  Failure.perform
+
+  assert $before
+  refute $after
+end
+
+spec '.perform returns a failure context' do
+  context = Failure.perform
+
+  assert context, :failure?
+  refute context, :success?
+end

data/spec/success.rb

@@ -0,0 +1,59 @@
+require 'cooperator'
+
+class ImplicitSuccess
+  prepend Cooperator
+
+  def perform
+    $before = true
+    $after = true
+  end
+end
+
+class ExplicitSuccess
+  prepend Cooperator
+
+  def perform
+    $before = true
+    success!
+    $after = true
+  end
+end
+
+prepare do
+  $before = false
+  $after = false
+end
+
+subject Cooperator
+
+scope 'implicit success' do
+  spec '.perform runs until #success! is called' do
+    ImplicitSuccess.perform
+
+    assert $before
+    assert $after
+  end
+
+  spec '.perform returns a success context' do
+    context = ImplicitSuccess.perform
+
+    assert context, :success?
+    refute context, :failure?
+  end
+end
+
+scope 'explicit success' do
+  spec '.perform runs until #success! is called' do
+    ExplicitSuccess.perform
+
+    assert $before
+    refute $after
+  end
+
+  spec '.perform returns a success context' do
+    context = ExplicitSuccess.perform
+
+    assert context, :success?
+    refute context, :failure?
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: cooperator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erol Fornoles
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple cooperative interactors for Ruby
+email:
+- erol.fornoles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cooperator.gemspec
+- lib/cooperator.rb
+- lib/cooperator/context.rb
+- lib/cooperator/version.rb
+- spec/context.rb
+- spec/cooperate.rb
+- spec/cooperator.rb
+- spec/failure.rb
+- spec/success.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Simple cooperative interactors for Ruby
+test_files:
+- spec/context.rb
+- spec/cooperate.rb
+- spec/cooperator.rb
+- spec/failure.rb
+- spec/success.rb