nxt_pipeline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 562568995097a8f83c10663f6338404b1aea732d7e65f1c151a1d4a76c32a2bb
+  data.tar.gz: 3494855a43cdbe7a253e9ee5b07c6c1be7bf7be3e52a2a83da99fcd2c612b2cc
+SHA512:
+  metadata.gz: 6efff78864aa95fa547486c301ab7023fa2b1ed623e6f3e80380efaae9b943dd0d35ae251a079d02be8e07faf34ee2d9e60f19a365c4e5496ac16406a5a5223f
+  data.tar.gz: e27d108c8cd267b61ac4962b2e395957070e580c66482b124e2f4217c27b2f80cbd3a8eb22d2417fd04b91e2a916279edb5cfc5ce2ac89314191c66effc41fef

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.6.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nxt_pipeline.gemspec
+gemspec
+
+gem 'activesupport'

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    nxt_pipeline (0.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 1.17)
+  nxt_pipeline!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nils Sommer
+
+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,89 @@
+# NxtPipeline
+
+nxt_pipeline provides a DSL to structure the processing of an object (oil) through multiple steps by defining pipelines (which process the object) and segments (reusable steps used by the pipeline).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nxt_pipeline'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nxt_pipeline
+
+## Usage
+
+Look how easy it is.
+
+```ruby
+class UppercaseSegment < NxtPipeline::Segment
+  def pipe_through
+    words.map(&:uppercase)
+  end
+end
+
+class SortSegment < NxtPipeline::Segment
+  def pipe_through
+    words.sort
+  end
+end
+
+class MyPipeline < NxtPipeline::Pipeline
+  pipe_attr :words
+  
+  segment UppercaseSegment
+  segment SortSegment
+end
+
+MyPipeline.new(words: %w[Ruby is awesome]).call
+# => ["AWESOME", "IS", "RUBY"]
+```
+
+Basically you create a pipeline class that inherits from `NxtPipeline::Pipeline` and name the attribute you want to pass through the pipeline's segments with the `pipe_attr` class method.
+
+You can add segments to the pipeline by using the `segment` class method in the pipeline class body. The segment classes inherit from `NxtPipeline::Segment` and have to implement a method `#pipe_through`. Inside of it, you can access the pipeline attr by its reader method (see example above).
+
+You can also define behavior to execute when one of the pipelines raises an error.
+
+```ruby
+class MyPipeline < NxtPipeline::Pipeline
+  pipe_attr :words
+  
+  segment UppercaseSegment
+  segment SortSegment
+  
+  rescue_from StandardError do |error, segment_failed_upon|
+    puts "Failed in segment #{segment_failed_upon} with #{error.class}: #{error.message}"
+  end
+end
+
+pipeline = MyPipeline.new(words: %w[Ruby is awesome])
+pipeline.call
+# => 'Failed in segment uppercase_segment with StandardError: Lorem ipsum'
+
+pipeline.burst?
+# => true
+pipeline.burst_segment
+# => 'uppercase_segment'
+```
+
+## 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/nxt-insurance/nxt_pipeline.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "nxt_pipeline"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/nxt_pipeline.rb

@@ -0,0 +1,10 @@
+require 'active_support'
+require 'active_support/core_ext'
+
+require 'nxt_pipeline/version'
+require 'nxt_pipeline/segment'
+require 'nxt_pipeline/pipeline'
+
+module NxtPipeline
+  class Error < StandardError; end
+end

data/lib/nxt_pipeline/pipeline.rb

@@ -0,0 +1,58 @@
+module NxtPipeline
+  class Pipeline
+    attr_reader :burst_segment
+
+    def initialize(*attrs)
+      extract_pipe_attr_from_init_params(*attrs)
+    end
+
+    def call
+      self.segments.reduce(pipe_attr) do |transformed_pipe_attr, segment|
+        segment[pipe_attr_name].new(pipe_attr_name => transformed_pipe_attr).pipe_through
+      rescue => error
+        handle_segment_burst(error, segment)
+      end
+    end
+
+    def burst?
+      burst_segment.present?
+    end
+
+    class << self
+      def pipe_attr(name)
+        self.pipe_attr_name = name
+      end
+
+      def mount_segment(name)
+        self.segments << name
+      end
+
+      def rescue_segment_burst(*errors, &block)
+        self.rescueable_segment_bursts = errors
+        self.rescueable_block = block
+      end
+    end
+
+    private
+
+    attr_reader :pipe_attr
+
+    cattr_accessor :pipe_attr_name
+    cattr_accessor :segments, instance_writer: false, default: []
+    cattr_accessor :rescueable_segment_bursts, instance_writer: false, default: []
+    cattr_accessor :rescueable_block, instance_writer: false
+
+    def extract_pipe_attr_from_init_params(*attrs)
+      raise ArgumentError, 'You need to pass a keyword param as argument to #new' unless attrs.first.is_a?(Hash)
+      @pipe_attr = attrs.first.fetch(pipe_attr_name)
+    end
+
+    def handle_segment_burst(error, segment)
+      @burst_segment = segment.name.split('::').last.underscore
+
+      self.rescueable_block.call(error, burst_segment) if error.class.in?(rescueable_segment_bursts)
+
+      raise
+    end
+  end
+end

data/lib/nxt_pipeline/segment.rb

@@ -0,0 +1,47 @@
+module NxtPipeline
+  class Segment
+    def initialize(*args)
+      validate_initialize_args(*args).each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    def pipe_through
+      # Public interface of Segment, to be implemented by subclasses.
+      raise NotImplementedError
+    end
+
+    def self.[](*args)
+      raise ArgumentError, 'Arguments missing' if args.empty?
+
+      Class.new(self) do
+        self.segment_args = args.map(&:to_sym)
+
+        self.segment_args.each do |segment_arg|
+          attr_accessor segment_arg
+        end
+      end
+    end
+
+    private
+
+    cattr_accessor :segment_args, instance_writer: false, default: []
+
+    def validate_initialize_args(*args)
+      raise ArgumentError, arguments_missing_msg(self.segment_args) if args.empty?
+
+      keyword_args = args.first
+      missing_keyword_args = self.segment_args.reject do |arg|
+        keyword_args.include?(arg)
+      end
+
+      raise ArgumentError, arguments_missing_msg(missing_keyword_args) if missing_keyword_args.any?
+
+      keyword_args.slice(*self.segment_args)
+    end
+
+    def arguments_missing_msg(missing_arg_keys)
+      "Arguments missing: #{missing_arg_keys.map { |a| "#{a}:" }.join(', ')}"
+    end
+  end
+end

data/lib/nxt_pipeline/version.rb

@@ -0,0 +1,3 @@
+module NxtPipeline
+  VERSION = "0.1.0"
+end

data/nxt_pipeline.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nxt_pipeline/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nxt_pipeline"
+  spec.version       = NxtPipeline::VERSION
+  spec.authors       = ["Nils Sommer", "Andreas Robecke", "Raphael Kallensee"]
+  spec.email         = ["mail@nilssommer.de"]
+
+  spec.summary       = %q{DSL to build Pipeline with mountable Segments to process things.}
+  spec.homepage      = "https://github.com/nxt-insurance/nxt_pipeline"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/nxt-insurance/nxt_pipeline.git"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: nxt_pipeline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nils Sommer
+- Andreas Robecke
+- Raphael Kallensee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- mail@nilssommer.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nxt_pipeline.rb
+- lib/nxt_pipeline/pipeline.rb
+- lib/nxt_pipeline/segment.rb
+- lib/nxt_pipeline/version.rb
+- nxt_pipeline.gemspec
+homepage: https://github.com/nxt-insurance/nxt_pipeline
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/nxt-insurance/nxt_pipeline
+  source_code_uri: https://github.com/nxt-insurance/nxt_pipeline.git
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: DSL to build Pipeline with mountable Segments to process things.
+test_files: []