Merge branch 'release/2.6.4'

Author: cuong-now

CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+== 2.6.4
+* Skip "models/concerns", #194
+* Fix #173 where annotate says "Nothing to annotate" in rails 4.2
+* Display an error message if not run from the root of the project, #186
+* Support rails 4.0 new default test directory, #182
+* Add an option to show timestamp in routes "-timestamp", #136
+* Skip plain ruby objects if they have the same class name as an ActiveRecord object, #121
+
 == 2.6.3
 * Fix bug of annotate position in routes (#158)
 

Gemfile

@@ -13,6 +13,8 @@ end
 
 group :development, :test do
   gem 'rspec', :require => false
+  gem 'guard-rspec', require: false
+
   platforms :mri do
     gem 'pry', :require => false
     gem 'pry-coolline', :require => false

Guardfile

@@ -0,0 +1,46 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

README.rdoc

@@ -54,7 +54,7 @@ Into Gemfile from rubygems.org:
 
 Into Gemfile from Github:
 
-    gem 'annotate', :git => 'git://github.com/ctran/annotate_models.git'
+    gem 'annotate', github: 'ctran/annotate_models'
 
 Into environment gems from rubygems.org:
 
@@ -179,6 +179,7 @@ you can do so with a simple environment variable, instead of editing the
             --format
             --force                      Force new annotations even if there are no changes.
             --trace                      If unable to annotate a file, print the full stack trace, not just the exception message.
+        --timestamp                      Include an updated time in routes.rb
 
 
 == Sorting

annotate.gemspec

@@ -1,9 +1,11 @@
 # -*- encoding: utf-8 -*-
-# stub: annotate 2.6.3 ruby lib
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'annotate/version'
 
 Gem::Specification.new do |s|
   s.name = "annotate"
-  s.version = "2.6.3"
+  s.version = Annotate.version
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cuong Tran", "Alex Chaffee", "Marcos Piccinini", "Turadg Aleahmad", "Jon Frisby"]

bin/annotate

@@ -1,4 +1,9 @@
 #!/usr/bin/env ruby
+
+unless File.exists?('./Rakefile') || File.exists?('./Gemfile')
+  abort "Please run annotate from the root of the project."
+end
+
 require 'rubygems'
 begin
   require 'bundler'
@@ -132,6 +137,10 @@ OptionParser.new do |opts|
     ENV['force'] = 'yes'
   end
 
+  opts.on('--timestamp', 'Include timestamp in (routes) annotation') do
+    ENV['timestamp'] = 'true'
+  end
+
   opts.on('--trace', 'If unable to annotate a file, print the full stack trace, not just the exception message.') do |value|
     ENV['trace'] = 'yes'
   end
@@ -142,7 +151,6 @@ OptionParser.new do |opts|
 
 end.parse!
 
-
-options=Annotate.setup_options({ :is_rake => !ENV['is_rake'].blank? })
+options = Annotate.setup_options({ :is_rake => ENV['is_rake'] && !ENV['is_rake'].empty? })
 Annotate.eager_load(options)
 target[:klass].send(target[:task], options)

lib/annotate.rb

@@ -22,7 +22,7 @@ module Annotate
   FLAG_OPTIONS=[
     :show_indexes, :simple_indexes, :include_version, :exclude_tests,
     :exclude_fixtures, :exclude_factories, :ignore_model_sub_dir,
-    :format_bare, :format_rdoc, :format_markdown, :sort, :force, :trace,
+    :format_bare, :format_rdoc, :format_markdown, :sort, :force, :trace, :timestamp
   ]
   OTHER_OPTIONS=[
     :model_dir, :ignore_columns

lib/annotate/annotate_models.rb

@@ -10,6 +10,7 @@ module AnnotateModels
   # File.join for windows reverse bar compat?
   # I dont use windows, can`t test
   UNIT_TEST_DIR         = File.join("test", "unit")
+  MODEL_TEST_DIR        = File.join("test", "models") # since rails 4.0
   SPEC_MODEL_DIR        = File.join("spec", "models")
   FIXTURE_TEST_DIR      = File.join("test", "fixtures")
   FIXTURE_SPEC_DIR      = File.join("spec", "fixtures")
@@ -32,6 +33,7 @@ module AnnotateModels
 
   TEST_PATTERNS = [
     File.join(UNIT_TEST_DIR,  "%MODEL_NAME%_test.rb"),
+    File.join(MODEL_TEST_DIR,  "%MODEL_NAME%_test.rb"),
     File.join(SPEC_MODEL_DIR, "%MODEL_NAME%_spec.rb"),
   ]
 
@@ -121,7 +123,7 @@ def get_schema_info(klass, header, options = {})
         col_type = (col.type || col.sql_type).to_s
         if col_type == "decimal"
           col_type << "(#{col.precision}, #{col.scale})"
-				elsif col_type != "spatial"
+        elsif col_type != "spatial"
           if (col.limit)
             if col.limit.is_a? Array
               attrs << "(#{col.limit.join(', ')})"
@@ -140,7 +142,7 @@ def get_schema_info(klass, header, options = {})
         # and print the type and SRID
         if col.respond_to?(:geometry_type)
           attrs << "#{col.geometry_type}, #{col.srid}"
-				elsif col.respond_to?(:geometric_type) and col.geometric_type.present?
+        elsif col.respond_to?(:geometric_type) and col.geometric_type.present?
           attrs << "#{col.geometric_type.to_s.downcase}, #{col.srid}"
         end
 
@@ -222,7 +224,7 @@ def annotate_one_file(file_name, info_block, position, options={})
         old_header = old_content.match(header_pattern).to_s
         new_header = info_block.match(header_pattern).to_s
 
-        column_pattern = /^#[\t ]+\w+[\t ]+.+$/
+        column_pattern = /^#[\t ]+[\w\*`]+[\t ]+.+$/
         old_columns = old_header && old_header.scan(column_pattern).sort
         new_columns = new_header && new_header.scan(column_pattern).sort
 
@@ -235,10 +237,10 @@ def annotate_one_file(file_name, info_block, position, options={})
           # Replace inline the old schema info with the new schema info
           new_content = old_content.sub(PATTERN, info_block + "\n")
 
-          if new_content.end_with? (info_block + "\n")
+          if new_content.end_with?(info_block + "\n")
             new_content = old_content.sub(PATTERN, "\n" + info_block)
           end
-           
+
           # if there *was* no old schema info (no substitution happened) or :force was passed,
           # we simply need to insert it in correct position
           if new_content == old_content || options[:force]
@@ -352,7 +354,7 @@ def get_model_files(options)
             models = if options[:ignore_model_sub_dir]
               Dir["*.rb"]
             else
-              Dir["**/*.rb"]
+              Dir["**/*.rb"].reject{ |f| f["concerns/"] }
             end
           end
         rescue SystemCallError
@@ -369,21 +371,36 @@ def get_model_files(options)
     # Check for namespaced models in subdirectories as well as models
     # in subdirectories without namespacing.
     def get_model_class(file)
-      # this is for non-rails projects, which don't get Rails auto-require magic
-      require File.expand_path("#{model_dir}/#{file}")
       model_path = file.gsub(/\.rb$/, '')
-      get_loaded_model(model_path) || get_loaded_model(model_path.split('/').last)
+      begin
+        get_loaded_model(model_path) or raise LoadError.new("cannot load a model from #{file}")
+      rescue LoadError
+        # this is for non-rails projects, which don't get Rails auto-require magic
+        if Kernel.require(File.expand_path("#{model_dir}/#{model_path}"))
+          retry
+        elsif model_path.match(/\//)
+          model_path = model_path.split('/')[1..-1].join('/').to_s
+          retry
+        else
+          raise
+        end
+      end
     end
 
     # Retrieve loaded model class by path to the file where it's supposed to be defined.
     def get_loaded_model(model_path)
-      ObjectSpace.each_object(::Class).
-        select do |c|
-          Class === c and    # note: we use === to avoid a bug in activesupport 2.3.14 OptionMerger vs. is_a?
-          c.ancestors.respond_to?(:include?) and  # to fix FactoryGirl bug, see https://github.com/ctran/annotate_models/pull/82
-          c.ancestors.include?(ActiveRecord::Base)
-        end.
-        detect { |c| ActiveSupport::Inflector.underscore(c) == model_path }
+      begin
+        ActiveSupport::Inflector.constantize(ActiveSupport::Inflector.camelize(model_path))
+      rescue
+        # Revert to the old way but it is not really robust
+        ObjectSpace.each_object(::Class).
+          select do |c|
+            Class === c and    # note: we use === to avoid a bug in activesupport 2.3.14 OptionMerger vs. is_a?
+            c.ancestors.respond_to?(:include?) and  # to fix FactoryGirl bug, see https://github.com/ctran/annotate_models/pull/82
+            c.ancestors.include?(ActiveRecord::Base)
+          end.
+          detect { |c| ActiveSupport::Inflector.underscore(c.to_s) == model_path }
+      end
     end
 
     # We're passed a name of things that might be
@@ -428,7 +445,6 @@ def annotate_model_file(annotated, file, header, options)
     end
 
     def remove_annotations(options={})
-
       self.model_dir = options[:model_dir] if options[:model_dir]
       deannotated = []
       deannotated_klass = false

lib/annotate/annotate_routes.rb

@@ -33,7 +33,7 @@ def self.do_annotations(options={})
     routes_map.shift if(routes_map.first =~ /^\(in \//)
 
     header = [
-      "#{PREFIX} (Updated #{Time.now.strftime("%Y-%m-%d %H:%M")})",
+      "#{PREFIX}" + (options[:timestamp] ? " (Updated #{Time.now.strftime("%Y-%m-%d %H:%M")})" : ""),
       "#"
     ] + routes_map.map { |line| "# #{line}".rstrip }
 

lib/annotate/version.rb

@@ -1,5 +1,5 @@
 module Annotate
   def self.version
-    '2.6.3'
+    '2.6.4'
   end
 end

lib/generators/annotate/templates/auto_annotate_models.rake

@@ -1,7 +1,7 @@
 # NOTE: only doing this in development as some production environments (Heroku)
 # NOTE: are sensitive to local FS writes, and besides -- it's just not proper
 # NOTE: to have a dev-mode tool do its thing in production.
-if(Rails.env.development?)
+if Rails.env.development?
   task :set_annotation_options do
     # You can override any of these by setting an environment variable of the
     # same name.