crack_pipe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b90ccb391cbc78b10497f1978236cac94de4f715
+  data.tar.gz: 12f9809281e638984c9d59ac340f5cef7e5c6592
+SHA512:
+  metadata.gz: 8e53e038a829b08417c47ab9a961dc76169be2d6ca6393f70ab0bb2e4f1c249a17b2f58851354f1500e55515ab07d0f07060ac14822bb0e440a1c60665dc4168
+  data.tar.gz: 3d4f43c12cc6d2c9af68c2b28395d7fdf4da17bc81afbac25bdd9e07ee34b3051097f54044e330e277d2c03107f3a2e50fd3e5ce48892aed8ce2c18db522aa71

data/LICENSE.txt

@@ -0,0 +1,18 @@
+Copyright (c) 2019 Joshua Hansen
+
+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 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,51 @@
+# CrackPipe
+
+## Introduction
+
+A little over a year ago, I discovered [Trailblazer](http://trailblazer.to) and used its concept of "operations" in a few projects. While I came to enjoy their concept of pipelines and result objects, I felt the entire project was entirely too complex for my use cases. I wanted much simpler pipelines and nesting.
+
+### What's with the name?
+
+Gem names are hard to come by these days. I'd considered something slightly more mature like `half_pipe`, but in the age of appending a codes of conduct to projects, I lean offensive in naming wherever possible. I'm kinda wishing I had named [my factory gem](https://github.com/binarypaladin/toil) `meth_lab` instead.
+
+## Installation
+
+Pretty standard gem stuff.
+
+```
+$ gem install crack_pipe
+```
+
+If you're using [Bundler](https://bundler.io) (and who isn't?) it's likely you'll add this to your `Gemfile` like so:
+
+```
+gem 'crack_pipe'
+```
+
+## Usage
+
+One day I'll write some actual documentation. (Yeah, right.) In the meantime, [the action spec](spec/action_spec.rb) has a pretty good example of steps, always passing, fail tracks, short circuiting, and nesting actions.
+
+## Contributing
+
+### Issue Guidelines
+
+GitHub issues are for bugs, not support. As of right now, there is no official support for this gem. You can try reaching out to the author, [Joshua Hansen](mailto:joshua@epicbanality.com?subject=CrackPipe+sucks) if you're really stuck, but there's a pretty high chance that won't go anywhere at the moment or you'll get a response like this:
+
+> Hi. I'm super busy. It's nothing personal. Check the README first if you haven't already. If you don't find your answer there, it's time to start reading the source. Have fun! Let me know if I screwed something up.
+
+### Pull Request Guidelines
+
+* Include tests with your PRs.
+
+### Code of Conduct
+
+Don't smoke crack.
+
+## License
+
+See [`LICENSE.txt`](LICENSE.txt).
+
+## What if I stop maintaining this?
+
+The codebase is pretty small. That was one of the main design goals. If you can figure out how to use it, I'm sure you can maintain it.

data/lib/crack_pipe/action/result.rb

@@ -0,0 +1,27 @@
+# frozen-string-literal: true
+
+module CrackPipe
+  class Action
+    class Result
+      attr_reader :context, :output
+
+      def initialize(context: {}, output: nil, success:, **)
+        @context = context
+        @output = output
+        @success = success
+      end
+
+      def [](key)
+        @context[key]
+      end
+
+      def failure?
+        !@success
+      end
+
+      def success?
+        @success
+      end
+    end
+  end
+end

data/lib/crack_pipe/action/short_circuit.rb

@@ -0,0 +1,14 @@
+# frozen-string-literal: true
+
+module CrackPipe
+  class Action
+    class ShortCircuit
+      attr_reader :success, :value
+
+      def initialize(value, success = nil)
+        @value = value
+        @success = success
+      end
+    end
+  end
+end

data/lib/crack_pipe/action/step.rb

@@ -0,0 +1,21 @@
+# frozen-string-literal: true
+
+module CrackPipe
+  class Action
+    class Step
+      attr_reader :exec, :context_override, :desc, :output_override, :track
+
+      def initialize(
+        track,
+        exec,
+        output_override = nil,
+        **context_override
+      )
+        @context_override = context_override.dup
+        @exec = exec
+        @output_override = output_override
+        @track = track
+      end
+    end
+  end
+end

data/lib/crack_pipe/action.rb

@@ -0,0 +1,166 @@
+# frozen-string-literal: true
+
+require 'crack_pipe/action/result'
+require 'crack_pipe/action/short_circuit'
+require 'crack_pipe/action/step'
+
+module CrackPipe
+  class Action
+    @steps = []
+
+    class << self
+      attr_reader :steps
+
+      def call(context, &blk)
+        new(context, steps, &blk).result
+      end
+
+      def inherited(subclass)
+        subclass.instance_variable_set(:@steps, @steps.dup)
+        super
+      end
+
+      private
+
+      def fail(exec = nil, **kwargs, &blk)
+        step(exec, kwargs.merge(track: :fail), &blk)
+      end
+
+      def pass(exec = nil, **kwargs, &blk)
+        step(exec, kwargs.merge(output_override: true), &blk)
+      end
+
+      def step(
+        exec = nil,
+        output_override: nil,
+        track: :default,
+        **opts,
+        &blk
+      )
+        if block_given?
+          raise ArgumentError, '`exec` must be `nil` with a block' unless
+            exec.nil?
+          exec = blk
+        end
+        @steps += [Step.new(track, exec, output_override, opts)]
+      end
+    end
+
+    attr_reader :history, :result
+
+    def initialize(context, steps = self.class.steps, &blk)
+      @history = []
+      _result!(context.dup, steps.dup, &blk)
+    end
+
+    # NOTE: While this hook does nothing by default, it is here with the
+    # intention of dealing with potential default values being generated either
+    # for output or adding values to the context. A common example would be
+    # returning some kind of default failure object in place of a literal `nil`
+    # or `false`.
+    def after_step(output, _context, _step)
+      output
+    end
+
+    def fail!(value)
+      ShortCircuit.new(value, false)
+    end
+
+    def pass!(value)
+      ShortCircuit.new(value, true)
+    end
+
+    def step_failure?(output)
+      case output
+      when Result
+        output.failure?
+      else
+        !output
+      end
+    end
+
+    def to_a
+      history.dup
+    end
+
+    private
+
+    def _action?(obj)
+      obj.is_a?(Class) && obj < Action
+    end
+
+    def _exec_nested!(context, action)
+      @history += action.new(context).history
+      @history.last.tap { |h| context.merge!(h[:context]) }
+    end
+
+    def _exec_step!(context, step)
+      e = step.exec
+      return _exec_nested!(context, e) if _action?(e)
+
+      output =
+        case e
+        when Symbol
+          public_send(e, context, **context)
+        when Proc
+          instance_exec(context, **context, &e)
+        else
+          e.call(context, **context)
+        end
+
+      _wrap_output(after_step(output, context, step), context.dup, step)
+        .tap { |wo| @history << wo }
+    end
+
+    def _exec_steps!(context, steps)
+      next_track = :default
+      steps.map do |s|
+        next unless next_track == s.track
+        _exec_step!(context, s).tap do |wrapped_output|
+          next_track =
+            wrapped_output[:short_circuit] ? nil : wrapped_output[:next_track]
+        end
+      end.compact.last
+    end
+
+    def _output_hash(output, step)
+      output = step.output_override unless step.output_override.nil?
+      success = step.track != :fail && !step_failure?(output)
+      case output
+      when ShortCircuit
+        {
+          output: output.value,
+          short_circuit: true,
+          success: output.success.nil? ? success : output.success
+        }
+      else
+        {
+          output: output,
+          short_circuit: false,
+          success: success
+        }
+      end
+    end
+
+    # NOTE: The optional block here allows you to wrap the the execution in
+    # external functionality, such as a default `rescue` or something like a
+    # database transaction if it's necessary to span multiple steps.
+    def _result!(context, steps)
+      if block_given?
+        yield(@result = Result.new(_exec_steps!(context, steps)))
+      else
+        @result = Result.new(_exec_steps!(context, steps))
+      end
+      @result
+    end
+
+    def _wrap_output(output, context, step)
+      wrapped_output = _output_hash(after_step(output, context, step), step)
+      {
+        exec: step.exec,
+        next_track: wrapped_output[:success] ? :default : :fail,
+        context: context
+      }.merge(wrapped_output)
+    end
+  end
+end

data/lib/crack_pipe/version.rb

@@ -0,0 +1,12 @@
+# frozen-string-literal: true
+
+module CrackPipe
+  MAJOR = 0
+  MINOR = 1
+  TINY  = 0
+  VERSION = [MAJOR, MINOR, TINY].join('.').freeze
+
+  def self.version
+    VERSION
+  end
+end

data/lib/crack_pipe.rb

@@ -0,0 +1,4 @@
+# frozen-string-literal: true
+
+require 'crack_pipe/action'
+require 'crack_pipe/version'

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: crack_pipe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua
+- Hansen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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'
+description: Pipelines... on crack I guess.
+email:
+- joshua@epicbanality.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/crack_pipe.rb
+- lib/crack_pipe/action.rb
+- lib/crack_pipe/action/result.rb
+- lib/crack_pipe/action/short_circuit.rb
+- lib/crack_pipe/action/step.rb
+- lib/crack_pipe/version.rb
+homepage: https://github.com/binarypaladin/crack_pipe
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.4
+signing_key: 
+specification_version: 4
+summary: Pipelines... on crack I guess.
+test_files: []