aasm 4.1.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e85a2c10a3cf49a548193c9634548eb38eb1578b
-  data.tar.gz: 9b87e33663caa939dbf4eeefad57ea6ebde01fac
+  metadata.gz: cd80c470206244734a77fe540848e299e87dab9f
+  data.tar.gz: 28b464e9012345a46ddc5595d29541d52a358bf4
 SHA512:
-  metadata.gz: 1e2b255e2cae2cfae4a13c14ef8bd89f20c132ae5acf8260e68319f40646008304f05870e5cfbb2e4402b7cedc588552b777407c613b30f7e8b1787b9eac8faf
-  data.tar.gz: 41843dcb1cfa5c1147abea4420951ae3217349abd7a7918a1ef0014671218a520957c61d2d7f70ae5634514df5722466e83deb64549b463a5d3d51a323049da3
+  metadata.gz: 46d54cc3e2e66387916f7f1edfe03f3de9cb09578a8b485ea084bd68ba854f9003d1fd00de18a6d7c40984a0b0d2fe1b2d7bc4b3610e7d421c724e2f5af7a9f1
+  data.tar.gz: cb2506c237a22fc3dc04869791d15f85614ac33096ccff60fa5a6dd40830d2325375ed13cdc3abf2adc02c958a336362027393c6ee0351bc463cf47cb0b9020f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # CHANGELOG
 
-## 4.2.0 (not yet released)
+## 4.3.0 (not yet released)
+
+## 4.2.0
+
+ * support turning off and on the configuration option for `no_direct_assignment` (see [issue #223](https://github.com/aasm/aasm/issues/223) for details)
+ * event arguments are now passed to `:after_commit` callbacks as well (see [issue #238](https://github.com/aasm/aasm/pull/238), thanks to [@kuinak](https://github.com/kuinak))
 
 ## 4.1.1
 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -4,7 +4,7 @@ gem "sqlite3",                          :platforms => :ruby
 gem 'rubysl',                           :platforms => :rbx
 gem "jruby-openssl",                    :platforms => :jruby
 gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
-gem "rails", "~>4.1"
+gem "rails", "~>4.2"
 gem 'mongoid', '~>4.0' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
 gem 'sequel'
 # Since mongoid V4 requires incompatible bson V2, cannot have mongoid (V4 or greater)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2014 Scott Barron
+Copyright (c) 2006-2015 Scott Barron
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -679,6 +679,15 @@ Feel free to
 * [Thorsten Böttger](http://github.com/alto) (since 2011)
 
 
+## Contributing ##
+
+1. Read the [Contributor Code of Conduct](https://github.com/aasm/aasm/blob/master/CODE_OF_CONDUCT.md)
+2. Fork it
+3. Create your feature branch (git checkout -b my-new-feature)
+4. Commit your changes (git commit -am 'Added some feature')
+5. Push to the branch (git push origin my-new-feature)
+6. Create new Pull Request
+
 ## Warranty ##
 
 This software is provided "as is" and without any express or

data/aasm.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'sdoc'
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec', ">= 3"
 
   # debugging
   # s.add_development_dependency 'debugger'

data/lib/aasm/base.rb

@@ -27,11 +27,19 @@ module AASM
 
       configure :enum, nil
 
-      if @state_machine.config.no_direct_assignment
-        @klass.send(:define_method, "#{@state_machine.config.column}=") do |state_name|
-          raise AASM::NoDirectAssignmentError.new('direct assignment of AASM column has been disabled (see AASM configuration for this class)')
+      # make sure to raise an error if no_direct_assignment is enabled
+      # and attribute is directly assigned though
+      @klass.class_eval %Q(
+        def #{@state_machine.config.column}=(state_name)
+          if self.class.aasm.state_machine.config.no_direct_assignment
+            raise AASM::NoDirectAssignmentError.new(
+              'direct assignment of AASM column has been disabled (see AASM configuration for this class)'
+            )
+          else
+            super
+          end
         end
-      end
+      )
     end
 
     # This method is both a getter and a setter

data/lib/aasm/persistence/active_record_persistence.rb

@@ -176,7 +176,7 @@ module AASM
 
           if success && options[:persist]
             event = self.class.aasm.state_machine.events[name]
-            event.fire_callbacks(:after_commit, self)
+            event.fire_callbacks(:after_commit, self, *args)
           end
 
           success

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.1.1"
+  VERSION = "4.2.0"
 end

data/spec/models/active_record/derivate_new_dsl.rb

@@ -0,0 +1,3 @@
+require_relative 'simple_new_dsl'
+class DerivateNewDsl < SimpleNewDsl
+end

data/spec/models/active_record/false_state.rb

@@ -0,0 +1,17 @@
+class FalseState < ActiveRecord::Base
+  include AASM
+
+  def initialize(*args)
+    super
+    self.aasm_state = false
+  end
+
+  aasm do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end

data/spec/models/active_record/gate.rb

@@ -0,0 +1,19 @@
+class Gate < ActiveRecord::Base
+  include AASM
+
+  # Fake this column for testing purposes
+  # attr_accessor :aasm_state
+
+  def value
+    'value'
+  end
+
+  aasm do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end

data/spec/models/active_record/localizer_test_model.rb

@@ -0,0 +1,34 @@
+class LocalizerTestModel < ActiveRecord::Base
+  include AASM
+
+  aasm do
+    state :opened, :initial => true
+    state :closed
+    event :close
+    event :open
+  end
+end
+
+describe 'localized state names' do
+  before(:all) do
+    I18n.load_path << 'spec/en.yml'
+    I18n.default_locale = :en
+    I18n.reload!
+  end
+
+  after(:all) do
+    I18n.load_path.clear
+  end
+
+  it 'should localize' do
+    state = LocalizerTestModel.aasm.states.detect {|s| s == :opened}
+    expect(state.localized_name).to eq("It's open now!")
+    expect(state.human_name).to eq("It's open now!")
+  end
+
+  it 'should use fallback' do
+    state = LocalizerTestModel.aasm.states.detect {|s| s == :closed}
+    expect(state.localized_name).to eq('Closed')
+    expect(state.human_name).to eq('Closed')
+  end
+end

data/spec/models/active_record/no_direct_assignment.rb

@@ -0,0 +1,10 @@
+class NoDirectAssignment < ActiveRecord::Base
+  include AASM
+  aasm :no_direct_assignment => true do
+    state :pending, :initial => true
+    state :running
+    event :run do
+      transitions :from => :pending, :to => :running
+    end
+  end
+end

data/spec/models/active_record/no_scope.rb

@@ -0,0 +1,10 @@
+class NoScope < ActiveRecord::Base
+  include AASM
+  aasm :create_scopes => false do
+    state :pending, :initial => true
+    state :running
+    event :run do
+      transitions :from => :pending, :to => :running
+    end
+  end
+end

data/spec/models/active_record/persisted_state.rb

@@ -0,0 +1,12 @@
+class PersistedState < ActiveRecord::Base
+  attr_accessor :transient_store, :persisted_store
+  include AASM
+  aasm do
+    state :alpha, :initial => true
+    state :beta
+    state :gamma
+    event :release do
+      transitions :from => [:alpha, :beta, :gamma], :to => :beta
+    end
+  end
+end

data/spec/models/active_record/provided_and_persisted_state.rb

@@ -0,0 +1,24 @@
+class ProvidedAndPersistedState < ActiveRecord::Base
+  attr_accessor :transient_store, :persisted_store
+  include AASM
+  aasm do
+    state :alpha, :initial => true
+    state :beta
+    state :gamma
+    event :release do
+      transitions :from => [:alpha, :beta, :gamma], :to => :beta
+    end
+  end
+
+  def aasm_read_state
+    :gamma
+  end
+
+  def aasm_write_state(new_state)
+    @persisted_store = new_state
+  end
+
+  def aasm_write_state_without_persistence(new_state)
+    @transient_store = new_state
+  end
+end

data/spec/models/active_record/reader.rb

@@ -0,0 +1,7 @@
+class Reader < ActiveRecord::Base
+  include AASM
+
+  def aasm_read_state
+    "fi"
+  end
+end

data/spec/models/active_record/simple_new_dsl.rb

@@ -0,0 +1,8 @@
+class SimpleNewDsl < ActiveRecord::Base
+  include AASM
+  aasm :column => :status
+  aasm do
+    state :unknown_scope
+    state :new
+  end
+end

data/spec/models/active_record/thief.rb

@@ -0,0 +1,14 @@
+class Thief < ActiveRecord::Base
+  if ActiveRecord::VERSION::MAJOR >= 3
+    self.table_name = 'thieves'
+  else
+    set_table_name "thieves"
+  end
+  include AASM
+  aasm do
+    state :rich
+    state :jailed
+    initial_state Proc.new {|thief| thief.skilled ? :rich : :jailed }
+  end
+  attr_accessor :skilled, :aasm_state
+end

data/spec/models/active_record/transient.rb

@@ -0,0 +1,6 @@
+class Transient < ActiveRecord::Base
+  def aasm_write_state_without_persistence(state)
+    "fum"
+  end
+  include AASM
+end

data/spec/models/active_record/with_enum.rb

@@ -0,0 +1,19 @@
+class WithEnum < ActiveRecord::Base
+  include AASM
+
+  # Fake this column for testing purposes
+  attr_accessor :aasm_state
+
+  def self.test
+    {}
+  end
+
+  aasm :enum => :test do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end

data/spec/models/active_record/with_false_enum.rb

@@ -0,0 +1,15 @@
+class WithFalseEnum < ActiveRecord::Base
+  include AASM
+
+  # Fake this column for testing purposes
+  attr_accessor :aasm_state
+
+  aasm :enum => false do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end

data/spec/models/active_record/with_true_enum.rb

@@ -0,0 +1,19 @@
+class WithTrueEnum < ActiveRecord::Base
+  include AASM
+
+  # Fake this column for testing purposes
+  attr_accessor :aasm_state
+
+  def value
+    'value'
+  end
+
+  aasm :enum => true do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end

data/spec/models/active_record/writer.rb

@@ -0,0 +1,6 @@
+class Writer < ActiveRecord::Base
+  def aasm_write_state(state)
+    "fo"
+  end
+  include AASM
+end

data/spec/models/{auth_machine.rb → complex_example.rb}

@@ -1,4 +1,4 @@
-class AuthMachine
+class ComplexExample
   include AASM
 
   attr_accessor :activation_code, :activated_at, :deleted_at

data/spec/models/default_state.rb

@@ -0,0 +1,12 @@
+class DefaultState
+  attr_accessor :transient_store, :persisted_store
+  include AASM
+  aasm do
+    state :alpha, :initial => true
+    state :beta
+    state :gamma
+    event :release do
+      transitions :from => [:alpha, :beta, :gamma], :to => :beta
+    end
+  end
+end

data/spec/models/initial_state_proc.rb

@@ -0,0 +1,15 @@
+class InitialStateProc
+  RICH = 1_000_000
+
+  attr_accessor :balance
+
+  include AASM
+  aasm do
+    state :retired
+    state :selling_bad_mortgages
+    initial_state Proc.new { |banker| banker.rich? ? :retired : :selling_bad_mortgages }
+  end
+
+  def initialize(balance = 0); self.balance = balance; end
+  def rich?; self.balance >= RICH; end
+end

data/spec/models/{bar.rb → no_initial_state.rb}

@@ -1,4 +1,4 @@
-class Bar
+class NoInitialState
   include AASM
 
   aasm do
@@ -10,6 +10,3 @@ class Bar
     end
   end
 end
-
-class Baz < Bar
-end

data/spec/models/provided_state.rb

@@ -0,0 +1,24 @@
+class ProvidedState
+  attr_accessor :transient_store, :persisted_store
+  include AASM
+  aasm do
+    state :alpha, :initial => true
+    state :beta
+    state :gamma
+    event :release do
+      transitions :from => [:alpha, :beta, :gamma], :to => :beta
+    end
+  end
+
+  def aasm_read_state
+    :beta
+  end
+
+  def aasm_write_state(new_state)
+    @persisted_store = new_state
+  end
+
+  def aasm_write_state_without_persistence(new_state)
+    @transient_store = new_state
+  end
+end