annotate 2.6.0.beta2 → 2.6.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 9cf1dc6bc654533120158f1a4e03caffd4dcb429
-  data.tar.gz: 12c3f503657c5d96ae02675a47ea5420956918ca
-SHA512:
-  metadata.gz: 69f28f89810d03767192f46583b550a34dac95332fd7d5fe545e57d5405fa5e97664966d2b0700a67eb6a56096a4085db1d1d557773d7947789c017ed7ac3de1
-  data.tar.gz: d613cad136a5a6941bb33563c777d835a9dfa8b9db7f1c0d9851afbe4976b9763ad279e30515d48fe3304e4241fa9af3c463a94244da13fad6117abf406c20a3
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTZlODkwZTcyMTAzZWQzNmZlNTI2NmVjY2Q5MWE4MmI4YWVhYTJiZQ==
+  data.tar.gz: !binary |-
+    MjQzMDdhYzNiODVmNzA1ZTY4MzA3YzAzZjBlNjgxNzFjZmM3ZGJhYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NGE3NjhhMGY4Y2RjMGQ5NzUwZDhhZjhiZjYxYTNjMzE4ZTU5NGJhYzBkMWNm
+    Njk3ZTBkOTViYzNmYzgwMzBjMzZiZDRhNWY4Njc4NjYyNGRmYmM3MWY4ZDk2
+    M2QyZjk5MzMyZTViNzJmZTMwOTE1ZDQzZmFiNmFiNjVkOTQ1ZmI=
+  data.tar.gz: !binary |-
+    MWQzN2NkYjBkNjkxMWVjNTFkZWY2MWI4NGJlMzVmMTA2NmMyZjdkN2M5NzAw
+    ZmRjNGIyNjM3MGM0NGRmZTQ3NjcyYTg2OTcwYjY4YjE4MWZkM2FhM2EzNDFi
+    ZWZhNGNjOTJjMTQxMGFkNzlhMjRlMzk0OTBlYzQ3YzUxZmVkOTQ=

data/AUTHORS.rdoc

@@ -0,0 +1,33 @@
+== Authors
+
+- Original code by: Dave Thomas -- Pragmatic Programmers, LLC <http://agilewebdevelopment.com/plugins/annotate_models>
+- Overhauled by: Alex Chaffee <http://alexch.github.com> alex@stinky.com
+- Gemmed by: Cuong Tran <http://github.com/ctran> ctran@pragmaquest.com
+- Maintained by: Alex Chaffee and Cuong Tran
+- Homepage: http://github.com/ctran/annotate_models
+
+With help from:
+
+- Jack Danger - http://github.com/JackDanger
+- Michael Bumann - http://github.com/bumi
+- Henrik Nyh - http://github.com/henrik
+- Marcos Piccinini - http://github.com/nofxx
+- Neal Clark - http://github.com/nclark
+- Jacqui Maher - http://github.com/jacqui
+- Nick Plante - http://github.com/zapnap - http://blog.zerosum.org
+- Pedro Visintin - http://github.com/peterpunk - http://www.pedrovisintin.com
+- Bob Potter - http://github.com/bpot
+- Gavin Montague - http://github.com/govan
+- Alexander Semyonov - http://github.com/rotuka
+- Nathan Brazil - http://github.com/bitaxis
+- Ian Duggan http://github.com/ijcd
+- Jon Frisby http://github.com/mrjoy
+- Tsutomu Kuroda
+- Kevin Moore
+- Philip Hallstrom
+- Brent Greeff
+- Paul Alexander
+- Dmitry Lihachev
+- qichunren
+
+and many others that I may have forgotten to add.

data/README.rdoc

@@ -33,7 +33,7 @@ The schema comment looks like this:
      . . .
 
 It also annotates geometrical columns, geom type and srid, when using
-`SpatialAdapter` or `PostgisAdapter`:
+`SpatialAdapter`, `PostgisAdapter` or `PostGISAdapter`:
 
    # == Schema Info
    #
@@ -119,15 +119,6 @@ anywhere in the file:
 
     # -*- SkipSchemaAnnotations
 
-To generate a configuration file (in the form of a `.rake` file), to set
-default options:
-
-    rails g annotate:install
-
-Edit this file to control things like output format, where annotations are
-added (top or bottom of file), and in which artifacts.
-
-
 === Configuration in Rails
 
 To generate a configuration file (in the form of a `.rake` file), to set
@@ -137,6 +128,7 @@ default options:
 
 Edit this file to control things like output format, where annotations are
 added (top or bottom of file), and in which artifacts.
+
 == Rails Integration
 
 By default, once you've generated a configuration file, annotate will be
@@ -148,7 +140,7 @@ change:
 
 To:
 
-    'skip_on_db_migrate'   => "try",
+    'skip_on_db_migrate'   => "true",
 
 If you want to run `rake db:migrate` as a one-off without running annotate,
 you can do so with a simple environment variable, instead of editing the
@@ -217,12 +209,17 @@ Be sure to add this to your `Gemfile` as well:
 
 == WARNING
 
-Note that this code will blow away the initial/final comment block in your
-models if it looks like it was previously added by this gem, so you don't want
-to add additional text to an automatically created comment block.
+<b>Don't add text after an automatically-created comment block.</b> This tool
+will blow away the initial/final comment block in your models if it looks like
+it was previously added by this gem.
 
-BACK UP YOUR MODELS BEFORE USING THIS TOOL!
+Be sure to check the changes that this tool makes! If you are using Git,
+you may simply check your project's status after running `annotate`:
 
+    $ git status
+
+If you are not using a VCS (like Git, Subversion or similar), please tread
+extra carefully, and consider using one.
 
 == Links
 
@@ -232,43 +229,19 @@ BACK UP YOUR MODELS BEFORE USING THIS TOOL!
 - Fabrication: http://github.com/paulelliott/fabrication
 - SpatialAdapter: http://github.com/pdeffendol/spatial_adapter
 - PostgisAdapter: http://github.com/nofxx/postgis_adapter
+- PostGISAdapter: https://github.com/dazuma/activerecord-postgis-adapter
 
 
 == License
 
 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
 
-- Original code by: Dave Thomas -- Pragmatic Programmers, LLC <http://agilewebdevelopment.com/plugins/annotate_models>
-- Overhauled by: Alex Chaffee <http://alexch.github.com> alex@stinky.com
-- Gemmed by: Cuong Tran <http://github.com/ctran> ctran@pragmaquest.com
-- Maintained by: Alex Chaffee and Cuong Tran
-- Homepage: http://github.com/ctran/annotate_models
-
-With help from:
-
-- Jack Danger - http://github.com/JackDanger
-- Michael Bumann - http://github.com/bumi
-- Henrik Nyh - http://github.com/henrik
-- Marcos Piccinini - http://github.com/nofxx
-- Neal Clark - http://github.com/nclark
-- Jacqui Maher - http://github.com/jacqui
-- Nick Plante - http://github.com/zapnap - http://blog.zerosum.org
-- Pedro Visintin - http://github.com/peterpunk - http://www.pedrovisintin.com
-- Bob Potter - http://github.com/bpot
-- Gavin Montague - http://github.com/govan
-- Alexander Semyonov - http://github.com/rotuka
-- Nathan Brazil - http://github.com/bitaxis
-- Ian Duggan http://github.com/ijcd
-- Jon Frisby http://github.com/mrjoy
-- Tsutomu Kuroda
-- Kevin Moore
-- Philip Hallstrom
-- Brent Greeff
-- Paul Alexander
-- Dmitry Lihachev
-- qichunren
-
-and many others that I may have forgotten to add.
+{See AUTHORS.rdoc}[link:AUTHORS.rdoc].
+

data/annotate.gemspec

@@ -4,21 +4,20 @@
 
 Gem::Specification.new do |s|
   s.name = "annotate"
-  s.version = "2.6.0.beta2"
+  s.version = "2.6.0"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cuong Tran", "Alex Chaffee", "Marcos Piccinini", "Turadg Aleahmad", "Jon Frisby"]
-  s.date = "2013-06-21"
+  s.date = "2013-11-29"
   s.description = "Annotates Rails/ActiveRecord Models, routes, fixtures, and others based on the database schema."
   s.email = ["alex@stinky.com", "ctran@pragmaquest.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 = ["CHANGELOG.rdoc", "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", "tasks/migrate.rake"]
+  s.files = ["AUTHORS.rdoc", "CHANGELOG.rdoc", "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", "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.0.3"
+  s.rubygems_version = "2.0.6"
   s.summary = "Annotates Rails Models, routes, fixtures, and others based on the database schema."
 
   if s.respond_to? :specification_version then

data/bin/annotate

@@ -134,6 +134,11 @@ OptionParser.new do |opts|
   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
+
+  opts.on('-I', '--ignore-columns REGEX', "don't annotate columns that match a given REGEX (i.e., `annotate -I '^(id|updated_at|created_at)'`" ) do |regex|
+    ENV['ignore_columns'] = regex
+  end
+
 end.parse!
 
 

data/lib/annotate.rb

@@ -25,7 +25,7 @@ module Annotate
     :format_bare, :format_rdoc, :format_markdown, :sort, :force, :trace,
   ]
   OTHER_OPTIONS=[
-    :model_dir,
+    :model_dir, :ignore_columns
   ]
   PATH_OPTIONS=[
     :require,

data/lib/annotate/annotate_models.rb

@@ -5,7 +5,7 @@ module AnnotateModels
   PREFIX           = "== Schema Information"
   PREFIX_MD        = "## Schema Information"
   END_MARK         = "== Schema Information End"
-  PATTERN          = /^\n?# (?:#{COMPAT_PREFIX}|#{COMPAT_PREFIX_MD}).*?\n(#.*\n)*\n/
+  PATTERN          = /^\n?# (?:#{COMPAT_PREFIX}|#{COMPAT_PREFIX_MD}).*?\n(#.*\n)*\n*/
 
   # File.join for windows reverse bar compat?
   # I dont use windows, can`t test
@@ -108,6 +108,9 @@ module AnnotateModels
       end
 
       cols = klass.columns
+      if options[:ignore_columns]
+        cols.reject! { |col| col.name.match(/#{options[:ignore_columns]}/) }
+      end
       cols = cols.sort_by(&:name) if(options[:sort])
       cols.each do |col|
         attrs = []
@@ -118,9 +121,13 @@ module AnnotateModels
         col_type = (col.type || col.sql_type).to_s
         if col_type == "decimal"
           col_type << "(#{col.precision}, #{col.scale})"
-        else
+				elsif col_type != "spatial"
           if (col.limit)
-            col_type << "(#{col.limit})" unless NO_LIMIT_COL_TYPES.include?(col_type)
+            if col.limit.is_a? Array
+              attrs << "(#{col.limit.join(', ')})"
+            else
+              col_type << "(#{col.limit})" unless NO_LIMIT_COL_TYPES.include?(col_type)
+            end
           end
         end
 
@@ -128,6 +135,8 @@ 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?
+          attrs << "#{col.geometric_type.to_s.downcase}, #{col.srid}"
         end
 
         # Check if the column has indices and print "indexed" if true
@@ -160,9 +169,9 @@ module AnnotateModels
       if options[:format_rdoc]
         info << "#--\n"
         info << "# #{END_MARK}\n"
-        info << "#++\n\n"
+        info << "#++\n"
       else
-        info << "#\n\n"
+        info << "#\n"
       end
     end
 
@@ -204,7 +213,7 @@ module AnnotateModels
         return false if(old_content =~ /# -\*- SkipSchemaAnnotations.*\n/)
 
         # Ignore the Schema version line because it changes with each migration
-        header_pattern = /(^# Table name:.*?\n(#.*[\r]?\n)*[\r]?\n)/
+        header_pattern = /(^# Table name:.*?\n(#.*[\r]?\n)*[\r]?)/
         old_header = old_content.match(header_pattern).to_s
         new_header = info_block.match(header_pattern).to_s
 
@@ -212,7 +221,7 @@ module AnnotateModels
         old_columns = old_header && old_header.scan(column_pattern).sort
         new_columns = new_header && new_header.scan(column_pattern).sort
 
-        encoding = Regexp.new(/(^#\s*encoding:.*\n)|(^# coding:.*\n)|(^# -\*- coding:.*\n)/)
+        encoding = Regexp.new(/(^#\s*encoding:.*\n)|(^# coding:.*\n)|(^# -\*- coding:.*\n)|(^# -\*- encoding\s?:.*\n)/)
         encoding_header = old_content.match(encoding).to_s
 
         if old_columns == new_columns && !options[:force]
@@ -238,7 +247,7 @@ module AnnotateModels
 
           new_content = options[position].to_s == 'after' ?
             (encoding_header + (old_content.rstrip + "\n\n" + info_block)) :
-            (encoding_header + info_block + old_content)
+            (encoding_header + info_block + "\n" + old_content)
 
           File.open(file_name, "wb") { |f| f.puts new_content }
           return true
@@ -407,7 +416,7 @@ module AnnotateModels
     def annotate_model_file(annotated, file, header, options)
       begin
         klass = get_model_class(file)
-        if klass && klass < ActiveRecord::Base && !klass.abstract_class?
+        if klass && klass < ActiveRecord::Base && !klass.abstract_class? && klass.table_exists?
           if annotate(klass, file, header, options)
             annotated << klass
           end

data/lib/annotate/version.rb

@@ -1,5 +1,5 @@
 module Annotate
   def self.version
-    '2.6.0.beta2'
+    '2.6.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotate
 version: !ruby/object:Gem::Version
-  version: 2.6.0.beta2
+  version: 2.6.0
 platform: ruby
 authors:
 - Cuong Tran
@@ -12,34 +12,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.3.0
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
@@ -58,6 +58,7 @@ extra_rdoc_files:
 - CHANGELOG.rdoc
 - TODO.rdoc
 files:
+- AUTHORS.rdoc
 - CHANGELOG.rdoc
 - README.rdoc
 - TODO.rdoc
@@ -85,17 +86,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: annotate
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Annotates Rails Models, routes, fixtures, and others based on the database