riverbed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c5d4978c088d800b517175a266ff9f025c1566b17f4820d64d9a60cc563e968
+  data.tar.gz: 803fce7525da68cf7f039e21d4e872de9cf7b421cf58f895da5fca208f52be8b
+SHA512:
+  metadata.gz: ea44732a062ed725d831d6abdd4c15c69ff9df667b26b30ed9014c8e86af51bd385168c3b0c669521ae1ca9efd0bf08e94a5551329a694430058f80c491e9e76
+  data.tar.gz: 4fd7136f509059fab6d0525f7125f9aaa6be070868e824e7dfa27e83422a537377a33ca47ea035f5c271defcbd183da2db50277ba011423ce17fda43fa390fd8

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/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-06-26
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in riverbed.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    riverbed (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  riverbed!
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.17

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Bnq
+
+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,90 @@
+# Riverbed
+
+A business logic ruby gem, initial release, WIP.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'riverbed'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install riverbed
+
+## Usage
+
+### Min example:
+```ruby
+require "riverbed"
+
+class Step1 < Riverbed::Step
+  def execute; end
+end
+
+class Flow1 < Riverbed::Flow
+  def steps
+    [
+      Step1
+    ]
+  end
+end
+
+Flow1.run
+```
+
+### Usage example:
+
+```ruby
+require "riverbed"
+
+class Step2 < Riverbed::Step
+  def execute
+    puts flow_data.input + " world" # flow ipnut
+
+    flow_data.add(:abc, 123) # sets key :abc in flow data container
+
+    10
+  end
+end
+
+# gets result of previous step (or input if no previous steps exist)
+# and adds to value of key abc
+# `flow_data.get(:a)` will return nil if key not present, `flow_data.get!(:a)` will raise error if key not preset
+class Step3 < Riverbed::Step
+  def execute
+    flow_data.last_result + flow_data.get(:abc)
+  end
+end
+
+class Flow2 < Riverbed::Flow
+  def steps
+    [
+      Step2,
+      Step3
+    ]
+  end
+end
+
+input = "Hello"
+result = Flow2.run(input, options: {}) # can set `options: { logger: nil }` to skip step execution time logging
+
+puts "Final result: #{result}"
+```
+
+Check tests for more examples
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/softcapybara/riverbed.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "riverbed"
+
+# 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/riverbed.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "logger"
+require "securerandom"
+
+require_relative "riverbed/version"
+require_relative "riverbed/data"
+require_relative "riverbed/step"
+require_relative "riverbed/flow"
+
+module Riverbed
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/riverbed/data.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Riverbed
+  class Data
+    attr_reader :input
+
+    def initialize(input)
+      @input = input
+      @results = []
+      @executed_steps = []
+      @registered = {}
+      @errors ||= []
+    end
+
+    def add_result(step_name, result)
+      executed_steps << step_name
+      results << result
+    end
+
+    def last_result
+      if results.empty?
+        @input
+      else
+        results.last
+      end
+    end
+
+    def add(name, value)
+      registered[name] = value
+    end
+
+    def get(name)
+      registered[name]
+    end
+
+    def get!(name)
+      registered.fetch(name)
+    end
+
+    def add_error(err)
+      @errors << err
+    end
+
+    def last_error
+      @errors.last
+    end
+
+    private
+
+    attr_accessor :results, :registered, :executed_steps, :errors
+  end
+end

data/lib/riverbed/flow.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Riverbed
+  class Flow
+    def initialize(input, options)
+      @logger = options.fetch(:logger, Logger.new($stdout))
+
+      @data = options.fetch(:data_object, Riverbed::Data.new(input))
+    end
+
+    def self.run(input = nil, options: {})
+      new(input, options).run
+    end
+
+    def steps
+      raise NotImplementedError
+    end
+
+    def always
+      []
+    end
+
+    def run
+      begin
+        run_steps(steps)
+      rescue StandardError => e
+        on_error(e)
+        data.add_error(e)
+      end
+
+      run_steps(always)
+
+      data.last_result
+    end
+
+    private
+
+    attr_accessor :logger, :data
+
+    def run_steps(steps)
+      steps.each do |step_class|
+        step = step_class.new(data, logger)
+        next if step.skip?
+
+        log_execution(step.name) do
+          data.add_result(step.name, step.execute)
+        end
+
+        break if step.break_flow?
+      end
+    end
+
+    def log_execution(step_name)
+      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      yield
+      end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      logger&.info("#{log_id} Step #{step_name} executed in #{((end_time - start_time) * 1000).round(2)} ms")
+    end
+
+    def log_id
+      @log_id ||= SecureRandom.urlsafe_base64(8)
+    end
+
+    def on_error(error)
+      logger&.error(error)
+    end
+  end
+end

data/lib/riverbed/step.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Riverbed
+  class Step
+    def initialize(flow_data, logger)
+      @flow_data = flow_data
+      @logger = logger
+    end
+
+    def skip?
+      false
+    end
+
+    def break_flow?
+      false
+    end
+
+    def execute
+      raise NotImplementedError
+    end
+
+    def name
+      self.class.name
+    end
+
+    def log_error(err)
+      @error = err
+    end
+
+    private
+
+    attr_accessor :flow_data, :logger, :error
+  end
+end

data/lib/riverbed/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Riverbed
+  VERSION = "0.1.0"
+end

data/riverbed.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/riverbed/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "riverbed"
+  spec.version       = Riverbed::VERSION
+  spec.authors       = ["BMaczka"]
+  spec.email         = ["bmaczka@hey.com"]
+
+  spec.summary       = "Ruby business logic gem"
+  spec.description   = "Ruby business logic gem"
+  spec.homepage      = "https://github.com/softcapybara/riverbed"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/softcapybara/riverbed"
+  spec.metadata["changelog_uri"] = "https://github.com/softcapybara/riverbed"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: riverbed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BMaczka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-26 00:00:00.000000000 Z
+dependencies: []
+description: Ruby business logic gem
+email:
+- bmaczka@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/riverbed.rb
+- lib/riverbed/data.rb
+- lib/riverbed/flow.rb
+- lib/riverbed/step.rb
+- lib/riverbed/version.rb
+- riverbed.gemspec
+homepage: https://github.com/softcapybara/riverbed
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/softcapybara/riverbed
+  source_code_uri: https://github.com/softcapybara/riverbed
+  changelog_uri: https://github.com/softcapybara/riverbed
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Ruby business logic gem
+test_files: []