estate 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e432065bf5d5370925a9ba65ca110ebad8c4c3810feaa2302c281d43b4d93426
-  data.tar.gz: cd71905ea5af259bc6b970cd91bb215d16934bb76892815439876ca91814d199
+  metadata.gz: f445ae55c16632d7805cd1774f2800eed57ebf16ce63db5ef7e780225ecc52a1
+  data.tar.gz: 60527e77ed67584c663bde4504a104c1b9b38e179fdd299e5344bef2031d6bb9
 SHA512:
-  metadata.gz: c68e50c0e42ebbf1700d9ee93cbcdfd24d1e33a289eb674f1346148035fb92d9bedb492331ddc611f4c987c0699895fa28d74274668c8ea0930f199fe3e377a9
-  data.tar.gz: 60fd96c4b66633ee872546c82d087f433532e32ec0cbe89a3df56edfd636cfcc93e596f4f2010f9115281907d96727b3439fa762f72c71a118b92cbbbfd68e7c
+  metadata.gz: e27a18f1f5a82b3b2316d559eb7847f400f15b025fad62dc3d1ced8106856d2c8c60014a86af2837e81f03cf6956175af7f2ab0dabf08d0b0d4fb6b7dac37495
+  data.tar.gz: a2f52b92fff0482abbc7981ab5685d59b5430e171f37c568f68f8ab72d1ed57d851886b0bbf631c472ee34ced52699203571c1ffd420ee636d94cfa00daf1984

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2023 Igor Korepanov
+Copyright (c) 2023-2024 Igor Korepanov
 
 MIT License
 

data/README.md

@@ -0,0 +1,89 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile and run `bundle install`:
+
+```ruby
+gem 'estate'
+```
+
+Or install it manually using:
+
+```bash
+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:
+
+```ruby
+class MyModel < ApplicationRecord
+  include Estate
+
+  estate do
+    state :state_1
+    state :state_2
+    state :state_3
+
+    transition from: :state_1, to: :state_2
+    transition from: :state_2, to: :state_3
+    transition from: :state_3, to: :state_1
+  end
+end
+```
+
+The default field for storing the state is named state. You can customize this field by providing options to the estate method:
+
+```ruby
+class MyModel < ApplicationRecord
+  include Estate
+
+  estate(column: :custom_state_field, empty_initial_state: true) do
+    state :state_1
+    state :state_2
+    state :state_3
+
+    transition from: :state_1, to: :state_2
+    transition from: :state_2, to: :state_3
+    transition from: :state_3, to: :state_1
+  end
+end
+```
+
+## Migration Example
+
+```bash
+bundle exec rails generate migration AddStateToMyModels state:string
+```
+
+This will generate a migration file. Open the migration file and modify it to suit your needs, for example:
+
+```ruby
+class AddStateToMyModels < ActiveRecord::Migration[7.0]
+  def change
+    add_column :my_models, :state, :string
+  end
+end
+```
+
+Run the migration:
+
+```bash
+bundle exec rails db:migrate
+```
+
+## License
+
+Copyright (c) 2023-2024 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

@@ -2,7 +2,7 @@
 
 module Estate
   module ActiveRecord
-    CALLBACK_NAMES = [:before_validation]
+    CALLBACK_NAMES = [:before_validation].freeze
 
     def setup_callbacks(base)
       base.class_eval do
@@ -17,27 +17,19 @@ module Estate
       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
+        if to_state.nil? && !Estate::Configuration.allow_empty_initial_state
+          raise(StandardError, "empty `#{Estate::Configuration.column_name}` is not allowed")
         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")
+      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
+end

data/lib/estate/configuration.rb

@@ -16,4 +16,4 @@ module Estate
       ALLOW_EMPTY_INITIAL_STATE = false
     end
   end
-end
+end

data/lib/estate/estate.rb

@@ -8,7 +8,6 @@ module Estate
     Estate::ActiveRecord.setup_callbacks(base)
     Estate::StateMachine.create_store
 
-    # TODO: make sure inheritance (aka subclassing) works with AASM
     super
   end
 
@@ -29,12 +28,10 @@ module Estate
     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
+      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)
         raise(StandardError, "`transition from: :#{from}, to: :#{to}` already defined")
       end

data/lib/estate/requirements.rb

@@ -3,13 +3,11 @@
 module Estate
   module Requirements
     def check_requirements(base)
-      ancestors = base.ancestors.map {|klass| klass.to_s}
+      ancestors = base.ancestors.map(&:to_s)
 
-      unless ancestors.include?("ActiveRecord::Base")
-        raise(StandardError, "Estate requires ActiveRecord")
-      end
+      raise(StandardError, 'Estate requires ActiveRecord') unless ancestors.include?('ActiveRecord::Base')
     end
 
     module_function :check_requirements
   end
-end
+end

data/lib/estate/state_machine.rb

@@ -38,4 +38,4 @@ module Estate
       attr_reader :states, :transitions
     end
   end
-end
+end

data/lib/estate/version.rb

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

metadata

@@ -1,17 +1,74 @@
 --- !ruby/object:Gem::Specification
 name: estate
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 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
+date: 2024-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.59.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.59.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.20.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.20.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.26.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.26.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+description: Estate is a Ruby gem designed to simplify state management in ActiveRecord
+  models
+email: noemail@example.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -25,7 +82,7 @@ files:
 - lib/estate/requirements.rb
 - lib/estate/state_machine.rb
 - lib/estate/version.rb
-homepage: https://rubygems.org/gems/estate
+homepage: https://github.com/igorkorepanov/estate
 licenses:
 - MIT
 metadata: {}
@@ -37,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -47,5 +104,5 @@ requirements: []
 rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
-summary: Estate
+summary: State machine for Rails models
 test_files: []