annotate 2.6.3 → 2.6.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjA3ODY1MmI2NTJiOGRjYzlhYmVmYzY5OTk1OTI2ZDBmNWI4OWVkOA==
+    OWJjZmE2N2E0NDFhOGU5MmFjZGJlZjZmNTg4YjI4MWZmYjhlZDUxNw==
   data.tar.gz: !binary |-
-    NTkwZTZmN2NkOTlmYzYwYThkODRhNzU0ZjczYzI4MzcyOTYxNzUwYw==
+    ZDViMWZlYjVlZWMxN2IzMjM2NWFlYmJmYTc2NGEyY2FlYmIyOWYxNQ==
 SHA512:
   metadata.gz: !binary |-
-    MTRkNmFkYzVhZWM1NWZjOGE0Y2YwZDk4NzAzZWE0OWE2NGJhNzgyZWJhOWQ1
-    MWYyZTgyNzMxMjJmYWExZDM5NjJkZmIxYTVlOWIzNzYzNzFjMmY1ZDhjMWVk
-    YWEzYzQ3M2Q3MWI0ZTAyNDczMzhmYWFiMDc5MWY2NTY3NWY4ZjQ=
+    NDBlMTlmZTczYjk0YjUxYzg1ZTljOWE3YmE1MjYxOGNhZjhmOGNlZWZhMDlh
+    N2EzNDRjMjcwZWRiYzk4ZmFlM2U5OGQ1ZDJlNTQ2YmM0ZTQwZDg5NzdmMDMx
+    NTU4NjM2OWY1ZmI3OTk3MTc2MTVkMTE4ZDNiMTJkZTk5NzA5M2I=
   data.tar.gz: !binary |-
-    MDg5YTI3ZDY4MWMzYzRhYTg5MzE4YjNkM2E3Mjc4OGQxZTRiNTIxY2E2NTAy
-    MWNiM2U4ZGRlODMwODljNjA3YTc1MWE4ODEyMDhlNzYyMzZmOWU5MjI4ZDQ4
-    YzMyZWFiYTA1ZmU4MTNhYjg5MmJhMmU4NTIwZmZiMzE4YmM4MzQ=
+    YzIzY2ZmNDA1YWEzYTVlZDY0ZDg4MDg3YThhYjBiYTQ1MjQ4ZTQwYzY2Mjc1
+    YmRjNjMxMTUwMDQ2OTIzZmFmNWI1ODM2Mzk5MjYwYmY2OWIzZTk0YmM5ODll
+    MDlmNTEwYjk2M2E1ZGZjOTUzZDE2ODJhYTQ1N2JlYzBjZTU4M2I=

data/CHANGELOG.rdoc

@@ -1,3 +1,14 @@
+== 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)
+
 == 2.6.2
 * Retain the current annotate block unless --force is specified
 * Always load models, since they may not be autoloaded by Rails

data/README.rdoc

@@ -1,7 +1,8 @@
 == Annotate (aka AnnotateModels)
 
-IMPORTANT:  If you're upgrading from a previous version, including 2.5.0,
-re-run the generator task!
+{<img src="https://badge.fury.io/rb/annotate.svg" alt="Gem Version" />}[http://badge.fury.io/rb/annotate]
+{<img src="https://travis-ci.org/ctran/annotate_models.png" />}[https://travis-ci.org/ctran/annotate_models]
+{<img src="https://gemnasium.com/ctran/annotate_models.png" />}[https://gemnasium.com/ctran/annotate_models]
 
 Add a comment summarizing the current schema to the top or bottom of each of
 your...
@@ -54,7 +55,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 +180,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
@@ -236,11 +238,6 @@ extra carefully, and consider using one.
 
 Released under the same license as Ruby. No Support. No Warranty.
 
-== Code Status
-{<img src="https://travis-ci.org/ctran/annotate_models.png" />}[https://travis-ci.org/ctran/annotate_models]
-{<img src="https://gemnasium.com/ctran/annotate_models.png" />}[https://gemnasium.com/ctran/annotate_models]
-
-
 == Authors
 
 {See AUTHORS.rdoc}[link:AUTHORS.rdoc].

data/annotate.gemspec

@@ -1,25 +1,25 @@
-# This file is auto-generated!
-# DO NOT EDIT THIS FILE DIRECTLY!
-# Instead, edit the Rakefile and run 'rake gems:gemspec'.# -*- encoding: utf-8 -*-
-# stub: annotate 2.6.3 ruby lib
+# -*- encoding: utf-8 -*-
+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.require_paths = ["lib"]
-  s.authors = ["Alex Chaffee", "Cuong Tran", "Marcos Piccinini", "Turadg Aleahmad", "Jon Frisby"]
-  s.date = "2014-04-05"
+  s.authors = ["Cuong Tran", "Alex Chaffee", "Marcos Piccinini", "Turadg Aleahmad", "Jon Frisby"]
+  s.date = "2014-06-16"
   s.description = "Annotates Rails/ActiveRecord Models, routes, fixtures, and others based on the database schema."
-  s.email = ["alex@stinky.com", "cuong@gmail.com", "x@nofxx.com", "turadg@aleahmad.net", "jon@cloudability.com"]
+  s.email = ["alex@stinky.com", "cuong.tran@gmail.com", "x@nofxx.com", "turadg@aleahmad.net", "jon@cloudability.com"]
   s.executables = ["annotate"]
   s.extra_rdoc_files = ["README.rdoc", "CHANGELOG.rdoc", "TODO.rdoc"]
-  s.files = [".travis.yml", "AUTHORS.rdoc", "CHANGELOG.rdoc", "LICENSE.txt", "README.rdoc", "TODO.rdoc", "annotate.gemspec", "bin/annotate", "lib/annotate.rb", "lib/annotate/active_record_patch.rb", "lib/annotate/annotate_models.rb", "lib/annotate/annotate_routes.rb", "lib/annotate/tasks.rb", "lib/annotate/version.rb", "lib/generators/annotate/USAGE", "lib/generators/annotate/install_generator.rb", "lib/generators/annotate/templates/auto_annotate_models.rake", "lib/tasks/annotate_models.rake", "lib/tasks/annotate_routes.rake", "lib/tasks/migrate.rake"]
+  s.files = ["AUTHORS.rdoc", "CHANGELOG.rdoc", "LICENSE.txt", "README.rdoc", "TODO.rdoc", "annotate.gemspec", "bin/annotate", "lib/annotate.rb", "lib/annotate/active_record_patch.rb", "lib/annotate/annotate_models.rb", "lib/annotate/annotate_routes.rb", "lib/annotate/tasks.rb", "lib/annotate/version.rb", "lib/generators/annotate/USAGE", "lib/generators/annotate/install_generator.rb", "lib/generators/annotate/templates/auto_annotate_models.rake", "lib/tasks/annotate_models.rake", "lib/tasks/annotate_routes.rake", "lib/tasks/migrate.rake"]
   s.homepage = "http://github.com/ctran/annotate_models"
   s.licenses = ["Ruby"]
+  s.require_paths = ["lib"]
   s.rubyforge_project = "annotate"
-  s.rubygems_version = "2.2.2"
+  s.rubygems_version = "2.1.11"
   s.summary = "Annotates Rails Models, routes, fixtures, and others based on the database schema."
 
   if s.respond_to? :specification_version then

data/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)

data/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

data/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 @@ module AnnotateModels
         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 @@ module AnnotateModels
         # 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 @@ module AnnotateModels
         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 @@ module AnnotateModels
           # 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 @@ module AnnotateModels
             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 @@ module AnnotateModels
     # 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 @@ module AnnotateModels
     end
 
     def remove_annotations(options={})
-
       self.model_dir = options[:model_dir] if options[:model_dir]
       deannotated = []
       deannotated_klass = false

data/lib/annotate/annotate_routes.rb

@@ -33,7 +33,7 @@ module AnnotateRoutes
     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 }
 

data/lib/annotate/version.rb

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

data/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.

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: annotate
 version: !ruby/object:Gem::Version
-  version: 2.6.3
+  version: 2.6.5
 platform: ruby
 authors:
-- Alex Chaffee
 - Cuong Tran
+- Alex Chaffee
 - Marcos Piccinini
 - Turadg Aleahmad
 - Jon Frisby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-05 00:00:00.000000000 Z
+date: 2014-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -20,14 +20,16 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: !binary |-
+          MC44Ljc=
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: !binary |-
+          MC44Ljc=
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -46,7 +48,7 @@ description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others b
   on the database schema.
 email:
 - alex@stinky.com
-- cuong@gmail.com
+- cuong.tran@gmail.com
 - x@nofxx.com
 - turadg@aleahmad.net
 - jon@cloudability.com
@@ -58,7 +60,6 @@ extra_rdoc_files:
 - CHANGELOG.rdoc
 - TODO.rdoc
 files:
-- .travis.yml
 - AUTHORS.rdoc
 - CHANGELOG.rdoc
 - LICENSE.txt
@@ -98,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: annotate
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Annotates Rails Models, routes, fixtures, and others based on the database

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-
-before_install:
-  - rvm @global do gem install bundler