ruby_pipeline 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f58ba14a41f2738f813dc20a2510cba4b2d285db8f0b1dc91ad5cbec2961b58a
+  data.tar.gz: 96b44437c7e11c1c0675c584691148e948025473ede0cf37ec6e31325a691c38
+SHA512:
+  metadata.gz: e109b4ef939340aaab83c9977bfc3382668b6ba9a891b2c7b02ae8989bf62b561031db0d7cb424472417d87e4b5c93ddf891d2d28d2bb8e1decbb935ae1cde4c
+  data.tar.gz: 8aaeb919db7af405b8be73ef8c50272018233aeee1bfa0e95aae7fed5fcef557c03dd1d717fb160979cc9cd431985d1f0858f1f4c4e55b028f6492b32980ff09

data/.github/workflows/release.yml

@@ -0,0 +1,31 @@
+name: "Publish gem"
+on:
+  push:
+    tags:
+      - 'v**'
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install --path vendor/bundle --jobs 4 --retry 3
+
+      - name: Publish to RubyGems Packages
+        env:
+          GEM_HOST_API_KEY: ${{secrets.GEM_HOST_API_KEY}}
+        run: |
+          gem build ruby_pipeline.gemspec
+          gem push ruby_pipeline-*.gem

data/.github/workflows/tests.yml

@@ -0,0 +1,45 @@
+name: "Tests"
+on:
+  push:
+
+jobs:
+  rubocop:
+    name: Rubocop
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install --path vendor/bundle --jobs 4 --retry 3
+
+      - name: Check code
+        run: bundle exec rubocop
+
+  rspec:
+    name: RSpec
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install --path vendor/bundle --jobs 4 --retry 3
+
+      - name: Run units
+        run: bundler exec rspec

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,30 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "Guardfile"
+    - "ruby_pipeline.gemspec"
+    - "spec/**/*.rb"
+
+Metrics/ModuleLength:
+  Exclude:
+    - "spec/**/*.rb"
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 8
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/Style/OpenStructUse:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.1.4

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.4

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+ruby '>= 2.5.0'
+
+source 'https://rubygems.org'
+
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-rspec'

data/Gemfile.lock

@@ -0,0 +1,69 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.0)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-rspec (2.23.2)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  rspec
+  rubocop
+  rubocop-rspec
+
+RUBY VERSION
+   ruby 3.0.3p157
+
+BUNDLED WITH
+   2.3.16

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rollbar, Inc.
+
+MIT License
+
+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,99 @@
+# Ruby Pipeline
+
+Add pipelines of small ruby classes to your ruby project.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_pipeline'
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install ruby_pipeline
+
+## Usage
+
+### Create a pipeline
+
+```ruby
+class MyPipeline < RubyPipeline::BasePipeline
+  private
+
+  def default_steps
+    [
+      PipelineSteps::Step1,
+      PipelineSteps::Step2
+    ]
+  end
+end
+```
+
+### Create a step
+
+```ruby
+class PipelineSteps::Step1 < RubyPipeline::BaseStep
+  def process(data)
+    # do something with data, what you return will be passed to the next step
+    data
+  end
+end
+
+class PipelineSteps::Step1 < RubyPipeline::BaseStep
+  def process(data)
+    # returning nil will terminate the pipeline
+    nil
+  end
+end
+```
+
+### Run a pipeline
+
+```ruby
+MyPipeline.new.process(data)
+```
+
+### Config
+
+You can configure a success callback to be called after each step is processed:
+
+```ruby
+RubyPipeline.configure do |config|
+  config.success_callback = ->(step) { my_monitoring_service.notify(step) }
+  config.failure_callback = ->(step) { puts "Failure in step #{step}" }
+end
+```
+
+## Contributing
+
+1. Fork it
+1. Create your feature branch (git checkout -b my-new-feature).
+1. Commit your changes (git commit -am 'Added some feature')
+1. Push to the branch (git push origin my-new-feature)
+1. Create new Pull Request
+
+We're using RSpec for testing. Run the test suite with rake spec. Tests for pull requests are appreciated but not required. (If you don't include a test, we'll write one before merging.)
+
+## License
+
+`ruby-pipeine`` is free software released under the MIT License. See LICENSE for details.
+
+## Publishing a gem version
+
+This gem uses Github Packages Registry to store gems, and all builds get pushed to it.
+
+1. Update `lib/ruby_pipeline/version.rb` with the new version
+2. Create and push a tag:
+
+  ```bash
+    git tag 'v0.1.0' # replace with your version
+    git push origin 'v0.1.0'
+  ```
+
+This will automatically trigger the release workflow of GHA, after which you will be able to install a fresh version of a gem into your system.

data/lib/ruby_pipeline/base_pipeline.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RubyPipeline
+  class BasePipeline
+    def initialize(steps = default_steps)
+      @steps = steps
+    end
+
+    def process(input = nil)
+      steps.inject(input) do |memo, step|
+        step_result = step.process(memo)
+
+        break failure(step) if step_result.nil?
+
+        success(step)
+        step_result
+      end
+    end
+
+    private
+
+    attr_reader :steps
+
+    def default_steps = []
+
+    def success(step) = RubyPipeline.configuration.success_callback.call(step)
+
+    def failure(step)
+      RubyPipeline.configuration.failure_callback.call(step)
+      false
+    end
+  end
+end

data/lib/ruby_pipeline/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RubyPipeline
+  class Configuration
+    attr_accessor :success_callback, :failure_callback
+
+    def initialize
+      @success_callback = ->(step) {}
+      @failure_callback = ->(step) {}
+    end
+  end
+end

data/lib/ruby_pipeline/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RubyPipeline
+  VERSION = '1.0.1'
+end

data/lib/ruby_pipeline.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'ruby_pipeline/version'
+require 'ruby_pipeline/configuration'
+require 'ruby_pipeline/base_pipeline'
+
+module RubyPipeline
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/ruby_pipeline.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/ruby_pipeline/version', __dir__)
+
+Gem::Specification.new do |s|
+  s.name        = 'ruby_pipeline'
+  s.version     = RubyPipeline::VERSION
+  s.summary     = 'Pipelines for your ruby apps'
+  s.description = ''
+  s.authors     = ['Ian Vaughan']
+  s.email       = 'ian@out.fund'
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.homepage    = 'https://rubygems.org/out-fund/ruby_pipeline'
+  s.license     = 'MIT'
+
+  s.metadata['rubygems_mfa_required'] = 'true'
+  s.required_ruby_version = '>= 3.1.4'
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: ruby_pipeline
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Ian Vaughan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-16 00:00:00.000000000 Z
+dependencies: []
+description: ''
+email: ian@out.fund
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/release.yml"
+- ".github/workflows/tests.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/ruby_pipeline.rb
+- lib/ruby_pipeline/base_pipeline.rb
+- lib/ruby_pipeline/configuration.rb
+- lib/ruby_pipeline/version.rb
+- ruby_pipeline.gemspec
+homepage: https://rubygems.org/out-fund/ruby_pipeline
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: Pipelines for your ruby apps
+test_files: []