stateful_models 0.0.1 → 0.0.2

data/spec/{dummy/db/migrate/20241221183116_create_has_states_tables.rb → generators/tmp/db/migrate/20241223213845_create_has_states_states.rb}

@@ -1,8 +1,7 @@
-# frozen_string_literal: true
-
-class CreateHasStatesTables < ActiveRecord::Migration[7.1]
+ class CreateHasStatesStates < ActiveRecord::Migration[8.0]
   def change
     create_table :has_states_states do |t|
+      t.string :type, null: false
       t.string :state_type
       t.string :status, null: false
 
@@ -10,10 +9,10 @@ class CreateHasStatesTables < ActiveRecord::Migration[7.1]
 
       t.references :stateable, polymorphic: true, null: false
 
-      t.datetime :completed_at
       t.timestamps
 
+      t.index %i[type stateable_id]
       t.index %i[stateable_type stateable_id]
     end
   end
-end
+end

data/spec/has_states/state_spec.rb

@@ -261,4 +261,66 @@ RSpec.describe HasStates::State, type: :model do
       end.to change { HasStates.configuration.callbacks.size }.from(1).to(0)
     end
   end
+
+  describe 'custom state types' do
+    # Create a custom state class for testing
+    class KYCState < HasStates::Base
+      validates :metadata, presence: true
+      validate :required_metadata_fields
+      
+      private
+      
+      def required_metadata_fields
+        return if metadata&.key?('document_type')
+        errors.add(:metadata, 'must include document_type')
+      end
+    end
+
+    let(:user) { create(:user) }
+
+    it 'allows creation of custom state types' do
+      state = user.add_state(
+        'kyc',
+        status: 'pending',
+        metadata: { document_type: 'passport' },
+        state_class: KYCState
+      )
+
+      expect(state).to be_valid
+      expect(state).to be_a(KYCState)
+    end
+
+    it 'enforces custom validations' do
+      expect do
+        user.add_state(
+          'kyc',
+          status: 'pending',
+          metadata: { other_field: 'value' },
+          state_class: KYCState
+        )
+      end.to raise_error(
+        ActiveRecord::RecordInvalid,
+        /Metadata must include document_type/
+      )
+    end
+
+    it 'defaults to HasStates::State when no state_class specified' do
+      state = user.add_state('kyc', status: 'pending')
+      
+      expect(state).to be_a(HasStates::State)
+      expect(state).to be_valid
+    end
+
+    it 'maintains STI type across database reads' do
+      state = user.add_state(
+        'kyc',
+        status: 'pending',
+        metadata: { document_type: 'passport' },
+        state_class: KYCState
+      )
+
+      reloaded_state = HasStates::Base.find(state.id)
+      expect(reloaded_state).to be_a(KYCState)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stateful_models
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sebastian Scholl
@@ -26,6 +26,7 @@ files:
 - lib/generators/has_states/install/templates/create_has_states_states.rb.erb
 - lib/generators/has_states/install/templates/initializer.rb.erb
 - lib/has_states.rb
+- lib/has_states/base.rb
 - lib/has_states/callback.rb
 - lib/has_states/configuration.rb
 - lib/has_states/configuration/model_configuration.rb
@@ -62,13 +63,14 @@ files:
 - spec/dummy/config/environments/test.rb
 - spec/dummy/config/initializers/cors.rb
 - spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/has_states.rb
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/master.key
 - spec/dummy/config/puma.rb
 - spec/dummy/config/routes.rb
 - spec/dummy/db/migrate/20241221171423_create_test_models.rb
-- spec/dummy/db/migrate/20241221183116_create_has_states_tables.rb
+- spec/dummy/db/migrate/20241223212128_create_has_states_states.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/seeds.rb
 - spec/dummy/log/development.log
@@ -80,7 +82,7 @@ files:
 - spec/factories/has_states.rb
 - spec/generators/has_states/install_generator_spec.rb
 - spec/generators/tmp/config/initializers/has_states.rb
-- spec/generators/tmp/db/migrate/20241223020432_create_has_states_states.rb
+- spec/generators/tmp/db/migrate/20241223213845_create_has_states_states.rb
 - spec/has_states/callback_spec.rb
 - spec/has_states/configuration_spec.rb
 - spec/has_states/state_spec.rb