standard-procedure-plumbing 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45b26855ceaf54673b25fe4ca63a5e52ab302f585f7653731f444b312dec233f
-  data.tar.gz: 936af082c395b80018878f9a53842505473f2d9978c97fafc88aea48102153e4
+  metadata.gz: a0bfd8678cd958f92a30d6c1879e664ac790637b400a2fd73302a7ed60a3b450
+  data.tar.gz: f06824216f1d2da14fa645b0f246106180e6e8e69f8fa7d5526e8a343ac77923
 SHA512:
-  metadata.gz: 1cce27319493e32407381bb3623734a5bcd87bd1fa986c83f6d8790afb05376c144f994adfd5e094dd9377ad11ee6bdef3d2348ec279d9f378706d52da49362c
-  data.tar.gz: 6594ec35d9753979414b79c524a27d3c033bf96739ec750a0774c1cbb0d7b6dc97ec7e64245026f93f42c8083cce1da91fa772cbcecc61edecba7e931e085c10
+  metadata.gz: ac2e9872aba1ecb6c4f2831ee6da3689afdcf1162c5bc0b65eaa2298ae1a00f4d698fb7909c34e10daa6b14cd10bcd8ab54cd92839fab7a1107cd93de831c2c5
+  data.tar.gz: 64f585e329a112504b692b788d6b6c9562bc188eb9c621a33001f2aed69d92c6260909c8a3df174436bfeda345791b7ca370afb09fdad2d281d466efcb0784fc

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.1.2] - 2024-08-14
+
+ - Removed dependencies
+ - Removed Ractor-based concurrent pipe (as I don't trust it yet)
+
 ## [0.1.1] - 2024-08-14
 
 - Tidied up the code

data/README.md

@@ -95,8 +95,6 @@ end
 # => "two"
 ```
 
-There is also [Plumbing::Concurrent::Pipe](/lib/plumbing/concurrent/pipe.rb) that uses a Ractor to dispatch events.  Use with caution as Ractors are still experimental, plus they have strict conditions about the data that can be passed across Ractor boundaries.  
-
 ## Plumbing::Chain - a chain of operations that occur in sequence
 
 Define a sequence of operations that proceed in order, passing their output from one operation as the input to another.

data/checksums/standard-procedure-plumbing-0.1.2.gem.sha512

@@ -0,0 +1 @@
+18d6d3138d2879c1672ab60b1534a6bc382e99a67adb4f8eff9c60ffb96b78b148bffac54ff1f7e78a2da1fc36d000041806b3a73993416c62279ef3ca09beba

data/lib/plumbing/blocked_pipe.rb

@@ -1,4 +1,3 @@
-require "dry/types"
 require_relative "error"
 require_relative "event"
 
@@ -7,14 +6,6 @@ module Plumbing
   # This class is "blocked", in that it won't push any events to registered observers.
   # Instead, this is the basis for subclasses like [Plumbing::Pipe] which actually allow events to flow through them.
   class BlockedPipe
-    module Types
-      include Dry::Types()
-      # Events must be Plumbing::Event instances or subclasses
-      Event = Instance(Plumbing::Event)
-      # Observers must have a `call` method
-      Observer = Interface(:call)
-    end
-
     # Create a new BlockedPipe
     # Subclasses should call `super()` to ensure the pipe is initialised corrected
     def initialize
@@ -25,13 +16,13 @@ module Plumbing
     # @param event [Plumbing::Event] the event to push into the pipe
     # Subclasses should implement this method
     def << event
-      raise PipeIsBlocked
+      raise Plumbing::PipeIsBlocked
     end
 
     # A shortcut to creating and then pushing an event
     # @param event_type [String] representing the type of event this is
     # @param data [Hash] representing the event-specific data to be passed to the observers
-    def notify event_type, **data
+    def notify event_type, data = nil
       Event.new(type: event_type, data: data).tap do |event|
         self << event
       end
@@ -42,11 +33,10 @@ module Plumbing
     # @param &block [Block] (optional)
     # @return an object representing this observer (dependent upon the implementation of the pipe itself)
     # Either a `callable` or a `block` must be supplied.  If the latter, it is converted to a [Proc]
-    def add_observer callable = nil, &block
-      callable ||= block.to_proc
-      Types::Observer[callable].tap do |observer|
-        @observers << observer
-      end
+    def add_observer observer = nil, &block
+      observer ||= block.to_proc
+      raise Plumbing::InvalidObserver.new "observer_does_not_respond_to_call" unless observer.respond_to? :call
+      @observers << observer
     end
 
     # Remove an observer from this pipe
@@ -83,7 +73,7 @@ module Plumbing
     # @return [Plumbing::Event]
     # Subclasses should implement this method
     def get_next_event
-      raise PipeIsBlocked
+      raise Plumbing::PipeIsBlocked
     end
 
     # Start the event loop

data/lib/plumbing/error.rb

@@ -9,10 +9,10 @@ module Plumbing
   class PostConditionError < Error; end
 
   # Error raised because an invalid [Event] object was pushed into the pipe
-  InvalidEvent = Dry::Types::ConstraintError
+  class InvalidEvent < Error; end
 
   # Error raised because an invalid observer was registered
-  InvalidObserver = Dry::Types::ConstraintError
+  class InvalidObserver < Error; end
 
   # Error raised because a BlockedPipe was used instead of an actual implementation of a Pipe
   class PipeIsBlocked < Plumbing::Error; end

data/lib/plumbing/event.rb

@@ -1,17 +1,5 @@
-require "dry/types"
-require "dry/struct"
-
 module Plumbing
   # An immutable data structure representing an Event
-  class Event < Dry::Struct
-    module Types
-      include Dry::Types()
-      SequenceNumber = Strict::Integer
-      Type = Strict::String
-      Data = Strict::Hash.map(Coercible::Symbol, Nominal::Any).default({}.freeze)
-    end
-
-    attribute :type, Types::Type
-    attribute :data, Types::Data
+  Event = Data.define :type, :data do
   end
 end

data/lib/plumbing/filter.rb

@@ -1,14 +1,9 @@
-require "dry/types"
 require_relative "blocked_pipe"
 
 module Plumbing
   # A pipe that filters events from a source pipe
   class Filter < BlockedPipe
-    module Types
-      include Dry::Types()
-      Source = Instance(Plumbing::BlockedPipe)
-      EventTypes = Array.of(Plumbing::Event::Types::Type)
-    end
+    class InvalidFilter < Error; end
 
     # Chain this pipe to the source pipe
     # @param source [Plumbing::BlockedPipe]
@@ -16,9 +11,11 @@ module Plumbing
     # @param rejects [Array[String]] event types that this filter will not allow through
     def initialize source:, accepts: [], rejects: []
       super()
-      @accepted_event_types = Types::EventTypes[accepts]
-      @rejected_event_types = Types::EventTypes[rejects]
-      Types::Source[source].add_observer do |event|
+      raise InvalidFilter.new "source must be a Plumbing::BlockedPipe descendant" unless source.is_a? Plumbing::BlockedPipe
+      raise InvalidFilter.new "accepts and rejects must be arrays" unless accepts.is_a?(Array) && rejects.is_a?(Array)
+      @accepted_event_types = accepts
+      @rejected_event_types = rejects
+      source.add_observer do |event|
         filter_and_republish(event)
       end
     end
@@ -26,6 +23,7 @@ module Plumbing
     private
 
     def filter_and_republish event
+      raise InvalidEvent.new "event is not a Plumbing::Event" unless event.is_a? Plumbing::Event
       return nil if @accepted_event_types.any? && !@accepted_event_types.include?(event.type)
       return nil if @rejected_event_types.include? event.type
       dispatch event

data/lib/plumbing/pipe.rb

@@ -11,7 +11,8 @@ module Plumbing
     end
 
     def << event
-      @fiber.resume Types::Event[event]
+      raise Plumbing::InvalidEvent.new "event is not a Plumbing::Event" unless event.is_a? Plumbing::Event
+      @fiber.resume event
     end
 
     def shutdown

data/lib/plumbing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Plumbing
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/plumbing.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "dry/types"
 module Plumbing
   require_relative "plumbing/version"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: standard-procedure-plumbing
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rahoul Baruah
@@ -9,36 +9,8 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2024-08-14 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: dry-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: dry-struct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: An event pipeline
+dependencies: []
+description: A composable event pipeline and sequential pipelines of operations
 email:
 - rahoulb@echodek.co
 executables: []
@@ -51,15 +23,14 @@ files:
 - ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - checksums/standard-procedure-plumbing-0.1.1.gem.sha512
+- checksums/standard-procedure-plumbing-0.1.2.gem.sha512
 - lib/plumbing.rb
 - lib/plumbing/blocked_pipe.rb
 - lib/plumbing/chain.rb
-- lib/plumbing/concurrent/pipe.rb
 - lib/plumbing/error.rb
 - lib/plumbing/event.rb
 - lib/plumbing/filter.rb
@@ -71,8 +42,8 @@ licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://theartandscienceofruby.com
-  source_code_uri: https://github.com
-  changelog_uri: https://github.com
+  source_code_uri: https://github.com/standard-procedure/plumbing
+  changelog_uri: https://github.com/standard-procedure/plumbing/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -91,5 +62,5 @@ requirements: []
 rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: An event pipeline
+summary: Plumbing - various pipelines for your ruby application
 test_files: []

data/Guardfile

@@ -1,32 +0,0 @@
-ignore(/bin/, /log/, /public/, /storage/, /tmp/)
-
-group :formatting do
-  guard :standardrb, fix: true, all_on_start: true, progress: true do
-    watch(/.+\.rb$/)
-    watch(/.+\.thor$/)
-    watch(/.+\.rake$/)
-    watch(/Guardfile$/)
-    watch(/Rakefile$/)
-    watch(/Gemfile$/)
-  end
-end
-
-group :development do
-  guard :rspec, cmd: "bundle exec rspec" do
-    watch("spec/.+_helper.rb") { "spec" }
-    watch(%r{^spec/.+_spec\.rb$})
-    watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
-  end
-
-  guard :bundler do
-    require "guard/bundler"
-    require "guard/bundler/verify"
-    helper = Guard::Bundler::Verify.new
-
-    files = ["Gemfile"]
-    files += Dir["*.gemspec"] if files.any? { |f| helper.uses_gemspec?(f) }
-
-    # Assume files are symlinked from somewhere
-    files.each { |file| watch(helper.real_path(file)) }
-  end
-end

data/lib/plumbing/concurrent/pipe.rb

@@ -1,72 +0,0 @@
-require "dry/types"
-require_relative "../blocked_pipe"
-
-module Plumbing
-  module Concurrent
-    class Pipe < Plumbing::BlockedPipe
-      module Types
-        include Dry::Types()
-        # Observers must be Ractors
-        Observer = Instance(Ractor)
-      end
-
-      def initialize
-        super
-        @queue = Ractor.new(self) do |instance|
-          while (message = Ractor.receive) != :shutdown
-            case message.first
-            when :add_observer then instance.send :add_observing_ractor, message.last
-            when :is_observer? then Ractor.yield(instance.send(:is_observing_ractor?, message.last))
-            when :remove_observer then instance.send :remove_observing_ractor, message.last
-            else instance.send :dispatch, message.last
-            end
-          end
-        end
-      end
-
-      def add_observer ractor = nil, &block
-        Plumbing::Concurrent::Pipe::Types::Observer[ractor].tap do |observer|
-          @queue << [:add_observer, observer]
-        end
-      end
-
-      def remove_observer ractor = nil, &block
-        @queue << [:remove_observer, ractor]
-      end
-
-      def is_observer? ractor
-        @queue << [:is_observer?, ractor]
-        @queue.take
-      end
-
-      def << event
-        @queue << [:dispatch, Plumbing::BlockedPipe::Types::Event[event]]
-      end
-
-      def shutdown
-        @queue << :shutdown
-        super
-      end
-
-      private
-
-      def dispatch event
-        @observers.each do |observer|
-          observer << event
-        end
-      end
-
-      def add_observing_ractor observer
-        @observers << observer
-      end
-
-      def is_observing_ractor? observer
-        @observers.include? observer
-      end
-
-      def remove_observing_ractor observer
-        @observers.delete observer
-      end
-    end
-  end
-end