aasm 3.0.6 → 3.0.7

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 3.0.7
+
+ * removed deprecation warning when localizing aasm state names (look at https://github.com/rubyist/aasm/issues/38 for details)
+
 ## 3.0.6
 
  * bugfix: if configured to skip validation the code does not validate anymore

data/aasm.gemspec

@@ -11,8 +11,9 @@ Gem::Specification.new do |s|
   s.summary     = %q{State machine mixin for Ruby objects}
   s.description = %q{AASM is a continuation of the acts as state machine rails plugin, built for plain Ruby objects.}
   s.date        = Time.now
+  s.licenses    = ["MIT"]
 
-  s.add_dependency             'activerecord'
+  s.add_development_dependency 'activerecord'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'sdoc'
   s.add_development_dependency 'rspec', '~> 2.0'

data/lib/aasm/supporting_classes/localizer.rb

@@ -2,20 +2,35 @@ module AASM
   module SupportingClasses
     class Localizer
       def human_event_name(klass, event)
-        defaults = ancestors_list(klass).map do |ancestor|
-          :"#{i18n_scope(klass)}.events.#{i18n_klass(ancestor)}.#{event}"
-        end << event.to_s.humanize
-
-        I18n.translate(defaults.shift, :default => defaults, :raise => true)
+        checklist = ancestors_list(klass).inject([]) do |list, ancestor|
+          list << :"#{i18n_scope(klass)}.events.#{i18n_klass(ancestor)}.#{event}"
+          list
+        end
+        (0...(checklist.size-1)).each do |i|
+          begin
+            return I18n.translate(checklist.shift, :raise => true)
+          rescue I18n::MissingTranslationData
+            # that's okay
+          end
+        end
+        I18n.translate(checklist.shift, :default => event.to_s.humanize)
       end
 
       def human_state(obj)
         klass = obj.class
-        defaults = ancestors_list(klass).map do |ancestor|
-          :"#{i18n_scope(klass)}.attributes.#{i18n_klass(ancestor)}.#{klass.aasm_column}.#{obj.aasm_current_state}"
-        end << obj.aasm_current_state.to_s.humanize
-
-        I18n.translate(defaults.shift, :default => defaults, :raise => true)
+        checklist = ancestors_list(klass).inject([]) do |list, ancestor|
+          list << :"#{i18n_scope(klass)}.attributes.#{i18n_klass(ancestor)}.#{klass.aasm_column}/#{obj.aasm_current_state}"
+          list << :"#{i18n_scope(klass)}.attributes.#{i18n_klass(ancestor)}.#{klass.aasm_column}.#{obj.aasm_current_state}"
+          list
+        end
+        (0...(checklist.size-1)).each do |i|
+          begin
+            return I18n.translate(checklist.shift, :raise => true)
+          rescue I18n::MissingTranslationData
+            # that's okay
+          end
+        end
+        I18n.translate(checklist.shift, :default => obj.aasm_current_state.to_s.humanize)
       end
 
       private

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "3.0.6"
+  VERSION = "3.0.7"
 end

data/spec/en.yml

@@ -6,5 +6,4 @@ en:
 
     attributes:
       localizer_test_model:
-        aasm_state:
-          open: "It's opened now!"
+        aasm_state/open: "It's opened now!"

data/spec/en_deprecated_style.yml

@@ -0,0 +1,10 @@
+en:
+  activerecord:
+    events:
+      localizer_test_model:
+        close: "Let's close it!"
+
+    attributes:
+      localizer_test_model:
+        aasm_state:
+          open: "It's opened now!"

data/spec/unit/active_record_persistence_spec.rb

@@ -4,7 +4,8 @@ require 'logger'
 
 load_schema
 
-ActiveRecord::Base.logger = Logger.new(STDERR)
+# if you want to see the statements while running the spec enable the following line
+# ActiveRecord::Base.logger = Logger.new(STDERR)
 
 class Gate < ActiveRecord::Base
   include AASM

data/spec/unit/localizer_spec.rb

@@ -3,8 +3,6 @@ require 'active_record'
 require 'logger'
 require 'i18n'
 
-ActiveRecord::Base.logger = Logger.new(STDERR)
-
 class LocalizerTestModel < ActiveRecord::Base
   include AASM
 
@@ -18,7 +16,7 @@ class LocalizerTestModel < ActiveRecord::Base
   aasm_event :open
 end
 
-describe AASM::SupportingClasses::Localizer do
+describe AASM::SupportingClasses::Localizer, "new style" do
   before(:all) do
     I18n.load_path << 'spec/en.yml'
     I18n.default_locale = :en
@@ -52,3 +50,38 @@ describe AASM::SupportingClasses::Localizer do
     end
   end
 end
+
+describe AASM::SupportingClasses::Localizer, "deprecated style" do
+  before(:all) do
+    I18n.load_path << 'spec/en_deprecated_style.yml'
+    I18n.default_locale = :en
+    I18n.reload!
+  end
+
+  after(:all) do
+    I18n.load_path.clear
+  end
+
+  let (:foo_opened) { LocalizerTestModel.new }
+  let (:foo_closed) { LocalizerTestModel.new.tap { |x| x.aasm_state = :closed  } }
+
+  context 'aasm_human_state' do
+    it 'should return translated state value' do
+      foo_opened.aasm_human_state.should == "It's opened now!"
+    end
+
+    it 'should return humanized value if not localized' do
+      foo_closed.aasm_human_state.should == "Closed"
+    end
+  end
+
+  context 'aasm_human_event_name' do
+    it 'should return translated event name' do
+      LocalizerTestModel.aasm_human_event_name(:close).should == "Let's close it!"
+    end
+
+    it 'should return humanized event name' do
+      LocalizerTestModel.aasm_human_event_name(:open).should == "Open"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -12,22 +12,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-17 00:00:00.000000000 Z
+date: 2012-06-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70346607015720 !ruby/object:Gem::Requirement
+  requirement: &70261929166680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: *70346607015720
+  version_requirements: *70261929166680
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70346607015180 !ruby/object:Gem::Requirement
+  requirement: &70261929166260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70346607015180
+  version_requirements: *70261929166260
 - !ruby/object:Gem::Dependency
   name: sdoc
-  requirement: &70346607014640 !ruby/object:Gem::Requirement
+  requirement: &70261929165840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +46,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70346607014640
+  version_requirements: *70261929165840
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70346607013980 !ruby/object:Gem::Requirement
+  requirement: &70261929165340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -57,10 +57,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70346607013980
+  version_requirements: *70261929165340
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70346607013560 !ruby/object:Gem::Requirement
+  requirement: &70261929164920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -68,10 +68,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70346607013560
+  version_requirements: *70261929164920
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70346607013000 !ruby/object:Gem::Requirement
+  requirement: &70261929195940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,10 +79,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70346607013000
+  version_requirements: *70261929195940
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70346607012380 !ruby/object:Gem::Requirement
+  requirement: &70261929195520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -90,10 +90,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70346607012380
+  version_requirements: *70261929195520
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70346607011840 !ruby/object:Gem::Requirement
+  requirement: &70261929195100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,10 +101,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70346607011840
+  version_requirements: *70261929195100
 - !ruby/object:Gem::Dependency
   name: ruby-debug-completion
-  requirement: &70346607011340 !ruby/object:Gem::Requirement
+  requirement: &70261929194680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -112,7 +112,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70346607011340
+  version_requirements: *70261929194680
 description: AASM is a continuation of the acts as state machine rails plugin, built
   for plain Ruby objects.
 email: scott@elitists.net, ttilley@gmail.com
@@ -144,6 +144,7 @@ files:
 - lib/aasm/version.rb
 - spec/database.yml
 - spec/en.yml
+- spec/en_deprecated_style.yml
 - spec/models/conversation.rb
 - spec/models/invalid_persistor.rb
 - spec/models/not_auto_loaded/process.rb
@@ -166,7 +167,8 @@ files:
 - spec/unit/state_spec.rb
 - spec/unit/state_transition_spec.rb
 homepage: http://rubyist.github.com/aasm/
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -185,13 +187,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: State machine mixin for Ruby objects
 test_files:
 - spec/database.yml
 - spec/en.yml
+- spec/en_deprecated_style.yml
 - spec/models/conversation.rb
 - spec/models/invalid_persistor.rb
 - spec/models/not_auto_loaded/process.rb