skywalker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 189ad007dad735d22002e8e676be20d37202e427
+  data.tar.gz: 49633c02c8e18e1572ed5d570b3ad49e1ca71f85
+SHA512:
+  metadata.gz: 32d48d08a9c6bd7a25af17485f2f0202fcee026b32133c3851093e2c530959148578c01dc29b012ea8f6ff08692c212b7eb8b912bdd695c1b4bc0c3bf3d77cc3
+  data.tar.gz: 4103d5ba416a5e403d2c00390c92f62d8001e7712a56b9c692e186ddc6d78e8eba589bae6b201ae4521e252cac066a391739d4dc98255a03834beb16eed91208

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rob Yurkowski
+
+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,89 @@
+# Skywalker
+
+Skywalker is a gem that provides a simple command pattern for applications that use transactions.
+
+## Why Skywalker?
+
+It's impossible to come up with a single-word clever name for a gem about commands. If you can't
+achieve clever, achieve topicality.
+
+## What is a command?
+
+A command is simply a series of instructions that should be run in sequence
+and considered a single unit. If one instruction fails, they should all fail.
+
+That's a transaction, you say? You're correct! But there are some benefits of
+considering transactional blocks as objects:
+
+### Testability
+
+With a command, you inject most any argument, which means that you can simulate
+the run of the command without providing real arguments. Best practice is to
+describe the operations in methods, which can then be stubbed out to test small
+portions in isolation.
+
+This also allows you to make the reasonable inference that the command will abort
+properly if one step raises an error, and by convention, the same method (`on_failure`)
+will be called. In most cases, you can thereby verify happy path and a single bad path
+through integration specs, and that will suffice.
+
+### Reasonability
+
+The benefit of abstraction means that you can easily reason about a command without
+having to know its internals. Standard caveats apply, but if you have a `CreateGroup`
+command, you should be able to infer that calling the command with the correct arguments
+will produce the expected result.
+
+### A gateway to harder architectures
+
+It's not hard to create an `Event` class and step up toward full event sourcing, or to
+go a bit further and implement full CQRS. This is the architectural pattern your parents
+warned you about.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'skywalker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install skywalker
+
+## Usage
+
+Compose your commands:
+
+```ruby
+class AddGroupCommand < Skywalker::Command
+  def execute!
+    # Your transactional operations go here. No need to open a transaction.
+    # Simply make sure each method raises an error when it fails.
+  end
+end
+```
+
+Then call your commands:
+
+```ruby
+command = AddGroupCommand.call(
+  on_success: method(:on_success),
+  on_failure: method(:on_failure)
+)
+
+You can pass any object responding to `#call` to the `on_success` and `on_failure` handlers, including procs, lambdas, controller methods, or other commands themselves.
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/robyurkowski/skywalker/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/skywalker.rb

@@ -0,0 +1,5 @@
+require "skywalker/version"
+
+module Skywalker
+  # Your code goes here...
+end

data/lib/skywalker/command.rb

@@ -0,0 +1,72 @@
+require 'active_record'
+
+module Skywalker
+  class Command
+    ################################################################################
+    # Class interface
+    ################################################################################
+    def self.call(*args)
+      new(*args).call
+    end
+
+
+    ################################################################################
+    # Instantiates command, setting all arguments.
+    ################################################################################
+    def initialize(on_success: nil, on_failure: nil)
+      self.on_success = on_success
+      self.on_failure = on_failure
+    end
+
+
+    attr_accessor :on_success,
+                  :on_failure,
+                  :error
+
+
+    ################################################################################
+    # Call: runs the transaction and all operations.
+    ################################################################################
+    def call
+      transaction do
+        execute!
+
+        confirm_success
+      end
+
+    rescue Exception => error
+      confirm_failure error
+    end
+
+
+    ################################################################################
+    # Operations should be defined in this method.
+    ################################################################################
+    private def execute!
+    end
+
+    ################################################################################
+    # Override to customize.
+    ################################################################################
+    private def transaction(&block)
+      ::ActiveRecord::Base.transaction(&block)
+    end
+
+
+    ################################################################################
+    # Trigger the given callback on success
+    ################################################################################
+    private def confirm_success
+      on_success.call(self)
+    end
+
+
+    ################################################################################
+    # Set the error so we can get it with `command.error`, and trigger error.
+    ################################################################################
+    private def confirm_failure(error)
+      self.error = error
+      on_failure.call(self)
+    end
+  end
+end

data/lib/skywalker/version.rb

@@ -0,0 +1,3 @@
+module Skywalker
+  VERSION = "1.0.0"
+end

data/skywalker.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'skywalker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "skywalker"
+  spec.version       = Skywalker::VERSION
+  spec.authors       = ["Rob Yurkowski"]
+  spec.email         = ["rob@yurkowski.net"]
+  spec.summary       = %q{A simple command pattern implementation for transactional operations.}
+  spec.description   = %q{A simple command pattern implementation for transactional operations.}
+  spec.homepage      = "https://github.com/robyurkowski/skywalker"
+  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_dependency 'activerecord', '~> 4.1'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+end

data/spec/lib/skywalker/command_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+require 'skywalker/command'
+
+module Skywalker
+  RSpec.describe Command do
+    describe "convenience" do
+      it "provides a class call method that instantiates and calls" do
+        arg = 'blah'
+
+        expect(Command).to receive_message_chain('new.call')
+        Command.call(arg)
+      end
+    end
+
+
+    describe "instantiation" do
+      it "accepts an on_success callback" do
+        expect { Command.new(on_success: ->{ nil }) }.not_to raise_error
+      end
+
+      it "accepts an on_failure callback" do
+        expect { Command.new(on_failure: ->{ nil }) }.not_to raise_error
+      end
+    end
+
+
+    describe "validity control" do
+      let(:command) { Command.new }
+
+      it "executes in a transaction" do
+        expect(command).to receive(:transaction)
+        command.call
+      end
+    end
+
+
+    describe "execution" do
+      before do
+        allow(command).to receive(:transaction).and_yield
+      end
+
+
+      describe "success handling" do
+        let(:on_success) { double("on_success callback") }
+        let(:command) { Command.new(on_success: on_success) }
+
+        before do
+          allow(command).to receive(:execute!).and_return(true)
+        end
+
+        it "triggers the confirm_success method" do
+          expect(command).to receive(:confirm_success)
+          command.call
+        end
+
+        it "calls the on_success callback with itself" do
+          expect(on_success).to receive(:call).with(command)
+          command.call
+        end
+      end
+
+
+      describe "failure handling" do
+        let(:on_failure) { double("on_failure callback") }
+        let(:command) { Command.new(on_failure: on_failure) }
+
+        before do
+          allow(command).to receive(:execute!).and_raise(ScriptError)
+        end
+
+        it "triggers the confirm_failure method" do
+          expect(command).to receive(:confirm_failure)
+          command.call
+        end
+
+        it "sets the error on the command" do
+          allow(on_failure).to receive(:call)
+          expect(command).to receive(:error=)
+          command.call
+        end
+
+        it "calls the on_failure callback with itself" do
+          allow(command).to receive(:error=)
+          expect(on_failure).to receive(:call).with(command)
+          command.call
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,85 @@
+# 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
+
+  # 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
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  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

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: skywalker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rob Yurkowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-byebug
+  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: A simple command pattern implementation for transactional operations.
+email:
+- rob@yurkowski.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/skywalker.rb
+- lib/skywalker/command.rb
+- lib/skywalker/version.rb
+- skywalker.gemspec
+- spec/lib/skywalker/command_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/robyurkowski/skywalker
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple command pattern implementation for transactional operations.
+test_files:
+- spec/lib/skywalker/command_spec.rb
+- spec/spec_helper.rb