data-pipeline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1eb0de763402a41bcefac5aac42158fc5107e4cf773b6fa15712426ece38985f
+  data.tar.gz: c4741176a480a08e8c651f1305038200c08dadaa2a328bf18a92b92ca0f3cd24
+SHA512:
+  metadata.gz: b6bbf4e0d2c0ffb95ea55999e624fde5de72221116d1ecceafe5991588daf2f44a2b38ca561a06d5f252d09a3f60313c5640237f54fbab265891ce6ce6234300
+  data.tar.gz: 0ad3de0e821e851bd55800d29d4752a58bee46e9ef28c4a494f9614624d8cda8bc4541e513c25176e2291ce2aa4b564efb72e9ba0f6b77983fd1463b8c93bb09

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ckyeo.1@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    data-pipeline (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    hirb (0.7.3)
+    json (2.1.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  data-pipeline!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.16.1)
+  simplecov-console (~> 0.4.2)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Chee Yeo
+
+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

@@ -0,0 +1,141 @@
+# Pipeline
+
+Pipeline is a gem that enables you to build `operations` to transform data from one state to another using `pipelines`
+
+This is based on the [chain-of-responsibility pattern](https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'data-pipeline'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install data-pipeline
+
+## Usage
+
+Load the pipeline gem into your project:
+```ruby
+require 'pipeline'
+```
+
+Before we can create a pipeline, we need operation objects for processing the data.
+
+Start by creating a simple `Operation` object by inheriting from `Pipeline::Operation` class:
+
+```ruby
+class HelloWorld < Pipeline::Operation
+  def call(env)
+    # env is the data passed in from the pipeline
+    # do your data processing here ...
+
+    "Hello, #{env}"
+
+    super
+  end
+end
+```
+
+The example `HelloWorld` operation appends `'Hello'` to every string passed in.
+
+Next, we need to create a `pipeline`. Within a pipeline, we can chain multiple operations to transform the data into the desired state.
+
+Suppose we create a `HelloWorld` pipeline to use the `HelloWorld` operation, we can do it as follows:
+
+```ruby
+  Pipeline::Builder.new do |b|
+    b.use HelloWorld
+  end.call('World')
+```
+
+The above will return `'Hello World'`
+
+We can also add operation classes as procs. From the above example, we can wrap the string in another by using an additional proc:
+
+```ruby
+Pipeline::Builder.new do |b|
+  b.use HelloWorld
+  b.use ->(str) { "More processing: #{str}" }
+end.call('World')
+```
+
+The above will return `'More processing: Hello World'`
+
+We can also pass additional data into the operation classes:
+
+```ruby
+  Pipeline::Builder.new do |b|
+    b.use HelloWorld, 'Additional args'
+  end.call('World')
+```
+Within the operation class we can access it using the `data` attribute.
+
+```ruby
+class HelloWorld < Pipeline::Operation
+  def call(env)
+    # env is the data passed in from the pipeline
+    # data is passed in to the operation #=> 'Additional args'
+    # ....
+    super
+  end
+end
+```
+
+## Using custom operation classes
+
+Operation classes have a very simple interface.
+
+To create your own operation classes, you need to implement the following methods:
+
+```ruby
+  initialize(next_op, data=nil)
+
+  call(env)
+```
+
+`initialize` takes 2 arguments: the next operation to call; and any optional data the operation accepts
+
+`call` performs the processing on the passed in data from the builder e.g. `builder.call(mydata)`
+
+An example custom operation class:
+```ruby
+  class CustomOp
+    attr_reader :next_op, :data
+
+    def initialize(next_op, data=nil)
+      @next_op = next_op
+      @data = data
+    end
+
+    def call(env)
+      # Data processing here...
+      @next_op.call(env)
+    end
+  end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cheeyeo/pipeline. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pipeline project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pipeline/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pipeline"
+
+# 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/examples/simple.rb

@@ -0,0 +1,19 @@
+require "pipeline"
+
+class HelloWorld < Pipeline::Operation
+  def call(env)
+    # env is the data passed in from the pipeline
+    # do your data processing here ...
+
+    env = "Hello, #{env}"
+
+    super
+  end
+end
+
+res = Pipeline::Builder.new do |b|
+        b.use HelloWorld
+        b.use ->(str) { "More processing: #{str}" }
+      end.call('World')
+
+puts res

data/lib/pipeline.rb

@@ -0,0 +1,3 @@
+require "pipeline/version"
+require "pipeline/builder"
+require "pipeline/operation"

data/lib/pipeline/builder.rb

@@ -0,0 +1,61 @@
+module Pipeline
+  class Builder
+    def initialize(&block)
+      if block_given?
+        if block.arity == 1
+          yield self
+        else
+          instance_eval(&block)
+        end
+      end
+    end
+
+    # Adds an operation to the internal stack
+    # @param [Class] operation - The operation class
+    # @param [Array] args - Arguments for the operation
+    # @param [Proc] block - Optional block for the operation
+    def use(operation, *args, &block)
+      stack << [operation, args, block]
+      self
+    end
+
+    # Calls the operations in the stack
+    # @param [Object] env - Optional initial input to the pipeline
+    def call(env)
+      build_operation_chain(stack.dup).
+        call(env.dup)
+    end
+
+    # Returns the internal stack array for reading as a frozen object
+    def inspect_stack
+      stack.freeze
+    end
+
+    private
+
+    def stack
+      @stack ||= []
+    end
+
+    # Iterate through the stack and build a single
+    # callable object which consists of each operation
+    # referencing the next one in the chain
+    def build_operation_chain(stack)
+      empty_op = EmptyOperation.new(nil)
+
+      stack.reverse.reduce(empty_op) do |next_op, current_op|
+        klass, args, block = current_op
+
+        if Class === klass
+          klass.new(next_op, *args, &block)
+        elsif Proc === klass
+          lambda do |env|
+            next_op.call(klass.call(env, *args))
+          end
+        else
+          raise StandardError, "Invalid operation, doesn't respond to `call`: #{klass.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/pipeline/operation.rb

@@ -0,0 +1,21 @@
+module Pipeline
+  class Operation
+    attr_reader :next_op, :data
+
+    def initialize(next_op, data=nil)
+      @next_op = next_op
+      @data = data
+    end
+
+    def call(env)
+      @next_op.call(env)
+    end
+  end
+
+  class EmptyOperation < Operation
+    def call(env)
+      # NOOP
+      env
+    end
+  end
+end

data/lib/pipeline/version.rb

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

data/pipeline.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pipeline/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "data-pipeline"
+  spec.version       = Pipeline::VERSION
+  spec.authors       = ["Chee Yeo"]
+  spec.email         = ["ckyeo.1@gmail.com"]
+  spec.date          = '2018-09-01'
+  spec.summary       = 'Ruby data pipeline'
+  spec.description   = 'Process data using pipelines and operations'
+  spec.homepage      = 'https://github.com/cheeyeo/pipeline'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.16.1"
+  spec.add_development_dependency 'simplecov-console', '~> 0.4.2'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: data-pipeline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chee Yeo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-01 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+description: Process data using pipelines and operations
+email:
+- ckyeo.1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/simple.rb
+- lib/pipeline.rb
+- lib/pipeline/builder.rb
+- lib/pipeline/operation.rb
+- lib/pipeline/version.rb
+- pipeline.gemspec
+homepage: https://github.com/cheeyeo/pipeline
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby data pipeline
+test_files: []