statesman 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb317c62d61044bf3d15ec90a14682f330f4ea86
-  data.tar.gz: df1622719c738cfdafd5925042a0ba8c0c4d612c
+  metadata.gz: 697717ea3c8a4b388c0b43a8777d9c1a18e147c1
+  data.tar.gz: 14051a4eacb2979013b8ff8e88698e9be6cff436
 SHA512:
-  metadata.gz: ce715eb5662eb4758d9d637d0575d5cec80859b859400699f783088ec64cdad1a2a661cad2d816e8e14fc03f7b91ec4e4305b64d973eaad959c2112d0ea573b3
-  data.tar.gz: e649cc276449930c9e8615707cf993572a090635e3cdaea838d82c77f825a880243c644a368a76522b7da2c9debb2656d978e71e92538ef52240b74781fe24a3
+  metadata.gz: 8fef4baf05db94227a2d3d9b2cbce8b7de0b0cc4eebacc6c3c04d879562b823c0903f8044ed36c2d0ba30443600ce7e04b1d109aa0fd4b501a85be51d2e640cc
+  data.tar.gz: 34deb50e48efc779d09ddff16b61afa90c7a36c263af58f8af8f1995ff8db1ca01a610e00182b9b11eed8d3a665b768c2d4c86dfeecd336e73e47efb90da53f0

data/.travis.yml

@@ -1,4 +1,5 @@
 rvm:
+  - 2.1.0
   - 2.0.0
   - 1.9.3
 services: mongodb

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## v 0.6.1 21 May 2014
+## v0.7.0 25 June 2014
+*Additions*
+
+- `Adapters::ActiveRecord` now handles `ActiveRecord::RecordNotUnique` errors explicitly and re-raises with a `Statesman::TransitionConflictError` if it is due to duplicate sort_keys (patch by [@greysteil](https://github.com/greysteil))
+
+## v0.6.1 21 May 2014
 *Fixes*
 - Fixes an issue where the wrong transition was passed to after_transition callbacks for the second and subsequent transition of a given state machine (patch by [@alan](https://github.com/alan))
 

data/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+Thanks for taking an interest in contributing to Statesman, here are a few
+ways you can help make this project better!
+
+# Contribute.md
+
+## Team members
+
+- [Andy Appleton](https://twitter.com/appltn)
+- [Harry Marr](https://twitter.com/harrymarr)
+
+## Contributing
+
+- Generally we welcome new features but please first open an issue where we 
+  can discuss whether it fits with our vision for the project.
+- Any new feature or bug fix needs an accompanying test case.
+- No need to add to the changelog, we will take care of updating it as we make
+  releases.
+
+## Style
+
+We use [Rubocop](https://github.com/bbatsov/rubocop) to help maintain a
+consistent code style across the project. Please check that your pull
+request passes by running `rubocop`.
+
+## Documentation
+
+Please add a section to the readme for any new feature additions or behaviour
+changes.

data/README.md

@@ -150,6 +150,8 @@ Statesman defaults to storing transitions in memory. If you're using rails, you
 can instead configure it to persist transitions to the database by using the
 ActiveRecord or Mongoid adapter.
 
+Statesman will fallback to memory unless you specify a transition_class when instantiating your state machine. This allows you to only persist transitions on certain state machines in your app.
+
 
 ## Class methods
 
@@ -260,4 +262,4 @@ Returns all models not currently in any of the supplied states.
 
 ---
 
-GoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/jobs/backend_developer).
+GoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/jobs#software-engineer).

data/lib/statesman/adapters/active_record.rb

@@ -7,9 +7,15 @@ module Statesman
       attr_reader :parent_model
 
       def initialize(transition_class, parent_model, observer)
-        unless transition_class.serialized_attributes.include?("metadata")
+        serialized = transition_class.serialized_attributes.include?("metadata")
+        column_type = transition_class.columns_hash['metadata'].sql_type
+        if !serialized && column_type != 'json'
           raise UnserializedMetadataError,
                 "#{transition_class.name}#metadata is not serialized"
+        elsif serialized && column_type == 'json'
+          raise IncompatibleSerializationError,
+                "#{transition_class.name}#metadata column type cannot be json
+                  and serialized simultaneously"
         end
         @transition_class = transition_class
         @parent_model = parent_model
@@ -17,20 +23,15 @@ module Statesman
       end
 
       def create(from, to, metadata = {})
-        transition = transitions_for_parent.build(to_state: to,
-                                                  sort_key: next_sort_key,
-                                                  metadata: metadata)
-
-        ::ActiveRecord::Base.transaction do
-          @observer.execute(:before, from, to, transition)
-          transition.save!
-          @last_transition = transition
-          @observer.execute(:after, from, to, transition)
-          @last_transition = nil
+        create_transition(from, to, metadata)
+      rescue ::ActiveRecord::RecordNotUnique => e
+        if e.message.include?('sort_key') &&
+          e.message.include?(@transition_class.table_name)
+          raise TransitionConflictError, e.message
+        else raise
         end
-        @observer.execute(:after_commit, from, to, transition)
-
-        transition
+      ensure
+        @last_transition = nil
       end
 
       def history
@@ -47,6 +48,22 @@ module Statesman
 
       private
 
+      def create_transition(from, to, metadata)
+        transition = transitions_for_parent.build(to_state: to,
+                                                  sort_key: next_sort_key,
+                                                  metadata: metadata)
+
+        ::ActiveRecord::Base.transaction do
+          @observer.execute(:before, from, to, transition)
+          transition.save!
+          @last_transition = transition
+          @observer.execute(:after, from, to, transition)
+        end
+        @observer.execute(:after_commit, from, to, transition)
+
+        transition
+      end
+
       def transitions_for_parent
         @parent_model.send(@transition_class.table_name)
       end

data/lib/statesman/adapters/mongoid.rb

@@ -25,8 +25,9 @@ module Statesman
         @last_transition = transition
         @observer.execute(:after, from, to, transition)
         @observer.execute(:after_commit, from, to, transition)
-        @last_transition = nil
         transition
+      ensure
+        @last_transition = nil
       end
 
       def history

data/lib/statesman/exceptions.rb

@@ -5,4 +5,6 @@ module Statesman
   class GuardFailedError < StandardError; end
   class TransitionFailedError < StandardError; end
   class UnserializedMetadataError < StandardError; end
+  class IncompatibleSerializationError < StandardError; end
+  class TransitionConflictError < StandardError; end
 end

data/lib/statesman/machine.rb

@@ -143,8 +143,8 @@ module Statesman
                       })
       @object = object
       @transition_class = options[:transition_class]
-      @storage_adapter = Statesman.storage_adapter.new(
-                                            @transition_class, object, self)
+      @storage_adapter = adapter_class(@transition_class)
+                          .new(@transition_class, object, self)
       send(:after_initialize) if respond_to? :after_initialize
     end
 
@@ -202,6 +202,14 @@ module Statesman
 
     private
 
+    def adapter_class(transition_class)
+      if transition_class == Statesman::Adapters::MemoryTransition
+        Adapters::Memory
+      else
+        Statesman.storage_adapter
+      end
+    end
+
     def successors_for(from)
       self.class.successors[from] || []
     end

data/lib/statesman/version.rb

@@ -1,3 +1,3 @@
 module Statesman
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/spec/statesman/adapters/active_record_spec.rb

@@ -18,16 +18,78 @@ describe Statesman::Adapters::ActiveRecord do
   it_behaves_like "an adapter", described_class, MyActiveRecordModelTransition
 
   describe "#initialize" do
-    context "with unserialized metadata" do
-      before { MyActiveRecordModelTransition.stub(serialized_attributes: {}) }
+    context "with unserialized metadata and non json column type" do
+      before do
+        metadata_column = double
+        metadata_column.stub(sql_type: '')
+        MyActiveRecordModelTransition.stub(columns_hash:
+                                           { 'metadata' => metadata_column })
+        MyActiveRecordModelTransition.stub(serialized_attributes: {})
+      end
 
-      it "raises an exception if metadata is not serialized" do
+      it "raises an exception" do
         expect do
           described_class.new(MyActiveRecordModelTransition,
                               MyActiveRecordModel, observer)
         end.to raise_exception(Statesman::UnserializedMetadataError)
       end
     end
+
+    context "with serialized metadata and json column type" do
+      before do
+        metadata_column = double
+        metadata_column.stub(sql_type: 'json')
+        MyActiveRecordModelTransition.stub(columns_hash:
+                                           { 'metadata' => metadata_column })
+        MyActiveRecordModelTransition.stub(serialized_attributes:
+                                           { 'metadata' => '' })
+      end
+
+      it "raises an exception" do
+        expect do
+          described_class.new(MyActiveRecordModelTransition,
+                              MyActiveRecordModel, observer)
+        end.to raise_exception(Statesman::IncompatibleSerializationError)
+      end
+    end
+  end
+
+  describe "#create" do
+    let(:adapter) do
+      described_class.new(MyActiveRecordModelTransition, model, observer)
+    end
+    let(:from) { :x }
+    let(:to) { :y }
+    let(:create) { adapter.create(from, to) }
+    subject { -> { create } }
+
+    context "when there is a race" do
+      it "raises a TransitionConflictError" do
+        adapter2 = adapter.dup
+        adapter2.create(:x, :y)
+        adapter.last
+        adapter2.create(:y, :z)
+        expect { adapter.create(:y, :z) }
+          .to raise_exception(Statesman::TransitionConflictError)
+      end
+    end
+
+    context "when other exceptions occur" do
+      before do
+        allow_any_instance_of(MyActiveRecordModelTransition)
+          .to receive(:save!).and_raise(error)
+      end
+
+      context "ActiveRecord::RecordNotUnique unrelated to this transition" do
+        let(:error) { ActiveRecord::RecordNotUnique.new("unrelated", nil) }
+        it { should raise_exception(ActiveRecord::RecordNotUnique) }
+      end
+
+      context "other errors" do
+        let(:error) { StandardError }
+        it { should raise_exception(StandardError) }
+      end
+    end
   end
 
   describe "#last" do

data/spec/statesman/machine_spec.rb

@@ -203,6 +203,13 @@ describe Statesman::Machine do
           .with(my_transition_class, my_model, anything)
         machine.new(my_model, transition_class: my_transition_class)
       end
+
+      it "falls back to Memory without transaction_class" do
+        Statesman.stub(:storage_adapter).and_return(Class.new)
+        Statesman::Adapters::Memory.should_receive(:new).once
+          .with(Statesman::Adapters::MemoryTransition, my_model, anything)
+        machine.new(my_model)
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Harry Marr
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,6 +162,7 @@ files:
 - .rubocop.yml
 - .travis.yml
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -229,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A statesmanlike state machine library