interactor-copy_context 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79f620e40edaf5d49a865cbb33b4c17122ac54d6
+  data.tar.gz: a3229c54f831ecf7a4dbed367fb341dcbb1d035e
+SHA512:
+  metadata.gz: 78bb812e0a1d2fc348f53c7ba7a2c0a2d3bb60753f534788911d8a4602e4baa18c593f16fa1f86a0cfeb1a539b39e800d782eaf832adcb77a28431a1ea9cd8be
+  data.tar.gz: ac551502fb93eca7b42b1765580f7668af02e923d56090f99c3eec79dc031c611e2c9ead2d6908b96ab4694a1d882dfbfe2e2965302e5842717cdd2952e87072

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in interactor-copy_context.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Fire-Dragon-DoL
+
+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,77 @@
+# Interactor CopyContext
+
+This gem allows you to easily extend [interactor](https://github.com/collectiveidea/interactor) so that in
+Ruby on Rails you can eventually copy the `context` on your controller as `@instace_variables`, accessing them
+easily. Here is an example:
+
+```ruby
+class MakeCake
+  include Interactor
+  
+  def perform
+    # dosomething
+  end
+end
+
+class CakesController < ApplicationController
+  
+  def create
+    MakeCake.perform_on(self, ingredients: [:egg, :milk, :something])
+    
+    render text: @ingredients.first.to_s # => "egg"
+  end
+  
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'interactor-copy_context', '~> 0.0.1'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install interactor-copy_context
+```
+
+## Usage
+
+Usage is very simple, use the method `perform_on` which is just a wrapper for `perform` (accepts same params).
+The only important thing is **first parameter is the object which you want to inject context into**. So for
+example, `self` in a controller is the controller itself, very helpful because data is ready for your views in
+that case. The method is available both on Interactor and organizer and on instance and class too.
+
+```ruby
+DummyInteractor.perform_on(self, dummy1: 'blah')
+DummyInteractor.new(dummy1: 'blah').perform_on(self)
+```
+
+Both methods inject same context, so they are equivalent. Same for organizer methods (they behave like
+interactors):
+
+```ruby
+DummyOrganizer.perform_on(self)
+DummyOrganizer.new.perform_on(self)
+```
+
+## About performance
+It's a copy of an entire hash (not a deep copy, only pointers). I don't think context will ever grow over 100
+elements, so it should be fine.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/interactor-copy_context/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,2 @@
+require "bundler/gem_tasks"
+

data/interactor-copy_context.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interactor/copy_context/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "interactor-copy_context"
+  spec.version       = Interactor::CopyContext::VERSION
+  spec.authors       = ["Fire-Dragon-DoL"]
+  spec.email         = ["francesco.belladonna@gmail.com"]
+  spec.summary       = %q{Copy interactor context on specified object's instance variables}
+  spec.description   = %q{Copy interactor context on specified object's instance variables to allow easier interaction with returned values}
+  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.6"
+  spec.add_development_dependency "rspec",   "~> 2.14.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "interactor", "~> 2.1"
+end

data/lib/interactor/copy_context/version.rb

@@ -0,0 +1,5 @@
+module Interactor
+  module CopyContext
+    VERSION = "0.0.1"
+  end
+end

data/lib/interactor/copy_context.rb

@@ -0,0 +1,3 @@
+require 'interactor/copy_context/version'
+require 'interactor/ext/interactor'
+require 'interactor/ext/interactor/organizer'

data/lib/interactor/ext/interactor.rb

@@ -0,0 +1,24 @@
+module Interactor
+
+  module ClassMethods
+
+    def perform_on(obj, *arguments)
+      perform(*arguments).tap do |instance|
+        instance.context.each do |key, value|
+          obj.send(:instance_variable_set, :"@#{ key }", value)
+        end
+      end
+    end
+
+  end
+
+  # InstanceMethods
+
+  def perform_on(obj)
+    perform
+    context.each do |key, value|
+      obj.send(:instance_variable_set, :"@#{ key }", value)
+    end
+  end
+
+end

data/spec/features/interactor_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe DummyInteractor do
+  let(:dummy1) { 'testmedummy' }
+  let(:dummy_object) do
+    Class.new do
+      attr_accessor :dummy1
+    end.new
+  end
+
+  it { expect(DummyInteractor).to respond_to(:perform_on) }
+  it { should respond_to(:perform_on) }
+
+  it "sets @dummy1 on dummy_object" do
+    DummyInteractor.perform_on(dummy_object, dummy1: dummy1)
+    
+    expect(dummy_object.dummy1).to eq dummy1
+  end
+
+  context "when called on instance" do
+
+    it "sets @dummy1 on dummy_object" do
+      interactor = DummyInteractor.new(dummy1: dummy1)
+      interactor.perform_on(dummy_object)
+      
+      expect(dummy_object.dummy1).to eq dummy1
+    end
+
+  end
+
+end

data/spec/features/organizer_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe DummyOrganizer do
+  let(:dummy1) { Dummy1Interactor::DUMMYVAR }
+  let(:dummy2) { Dummy2Interactor::DUMMYVAR }
+  let(:dummy_object) do
+    Class.new do
+      attr_accessor :dummy1
+      attr_accessor :dummy2
+    end.new
+  end
+
+  it { expect(DummyOrganizer).to respond_to(:perform_on) }
+  it { should respond_to(:perform_on) }
+
+  it "sets @dummy1 on dummy_object" do
+    DummyOrganizer.perform_on(dummy_object)
+    
+    expect(dummy_object.dummy1).to eq dummy1
+  end
+
+  it "sets @dummy2 on dummy_object" do
+    DummyOrganizer.perform_on(dummy_object)
+    
+    expect(dummy_object.dummy2).to eq dummy2
+  end
+
+  context "when called on instance" do
+
+    it "sets @dummy1 on dummy_object" do
+      interactor = DummyOrganizer.new
+      interactor.perform_on(dummy_object)
+      
+      expect(dummy_object.dummy1).to eq dummy1
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'interactor'
+require 'interactor/copy_context'
+
+support_path = Pathname.new(File.expand_path('..', __FILE__))
+support_path = support_path.join('support', '**', '*.rb')
+Dir[support_path].each { |f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.filter_run_excluding broken: true
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/dummy_interactor.rb

@@ -0,0 +1,12 @@
+class DummyInteractor
+  include Interactor
+
+  def perform
+    if context[:should_fail]
+      context.fail!
+    else
+      context[:custom_var_1] = 'testme'
+    end
+  end
+  
+end

data/spec/support/dummy_organizer.rb

@@ -0,0 +1,35 @@
+class Dummy1Interactor
+  include Interactor
+
+  DUMMYVAR = 'testmedummy1'
+
+  def perform
+    if context[:should_fail]
+      context.fail!
+    else
+      context[:dummy1] = DUMMYVAR
+    end
+  end
+
+end
+
+class Dummy2Interactor
+  include Interactor
+
+  DUMMYVAR = 'testmedummy2'
+
+  def perform
+    if context[:should_fail]
+      context.fail!
+    else
+      context[:dummy2] = DUMMYVAR
+    end
+  end
+
+end
+
+class DummyOrganizer
+  include Interactor::Organizer
+
+  organize Dummy1Interactor, Dummy2Interactor  
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: interactor-copy_context
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Fire-Dragon-DoL
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: interactor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Copy interactor context on specified object's instance variables to allow
+  easier interaction with returned values
+email:
+- francesco.belladonna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- interactor-copy_context.gemspec
+- lib/interactor/copy_context.rb
+- lib/interactor/copy_context/version.rb
+- lib/interactor/ext/interactor.rb
+- spec/features/interactor_spec.rb
+- spec/features/organizer_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_interactor.rb
+- spec/support/dummy_organizer.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: Copy interactor context on specified object's instance variables
+test_files:
+- spec/features/interactor_spec.rb
+- spec/features/organizer_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_interactor.rb
+- spec/support/dummy_organizer.rb