circulator 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a3d83bc194cf2440d13e088b1b23e72cf3ec89071ae9d046d575a7e5d1014c7
-  data.tar.gz: 4c1afec2234a2edf3675048519aac13e4b64f2c8bbb08b98387603fc5f354ea8
+  metadata.gz: bdd2e4e17046d72b53d25ea469b8f037316abf74cb7a34fe010091ff4f8b5bfa
+  data.tar.gz: 879a93ab33bb08c07fb6239ce490c5d900272cbd3cd03a65c66516f95439499e
 SHA512:
-  metadata.gz: a5bf023b56fe2f8352fbb2fadce2c8a29cb9a47cfd5b011c80c098646696b9dcd5735c2b027c8f4a126c285005f11c8b46e9c009ac8ad243df3e1bc8a5979523
-  data.tar.gz: e4f99d8cd3e1cdbf87a15eb0b588ffc778f0fdf412c897fb5bf6796ff1295351fcf542c6ea80d1f883b1c3fa6afd817925ecddbda39ac1e16ffc9a59665754cb
+  metadata.gz: 910cd9755d9b9c02996d9d38329082733d019019151c19bc839663893e3523a6c64be9149485317bc7a0979f10223d15c4e0bb34ae0a9942f30d1c473acf8378
+  data.tar.gz: a98cad092d4da49cf93c38db6462489730061c38439f9825e2d2378ef58def38d3db243784c570f50697704442d271d8ac3aa0b1eddd5147e7f4a65b2a346c8a

data/CHANGELOG.md

@@ -5,8 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [2.1.2] - 2025-10-17
+## [2.1.3] - 2025-10-27
+
+### Fixed
+
+- Ignore nil states in predicate methods (73c74c2)
 
 ### Added
 
-- Hash-based allow_if for nested state dependencies (411a6b5)
+- Attribute predicate methods and documentation (8f9cc33)

data/README.md

@@ -6,7 +6,7 @@ A lightweight and flexible state machine implementation for Ruby that allows you
 
 - **Lightweight**: Minimal dependencies and simple implementation
 - **Flexible DSL**: Intuitive syntax for defining states and transitions
-- **Dynamic Method Generation**: Automatically creates helper methods for state transitions
+- **Dynamic Method Generation**: Automatically creates action methods for transitions and predicate methods for state checks
 - **Conditional Transitions**: Support for guards and conditional logic
 - **Nested State Dependencies**: State machines can depend on the state of other attributes
 - **Transition Callbacks**: Execute code before, during, or after transitions
@@ -72,6 +72,37 @@ order.status_ship     # => :shipped
 order.status_deliver  # => :delivered
 ```
 
+### Generated Methods
+
+Circulator automatically generates two types of helper methods for your state machines:
+
+#### Action Methods
+
+For each action defined in your state machine, Circulator creates a method that performs the transition:
+
+```ruby
+order.status_process  # Transitions from :pending to :processing
+order.status_cancel   # Transitions to :cancelled
+```
+
+#### State Predicate Methods
+
+For each state in your state machine, Circulator creates a predicate method to check the current state:
+
+```ruby
+order.status = :pending
+
+order.status_pending?     # => true
+order.status_processing?  # => false
+order.status_shipped?     # => false
+
+order.status_process
+order.status_processing?  # => true
+order.status_pending?     # => false
+```
+
+These predicate methods work with both symbol and string values, automatically converting strings to symbols for comparison.
+
 ### Advanced Features
 
 #### Conditional Transitions with Guards
@@ -227,7 +258,7 @@ Circulator distinguishes itself from other Ruby state machine libraries through
 - **Minimal Magic**: Unlike AASM and state_machines, Circulator uses straightforward Ruby metaprogramming without complex DSL magic
 - **No Dependencies**: Works with plain Ruby objects without requiring Rails, ActiveRecord, or other frameworks
 - **Lightweight**: Smaller footprint compared to feature-heavy alternatives
-- **Clear Method Names**: Generated methods follow predictable naming patterns (`status_approve`, `priority_escalate`)
+- **Clear Method Names**: Generated methods follow predictable naming patterns (`status_approve`, `status_pending?`)
 - **Flexible Architecture**: Easy to extend and customize for specific needs
 
 ### When to Use Circulator

data/lib/circulator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Circulator
-  VERSION = "2.1.2"
+  VERSION = "2.1.3"
 end

data/lib/circulator.rb

@@ -145,12 +145,38 @@ module Circulator
       Circulator.methodize_name(model)
     end
 
+    states = Set.new
     @flows.dig(model_key, attribute_name).transition_map.each do |action, transitions|
+      transitions.each do |from_state, transition_data|
+        states.add(from_state)
+        # Add the 'to' state if it's not a callable
+        unless transition_data[:to].respond_to?(:call)
+          states.add(transition_data[:to])
+        end
+      end
       define_flow_method(attribute_name:, action:, transitions:, object:, owner: flow_module)
     end
+
+    # Define predicate methods for each state (skip nil)
+    states.each do |state|
+      next if state.nil?
+      define_state_method(attribute_name:, state:, object:, owner: flow_module)
+    end
   end
   alias_method :circulator, :flow
 
+  def define_state_method(attribute_name:, state:, object:, owner:)
+    object_attribute_method = [object, attribute_name, state].compact.join("_") << "?"
+    return if owner.method_defined?(object_attribute_method)
+
+    owner.define_method(object_attribute_method) do
+      current_value = send(attribute_name)
+      # Convert to symbol for comparison if possible
+      current_value = current_value.to_sym if current_value.respond_to?(:to_sym)
+      current_value == state
+    end
+  end
+
   def define_flow_method(attribute_name:, action:, transitions:, object:, owner:)
     object_attribute_method = [object, attribute_name, action].compact.join("_")
     raise ArgumentError, "Method already defined: #{object_attribute_method}" if owner.method_defined?(object_attribute_method)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circulator
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Jim Gay
@@ -46,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Simple state machine
 test_files: []