approval_cycle 0.1.0.pre → 0.1.1.pre

data/spec/features/configurable_approval_statuses_demo_spec.rb

@@ -0,0 +1,76 @@
+require 'rails_helper'
+
+# Demonstration of configurable approval statuses
+RSpec.describe 'Configurable Approval Statuses Demo', type: :model do
+  describe 'Configured approval statuses' do
+    it 'uses the configured custom statuses for dummy_request' do
+      # Since we have custom statuses configured in the dummy app initializer
+      expected_statuses = %w[pending approved rejected cancelled on_hold auto_approved skipped_after_rejection skipped_after_withdrawal]
+      actual_statuses = ApprovalCycle::Approval.statuses.keys
+
+      expect(actual_statuses).to match_array(expected_statuses)
+    end
+  end
+
+  describe 'Custom approval statuses configuration' do
+    it 'allows configuration to be set' do
+      # This demonstrates how a user would configure custom statuses for dummy_request
+      custom_config = ApprovalCycle::Configuration.new
+      custom_config.approval_statuses = {
+        pending:   'pending',
+        approved:  'approved',
+        rejected:  'rejected',
+        cancelled: 'cancelled',
+        on_hold:   'on_hold'
+      }
+
+      expect(custom_config.approval_statuses.keys).to contain_exactly(
+        :pending, :approved, :rejected, :cancelled, :on_hold
+      )
+    end
+
+    it 'provides access to custom statuses via configuration for dummy_request' do
+      # This shows how the enum accesses the configuration for dummy_request workflow
+      ApprovalCycle.configure do |config|
+        config.approval_cycle_setup_types = { dummy_request: 0 }
+        config.approval_statuses = {
+          pending:   'pending',
+          approved:  'approved',
+          rejected:  'rejected',
+          cancelled: 'cancelled',
+          on_hold:   'on_hold'
+        }
+      end
+
+      # The configuration is available and can be accessed
+      expect(ApprovalCycle.configuration.approval_statuses).to include(
+        pending:   'pending',
+        approved:  'approved',
+        rejected:  'rejected',
+        cancelled: 'cancelled',
+        on_hold:   'on_hold'
+      )
+    end
+  end
+
+  describe 'Fallback behavior' do
+    it 'uses fallback statuses when configuration is nil' do
+      # Simulate the enum fallback behavior
+      config_statuses = nil
+      fallback_statuses = {
+        pending:                  'pending',
+        rejected:                 'rejected',
+        approved:                 'approved',
+        skipped:                  'skipped',
+        auto_approved:            'auto_approved',
+        skipped_after_rejection:  'skipped_after_rejection',
+        skipped_after_withdrawal: 'skipped_after_withdrawal'
+      }
+
+      # This is what happens in the enum definition
+      used_statuses = config_statuses || fallback_statuses
+
+      expect(used_statuses).to eq(fallback_statuses)
+    end
+  end
+end

data/spec/lib/approval_cycle/configuration_spec.rb

@@ -0,0 +1,81 @@
+require 'rails_helper'
+
+module ApprovalCycle
+  RSpec.describe Configuration do
+    let(:config) { Configuration.new }
+
+    describe '#approval_statuses' do
+      it 'has default approval statuses' do
+        expect(config.approval_statuses).to eq({
+                                                 pending:                  'pending',
+                                                 rejected:                 'rejected',
+                                                 approved:                 'approved',
+                                                 skipped:                  'skipped',
+                                                 auto_approved:            'auto_approved',
+                                                 skipped_after_rejection:  'skipped_after_rejection',
+                                                 skipped_after_withdrawal: 'skipped_after_withdrawal'
+                                               })
+      end
+
+      it 'allows custom approval statuses to be set' do
+        custom_statuses = {
+          pending:   'pending',
+          approved:  'approved',
+          rejected:  'rejected',
+          cancelled: 'cancelled'
+        }
+
+        config.approval_statuses = custom_statuses
+        expect(config.approval_statuses).to eq(custom_statuses)
+      end
+    end
+
+    describe '#approval_cycle_setup_types' do
+      it 'starts with empty setup types' do
+        expect(config.approval_cycle_setup_types).to eq({})
+      end
+
+      it 'allows setup types to be set' do
+        setup_types = { dummy_request: 0 }
+        config.approval_cycle_setup_types = setup_types
+        expect(config.approval_cycle_setup_types).to eq(setup_types)
+      end
+    end
+  end
+
+  RSpec.describe 'ApprovalCycle.configure' do
+    around do |example|
+      original_config = ApprovalCycle.configuration
+      example.run
+      ApprovalCycle.configuration = original_config
+    end
+
+    it 'allows configuration of approval statuses' do
+      ApprovalCycle.configure do |config|
+        config.approval_statuses = {
+          pending:   'pending',
+          approved:  'approved',
+          rejected:  'rejected',
+          cancelled: 'cancelled'
+        }
+      end
+
+      expect(ApprovalCycle.configuration.approval_statuses).to eq({
+                                                                    pending:   'pending',
+                                                                    approved:  'approved',
+                                                                    rejected:  'rejected',
+                                                                    cancelled: 'cancelled'
+                                                                  })
+    end
+
+    it 'allows configuration of setup types' do
+      ApprovalCycle.configure do |config|
+        config.approval_cycle_setup_types = { dummy_request: 0 }
+      end
+
+      expect(ApprovalCycle.configuration.approval_cycle_setup_types).to eq({
+                                                                             dummy_request: 0
+                                                                           })
+    end
+  end
+end

data/spec/models/approval_cycle/approval_spec.rb

@@ -10,8 +10,8 @@ module ApprovalCycle
     let(:fourth_user)   { users.fourth }
     let(:user)          { create(:dummy_user) }
     let(:approver)      { create(:approver, user_id: user.id, user_type: 'DummyUser', approval_cycle_setup: setup, order: 10) }
-    let(:approvers)     { [ { user_id: first_user.id, order: 0, user_type: 'DummyUser' }, { user_id: second_user.id, order: 1, user_type: 'DummyUser' }, { user_id: third_user.id, order: 2, user_type: 'DummyUser' } ] }
-    let(:setup)         { create(:setup, level: company, approval_cycle_setup_type: :dummy_request, modifier: user, approval_cycle_approvers_attributes: approvers, approval_cycle_watchers_attributes: [ { user_id: user.id, user_type: 'DummyUser', action: 'both' } ], approval_cycle_action_takers_attributes: [ { user_id: user.id, user_type: 'DummyUser' } ]) }
+    let(:approvers)     { [{ user_id: first_user.id, order: 0, user_type: 'DummyUser' }, { user_id: second_user.id, order: 1, user_type: 'DummyUser' }, { user_id: third_user.id, order: 2, user_type: 'DummyUser' }] }
+    let(:setup)         { create(:setup, level: company, approval_cycle_setup_type: :dummy_request, modifier: user, approval_cycle_approvers_attributes: approvers, approval_cycle_watchers_attributes: [{ user_id: user.id, user_type: 'DummyUser', action: 'both' }], approval_cycle_action_takers_attributes: [{ user_id: user.id, user_type: 'DummyUser' }]) }
     let(:second_setup)  { create(:setup, level: company, modifier: user, approval_cycle_setup_type: :dummy_request) }
     let(:dummy_request) { create(:dummy_request, approval_cycle_setup: setup, approval_cycle_status: :pending, modifier: user) }
     let(:subject)       { create(:approval, approval_cycle_approver: approver, approvable: dummy_request) }
@@ -28,7 +28,36 @@ module ApprovalCycle
     end
 
     describe 'Enums' do
-      it { should define_enum_for(:status).with_values({ pending: 'pending', rejected: 'rejected', approved: 'approved', skipped: 'skipped', auto_approved: 'auto_approved', skipped_after_rejection: 'skipped_after_rejection', skipped_after_withdrawal: 'skipped_after_withdrawal' }).backed_by_column_of_type(:string).with_prefix(true) }
+      it { should define_enum_for(:status).with_values({ pending: 'pending', approved: 'approved', rejected: 'rejected', cancelled: 'cancelled', on_hold: 'on_hold', auto_approved: 'auto_approved', skipped_after_rejection: 'skipped_after_rejection', skipped_after_withdrawal: 'skipped_after_withdrawal' }).backed_by_column_of_type(:string).with_prefix(true) }
+
+      context 'with custom approval statuses' do
+        around do |example|
+          original_config = ApprovalCycle.configuration
+          ApprovalCycle.configuration = ApprovalCycle::Configuration.new
+          ApprovalCycle.configure do |config|
+            config.approval_cycle_setup_types = { dummy_request: 0 }
+            config.approval_statuses = {
+              pending:   'pending',
+              approved:  'approved',
+              rejected:  'rejected',
+              cancelled: 'cancelled'
+            }
+          end
+
+          example.run
+
+          ApprovalCycle.configuration = original_config
+        end
+
+        it 'allows custom statuses to be configured' do
+          expect(ApprovalCycle.configuration.approval_statuses).to eq({
+                                                                        pending:   'pending',
+                                                                        approved:  'approved',
+                                                                        rejected:  'rejected',
+                                                                        cancelled: 'cancelled'
+                                                                      })
+        end
+      end
     end
 
     describe '#update_next_approval_received_at' do
@@ -69,7 +98,7 @@ module ApprovalCycle
         context 'when current approval is first approval' do
           it 'does not update next approval received_at' do
             expect(current_approval.count).to          eq(1)
-            expect(current_approval.pluck(:status)).to eq([ 'rejected' ])
+            expect(current_approval.pluck(:status)).to eq(['rejected'])
           end
         end
       end
@@ -89,7 +118,7 @@ module ApprovalCycle
         end
 
         it 'creates all other approvals with NIL received_at and status' do
-          expect(Approval.last(2).pluck(:approval_cycle_approver_id, :received_at, :status)).to match_array(awaiting_approvals.map { |approver| [ approver.id, nil, 'pending' ] })
+          expect(Approval.last(2).pluck(:approval_cycle_approver_id, :received_at, :status)).to match_array(awaiting_approvals.map { |approver| [approver.id, nil, 'pending'] })
         end
       end
     end
@@ -100,7 +129,7 @@ module ApprovalCycle
 
       context 'when created_by is approver' do
         context 'when approver is first and only approver' do
-          let(:approvers) { [ { user_id: user.id, order: 0, user_type: 'DummyUser' } ] }
+          let(:approvers) { [{ user_id: user.id, order: 0, user_type: 'DummyUser' }] }
 
           it 'approves request' do
             expect(request_status).to         eq('approved')
@@ -109,7 +138,7 @@ module ApprovalCycle
         end
 
         context 'when approver is last approver' do
-          let(:approvers) { [ { user_id: first_user.id, order: 0, user_type: 'DummyUser' }, { user_id: user.id, order: 1, user_type: 'DummyUser' } ] }
+          let(:approvers) { [{ user_id: first_user.id, order: 0, user_type: 'DummyUser' }, { user_id: user.id, order: 1, user_type: 'DummyUser' }] }
 
           before { Approval.first.approve! }
 
@@ -120,7 +149,7 @@ module ApprovalCycle
         end
 
         context 'when approver is not last approver' do
-          let(:approvers) { [ { user_id: first_user.id, order: 0, user_type: 'DummyUser' }, { user_id: user.id, order: 1, user_type: 'DummyUser' }, { user_id: third_user.id, order: 2, user_type: 'DummyUser' } ] }
+          let(:approvers) { [{ user_id: first_user.id, order: 0, user_type: 'DummyUser' }, { user_id: user.id, order: 1, user_type: 'DummyUser' }, { user_id: third_user.id, order: 2, user_type: 'DummyUser' }] }
 
           before { Approval.first.approve! }
 
@@ -133,7 +162,7 @@ module ApprovalCycle
       end
 
       context 'when created_by is not approver' do
-        let(:approvers) { [ { user_id: first_user.id, order: 0, user_type: 'DummyUser' } ] }
+        let(:approvers) { [{ user_id: first_user.id, order: 0, user_type: 'DummyUser' }] }
 
         it 'does not auto approve' do
           expect(request_status).to         eq('pending')

data/spec/models/approval_cycle/setup_spec.rb

@@ -1,3 +1,5 @@
+require 'rails_helper'
+
 module ApprovalCycle
   RSpec.describe Setup, type: :model do
     let(:company)              { create(:company) }

data/spec/services/approval_cycle/setup_updater_spec.rb

@@ -1,6 +1,8 @@
+require 'rails_helper'
+
 module ApprovalCycle
-  RSpec.describe SetupUpdater, type: :service do
-    describe '#call' do
+  RSpec.describe SetupUpdater, type: :service do # rubocop:disable Metrics/BlockLength
+    describe '#call' do # rubocop:disable Metrics/BlockLength
       let(:company)            { create(:company) }
       let(:user)               { create(:dummy_user) }
       let(:setup_attrs)        { { approval_cycle_approvers_attributes: [ { user_id: user.id, order: 0, user_type: 'DummyUser' } ], approval_cycle_watchers_attributes: [ { user_id: user.id, action: 'both', user_type: 'DummyUser' } ], approval_cycle_action_takers_attributes: [ { user_id: user.id, user_type: 'DummyUser' } ] } }
@@ -14,7 +16,7 @@ module ApprovalCycle
 
       before { dummy_request }
 
-      context 'with valid params' do
+      context 'with valid params' do # rubocop:disable Metrics/BlockLength
         context 'when apply_to_versions is false' do
           let(:params) { update_params }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: approval_cycle
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.1.pre
 platform: ruby
 authors:
 - Farah Assaf
@@ -163,7 +163,6 @@ files:
 - app/services/approval_cycle/setup_updater.rb
 - app/views/layouts/approval_cycle/application.html.erb
 - config/routes.rb
-- db/migrate/20240723091230_enable_pg_trgm_extention.rb
 - db/migrate/20240723091231_create_approval_cycle_setups.rb
 - db/migrate/20240723142036_create_approval_cycle_approvers.rb
 - db/migrate/20240806080650_create_approval_cycle_watchers.rb
@@ -222,14 +221,13 @@ files:
 - spec/dummy/db/migrate/20241028115559_create_companies.rb
 - spec/dummy/db/migrate/20241028115633_create_dummy_users.rb
 - spec/dummy/db/migrate/20241030055459_create_dummy_requests.rb
-- spec/dummy/db/migrate/20250731094004_enable_pg_trgm_extention.rb
-- spec/dummy/db/migrate/20250731094005_create_approval_cycle_setups.rb
-- spec/dummy/db/migrate/20250731094006_create_approval_cycle_approvers.rb
-- spec/dummy/db/migrate/20250731094007_create_approval_cycle_watchers.rb
-- spec/dummy/db/migrate/20250731094008_create_approval_cycle_action_takers.rb
-- spec/dummy/db/migrate/20250731094009_create_approval_cycle_object_activities.rb
-- spec/dummy/db/migrate/20250731094010_create_approval_cycle_approvals.rb
-- spec/dummy/db/migrate/20250731094101_add_approval_cycle_to_configured_types.rb
+- spec/dummy/db/migrate/20250731123034_create_approval_cycle_setups.rb
+- spec/dummy/db/migrate/20250731123035_create_approval_cycle_approvers.rb
+- spec/dummy/db/migrate/20250731123036_create_approval_cycle_watchers.rb
+- spec/dummy/db/migrate/20250731123037_create_approval_cycle_action_takers.rb
+- spec/dummy/db/migrate/20250731123038_create_approval_cycle_object_activities.rb
+- spec/dummy/db/migrate/20250731123039_create_approval_cycle_approvals.rb
+- spec/dummy/db/migrate/20250731123227_add_approval_cycle_to_configured_types.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/log/development.log
 - spec/dummy/log/teast.log
@@ -252,6 +250,8 @@ files:
 - spec/factories/dummy_users.rb
 - spec/factories/setups.rb
 - spec/factories/watchers.rb
+- spec/features/configurable_approval_statuses_demo_spec.rb
+- spec/lib/approval_cycle/configuration_spec.rb
 - spec/models/approval_cycle/action_taker_spec.rb
 - spec/models/approval_cycle/approval_spec.rb
 - spec/models/approval_cycle/approver_spec.rb
@@ -334,14 +334,13 @@ test_files:
 - spec/dummy/db/migrate/20241028115559_create_companies.rb
 - spec/dummy/db/migrate/20241028115633_create_dummy_users.rb
 - spec/dummy/db/migrate/20241030055459_create_dummy_requests.rb
-- spec/dummy/db/migrate/20250731094004_enable_pg_trgm_extention.rb
-- spec/dummy/db/migrate/20250731094005_create_approval_cycle_setups.rb
-- spec/dummy/db/migrate/20250731094006_create_approval_cycle_approvers.rb
-- spec/dummy/db/migrate/20250731094007_create_approval_cycle_watchers.rb
-- spec/dummy/db/migrate/20250731094008_create_approval_cycle_action_takers.rb
-- spec/dummy/db/migrate/20250731094009_create_approval_cycle_object_activities.rb
-- spec/dummy/db/migrate/20250731094010_create_approval_cycle_approvals.rb
-- spec/dummy/db/migrate/20250731094101_add_approval_cycle_to_configured_types.rb
+- spec/dummy/db/migrate/20250731123034_create_approval_cycle_setups.rb
+- spec/dummy/db/migrate/20250731123035_create_approval_cycle_approvers.rb
+- spec/dummy/db/migrate/20250731123036_create_approval_cycle_watchers.rb
+- spec/dummy/db/migrate/20250731123037_create_approval_cycle_action_takers.rb
+- spec/dummy/db/migrate/20250731123038_create_approval_cycle_object_activities.rb
+- spec/dummy/db/migrate/20250731123039_create_approval_cycle_approvals.rb
+- spec/dummy/db/migrate/20250731123227_add_approval_cycle_to_configured_types.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/log/development.log
 - spec/dummy/log/teast.log
@@ -364,6 +363,8 @@ test_files:
 - spec/factories/dummy_users.rb
 - spec/factories/setups.rb
 - spec/factories/watchers.rb
+- spec/features/configurable_approval_statuses_demo_spec.rb
+- spec/lib/approval_cycle/configuration_spec.rb
 - spec/models/approval_cycle/action_taker_spec.rb
 - spec/models/approval_cycle/approval_spec.rb
 - spec/models/approval_cycle/approver_spec.rb

data/db/migrate/20240723091230_enable_pg_trgm_extention.rb

@@ -1,9 +0,0 @@
-class EnablePgTrgmExtention < ActiveRecord::Migration[7.0]
-  def up
-    enable_extension('pg_trgm') unless extensions.include?('pg_trgm')
-  end
-
-  def down
-    disable_extension('pg_trgm') if extensions.include?('pg_trgm')
-  end
-end

data/spec/dummy/db/migrate/20250731094004_enable_pg_trgm_extention.rb

@@ -1,9 +0,0 @@
-class EnablePgTrgmExtention < ActiveRecord::Migration[7.0]
-  def up
-    enable_extension('pg_trgm') unless extensions.include?('pg_trgm')
-  end
-
-  def down
-    disable_extension('pg_trgm') if extensions.include?('pg_trgm')
-  end
-end