state_machine_enum 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 255a61ddbdf562c086709c6fbe51e37533ac15bf47bd698d0aae2086e2157569
-  data.tar.gz: 759c5a66316166c230d37576d2a087cb93978620a1984f9d10ece17b9ba2f89e
+  metadata.gz: 0a64dc12150ea615573c5fc5ce222e80fa8f2959392c94f3c6a80fae6efa53cd
+  data.tar.gz: 63b7a19ac4794c1b75d5e4d8a6b93964e5b9400d394927458d44893d2c9f4a31
 SHA512:
-  metadata.gz: 8197dc76f3536c972ab610da6259dc4c0d53ebd049addd747965acb925f43be39b4bb78948edf315b3f257ce107f68db3c989a7f7340f8b65931f901a8da505c
-  data.tar.gz: f219d01939f927981cdd45b3c72fe76ab3a19bbd7c56028a5c6e5ebae64a36adfa36c61e1310afd0ae2ab78c3697af00f8ddee44f9afb02ee8ccc73935a13e9d
+  metadata.gz: b705009767fb54820386c8748f1747a45d2145dc177355569a794669d1514bac07cb9f5666999950d158ed1b9fba3808eebb8b28f63fdeab3da1818314919598
+  data.tar.gz: 187ee30f697c019617f45b057e709d404a2cd11083e57c0f7387f24272a27a17ce7afce6da31b8dff675914498589b9a13e4a64c1eab0e21fe6101d1aa277b75

data/CHANGELOG.md

@@ -1,31 +1,28 @@
-# Changelog
-All notable changes to this project will be documented in this file.
+## 0.1.4
 
-This 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).
+* Raise `InvalidTransition` which is a subclass of `InvalidState`. That exception contains the following properties which can be used:
+  * `attribute_name` is the name of the enum attribute
+  * `from_state` is the state the transition was attempted from
+  * `to_state` is the state the transition was going to
+  * `already_in_target_state?` is `true` if a repeated transition was attempted
+* Some more code styling
+* Relax dependencies so that Bundler does not complain on Rails 8.x apps
 
 ## 0.1.3
 
-### Changed
-
-- Added more documentation and improvements to the readme
-- Little code styling
+* Added more documentation and improvements to the readme
+* Little code styling
 
 ## 0.1.2
 
-### Added
-
-- basic tests for a library
-
-### Changed
-
-- #ensure_<attribute>_may_transition_to! method now actually verifies that an attribute can transition to a new state.
+* Add basic tests
+* `#ensure_<attribute>_may_transition_to!` now actually verifies that an attribute can transition to the new state.
 
 ## 0.1.1
 
-### Added
 
-- Provide real authorts of this gem.
+* Provide real authors.
 
 ## 0.1.0
 
-- Initial release
+* Initial release

data/README.md

@@ -18,11 +18,11 @@ end
 
 Install the gem and add it to the application's Gemfile by executing:
 
-    $ bundle add state_machine_enum
+  $ bundle add state_machine_enum
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install state_machine_enum
+  $ gem install state_machine_enum
 
 ## Usage
 
@@ -33,10 +33,10 @@ class User < ApplicationRecord
   include StateMachineEnum
 
   state_machine_enum :state, prefix: :state do |s|
-    s.permit_transition(:registered, :active)
-    s.permit_transition(:active, :banned)
-    s.permit_transition(:banned, :active)
-    s.permit_transition(:active, :deleted)
+  s.permit_transition(:registered, :active)
+  s.permit_transition(:active, :banned)
+  s.permit_transition(:banned, :active)
+  s.permit_transition(:active, :deleted)
   end
 end
 
@@ -69,10 +69,10 @@ For example the state updates to :registered, but before the model is saved
 
 ```ruby
 state_machine_enum :state, prefix: "state" do |s|
-    s.permit_transition(:registered, :active)
-    s.after_inline_transition_to(:active) do |model|
-        model.another_attr = Time.now.utc
-    end
+  s.permit_transition(:registered, :active)
+  s.after_inline_transition_to(:active) do |model|
+    model.another_attr = Time.now.utc
+  end
 end
 ```
 
@@ -85,10 +85,10 @@ updated to :registered
 
 ```ruby
 state_machine_enum :state, prefix: "state" do |s|
-    s.permit_transition(:registered, :active)
-    s.after_committed_transition_to(:active) do |model|
-        model.send_notification!
-    end
+  s.permit_transition(:registered, :active)
+  s.after_committed_transition_to(:active) do |model|
+    model.send_notification!
+  end
 end
 ```
 
@@ -98,11 +98,11 @@ For example if you want to do something after any state update has commited.
 
 ```ruby
 state_machine_enum :state, prefix: "state" do |s|
-    s.permit_transition(:registered, :active)
-    s.permit_transition(:active, :suspended)
-    s.after_any_committed_transition_to do |model|
-        log_changes!
-    end
+  s.permit_transition(:registered, :active)
+  s.permit_transition(:active, :suspended)
+  s.after_any_committed_transition_to do |model|
+    log_changes!
+  end
 end
 ```
 
@@ -123,7 +123,7 @@ Predicate to check if a transition is possible with the rules we've set.
 
 ```ruby
 state_machine_enum :state, prefix: "state" do |s|
-    s.permit_transition(:registered, :active)
+  s.permit_transition(:registered, :active)
 end
 
 state_may_transition_to?(:active) # => true

data/lib/state_machine_enum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StateMachineEnum
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/state_machine_enum.rb

@@ -72,6 +72,21 @@ module StateMachineEnum
   class InvalidState < StandardError
   end
 
+  class InvalidTransition < InvalidState
+    attr_reader :attribute_name, :from_state, :to_state
+
+    def already_in_target_state?
+      @from_state == @to_state
+    end
+
+    def initialize(attribute_name, attempted_transition_from_state, attempted_transition_to_state, *args_for_super)
+      @attribute_name = attribute_name.to_s
+      @from_state = attempted_transition_from_state.to_s
+      @to_state = attempted_transition_to_state.to_s
+      super(*args_for_super)
+    end
+  end
+
   class_methods do
     def state_machine_enum(attribute_name, **options_for_enum)
       # Collect the states
@@ -117,10 +132,10 @@ module StateMachineEnum
 
         define_method(:"ensure_#{attribute_name}_may_transition_to!") do |next_state|
           val = self[attribute_name]
-          raise InvalidState, "#{attribute_name} already is #{val.inspect}" if next_state.to_s == val
+          raise InvalidTransition.new(attribute_name, val, next_state, "#{attribute_name} already is #{val.inspect}") if next_state.to_s == val
           return if collector._may_transition?(val, next_state)
 
-          raise InvalidState, "#{attribute_name} may not transition from #{val.inspect} to #{next_state.inspect}"
+          raise InvalidTransition.new(attribute_name, val, next_state, "#{attribute_name} may not transition from #{val.inspect} to #{next_state.inspect}")
         end
 
         define_method(:"#{attribute_name}_may_transition_to?") do |next_state|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machine_enum
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -10,22 +10,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -44,16 +44,16 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.0'
 description: Concern that makes it easy to define and enforce possibe state transitions
   for a field/object
 email:
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Define possible state transitions for a field