state_machina 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f0a424d08f9a7c3103b4e1eca3d27cda85089c72c25fecdceaad77bf4ba7ad1
-  data.tar.gz: 5eb6269265360180bc155872205765ae49574e593b1614ec003125ab8109c27a
+  metadata.gz: da7744a0dd9bd422710ba97e8db2799be0ce7a9c2aed9da7c580f0f0941b3276
+  data.tar.gz: ffa9c6ab967b3490b0bc54fbd34ea51332d9d2e61470e1c07468a1f8caf81b80
 SHA512:
-  metadata.gz: 3f19e17c7e7ac1f8420027b727954bac2677878ef4c9bc2c8b9b8a17af09b9902b7d00f170d3eea7cab154caa90a0e13382a4237f4adbed5c2436f5958608bf5
-  data.tar.gz: ee4ba5d3bdc4aa9e4f6fa03612312a5f53215fdabf270d99d032a1e4ba73a72429dc45b1bc3166de030b34217c8c03288cf4458ce35a95b9dd16e5b32f0f00cf
+  metadata.gz: ca9ee7f05f7790ebe6cedb28d7d62963f1718ac1d0baf2317640ae26b42846e06999784ebb906cc62035dc320e51520a1479204c62c98051c7989de862b83d65
+  data.tar.gz: 96215bace1c18c7d7a9829541e035d4cdb46f6ee136ca0f5a6621b31d49df22b44f6f9224f825863a5a84255eb4ff817ed07a769c0fa8bf32a9dccb0e5d965ce

data/.tool-versions

@@ -1 +1 @@
-ruby 3.2.0
+ruby 4.0.2

data/Gemfile.lock

@@ -1,25 +1,40 @@
 PATH
   remote: .
   specs:
-    state_machina (0.1.6)
+    state_machina (0.1.8)
+      activesupport (>= 5.0, < 8)
       concurrent-ruby (< 2)
+      i18n (>= 0.7, < 2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.8.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
+    activesupport (7.2.4)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5, < 3)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1, < 6)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
     ast (2.4.2)
+    base64 (0.3.0)
+    benchmark (0.5.0)
+    bigdecimal (4.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.8)
+    connection_pool (2.5.5)
     diff-lcs (1.5.0)
-    i18n (1.14.5)
+    drb (2.2.3)
+    i18n (1.15.2)
       concurrent-ruby (~> 1.0)
+    logger (1.7.0)
     method_source (1.0.0)
-    minitest (5.22.3)
+    minitest (5.27.0)
     parallel (1.21.0)
     parser (3.1.1.0)
       ast (~> 2.4.1)
@@ -55,15 +70,16 @@ GEM
     rubocop-ast (1.16.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.11)
-      thread_safe (~> 0.1)
+    securerandom (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
 
 PLATFORMS
   arm64-darwin-21
   arm64-darwin-22
   arm64-darwin-23
+  arm64-darwin-25
   x86_64-darwin-20
 
 DEPENDENCIES

data/lib/state_machina/extended_integration.rb

@@ -2,7 +2,7 @@ module StateMachina
   module ExtendedIntegration
     module ClassMethods
       # Extends a machine on a model where the machine is already defined
-      def extend_machine(klass, machine_name = 'default')
+      def extend_machine(klass, machine_name = StateMachina::Machine::DEFAULT_MACHINE_NAME)
         model_name = StateMachina::Util.normalized_klass_to_name(klass)
 
         yield(StateMachina::Registry.find_machine!(model_name, machine_name))

data/lib/state_machina/integration.rb

@@ -2,9 +2,15 @@ module StateMachina
   module Integration
     module ClassMethods
       # Defines a new machine on a model
-      def define_machine(machine_name = 'default', column_name: :state, metadata: {})
+      def define_machine(machine_name = StateMachina::Machine::DEFAULT_MACHINE_NAME, column_name: :state, i18n_scope: nil, metadata: {})
         model_name = StateMachina::Util.normalized_klass_to_name(self)
-        machine = StateMachina::Machine.new(model_name, machine_name, column_name: column_name, metadata: metadata)
+        machine = StateMachina::Machine.new(
+          model_name,
+          machine_name,
+          column_name: column_name,
+          i18n_scope: i18n_scope,
+          metadata: metadata
+        )
 
         yield(StateMachina::Registry.register_machine(machine))
       end
@@ -12,7 +18,7 @@ module StateMachina
       alias_method :define_state_machine, :define_machine
 
       # Extends a machine on a model where the machine is already defined
-      def extend_machine(klass, machine_name = 'default')
+      def extend_machine(klass, machine_name = StateMachina::Machine::DEFAULT_MACHINE_NAME)
         model_name = StateMachina::Util.normalized_klass_to_name(klass)
 
         yield(StateMachina::Registry.find_machine!(model_name, machine_name))
@@ -21,7 +27,7 @@ module StateMachina
       alias_method :extend_state_machine, :extend_machine
 
       # Returns the defined machine on a model
-      def machine(machine_name = 'default')
+      def machine(machine_name = StateMachina::Machine::DEFAULT_MACHINE_NAME)
         model_name = StateMachina::Util.normalized_klass_to_name(self)
 
         StateMachina::Registry.find_machine!(model_name, machine_name)
@@ -44,7 +50,7 @@ module StateMachina
     end
 
     # Returns the defined machine on a model instance
-    def machine(machine_name = 'default')
+    def machine(machine_name = StateMachina::Machine::DEFAULT_MACHINE_NAME)
       model_name = StateMachina::Util.normalized_klass_to_name(self.class)
 
       machine = StateMachina::Registry.find_machine!(model_name, machine_name).dup

data/lib/state_machina/machine.rb

@@ -1,17 +1,32 @@
 module StateMachina
   class Machine
-    attr_reader :model_name, :name, :column_name, :metadata
+    DEFAULT_MACHINE_NAME = 'default'
+
+    attr_reader :model_name, :name, :column_name, :i18n_scope, :metadata
     attr_accessor :model
 
     delegate :before?, :before_inclusive?, :past?, :past_inclusive?, :between?, :between_inclusive?, to: :current_state
 
-    def initialize(model_name, name, column_name: :state, metadata: {})
+    def initialize(model_name, name, column_name: :state, i18n_scope: nil, metadata: {})
       @model_name = model_name
       @name = name.to_s
       @column_name = column_name
+      @i18n_scope = i18n_scope || default_i18n_scope
       @metadata = metadata
     end
 
+    def default?
+      name == DEFAULT_MACHINE_NAME
+    end
+
+    def self.default_i18n_scope(model_name)
+      "activerecord.attributes.#{model_name}"
+    end
+
+    def human_name
+      I18n.t(name, scope: "#{i18n_scope}.machines", default: name.humanize)
+    end
+
     def state(state_name, metadata: {})
       state = StateMachina::State.new(model_name, name, state_name, metadata: metadata)
 
@@ -55,6 +70,7 @@ module StateMachina
     end
 
     def update_state(new_state)
+      raise(UnknownStateError, "for model: #{model_name}, with name: #{new_state}") unless states.find_by_name(new_state)
       if model.respond_to?(:update)
         model.update(column_name => new_state)
       else
@@ -63,6 +79,7 @@ module StateMachina
     end
 
     def update_state!(new_state)
+      raise(UnknownStateError, "for model: #{model_name}, with name: #{new_state}") unless states.find_by_name(new_state)
       if model.respond_to?(:update!)
         model.update!(column_name => new_state)
       else
@@ -72,6 +89,10 @@ module StateMachina
 
     private
 
+    def default_i18n_scope
+      self.class.default_i18n_scope(model_name)
+    end
+
     def select_possible_events(events)
       events.select(&:possible?)
     end

data/lib/state_machina/state.rb

@@ -10,6 +10,16 @@ module StateMachina
       @metadata = metadata
     end
 
+    def human_name
+      return name.humanize if machine.nil?
+
+      I18n.t(name, scope: i18n_scope, default: name.humanize)
+    end
+
+    def i18n_scope
+      "#{machine.i18n_scope}.states.#{machine_name}"
+    end
+
     def before?(other_state_name)
       return false if machine.nil?
 

data/lib/state_machina/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StateMachina
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/lib/state_machina.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require "concurrent"
+require "i18n"
 require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/string/inflections"
 
 require_relative "state_machina/event"
 require_relative "state_machina/events_collection"
@@ -19,4 +21,5 @@ module StateMachina
   class Error < StandardError; end
 
   class NoMachineFoundError < Error; end
+  class UnknownStateError < Error; end
 end

metadata

@@ -1,15 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: state_machina
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Jan van der Pas
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +43,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +77,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.15'
-description:
 email:
 - jan.vanderpas@beequip.nl
 executables: []
@@ -68,11 +106,9 @@ files:
 - lib/state_machina/util.rb
 - lib/state_machina/version.rb
 - sig/state_machina.rbs
-homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,8 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
-signing_key:
+rubygems_version: 4.0.13
 specification_version: 4
 summary: State machine supporting multiple machines per object
 test_files: []