simple_pipeline 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5cbe78df308227f273429f35076b7cd0cbbe76d
-  data.tar.gz: 8bba7a8aa97709ab873daa5387bbc79d4947c852
+  metadata.gz: d7498222868fb61586a42e233b459aed023f91a4
+  data.tar.gz: 157c751b613f41bd2b0a507606a4ed2be6b5538b
 SHA512:
-  metadata.gz: 2e4084681ee5817434341d714df17d16320f13d197ae90ba744ee1c807838264110c4f8b6f769ec836d84004c121d0c5f35ecf7902527ddb93bcb78e0073852e
-  data.tar.gz: 197fc96cc90add02ce7dd2395ada21ca2ed6acfdaf98f1ae98d8552fedbea7d04512b92a79a37800b87cfeedb5ffdf209e205b4ddb0cdf71eb3b8bf93161da6b
+  metadata.gz: e86424d591224a4bd4e0822666c83877f0fa497d33c570989748329c007842e8d7c3f7d7861262a75a1b01252014f838bc2d9bee772a459a2d22107b13b9b689
+  data.tar.gz: 2d6b0b662fd764343825ca652469940879e270434d4b0a7f8185aa8d74e988bd8f60dfbf73bf57fe4a620c937e0d8e22183629adae1676c2faba1448053c37c4

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+build.bat

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jonathan Wong
+
+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,31 @@
+# SimplePipeline
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_pipeline'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_pipeline
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/simple_pipeline/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+
+task :default  => :spec

data/lib/simple_pipeline/timeout.rb

@@ -0,0 +1,19 @@
+require 'timeout'
+
+class SimplePipeline
+
+	module Timeout
+
+		def set_timeout (sec)
+			@timeout_in_sec = sec
+		end
+
+		def process_with_timeout (payload)
+			::Timeout::timeout(@timeout_in_sec) {
+				process(payload)
+			}
+		end
+
+	end
+
+end

data/lib/simple_pipeline/version.rb

@@ -1,3 +1,3 @@
-module SimplePipeline
-  VERSION = "0.0.1"
+class SimplePipeline
+  VERSION = "0.0.2"
 end

data/lib/simple_pipeline.rb

@@ -1,2 +1,37 @@
-require "simple_pipeline/pipe"
-require "simple_pipeline/version"
+require "simple_pipeline/timeout"
+require "simple_pipeline/version"
+
+
+class SimplePipeline
+
+	def initialize
+		@pipes = []
+	end
+
+	def add (pipe)
+		begin
+			raise ArgumentError, "invalid pipe - incorrect number of arguments for process() method (should be 1)" unless pipe.class.instance_method(:process).arity == 1
+		rescue NameError
+			raise ArgumentError, "invalid pipe - process() method not found"
+		end
+
+		@pipes << pipe
+	end
+
+	def size
+		return @pipes.size
+	end
+
+	def process (payload)
+		@pipes.each do |pipe|
+			if pipe.is_a? SimplePipeline::Timeout
+				pipe.process_with_timeout(payload)
+			else
+				pipe.process(payload)
+			end
+		end
+	end
+
+	alias :length :size
+
+end

data/simple_pipeline.gemspec

@@ -0,0 +1,18 @@
+require File.expand_path("../lib/simple_pipeline/version", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_pipeline"
+  spec.version       = SimplePipeline::VERSION
+  spec.authors       = ["Jonathan Wong"]
+  spec.email         = ["jonathan@armchairtheorist.com"]
+  spec.summary       = "Simple implementation of a configurable processing pipeline for sequential execution of reusable code components."
+  spec.homepage      = "http://github.com/armchairtheorist/simple_pipeline"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'rspec', '~> 0'
+  spec.add_development_dependency 'rake', '~> 0'
+end

data/spec/simple_pipeline_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+class TestPipe
+	def process (payload)
+		payload[:test_value] *= 10
+	end
+end
+
+class BadPipe
+	def process (payload1, payload2)
+		# do nothing
+	end
+end
+
+class TimeoutPipe
+	include SimplePipeline::Timeout
+
+	def initialize
+		set_timeout 1 # seconds
+	end
+
+	def process (payload)
+		sleep 10 # seconds
+	end
+end
+
+describe SimplePipeline do
+	it "should support three normal pipes" do
+		pipeline = SimplePipeline.new
+		pipeline.add TestPipe.new
+		pipeline.add TestPipe.new
+		pipeline.add TestPipe.new
+		
+		payload = {:test_value => 10}
+
+		pipeline.process(payload)
+
+		expect(pipeline.size).to eq 3
+    	expect(payload[:test_value]).to eq 10000
+  	end
+
+  	it "should throw an error for invalid pipes" do
+		pipeline = SimplePipeline.new
+		
+		expect {
+			pipeline.add Object.new # not a pipe
+		}.to raise_error(ArgumentError)
+
+		expect {
+			pipeline.add BadPipe
+		}.to raise_error(ArgumentError)
+	end
+
+	it "should support pipes with timeout" do
+		pipeline = SimplePipeline.new
+		pipe = TimeoutPipe.new
+		pipeline.add pipe
+
+		expect {
+			pipeline.process({})
+		}.to raise_error(Timeout::Error)
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+require 'simple_pipeline'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: simple_pipeline
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jonathan Wong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-04 00:00:00.000000000 Z
-dependencies: []
+date: 2016-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rake
+  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:
 - jonathan@armchairtheorist.com
@@ -17,9 +45,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
 - lib/simple_pipeline.rb
-- lib/simple_pipeline/pipe.rb
+- lib/simple_pipeline/timeout.rb
 - lib/simple_pipeline/version.rb
+- simple_pipeline.gemspec
+- spec/simple_pipeline_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/armchairtheorist/simple_pipeline
 licenses:
 - MIT
@@ -40,9 +77,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Simple implementation of a configurable processing pipeline framework for
-  sequential execution of reusable code components.
+summary: Simple implementation of a configurable processing pipeline for sequential
+  execution of reusable code components.
 test_files: []

data/lib/simple_pipeline/pipe.rb

@@ -1,35 +0,0 @@
-module SimplePipeline
-
-	class Pipe
-
-		DEFAULT_OPTIONS = {}
-
-		def initialize (options = {})
-			@options = DEFAULT_OPTIONS.merge(options)
-			@sections = []
-		end
-
-		def add (section)
-			begin
-				raise ArgumentError, "invalid section - incorrect number of arguments for process() method (should be 1)" unless section.class.instance_method(:process).arity == 1
-			rescue NameError
-				raise ArgumentError, "invalid section - process() method not found"
-			end
-
-			@sections << section
-		end
-
-		def size
-			return @sections.size
-		end
-
-		def process (payload)
-			@sections.each do |section|
-				section.process(payload)
-			end
-		end
-
-		alias :length :size
-	end
-
-end