pipey 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5af6b9a3c74fce3126319deb94789a55cbe9e80
+  data.tar.gz: a5fd97c3205c86a00cb2e303093d41a9a203093a
+SHA512:
+  metadata.gz: 8f54f83712ed5d9c3f5a9d91f28cb3ccc3f3b2034327a04932c74d6b5817095c0b0cb1ff31509a29c3918a483d6b07dfc8a7ea1959c4733a592b1d84657c9ae5
+  data.tar.gz: e1e51361b41741ec6cd2fc4923e1eb7a5a205400fe250fe1c92db8ac05c04e3c4294d6d4cf51ee87e22e0af71589ee5dc23e1b4e114ff9cd4a0c9317933fffac

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pipey.gemspec
+gemspec
+gem 'pry'

data/README.md

@@ -0,0 +1,155 @@
+# Pipey
+
+A utility for pipeline operations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pipey'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pipey
+
+## Usage
+
+### `Pipey::Line`
+
+`Pipey::Line` can be used to work with any object in a pipe-line manner.
+
+```ruby
+class MyPipe < Pipey::Line
+  extend Pipey::Steps::Scanner[/^run_/]
+
+  def run_foo(num, multiply:, **)
+    num * multiply
+  end
+
+  def run_bar(num, add:, **)
+    num + add
+  end
+end
+
+MyPipe.call(1, multiply: 10, add: 5) #=> 15
+```
+
+### `Pipey::Chain`
+
+`Pipey::Chain` is a slightly fancier way to work with chainable objects like `Array`s or `ActiveRecord::Relation`s.
+
+```ruby
+class MyPipe < Pipey::Chain
+  extend Pipey::Steps::Scanner[/^run_/]
+
+  def run_foo(multiply:, **)
+    map { |v| v * a }
+  end
+
+  def run_bar(minimum:, **)
+    select { |v| v > minimum }
+  end
+end
+
+MyPipe.call([1, 2, 3], multiply: 5, minimum: 6) #=> [10, 15]
+```
+
+### `Pipey::Steps::Scanner`
+
+`Pipey::Steps::Scanner` takes a `Regexp` as an argument, and it will run the methods that match the regexp.
+
+**NOTE:** This does not guarantee the order in which steps will run.
+
+### `Pipey::Steps::DSL`
+
+If you don't like the automatic behavior provided by `Pipey::Steps::Scanner`, you can use `Pipey::Steps::DSL` instead. With it, you can list out your steps.
+
+**NOTE:** This does guarantee the order in which steps will run.
+
+```ruby
+class MyPipe < Pipey::Line
+  extend Pipey::Steps::DSL
+
+  step :foo
+  step :bar
+
+  def foo(num, multiply:, **)
+    num * multiply
+  end
+
+  def bar(num, add:, **)
+    num + add
+  end
+end
+
+MyPipe.call(1, multiply: 10, add: 5) #=> 15
+```
+
+### `Pipey::Extensions::RequiredKeys`
+
+This extension won't call a step if it requires a key that is falsy.
+
+```ruby
+class MyPipe < Pipey::Line
+  extend Pipey::Steps::Scanner[/^run_/]
+  extend Pipey::Extensions::RequiredKeys
+
+  def run_foo(num, multiply:, **)
+    num * multiply
+  end
+
+  def run_bar(num, add:, **)
+    num + add
+  end
+end
+
+MyPipe.call(1, multiply: 10, add: 5) #=> 15
+MyPipe.call(1, multiply: 10)         #=> 10
+MyPipe.call(1, add: 5)               #=> 6
+```
+
+### `Pipey::Extensions::IgnoreNil`
+
+By using this extension, any step that returns nil will be ignored.
+
+```ruby
+class MyPipe < Pipey::Line
+  extend Pipey::Steps::Scanner[/^run_/]
+  extend Pipey::Extensions::IgnoreNil
+
+  def run_foo(num, add:, **)
+    num * add if add > 5
+  end
+end
+
+MyPipe.call(1, add: 5) #=> 1
+MyPipe.call(1, add: 6) #=> 6
+```
+
+### `Pipey::Extensions::Ignore`
+
+This can be used to create more complicated ignores.
+
+For example, the implementation of `IgnoreNil` looks like this:
+
+```ruby
+Pipey::Extensions::Ignore.new(&:nil?)
+```
+
+If you wanted to ignore any value equal to 5, you could do this:
+
+```ruby
+class MyPipe < Pipey::Line
+  extend Pipey::Extensions::Ignore.new { |v| v == 5 }
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rzane/pipey.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new :default do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pipey"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pipey.rb

@@ -0,0 +1,11 @@
+require 'pipey/version'
+require 'pipey/line'
+require 'pipey/chain'
+require 'pipey/steps'
+require 'pipey/steps'
+require 'pipey/extensions'
+require 'pipey/extensions'
+
+module Pipey
+  # Your code goes here...
+end

data/lib/pipey/chain.rb

@@ -0,0 +1,23 @@
+require 'pipey/core'
+
+module Pipey
+  class Chain < SimpleDelegator
+    include Core
+
+    def self.call(initial, params = {})
+      new(initial).call(params)
+    end
+
+    def call!(params = {}) # :nodoc:
+      self.class.steps_for(params).each do |name|
+        result = send(name, params)
+
+        if self.class.valid_pipe_result?(result)
+          __setobj__(result)
+        end
+      end
+
+      __getobj__
+    end
+  end
+end

data/lib/pipey/core.rb

@@ -0,0 +1,23 @@
+module Pipey
+  module Core # :nodoc:
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def valid_pipe_result?(_)
+        true
+      end
+    end
+
+    def stop!(*args)
+      throw(:__pipey_stop, *args)
+    end
+
+    def call(*args)
+      catch :__pipey_stop do
+        clone.call!(*args)
+      end
+    end
+  end
+end

data/lib/pipey/extensions.rb

@@ -0,0 +1,31 @@
+module Pipey
+  module Extensions
+    module RequiredKeys
+      # @override Pipey::DSL.steps_for
+      # @override Pipey::Scanner.steps_for
+      def steps_for(params)
+        super.reject do |step|
+          instance_method(step).parameters.any? do |type, name|
+            type == :keyreq && params[name].nil?
+          end
+        end
+      end
+    end
+
+    class Ignore < Module
+      class << self
+        alias [] new
+      end
+
+      def initialize(&comparator)
+        # @override Pipey::Chain#valid_pipe_result?
+        # @override Pipey::Line#valid_pipe_result?
+        define_method :valid_pipe_result? do |result|
+          super(result) && !comparator.call(result)
+        end
+      end
+    end
+
+    IgnoreNil = Ignore.new(&:nil?)
+  end
+end

data/lib/pipey/line.rb

@@ -0,0 +1,23 @@
+require 'pipey/core'
+
+module Pipey
+  class Line
+    include Core
+
+    def self.call(*args)
+      new.call(*args)
+    end
+
+    def call!(initial, opts = {})
+      self.class.steps_for(opts).reduce(initial) do |value, name|
+        result = send(name, value, opts)
+
+        if self.class.valid_pipe_result?(result)
+          result
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/pipey/steps.rb

@@ -0,0 +1,33 @@
+module Pipey
+  module Steps
+    module DSL
+      def steps
+        @steps ||= []
+      end
+
+      def steps_for(_)
+        steps
+      end
+
+      def step(key)
+        steps << key
+      end
+    end
+
+    class Scanner < Module
+      class << self
+        alias [] new
+      end
+
+      def initialize(pattern)
+        define_method :steps do
+          instance_methods.grep(pattern)
+        end
+
+        define_method :steps_for do |_|
+          steps
+        end
+      end
+    end
+  end
+end

data/lib/pipey/version.rb

@@ -0,0 +1,3 @@
+module Pipey
+  VERSION = "0.1.0"
+end

data/pipey.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pipey/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pipey"
+  spec.version       = Pipey::VERSION
+  spec.authors       = ["Ray Zane"]
+  spec.email         = ["raymondzane@gmail.com"]
+
+  spec.summary       = %q{Utilities for building data pipelines.}
+  spec.homepage      = "https://github.com/rzane/pipey"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "m"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: pipey
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ray Zane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- raymondzane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pipey.rb
+- lib/pipey/chain.rb
+- lib/pipey/core.rb
+- lib/pipey/extensions.rb
+- lib/pipey/line.rb
+- lib/pipey/steps.rb
+- lib/pipey/version.rb
+- pipey.gemspec
+homepage: https://github.com/rzane/pipey
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Utilities for building data pipelines.
+test_files: []