subroutine-factory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 26e7af94d4befaec49de002e7460572005754d21
+  data.tar.gz: b5b1b80adc2b9c37bb82cccf7787775b7fd449fc
+SHA512:
+  metadata.gz: 6fe24be9bab1509b6b69d3f196e5ab4b600715972bf3c8cbcb7bcf174fa937976cb32eb1e6366c2f57d24b3e333489e50a568268b6a7997571f878c417209dd7
+  data.tar.gz: a0eee2e1db2c9a1e4d044f0e1b1739cfc5152327fa96dbbc766da5c8a90f95ec22905e7b6d9a8b6f12802aaa25c7a7c0c0fa36fb2a4c5a3c69870174fb4ea4a4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+
+rvm:
+  - 2.1.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mike Nelson
+
+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,84 @@
+# Subroutine::Factory
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'subroutine-factory'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install subroutine-factory
+
+## Usage
+
+The Subroutine gem does a great job of encapsulating your app's business logic. To simplify the usage of Subroutine Ops in your test suite, utilize the subroutine-factory gem.
+
+Defining factories:
+
+```ruby
+Subroutine::Factory.define :signup do
+  op ::SignupOp
+
+  inputs :email, sequence{|n| "foo{n}@example.com" }
+  inputs :password, "password123"
+
+  # by default, the op will be returned when the factory is used.
+  # this `output` returns the value of the accessor on the resulting op
+  output :user
+end
+
+Subroutine::Factory.define :business_signup do
+
+  # all configurations are inherited from the "signup" factory
+  parent :signup
+
+  op ::BusinessSignupOp
+
+  input :business_name, sequence{|n| "Business #{n}" }
+
+  # you can output multiple things into a hash by using `outputs`
+  outputs :user, :business
+end
+```
+
+Using Factories:
+
+```ruby
+user = Subroutine::Factory.create :signup
+user = Subroutine::Factory.create :signup, email: "foo@bar.com"
+
+out = Subroutine::Factory.create :business_signup
+out[:user] #=> User{}
+out[:business] #=> Business{}
+```
+
+Spec / Test Helper:
+```ruby
+#spec_helper.rb, test_helper.rb
+config.include ::Subroutine::Factory::SpecHelper
+
+# in your tests
+user = factory(:signup)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mnelson/subroutine-factory.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "subroutine/factory"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/subroutine/factory/builder.rb

@@ -0,0 +1,66 @@
+require 'active_support/inflector/methods'
+
+module Subroutine
+  module Factory
+    class Builder
+
+      def initialize(config, *args)
+        @config = config
+        @options = config.options
+        @args = args
+      end
+
+      def execute!
+        op = op_class.new(*input_args)
+        Array(@options[:befores]).each{|block| block.call(op) }
+        op.submit!
+        output = extract_output(op)
+        Array(@options[:afters]).each{|block| block.call(op, output) }
+        output
+      end
+
+      protected
+
+      def op_class
+        klass = @options[:op].constantize
+      end
+
+      def input_args
+        args = @args.dup
+        overrides = args.extract_options!
+        inputs = build_inputs(overrides)
+
+        args.push(inputs)
+        args
+      end
+
+      def build_inputs(overrides)
+        out = {}
+        @options[:inputs].each_pair do |k,v|
+          if overrides.has_key?(k)
+            out[k] = overrides[k]
+          else
+            out[k] = v.respond_to?(:call) ? v.call : v
+          end
+        end
+
+        out
+      end
+
+      def extract_output(op)
+        if @options[:output]
+          return op.send(@options[:output])
+        elsif @options[:outputs]
+          if @options[:outputs].length == 1 && @options[:outputs][0].is_a?(Array)
+            @options[:outputs][0].map{|output| op.send(output) }
+          else
+            @options[:outputs].inject({}){|out, output| out[output] = op.send(output); out }
+          end
+        else
+          op
+        end
+      end
+
+    end
+  end
+end

data/lib/subroutine/factory/config.rb

@@ -0,0 +1,83 @@
+require 'active_support/core_ext/hash/deep_merge'
+
+module Subroutine
+  module Factory
+    class Config
+
+      delegate :sequence, to: "::Subroutine::Factory"
+
+      attr_reader :options
+
+      def initialize(options)
+        @options = options || {}
+
+        parent(@options.delete(:parent)) if @options[:parent]
+
+        sanitize!
+      end
+
+      def parent(parent)
+        inherit_from(parent)
+      end
+
+      def validate!
+        raise "Missing op configuration" unless @options[:op]
+      end
+
+      def op(op_class)
+        @options[:op] = case op_class
+        when String
+          op_class
+        when Class
+          op_class.name
+        else
+          op_class.to_s
+        end
+      end
+
+      def before(&block)
+        @options[:befores].push(block)
+      end
+
+      def after(&block)
+        @options[:afters].push(block)
+      end
+
+      def input(name, value)
+        @options[:inputs][name.to_sym] = value
+      end
+
+      def output(name)
+        @options.delete(:outputs)
+        @options[:output] = name
+      end
+
+      def outputs(*names)
+        @options.delete(:output)
+        @options[:outputs] = names
+      end
+
+      protected
+
+      def inherit_from(parent)
+        parent = ::Subroutine::Factory.get_config!(parent) unless parent.is_a?(::Subroutine::Factory::Config)
+        @options.deep_merge!(parent.options)
+        sanitize!
+      end
+
+      def sanitize!
+        op(@options[:op]) if @options[:op]
+
+        @options[:inputs] ||= {}
+        @options[:inputs].each_pair(&method(:input))
+
+        outputs(*@options[:outputs]) if @options[:outputs]
+        output(@options[:output]) if @options[:output]
+
+        @options[:befores] = @options[:befores].dup if @options[:befores]
+        @options[:afters] = @options[:afters].dup if @options[:afters]
+      end
+
+    end
+  end
+end

data/lib/subroutine/factory/spec_helper.rb

@@ -0,0 +1,13 @@
+module Subroutine
+  module Factory
+    module SpecHelper
+      def factory(*args)
+        ::Subroutine::Factory.create(*args)
+      end
+
+      def factory!(*args)
+        factory(*args)
+      end
+    end
+  end
+end

data/lib/subroutine/factory/version.rb

@@ -0,0 +1,5 @@
+module Subroutine
+  module Factory
+    VERSION = "0.1.0"
+  end
+end

data/lib/subroutine/factory.rb

@@ -0,0 +1,53 @@
+require 'subroutine'
+require "subroutine/factory/version"
+require "subroutine/factory/config"
+require "subroutine/factory/builder"
+require "subroutine/factory/spec_helper"
+
+module Subroutine
+  module Factory
+
+    @@configs = {}
+    @@sequence = 1
+
+    def self.configs
+      @@configs
+    end
+
+    def self.define(name, options = {}, &block)
+      config = ::Subroutine::Factory::Config.new(options)
+      @@configs[name.to_sym] = config
+      config.instance_eval(&block) if block_given?
+      config.validate!
+      config
+    end
+
+    def self.get_config(name)
+      @@configs[name.to_sym]
+    end
+
+    def self.get_config!(name)
+      config = get_config(name)
+      raise "Unknown Subroutine::Factory `#{name}`" unless config
+      return config
+    end
+
+    def self.create(name, *args)
+      config = get_config!(name)
+      builder = ::Subroutine::Factory::Builder.new(config, *args)
+      builder.execute!
+    end
+
+    def self.sequence(&lambda)
+      if block_given?
+        Proc.new{
+          @@sequence += 1
+          lambda.call(@@sequence)
+        }
+      else
+        @@sequence += 1
+      end
+    end
+
+  end
+end

data/subroutine-factory.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'subroutine/factory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "subroutine-factory"
+  spec.version       = Subroutine::Factory::VERSION
+  spec.authors       = ["Mike Nelson"]
+  spec.email         = ["mike@mnelson.io"]
+
+  spec.summary       = %q{Test factories for ops using Subroutine Ops}
+  spec.description   = %q{Test factories for ops using Subroutine Ops}
+  spec.homepage      = "https://github.com/mnelson/subroutine-factory"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "subroutine"
+  spec.add_dependency "activesupport", ">= 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
+
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: subroutine-factory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Nelson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: subroutine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: minitest-reporters
+  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: Test factories for ops using Subroutine Ops
+email:
+- mike@mnelson.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/subroutine/factory.rb
+- lib/subroutine/factory/builder.rb
+- lib/subroutine/factory/config.rb
+- lib/subroutine/factory/spec_helper.rb
+- lib/subroutine/factory/version.rb
+- subroutine-factory.gemspec
+homepage: https://github.com/mnelson/subroutine-factory
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Test factories for ops using Subroutine Ops
+test_files: []