literal_enums 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5032b916232ac6faa5494185fcf1fd84914e3e7781f791a0466e9b7617d136b9
-  data.tar.gz: b7ab5c1a471672329cbd2f23707d206cd214c4bdb1b066ba908124750acd4e50
+  metadata.gz: 5966057536538f9691058988d2ead560f4c0827325d5334db07326f3d61ce73a
+  data.tar.gz: 76be2563d5184035fffb3df734c3578a140daf222e1c53f39d581f25db7dcfb1
 SHA512:
-  metadata.gz: 609cbdcfa378843a507deb5d01b9da8a66e5d91a5e3b96b723a57af19e1cb3cb056fa4c9eac7bee96edec89544ce3e8d290c3da3cc664c30d09b9796a0fe4577
-  data.tar.gz: 7f58231fbdad7bd52c717a0a05922661945fee6b0db62604bb85ee05d52fc62d9bc77071f11e7a8466cf84acc1f9911bca2e03481dad2e215b8d801dd25da432
+  metadata.gz: 570244eab14a91efd59a10267cbd05d0b41c2fbb5709486476a483e9877844e73658a99813b20e41f0912d91f4964e93bbac4832f810fd8fc9fd4e560c9495da
+  data.tar.gz: c2cecc679d71e18fcc14443ded0d082b9fc6ef051f9d325a0e7e89fdf149d554c7bc3e34cec9dfc20e363d89b3996ea34012a138d92e75e527fb9ae9c4681d6e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    literal_enums (1.0.0)
+    literal_enums (1.1.0)
       activesupport (~> 7.0.2.2)
 
 GEM

data/README.md

@@ -90,50 +90,50 @@ It is also possible to define a more complex state machine by defining `transiti
 
 ```ruby
 class State < Enum
-  Unprocessed do
+  Pending do
     def transitions_to
-      [Validated, Errored]
+      [Approved, Rejected]
     end
   end
 
-  Validated do
+  Approved do
     def transitions_to
-      [Published, Errored]
+      Published
     end
   end
 
-  Published do
+  Rejected do
     def transitions_to
-      [Processed, Errored]
+      Deleted
     end
   end
 
-  Processed()
-  Errored()
+  Deleted()
+  Published()
 end
 ```
 
 Given the above definition, we can transition from one state to another by calling `transition_to` with the newly desired state. This will raise a `LiteralEnums::TransitionError` if the transition is invalid.
 
 ```ruby
-State::Unprocessed.transition_to(State::Validated) # returns State::Validated.
-State::Unprocessed.transition_to(State::Processed) # raises a LiteralEnums::TransitionError.
+State::Pending.transition_to(State::Approved) # returns State::Approved.
+State::Pending.transition_to(State::Published) # raises a LiteralEnums::TransitionError.
 ```
 
 Alternatively, we can call the new state as a method on the old state.
 
 ```ruby
-State::Unprocessed.validated # returns State::Validated.
+State::Pending.approved # returns State::Approved.
 ```
 
-An invalid transition will return a `NoMethodErorr` in this case as the method is not defined.
+An invalid transition would return a `NoMethodErorr` in this case as the method is not defined.
 
 The advantage of using method calls to transition from one state to anotehr is the method calls can be chained.
 
 ```ruby
-State::Unprocessed.validated.processed # returns State::Processed, since it's valid to
-                                       # move to State::Processed from State::Validated and it's
-                                       # valid to move to State::Validated from State::Unprocessed.
+State::Pending.approved.published # returns State::Published, since it's valid to
+                                  # move to State::Published from State::Approved and it's
+                                  # valid to move to State::Approved from State::Pending.
 ```
 
 ## Installation

data/lib/enum.rb

@@ -1,9 +1,9 @@
 class Enum
+  extend Enumerable
   include LiteralEnums::Transitions
 
   attr_reader :name, :value
 
-  alias_method :to_s, :value
   alias_method :inspect, :name
 
   def initialize(name, value)
@@ -22,7 +22,7 @@ class Enum
     end
 
     def values
-      members.map(&:value).to_set
+      map(&:value).to_set
     end
 
     def each(&block)

data/lib/literal_enums/version.rb

@@ -1,3 +1,3 @@
 module LiteralEnums
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: literal_enums
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Joel Drapper