phase_shift 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jurgens du Toit
+
+MIT License
+
+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,29 @@
+# PhaseShift
+
+A simple pipeline processing implementation similiar to rack middleware
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'phase_shift'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install phase_shift
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/phase_shift.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+require 'phase_shift'
+
+runner = PhaseShift::Runner.new
+runner.run

data/lib/phase_shift.rb

@@ -0,0 +1,3 @@
+require 'phase_shift/version'
+require 'phase_shift/runner'
+require 'phase_shift/builder'

data/lib/phase_shift/builder.rb

@@ -0,0 +1,30 @@
+module PhaseShift
+  # Create a pipeline by building up stages
+  class Builder
+    attr_reader :stages
+
+    def self.parse_file(config, file = '(phase_shift)')
+      builder_script = ::File.read(config)
+      code = "PhaseShift::Builder.new {\n" + builder_script + "\n}.pipeline"
+      eval code, TOPLEVEL_BINDING, file, 0
+    end
+
+    def initialize(default_stage = nil, &block)
+      @default_stage = default_stage || proc { [] }
+      @stages = []
+      instance_eval(&block) if block_given?
+    end
+
+    def use(stage, *args)
+      @stages << proc { |pipeline| stage.new(pipeline, *args) }
+    end
+
+    def pipeline
+      stages.inject(@default_stage) { |a, e| e[a] }
+    end
+
+    def run
+      pipeline.call
+    end
+  end
+end

data/lib/phase_shift/runner.rb

@@ -0,0 +1,35 @@
+require_relative 'builder'
+
+module PhaseShift
+  # Run a defined pipeline
+  class Runner
+    def initialize(options = nil)
+      fail 'No specified pipeline' unless options.include? :pipeline
+      @options = options
+    end
+
+    def run
+      pipeline.call
+    end
+
+    def pipeline
+      @pipeline ||= Builder.parse_file "#{options[:pipeline]}.rb"
+    end
+
+    def options
+      @options ||= parse_options(ARGV)
+    end
+
+    def default_options
+      {}
+    end
+
+    private
+
+    def parse_options(argv)
+      @options = default_options
+      @options[:pipeline] = argv.first if argv.length > 0
+      @options
+    end
+  end
+end

data/lib/phase_shift/version.rb

@@ -0,0 +1,4 @@
+# A simple pipeline processing implementation similiar to rack middleware
+module PhaseShift
+  VERSION = '0.0.1'
+end

data/phase_shift.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phase_shift/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'phase_shift'
+  spec.version       = PhaseShift::VERSION
+  spec.authors       = ['Jurgens du Toit']
+  spec.email         = ['jrgns@jadeit.co.za']
+  spec.description   = spec.summary
+  spec.summary       = 'A simple pipeline processing implementation'
+  spec.homepage      = 'https://github.com/hackerplanet/phase_shift'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rspec'
+end

data/spec/messager.rb

@@ -0,0 +1,13 @@
+# Simple counter class
+class Messager
+  def initialize(app, message = 'Message')
+    @app = app
+    @message = message
+  end
+
+  def call
+    result = @app.call
+    result.push @message
+    result
+  end
+end

data/spec/phase_shift/builder_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+require 'phase_shift/builder'
+
+describe 'PhaseShift::Builder' do
+  subject { PhaseShift::Builder }
+
+  let(:stage) do
+    double.as_null_object
+  end
+
+  let(:stage_two) do
+    double.as_null_object
+  end
+
+  context '.parse_file' do
+    it 'evaluates the passed file to a callable object' do
+      expect(subject.parse_file('spec/test.rb')).to respond_to :call
+    end
+  end
+
+  context '#initialize' do
+    it 'evaluates the passed block in the context of the object' do
+      expect { subject.new { fail "Stage Count: #{stages.count}" } }\
+        .to raise_error('Stage Count: 0')
+    end
+  end
+
+  context '#use' do
+    it 'adds the passed stage to the pipeline' do
+      builder = subject.new
+      builder.use stage
+
+      builder.run
+
+      expect(stage).to have_received(:new).with(duck_type(:call))
+    end
+
+    it 'passes the specified arguments to the stage' do
+      builder = subject.new
+      string = 'This'
+      builder.use stage, string
+
+      builder.run
+
+      expect(stage).to have_received(:new).with(duck_type(:call), be(string))
+    end
+
+    it 'adds all the specified stages to the pipeline' do
+      builder = subject.new
+      builder.use stage
+      builder.use stage_two
+
+      expect(builder.stages.count).to eq(2)
+    end
+  end
+
+  context '#pipeline' do
+    it 'has a default stage that returns an empty array' do
+      expect(subject.new.pipeline.call).to eq([])
+    end
+
+    it 'allows the first stage of the pipeline to be customized' do
+      expect(subject.new(proc { [1] }).pipeline.call).to eq([1])
+    end
+
+    it 'build the pipeline out of stages' do
+      builder = subject.new
+      builder.use stage
+      builder.use stage_two
+
+      builder.pipeline
+
+      expect(stage).to have_received(:new).with(duck_type(:call))
+      expect(stage_two).to have_received(:new).with(duck_type(:call))
+    end
+  end
+
+  context '#run' do
+    it 'calls the stages in the pipeline' do
+      builder = subject.new
+      builder.use stage
+      builder.run
+
+      expect(stage).to have_received(:call)
+    end
+  end
+end

data/spec/phase_shift/runner_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'phase_shift/runner'
+
+describe 'PhaseShift::Runner' do
+  subject { PhaseShift::Runner.new(pipeline: 'spec/test') }
+
+  context '#initialize' do
+    it 'requires a specified pipeline' do
+      expect {PhaseShift::Runner.new}.to raise_error
+    end
+
+    it 'sets the passed options' do
+      runner = PhaseShift::Runner.new(pipeline: 'spec/test', test: 'value')
+      expect(runner.options).to include(:test)
+      expect(runner.options[:test]).to eq 'value'
+    end
+  end
+
+  context '#run' do
+    it 'calls the pipeline' do
+      result = subject.run
+      expect(result).to eq ['Phase 1', 'Phase 2', 'Phase 3', 'Phase 4']
+    end
+  end
+
+  context '#pipeline' do
+    it 'returns the pipeline' do
+      expect(subject.pipeline).to respond_to :call
+      expect(subject.pipeline.call).to \
+        eq ['Phase 1', 'Phase 2', 'Phase 3', 'Phase 4']
+    end
+  end
+
+  context '#options' do
+    it 'returns the options hash' do
+      expect(subject.options).to eq pipeline: 'spec/test'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.alias_example_to :fit, focus: true
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

data/spec/test.rb

@@ -0,0 +1,6 @@
+require 'messager'
+
+use Messager, 'Phase 1'
+use Messager, 'Phase 2'
+use Messager, 'Phase 3'
+use Messager, 'Phase 4'

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: phase_shift
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jurgens du Toit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- jrgns@jadeit.co.za
+executables:
+- phase_shift.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/phase_shift.rb
+- lib/phase_shift.rb
+- lib/phase_shift/builder.rb
+- lib/phase_shift/runner.rb
+- lib/phase_shift/version.rb
+- phase_shift.gemspec
+- spec/messager.rb
+- spec/phase_shift/builder_spec.rb
+- spec/phase_shift/runner_spec.rb
+- spec/spec_helper.rb
+- spec/test.rb
+homepage: https://github.com/hackerplanet/phase_shift
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple pipeline processing implementation
+test_files:
+- spec/messager.rb
+- spec/phase_shift/builder_spec.rb
+- spec/phase_shift/runner_spec.rb
+- spec/spec_helper.rb
+- spec/test.rb