simple_interaction 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 902b964d4821ea5d1e0857412061e40a895abb29
+  data.tar.gz: 3e5adefafafd26b0d589f95d7c7ac19254f05aa2
+SHA512:
+  metadata.gz: 1369a2a7d08fb56833109cb523b117fdc5a3ce9bb6bfd5da6394154fd21f1a95c4556fa7fa7a77523ece4e5327a99ef8d981c92d2bb1d2f239f9b80484d5ba58
+  data.tar.gz: 1886ddbf0a775163c6d2bf838f047515c9cef69819608dd7fa28374f8de19de18ec69013740935f5d6314f829a7470d811f31e00ecf058e48816d19e024887a3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in interaction.gemspec
+gemspec
+
+group :test do
+  # FIX: Our test suite isn't ready to run in random order yet
+  gem 'minitest', '< 5.3.4'
+
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jose Boza
+
+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,62 @@
+# Interaction
+
+Interactions are meant to keep controllers and models or any other business logic slim (YAY).
+Keep intention of class clear when using interactions, for example: 
+To create a user, a class should be name Users::Create.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'interaction'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install interaction
+
+## Usage
+
+```
+class Klass
+  include Interaction
+
+  fail_with 'ErrorClass'
+  requires :param1, :param2     
+
+  private
+  
+  def run
+    method
+  rescue => e
+    @error = e.message
+  end
+
+  def method
+    param1 / param2
+  end
+
+end
+
+interaction = Klass.run(param1: 2, param2: 1)
+interaction.success? #=> true
+interaction.error #=> nil
+interaction.result #=> 2
+
+Klass.run!(param1: 1, param2: 0) #=> raises Klass::ErrorClass
+Klass.run!(param1: 1, param2: 2) #=> 2
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/interaction/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+task default: :test
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << "test" # here is the test_helper
+  test.pattern = "test/**/*_test.rb"
+end

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/interaction.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interaction/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_interaction"
+  spec.version       = Interaction::VERSION
+  spec.authors       = ["Jose Boza"]
+  spec.email         = ["jaboza@gmail.com"]
+  spec.summary       = %q{Keep your code clean with simple interactions}
+  spec.description   = %q{}
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/interaction/version.rb

@@ -0,0 +1,3 @@
+module Interaction
+  VERSION = "0.0.1"
+end

data/lib/interaction.rb

@@ -0,0 +1,122 @@
+require "interaction/version"
+
+module Interaction
+
+  # = Interactions
+  # 
+  # Interactions are meant to keep controllers and models slim (YAY).
+  # Keep intention of class clear when using interactions
+  # for example to create a user a class should be name Users::Create.
+  # 
+  #
+  # example of usage:
+  #
+  #   class Klass
+  #     include Interaction
+  #          
+  #     requires :param1, :param2     
+  #
+  #     private
+  #     
+  #     def run
+  #       method
+  #     end
+  #
+  #     def method
+  #       param1 * param2
+  #     end
+  #
+  #   end
+  #
+  #  Klass.run(param1: param1, param2: param2)
+
+  class InteractionError< StandardError;end
+  class RequirementsNotMet < InteractionError;end
+  class NotImplemented < InteractionError;end
+
+  module ClassMethods
+
+    attr_accessor :accessors
+
+    def accessors
+      @accessors ||= []
+    end
+
+    def error_class
+      @error_class ||= InteractionError
+    end
+    
+    # class method to make sure parameters are required for the interaction to work.
+    def requires(*attrs)
+      set_accessors(attrs)
+    end
+
+    def fail_with(klass)
+      @error_class = self.const_set(klass, Class.new(InteractionError))
+    end
+
+    # checks if requirements are met from the requires params
+    # creates an instance of the interaction 
+    # calls run on the instance
+    def run(**options)
+      @options = options
+      fail RequirementsNotMet.new("#{self} requires the following parameters #{accessors}") unless requirements_met?
+      new(@options).__send__(:run)
+    end
+
+    def run!(**options)
+      interaction = run(options)
+      raise error_class.new(interaction.error) unless interaction.success?
+      interaction.result
+    end
+
+    private
+
+    def requirements_met?
+      return true if accessors.empty?
+      return false unless @options.kind_of?(Hash)
+      accessors.each do |accessor|
+        break false unless @options.has_key?(accessor)
+      end
+    end
+
+    def set_accessors(attrs)
+      attr_accessor *attrs
+      accessors.unshift(*attrs)
+    end
+
+  end
+  
+  module InstanceMethods
+
+    attr_accessor :error, :result, :error_class
+
+    def success?
+      error.nil?
+    end
+
+    private
+
+    # initializes instance and sets the instance variable for each attr_accessor from the required parameters
+    def initialize(**opts)
+
+      opts.select { |option, _| self.class.accessors.include?(option) }.each do |accessor, value|
+        __send__("#{accessor}=", value)
+      end
+    end
+
+    # run method should be overwritten on every class where interaction is included
+    def run
+      fail NotImplemented.new("`run` instance method must be implemented in class #{self.class}") unless defined?(super)
+      interaction_run = super
+      @result = interaction_run if success?
+      self
+    end    
+
+  end
+  
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+    receiver.send :prepend, InstanceMethods
+  end
+end

data/test/interaction_test.rb

@@ -0,0 +1,73 @@
+require 'minitest/autorun'
+require 'interaction'
+
+class Interactor
+  include Interaction
+
+  fail_with 'InteractorExp'
+
+  requires :param
+
+  def run
+    @error = "only strings please" if param =~ /\d{1,}/
+    "This is the result for #{param}"
+  end
+
+end
+
+class InteractorNotImplemented
+  include Interaction
+end
+
+module Interaction
+  class InteractionTest < ::Minitest::Test
+
+    def test_private_run
+      assert Interactor.private_method_defined?(:run), 'instance method run should be private'
+    end
+
+    def test_error_class
+      assert_equal Interactor::InteractorExp, Interactor.error_class
+    end
+
+    def test_error_class_not_defined
+      assert_equal Interaction::InteractionError, InteractorNotImplemented.error_class
+    end
+
+    def test_should_require_params
+      assert_raises RequirementsNotMet do
+        Interactor.run
+      end
+    end
+
+    def test_result
+      assert_equal "This is the result for awesome interaction", Interactor.run(param: 'awesome interaction').result
+    end
+
+    def test_success
+      assert Interactor.run(param: 'awesome interaction').success?, 'Interactor didn\'t finish successfuly' 
+    end
+
+    def test_run_with_bang
+      assert_equal "This is the result for awesome interaction", Interactor.run!(param: 'awesome interaction')
+    end
+
+    def test_error
+      interaction = Interactor.run(param: '1')
+      refute interaction.success?, 'Interactor didn\'t finish with an error' 
+      assert_match interaction.error, "only strings please"
+    end
+
+    def test_error_with_bang
+      exception = assert_raises(Interactor::InteractorExp) { Interactor.run!(param: '1') }
+      assert_equal "only strings please", exception.message
+    end
+
+    def test_not_implemented
+       assert_raises(Interaction::NotImplemented) { InteractorNotImplemented.run(param: '1') }
+    end
+
+  end  
+end
+
+

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: simple_interaction
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jose Boza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: ''
+email:
+- jaboza@gmail.com
+executables:
+- rake
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rake
+- interaction.gemspec
+- lib/interaction.rb
+- lib/interaction/version.rb
+- test/interaction_test.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.2
+signing_key: 
+specification_version: 4
+summary: Keep your code clean with simple interactions
+test_files:
+- test/interaction_test.rb