aasm 5.1.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be8ee23b312066a6b90211161857cb2c461f20e9b1e3e93f955d6b8caeb6f497
-  data.tar.gz: 47c63523fc92f0fdc823024f632f27cab4453c4c2c9c7e277c45dea0f170250f
+  metadata.gz: f2f4099a66f8d753c2bd7c06b3c378dcd37b47acf9b2f7487784e7762742c1c4
+  data.tar.gz: 8971b36f1b066c08d3a4d278a99d7c1e5386be72182da62b51a82db1e60e9e9f
 SHA512:
-  metadata.gz: 258182cd645528de747eff39a70bcd697b5f965e49890ce369804aba0fb4c08739ff5259efef9cdde405b819765becb451ba4a6994f74dc89f0581c387d84ef1
-  data.tar.gz: 9408e99df7783505a8a67d4d54b0d5f3660b991790db7bad46598734ed33d1d7f1b5e463f67d435c0de15d0d1ef020023f8900781a72a40bcc85c35d76c8cf22
+  metadata.gz: c24e544b82cfc4616f3e3ff033b7a5ab68bff7bd834b115797e9127ca361effe241ffb1adaedcdb595711a6757f2e0a8e0a8d606a9bc812c28707a1ee845ef40
+  data.tar.gz: 421636d1e59e52b8d6b4ddff7dd373fecd9a19ef67b90935e856b1ee980bae9a5a4a8526e62238de9ecc84a7783362e8d5b2005c53b9c7754368be79724c6255

data/.travis.yml

@@ -12,7 +12,6 @@ before_install:
   - bundle _1.16.1_ install
 
 rvm:
-  - 2.3.0
   - 2.5.0
   - 2.6.5
   - 2.7.0
@@ -47,16 +46,6 @@ script:
 
 matrix:
   exclude:
-    - rvm: 2.3.0
-      gemfile: gemfiles/norails.gemfile
-    - rvm: 2.3.0
-      gemfile: gemfiles/rails_5.0.gemfile
-#    - rvm: 2.3.0
-#      gemfile: gemfiles/rails_5.0_nobrainer.gemfile
-    - rvm: 2.3.0
-      gemfile: gemfiles/rails_5.1.gemfile
-    - rvm: 2.3.0
-      gemfile: gemfiles/rails_5.2.gemfile
     - rvm: 2.7.0
       gemfile: gemfiles/rails_5.2.gemfile
     - rvm: 2.6.5

data/CHANGELOG.md

@@ -4,6 +4,12 @@
 
 ## 5.1.0
 
+* Fix Depreciation message for after_commit_everywhere [#695](https://github.com/aasm/aasm/issues/695) in PR [#696](https://github.com/aasm/aasm/pull/696)
+* Fix human_state to use display option [#684](https://github.com/aasm/aasm/issues/684) in PR [#697](https://github.com/aasm/aasm/pull/697)
+* Remove support for ruby 2.3
+
+## 5.1.0
+
 * Fix after_commit in nested transactions [#536](https://github.com/aasm/aasm/issues/536) without explicit AR dependency in PR [#668](https://github.com/aasm/aasm/pull/668), thanks to [stokarenko](https://github.com/stokarenko)
 * Remove support for Rails 3.2
 

data/README.md

@@ -434,6 +434,25 @@ job.stage1_completed
 job.aasm.current_state # stage3
 ```
 
+### Display name for state
+
+You can define display name for state using :display option
+
+```ruby
+class Job
+  include AASM
+
+  aasm do
+    state :stage1, initial: true, display: 'First Stage'
+    state :stage2
+    state :stage3
+  end
+end
+
+job = Job.new
+job.aasm.human_state
+
+```
 
 ### Multiple state machines per class
 

data/lib/aasm.rb

@@ -1,5 +1,3 @@
-require 'ostruct'
-
 require 'aasm/version'
 require 'aasm/errors'
 require 'aasm/configuration'

data/lib/aasm/instance_base.rb

@@ -28,7 +28,7 @@ module AASM
     end
 
     def human_state
-      AASM::Localizer.new.human_state_name(@instance.class, state_object_for_name(current_state))
+      state_object_for_name(current_state).display_name
     end
 
     def states(options={}, *args)

data/lib/aasm/persistence/active_record_persistence.rb

@@ -28,19 +28,6 @@ module AASM
       #   end
       #
       def self.included(base)
-        begin
-          require 'after_commit_everywhere'
-          raise LoadError unless Gem::Version.new(::AfterCommitEverywhere::VERSION) >= Gem::Version.new('0.1.5')
-
-          base.send(:include, ::AfterCommitEverywhere) unless base.include?(::AfterCommitEverywhere)
-          base.send(:alias_method, :aasm_execute_after_commit, :after_commit)
-        rescue LoadError
-          warn <<-MSG
-[DEPRECATION] :after_commit AASM callback is not safe in terms of race conditions and redundant calls.
-              Please add `gem 'after_commit_everywhere', '~> 0.1', '>= 0.1.5'` to your Gemfile in order to fix that.
-          MSG
-        end
-
         base.send(:include, AASM::Persistence::Base)
         base.send(:include, AASM::Persistence::ORM)
         base.send(:include, AASM::Persistence::ActiveRecordPersistence::InstanceMethods)
@@ -74,6 +61,24 @@ module AASM
 
         private
 
+        def aasm_execute_after_commit
+          begin
+            require 'after_commit_everywhere'
+            raise LoadError unless Gem::Version.new(::AfterCommitEverywhere::VERSION) >= Gem::Version.new('0.1.5')
+
+            self.extend ::AfterCommitEverywhere
+            after_commit do
+              yield
+            end
+          rescue LoadError
+            warn <<-MSG
+  [DEPRECATION] :after_commit AASM callback is not safe in terms of race conditions and redundant calls.
+                Please add `gem 'after_commit_everywhere', '~> 0.1', '>= 0.1.5'` to your Gemfile in order to fix that.
+            MSG
+            yield
+          end
+        end
+
         def aasm_raise_invalid_record
           raise ActiveRecord::RecordInvalid.new(self)
         end

data/lib/aasm/persistence/orm.rb

@@ -135,7 +135,7 @@ module AASM
             super
           end
 
-          if success
+          if success && !(event.options.keys & [:after_commit, :after_all_commits]).empty?
             aasm_execute_after_commit do
               event.fire_callbacks(:after_commit, self, *args)
               event.fire_global_callbacks(:after_all_commits, self, *args)

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "5.1.0"
+  VERSION = "5.1.1"
 end

data/spec/en.yml

@@ -4,9 +4,6 @@ en:
       localizer_test_model:
         close: "Let's close it!"
 
-    attributes:
-      localizer_test_model:
-        aasm_state/opened: "It's open now!"
     errors:
       messages:
         record_invalid: "Invalid record"

data/spec/{en_deprecated_style.yml → localizer_test_model_deprecated_style.yml}

@@ -1,9 +1,5 @@
 en:
   activerecord:
-    events:
-      localizer_test_model:
-        close: "Let's close it!"
-
     attributes:
       localizer_test_model:
         aasm_state:

data/spec/localizer_test_model_new_style.yml

@@ -0,0 +1,5 @@
+en:
+  activerecord:
+    attributes:
+      localizer_test_model:
+        aasm_state/opened: "It's open now!"

data/spec/models/active_record/localizer_test_model.rb

@@ -11,13 +11,13 @@ end
 
 describe 'localized state names' do
   before(:all) do
-    I18n.load_path << 'spec/en.yml'
-    I18n.default_locale = :en
+    I18n.load_path << 'spec/localizer_test_model_new_style.yml'
     I18n.reload!
   end
 
   after(:all) do
-    I18n.load_path.clear
+    I18n.load_path.delete('spec/localizer_test_model_new_style.yml')
+    I18n.backend.load_translations
   end
 
   it 'should localize' do

data/spec/models/default_state.rb

@@ -2,7 +2,7 @@ class DefaultState
   attr_accessor :transient_store, :persisted_store
   include AASM
   aasm do
-    state :alpha, :initial => true
+    state :alpha, :initial => true, display: 'ALPHA'
     state :beta
     state :gamma
     event :release do

data/spec/spec_helper.rb

@@ -13,6 +13,7 @@ $LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib
 require 'aasm'
 require 'rspec'
 require 'aasm/rspec'
+require 'i18n'
 require 'pry'
 
 # require 'ruby-debug'; Debugger.settings[:autoeval] = true; debugger; rubys_debugger = 'annoying'
@@ -34,3 +35,7 @@ Dir[File.dirname(__FILE__) + "/spec_helpers/**/*.rb"].sort.each { |f| require Fi
 
 # example model classes
 Dir[File.dirname(__FILE__) + "/models/*.rb"].sort.each { |f| require File.expand_path(f) }
+
+I18n.load_path << 'spec/en.yml'
+I18n.enforce_available_locales = false
+I18n.default_locale = :en

data/spec/unit/api_spec.rb

@@ -13,6 +13,10 @@ if defined?(ActiveRecord)
       expect(DefaultState.new.aasm.current_state).to eql :alpha
     end
 
+    it "uses display option" do
+      expect(DefaultState.new.aasm.human_state).to eql "ALPHA"
+    end
+
     it "uses the provided method" do
       expect(ProvidedState.new.aasm.current_state).to eql :beta
     end

data/spec/unit/inspection_multiple_spec.rb

@@ -166,11 +166,15 @@ describe "special cases" do
 end
 
 describe 'aasm.states_for_select' do
-  it "should return a select friendly array of states" do
-    expect(FooMultiple.aasm(:left)).to respond_to(:states_for_select)
-    expect(FooMultiple.aasm(:left).states_for_select).to eq(
-      [['Open', 'open'], ['Closed', 'closed'], ['Final', 'final']]
-    )
+  context 'without I18n' do
+    before { allow(Module).to receive(:const_defined?).with(:I18n).and_return(nil) }
+
+    it "should return a select friendly array of states" do
+      expect(FooMultiple.aasm(:left)).to respond_to(:states_for_select)
+      expect(FooMultiple.aasm(:left).states_for_select).to eq(
+        [['Open', 'open'], ['Closed', 'closed'], ['Final', 'final']]
+      )
+    end
   end
 end
 

data/spec/unit/inspection_spec.rb

@@ -102,9 +102,13 @@ describe "special cases" do
 end
 
 describe 'aasm.states_for_select' do
-  it "should return a select friendly array of states" do
-    expect(Foo.aasm).to respond_to(:states_for_select)
-    expect(Foo.aasm.states_for_select).to eq([['Open', 'open'], ['Closed', 'closed'], ['Final', 'final']])
+  context 'without I18n' do
+    before { allow(Module).to receive(:const_defined?).with(:I18n).and_return(nil) }
+
+    it "should return a select friendly array of states" do
+      expect(Foo.aasm).to respond_to(:states_for_select)
+      expect(Foo.aasm.states_for_select).to eq([['Open', 'open'], ['Closed', 'closed'], ['Final', 'final']])
+    end
   end
 end
 

data/spec/unit/localizer_spec.rb

@@ -1,20 +1,18 @@
 require 'spec_helper'
 
-if defined?(ActiceRecord)
-  require 'i18n'
-
-  I18n.enforce_available_locales = false
+if defined?(ActiveRecord)
+  require 'models/active_record/localizer_test_model'
   load_schema
 
   describe AASM::Localizer, "new style" do
     before(:all) do
-      I18n.load_path << 'spec/en.yml'
-      I18n.default_locale = :en
+      I18n.load_path << 'spec/localizer_test_model_new_style.yml'
       I18n.reload!
     end
 
     after(:all) do
-      I18n.load_path.clear
+      I18n.load_path.delete('spec/localizer_test_model_new_style.yml')
+      I18n.backend.load_translations
     end
 
     let (:foo_opened) { LocalizerTestModel.new }
@@ -43,13 +41,14 @@ if defined?(ActiceRecord)
 
   describe AASM::Localizer, "deprecated style" do
     before(:all) do
-      I18n.load_path << 'spec/en_deprecated_style.yml'
-      I18n.default_locale = :en
+      I18n.load_path << 'spec/localizer_test_model_deprecated_style.yml'
       I18n.reload!
+      I18n.backend.load_translations
     end
 
     after(:all) do
-      I18n.load_path.clear
+      I18n.load_path.delete('spec/localizer_test_model_deprecated_style.yml')
+      I18n.backend.load_translations
     end
 
     let (:foo_opened) { LocalizerTestModel.new }

data/spec/unit/state_spec.rb

@@ -17,12 +17,28 @@ describe AASM::Core::State do
     expect(state.name).to eq(:astate)
   end
 
-  it 'should set the display_name from name' do
-    expect(new_state.display_name).to eq('Astate')
-  end
+  describe '#display_name' do
+    subject(:display_name) { new_state(options).display_name }
+
+    context 'without options' do
+      let(:options) { {} }
+
+      context 'without I18n' do
+        before { allow(Module).to receive(:const_defined?).with(:I18n).and_return(nil) }
+
+        it 'should set the display_name from name' do
+          expect(display_name).to eq('Astate')
+        end
+      end
+    end
+
+    context 'with :display option' do
+      let(:options) { { display: "A State" } }
 
-  it 'should set the display_name from options' do
-    expect(new_state(:display => "A State").display_name).to eq('A State')
+      it 'should set the display_name from options' do
+        expect(display_name).to eq('A State')
+      end
+    end
   end
 
   it 'should set the options and expose them as options' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.1.1
 platform: ruby
 authors:
 - Thorsten Boettger
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-01 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -232,10 +232,11 @@ files:
 - spec/database.rb
 - spec/database.yml
 - spec/en.yml
-- spec/en_deprecated_style.yml
 - spec/generators/active_record_generator_spec.rb
 - spec/generators/mongoid_generator_spec.rb
 - spec/generators/no_brainer_generator_spec.rb
+- spec/localizer_test_model_deprecated_style.yml
+- spec/localizer_test_model_new_style.yml
 - spec/models/active_record/active_record_callback.rb
 - spec/models/active_record/basic_active_record_two_state_machines_example.rb
 - spec/models/active_record/complex_active_record_example.rb
@@ -436,10 +437,11 @@ test_files:
 - spec/database.rb
 - spec/database.yml
 - spec/en.yml
-- spec/en_deprecated_style.yml
 - spec/generators/active_record_generator_spec.rb
 - spec/generators/mongoid_generator_spec.rb
 - spec/generators/no_brainer_generator_spec.rb
+- spec/localizer_test_model_deprecated_style.yml
+- spec/localizer_test_model_new_style.yml
 - spec/models/active_record/active_record_callback.rb
 - spec/models/active_record/basic_active_record_two_state_machines_example.rb
 - spec/models/active_record/complex_active_record_example.rb