steady_state 1.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02e5f7eb48f3ada429e0d38598535c77489ab57172d920c2dbb6083a19dc5466
-  data.tar.gz: bbc957eeed78c83b1a7e2c49395df741ba34eea99d3d4adaabdbbabe1298bb06
+  metadata.gz: 4824f112c40684778015b921d582801f2b95c134ed2881ed8c87e346a2bfcad2
+  data.tar.gz: 64837c8febda4b8b4adce2261e7a5a8b43014bdc5e09b3dec8c2543d86b0f6e1
 SHA512:
-  metadata.gz: a2f28a60fae258f08f3bb57925419c86015d4dc5d738667fffe8e943223fe3603a0a90960653ff2b1d171dac4f077e50b113b4f5b5024da5cb5c8f58a950a096
-  data.tar.gz: 3fd2023e60bb8ff68c5ea40dcc4a263184fe0698ff3d3507dd7b02ecacf8417bcb9e9b0f44c1d789513994ac5010211b1c50716cdedc7f4eb39f21213a481f5f
+  metadata.gz: f3b3ba6cc7e0317163d8b65c3a0f4033f34f6b5066c09c2ae8af7c6daf380943f03a2a49710142675931d23ff6b8037d033cb489562fac514142558d727ad09d
+  data.tar.gz: c8c835c627ee902f045dd72188ed26f4112cf9722ff8827c1bae3589029141ff8e1c8d7bed8d0a18bf3aabb8b39cd3224c6b211ca3bde95d3deedb51a69ebba4

data/README.md

@@ -210,6 +210,22 @@ steady_state :step, scopes: false do
 end
 ```
 
+`steady_state` also follows the same `prefix` api as `delegate` in Rails.  You may optionally define your scopes to be prefixed to the name of the state machine with `prefix: true`, or you may provide a custom prefix with `prefix: :some_custom_name`.  This may be useful when dealing with multiple state machines on one object.
+
+```ruby
+steady_state :temperature, scopes: { prefix: true } do
+  state 'cold', default: true
+end
+
+steady_state :color_temperature, scopes: { prefix: 'color' } do
+  state 'cold', default: true
+end
+
+Material.solid # => query for 'solid' records
+Material.temperature_cold # => query for records with a cold temperature
+Material.color_cold # => query for for records with a cold color temperature
+```
+
 ### Next and Previous States
 
 The `may_become?` method can be used to see if setting the state to a particular value would be allowed (ignoring all other validations):
@@ -277,7 +293,7 @@ class Material
     self.state = 'liquid'
     valid? # will return `false` if state transition is invalid
   end
-  
+
   def melt!
     self.state = 'liquid'
     validate! # will raise an exception if state transition is invalid

data/lib/steady_state/attribute.rb

@@ -56,13 +56,24 @@ module SteadyState
 
         delegate(*state_machines[attr_name].predicates, to: attr_name, allow_nil: true) if predicates
         if scopes
+          scopes = {} unless scopes.is_a?(Hash)
+          prefix = SteadyState::Attribute.build_prefix(attr_name, **scopes)
+
           state_machines[attr_name].states.each do |state|
-            scope state.to_sym, -> { where(attr_name.to_sym => state) }
+            scope :"#{prefix}#{state}", -> { where(attr_name.to_sym => state) }
           end
         end
 
         validates :"#{attr_name}", 'steady_state/attribute/transition' => true,
-                                   inclusion: { in: state_machines[attr_name].states }
+          inclusion: { in: state_machines[attr_name].states }
+      end
+    end
+
+    def self.build_prefix(attr_name, prefix: false)
+      if prefix
+        "#{prefix == true ? attr_name : prefix}_"
+      else
+        ""
       end
     end
   end

data/lib/steady_state/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SteadyState
-  VERSION = '1.1.0'
+  VERSION = '2.2.0'
 end

data/rbi/steady_state.rbi

@@ -0,0 +1,49 @@
+# typed: true
+
+# Sorbet annotations for SteadyState's DSL, shipped with the gem so that
+# Tapioca merges them into consumers' generated gem RBIs.
+#
+# The key annotation is the `T.proc.bind` on `steady_state`'s block: the
+# block is `instance_eval`'d against a `StateMachine`, so without the bind,
+# Sorbet resolves `state` calls against the including class and errors.
+
+module SteadyState
+  mixes_in_class_methods SteadyState::Attribute::ClassMethods
+end
+
+module SteadyState::Attribute
+  mixes_in_class_methods SteadyState::Attribute::ClassMethods
+end
+
+module SteadyState::Attribute::ClassMethods
+  sig do
+    params(
+      attr_name: T.any(Symbol, String),
+      predicates: T::Boolean,
+      states_getter: T::Boolean,
+      scopes: T.any(T::Boolean, T::Hash[Symbol, T.untyped]),
+      block: T.proc.bind(SteadyState::Attribute::StateMachine).void,
+    ).void
+  end
+  def steady_state(attr_name, predicates: true, states_getter: true, scopes: false, &block); end
+end
+
+class SteadyState::Attribute::StateMachine
+  sig do
+    params(
+      state: String,
+      default: T::Boolean,
+      from: T.any(String, T::Array[String]),
+    ).void
+  end
+  def state(state, default: false, from: []); end
+
+  sig { returns(T.nilable(String)) }
+  def start; end
+
+  sig { returns(T::Array[String]) }
+  def states; end
+
+  sig { returns(T::Array[Symbol]) }
+  def predicates; end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steady_state
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Nathan Griffith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2026-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   A minimalist approach to managing object state,
   perhaps best described as "an enum with guard rails."
@@ -113,6 +127,7 @@ files:
 - lib/steady_state/attribute/state_machine.rb
 - lib/steady_state/attribute/transition_validator.rb
 - lib/steady_state/version.rb
+- rbi/steady_state.rbi
 homepage:
 licenses: []
 metadata:
@@ -125,14 +140,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.1
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Minimalist state management via "an enum with guard rails"