simple_interaction 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65e48aa19b408f562e5a17262322879d036211a0
-  data.tar.gz: 42dab38a13d25b5d4ba5b922ba50f85f894d4842
+  metadata.gz: f1373c9de32c59e77fa3bac5d1f86dd66a1b9c6b
+  data.tar.gz: 598115f757d7229015e79fa08b63b0a2b7f78d84
 SHA512:
-  metadata.gz: 4b80343bfcfe3049868417fdc769c9c31a9275ac309f93c8326c563a6bbf68fd6bb05212c660b418345d8e2a42d57eadbe5829e65e8cfe16ac2fcb6496d8283d
-  data.tar.gz: f928690ddc5094fb7dc8360c42e5cc8aca014ce1a39d07849b43c716bf924ae30d2266aaf41806806b511755673579fa0519d68c995baa1c50f0797035a75632
+  metadata.gz: 1f88bd9e54db5e2a541cf7aafcf7589054274b15088e86b818bbb3159ce23de201ab9d0979072d2ce7e6b059cb87c3099897529097e1111eb3ed73d568e37dc9
+  data.tar.gz: af454ff6d113e2b7d0d76f5195fc47fb4222fbbe026baf7d219f3106185b41549b6db629fdd6e2bcfc914d6159fe0863062447d0b1ca99d041f25ecf620418b2

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+bin/
 *.bundle
 *.so
 *.o

data/README.md

@@ -4,12 +4,22 @@ Interactions are meant to keep controllers and models or any other business logi
 Keep intention of class clear when using interactions, for example: 
 To create a user, a class should be name Users::Create.
 
+If you are using this in a Rails application you might want to use
+
+```ruby
+gem 'simple_interaction-rails, github: "boza/simple_interaction-rails"'
+```
+
+this comes with a generator so you don't have to create individual files :)
+
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'interaction'
+gem 'simple_interaction'
 ```
 
 And then execute:
@@ -18,13 +28,13 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install interaction
+    $ gem install simple_interaction
 
 ## Usage
 
 ```
 class Klass
-  include Interaction
+  include SimpleInteraction
 
   fail_with 'ErrorClass'
   requires :param1, :param2     

data/interaction.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = '~> 2.0'
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/simple_interaction/class_methods.rb

@@ -0,0 +1,60 @@
+module SimpleInteraction
+  module ClassMethods
+
+    attr_accessor :requirements
+
+    # required arguments to run interaction `requires :param`
+    def requires(*attrs)
+      set_requirements(attrs)
+    end
+
+    # interaction requirements
+    def requirements
+      @requirements ||= []
+    end
+    
+    # specifies the error class that will be raise if interaction is run with !
+    # if nothing is set InteractionError will be the default error class
+    def fail_with(klass)
+      @error_class = self.const_set(klass, Class.new(InteractionError))
+    end
+
+    def error_class
+      @error_class ||= 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 #{requirements}") unless requirements_met?
+      new(@options).tap do |interaction|
+        interaction.__send__(:run)
+      end
+    end
+
+    # runs interaction raises if any error or returns the interaction result
+    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 requirements.empty?
+      return false unless @options.kind_of?(Hash)
+      requirements.each do |accessor|
+        break false unless @options.has_key?(accessor)
+      end
+    end
+
+    def set_requirements(attrs)
+      attr_accessor *attrs
+      requirements.unshift(*attrs)
+    end
+
+  end  
+end

data/lib/simple_interaction/exceptions.rb

@@ -0,0 +1,12 @@
+module SimpleInteraction
+  
+  #main interaction error class
+  class InteractionError< StandardError;end
+
+  # this exception is raised when any arguments on `requires` method is missing
+  class RequirementsNotMet < InteractionError;end
+
+  # this exception will be raised if no run method is implemented on the interaction class
+  class NotImplemented < InteractionError;end
+
+end

data/lib/simple_interaction/instance_methods.rb

@@ -0,0 +1,33 @@
+module SimpleInteraction
+  module InstanceMethods
+
+    # error message if interaction was not successful
+    attr_accessor :error
+
+    # result of interaction, set when interaction was successful in otherwise is nil
+    attr_accessor :result
+
+    def success?
+      error.nil?
+    end
+
+    private
+
+    # sets the attr_accessor for each requirement of the intereaction
+    def initialize(**opts)
+      opts.select { |option, _| self.class.requirements.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
+      if success?
+        @result = interaction_run
+      end
+    end    
+
+  end
+end

data/lib/simple_interaction/version.rb

@@ -1,3 +1,3 @@
 module SimpleInteraction
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/simple_interaction.rb

@@ -1,8 +1,11 @@
 require "simple_interaction/version"
+require "simple_interaction/exceptions"
+require "simple_interaction/instance_methods"
+require "simple_interaction/class_methods"
 
 module SimpleInteraction
 
-  # = Interactions
+  # = Simple Interaction
   # 
   # Interactions are meant to keep controllers and models slim (YAY).
   # Keep intention of class clear when using interactions
@@ -29,94 +32,10 @@ module SimpleInteraction
   #   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

@@ -45,7 +45,8 @@ module SimpleInteraction
     end
 
     def test_success
-      assert Interactor.run(param: 'awesome interaction').success?, 'Interactor didn\'t finish successfuly' 
+      interaction = Interactor.run(param: 'awesome interaction')
+      assert interaction.success?, "Interactor didn't finish successfuly #{interaction.error}" 
     end
 
     def test_run_with_bang

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_interaction
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Jose Boza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-17 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,9 @@ files:
 - Rakefile
 - interaction.gemspec
 - lib/simple_interaction.rb
+- lib/simple_interaction/class_methods.rb
+- lib/simple_interaction/exceptions.rb
+- lib/simple_interaction/instance_methods.rb
 - lib/simple_interaction/version.rb
 - test/interaction_test.rb
 homepage: ''
@@ -64,9 +67,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="