transflow 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c18bc0bd37bd89215142adefd13b8a965ea0994
+  data.tar.gz: 7827d58aeef106f8cf0eb6969381b76433f44a4e
+SHA512:
+  metadata.gz: 531682614e131a47544798c2700fd2c22258b6fa9a61c309515ef5a6bf72404dbd8a4faa29e8111c3f3c930d73243e7791546d1b4d6ff0aaa1699b0755a0833d
+  data.tar.gz: e87f9e64c7249a0c550e43b148391da884bdd90bb23b0eeb3131249961c8fd4882a9e6f0d43a7b98e3fb7513c7d699cf63fa63138df53a184f3dbdfa61621643

data/.gitignore

@@ -0,0 +1,45 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+=======
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--order random
+--warnings
+-r ./spec/spec_helper.rb

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+before_install: gem install bundler
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - jruby
+  - ruby-head
+  - jruby-head

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1 2015-08-16
+
+First public release \o/

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in transflow.gemspec
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', require: false, platforms: :rbx
+end
+
+group :tools do
+  gem 'byebug', platforms: :mri
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Piotr Solnica
+
+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,82 @@
+[gem]: https://rubygems.org/gems/transflow
+[travis]: https://travis-ci.org/solnic/transflow
+[gemnasium]: https://gemnasium.com/solnic/transflow
+[codeclimate]: https://codeclimate.com/github/solnic/transflow
+[inchpages]: http://inch-ci.org/github/solnic/transflow
+
+# Transflow
+
+[![Gem Version](https://badge.fury.io/rb/transflow.svg)][gem]
+[![Build Status](https://travis-ci.org/solnic/transflow.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/solnic/transflow.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/solnic/transflow/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/solnic/transflow/badges/coverage.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/solnic/transflow.svg?branch=master)][inchpages]
+
+Business transaction flow DSL. The aim of this small gem is to provide a simple
+way of defining complex business transaction flows that include processing by
+many different objects.
+
+It is based on the following ideas:
+
+- a business transaction is a series of operations where each can fail and stop processing
+- a business transaction resolves its dependencies using an external container object
+  and it doesn't know any details about the individual operation objects except their
+  identifiers
+- a business transaction can describe the flow on an abstract level without being
+  coupled to any details about how individual operations work
+- a business transaction doesn't have any state
+- each operation shouldn't accumulate state, instead it should receive an input and return
+  an output without causing any side-effects
+- the only interface of a an operation is `#call(input)`
+- each operation provides a meaningful functionality and can be reused
+- each operation can broadcast its result (TODO)
+- external message consumers can listen to a transaction object for specific events (TODO)
+
+## Why?
+
+The rationale for this project is quite simple - every use-case in an application
+can be described as a series of processing steps where some input is turned into
+an output. Steps can result in triggering additional operations handled by other
+parts of your application or completely external systems and that can be easily
+handled by a pub/sub interface.
+
+It's a clean and simple way of encapsulating complex business logic in your application
+using simple, stateless objects.
+
+## Error Handling
+
+This will be the tricky part - there are scenarios where we need to aggregate
+errors from multiple steps without stopping the processing. It's not implemented
+yet but *probably* using pub/sub for that will do the work as we can register an
+error listener that can simply gather errors and return it as a result.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'transflow'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transflow
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/transflow.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "transflow"
+
+# 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/transflow.rb

@@ -0,0 +1,73 @@
+require 'transproc'
+require 'transflow/version'
+
+module Transflow
+  class Transaction
+    attr_reader :handler
+
+    attr_reader :steps
+
+    def initialize(steps, handler)
+      @steps = steps
+      @handler = handler
+    end
+
+    def call(*args)
+      handler.call(*args)
+    end
+    alias_method :[], :call
+  end
+
+  class StepDSL
+    attr_reader :name
+
+    attr_reader :handler
+
+    attr_reader :container
+
+    attr_reader :steps
+
+    def initialize(name, options, container, steps, &block)
+      @name = name
+      @handler = options.fetch(:with)
+      @container = container
+      @steps = steps
+      instance_exec(&block) if block
+    end
+
+    def step(*args, &block)
+      self.class.new(*args, container, steps, &block).call
+    end
+
+    def call
+      steps[name] = container[handler]
+    end
+  end
+
+  class FlowDSL
+    attr_reader :options
+
+    attr_reader :container
+
+    attr_reader :steps
+
+    def initialize(options, &block)
+      @options = options
+      @container = options.fetch(:container)
+      @steps = {}
+      instance_exec(&block)
+    end
+
+    def step(*args, &block)
+      StepDSL.new(*args, container, steps, &block).call
+    end
+
+    def call
+      Transaction.new(steps, steps.values.reverse.reduce(:>>))
+    end
+  end
+end
+
+def Transflow(options = {}, &block)
+  Transflow::FlowDSL.new(options, &block).call
+end

data/lib/transflow/version.rb

@@ -0,0 +1,3 @@
+module Transflow
+  VERSION = '0.0.1'.freeze
+end

data/transflow.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transflow/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = "transflow"
+  spec.version  = Transflow::VERSION
+  spec.authors  = ["Piotr Solnica"]
+  spec.email    = ["piotr.solnica@gmail.com"]
+  spec.license  = "MIT"
+
+  spec.summary  = "Business Transaction Flow DSL"
+  spec.homepage = "https://github.com/solnic/transflow"
+
+  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_runtime_dependency 'transproc', '~> 0.3', '>= 0.3.1'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: transflow
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Piotr Solnica
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: transproc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 
+email:
+- piotr.solnica@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/transflow.rb
+- lib/transflow/version.rb
+- transflow.gemspec
+homepage: https://github.com/solnic/transflow
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Business Transaction Flow DSL
+test_files: []