up_and_at_them 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2a05a7454d62421c8d4029dbae49370ddbaf695
-  data.tar.gz: ecdfc5d2c6d0831bb9c7486392635509a821b578
+  metadata.gz: 939048fd2ad08daec7378c1b4dd93c5fc2416e80
+  data.tar.gz: 5065388003473404532a5e72fe4951eae85c911a
 SHA512:
-  metadata.gz: 26ed6944e975a43fbfebf3596d37ed82331e3b98907f30100ebdba42dd745f4f34921c2499ea2ec66b90e61e29de29de157833a79ffb272c84dbc12026c9cce1
-  data.tar.gz: 82880cc5008cdb448964596eda8077bf8fafcdbe3f4093714eb28e2872bb6920479ec7e4d6465f25ecd72b87d2b2bc14521bdab62db687696788347d4fb6228c
+  metadata.gz: 21660a484924d390ab20a6f11b7e678f46efc69cd9cdd1a7380e965c5c22e449dc673e01e32971d629526be7e3e14e2ea8a90b47df2c1e6cff6b857b1eab15c9
+  data.tar.gz: 0bd1b751dece6ce750eb5fd0fdfd84ed4287a53f0be8c8c54fed976328fec46988272a8a60d39aed3e5c577976361f458b10adbfd036efcaf6f820e0ce15fbe7

data/.rspec

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

data/README.md

@@ -25,10 +25,16 @@ Or install it yourself as:
 Create a Transaction which contains all of your commits. Note that the Transaction will run as soon as it is
 initialized.
 
-    UpAndAtThem::Transaction.new([
-        UpAndAtThem::Commit.new { puts "do something!" }.on_rollback { "undo something!" },
-        UpAndAtThem::Commit.new { puts "do something else!" }.on_rollback { "undo something else!" },
-    ])
+    UpAndAtThem::Transaction[
+      UpAndAtThem::Commit.new { puts "do something!" }.on_rollback { "undo something!" },
+      UpAndAtThem::Commit.new { puts "do something else!" }.on_rollback { "undo something else!" }
+    ]
+
+The `UpAndAtThem::Transaction` array can contain any classes that respond to `#call` and `#rollback`. The
+`UpAndAtThem::Commit` class allows you to define those methods easily:
+
+    UpAndAtThem::Commit.new { "this block will execute on #call" }.on_rollback { "this block will execute on #rollback" }
+    UpAndAtThem::Commit.new { "calling on_rollback is not necessary" }
 
 See the tests for other example Commit actions within a Transaction.
 

data/lib/up_and_at_them/commit.rb

@@ -0,0 +1,24 @@
+module UpAndAtThem
+  class Commit
+
+    def initialize(&block)
+      raise LocalJumpError unless block_given?
+      @block = block
+    end
+
+    def on_rollback(&block)
+      raise LocalJumpError unless block_given?
+      @rollback = block
+      self
+    end
+
+    def call
+      @block.call
+    end
+
+    def rollback
+      @rollback.call if @rollback
+    end
+
+  end
+end

data/lib/up_and_at_them/transaction.rb

@@ -0,0 +1,25 @@
+module UpAndAtThem
+  class Transaction
+
+    def self.[](*tasks)
+      new(tasks)
+    end
+
+    def initialize(tasks)
+      @tasks = Array(tasks)
+      run
+    end
+
+    def run
+      finished_tasks = []
+      @tasks.each do |task|
+        task.call
+        finished_tasks << task
+      end
+    rescue => err
+      finished_tasks.reverse_each(&:rollback)
+      raise err
+    end
+
+  end
+end

data/lib/up_and_at_them/version.rb

@@ -1,3 +1,3 @@
 module UpAndAtThem
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/up_and_at_them.rb

@@ -1,47 +1,3 @@
-require "up_and_at_them/version"
-
-module UpAndAtThem
-  class Commit
-    def initialize(&block)
-      raise LocalJumpError unless block_given?
-      @block = block
-    end
-    def on_rollback(&block)
-      raise LocalJumpError unless block_given?
-      @rollback = block
-      self
-    end
-    def call
-      @block.call
-    end
-    def rollback
-      @rollback.call if @rollback
-    end
-  end
-
-  class Transaction
-    def initialize(tasks)
-      tasks = Array(tasks)
-      tasks.each do |t|
-        Commit === t or raise TypeError
-      end
-      @tasks = tasks
-      run
-    end
-
-    def run
-      finished_tasks = []
-      begin
-        @tasks.each do |task|
-          task.call
-          finished_tasks << task
-        end
-      rescue => err
-        finished_tasks.reverse_each do |task|
-          task.rollback
-        end
-        raise err
-      end
-    end
-  end
-end
+require 'up_and_at_them/version'
+require 'up_and_at_them/commit'
+require 'up_and_at_them/transaction'

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'rubygems'
+require 'bundler/setup'
+require 'up_and_at_them'
+
+RSpec.configure do |config|
+  config.order = :random
+end

data/spec/transaction_spec.rb

@@ -0,0 +1,80 @@
+describe UpAndAtThem::Transaction do
+
+  it 'rolls back past commits' do
+    flags = { 1 => :pending, 2 => :pending, 3 => :pending, 4 => :pending }
+    commits = (1...4).map do |i|
+      UpAndAtThem::Commit.new { flags[i] = :committed; if i==3 ; raise 'uh oh!'; end }.on_rollback { flags[i] = :rolled_back }
+    end
+    expect { UpAndAtThem::Transaction.new commits }.to raise_error(RuntimeError)
+    expect(flags[1]).to eq :rolled_back
+    expect(flags[4]).to eq :pending
+    expect(flags[3]).to eq :committed
+    expect(flags[2]).to eq :rolled_back
+  end
+
+  it 'rolls back in reverse commit order' do
+    flags = { 1 => -1, 2 => -1, 3 => -1, 4 => -1 }
+    commits = (1...4).map do |i|
+      UpAndAtThem::Commit.new { flags[i] = -1; if i==3 ; raise 'uh oh!'; end }.on_rollback { flags[i] = Time.now; sleep 1 }
+    end
+    expect { UpAndAtThem::Transaction.new commits }.to raise_error(RuntimeError)
+    expect(flags[4].to_f).to eq -1
+    expect(flags[3].to_f).to be < flags[2].to_f
+    expect(flags[2].to_f).to be < flags[1].to_f
+  end
+
+  it 'allows no-rollback commits' do
+    flags = {1 => :pending, 2 => :pending, 3 => :pending, 4 => :pending}
+    commits = (1...4).map do |i|
+      UpAndAtThem::Commit.new { flags[i] = :committed; if i==3 ; raise 'fail!'; end }
+    end
+    expect { UpAndAtThem::Transaction.new commits }.to raise_error(RuntimeError)
+    expect(flags[4]).to eq :pending
+    expect(flags[3]).to eq :committed
+    expect(flags[2]).to eq :committed
+    expect(flags[1]).to eq :committed
+  end
+
+  describe '.[]' do
+    it 'instantiates a new Transaction' do
+      commit = -> { raise 'fail!' }
+      expect { UpAndAtThem::Transaction[commit] }.to raise_error(RuntimeError)
+    end
+  end
+
+  describe 'duck typed Commits' do
+    class TestCommit
+      attr_reader :state
+
+      def initialize(fail = false)
+        @fail = fail
+        @state = :pending
+      end
+
+      def call
+        @state = :committed
+        raise if @fail
+      end
+
+      def rollback
+        @state = :rolled_back
+      end
+    end
+
+    it 'runs #call on each commit' do
+      commit = TestCommit.new
+      UpAndAtThem::Transaction[commit]
+      expect(commit.state).to eq :committed
+    end
+
+    it 'runs #rollback when the commit fails' do
+      commit1 = TestCommit.new
+      commit2 = TestCommit.new(true)
+      expect { UpAndAtThem::Transaction[commit1, commit2] }.to raise_error
+      expect(commit1.state).to eq :rolled_back
+      expect(commit2.state).to eq :committed
+    end
+
+  end
+
+end

data/up_and_at_them.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: up_and_at_them
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dave Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-07 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !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: A library for simplifying atomic transactions with the option for rollback
   of each operation in the transaction.
 email:
@@ -47,13 +61,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/up_and_at_them.rb
+- lib/up_and_at_them/commit.rb
+- lib/up_and_at_them/transaction.rb
 - lib/up_and_at_them/version.rb
-- test/test_transaction.rb
+- spec/spec_helper.rb
+- spec/transaction_spec.rb
 - up_and_at_them.gemspec
 homepage: http://github.com/metova/up_and_at_them
 licenses:
@@ -75,9 +93,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A library for simplifying atomic transactions.
 test_files:
-- test/test_transaction.rb
+- spec/spec_helper.rb
+- spec/transaction_spec.rb

data/test/test_transaction.rb

@@ -1,54 +0,0 @@
-require 'minitest/autorun'
-require 'up_and_at_them'
-
-class TransactionTest < MiniTest::Test
-  def test_rollback_past_commits
-    flags = {1 => :pending, 2 => :pending, 3 => :pending, 4 => :pending}
-
-    commits = Array.new
-    (1...4).each do |i|
-      commits << UpAndAtThem::Commit.new { flags[i] = :committed; if i==3 ; raise 'uh oh!'; end }.on_rollback { flags[i] = :rolled_back }
-    end
-
-    assert_raises RuntimeError do
-      UpAndAtThem::Transaction.new commits
-    end
-    assert_equal :pending, flags[4]
-    assert_equal :committed, flags[3]
-    assert_equal :rolled_back, flags[2]
-    assert_equal :rolled_back, flags[1]
-  end
-
-  def test_rollback_in_reverse_commit_order
-    flags = {1 => -1, 2 => -1, 3 => -1, 4 => -1}
-
-    commits = Array.new
-    (1...4).each do |i|
-      commits << UpAndAtThem::Commit.new { flags[i] = -1; if i==3 ; raise 'uh oh!'; end }.on_rollback { flags[i] = Time.now; sleep 1 }
-    end
-
-    assert_raises RuntimeError do
-      UpAndAtThem::Transaction.new commits
-    end
-    assert_equal -1, flags[4]
-    assert flags[3].to_f < flags[2].to_f
-    assert flags[2].to_f < flags[1].to_f
-  end
-
-  def test_allow_no_rollback_blocks
-    flags = {1 => :pending, 2 => :pending, 3 => :pending, 4 => :pending}
-
-    commits = Array.new
-    (1...4).each do |i|
-      commits << UpAndAtThem::Commit.new { flags[i] = :committed; if i==3 ; raise 'fail!'; end }
-    end
-
-    assert_raises RuntimeError do
-      UpAndAtThem::Transaction.new commits
-    end
-    assert_equal :pending, flags[4]
-    assert_equal :committed, flags[3]
-    assert_equal :committed, flags[2]
-    assert_equal :committed, flags[1]
-  end
-end