statesman 1.0.0.beta1 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55f5eab4bdf1849056059ca216caa5412679967d
-  data.tar.gz: 56d537766abea0884d94e4a55a9051896bbfc902
+  metadata.gz: 5acbb511b8785176c360bef3aa219e6032f04cea
+  data.tar.gz: a3e42e31f916ce396904a0e5dc7a687643ee124a
 SHA512:
-  metadata.gz: b2bead7fc506334da98f4ab620cb6df1fd49012a3a77c3accb8e779e8f09212e3b9926c5ea145ea7d0d3df2f69db13808d05bb65ec55fdfbb39be3ea55d4e915
-  data.tar.gz: e9c8295a8eca68e22debdb594c4802bdd554c18b6a26b4e7d3940fed0673436bf5aa917b4b3a188191b867f6cb4532d08f9383e378d771752ca4b0e91eab1790
+  metadata.gz: 9df0ba4a9e60e6f9eab79a028d580f59f19b95cf8de5a95ca27b496f0ead46634b12160c3bb6984eee5ed4b9d763360a71172cee48159d15bb42987902291828
+  data.tar.gz: 81796ee3bae3a594dedb93ad2c9d45793e955ca96501a3221de013d74d9ba8816889c7a219071b4660e2a8aaf9301f2f7c6759727d366e4d792a53b595dd5197

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## v1.0.0.rc1 9 October 2014
+## v1.0.0.beta2 10 October 2014
+*Breaking changes*
+
+- Rename `ActiveRecordModel` to `ActiveRecordQueries`, to reflect the fact that it mixes in some helpful scopes, but is not required.
+
+## v1.0.0.beta1 9 October 2014
 *Breaking changes*
 
 - Classes which include `ActiveRecordModel` must define an `initial_state` class method.

data/README.md

@@ -53,7 +53,7 @@ class OrderStateMachine
 end
 
 class Order < ActiveRecord::Base
-  include Statesman::Adapters::ActiveRecordModel
+  include Statesman::Adapters::ActiveRecordQueries
 
   has_many :order_transitions
 
@@ -66,6 +66,10 @@ class Order < ActiveRecord::Base
   def self.transition_class
     OrderTransition
   end
+
+  def self.initial_state
+    :pending
+  end
 end
 
 class OrderTransition < ActiveRecord::Base
@@ -335,7 +339,7 @@ model and define `transition_class` and `initial_state` class methods:
 
 ```ruby
 class Order < ActiveRecord::Base
-  include Statesman::Adapters::ActiveRecordModel
+  include Statesman::Adapters::ActiveRecordQueries
 
   private
 
@@ -357,16 +361,6 @@ Returns all models not currently in any of the supplied states. Prior to 1.0 thi
 
 ## Frequently Asked Questions
 
-#### `Model.in_state` does not work before first transition
-
-This is expected. State is modelled as a series of tranisitions so initially where there has been no transition, there is no explict state. At GoCardless we get around this by transitioning immediately after creation:
-
-```ruby
-after_create do
-  state_machine.transition_to! "pending"
-end
-```
-
 #### Storing the state on the model object
 
 If you wish to store the model state on the model directly, you can keep it up to date using an `after_transition` hook:
@@ -378,6 +372,8 @@ after_transition do |model, transition|
 end
 ```
 
+You could also use a calculated column or view in your database.
+
 #### Accessing metadata from the last transition
 
 Given a field `foo` that was stored in the metadata, you can access it like so:

data/lib/statesman/adapters/{active_record_model.rb → active_record_queries.rb}

@@ -1,6 +1,6 @@
 module Statesman
   module Adapters
-    module ActiveRecordModel
+    module ActiveRecordQueries
       def self.included(base)
         base.extend(ClassMethods)
       end

data/lib/statesman/version.rb

@@ -1,3 +1,3 @@
 module Statesman
-  VERSION = "1.0.0.beta1"
+  VERSION = "1.0.0.beta2"
 end

data/lib/statesman.rb

@@ -9,8 +9,8 @@ module Statesman
     autoload :ActiveRecord, "statesman/adapters/active_record"
     autoload :ActiveRecordTransition,
              "statesman/adapters/active_record_transition"
-    autoload :ActiveRecordModel,
-             "statesman/adapters/active_record_model"
+    autoload :ActiveRecordQueries,
+             "statesman/adapters/active_record_queries"
     autoload :Mongoid,      "statesman/adapters/mongoid"
     autoload :MongoidTransition,
              "statesman/adapters/mongoid_transition"

data/spec/statesman/adapters/{active_record_model_spec.rb → active_record_queries_spec.rb}

@@ -1,13 +1,13 @@
 require "spec_helper"
 
-describe Statesman::Adapters::ActiveRecordModel do
+describe Statesman::Adapters::ActiveRecordQueries do
   before do
     prepare_model_table
     prepare_transitions_table
   end
 
   before do
-    MyActiveRecordModel.send(:include, Statesman::Adapters::ActiveRecordModel)
+    MyActiveRecordModel.send(:include, Statesman::Adapters::ActiveRecordQueries)
     MyActiveRecordModel.class_eval do
       def self.transition_class
         MyActiveRecordModelTransition

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Harry Marr
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-09 00:00:00.000000000 Z
+date: 2014-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -193,7 +193,7 @@ files:
 - lib/generators/statesman/templates/update_migration.rb.erb
 - lib/statesman.rb
 - lib/statesman/adapters/active_record.rb
-- lib/statesman/adapters/active_record_model.rb
+- lib/statesman/adapters/active_record_queries.rb
 - lib/statesman/adapters/active_record_transition.rb
 - lib/statesman/adapters/memory.rb
 - lib/statesman/adapters/memory_transition.rb
@@ -210,7 +210,7 @@ files:
 - spec/generators/statesman/migration_generator_spec.rb
 - spec/generators/statesman/mongoid_transition_generator_spec.rb
 - spec/spec_helper.rb
-- spec/statesman/adapters/active_record_model_spec.rb
+- spec/statesman/adapters/active_record_queries_spec.rb
 - spec/statesman/adapters/active_record_spec.rb
 - spec/statesman/adapters/active_record_transition_spec.rb
 - spec/statesman/adapters/memory_spec.rb
@@ -254,7 +254,7 @@ test_files:
 - spec/generators/statesman/migration_generator_spec.rb
 - spec/generators/statesman/mongoid_transition_generator_spec.rb
 - spec/spec_helper.rb
-- spec/statesman/adapters/active_record_model_spec.rb
+- spec/statesman/adapters/active_record_queries_spec.rb
 - spec/statesman/adapters/active_record_spec.rb
 - spec/statesman/adapters/active_record_transition_spec.rb
 - spec/statesman/adapters/memory_spec.rb