payload 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fa079c6398f542f86d57e0d7877adfd70566478
-  data.tar.gz: e2ac201ce98bd76fcc49bc8356d326a4a72e16db
+  metadata.gz: b10fd4f4978e6e012a6a0de2afb3ddd2d0a42213
+  data.tar.gz: 4f8f29b9e509d9187d7069af752af5bbb4ebd3ab
 SHA512:
-  metadata.gz: 44d7f4b24a8cfa7aa9b81dfdce4e1c428727352ecffd8c21010c980723022cbe6b94519d5525082a45903556fc8241c1a032cb5c57eee4fa5f37e81c13ea31f4
-  data.tar.gz: bc383b6d05c0bc47a49c1cc56159437db0a1937484fbfb724d75557316bf8b996707a2ef0f8475d36e15b7038a80ccc3d4e9a507a59182e569bb4acab9611263
+  metadata.gz: bf4b151ea4ce615e0eac8a522768d8e4e4b63b8b47ed9cb392a7b053a9fadecfe5cc2a6b68da3e3375a8ab305e34732f553b85e85ce55c78fa5ddef03add86fc
+  data.tar.gz: 906535970e22a92f507b48e14a37a2b2ec16ce6ba23fa63f9591bda7a909d73c0acb649e21d684891db10ea8eb1e2a562b7f376143e340cdf4b23276ce64db0f

data/.gitignore

@@ -1,4 +1,5 @@
 .bundle
 .yardoc
+coverage
 doc
 pkg

data/.travis.yml

@@ -0,0 +1,7 @@
+addons:
+  code_climate:
+    repo_token: adbc28d8c3bd765fc6aa418515aa036b275608c9d42a2326d3133b1231f14741
+
+rvm:
+  - 2.0.0
+  - 2.1.0

data/Gemfile.lock

@@ -1,12 +1,16 @@
 PATH
   remote: .
   specs:
-    payload (0.2.2)
+    payload (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    codeclimate-test-reporter (0.2.0)
+      simplecov (>= 0.7.1, < 1.0.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
+    multi_json (1.10.1)
     rack (1.5.2)
     rake (10.3.2)
     rspec (3.1.0)
@@ -21,11 +25,17 @@ GEM
     rspec-mocks (3.1.3)
       rspec-support (~> 3.1.0)
     rspec-support (3.1.2)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  codeclimate-test-reporter
   payload!
   rack
   rake

data/README.md

@@ -71,8 +71,8 @@ from controllers entirely.
 In `config/dependencies.rb`:
 
 ```ruby
-factory :payment do |container|
-  Payment.new(container[:attributes], container[:payment_client])
+factory :payment do |container, attributes|
+  Payment.new(attributes, container[:payment_client])
 end
 ```
 
@@ -81,7 +81,7 @@ In `app/controllers/payments_controller.rb`:
 ```ruby
 class PaymentsController < ApplicationController
   def create
-    payment = dependencies[:payment].new(attributes: params[:payment])
+    payment = dependencies[:payment].new(params[:payment])
     payment.process
     redirect_to payment
   end
@@ -95,7 +95,7 @@ describe PaymentsController do
   describe '#create' do
     it 'processes a payment' do
       payment_params = { product_id: '123', amount: '25' }
-      payment = stub_factory_instance(:payment, attributes: payment_params)
+      payment = stub_factory_instance(:payment, payment_params)
 
       post :create, payment_params
 
@@ -151,13 +151,13 @@ Use the `factory` method to define dependencies which require dependencies from
 the container as well as runtime state which varies per-request:
 
 ```ruby
-factory :payment do |container|
-  Payment.new(container[:attributes], container[:payment_client])
+factory :payment do |container, attributes|
+  Payment.new(attributes, container[:payment_client])
 end
 ```
 
-The container for factory definitions contains all dependencies defined on the
-container as well as dependencies provided when instantiating the factory.
+Any additional arguments passed to `new` when instantiating the factory will
+also be passed to the factory definition block.
 
 Use the `decorate` method to extend or replace a previously defined dependency:
 
@@ -193,15 +193,15 @@ Use `new` to instantiate dependencies from factories:
 ```ruby
 class PaymentsController < ApplicationController
   def create
-    payment = dependencies[:payment].new(attributes: params[:payment])
+    payment = dependencies[:payment].new(params[:payment])
     payment.process
     redirect_to payment
   end
 end
 ```
 
-The `new` method accepts a `Hash`. Each element of the `Hash` will be accessible
-from the container in `factory` definitions.
+All arguments to the `new` method will be passed to the factory definition
+block.
 
 Grouping Dependencies
 ---------------------
@@ -222,8 +222,8 @@ service :payment_notifier do |container|
   PaymentNotifier.new(container[:mailer])
 end
 
-factory :payment do |container|
-  Payment.new(container[:attributes], container[:payment_client])
+factory :payment do |container, attributes|
+  Payment.new(attributes, container[:payment_client])
 end
 
 decorate :payment do |payment, container|

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/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' 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('rspec-core', 'rspec')

data/lib/payload/decorator_chain.rb

@@ -16,9 +16,9 @@ module Payload
       self.class.new decorators + [decorator]
     end
 
-    def decorate(base, container)
+    def decorate(base, container, *extra)
       decorators.inject(base) do |component, decorator|
-        decorator.call(component, container)
+        decorator.call(component, container, *extra)
       end
     end
 

data/lib/payload/definition.rb

@@ -5,7 +5,7 @@ module Payload
   # Definition for a dependency which can be resolved and decorated.
   #
   # Used internally by {DefinitionList}. Use {Container#service} or
-  # {Container#fatory}.
+  # {Container#factory}.
   #
   # @api private
   class Definition

data/lib/payload/factory.rb

@@ -1,3 +1,5 @@
+require "payload/partial_instance"
+
 module Payload
   # Returned by {Container#[]} for {Container#factory} definitions.
   #
@@ -15,19 +17,34 @@ module Payload
       @decorators = decorators
     end
 
-    # @param [Hash] arguments additional dependencies and arguments to resolve
-    #   before invoking the factory definition block.
+    # @param [Array] arguments additional arguments to pass to the factory
+    #   definition block.
     # @return the instance defined by the factory definition block.
     # @see Container#factory Container#factory for defining and using factories.
-    def new(arguments = {})
-      resolved =
-        arguments.inject(@container) do |container, (argument, value)|
-          container.service(argument) { value }
-        end
-
-      base = @block.call(resolved)
+    def new(*arguments)
+      base = @block.call(@container, *arguments)
+      @decorators.decorate(base, @container, *arguments)
+    end
 
-      @decorators.decorate(base, resolved)
+    # Return a new factory with some of the arguments provided. Remaining
+    # arguments can be provided by invoking {Factory#new} on the returned
+    # instance. Chaining {Factory#apply} is also possible. This can be useful
+    # for returning a factory where some of the dependencies are provided by the
+    # container, and the remainder are provided at runtime.
+    #
+    # @example
+    #   container = Payload::Container.new.
+    #     factory(:form) { |container, model, attributes|
+    #       Form.new(model, attributes)
+    #     }.
+    #     service(:user_form) { |container| container[:form].apply(User) }
+    #   user_form = container[:user_form].new(username: "smith")
+    # @param [Array] arguments positional arguments to be passed to the factory
+    # @param [Hash] keywords keyword arguments to be passed to the factory
+    # @return [PartialInstance] an instance on which you can invoke
+    #   {Factory#new}.
+    def apply(*arguments, **keywords)
+      PartialInstance.new(self).apply(*arguments, **keywords)
     end
   end
 end

data/lib/payload/partial_instance.rb

@@ -0,0 +1,57 @@
+module Payload
+  # Returned by {Factory#apply}.
+  #
+  # Used to build up arguments for invoking factory definitions.
+  #
+  # @see Factory#apply Factory#apply for usage.
+  class PartialInstance
+    # Used internally by {Factory}.
+    #
+    # @api private
+    def initialize(instance, positional = [], keywords = {})
+      @instance = instance
+      @positional = positional
+      @keywords = keywords
+    end
+
+    # @see Factory#apply Factory#apply for usage.
+    def apply(*positional, **keywords)
+      self.class.new(
+        @instance,
+        @positional + positional,
+        @keywords.merge(keywords)
+      )
+    end
+
+    # Applies final arguments and invokes the missing method on the target.
+    #
+    # @see Factory#new Factory#new for usage.
+    def method_missing(name, *positional, **keywords, &block)
+      apply(*positional, **keywords).evaluate(name, &block)
+    end
+
+    protected
+
+    def evaluate(name, &block)
+      @instance.public_send(name, *arguments, &block)
+    end
+
+    private
+
+    def arguments
+      @positional + keyword_arguments
+    end
+
+    def keyword_arguments
+      if @keywords.empty?
+        []
+      else
+        [@keywords]
+      end
+    end
+
+    def respond_to_missing?(*arguments)
+      @instance.respond_to?(*arguments)
+    end
+  end
+end

data/lib/payload/version.rb

@@ -1,3 +1,3 @@
 module Payload
-  VERSION = '0.2.2'
+  VERSION = "0.3.0"
 end

data/payload.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rack'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 3.1.0'
+  s.add_development_dependency 'codeclimate-test-reporter'
 end

data/spec/payload/container_spec.rb

@@ -5,17 +5,17 @@ require 'payload/testing'
 describe Payload::Container do
   include Payload::Testing
 
-  describe '#factory' do
-    it 'returns an object that responds to new' do
-      container = build_container
-        .service(:from_container) { |config| 'From container' }
-        .factory(:example) do |config|
-          "#{config[:from_new]} and #{config[:from_container]}"
+  describe "#factory" do
+    it "returns an object that responds to new" do
+      container = build_container.
+        service(:from_container) { |config| "From container" }.
+        factory(:example) do |config, from_new|
+          "#{from_new} and #{config[:from_container]}"
         end
 
-      result = container[:example].new(from_new: 'From new')
+      result = container[:example].new("From new")
 
-      expect(result).to eq('From new and From container')
+      expect(result).to eq("From new and From container")
     end
   end
 

data/spec/payload/decorator_chain_spec.rb

@@ -6,28 +6,42 @@ describe Payload::DecoratorChain do
     expect(Payload::DecoratorChain.new).to be_a(Enumerable)
   end
 
-  describe '#decorate' do
-    it 'applies a series of decorators to a component' do
-      chain = Payload::DecoratorChain
-        .new
-        .add(lambda { |base, config| "Decorated #{base} with #{config[:one]}" })
-        .add(lambda { |base, config| "#{base} and #{config[:two]}" })
+  describe "#decorate" do
+    it "applies a series of decorators to a component" do
+      chain = Payload::DecoratorChain.
+        new.
+        add(lambda { |base, config| "Decorated #{base} with #{config[:one]}" }).
+        add(lambda { |base, config| "#{base} and #{config[:two]}" })
 
-      result = chain.decorate('original', one: 'one', two: 'two')
+      result = chain.decorate("original", one: "one", two: "two")
 
-      expect(result).to eq('Decorated original with one and two')
+      expect(result).to eq("Decorated original with one and two")
+    end
+
+    it "applies a decorator with extra arguments" do
+      block = lambda do |base, config, extra|
+        "Decorated #{base} with #{config[:one]} and #{extra}"
+      end
+
+      chain = Payload::DecoratorChain.
+        new.
+        add(block)
+
+      result = chain.decorate("original", { one: "one", two: "two" }, "extra")
+
+      expect(result).to eq("Decorated original with one and extra")
     end
 
     it "doesn't mutate" do
-      chain = Payload::DecoratorChain
-        .new
-        .add(lambda { |base, config| "Decorated #{base}" })
+      chain = Payload::DecoratorChain.
+        new.
+        add(lambda { |base, config| "Decorated #{base}" })
 
-      chain.add(lambda { |base, config| 'Unreferenced decorator' })
+      chain.add(lambda { |base, config| "Unreferenced decorator" })
 
-      result = chain.decorate('original', {})
+      result = chain.decorate("original", {})
 
-      expect(result).to eq('Decorated original')
+      expect(result).to eq("Decorated original")
     end
   end
 

data/spec/payload/factory_spec.rb

@@ -1,46 +1,56 @@
-require 'spec_helper'
-require 'payload/factory'
-require 'payload/decorator_chain'
-require 'payload/testing'
+require "spec_helper"
+require "payload/factory"
+require "payload/decorator_chain"
+require "payload/testing"
 
 describe Payload::Factory do
   include Payload::Testing
 
-  describe '#new' do
-    it 'instantiates the dependency' do
-      decorator = lambda do |component, config|
-        "Decorated #{component.inspect} " \
-          "with #{config[:from_container]} " \
-          "and #{config[:from_new]}"
+  describe "#new" do
+    it "instantiates the dependency" do
+      decorator = lambda do |component, config, from_new|
+        "Decorated #{component.inspect}" \
+          " with #{config[:from_container]} and #{from_new}"
       end
-      block = lambda do |config|
-        "Component with #{config[:from_container]} and #{config[:from_new]}"
+      block = lambda do |config, from_new|
+        "Component with #{config[:from_container]} and #{from_new}"
       end
       decorators = Payload::DecoratorChain.new.add(decorator)
-      container = build_container
-        .service(:from_container) { 'From container' }
+      container = build_container.service(:from_container) { "From container" }
       factory = Payload::Factory.new(container, block, decorators)
 
-      result = factory.new(from_new: 'From new')
+      result = factory.new("From new")
 
       expect(result).to eq(
         'Decorated "Component with From container and From new" ' \
-          'with From container and From new'
+          "with From container and From new"
       )
     end
 
-    it 'instantiates the dependency without arguments' do
+    it "instantiates the dependency without arguments" do
       block = lambda do |config|
         "Component with #{config[:from_container]}"
       end
       decorators = Payload::DecoratorChain.new
-      container = build_container
-        .service(:from_container) { 'From container' }
+      container = build_container.service(:from_container) { "From container" }
       factory = Payload::Factory.new(container, block, decorators)
 
       result = factory.new
 
-      expect(result).to eq('Component with From container')
+      expect(result).to eq("Component with From container")
+    end
+  end
+
+  describe "#apply" do
+    it "applies arguments" do
+      container = build_container
+      block = lambda { |config, applied, local| "Got #{applied} and #{local}" }
+      decorators = Payload::DecoratorChain.new
+      factory = Payload::Factory.new(container, block, decorators)
+
+      result = factory.apply("applied").new("local")
+
+      expect(result).to eq("Got applied and local")
     end
   end
 end

data/spec/payload/partial_instance_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+require "payload/partial_instance"
+
+describe Payload::PartialInstance do
+  describe "#method_missing" do
+    context "for a method with only positional arguments" do
+      it "applies parameters from #initialize and #apply" do
+        block = lambda do |first, second, third|
+          [first, second, third]
+        end
+
+        result = Payload::PartialInstance.
+          new(block, ["first"], {}).
+          apply("second").
+          call("third")
+
+        expect(result).to eq(%w(first second third))
+      end
+    end
+
+    context "for a method with keyword arguments" do
+      it "combines keyword arguments" do
+        block = lambda do |first, second, third, a: nil, b: nil, c: nil|
+          [first, second, third, a, b, c]
+        end
+
+        result = Payload::PartialInstance.
+          new(block, ["first"], { a: "a" }).
+          apply("second", b: "b").
+          call("third", c: "c")
+
+        expect(result).to eq(%w(first second third a b c))
+      end
+    end
+  end
+
+  describe "#respond_to_missing?" do
+    context "for a method defined on its instance" do
+      it "returns true" do
+        instance = double("instance")
+        allow(instance).to receive(:example)
+        partial = Payload::PartialInstance.new(instance)
+
+        expect(partial.method(:example)).not_to be_nil
+      end
+    end
+
+    context "for an undefined method" do
+      it "returns false" do
+        instance = double("instance")
+        partial = Payload::PartialInstance.new(instance)
+
+        expect { partial.method(:unknown) }.to raise_error(NameError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,11 @@
+if ENV["CODECLIMATE_REPO_TOKEN"]
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+else
+  require "simplecov"
+  SimpleCov.start
+end
+
 RSpec.configure do |config|
   config.raise_errors_for_deprecations!
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: payload
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - thoughtbot
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2014-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: Dependency configuration and injection for Ruby and Rails.
 email: support@thoughtbot.com
 executables: []
@@ -63,12 +77,15 @@ extra_rdoc_files:
 - CONTRIBUTING.md
 files:
 - ".gitignore"
+- ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- bin/rake
+- bin/rspec
 - lib/payload/container.rb
 - lib/payload/controller.rb
 - lib/payload/decorator_chain.rb
@@ -79,6 +96,7 @@ files:
 - lib/payload/factory.rb
 - lib/payload/factory_resolver.rb
 - lib/payload/mutable_container.rb
+- lib/payload/partial_instance.rb
 - lib/payload/rack_container.rb
 - lib/payload/rails_loader.rb
 - lib/payload/railtie.rb
@@ -97,6 +115,7 @@ files:
 - spec/payload/factory_resolver_spec.rb
 - spec/payload/factory_spec.rb
 - spec/payload/mutable_container_spec.rb
+- spec/payload/partial_instance_spec.rb
 - spec/payload/rack_container_spec.rb
 - spec/payload/rails_loader_spec.rb
 - spec/payload/service_resolver_spec.rb
@@ -123,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Dependency configuration and injection for Ruby and Rails.
@@ -137,6 +156,7 @@ test_files:
 - spec/payload/factory_resolver_spec.rb
 - spec/payload/factory_spec.rb
 - spec/payload/mutable_container_spec.rb
+- spec/payload/partial_instance_spec.rb
 - spec/payload/rack_container_spec.rb
 - spec/payload/rails_loader_spec.rb
 - spec/payload/service_resolver_spec.rb