shifty 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46d6ec38da041475fa499d8d79042e685d9eb3c4ab1dbce24ab70579b466acc2
-  data.tar.gz: b8cc19ee79ad7321e113f8ec7311f52020566506ff8a7e84dc36c6eb840e57dd
+  metadata.gz: df1f9b8ed700b93a733b07ef8316d40f4c0651f993e7ebdc81534ce2816f35da
+  data.tar.gz: 18ef18bf4bfa01d84f13ee3cf3151a1bf0475dd25b5c5cdbfd6555fa6a777de9
 SHA512:
-  metadata.gz: c11b09e67ff91d611ddedff9404d81b043f9211e0a96a452ff6d9fde0480955e65050b00fb6a71cabc867e35ef3ae28815943d371b56c1a3a1a425a80e5847f0
-  data.tar.gz: 46d0ef549da9cdfc57043b2563d1a4549abb44abffbe424228b18d97758e871e1ad279c9e5d8824d584a1ab66e43100a514c5ccb82fcce161280318d06762a53
+  metadata.gz: 13217cff868f2d1fb1d8dd7d0f0d149abeac5130db3740765dfaab4d178c0d95821e02406e270a6159e181591827fda9c5b9e903cf1313df07244cfefcc81329
+  data.tar.gz: 5a010dbc027c6c0c7295e2c63fd90a2a58deba458664c351410ad075e5ba9ca15f088ad44ca420dd31d6e3e6d26e1bda64f4750ba061f4c15737da456354acee

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.vscode/
 /.yardoc
 /_yardoc/
 /coverage/
@@ -10,4 +11,6 @@
 # rspec failure tracking
 .rspec_status
 
+.rubocop.yml
+
 Gemfile.lock

data/.standard.yml

@@ -0,0 +1,3 @@
+ignore:
+  - '**/*':
+    - Layout/ExtraSpacing

data/Gemfile

@@ -1,6 +1,9 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-git_source(:github) {|repo_name| 'https://github.com/#{repo_name}' }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem "guard"
+gem "guard-rspec", require: false
 
 # Specify your gem's dependencies in shifty.gemspec
 gemspec

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/shifty.svg)](https://badge.fury.io/rb/shifty)
-[![Build Status](https://travis-ci.org/joelhelbling/shifty.png)](https://travis-ci.org/joelhelbling/shifty)
+[![Tests](https://github.com/joelhelbling/shifty/actions/workflows/ruby.yml/badge.svg)](https://github.com/joelhelbling/shifty/actions/workflows/ruby.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/950ded888350c1124348/maintainability)](https://codeclimate.com/github/joelhelbling/shifty/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/950ded888350c1124348/test_coverage)](https://codeclimate.com/github/joelhelbling/shifty/test_coverage)
 
@@ -21,7 +21,7 @@ And then execute:
 
 Or install it yourself:
 
-    $ gem install steplader
+    $ gem install shifty
 
 And then use it:
 
@@ -344,7 +344,7 @@ worker simply provides a nil.
 
 ## Origins of Shifty
 
-Shifty was Shifty, which grew out of experimentation with Ruby fibers, after reading
+Shifty was [Stepladder](https://github.com/joelhelbling/stepladder), which grew out of experimentation with Ruby fibers, after reading
 [Dave Thomas' demo of Ruby fibers](http://pragdave.me/blog/2007/12/30/pipelines-using-fibers-in-ruby-19/),
 wherein he created a pipeline of fiber processes, emulating the style and syntax of the
 \*nix command line.  I noticed that, courtesy of fibers' extremely low surface area,

data/Rakefile

@@ -1,6 +1,7 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-dinky

data/lib/shifty/dsl.rb

@@ -2,7 +2,7 @@ module Shifty
   class WorkerInitializationError < StandardError; end
 
   module DSL
-    def source_worker(argument=nil, &block)
+    def source_worker(argument = nil, &block)
       ensure_correct_arity_for!(argument, block)
 
       series = series_from(argument)
@@ -13,11 +13,10 @@ module Shifty
       Worker.new do
         series.each(&callable)
 
-        while true do
+        loop do
           handoff nil
         end
       end
-
     end
 
     def relay_worker(&block)
@@ -28,10 +27,10 @@ module Shifty
       end
     end
 
-    def side_worker(mode=:normal, &block)
+    def side_worker(mode = :normal, &block)
       ensure_regular_arity(block)
 
-      Worker.new do |value|
+      Worker.new(tags: [:side_effect]) do |value|
         value.tap do |v|
           used_value = mode == :hardened ?
             Marshal.load(Marshal.dump(v)) : v
@@ -41,15 +40,15 @@ module Shifty
       end
     end
 
-    def filter_worker(argument=nil, &block)
-      if (block && argument.respond_to?(:call))
-        throw_with 'You cannot supply two callables'
+    def filter_worker(argument = nil, &block)
+      if block && argument.respond_to?(:call)
+        throw_with "You cannot supply two callables"
       end
       callable = argument.respond_to?(:call) ? argument : block
       ensure_callable(callable)
 
       Worker.new do |value, supply|
-        while value && !callable.call(value) do
+        while value && !callable.call(value)
           value = supply.shift
         end
         value
@@ -59,23 +58,23 @@ module Shifty
     class BatchContext < OpenStruct
       def batch_complete?(value, collection)
         value.nil? ||
-          !! batch_full.call(value, collection)
+          !!batch_full.call(value, collection)
       end
     end
 
     def batch_worker(options = {gathering: 1}, &block)
       ensure_regular_arity(block) if block
       batch_full = block ||
-        Proc.new { |_, batch| batch.size >= options[:gathering] }
+        proc { |_, batch| batch.size >= options[:gathering] }
 
-      batch_context = BatchContext.new({ batch_full: batch_full })
+      batch_context = BatchContext.new({batch_full: batch_full})
 
       Worker.new(context: batch_context) do |value, supply, context|
         if value
           context.collection = [value]
           until context.batch_complete?(
-              context.collection.last,
-              context.collection
+            context.collection.last,
+            context.collection
           )
             context.collection << supply.shift
           end
@@ -92,7 +91,7 @@ module Shifty
           value
         else
           parts = [block.call(value)].flatten
-          while parts.size > 1 do
+          while parts.size > 1
             handoff parts.shift
           end
           parts.shift
@@ -100,7 +99,7 @@ module Shifty
       end
     end
 
-    def trailing_worker(trail_length=2)
+    def trailing_worker(trail_length = 2)
       trail = []
       Worker.new do |value, supply|
         if value
@@ -126,12 +125,12 @@ module Shifty
     private
 
     def throw_with(*msg)
-      raise WorkerInitializationError.new([msg].flatten.join(' '))
+      raise WorkerInitializationError.new([msg].flatten.join(" "))
     end
 
     def ensure_callable(callable)
-      unless callable && callable.respond_to?(:call)
-        throw_with 'You must supply a callable'
+      unless callable&.respond_to?(:call)
+        throw_with "You must supply a callable"
       end
     end
 
@@ -147,20 +146,17 @@ module Shifty
       return unless block
       if argument
         ensure_regular_arity(block)
-      else
-        if block.arity > 0
-          throw_with \
-            'Source worker cannot accept any arguments (arity == 0)'
-        end
+      elsif block.arity > 0
+        throw_with \
+          "Source worker cannot accept any arguments (arity == 0)"
       end
     end
 
     def series_from(series)
       return if series.nil?
-      case
-      when series.respond_to?(:to_a)
+      if series.respond_to?(:to_a)
         series.to_a
-      when series.respond_to?(:scan)
+      elsif series.respond_to?(:scan)
         series.scan(/./)
       else
         [series]
@@ -170,11 +166,10 @@ module Shifty
     def setup_callable_for(block, series)
       return block unless series
       if block
-        return Proc.new { |value| handoff block.call(value) }
+        proc { |value| handoff block.call(value) }
       else
-        return Proc.new { |value| handoff value }
+        proc { |value| handoff value }
       end
     end
-
   end
 end

data/lib/shifty/gang.rb

@@ -1,46 +1,52 @@
-require 'shifty/roster'
+require "shifty/roster"
+require "shifty/taggable"
 
 module Shifty
   class Gang
-    attr_accessor :workers
+    attr_reader :roster, :tags
 
-    def initialize(workers=[])
-      link(workers + [])
-    end
+    include Taggable
 
-    def roster
-      workers
+    def initialize(workers = [], p = {})
+      @roster = Roster.new(workers)
+      self.criteria = p[:criteria]
+      self.tags     = p[:tags]
     end
 
     def shift
-      workers.last.shift
+      if criteria_passes?
+        roster.last.shift
+      else
+        roster.first.supply.shift
+      end
     end
 
     def ready_to_work?
-      workers.first.ready_to_work?
+      roster.first.ready_to_work?
     end
 
     def supply
-      workers.first.supply
+      roster.first.supply
     end
 
-    def supply=(source_queue)
-      workers.first.supply = source_queue
+    def supply=(supplier)
+      roster.first.supply = supplier
     end
 
-    def supplies(subscribing_party)
-      subscribing_party.supply = self
+    def supplies(subscribing_worker)
+      subscribing_worker.supply = self
+      subscribing_worker
     end
-    alias_method :"|", :supplies
+    alias_method :|, :supplies
 
-    private
+    def append(worker)
+      roster << worker
+    end
 
-    def link(workers)
-      @workers = [workers.shift]
-      while worker = workers.shift do
-        Roster[self] << worker
+    class << self
+      def [](*workers)
+        new workers
       end
     end
-
   end
 end

data/lib/shifty/roster.rb

@@ -1,33 +1,30 @@
+require "forwardable"
+
 module Shifty
-  module Roster
-    class << self
-      def [](gang)
-        RosterizedGang.new(gang)
-      end
-    end
-  end
+  class Roster
+    extend Forwardable
 
-  class RosterizedGang
-    attr_reader :gang
+    attr_reader :workers
 
-    def initialize(gang)
-      @gang = gang
+    def initialize(workers = [])
+      @workers = []
+      workers.each do |worker|
+        push worker
+      end
     end
 
-    def workers
-      gang.workers
-    end
+    def_delegators :workers, :first, :last
 
     def push(worker)
       if worker
-        worker.supply = workers.last
+        worker.supply = workers.last unless workers.empty?
         workers << worker
       end
     end
-    alias_method :"<<", :push
+    alias_method :<<, :push
 
     def pop
-      gang.workers.pop.tap do |popped|
+      workers.pop.tap do |popped|
         popped.supply = nil
       end
     end

data/lib/shifty/taggable.rb

@@ -0,0 +1,21 @@
+module Shifty
+  module Taggable
+    def tags=(tag_arg)
+      @tags = [tag_arg].flatten.compact
+    end
+
+    def criteria=(criteria_arg)
+      @criteria = [criteria_arg].flatten.compact
+    end
+
+    def has_tag?(tag)
+      @tags.include? tag
+    end
+
+    def criteria_passes?
+      return true if @criteria.empty?
+
+      @criteria.all? { |c| c.call(self) }
+    end
+  end
+end

data/lib/shifty/version.rb

@@ -1,3 +1,3 @@
 module Shifty
-  VERSION = "0.3.0"
+  VERSION = "0.4.1"
 end

data/lib/shifty/worker.rb

@@ -1,18 +1,18 @@
-require 'ostruct'
+require "ostruct"
+require "shifty/taggable"
 
 module Shifty
   class Worker
-    attr_reader :supply
-
-    def initialize(p={}, &block)
-      @supply   = p[:supply]
-      @task     = block || p[:task]
-      @context  = p[:context] || OpenStruct.new
-      # don't define default task here
-      # because we want to allow for
-      # an initialized worker to have
-      # a task injected, including
-      # method-based tasks.
+    attr_reader :supply, :tags
+
+    include Shifty::Taggable
+
+    def initialize(p = {}, &block)
+      @supply       = p[:supply]
+      @task         = block || p[:task]
+      @context      = p[:context] || OpenStruct.new
+      self.criteria = p[:criteria]
+      self.tags     = p[:tags]
     end
 
     def shift
@@ -24,11 +24,11 @@ module Shifty
       @task && (supply || !task_accepts_a_value?)
     end
 
-    def supplies(subscribing_party)
-      subscribing_party.supply = self
-      subscribing_party
+    def supplies(subscribing_worker)
+      subscribing_worker.supply = self
+      subscribing_worker
     end
-    alias_method :"|", :supplies
+    alias_method :|, :supplies
 
     def supply=(supplier)
       raise WorkerError.new("Worker is a source, and cannot accept a supply") unless suppliable?
@@ -50,16 +50,20 @@ module Shifty
     end
 
     def workflow
-      @my_little_machine ||= Fiber.new do
+      @my_little_machine ||= Fiber.new {
         loop do
-          value = supply && supply.shift
-          Fiber.yield @task.call(value, supply, @context)
+          value = supply&.shift
+          if criteria_passes?
+            Fiber.yield @task.call(value, supply, @context)
+          else
+            Fiber.yield value
+          end
         end
-      end
+      }
     end
 
     def default_task
-      Proc.new { |value| value }
+      proc { |value| value }
     end
 
     def task_accepts_a_value?
@@ -67,13 +71,12 @@ module Shifty
     end
 
     def task_method_exists?
-      self.methods.include? :task
+      methods.include? :task
     end
 
     def task_method_accepts_a_value?
-      self.method(:task).arity > 0
+      method(:task).arity > 0
     end
-
   end
 
   class WorkerError < StandardError; end

data/lib/shifty.rb

@@ -1,5 +1,5 @@
-require_relative 'shifty/version'
-require_relative 'shifty/worker'
-require_relative 'shifty/gang'
-require_relative 'shifty/roster'
-require_relative 'shifty/dsl'
+require_relative "shifty/version"
+require_relative "shifty/worker"
+require_relative "shifty/gang"
+require_relative "shifty/roster"
+require_relative "shifty/dsl"

data/shifty.gemspec

@@ -1,29 +1,29 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'shifty/version'
+require "shifty/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'shifty'
-  spec.version       = Shifty::VERSION
-  spec.authors       = ['Joel Helbling']
-  spec.email         = ['joel@joelhelbling.com']
+  spec.name = "shifty"
+  spec.version = Shifty::VERSION
+  spec.authors = ["Joel Helbling"]
+  spec.email = ["joel@joelhelbling.com"]
 
-  spec.summary       = %q{A functional framework aimed at extremely low coupling}
-  spec.description   = %q{Shifty provides tools for coordinating simple workers which consume a supplying queue and emit corresponding work products, valuing pure functions, carefully isolated side effects, and extremely low coupling.}
-  spec.homepage      = 'https://github.com/joelhelbling/shifty'
-  spec.license       = 'MIT'
+  spec.summary = "A functional framework aimed at extremely low coupling"
+  spec.description = "Shifty provides tools for coordinating simple workers which consume a supplying queue and emit corresponding work products, valuing pure functions, carefully isolated side effects, and extremely low coupling."
+  spec.homepage = "https://github.com/joelhelbling/shifty"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|\.github|\.standard\.yml|Guardfile|_config\.yml)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.1'
-  spec.add_development_dependency 'rspec-given', '~> 3.8'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "rspec-given", "~> 3.8"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "standard", "~> 1.1"
+  spec.add_development_dependency "codeclimate-test-reporter"
 end

metadata

@@ -1,57 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: shifty
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Joel Helbling
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-04-01 00:00:00.000000000 Z
+date: 2022-10-03 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: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rspec-given
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -105,11 +105,13 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".standard.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- _config.yml
 - bin/console
 - bin/setup
 - docs/shifty/worker.md
@@ -117,6 +119,7 @@ files:
 - lib/shifty/dsl.rb
 - lib/shifty/gang.rb
 - lib/shifty/roster.rb
+- lib/shifty/taggable.rb
 - lib/shifty/version.rb
 - lib/shifty/worker.rb
 - pkg/.gitkeep
@@ -125,7 +128,7 @@ homepage: https://github.com/joelhelbling/shifty
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -140,9 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: A functional framework aimed at extremely low coupling
 test_files: []

data/.travis.yml

@@ -1,17 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=de10d77685b449162f3f3d568e1ab75d94c0f281afceee218502cf0995e49aa6
-sudo: false
-language: ruby
-rvm:
-  - 2.5.0
-  - jruby-19mode
-before_install: gem install bundler -v 1.16.1
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-script:
-  - bundle exec rspec
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT