estate 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b3da0543146b0a82972f87969bc2278b1deb7ab600965370caf143bd8b342d7
-  data.tar.gz: e87a26965c47b976746059431196048fb2b03cb829475e5e1eabf48b80054694
+  metadata.gz: 71bb34f3ba838cee7a69c1c149e10fa539f074d887503dc97e02818a05c8712b
+  data.tar.gz: 97e67199bd544a360a0b7da92a6321144d1bfce380d15463c929c540713ffcce
 SHA512:
-  metadata.gz: bd904b3f3dbcf36895fb76c3c76ce05c7cb4af45ab30150fb8d9becd2120c9a7add11ada7051396e3f5cfc7093702221b7f6e77de994e04e347f1018802ce0f3
-  data.tar.gz: c69b6df5691fcc4104c28e9ce5eb23ad294c54002a8ff32c498750074c7c6bded4bbe7cb0707d69f3abd23ab4f47e67b59ca25571784c008e63c41135620e76e
+  metadata.gz: a1efa655c9bf89e4a19bd4b5840e816ad048418c509b267e569e0040f793ab2bfad11b817d7d97b19ee8cf777455da1e040cfb5e0be8abdf36900d10301a093d
+  data.tar.gz: 93f161f47890608d3a2ec5a92195524c6fe884a1d3a140557908f0c76402f2effcf9b5b687347b0eec07d414eca7dc2a85bf3ec87e291f6d6fccdf2573dbdcfd

data/README.md

@@ -2,7 +2,7 @@
 
 # Estate Gem
 
-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.
+Estate is a Ruby gem designed to simplify state management in models, including ActiveRecord, Sequel, as well as plain Ruby objects. The primary focus of this gem is to provide a straightforward way to define states and transitions using a clean syntax.
 
 ## Installation
 

data/lib/estate/constants/{orm.rb → adapters.rb}

@@ -2,9 +2,10 @@
 
 module Estate
   module Constants
-    module Orm
+    module Adapters
       ACTIVE_RECORD = 'active_record'
       SEQUEL = 'sequel'
+      PLAIN_RUBY_OBJECT = 'plain_ruby_object'
     end
   end
 end

data/lib/estate/estate.rb

@@ -3,9 +3,6 @@
 module Estate
   def self.included(base)
     base.extend Estate::ClassMethods
-
-    Estate::Requirements.check_requirements(base)
-    Estate::Setup.call(base)
   end
 
   module ClassMethods
@@ -13,6 +10,7 @@ module Estate
                empty_initial_state: Estate::Configuration::Defaults::ALLOW_EMPTY_INITIAL_STATE,
                raise_on_error: Estate::Configuration::Defaults::RAISE_ON_ERROR)
       Estate::StateMachine.init(name, column, empty_initial_state, raise_on_error)
+      Estate::Setup.call(self)
 
       yield if block_given?
     end

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'estate/logic/common_logic'
+require 'estate/logic/active_record/specific_logic'
+
 module Estate
   module Logic
     module ActiveRecord
@@ -9,7 +12,9 @@ module Estate
         def call(base)
           base.class_eval do
             public_send(:before_validation) do
-              Estate::Logic::Core.call(Estate::Constants::Orm::ACTIVE_RECORD, self)
+              extend Estate::Logic::CommonLogic
+              extend Estate::Logic::ActiveRecord::SpecificLogic
+              validate_state_changes(self, *get_states(self))
             end
           end
         end

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

@@ -1,13 +1,9 @@
 # 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)

data/lib/estate/logic/common_logic.rb

@@ -24,8 +24,8 @@ module Estate
         from_state.nil? || Estate::StateMachine.transition_exists?(state_machine_name, from_state, to_state)
       end
 
-      def config_for(instance)
-        state_machine_name = instance.class.name
+      def config_for(klass)
+        state_machine_name = klass.is_a?(Class) ? klass.name : klass.class.name
         Estate::StateMachine.state_machines[state_machine_name][:config]
       end
     end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'estate/logic/common_logic'
+require 'estate/logic/plain_ruby_object/specific_logic'
+
+module Estate
+  module Logic
+    module PlainRubyObject
+      module Setup
+        module_function
+
+        def call(base)
+          base.prepend(Module.new do
+            extend Estate::Logic::CommonLogic
+
+            define_method("#{config_for(base)[:column_name]}=") do |new_value|
+              extend Estate::Logic::CommonLogic
+              extend Estate::Logic::PlainRubyObject::SpecificLogic
+
+              validate_state_changes(self, state, new_value)
+
+              super(new_value)
+            end
+          end)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Estate
+  module Logic
+    module PlainRubyObject
+      module SpecificLogic
+        module_function
+
+        def add_error(_, message, attribute: :base)
+          exception_message = attribute == :base ? message : "#{attribute}: #{message}"
+          raise(StandardError, exception_message)
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'estate/logic/common_logic'
+require 'estate/logic/sequel/specific_logic'
+
 module Estate
   module Logic
     module Sequel
@@ -11,7 +14,9 @@ module Estate
             def validate
               super
 
-              Estate::Logic::Core.call(Estate::Constants::Orm::SEQUEL, self)
+              extend Estate::Logic::CommonLogic
+              extend Estate::Logic::Sequel::SpecificLogic
+              validate_state_changes(self, *get_states(self))
             end
           end
         end

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

@@ -1,13 +1,9 @@
 # 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

data/lib/estate/setup.rb

@@ -5,12 +5,16 @@ module Estate
     module_function
 
     def call(base)
-      if base.ancestors.map(&:to_s).include? 'ActiveRecord::Base'
+      ancestors = base.ancestors.map(&:to_s)
+      if ancestors.include? 'ActiveRecord::Base'
         require File.join(File.dirname(__FILE__), 'logic', 'active_record', 'setup')
         Estate::Logic::ActiveRecord::Setup.call(base)
-      else
+      elsif ancestors.include? 'Sequel::Model'
         require File.join(File.dirname(__FILE__), 'logic', 'sequel', 'setup')
         Estate::Logic::Sequel::Setup.call(base)
+      else
+        require File.join(File.dirname(__FILE__), 'logic', 'plain_ruby_object', 'setup')
+        Estate::Logic::PlainRubyObject::Setup.call(base)
       end
     end
   end

data/lib/estate/version.rb

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

data/lib/estate.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
 require 'estate/configuration'
-require 'estate/constants/orm'
+require 'estate/constants/adapters'
 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.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Igor Korepanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -80,9 +80,9 @@ dependencies:
     - - '='
       - !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
+description: Estate is a Ruby gem designed to simplify state management in models,
+  as well as plain Ruby objects
+email: korepanovigor87@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -91,15 +91,15 @@ files:
 - README.md
 - lib/estate.rb
 - lib/estate/configuration.rb
-- lib/estate/constants/orm.rb
+- lib/estate/constants/adapters.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/plain_ruby_object/setup.rb
+- lib/estate/logic/plain_ruby_object/specific_logic.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
@@ -125,5 +125,5 @@ requirements: []
 rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
-summary: State machine for Rails models
+summary: State machine for Rails models and plain Ruby objects
 test_files: []

data/lib/estate/logic/core.rb

@@ -1,19 +0,0 @@
-# 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/requirements.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Estate
-  module Requirements
-    def check_requirements(base)
-      ancestors = base.ancestors.map(&:to_s)
-
-      unless 'Sequel::Model'.in?(ancestors) || 'ActiveRecord::Base'.in?(ancestors)
-        raise(StandardError, 'Estate requires ActiveRecord or Sequel')
-      end
-    end
-
-    module_function :check_requirements
-  end
-end