pipeable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dc4a4b0633e75d9f7cb808863f5001881ed33fa95d986cc3f72578c25b4ff05
-  data.tar.gz: ec83428d78108b3b151f4c78dae01836a49e28307f83b3e0855d7447071bd8d9
+  metadata.gz: adfcbe3f56342f3a92393c79a301f95dfbc71cbf0c46a9be4fb4c2ca0279690a
+  data.tar.gz: c626ab5ea4431bf9c039ee0461a30255d57206a3153ef20017edaaf78ec233e5
 SHA512:
-  metadata.gz: c666e8473268a786ae2c28cb0eb799add88de52c7af88119492b5ba6584c7ff1e42081bff2592f574316f582147d70862db614c8c23b0697f1c846303312138f
-  data.tar.gz: a6a4199e6eff84898ec19f52b48922d97217c0f18bbdb8f68bba58781108bde272ae0c5b946ace2f6db514d1a15655e32aab9ce7590d5a5ccad0e18c51e5c5d5
+  metadata.gz: 25c6943f6b37242819457db49debdc08c6e466464d4f79fa767c523710ab24a8095688edee622eb9a791d11a71d7384fdeeab97eed07d694badd7295a4186042
+  data.tar.gz: 4bdaf170441d0ef85ba66e00941bb15c88b3b3f638690601041f8351b4b0f40c088e9d2e1e872ec1afa4563321649d00ef06e6a4fc25d3547926e5e2093a089d

data/README.adoc

@@ -3,9 +3,8 @@
 :figure-caption!:
 
 :command_pattern_link: link:https://alchemists.io/articles/command_pattern[Command Pattern]
+:containable_link: link:https://alchemists.io/projects/containable[Containable]
 :debug_link: link:https://github.com/ruby/debug[Debug]
-:dry_container_link: link:https://dry-rb.org/gems/dry-container[Dry Container]
-:dry_events_link: link:https://dry-rb.org/gems/dry-events[Dry Events]
 :dry_monads_link: link:https://dry-rb.org/gems/dry-monads[Dry Monads]
 :dry_schema_link: link:https://dry-rb.org/gems/dry-schema[Dry Schema]
 :dry_validation_link: link:https://dry-rb.org/gems/dry-validation[Dry Validation]
@@ -25,8 +24,7 @@ toc::[]
 * Adheres to the {railway_pattern_link}.
 * Provides built-in and customizable domain-specific steps.
 * Provides chainable _pipes_ which can be used to build more complex workflows.
-* Compatible with {dry_monads_link}.
-* Compatible with {infusible_link}.
+* Compatible with the {containable_link}, {infusible_link}, and {dry_monads_link} gems.
 
 == Requirements
 
@@ -415,7 +413,7 @@ module CustomSteps
   end
 end
 
-Pipeable::Steps::Container.register(:join) { CustomSteps::Join }
+Pipeable::Steps::Container.register :join, CustomSteps::Join
 
 include Pipeable
 
@@ -428,27 +426,27 @@ pipe :a, insert(:b), join(""), as(:to_sym)
 
 === Containers
 
-Should you not want the basic steps, need custom steps, or a hybrid of default and custom steps, you can define your own container and provide it as an argument to `.with` when including pipeable behavior. Example:
+Should you not want the basic steps, need custom steps, or a hybrid of default and custom steps, you can define your own container and provide it as an argument to `.[]` when including pipeable behavior. Example:
 
 [source,ruby]
 ----
-require "dry/container"
+require "containable"
 
 module CustomContainer
-  extend Dry::Container::Mixin
+  extend Containable
 
   register :echo, -> result { result }
-  register(:insert) { Pipeable::Steps::Insert }
+  register :insert, Pipeable::Steps::Insert
 end
 
-include Pipeable.with(CustomContainer)
+include Pipeable[CustomContainer]
 
 pipe :a, echo, insert(:b)
 
 # Yields: Success [:a, :b]
 ----
 
-The above is a hybrid example where the `CustomContainer` registers a custom `echo` step along with the default `insert` step to make a new container. This is included when passed in as an argument via `.with` (i.e. `include Pipeable.with(CustomContainer)`).
+The above is a hybrid example where the `CustomContainer` registers a custom `echo` step along with the default `insert` step to make a new container. This is included when passed in as an argument via `.[]` (i.e. `include Pipeable[CustomContainer]`).
 
 Whether you use default, custom, or hybrid steps, you have maximum flexibility using this approach.
 
@@ -479,7 +477,7 @@ bin/console
 The architecture of this gem is built on top of the following concepts and gems:
 
 * {function_composition_link}: Made possible through the use of the `\#>>` and `#<<` methods on the link:https://rubyapi.org/3.1/o/method[Method] and link:https://rubyapi.org/3.1/o/proc[Proc] objects.
-* {dry_container_link}: Allows related dependencies to be grouped together for injection as desired.
+* {containable_link}: Allows related dependencies to be grouped together for injection as desired.
 * {dry_monads_link}: Critical to ensuring the entire pipeline of steps adhere to the {railway_pattern_link} and leans heavily on the `Result` object.
 * link:https://alchemists.io/projects/marameters[Marameters]: Through the use of the `.categorize` method, dynamic message passing is possible by inspecting the operation method's parameters.
 

data/lib/pipeable/{stepable.rb → definer.rb}

@@ -4,15 +4,15 @@ require "dry/monads"
 require "refinements/array"
 
 module Pipeable
-  # Allows an object to pipe steps together to composed a single result.
-  class Stepable < Module
+  # Defines the pipe and and associated step methods for an object.
+  class Definer < Module
     include Dry::Monads[:result]
 
     using Refinements::Array
 
-    def initialize steps = Steps::Container, pipe: Pipe
+    def initialize container = Steps::Container, pipe: Pipe
       super()
-      @steps = steps
+      @container = container
       @pipe = pipe
       @instance_module = Class.new(Module).new
     end
@@ -26,22 +26,20 @@ module Pipeable
 
     private
 
-    attr_reader :steps, :pipe, :instance_module
-
-    def define_pipe
-      local_pipe = pipe
+    attr_reader :container, :pipe, :instance_module
 
+    def define_pipe pipeline = pipe
       instance_module.define_method :pipe do |input, *steps|
         steps.each { |step| steps.supplant step, method(step) if step.is_a? Symbol }
-        local_pipe.call(input, *steps)
+        pipeline.call(input, *steps)
       end
     end
 
     def define_steps
-      instance_module.class_exec steps do |container|
-        container.each_key do |name|
+      instance_module.class_exec container do |dependencies|
+        dependencies.each_key do |name|
           define_method name do |*positionals, **keywords, &block|
-            step = container[name]
+            step = dependencies[name]
             step.is_a?(Proc) ? step : step.new(*positionals, **keywords, &block)
           end
         end

data/lib/pipeable/steps/container.rb

@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
-require "dry/container"
+require "containable"
 
 module Pipeable
   module Steps
     # Registers default steps.
     module Container
-      extend Dry::Container::Mixin
+      extend Containable
 
-      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 }
+      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.rb

@@ -10,11 +10,16 @@ end
 
 # Main namespace.
 module Pipeable
-  def self.included(descendant) = descendant.include Stepable.new
+  def self.included(descendant) = descendant.include Definer.new
 
   def self.loader registry = Zeitwerk::Registry
     @loader ||= registry.loaders.find { |loader| loader.tag == File.basename(__FILE__, ".rb") }
   end
 
-  def self.with(...) = Stepable.new(...)
+  def self.[](container) = Definer.new(container)
+
+  def self.with(...)
+    warn "`#{self.class}.#{__method__}` is deprecated, use `.[]` instead.", category: :deprecated
+    Definer.new(...)
+  end
 end

data/pipeable.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "pipeable"
-  spec.version = "0.1.0"
+  spec.version = "0.2.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/pipeable"
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.cert_chain = [Gem.default_cert_path]
 
   spec.required_ruby_version = "~> 3.3"
-  spec.add_dependency "dry-container", "~> 0.11"
+  spec.add_dependency "containable", "~> 0.0"
   spec.add_dependency "dry-monads", "~> 1.6"
   spec.add_dependency "marameters", "~> 3.2"
   spec.add_dependency "refinements", "~> 12.1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pipeable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,22 +35,22 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-03-03 00:00:00.000000000 Z
+date: 2024-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: dry-container
+  name: containable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement
@@ -120,8 +120,8 @@ files:
 - README.adoc
 - lib/pipeable.rb
 - lib/pipeable/composable.rb
+- lib/pipeable/definer.rb
 - lib/pipeable/pipe.rb
-- lib/pipeable/stepable.rb
 - lib/pipeable/steps/abstract.rb
 - lib/pipeable/steps/as.rb
 - lib/pipeable/steps/bind.rb
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
 summary: An implementation of the Railway Pattern for functional composable pipelines.