bulk_execution 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 71cd526e7dfcf85751265c38bf67477ff7350813
+  data.tar.gz: 24e3ea9a896985ed9a362a92ea561212de0ad63b
+SHA512:
+  metadata.gz: cdcdc13e18e64b13df38a985723efe64021da30cb173382c733ed680d5a64d3e5f168b7b9c3a68ddd3eb49527e65c29732a4a048aeeff98f5cae0452c16be0e6
+  data.tar.gz: 0211d86a6e7bf1777a07fb68c776913a7814a45e775952d4dafd549ec9354c0b25424f1f866444a0ac3d807cb1070e37bff34e2a9ef50da857600b1a46630ae5

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx-2
+  - ruby-head

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pete Swan
+
+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,42 @@
+[![Build Status](https://travis-ci.org/gustly/bulk_execution.svg?branch=master)](https://travis-ci.org/gustly/bulk_execution)
+
+# BulkExecution
+
+Execute a block over a collection of data keeping track of successes and failures, 
+the data that caused them, and the index of that data within the collection.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bulk_execution'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bulk_execution
+
+## Usage
+
+```ruby
+executor = BulkExecution::Exector.new(data)
+executor.execute do |execution_context|
+  begin
+    result = do_something(execution_context.data)
+    execution_context.record_success(result)
+  rescue
+    execution_context.record_failure($!)
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/bulk_execution/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 new Pull Request

data/Rakefile

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

data/bulk_execution.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bulk_execution/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bulk_execution"
+  spec.version       = BulkExecution::VERSION
+  spec.authors       = ["Peter Swan"]
+  spec.email         = ["pdswan@gmail.com"]
+  spec.summary       = %q{Execute a block over a collection storing success and failure with the data that caused it.}
+  spec.homepage      = "https://github.com/gustly/bulk_execution"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/bulk_execution.rb

@@ -0,0 +1,6 @@
+require "bulk_execution/version"
+require "bulk_execution/executor"
+require "bulk_execution/execution_context"
+require "bulk_execution/results/result"
+require "bulk_execution/results/result_set"
+

data/lib/bulk_execution/execution_context.rb

@@ -0,0 +1,24 @@
+module BulkExecution
+  class ExecutionContext
+    def initialize(data, index, result_set)
+      @data = data
+      @result_set = result_set
+      @index = index
+    end
+
+    def record_failure(*args)
+      result_set.record_failure(data, index, *args)
+    end
+
+    def record_success(*args)
+      result_set.record_success(data, index, *args)
+    end
+
+    attr_reader :data
+
+    private
+
+    attr_reader :result_set, :index
+  end
+end
+

data/lib/bulk_execution/executor.rb

@@ -0,0 +1,20 @@
+module BulkExecution
+  class Executor
+    def initialize(data)
+      @data = data
+    end
+
+    def execute(&block)
+      Results::ResultSet.new.tap do |results|
+        data.each_with_index do |datum, index|
+          block.call(ExecutionContext.new(datum, index, results))
+        end
+      end
+    end
+
+    private
+
+    attr_reader :data
+  end
+end
+

data/lib/bulk_execution/results/result.rb

@@ -0,0 +1,27 @@
+module BulkExecution
+  module Results
+    class Result
+      def initialize(data, index, result)
+        raise StandardError, "Abstract base class" if self.class == Result
+        @data = data
+        @index = index
+        @result = result
+      end
+
+      def success?
+        case self
+        when Success then true
+        when Failure then false
+        end
+      end
+
+      attr_reader :data, :index, :result
+    end
+
+    class Success < Result; end
+
+    class Failure < Result
+      alias_method :error, :result
+    end
+  end
+end

data/lib/bulk_execution/results/result_set.rb

@@ -0,0 +1,30 @@
+module BulkExecution
+  module Results
+    class ResultSet
+      def initialize
+        @successes = []
+        @failures = []
+      end
+
+      def record_failure(*args)
+        @failures << Failure.new(*args)
+      end
+
+      def record_success(*args)
+        @successes << Success.new(*args)
+      end
+
+      def failure?
+        failures.any?
+      end
+
+      def success?
+        !failure?
+      end
+
+      attr_reader :failures,
+        :successes
+    end
+  end
+end
+

data/lib/bulk_execution/version.rb

@@ -0,0 +1,3 @@
+module BulkExecution
+  VERSION = "0.0.1"
+end

data/spec/bulk_execution/execution_context_spec.rb

@@ -0,0 +1,35 @@
+require "support/spec_helper"
+
+describe BulkExecution::ExecutionContext do
+  let(:execution_context) { BulkExecution::ExecutionContext.new(data, index, result_set) }
+  let(:data) { double(:data) }
+  let(:result_set) { double(:result_set) }
+  let(:index) { double(:index) }
+
+  describe "#record_failure" do
+    let(:failure_arg) { double(:failure_arg) }
+
+    before do
+      allow(result_set).to receive(:record_failure)
+    end
+
+    it "records a failure in the results set" do
+      execution_context.record_failure(failure_arg)
+      expect(result_set).to have_received(:record_failure).with(data, index, failure_arg)
+    end
+  end
+
+  describe "#record_success" do
+    let(:success_arg) { double(:success_arg) }
+
+    before do
+      allow(result_set).to receive(:record_success)
+    end
+
+    it "records a success in teh results set" do
+      execution_context.record_success(success_arg)
+      expect(result_set).to have_received(:record_success).with(data, index, success_arg)
+    end
+  end
+end
+

data/spec/bulk_execution/executor_spec.rb

@@ -0,0 +1,32 @@
+require "support/spec_helper"
+
+describe BulkExecution::Executor do
+  let(:bulk_execution) { BulkExecution::Executor.new(data) }
+  let(:block) { Proc.new {} }
+  let(:result_set) { double(:result_set) }
+
+  let(:data) { [datum] }
+  let(:datum) { double(:datum) }
+
+  let(:execution_context) { double(:execution_context) }
+
+  before do
+    allow(BulkExecution::Results::ResultSet).to receive(:new).
+      and_return(result_set)
+
+    allow(block).to receive(:call)
+  end
+
+  describe "#execute" do
+    it "executes the block over the data" do
+      allow(BulkExecution::ExecutionContext).to receive(:new).
+        with(datum, 0, result_set).
+        and_return(execution_context)
+
+      bulk_execution.execute(&block)
+
+      expect(block).to have_received(:call).with(execution_context)
+    end
+  end
+end
+

data/spec/bulk_execution/results/result_set_spec.rb

@@ -0,0 +1,66 @@
+describe BulkExecution::Results::ResultSet do
+  let(:result_set) { BulkExecution::Results::ResultSet.new }
+
+  let(:failure) { double(:failure) }
+  let(:failure_data) { double(:failure_data) }
+  let(:index) { double(:index) }
+  let(:error_message) { double(:error_message) }
+
+  let(:success) { double(:success) }
+  let(:success_data) { double(:success_data) }
+
+  let(:success_result) { double(:success_result) }
+
+  describe "#record_failure" do
+    before do
+      allow(BulkExecution::Results::Failure).to receive(:new).
+        with(failure_data, index, error_message).
+        and_return(failure)
+    end
+
+    it "creates a new Failure" do
+      result_set.record_failure(failure_data, index, error_message)
+      expect(result_set.failures).to include(failure)
+    end
+  end
+
+  describe "#record_success" do
+    before do
+      allow(BulkExecution::Results::Success).to receive(:new).
+        with(success_data, index, success_result).
+        and_return(success)
+    end
+
+    it "creates a new Success" do
+      result_set.record_success(success_data, index, success_result)
+      expect(result_set.successes).to include(success)
+    end
+  end
+
+  describe "#failure?" do
+    subject { result_set.failure? }
+
+    context "there are failures" do
+      before { result_set.record_failure(failure_data, index, error_message) }
+      specify { expect(subject).to eq(true) }
+    end
+
+    context "there are no failures" do
+      specify { expect(subject).to eq(false) }
+    end
+  end
+
+  describe "#success?" do
+    subject { result_set.success? }
+
+    context "there are failures" do
+      before { result_set.record_failure(failure_data, index, error_message) }
+      specify { expect(subject).to eq(false) }
+    end
+
+    context "there are no failures" do
+      specify { expect(subject).to eq(true) }
+    end
+  end
+end
+

data/spec/bulk_execution/results/result_spec.rb

@@ -0,0 +1,28 @@
+require "support/spec_helper"
+
+describe BulkExecution::Results::Success do
+  let(:success) { BulkExecution::Results::Success.new(data, index, result) }
+  let(:data) { double(:data) }
+  let(:index) { double(:index) }
+  let(:result) { double(:result) }
+
+  describe "#success?" do
+    it "returns true" do
+      expect(success.success?).to eq(true)
+    end
+  end
+end
+
+describe BulkExecution::Results::Failure do
+  let(:failure) { BulkExecution::Results::Failure.new(data, index, result) }
+  let(:data) { double(:data) }
+  let(:index) { double(:index) }
+  let(:result) { double(:result) }
+
+  describe "#success?" do
+    it "returns false" do
+      expect(failure.success?).to eq(false)
+    end
+  end
+end
+

data/spec/support/spec_helper.rb

@@ -0,0 +1,2 @@
+require "rspec"
+require "bulk_execution"

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: bulk_execution
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Swan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !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'
+description: 
+email:
+- pdswan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bulk_execution.gemspec
+- lib/bulk_execution.rb
+- lib/bulk_execution/execution_context.rb
+- lib/bulk_execution/executor.rb
+- lib/bulk_execution/results/result.rb
+- lib/bulk_execution/results/result_set.rb
+- lib/bulk_execution/version.rb
+- spec/bulk_execution/execution_context_spec.rb
+- spec/bulk_execution/executor_spec.rb
+- spec/bulk_execution/results/result_set_spec.rb
+- spec/bulk_execution/results/result_spec.rb
+- spec/support/spec_helper.rb
+homepage: https://github.com/gustly/bulk_execution
+licenses:
+- MIT
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Execute a block over a collection storing success and failure with the data
+  that caused it.
+test_files:
+- spec/bulk_execution/execution_context_spec.rb
+- spec/bulk_execution/executor_spec.rb
+- spec/bulk_execution/results/result_set_spec.rb
+- spec/bulk_execution/results/result_spec.rb
+- spec/support/spec_helper.rb