estate 0.0.2 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f445ae55c16632d7805cd1774f2800eed57ebf16ce63db5ef7e780225ecc52a1
-  data.tar.gz: 60527e77ed67584c663bde4504a104c1b9b38e179fdd299e5344bef2031d6bb9
+  metadata.gz: 0777265b6deae44f96eb4fbc8f150bb73b1f2d98849107b9750eeb0ac025ca49
+  data.tar.gz: 916c2a835c05ed793d87e25883cb6999ebf87687c260f39eba90e994cf0aa228
 SHA512:
-  metadata.gz: e27a18f1f5a82b3b2316d559eb7847f400f15b025fad62dc3d1ced8106856d2c8c60014a86af2837e81f03cf6956175af7f2ab0dabf08d0b0d4fb6b7dac37495
-  data.tar.gz: a2f52b92fff0482abbc7981ab5685d59b5430e171f37c568f68f8ab72d1ed57d851886b0bbf631c472ee34ced52699203571c1ffd420ee636d94cfa00daf1984
+  metadata.gz: 37e595f2f4451386df31a2b563af980037c90f91786760c9c88f9090418ffd3b640473bc5c2d16a1826c3646302d2041b151a0807d106e1dbc6c85dc126bbfbd
+  data.tar.gz: f939381283ace662a7d97169cc7e0bf26ad8d05a78eb40585f456e84768bda4474c1ae0501d5f7d232eb401d577341d2ce09f4fa3b02137adca8019e87c65114

data/README.md

@@ -1,6 +1,8 @@
+![CI](https://github.com/igorkorepanov/estate/actions/workflows/main.yml/badge.svg)
+
 # Estate Gem
 
-Estate is a Ruby gem designed to simplify state management in ActiveRecord models. The primary focus of this gem is to provide a straightforward way to define states and transitions using a clean syntax, allowing seamless integration into ActiveRecord models.
+Estate is a Ruby gem designed to simplify state management in both ActiveRecord and Sequel models. The primary focus of this gem is to provide a straightforward way to define states and transitions using a clean syntax.
 
 ## Installation
 
@@ -17,8 +19,8 @@ gem install estate
 ```
 
 ## Usage
-
-To use the Estate gem, include it in your ActiveRecord model and define your states and transitions inside a block using the `estate` method. Here's a simple example:
+### ActiveRecord
+To use the Estate gem with ActiveRecord, include it in your model and define your states and transitions inside a block using the `estate` method. Here's a simple example:
 
 ```ruby
 class MyModel < ApplicationRecord
@@ -36,13 +38,59 @@ class MyModel < ApplicationRecord
 end
 ```
 
-The default field for storing the state is named state. You can customize this field by providing options to the estate method:
+And then
+
+```ruby
+model = MyModel.create(state: :state_1)
+model.update(state: :state_2) # you don't need to call any extra code to change the state; treat it like a normal field
+```
+
+The default field for storing the state is named "state". You can customize this name by providing options to the estate method:
+
+```ruby
+class MyModel < ApplicationRecord
+  include Estate
+
+  estate column: :custom_state_field do
+    # ...
+  end
+end
+```
+
+You can also use the `empty_initial_state: true` option to enable the creation of a model with a `nil` initial state:
+
+```ruby
+class MyModel < ApplicationRecord
+  include Estate
+
+  estate empty_initial_state: true do
+    # ...
+  end
+end
+```
+
+The `estate` method now supports a `raise_on_error` option. When set to `true`, the gem will raise a specific exception instead of the standard ActiveRecord validation error upon a validation failure.
 
 ```ruby
 class MyModel < ApplicationRecord
   include Estate
 
-  estate(column: :custom_state_field, empty_initial_state: true) do
+  estate raise_on_error: true do
+    # ...
+  end
+end
+```
+
+### Sequel
+To use the Estate gem with Sequel, include it in your model, and ensure you have the `plugin: dirty` enabled for validation to work correctly. The `raise_on_error` option is not needed with Sequel, as exceptions are always raised on validation errors.
+
+```ruby
+class MySequelModel < Sequel::Model
+  include Estate
+
+  plugin :dirty # Ensure the dirty plugin is enabled for validation to work
+
+  estate do
     state :state_1
     state :state_2
     state :state_3
@@ -54,7 +102,7 @@ class MyModel < ApplicationRecord
 end
 ```
 
-## Migration Example
+## Migration Example for ActiveRecord
 
 ```bash
 bundle exec rails generate migration AddStateToMyModels state:string

data/lib/estate/configuration.rb

@@ -3,17 +3,19 @@
 module Estate
   module Configuration
     class << self
-      def init_config(column_name:, allow_empty_initial_state:)
+      def init_config(column_name, allow_empty_initial_state, raise_on_error)
         @column_name = column_name
         @allow_empty_initial_state = allow_empty_initial_state
+        @raise_on_error = raise_on_error
       end
 
-      attr_reader :column_name, :allow_empty_initial_state
+      attr_reader :column_name, :allow_empty_initial_state, :raise_on_error
     end
 
     module Defaults
       COLUMN_NAME = :state
       ALLOW_EMPTY_INITIAL_STATE = false
+      RAISE_ON_ERROR = false
     end
   end
 end

data/lib/estate/constants/orm.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Estate
+  module Constants
+    module Orm
+      ACTIVE_RECORD = 'active_record'
+      SEQUEL = 'sequel'
+    end
+  end
+end

data/lib/estate/estate.rb

@@ -5,21 +5,22 @@ module Estate
     base.extend Estate::ClassMethods
 
     Estate::Requirements.check_requirements(base)
-    Estate::ActiveRecord.setup_callbacks(base)
     Estate::StateMachine.create_store
-
-    super
+    Estate::Setup.call(base)
   end
 
   module ClassMethods
     def estate(column: Estate::Configuration::Defaults::COLUMN_NAME,
-               empty_initial_state: Estate::Configuration::Defaults::ALLOW_EMPTY_INITIAL_STATE)
-      Estate::Configuration.init_config(column_name: column, allow_empty_initial_state: empty_initial_state)
+               empty_initial_state: Estate::Configuration::Defaults::ALLOW_EMPTY_INITIAL_STATE,
+               raise_on_error: Estate::Configuration::Defaults::RAISE_ON_ERROR)
+      Estate::Configuration.init_config(column, empty_initial_state, raise_on_error)
 
       yield if block_given?
     end
 
-    def state(name)
+    def state(name = nil)
+      raise(StandardError, 'state must be a Symbol or a String') unless Estate::StateMachine.argument_valid?(name)
+
       if Estate::StateMachine.state_exists?(name)
         raise(StandardError, "state `:#{name}` is already defined")
       else
@@ -27,16 +28,22 @@ module Estate
       end
     end
 
-    def transition(from:, to:)
+    def transition(from: nil, to: nil)
+      unless Estate::StateMachine.argument_valid?(from)
+        raise(StandardError, 'argument `from` must be a Symbol or a String')
+      end
+
+      raise(StandardError, 'argument `to` must be a Symbol or a String') unless Estate::StateMachine.argument_valid?(to)
+
       raise(StandardError, "state `#{from}` is not defined") unless Estate::StateMachine.state_exists?(from)
 
       raise(StandardError, "state `#{to}` is not defined") unless Estate::StateMachine.state_exists?(to)
 
-      if Estate::StateMachine.transition_exists?(from: from, to: to)
+      if Estate::StateMachine.transition_exists?(from, to)
         raise(StandardError, "`transition from: :#{from}, to: :#{to}` already defined")
       end
 
-      Estate::StateMachine.register_transition(from: from, to: to)
+      Estate::StateMachine.register_transition(from, to)
     end
   end
 end

data/lib/estate/logic/active_record/setup.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Estate
+  module Logic
+    module ActiveRecord
+      module Setup
+        module_function
+
+        def call(base)
+          base.class_eval do
+            public_send(:before_validation) do
+              Estate::Logic::Core.call(Estate::Constants::Orm::ACTIVE_RECORD, self)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/estate/logic/active_record/specific_logic.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'estate/logic/common_logic'
+
+module Estate
+  module Logic
+    module ActiveRecord
+      module SpecificLogic
+        extend Estate::Logic::CommonLogic
+
+        module_function
+
+        def add_error(instance, message, attribute: :base)
+          if Estate::Configuration.raise_on_error
+            exception_message = attribute == :base ? message : "#{attribute}: #{message}"
+            raise(StandardError, exception_message)
+          else
+            instance.errors.add(attribute, message) unless instance.errors[attribute].include?(message)
+          end
+        end
+
+        def get_states(instance)
+          from_state = instance.public_send("#{Estate::Configuration.column_name}_was")
+          to_state = instance.public_send(Estate::Configuration.column_name)
+          [from_state, to_state]
+        end
+      end
+    end
+  end
+end

data/lib/estate/logic/common_logic.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Estate
+  module Logic
+    module CommonLogic
+      def validate_state_changes(instance, from_state, to_state)
+        if from_state == to_state
+          if from_state.nil? && !Estate::Configuration.allow_empty_initial_state
+            add_error(instance, "empty `#{Estate::Configuration.column_name}` is not allowed")
+          end
+        elsif to_state.nil?
+          add_error(instance, 'transition to empty state is not allowed')
+        elsif !Estate::StateMachine.state_exists?(to_state)
+          add_error(instance, "state `#{to_state}` is not defined")
+        elsif !transition_allowed?(from_state, to_state)
+          add_error(instance, "transition from `#{from_state}` to `#{to_state}` is not allowed",
+                    attribute: Estate::Configuration.column_name)
+        end
+      end
+
+      def transition_allowed?(from_state, to_state)
+        from_state.nil? || Estate::StateMachine.transition_exists?(from_state, to_state)
+      end
+    end
+  end
+end

data/lib/estate/logic/core.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Estate
+  module Logic
+    module Core
+      module_function
+
+      def call(orm, instance)
+        require 'estate/logic/common_logic'
+        require File.join(File.dirname(__FILE__), orm, 'specific_logic')
+
+        extend Estate::Logic::CommonLogic
+        extend "Estate::Logic::#{orm.classify}::SpecificLogic".safe_constantize
+
+        validate_state_changes(instance, *get_states(instance))
+      end
+    end
+  end
+end

data/lib/estate/logic/sequel/setup.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Estate
+  module Logic
+    module Sequel
+      module Setup
+        module_function
+
+        def call(base)
+          base.class_eval do
+            def validate
+              super
+
+              Estate::Logic::Core.call(Estate::Constants::Orm::SEQUEL, self)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/estate/logic/sequel/specific_logic.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'estate/logic/common_logic'
+
+module Estate
+  module Logic
+    module Sequel
+      module SpecificLogic
+        extend Estate::Logic::CommonLogic
+
+        module_function
+
+        # TODO: remove :base
+        def add_error(instance, message, attribute: :base)
+          instance.errors.add(attribute, message)
+        end
+
+        def get_states(instance)
+          from_state, = instance.column_change(Estate::Configuration.column_name)
+          to_state = instance.values[Estate::Configuration.column_name]
+          [from_state, to_state]
+        end
+      end
+    end
+  end
+end

data/lib/estate/requirements.rb

@@ -5,7 +5,9 @@ module Estate
     def check_requirements(base)
       ancestors = base.ancestors.map(&:to_s)
 
-      raise(StandardError, 'Estate requires ActiveRecord') unless ancestors.include?('ActiveRecord::Base')
+      unless 'Sequel::Model'.in?(ancestors) || 'ActiveRecord::Base'.in?(ancestors)
+        raise(StandardError, 'Estate requires ActiveRecord or Sequel')
+      end
     end
 
     module_function :check_requirements

data/lib/estate/setup.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Estate
+  module Setup
+    module_function
+
+    def call(base)
+      if base.ancestors.map(&:to_s).include? 'ActiveRecord::Base'
+        require File.join(File.dirname(__FILE__), 'logic', 'active_record', 'setup')
+        Estate::Logic::ActiveRecord::Setup.call(base)
+      else
+        require File.join(File.dirname(__FILE__), 'logic', 'sequel', 'setup')
+        Estate::Logic::Sequel::Setup.call(base)
+      end
+    end
+  end
+end

data/lib/estate/state_machine.rb

@@ -9,32 +9,27 @@ module Estate
       end
 
       def state_exists?(state)
-        !state.nil? && states.key?(state.to_sym)
+        states.key?(state.to_sym)
       end
 
       def register_state(state)
-        case state
-        when Symbol
-          states[state] = nil
-        when String
-          states[state.to_sym] = nil
-        else
-          raise(ArgumentError, 'State must be a Symbol or a String')
-        end
+        states[state.to_sym] = nil
       end
 
-      def transition_exists?(from:, to:)
-        # TODO: validate from and to
-        transition_key = { from: from.to_sym, to: to.to_sym }
+      def transition_exists?(from_state, to_state)
+        transition_key = { from: from_state.to_sym, to: to_state.to_sym }
         transitions.key?(transition_key)
       end
 
-      def register_transition(from:, to:)
-        # TODO: validate from and to
-        transition_key = { from: from.to_sym, to: to.to_sym }
+      def register_transition(from_state, to_state)
+        transition_key = { from: from_state.to_sym, to: to_state.to_sym }
         transitions[transition_key] = nil
       end
 
+      def argument_valid?(argument)
+        argument.is_a?(Symbol) || argument.is_a?(String)
+      end
+
       attr_reader :states, :transitions
     end
   end

data/lib/estate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Estate
-  VERSION = '0.0.2'
+  VERSION = '0.1.1'
 end

data/lib/estate.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
-require 'estate/version'
-require 'estate/requirements'
 require 'estate/configuration'
-require 'estate/state_machine'
-require 'estate/active_record'
+require 'estate/constants/orm'
 require 'estate/estate'
+require 'estate/logic/core'
+require 'estate/requirements'
+require 'estate/setup'
+require 'estate/state_machine'
+require 'estate/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: estate
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.1
 platform: ruby
 authors:
 - Igor Korepanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-22 00:00:00.000000000 Z
+date: 2024-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -66,6 +66,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.12.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.22.0
 description: Estate is a Ruby gem designed to simplify state management in ActiveRecord
   models
 email: noemail@example.com
@@ -76,10 +90,17 @@ files:
 - LICENSE.txt
 - README.md
 - lib/estate.rb
-- lib/estate/active_record.rb
 - lib/estate/configuration.rb
+- lib/estate/constants/orm.rb
 - lib/estate/estate.rb
+- lib/estate/logic/active_record/setup.rb
+- lib/estate/logic/active_record/specific_logic.rb
+- lib/estate/logic/common_logic.rb
+- lib/estate/logic/core.rb
+- lib/estate/logic/sequel/setup.rb
+- lib/estate/logic/sequel/specific_logic.rb
 - lib/estate/requirements.rb
+- lib/estate/setup.rb
 - lib/estate/state_machine.rb
 - lib/estate/version.rb
 homepage: https://github.com/igorkorepanov/estate

data/lib/estate/active_record.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Estate
-  module ActiveRecord
-    CALLBACK_NAMES = [:before_validation].freeze
-
-    def setup_callbacks(base)
-      base.class_eval do
-        CALLBACK_NAMES.each do |callback_name|
-          public_send(callback_name) { Estate::ActiveRecord.validate_state_changes(self) }
-        end
-      end
-    end
-
-    def validate_state_changes(instance)
-      from_state = instance.public_send("#{Estate::Configuration.column_name}_was")
-      to_state = instance.public_send(Estate::Configuration.column_name)
-
-      if from_state == to_state
-        if to_state.nil? && !Estate::Configuration.allow_empty_initial_state
-          raise(StandardError, "empty `#{Estate::Configuration.column_name}` is not allowed")
-        end
-      elsif Estate::StateMachine.state_exists?(to_state) # TODO: check to_state.nil?
-        unless Estate::StateMachine.transition_exists?(from: from_state, to: to_state)
-          instance.errors.add(Estate::Configuration.column_name,
-                              message: "transition from `#{from_state}` to `#{to_state}` is not allowed")
-        end
-      else
-        instance.errors.add(:base, "state `#{to_state}` is not defined")
-      end
-    end
-
-    module_function :setup_callbacks, :validate_state_changes
-  end
-end