estate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e432065bf5d5370925a9ba65ca110ebad8c4c3810feaa2302c281d43b4d93426
+  data.tar.gz: cd71905ea5af259bc6b970cd91bb215d16934bb76892815439876ca91814d199
+SHA512:
+  metadata.gz: c68e50c0e42ebbf1700d9ee93cbcdfd24d1e33a289eb674f1346148035fb92d9bedb492331ddc611f4c987c0699895fa28d74274668c8ea0930f199fe3e377a9
+  data.tar.gz: 60fd96c4b66633ee872546c82d087f433532e32ec0cbe89a3df56edfd636cfcc93e596f4f2010f9115281907d96727b3439fa762f72c71a118b92cbbbfd68e7c

data/LICENSE.txt

@@ -0,0 +1,9 @@
+Copyright (c) 2023 Igor Korepanov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/estate/active_record.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Estate
+  module ActiveRecord
+    CALLBACK_NAMES = [:before_validation]
+
+    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?
+          if Estate::Configuration.allow_empty_initial_state
+            # OK
+          else
+            raise(StandardError, "empty `#{Estate::Configuration.column_name}` is not allowed")
+          end
+        end
+      else
+        # TODO: check to_state.nil?
+        if Estate::StateMachine.state_exists?(to_state)
+          if Estate::StateMachine.transition_exists?(from: from_state, to: to_state)
+          else
+            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")
+          # raise(StandardError, "state `#{to_state}` is not defined")
+        end
+      end
+    end
+
+    module_function :setup_callbacks, :validate_state_changes
+  end
+end

data/lib/estate/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Estate
+  module Configuration
+    class << self
+      def init_config(column_name:, allow_empty_initial_state:)
+        @column_name = column_name
+        @allow_empty_initial_state = allow_empty_initial_state
+      end
+
+      attr_reader :column_name, :allow_empty_initial_state
+    end
+
+    module Defaults
+      COLUMN_NAME = :state
+      ALLOW_EMPTY_INITIAL_STATE = false
+    end
+  end
+end

data/lib/estate/estate.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Estate
+  def self.included(base)
+    base.extend Estate::ClassMethods
+
+    Estate::Requirements.check_requirements(base)
+    Estate::ActiveRecord.setup_callbacks(base)
+    Estate::StateMachine.create_store
+
+    # TODO: make sure inheritance (aka subclassing) works with AASM
+    super
+  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)
+
+      yield if block_given?
+    end
+
+    def state(name)
+      if Estate::StateMachine.state_exists?(name)
+        raise(StandardError, "state `:#{name}` is already defined")
+      else
+        Estate::StateMachine.register_state(name)
+      end
+    end
+
+    def transition(from:, to:)
+      unless Estate::StateMachine.state_exists?(from)
+        raise(StandardError, "state `#{from}` is not defined")
+      end
+      unless Estate::StateMachine.state_exists?(to)
+        raise(StandardError, "state `#{to}` is not defined")
+      end
+      if Estate::StateMachine.transition_exists?(from: from, to: to)
+        raise(StandardError, "`transition from: :#{from}, to: :#{to}` already defined")
+      end
+
+      Estate::StateMachine.register_transition(from: from, to: to)
+    end
+  end
+end

data/lib/estate/requirements.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Estate
+  module Requirements
+    def check_requirements(base)
+      ancestors = base.ancestors.map {|klass| klass.to_s}
+
+      unless ancestors.include?("ActiveRecord::Base")
+        raise(StandardError, "Estate requires ActiveRecord")
+      end
+    end
+
+    module_function :check_requirements
+  end
+end

data/lib/estate/state_machine.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Estate
+  class StateMachine
+    class << self
+      def create_store
+        @states = {}
+        @transitions = {}
+      end
+
+      def state_exists?(state)
+        !state.nil? && 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
+      end
+
+      def transition_exists?(from:, to:)
+        # TODO: validate from and to
+        transition_key = { from: from.to_sym, to: to.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 }
+        transitions[transition_key] = nil
+      end
+
+      attr_reader :states, :transitions
+    end
+  end
+end

data/lib/estate/version.rb

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

data/lib/estate.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'estate/version'
+require 'estate/requirements'
+require 'estate/configuration'
+require 'estate/state_machine'
+require 'estate/active_record'
+require 'estate/estate'

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: estate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Igor Korepanov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-05 00:00:00.000000000 Z
+dependencies: []
+description: Estate test gem
+email: email@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/estate.rb
+- lib/estate/active_record.rb
+- lib/estate/configuration.rb
+- lib/estate/estate.rb
+- lib/estate/requirements.rb
+- lib/estate/state_machine.rb
+- lib/estate/version.rb
+homepage: https://rubygems.org/gems/estate
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Estate
+test_files: []