rails-workflow 1.4.11 → 1.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8bdc4bd121ea33bf5c173251fbad21009ddeb72
-  data.tar.gz: f593969d04cbb64b74cb551da7e7b06ca7e3fcd6
+  metadata.gz: 7d215275ad6a4ce79e08310152150012a3cc8ac0
+  data.tar.gz: 970e42fdc6b4d5f4d2cd78a76bcc365847792d45
 SHA512:
-  metadata.gz: a09a67020266baa7489303f5713e0fb346b8d8b6db32257332d4c96ec599cd7314888d4cb854479f76834c7d8f17f2d6e3249f16c262706162f7f44f9f97e98a
-  data.tar.gz: 4161bb384a19eef51d640ff64e0aefb6c3ff373b92259890b0f47428d81f1a21494c5e39b9a35f2126f2e5dd3df8b6da37347a9bc7e7704079bff86b1a8ff3e6
+  metadata.gz: 1955fd9145001d3ea4b2dc8bfa8b34e0fb612db028d0d8e24a0ccf01efb51a8a88cc4dd05787ad716419c5d7ec6e20da335031b59ae5cd892aad55bc312f18df
+  data.tar.gz: cf316591ef4198441c6c5b21f5220169d73ceeb68642c5cb8d357427413d8d072d3f5fb136744026177ad26892bc18aabac1de628a3723ebd50863f9cc4aa70a

data/lib/workflow/adapters/active_record.rb

@@ -63,16 +63,49 @@ module Workflow
           workflow_spec.states.each { |state| define_scopes(state) }
         end
 
+        # Find objects that are in a terminal state - no available
+        # event transitions
+        # @return [ActiveRecord::Relation] ActiveRecord query object meeting the criteria
+        def in_terminal_state
+          with_state workflow_spec.states.select(&:terminal?)
+        end
+
+        # Find objects that are not in a terminal state
+        # @return [ActiveRecord::Relation] ActiveRecord query object meeting the criteria
+        def not_in_terminal_state
+          with_state(workflow_spec.states.reject(&:terminal?))
+        end
+
+        # Locate objects that are in a state tagged with the given tag(s)
+        #
+        # @param [Symbol] tags List of tags that apply
+        # @return [ActiveRecord::Relation] ActiveRecord query object meeting the criteria
         def state_tagged_with(*tags)
-          states = workflow_spec.states.tagged_with(tags)
-          states.map! { |state| state.name.to_s }
-          where(workflow_state: states)
+          with_state workflow_spec.states.tagged_with(tags)
         end
 
+        # Locate objects that are not in a state tagged with the given tag(s)
+        #
+        # @param [Symbol] tags List of tags the objects (and their states) should not have
+        # @return [ActiveRecord::Relation] ActiveRecord query object meeting the criteria
         def state_not_tagged_with(*tags)
-          states = workflow_spec.states.tagged_with(tags)
-          states.map! { |state| state.name.to_s }
-          where.not(workflow_state: states)
+          with_state workflow_spec.states.not_tagged_with(tags)
+        end
+
+        # Find objects in the given state(s)
+        #
+        # @param [Object] states Symbol, String or {Workflow::State} objects
+        # @return [ActiveRecord::Relation] ActiveRecord query object meeting the criteria
+        def with_state(*states)
+          states = [states].flatten
+          states.map! do |state|
+            if state.is_a?(Workflow::State)
+              state.name.to_s
+            else
+              state.to_s
+            end
+          end
+          where(workflow_state: states)
         end
 
         private

data/lib/workflow/version.rb

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

metadata

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