rails-workflow 1.4.12 → 1.4.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d215275ad6a4ce79e08310152150012a3cc8ac0
-  data.tar.gz: 970e42fdc6b4d5f4d2cd78a76bcc365847792d45
+  metadata.gz: 30ada397c29addd3b7b628691797ac590f7214d0
+  data.tar.gz: 0e7375ee4380363fb96ac04c3f7e3d62608e9ed4
 SHA512:
-  metadata.gz: 1955fd9145001d3ea4b2dc8bfa8b34e0fb612db028d0d8e24a0ccf01efb51a8a88cc4dd05787ad716419c5d7ec6e20da335031b59ae5cd892aad55bc312f18df
-  data.tar.gz: cf316591ef4198441c6c5b21f5220169d73ceeb68642c5cb8d357427413d8d072d3f5fb136744026177ad26892bc18aabac1de628a3723ebd50863f9cc4aa70a
+  metadata.gz: 349149ca15104eb4a9aef2f48d3090a48434b60e0842f6be06de9bece667c8119d6f0f220e5f28f70f8898d0db70b2a85278108b73d91e9815b8fe1c69932086
+  data.tar.gz: ad54fca54b8276f34badbc4e80c6ff2e72bca982ed501b1cc5b1d9dfeafc283206db9a8eb748ef8d3663cb62d39a415774fe9d6e042323f1ccab732ef9b15ed5

data/lib/workflow/adapters/active_record.rb

@@ -37,14 +37,26 @@ module Workflow
         write_attribute self.class.workflow_column, current_state.name
       end
 
-      # This module will automatically generate ActiveRecord scopes based on workflow states.
-      # The name of each generated scope will be something like `with_<state_name>_state`
+      # Scopes for the ActiveRecord entity class.
       #
-      # Examples:
+      # Two scopes for each {Workflow::State} specified plus some general ones:
       #
+      # Examples:
+      # ~~~ruby
+      # class Article < ApplicationRecord
+      #   include Workflow
+      #   state :pending, tags: :some_tag do
+      #     on :submit, to: :submitted
+      #   end
+      #   state :submitted
+      # end
       # Article.with_pending_state # => ActiveRecord::Relation
-      # Payment.without_refunded_state # => ActiveRecord::Relation
-      # `
+      # Article.without_pending_state # => ActiveRecord::Relation
+      # Article.state_tagged_with(:some_tag, :another_tag)
+      # Article.state_not_tagged_with(:some_tag)
+      # Article.in_terminal_state
+      #
+      # ~~~
       # Example above just adds `where(:state_column_name => 'pending')` or
       # `where.not(:state_column_name => 'pending')` to AR query and returns
       # ActiveRecord::Relation.

data/lib/workflow/specification.rb

@@ -57,6 +57,16 @@ module Workflow
       states.find { |t| t.name == name.to_sym }
     end
 
+    # @return [Array] Array of unique event names defined for this workflow spec.
+    def event_names
+      events.map(&:name).uniq
+    end
+
+    # @return [Array] Names of states defined on this workflow spec.
+    def state_names
+      states.map(&:name)
+    end
+
     # @api private
     #
     # @param [Hash] meta Metadata

data/lib/workflow/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Workflow
-  VERSION = '1.4.12'
+  VERSION = '1.4.13'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-workflow
 version: !ruby/object:Gem::Version
-  version: 1.4.12
+  version: 1.4.13
 platform: ruby
 authors:
 - Tyler Gannon