codequest_pipes 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8927148db159660b6ead2c27a563bad7549d0a09
-  data.tar.gz: 19984aa1944dcfeb4f25f98a4e094d7d7a30d726
+  metadata.gz: f4686dbe7780d8bc9a02b7371a87939c26c5a425
+  data.tar.gz: 2fe01e9d642064faa039e75b14374869e3593ec9
 SHA512:
-  metadata.gz: c21098b3a8f6a3c58fe20b811601a242a2cbec7804ddc238033d7098cd9b8dd37d4d51889329408e998f32c9f2a5dacc57d99af852ee3519c16f7171c1639e39
-  data.tar.gz: 42650f5652b26974040cda7f82db6860c09d69f616ecc3a2bf378947df5735e3304a5843023f09983373ab17c5825329655309e3728bbfc008807b15882bd328
+  metadata.gz: de35061ef1e1f3dedc67c5e469ead96fbd9baf50520deaec045ba427f1585ef97ebdc131e463c8b171ddd5e13e09e0a0f695c4d4a521cbf4d266d26f665a1c56
+  data.tar.gz: 5781bcedc1099d9ce527ec1af5a04b02602049ff9e300aa5da6360bc8bb7ef28f5d5316733fcc1cd7f080aeff0197f1b48af82b480a261727fd253f1bc67f6c3

data/lib/codequest_pipes/context.rb

@@ -65,5 +65,17 @@ module Pipes
     def failure?
       !success?
     end
+
+    # Printable string representation of the context
+    # object_id_hex explained: http://stackoverflow.com/a/2818916/3526316
+    #
+    # @return [String]
+    def inspect
+      keys = methods - Object.methods - Pipes::Context.instance_methods
+      fields = keys.map { |key| "#{key}=#{public_send(key).inspect}" }
+      fields << "@error=#{@error.inspect}"
+      object_id_hex = '%x' % (object_id << 1)
+      "#<Pipes::Context:0x00#{object_id_hex} #{fields.join(', ')}>"
+    end
   end # class Context
 end # module Pipes

data/lib/codequest_pipes/rspec.rb

@@ -0,0 +1,16 @@
+RSpec::Matchers.define :pipe_context do |expected_hash|
+  def matches_or_equals?(actual, expected)
+    return expected.matches?(actual) if expected.respond_to?(:matches?)
+    expected == actual
+  end
+
+  match do |ctx|
+    return false unless ctx.is_a?(Pipes::Context)
+    expected_hash.all? do |key, val|
+      next false unless ctx.respond_to?(key)
+      matches_or_equals?(ctx.public_send(key), val)
+    end
+  end
+
+  diffable
+end

data/spec/context_spec.rb

@@ -1,18 +1,30 @@
 require 'spec_helper'
 
 describe Pipes::Context do
-  let(:ctx) { Pipes::Context.new }
-
   describe '#add' do
     it 'allows adding new fields' do
-      ctx.add(key: 'val')
-      expect(ctx.key).to eq('val')
+      subject.add(key: 'val')
+      expect(subject.key).to eq('val')
     end
 
     it 'does not allow rewriting existing fields' do
-      ctx.add(key: 'val')
-      expect { ctx.add(key: 'other_val') }
+      subject.add(key: 'val')
+      expect { subject.add(key: 'other_val') }
         .to raise_error(Pipes::Context::Override)
     end
-  end
-end # describe Context
+  end # describe '#add'
+
+  describe '#inspect' do
+    it 'lists all fields' do
+      subject.add(bacon: 'yum', raisins: 'bleh')
+      expect(subject.inspect)
+        .to match(/bacon=\"yum\", raisins=\"bleh\", @error=nil/)
+    end
+
+    it 'lists nested contexts' do
+      subject.add(nested: Pipes::Context.new(foo: 'bar'))
+      expect(subject.inspect)
+        .to match(/nested=#<Pipes::Context:0x\w+ foo="bar", @error=nil>,/)
+    end
+  end # describe '#inspect'
+end # describe Pipes::Context

data/spec/matcher_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'rspec/matchers/fail_matchers'
+require 'codequest_pipes/rspec'
+
+RSpec.configure do |config|
+  config.include RSpec::Matchers::FailMatchers
+end
+
+describe 'expect(...).to match(pipe_context(expected))' do
+  let(:ctx) { Pipes::Context.new(foo: 'foo', bar: {}, baz: 1) }
+  let(:expected) { nil }
+
+  shared_examples_for 'fails_with_message' do |message|
+    it 'fails' do
+      expected_message =
+        message || /expected #<Pipes::Context:.+ @error=nil> to match/
+      expect { expect(ctx).to match(pipe_context(expected)) }
+        .to fail_with(expected_message)
+    end
+  end # shared_examples_for 'fails'
+
+  context 'when any key is missing' do
+    let(:expected) { {foo: 'foo', bacon: {}} }
+    it_behaves_like 'fails_with_message'
+  end # context 'when any key is missing'
+
+  context 'when actual is not Pipes::Context' do
+    let(:ctx) { 'bacon' }
+
+    it_behaves_like 'fails_with_message', /expected "bacon" to match/
+  end # context 'when expected is not Pipes::Context'
+
+  context 'when any key matcher fails' do
+    let(:expected) { {foo: 'foo', bar: {}, baz: 'bacon'} }
+
+    it_behaves_like 'fails_with_message'
+  end # context 'when any key matcher fails'
+
+  context 'when any value not equal' do
+    let(:expected) { {foo: 'foo', bar: {}, baz: 2} }
+
+    it_behaves_like 'fails_with_message'
+  end
+
+  context 'when all keys match' do
+    let(:expected) { {foo: 'foo', bar: {}, baz: 1} }
+    it 'succeeds' do
+      expect(ctx).to match(pipe_context(expected))
+    end
+  end # context 'when all keys match'
+end # describe 'pipe_context'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codequest_pipes
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - codequest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,19 +50,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- LICENSE
-- README.md
-- Rakefile
-- codequest_pipes.gemspec
 - lib/codequest_pipes.rb
 - lib/codequest_pipes/closure.rb
 - lib/codequest_pipes/context.rb
 - lib/codequest_pipes/pipe.rb
+- lib/codequest_pipes/rspec.rb
 - spec/context_spec.rb
+- spec/matcher_spec.rb
 - spec/pipe_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/codequest-eu/codequest_pipes
@@ -85,11 +79,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Unix-like way to chain business objects (interactors)
 test_files:
 - spec/context_spec.rb
+- spec/matcher_spec.rb
 - spec/pipe_spec.rb
 - spec/spec_helper.rb

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.0
-  - 2.1.0
-  - 2.0.0

data/Gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :test do
-  gem 'rspec', '~> 3.1'
-end

data/LICENSE

@@ -1,22 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 code quest
-
-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

@@ -1,56 +0,0 @@
-# Pipes [![Build Status](https://travis-ci.org/codequest-eu/codequest_pipes.svg?branch=master)](https://travis-ci.org/codequest-eu/codequest_pipes) [![codebeat badge](https://codebeat.co/badges/73f1bb7f-516f-4fc5-b241-daea42c7badd)](https://codebeat.co/projects/codequest_pipes-master-ab1a7c5f-ad5f-425a-a0f0-e56e13a04876)
-
-Pipes provide a Unix-like way to chain business objects (interactors) in Ruby.
-
-## Installation
-
-To start using Pipes, add the library to your `Gemfile` and run `bundle install`.
-
-```ruby
-gem 'codequest_pipes'
-```
-
-## High-level usage example
-
-```ruby
-FLOW = Projects::Match         | # NOTE: each of the elements must inherit from
-       Projects::Validate      | # Pipes::Pipe!
-       Projects::UpdatePayment |
-       Projects::SaveWithReport
-context = Pipes::Context.new(project: p)
-FLOW.call(context)
-```
-
-## Pipe
-
-Pipes provide a way to describe business transactions in a stateless
-and reusable way. Let's create a few pipes from plain Ruby classes.
-
-```ruby
-class PaymentPipe < Pipes::Pipe
-  require_context :user        # flow will fail if precondition not met
-  provide_context :transaction # flow will fail if postcondition not met
-
-  def call
-    result = PaymentService.create_transaction(user)
-    add(transaction: result.transaction)
-  end
-end
-```
-
-Note how we've only had to implement the `call` method for the magic to start happening. When calling these objects you'd be using the class method `call` instead and passing a `Pipes::Context` objects to it. All unknown messages (like `user`) in two examples above are passed to the `context` which is an instance variable of every object inheriting from `Pipes::Pipe`.
-
-## Context
-
-Each Pipe requires an instance `Pipes::Context` to be passed on `.call` invokation. It provides append-only data container for Pipes: you can add data to a context at any time using the `add` method but the same call will raise an error if you try to modify an existing key.
-
-Made with ❤️ by [code quest](http://www.codequest.com)
-
-
-
-
-
-
-
-
-

data/Rakefile

@@ -1,9 +0,0 @@
-begin
-  require 'rspec/core/rake_task'
-
-  RSpec::Core::RakeTask.new(:spec)
-
-  task :default => :spec
-rescue LoadError
-  # no rspec available
-end

data/codequest_pipes.gemspec

@@ -1,19 +0,0 @@
-# encoding: utf-8
-
-Gem::Specification.new do |spec|
-  spec.name    = 'codequest_pipes'
-  spec.version = '0.3.0'
-
-  spec.author      = 'codequest'
-  spec.email       = 'hello@codequest.com'
-  spec.description = 'Pipes provides a Unix-like way to chain business objects'
-  spec.summary     = 'Unix-like way to chain business objects (interactors)'
-  spec.homepage    = 'https://github.com/codequest-eu/codequest_pipes'
-  spec.license     = 'MIT'
-
-  spec.files      = `git ls-files`.split($RS)
-  spec.test_files = spec.files.grep(/^spec/)
-
-  spec.add_development_dependency 'bundler', '~> 1.6', '>= 1.6.9'
-  spec.add_development_dependency 'rake', '~> 10.3'
-end