aasm 4.5.2 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 497994639dac4183fdf996cafad384f308784855
-  data.tar.gz: 731e388e865ffb526e4cbb3c20443659aab8605a
+  metadata.gz: 5b8d8a7ce2210a49761c9f1c622393a1bc453452
+  data.tar.gz: 1239b8468c521eb11bdbfef04d58540a6d1e5b72
 SHA512:
-  metadata.gz: b3572795abc66917c392e8736afc6d8ea882b12f0fdfcb15cd8046ae0f1977e8dd01b2eeab5d2fcb7e659295c3f45b6aa438aa008c61c8707370be7b27b40e31
-  data.tar.gz: 42a4dc5b04c7a13e2a15e745a42b960a80cb4a90f4f62e1eb51c09b4493565314c85ae4aeeb1dd985fc85094706b440fc14ec11dbb7e7275c641e64309b7106d
+  metadata.gz: 7b8f2affa363cce45636f684c24e2f72d71cb0a5af4fce0303894a77eb9db7fb37f08442c4b4b1955d7aaae042225ec4b3e52b27ffafe5cbb0c765c15498cf65
+  data.tar.gz: d9769d7cfd98b28e98f8a79c9b0b823cabec8b721bf5bdfaaae3dac37ca2b6127c38b42d427ed2fd451a67987c2371e36f4b46df09e0b4042fb1abb2c44320cd

data/.gitignore

@@ -17,3 +17,4 @@ alto
 .rspec
 .bundle
 tags
+tmp

data/.travis.yml

@@ -17,7 +17,7 @@ rvm:
 services: mongodb
 
 gemfile:
-  - gemfiles/rails_3.2.gemfile
+  - gemfiles/rails_3.2_stable.gemfile
   - gemfiles/rails_4.0.gemfile
   - gemfiles/rails_4.0_mongo_mapper.gemfile
   - gemfiles/rails_4.1.gemfile

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 4.6.0
+
+ * fix: make sure the column is actually present for _ActiveRecord_ enums (see [issue #265](https://github.com/aasm/aasm/issues/265) and [issue #152](https://github.com/aasm/aasm/issues/152) for details, thanks to [@anilmaurya](https://github.com/anilmaurya))
+* add generators to configure active_record and mongoid after install (see [issue #261](https://github.com/aasm/aasm/issues/261) for details, thanks to [@anilmaurya](https://github.com/anilmaurya))
+
 ## 4.5.2
 
  * fix arity difference between Procs and lambdas (see [issue #293](https://github.com/aasm/aasm/issues/293) for details)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2015 Scott Barron
+Copyright (c) 2006-2016 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

@@ -791,6 +791,17 @@ gem 'aasm'
 % sudo gem install pkg/aasm-x.y.z.gem
 ```
 
+### Generators
+
+After installing Aasm you can run generator:
+
+```sh
+% rails generate aasm NAME [COLUMN_NAME]
+```
+Replace NAME with the Model name, COLUMN_NAME is optional(default is 'aasm_state'). 
+This will create a model (if one does not exist) and configure it with aasm block.
+For Active record orm a migration file is added to add aasm state column to table.
+
 ## Latest changes ##
 
 Take a look at the [CHANGELOG](https://github.com/aasm/aasm/blob/master/CHANGELOG.md) for details about recent changes to the current version.
@@ -828,7 +839,7 @@ purpose.
 
 ## License ##
 
-Copyright (c) 2006-2015 Scott Barron
+Copyright (c) 2006-2016 Scott Barron
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/aasm.gemspec

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

data/gemfiles/{rails_3.2.gemfile → rails_3.2_stable.gemfile}

@@ -5,10 +5,11 @@ gem 'rubysl',                           :platforms => :rbx
 gem 'rubinius-developer_tools',         :platforms => :rbx
 gem "jruby-openssl",                    :platforms => :jruby
 gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
-gem "rails", "3.2.21"
+gem "rails", :github => "rails/rails",  :branch => "3-2-stable"
 gem 'mongoid', '~>3.1' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
 gem 'sequel'
 gem 'mongo_mapper', '~>0.13'
 gem 'bson_ext',                          :platforms => :ruby
+gem 'test-unit', '~> 3.0'
 
 gemspec :path => "../"

data/lib/aasm/persistence/active_record_persistence.rb

@@ -102,7 +102,10 @@ module AASM
         end
 
         def aasm_column_looks_like_enum(name=:default)
-          self.class.columns_hash[self.class.aasm(name).attribute_name.to_s].type == :integer
+          column_name = self.class.aasm(name).attribute_name.to_s
+          column = self.class.columns_hash[column_name]
+          raise NoMethodError.new("undefined method '#{column_name}' for #{self.class}") if column.nil?
+          column.type == :integer
         end
 
         def aasm_guess_enum_method(name=:default)

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.5.2"
+  VERSION = "4.6.0"
 end

data/lib/generators/aasm/aasm_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators/named_base'
+
+module AASM
+  module Generators
+    class AASMGenerator < Rails::Generators::NamedBase
+
+      source_root File.expand_path("../templates", __FILE__)
+      argument :column_name, type: :string, default: 'aasm_state'
+
+      desc "Generates a model with the given NAME (if one does not exist) with aasm " <<
+      "block and migration to add aasm_state column."
+
+      hook_for :orm
+
+    end
+  end
+end

data/lib/generators/aasm/orm_helpers.rb

@@ -0,0 +1,35 @@
+module AASM
+  module Generators
+    module OrmHelpers
+
+      def model_contents
+        if column_name == 'aasm_state'
+<<RUBY
+  include AASM
+
+  aasm do
+  end
+RUBY
+        else
+<<RUBY
+  include AASM
+
+  aasm :column => '#{column_name}' do
+  end
+RUBY
+        end
+      end
+
+      private
+
+      def model_exists?
+        File.exists?(File.join(destination_root, model_path))
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+
+    end
+  end
+end

data/lib/generators/active_record/aasm_generator.rb

@@ -0,0 +1,38 @@
+require 'rails/generators/active_record'
+require 'generators/aasm/orm_helpers'
+
+module ActiveRecord
+  module Generators
+    class AASMGenerator < ActiveRecord::Generators::Base
+      include AASM::Generators::OrmHelpers
+
+      argument :column_name, type: :string, default: 'aasm_state'
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_aasm_migration
+        if model_exists?
+          migration_template "migration_existing.rb", "db/migrate/add_aasm_state_to_#{table_name}.rb"
+        else
+          migration_template "migration.rb", "db/migrate/aasm_create_#{table_name}.rb"
+        end
+      end 
+
+      def generate_model
+        invoke "active_record:model", [name], migration: false unless model_exists?
+      end 
+
+      def inject_aasm_content
+        content = model_contents
+
+        class_path = if namespaced?
+                       class_name.to_s.split("::")
+                     else
+                       [class_name]
+                     end
+        inject_into_class(model_path, class_path.last, content) if model_exists?
+      end
+
+    end
+  end
+end

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,8 @@
+class AASMCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= table_name %>) do |t|
+      t.string :<%= column_name %>
+      t.timestamps null: false 
+    end
+  end
+end

data/lib/generators/active_record/templates/migration_existing.rb

@@ -0,0 +1,9 @@
+class AddAASMTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    add_column :<%= table_name %>, :<%= column_name %>, :string
+  end
+
+  def self.down
+    remove_column :<%= table_name %>, :<%= column_name %>
+  end
+end

data/lib/generators/mongoid/aasm_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators/named_base'
+require 'generators/aasm/orm_helpers'
+
+module Mongoid
+  module Generators
+    class AASMGenerator < Rails::Generators::NamedBase
+      include AASM::Generators::OrmHelpers
+
+      argument :column_name, type: :string, default: 'aasm_state'
+
+      def generate_model
+        invoke "mongoid:model", [name] unless model_exists?
+      end 
+
+      def inject_aasm_content
+        inject_into_file model_path, model_contents, after: "include Mongoid::Document\n" if model_exists?
+      end 
+
+      def inject_field_types
+        inject_into_file model_path, migration_data, after: "include Mongoid::Document\n" if model_exists?
+      end 
+
+      def migration_data
+        "  field :#{column_name}"
+      end
+    end
+  end
+end

data/spec/database.rb

@@ -1,5 +1,5 @@
 ActiveRecord::Migration.suppress_messages do
-  %w{gates multiple_gates readers writers transients simples no_scopes multiple_no_scopes no_direct_assignments multiple_no_direct_assignments thieves multiple_thieves localizer_test_models persisted_states provided_and_persisted_states with_enums with_true_enums with_false_enums false_states multiple_with_enums multiple_with_true_enums multiple_with_false_enums multiple_false_states readme_jobs}.each do |table_name|
+  %w{gates multiple_gates readers writers transients simples no_scopes multiple_no_scopes no_direct_assignments multiple_no_direct_assignments thieves multiple_thieves localizer_test_models persisted_states provided_and_persisted_states with_enums with_enum_without_columns multiple_with_enum_without_columns with_true_enums with_false_enums false_states multiple_with_enums multiple_with_true_enums multiple_with_false_enums multiple_false_states readme_jobs}.each do |table_name|
     ActiveRecord::Migration.create_table table_name, :force => true do |t|
       t.string "aasm_state"
     end

data/spec/generators/active_record_generator_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'generator_spec'
+require 'generators/active_record/aasm_generator'
+
+describe ActiveRecord::Generators::AASMGenerator, type: :generator do
+  destination File.expand_path("../../../tmp", __FILE__)
+
+  before(:all) do
+    prepare_destination
+  end
+
+  it "creates model with aasm block for default column_name" do
+    run_generator %w(user)
+    assert_file "app/models/user.rb", /include AASM\n\n  aasm do\n  end\n/
+  end
+
+  it "creates model with aasm block for custom column_name" do
+    run_generator %w(user state)
+    assert_file "app/models/user.rb", /aasm :column => 'state' do\n  end\n/
+  end
+
+  it "creates model with aasm block for namespaced model" do
+    run_generator %w(Admin::User state)
+    assert_file "app/models/admin/user.rb", /aasm :column => 'state' do\n  end\n/
+  end
+
+  it "creates migration for model with aasm_column" do
+    run_generator %w(post)
+    assert_migration "db/migrate/aasm_create_posts.rb", /create_table(:posts) do |t|\n  t.string :aasm_state\n/
+  end
+
+  it "add aasm_column in existing model" do
+    run_generator %w(job)
+    assert_file "app/models/job.rb"
+    run_generator %w(job)
+    assert_migration "db/migrate/add_aasm_state_to_jobs.rb"
+  end
+
+end

data/spec/generators/mongoid_generator_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'generator_spec'
+require 'generators/mongoid/aasm_generator'
+
+begin
+  require "mongoid"
+
+  describe Mongoid::Generators::AASMGenerator, type: :generator do
+    destination File.expand_path("../../../tmp", __FILE__)
+
+    before(:all) do
+      prepare_destination
+    end
+
+    it "creates model with aasm block for default column_name" do
+      run_generator %w(user)
+      assert_file "app/models/user.rb", /include AASM\n\n  aasm do\n  end\n/
+    end
+
+    it "creates model with aasm block for custom column_name" do
+      run_generator %w(user state)
+      assert_file "app/models/user.rb", /aasm :column => 'state' do\n  end\n/
+    end
+
+    it "creates model with aasm block for namespaced model" do
+      run_generator %w(Admin::User state)
+      assert_file "app/models/admin/user.rb", /aasm :column => 'state' do\n  end\n/
+    end
+
+  end
+rescue LoadError
+  puts "Not running Mongoid specs because mongoid gem is not installed!!!"
+end

data/spec/models/active_record/with_enum_without_column.rb

@@ -0,0 +1,38 @@
+class WithEnumWithoutColumn < ActiveRecord::Base
+  include AASM
+
+  if ActiveRecord::VERSION::MAJOR >= 4 && ActiveRecord::VERSION::MINOR >= 1 # won't work with Rails <= 4.1
+    enum status: {
+      opened: 0,
+      closed: 1
+    }
+  end
+
+  aasm :column => :status do
+    state :closed, initial: true
+    state :opened
+
+    event :view do
+      transitions :to => :opened, :from => :closed
+    end
+  end
+end
+
+class MultipleWithEnumWithoutColumn < ActiveRecord::Base
+  include AASM
+  if ActiveRecord::VERSION::MAJOR >= 4 && ActiveRecord::VERSION::MINOR >= 1 # won't work with Rails <= 4.1
+    enum status: {
+      opened: 0,
+      closed: 1
+    }
+  end
+
+  aasm :left, :column => :status do
+    state :closed, initial: true
+    state :opened
+
+    event :view do
+      transitions :to => :opened, :from => :closed
+    end
+  end
+end

data/spec/unit/persistence/active_record_persistence_multiple_spec.rb

@@ -113,6 +113,20 @@ describe "instance methods" do
         end
       end
     end
+
+    if ActiveRecord::VERSION::MAJOR >= 4 && ActiveRecord::VERSION::MINOR >= 1 # won't work with Rails <= 4.1
+      # Enum are introduced from Rails 4.1, therefore enum syntax will not work on Rails <= 4.1
+      context "when AASM enum setting is not enabled and aasm column not present" do
+
+        let(:multiple_with_enum_without_column) {MultipleWithEnumWithoutColumn.new}
+
+        it "should raise NoMethodError for transitions" do
+          expect{multiple_with_enum_without_column.send(:view, :left)}.to raise_error(NoMethodError, "undefined method 'status' for MultipleWithEnumWithoutColumn")
+        end
+      end
+
+    end
+
   end
 
   context "when AASM is configured to use enum" do

data/spec/unit/persistence/active_record_persistence_spec.rb

@@ -113,6 +113,20 @@ describe "instance methods" do
         end
       end
     end
+
+    if ActiveRecord::VERSION::MAJOR >= 4 && ActiveRecord::VERSION::MINOR >= 1 # won't work with Rails <= 4.1
+      # Enum are introduced from Rails 4.1, therefore enum syntax will not work on Rails <= 4.1
+      context "when AASM enum setting is not enabled and aasm column not present" do
+
+        let(:with_enum_without_column) {WithEnumWithoutColumn.new}
+
+        it "should raise NoMethodError for transitions" do
+          expect{with_enum_without_column.send(:view)}.to raise_error(NoMethodError, "undefined method 'status' for WithEnumWithoutColumn")
+        end
+      end
+
+    end
+
   end
 
   context "when AASM is configured to use enum" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 4.5.2
+  version: 4.6.0
 platform: ruby
 authors:
 - Scott Barron
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -54,6 +54,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -90,7 +104,7 @@ files:
 - Rakefile
 - aasm.gemspec
 - callbacks.txt
-- gemfiles/rails_3.2.gemfile
+- gemfiles/rails_3.2_stable.gemfile
 - gemfiles/rails_4.0.gemfile
 - gemfiles/rails_4.0_mongo_mapper.gemfile
 - gemfiles/rails_4.1.gemfile
@@ -123,10 +137,18 @@ files:
 - lib/aasm/rspec/transition_from.rb
 - lib/aasm/state_machine.rb
 - lib/aasm/version.rb
+- lib/generators/aasm/aasm_generator.rb
+- lib/generators/aasm/orm_helpers.rb
+- lib/generators/active_record/aasm_generator.rb
+- lib/generators/active_record/templates/migration.rb
+- lib/generators/active_record/templates/migration_existing.rb
+- lib/generators/mongoid/aasm_generator.rb
 - 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/models/active_record/basic_active_record_two_state_machines_example.rb
 - spec/models/active_record/complex_active_record_example.rb
 - spec/models/active_record/derivate_new_dsl.rb
@@ -143,6 +165,7 @@ files:
 - spec/models/active_record/thief.rb
 - spec/models/active_record/transient.rb
 - spec/models/active_record/with_enum.rb
+- spec/models/active_record/with_enum_without_column.rb
 - spec/models/active_record/with_false_enum.rb
 - spec/models/active_record/with_true_enum.rb
 - spec/models/active_record/writer.rb
@@ -265,6 +288,8 @@ test_files:
 - 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/models/active_record/basic_active_record_two_state_machines_example.rb
 - spec/models/active_record/complex_active_record_example.rb
 - spec/models/active_record/derivate_new_dsl.rb
@@ -281,6 +306,7 @@ test_files:
 - spec/models/active_record/thief.rb
 - spec/models/active_record/transient.rb
 - spec/models/active_record/with_enum.rb
+- spec/models/active_record/with_enum_without_column.rb
 - spec/models/active_record/with_false_enum.rb
 - spec/models/active_record/with_true_enum.rb
 - spec/models/active_record/writer.rb