enum_state_machine 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3ae151dc70ba36b4e8fe6269c557282d7651c302
-  data.tar.gz: a03562029134f816981feddf364bc0d45807ced7
+SHA256:
+  metadata.gz: b789f253ef713a0650807bc1d06439252411fca86b15c7c9947dfa466edb104b
+  data.tar.gz: dd54f68b6bd0ff062c98ab75bcfd4444e4879820a831a5def374845fcfec8380
 SHA512:
-  metadata.gz: 4529e8a2615e81a8a8e3639de6db2b2856b70fe325315efee427cc08627e0c49d3cb97a8fa4b9fd7e6ea937b656a455e06b53081cad3326ed53bc7c7456466ae
-  data.tar.gz: e3027199f6a2a345016d4f59f9c9aae5960b5717044f986cc0e782caea6ba0816e7a0f0c1654c1c2bdbe8363a01f1b3459ccd0cf5165ab6c94f194a1600a34a1
+  metadata.gz: 3d35efc93d0045b153105ddb01499a4b09db5d70acf740ab3ac1ac9b106d5f917042491604c2702b40137acdd317e0b0d4bc4c8c1670146010c6c5915ea9f3ad
+  data.tar.gz: 73389b3df7fe1d451e81321e4eee3e0c4714fcf89270ac1afd10094aca807df6543d8785f79884869f3f6b807d16b61edf0cd3763e1e897c83bb040cf7ea8117

data/.ruby-version

@@ -1 +1 @@
-2.1.2
+2.6.5

data/README.md

@@ -1,4 +1,75 @@
-##enum_state_machine
+## enum_state_machine
 ==================
 
-state_machine patches to use PowerEnum enums for state values.
+`state_machine` patches to use PowerEnum enums for state values.
+It allows you to use an enumerated attribute to track a state machine status.
+
+## Installation:
+
+Add the following to your Gemfile:
+
+```ruby
+gem 'enum_state_machine'
+```
+
+## Usage:
+
+Before using this you must familiarize yourself with the [PowerEnum](https://github.com/albertosaurus/power_enum_2)
+and [state_machine](https://github.com/pluginaweek/state_machine) gems.
+
+Include `EnumStateMachine::StateEnum` in our model. That adds a single method that is used to define an enumerated state attribute:
+
+```ruby
+# state_attr is the name of the state variable
+# enum_attr is the name of the underlying enumerated attribute
+# enum_opts are options to be passed to has_enumerated
+has_state_enum(state_attr, enum_attr, enum_opts = {})
+```
+
+This is best illustrated with an example. Suppose you have a Grenade model that can have four possible states: stored, armed, kaboom, and fizzle.
+
+```ruby
+
+# Migration
+
+create_enum :grenade_status
+
+create_table :grenades do |t|
+  t.references :grenade_statuses
+  t.boolean :is_defective
+
+  t.timestamps
+end
+
+# Seeds
+
+GrenadeStatus.update_enumerations_model do
+  [:unarmed, :armed, :kaboom, :fizzle].each { |name| GrenadeStatus.create! name: name }
+end
+
+# Models
+
+class GrenadeStatus < ActiveRecord::Base
+  acts_as_enumerated
+end
+
+class Grenade < ActiveRecord::Base
+  include EnumStateMachine::StateEnum
+  has_state_enum :status, :grenade_status, default: :unarmed
+
+  state_machine :status, initial: :unarmed do
+    event :pulled_pin do
+      transition :unarmed => :armed
+    end
+
+    event :thrown do
+      # a defective grenade won't explode
+      transition :armed => :fizzle, :if => :is_defective?
+      # a normal armed one will explode
+      transition :armed => :kaboom
+      # If you forgot to pull the pin, nothing happens
+      transition :unarmed => :unarmed
+    end
+  end
+end
+```

data/enum_state_machine.gemspec

@@ -17,11 +17,10 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files  = %w(README.md CHANGELOG.md LICENSE)
   s.license           = 'MIT'
 
-  s.add_dependency "rails", "~> 4.0"
-
-  s.add_dependency "activerecord-deprecated_finders", "~> 1.0.3"
-  #s.add_dependency "rails-observers", "~> 0.1.2"
-  s.add_dependency "power_enum", "~> 2.7"
+  s.add_dependency "rails", "> 4.0", "< 7.0"
+  s.add_dependency "activerecord-deprecated_finders", ">= 1.0.3"
+  #s.add_dependency "rails-observers", ">= 0.1.2"
+  s.add_dependency "power_enum", "> 2.8", "< 4.0"
 
   s.add_development_dependency "rake"
   s.add_development_dependency "minitest", "~> 5.1"

data/lib/enum_state_machine/integrations/active_record.rb

@@ -455,10 +455,17 @@ module EnumStateMachine
           # attributes passed into #initialize
           define_helper :class, <<-end_eval, __FILE__, __LINE__ + 1
             def column_defaults(*) #:nodoc:
-              result = super
+              @column_defaults = super
+              return @column_defaults if @column_defaults_are_set
+              @column_defaults_are_set = true
+
+              was_frozen = @column_defaults.frozen?
+              @column_defaults = @column_defaults.deep_dup if was_frozen
+
               # No need to pass in an object, since the overrides will be forced
-              self.state_machines.initialize_states(nil, :static => :force, :dynamic => false, :to => result)
-              result
+              self.state_machines.initialize_states(nil, :static => :force, :dynamic => false, :to => @column_defaults)
+
+              @column_defaults.tap { |defaults| defaults.freeze if was_frozen }
             end
           end_eval
         end

data/lib/enum_state_machine/version.rb

@@ -1,3 +1,3 @@
 module EnumStateMachine
-  VERSION = "0.4.0"
+  VERSION = "0.7.0"
 end

data/test/unit/event_test.rb

@@ -247,7 +247,7 @@ class EventWithConflictingHelpersAfterDefinitionTest < MiniTest::Test
     end
     
     assert_equal false, @object.can_ignite?
-    assert_equal nil, @object.ignite_transition
+    assert_nil @object.ignite_transition
     assert_equal false, @object.ignite
     assert_raises(EnumStateMachine::InvalidTransition) { @object.ignite! }
   end
@@ -764,7 +764,7 @@ class EventWithTransitionWithNilToStateTest < MiniTest::Test
     transition = @event.transition_for(@object)
     refute_nil transition
     assert_equal 'idling', transition.from
-    assert_equal nil, transition.to
+    assert_nil transition.to
     assert_equal :park, transition.event
   end
   
@@ -774,7 +774,7 @@ class EventWithTransitionWithNilToStateTest < MiniTest::Test
   
   def test_should_not_change_the_current_state
     @event.fire(@object)
-    assert_equal nil, @object.state
+    assert_nil @object.state
   end
 end
 

data/test/unit/machine_test.rb

@@ -1847,10 +1847,10 @@ class MachineWithConflictingHelpersAfterDefinitionTest < MiniTest::Test
     assert_equal 'parked', @klass.human_state_name(:parked)
     assert_equal 'ignite', @klass.human_state_event_name(:ignite)
     
-    assert_equal nil, @object.state
+    assert_nil @object.state
     @object.state = 'idling'
     assert_equal 'idling', @object.state
-    assert_equal nil, @object.status
+    assert_nil @object.status
     assert_equal false, @object.state?(:parked)
     assert_equal :idling, @object.state_name
     assert_equal 'idling', @object.human_state_name

data/test/unit/transition_collection_test.rb

@@ -79,7 +79,7 @@ class TransitionCollectionEmptyWithBlockTest < MiniTest::Test
   end
   
   def test_should_use_block_reslut_if_nil
-    assert_equal nil, @transitions.perform { nil }
+    assert_nil @transitions.perform { nil }
   end
 end
 

metadata

@@ -1,57 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: enum_state_machine
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - The HornsAndHooves Team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-09-19 00:00:00.000000000 Z
+date: 2022-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activerecord-deprecated_finders
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: power_enum
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -248,7 +260,7 @@ homepage: https://github.com/HornsAndHooves/enum_state_machine
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--line-numbers"
 - "--inline-source"
@@ -269,9 +281,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Enum State machines for attributes
 test_files:
@@ -309,4 +320,3 @@ test_files:
 - test/unit/state_test.rb
 - test/unit/transition_collection_test.rb
 - test/unit/transition_test.rb
-has_rdoc: