pipeable 0.0.1 → 0.1.0

data/lib/pipeable/steps/check.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Pipeable
+  module Steps
+    # Checks if operation is true and then answers success (passthrough) or failure (with argument).
+    class Check < Abstract
+      def initialize(operation, message, **)
+        super(**)
+        @operation = operation
+        @message = message
+      end
+
+      def call result
+        result.bind do |arguments|
+          answer = question arguments
+          answer == true || answer.is_a?(Success) ? result : Failure(arguments)
+        end
+      end
+
+      private
+
+      attr_reader :operation, :message
+
+      def question arguments
+        splat = marameters.categorize operation.method(message).parameters, arguments
+        operation.public_send(message, *splat.positionals, **splat.keywords, &splat.block)
+      end
+    end
+  end
+end

data/lib/pipeable/steps/container.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "dry/container"
+
+module Pipeable
+  module Steps
+    # Registers default steps.
+    module Container
+      extend Dry::Container::Mixin
+
+      register(:as) { As }
+      register(:bind) { Bind }
+      register(:check) { Check }
+      register(:fmap) { Fmap }
+      register(:insert) { Insert }
+      register(:map) { Map }
+      register(:merge) { Merge }
+      register(:orr) { Or }
+      register(:tee) { Tee }
+      register(:to) { To }
+      register(:try) { Try }
+      register(:use) { Use }
+      register(:validate) { Validate }
+    end
+  end
+end

data/lib/pipeable/steps/fmap.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Pipeable
+  module Steps
+    # Wraps Dry Monads `#fmap` method as a step.
+    class Fmap < Abstract
+      def call(result) = result.fmap { |input| base_block.call input }
+    end
+  end
+end

data/lib/pipeable/steps/insert.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Pipeable
+  module Steps
+    # Inserts elements before, after, or around input.
+    class Insert < Abstract
+      LAST = -1
+
+      def initialize(*positionals, at: LAST, **)
+        super(*positionals, **)
+        @value = positionals.empty? ? base_keywords : positionals.flatten
+        @at = at
+      end
+
+      def call result
+        result.fmap do |input|
+          cast = input.is_a?(Array) ? input : [input]
+          value.is_a?(Array) ? cast.insert(at, *value) : cast.insert(at, value)
+        end
+      end
+
+      private
+
+      attr_reader :value, :at
+    end
+  end
+end

data/lib/pipeable/steps/map.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Pipeable
+  module Steps
+    # Maps over a collection, processing each element, and answering a new result.
+    class Map < Abstract
+      def call(result) = result.fmap { |collection| collection.map(&base_block) }
+    end
+  end
+end

data/lib/pipeable/steps/merge.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Pipeable
+  module Steps
+    # Merges initialized attributes with step argument for use by a subsequent step.
+    class Merge < Abstract
+      def initialize as: :step, **keywords
+        super(**keywords)
+        @as = as
+      end
+
+      def call result
+        result.fmap do |input|
+          if input.is_a? Hash
+            input.merge! base_keywords
+          else
+            {as => input}.merge!(base_keywords)
+          end
+        end
+      end
+
+      private
+
+      attr_reader :as
+    end
+  end
+end

data/lib/pipeable/steps/or.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Pipeable
+  module Steps
+    # Wraps Dry Monads `#or` method as a step.
+    class Or < Abstract
+      def call(result) = result.or { |input| base_block.call input }
+    end
+  end
+end

data/lib/pipeable/steps/tee.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Pipeable
+  module Steps
+    # Messages operation, without any response checks, while passing input through as output.
+    class Tee < Abstract
+      def initialize(operation, *, **)
+        super(*, **)
+        @operation = operation
+      end
+
+      def call result
+        operation.public_send(*base_positionals, **base_keywords)
+        result
+      end
+
+      private
+
+      attr_reader :operation
+    end
+  end
+end

data/lib/pipeable/steps/to.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Pipeable
+  module Steps
+    # Delegates to a non-callable operation which automatically wraps the result if necessary.
+    class To < Abstract
+      def initialize(operation, message, **)
+        super(**)
+        @operation = operation
+        @message = message
+      end
+
+      def call result
+        result.bind do |arguments|
+          splat = marameters.categorize operation.method(message).parameters, arguments
+          wrap operation.public_send(message, *splat.positionals, **splat.keywords, &splat.block)
+        end
+      end
+
+      private
+
+      attr_reader :operation, :message
+
+      def wrap(result) = result.is_a?(Dry::Monads::Result) ? result : Success(result)
+    end
+  end
+end

data/lib/pipeable/steps/try.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pipeable
+  module Steps
+    # Messages a risky operation which may pass or fail.
+    class Try < Abstract
+      def initialize *positionals, catch:, **keywords
+        super(*positionals, **keywords)
+        @catch = catch
+      end
+
+      def call result
+        result.fmap { |operation| operation.public_send(*base_positionals, **base_keywords) }
+      rescue *Array(catch) => error
+        Failure error.message
+      end
+
+      private
+
+      attr_reader :catch
+    end
+  end
+end

data/lib/pipeable/steps/use.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pipeable
+  module Steps
+    # Use another transaction -- or any command -- which answers a result.
+    class Use < Abstract
+      def initialize(operation, **)
+        super(**)
+        @operation = operation
+      end
+
+      def call(result) = result.bind { |input| operation.call input }
+
+      private
+
+      attr_reader :operation
+    end
+  end
+end

data/lib/pipeable/steps/validate.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pipeable
+  module Steps
+    # Validates a result via a callable operation.
+    class Validate < Abstract
+      def initialize(operation, as: :to_h, **)
+        super(**)
+        @operation = operation
+        @as = as
+      end
+
+      def call result
+        result.bind do |payload|
+          value = operation.call payload
+
+          return Failure value if value.failure?
+
+          Success(as ? value.public_send(as) : value)
+        end
+      end
+
+      private
+
+      attr_reader :operation, :as
+    end
+  end
+end

data/lib/pipeable.rb

@@ -1,7 +1,20 @@
-require "pipeable/version"
+# frozen_string_literal: true
 
+require "zeitwerk"
+
+Zeitwerk::Loader.new.then do |loader|
+  loader.tag = File.basename __FILE__, ".rb"
+  loader.push_dir __dir__
+  loader.setup
+end
+
+# Main namespace.
 module Pipeable
-  def pipe(&block)
-    yield self
+  def self.included(descendant) = descendant.include Stepable.new
+
+  def self.loader registry = Zeitwerk::Registry
+    @loader ||= registry.loaders.find { |loader| loader.tag == File.basename(__FILE__, ".rb") }
   end
+
+  def self.with(...) = Stepable.new(...)
 end

data/pipeable.gemspec

@@ -1,22 +1,34 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'pipeable/version'
+# frozen_string_literal: true
 
 Gem::Specification.new do |spec|
-  spec.name          = "pipeable"
-  spec.version       = Pipeable::VERSION
-  spec.authors       = ["Brandon Weaver"]
-  spec.email         = ["keystonelemur@gmail.com"]
-  spec.summary       = %q{A Mock at Unix Piping in Ruby}
-  spec.homepage      = "https://www.github.com/baweaver/pipeable"
-  spec.license       = "MIT"
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.name = "pipeable"
+  spec.version = "0.1.0"
+  spec.authors = ["Brooke Kuhlmann"]
+  spec.email = ["brooke@alchemists.io"]
+  spec.homepage = "https://alchemists.io/projects/pipeable"
+  spec.summary = "An implementation of the Railway Pattern for functional composable pipelines."
+  spec.license = "Hippocratic-2.1"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/bkuhlmann/pipeable/issues",
+    "changelog_uri" => "https://alchemists.io/projects/pipeable/versions",
+    "documentation_uri" => "https://alchemists.io/projects/pipeable",
+    "funding_uri" => "https://github.com/sponsors/bkuhlmann",
+    "label" => "Pipeable",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/bkuhlmann/pipeable"
+  }
+
+  spec.signing_key = Gem.default_key_path
+  spec.cert_chain = [Gem.default_cert_path]
+
+  spec.required_ruby_version = "~> 3.3"
+  spec.add_dependency "dry-container", "~> 0.11"
+  spec.add_dependency "dry-monads", "~> 1.6"
+  spec.add_dependency "marameters", "~> 3.2"
+  spec.add_dependency "refinements", "~> 12.1"
+  spec.add_dependency "zeitwerk", "~> 2.6"
+
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
 end

metadata

@@ -1,99 +1,171 @@
 --- !ruby/object:Gem::Specification
 name: pipeable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
-- Brandon Weaver
-autorequire: 
+- Brooke Kuhlmann
+autorequire:
 bindir: bin
-cert_chain: []
-date: 2014-01-31 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEeDCCAuCgAwIBAgIBATANBgkqhkiG9w0BAQsFADBBMQ8wDQYDVQQDDAZicm9v
+  a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
+  aW8wHhcNMjMwMzIyMTYxNDQxWhcNMjUwMzIxMTYxNDQxWjBBMQ8wDQYDVQQDDAZi
+  cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
+  GRYCaW8wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCro8tj5/E1Hg88
+  f4qfiwPVd2zJQHvdYt4GHVvuHRRgx4HGhJuNp+4BId08RBn7V6V1MW6MY3kezRBs
+  M+7QOQ4b1xNLTvY7FYQB1wGK5a4x7TTokDrPYQxDB2jmsdDYCzVbIMrAvUfcecRi
+  khyGZCdByiiCl4fKv77P12tTT+NfsvXkLt/AYCGwjOUyGKTQ01Z6eC09T27GayPH
+  QQvIkakyFgcJtzSyGzs8bzK5q9u7wQ12MNTjJoXzW69lqp0oNvDylu81EiSUb5S6
+  QzzPxZBiRB1sgtbt1gUbVI262ZDq1gR+HxPFmp+Cgt7ZLIJZAtesQvtcMzseXpfn
+  hpmm0Sw22KGhRAy/mqHBRhDl5HqS1SJp2Ko3lcnpXeFResp0HNlt8NSu13vhC08j
+  GUHU9MyIXbFOsnp3K3ADrAVjPWop8EZkmUR3MV/CUm00w2cZHCSGiXl1KMpiVKvk
+  Ywr1gd2ZME4QLSo+EXUtLxDUa/W3xnBS8dBOuMMz02FPWYr3PN8CAwEAAaN7MHkw
+  CQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFAFgmv0tYMZnItuPycSM
+  F5wykJEVMB8GA1UdEQQYMBaBFGJyb29rZUBhbGNoZW1pc3RzLmlvMB8GA1UdEgQY
+  MBaBFGJyb29rZUBhbGNoZW1pc3RzLmlvMA0GCSqGSIb3DQEBCwUAA4IBgQAX+EGY
+  9RLYGxF1VLZz+G1ACQc4uyrCB6kXwI06kzUa5dF9tPXqTX9ffnz3/W8ck2IQhKzu
+  MKO2FVijzbDWTsZeZGglS4E+4Jxpau1lU9HhOIcKolv6LeC6UdALTFudY+GLb8Xw
+  REXgaJkjzzhkUSILmEnRwEbY08dVSl7ZAaxVI679vfI2yapLlIwpbBgmQTiTvPr3
+  qyyLUno9flYEOv9fmGHunSrM+gE0/0niGTXa5GgXBXYGS2he4LQGgSBfGp/cTwMU
+  rDKJRcusZ12lNBeDfgqACz/BBJF8FLodgk6rGMRZz7+ZmjjHEmpG5bQpR6Q2BuWL
+  XMtYk/QzaWuhiR7pWjiF8jbdd7RO6or0ohq7iFkokz/5xrtQ/vPzU2RQ3Qc6YaKw
+  3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
+  gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
+  -----END CERTIFICATE-----
+date: 2024-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: dry-container
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
+        version: '0.11'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: dry-monads
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: marameters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '3.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: refinements
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description:
 email:
-- keystonelemur@gmail.com
+- brooke@alchemists.io
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.adoc
 files:
-- .gitignore
-- .travis.yml
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
+- LICENSE.adoc
+- README.adoc
 - lib/pipeable.rb
-- lib/pipeable/version.rb
+- lib/pipeable/composable.rb
+- lib/pipeable/pipe.rb
+- lib/pipeable/stepable.rb
+- lib/pipeable/steps/abstract.rb
+- lib/pipeable/steps/as.rb
+- lib/pipeable/steps/bind.rb
+- lib/pipeable/steps/check.rb
+- lib/pipeable/steps/container.rb
+- lib/pipeable/steps/fmap.rb
+- lib/pipeable/steps/insert.rb
+- lib/pipeable/steps/map.rb
+- lib/pipeable/steps/merge.rb
+- lib/pipeable/steps/or.rb
+- lib/pipeable/steps/tee.rb
+- lib/pipeable/steps/to.rb
+- lib/pipeable/steps/try.rb
+- lib/pipeable/steps/use.rb
+- lib/pipeable/steps/validate.rb
 - pipeable.gemspec
-- spec/pipeable_spec.rb
-- spec/spec_helper.rb
-homepage: https://www.github.com/baweaver/pipeable
+homepage: https://alchemists.io/projects/pipeable
 licenses:
-- MIT
-metadata: {}
-post_install_message: 
+- Hippocratic-2.1
+metadata:
+  bug_tracker_uri: https://github.com/bkuhlmann/pipeable/issues
+  changelog_uri: https://alchemists.io/projects/pipeable/versions
+  documentation_uri: https://alchemists.io/projects/pipeable
+  funding_uri: https://github.com/sponsors/bkuhlmann
+  label: Pipeable
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/bkuhlmann/pipeable
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.1
-signing_key: 
+rubygems_version: 3.5.6
+signing_key:
 specification_version: 4
-summary: A Mock at Unix Piping in Ruby
-test_files:
-- spec/pipeable_spec.rb
-- spec/spec_helper.rb
+summary: An implementation of the Railway Pattern for functional composable pipelines.
+test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.travis.yml

@@ -1 +0,0 @@
-language: ruby

data/Gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in pipeable.gemspec
-gemspec
-gem 'coveralls', require: false

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 Brandon Weaver
-
-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

@@ -1,46 +0,0 @@
-# Pipeable
-
-A play at Unix Piping in Ruby for kicks. It helps to break up some more exotic logic and chaining. 
-
-It can be used to play with a value in a method chain and return whatever you want out of the block. Personally I'm
-still toying with how it can be used and working to find clever tricks with it.
-
-_That being said, this is a 5 minute hack. You've been warned._
-
-Piping is simple, we take the object and put a pipe on it:
-```ruby
-1.pipe { |x| "#{x} is great!" }
-# => '1 is great!'
-```
-
-How do you get going with pipe?
-```ruby
-include Pipeable
-```
-...and your object is ready to go!
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'pipeable'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install pipeable
-
-## Usage
-
-Slap a pipe on the end of it!
-
-## Contributing
-
-1. Fork it ( http://github.com/baweaver/pipeable/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"