enum_state_machine 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ae151dc70ba36b4e8fe6269c557282d7651c302
-  data.tar.gz: a03562029134f816981feddf364bc0d45807ced7
+  metadata.gz: f0fff66d7a0561056a0a44726a3ae5d94d5d9d24
+  data.tar.gz: 1ea8c3370bd2d8c15379c4aa898d2f7e9088aed9
 SHA512:
-  metadata.gz: 4529e8a2615e81a8a8e3639de6db2b2856b70fe325315efee427cc08627e0c49d3cb97a8fa4b9fd7e6ea937b656a455e06b53081cad3326ed53bc7c7456466ae
-  data.tar.gz: e3027199f6a2a345016d4f59f9c9aae5960b5717044f986cc0e782caea6ba0816e7a0f0c1654c1c2bdbe8363a01f1b3459ccd0cf5165ab6c94f194a1600a34a1
+  metadata.gz: 43c264aa10cd9ad765f69f17509e9412199b48a5246c3887377335bb4dc207a340099639dee6b8d87a569fc3ae5604569644a7e82c6ca38879c29828480c8c16
+  data.tar.gz: 4793fdab192b45767e9174a184b28710fc83f9afb291df56dcf44d5bf4a5783a89e2663ce99534bffe96abd084719f7d57e354769eac4a9ce3a498a2f0f31d9f

data/.ruby-version

@@ -1 +1 @@
-2.1.2
+2.2.4

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

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
 
   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 "power_enum", "> 2.8", "< 4.0"
 
   s.add_development_dependency "rake"
   s.add_development_dependency "minitest", "~> 5.1"

data/lib/enum_state_machine/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enum_state_machine
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - The HornsAndHooves Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-19 00:00:00.000000000 Z
+date: 2017-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -42,16 +42,22 @@ dependencies:
   name: power_enum
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        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
@@ -270,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Enum State machines for attributes
@@ -309,4 +315,3 @@ test_files:
 - test/unit/state_test.rb
 - test/unit/transition_collection_test.rb
 - test/unit/transition_test.rb
-has_rdoc: