annotate 2.5.0 → 2.6.0.beta2

data/lib/annotate/annotate_routes.rb

@@ -5,37 +5,143 @@
 #
 #
 # Prepends the output of "rake routes" to the top of your routes.rb file.
-# Yes, it's simple but I'm thick and often need a reminder of what my routes mean.
+# Yes, it's simple but I'm thick and often need a reminder of what my routes
+# mean.
 #
-# Running this task will replace any exising route comment generated by the task.
-# Best to back up your routes file before running:
+# Running this task will replace any exising route comment generated by the
+# task. Best to back up your routes file before running:
 #
 # Author:
 #  Gavin Montague
 #  gavin@leftbrained.co.uk
 #
-# Released under the same license as Ruby. No Support. No Warranty.module AnnotateRoutes
+# Released under the same license as Ruby. No Support. No Warranty.
 #
 module AnnotateRoutes
-  PREFIX = "#== Route Map"
-
-  def self.do_annotate
-    routes_rb = File.join("config", "routes.rb")
-    header = PREFIX + "\n# Generated on #{Time.now.strftime("%d %b %Y %H:%M")}\n#"
-    if File.exists? routes_rb
-      routes_map = `rake routes`
-      routes_map = routes_map.split("\n")
-      routes_map.shift # remove the first line of rake routes which is just a file path
-      routes_map = routes_map.inject(header){|sum, line| sum<<"\n# "<<line}
-      content = File.read(routes_rb)
-      content, old = content.split(/^#== Route .*?\n/)
-      File.open(routes_rb, "wb") do |f|
-        f.puts content.sub!(/\n?\z/, "\n") + routes_map
+  PREFIX = "# == Route Map"
+
+  def self.do_annotations(options={})
+    return unless(routes_exists?)
+
+    position_after = options[:position_in_routes] != 'before'
+
+    routes_map = `rake routes`.split(/\n/, -1)
+
+    # In old versions of Rake, the first line of output was the cwd.  Not so
+    # much in newer ones.  We ditch that line if it exists, and if not, we
+    # keep the line around.
+    routes_map.shift if(routes_map.first =~ /^\(in \//)
+
+    header = [
+      "#{PREFIX} (Updated #{Time.now.strftime("%Y-%m-%d %H:%M")})",
+      "#"
+    ] + routes_map.map { |line| "# #{line}".rstrip }
+
+    (content, where_header_found) = strip_annotations(File.read(routes_file))
+    changed = where_header_found != 0 # This will either be :before, :after, or
+                                      # a number.  If the number is > 0, the
+                                      # annotation was found somewhere in the
+                                      # middle of the file.  If the number is
+                                      # zero, no annotation was found.
+
+    if(position_after)
+      # Ensure we have adequate trailing newlines at the end of the file to
+      # ensure a blank line separating the content from the annotation.
+      content << '' if(content.last != '')
+
+      # We're moving something from the top of the file to the bottom, so ditch
+      # the spacer we put in the first time around.
+      if(changed && where_header_found == :before)
+        content.shift if(content.first == '')
       end
-      puts "Route file annotated."
     else
-      puts "Can`t find routes.rb"
+      header = header << '' if(content.first != '' || changed)
     end
+
+    content = position_after ? (content + header) : header + content
+
+    write_contents(content)
+
+    puts "Route file annotated."
+  end
+
+  def self.remove_annotations(options={})
+    return unless(routes_exists?)
+
+    (content, where_header_found) = strip_annotations(File.read(routes_file))
+
+    content = strip_on_removal(content, where_header_found)
+
+    write_contents(content)
+
+    puts "Removed annotations from routes file."
   end
 
+protected
+
+  def self.routes_file
+    @routes_rb ||= File.join("config", "routes.rb")
+  end
+
+  def self.routes_exists?
+    routes_exists = File.exists?(routes_file)
+    puts "Can`t find routes.rb" if(!routes_exists)
+    return routes_exists
+  end
+
+  def self.write_contents(content)
+    content << '' unless(content.last == '') # Make sure we end on a trailing
+                                             # newline.
+
+    File.open(routes_file, "wb") { |f| f.puts(content.join("\n")) }
+  end
+
+  def self.strip_annotations(content)
+    real_content = []
+    mode = :content
+    line_number = 0
+    header_found_at = 0
+    content.split(/\n/, -1).each do |line|
+      line_number += 1
+      begin
+        if(mode == :header)
+          if(line !~ /\s*#/)
+            mode = :content
+            raise unless (line == '')
+          end
+        elsif(mode == :content)
+          if(line =~ /^\s*#\s*== Route.*$/)
+            header_found_at = line_number
+            mode = :header
+          else
+            real_content << line
+          end
+        end
+      rescue
+        retry
+      end
+    end
+    content_lines = real_content.count
+
+    # By default assume the annotation was found in the middle of the file...
+    where_header_found = header_found_at
+    # ... unless we have evidence it was at the beginning ...
+    where_header_found = :before if(header_found_at == 1)
+    # ... or that it was at the end.
+    where_header_found = :after if(header_found_at >= content_lines)
+
+    return real_content, where_header_found
+  end
+
+  def self.strip_on_removal(content, where_header_found)
+    if(where_header_found == :before)
+      content.shift while(content.first == '')
+    elsif(where_header_found == :after)
+      content.pop while(content.last == '')
+    end
+    # TODO: If the user buried it in the middle, we should probably see about
+    # TODO: preserving a single line of space between the content above and
+    # TODO: below...
+    return content
+  end
 end

data/lib/annotate/version.rb

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

data/lib/generators/{annotate_models → annotate}/USAGE

@@ -1,4 +1,4 @@
 Add a .rake file that automatically annotates models when you do a db:migrate
 in development mode:
 
-    rails generate annotate_models:install
+    rails generate annotate:install

data/lib/generators/{annotate_models → annotate}/install_generator.rb

@@ -1,4 +1,4 @@
-module AnnotateModels
+module Annotate
   module Generators
     class InstallGenerator < Rails::Generators::Base
       desc "Copy annotate_models rakefiles for automatic annotation"
@@ -11,4 +11,4 @@ module AnnotateModels
 
     end
   end
-end
+end

data/lib/generators/annotate/templates/auto_annotate_models.rake

@@ -0,0 +1,34 @@
+# 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?)
+  task :set_annotation_options do
+    # You can override any of these by setting an environment variable of the
+    # same name.
+    Annotate.set_defaults({
+      'position_in_routes'   => "before",
+      'position_in_class'    => "before",
+      'position_in_test'     => "before",
+      'position_in_fixture'  => "before",
+      'position_in_factory'  => "before",
+      'show_indexes'         => "true",
+      'simple_indexes'       => "false",
+      'model_dir'            => "app/models",
+      'include_version'      => "false",
+      'require'              => "",
+      'exclude_tests'        => "false",
+      'exclude_fixtures'     => "false",
+      'exclude_factories'    => "false",
+      'ignore_model_sub_dir' => "false",
+      'skip_on_db_migrate'   => "false",
+      'format_bare'          => "true",
+      'format_rdoc'          => "false",
+      'format_markdown'      => "false",
+      'sort'                 => "false",
+      'force'                => "false",
+      'trace'                => "false",
+    })
+  end
+
+  Annotate.load_tasks
+end

data/lib/tasks/annotate_models.rake

@@ -10,25 +10,27 @@ task :annotate_models => :environment do
   require "#{annotate_lib}/annotate/annotate_models"
   require "#{annotate_lib}/annotate/active_record_patch"
 
-  true_re = /(true|t|yes|y|1)$/i
-
   options={ :is_rake => true }
-  options[:position_in_class] = ENV['position_in_class'] || ENV['position'] || 'before'
-  options[:position_in_fixture] = ENV['position_in_fixture'] || ENV['position']  || 'before'
-  options[:position_in_factory] = ENV['position_in_factory'] || ENV['position'] || 'before'
-  options[:show_indexes] = ENV['show_indexes'] =~ true_re
-  options[:simple_indexes] = ENV['simple_indexes'] =~ true_re
+  ENV['position'] = options[:position] = Annotate.fallback(ENV['position'], 'before')
+  options[:position_in_class] = Annotate.fallback(ENV['position_in_class'], ENV['position'])
+  options[:position_in_fixture] = Annotate.fallback(ENV['position_in_fixture'], ENV['position'])
+  options[:position_in_factory] = Annotate.fallback(ENV['position_in_factory'], ENV['position'])
+  options[:position_in_test] = Annotate.fallback(ENV['position_in_test'], ENV['position'])
+  options[:show_indexes] = Annotate.true?(ENV['show_indexes'])
+  options[:simple_indexes] = Annotate.true?(ENV['simple_indexes'])
   options[:model_dir] = ENV['model_dir']
-  options[:include_version] = ENV['include_version'] =~ true_re
+  options[:include_version] = Annotate.true?(ENV['include_version'])
   options[:require] = ENV['require'] ? ENV['require'].split(',') : []
-  options[:exclude_tests] = ENV['exclude_tests'] =~ true_re
-  options[:exclude_fixtures] = ENV['exclude_fixtures'] =~ true_re
-  options[:ignore_model_sub_dir] = ENV['ignore_model_sub_dir'] =~ true_re
-  options[:format_rdoc] = ENV['format_rdoc'] =~ true_re
-  options[:format_markdown] = ENV['format_markdown'] =~ true_re
-  options[:sort] = ENV['sort'] =~ true_re
-  options[:force] = ENV['force'] =~ true_re
-  options[:trace] = ENV['trace'] =~ true_re
+  options[:exclude_tests] = Annotate.true?(ENV['exclude_tests'])
+  options[:exclude_factories] = Annotate.true?(ENV['exclude_factories'])
+  options[:exclude_fixtures] = Annotate.true?(ENV['exclude_fixtures'])
+  options[:ignore_model_sub_dir] = Annotate.true?(ENV['ignore_model_sub_dir'])
+  options[:format_bare] = Annotate.true?(ENV['format_bare'])
+  options[:format_rdoc] = Annotate.true?(ENV['format_rdoc'])
+  options[:format_markdown] = Annotate.true?(ENV['format_markdown'])
+  options[:sort] = Annotate.true?(ENV['sort'])
+  options[:force] = Annotate.true?(ENV['force'])
+  options[:trace] = Annotate.true?(ENV['trace'])
   AnnotateModels.do_annotations(options)
 end
 
@@ -36,7 +38,10 @@ desc "Remove schema information from model and fixture files"
 task :remove_annotation => :environment do
   require "#{annotate_lib}/annotate/annotate_models"
   require "#{annotate_lib}/annotate/active_record_patch"
+
   options={ :is_rake => true }
   options[:model_dir] = ENV['model_dir']
+  options[:require] = ENV['require'] ? ENV['require'].split(',') : []
+  options[:trace] = Annotate.true?(ENV['trace'])
   AnnotateModels.remove_annotations(options)
 end

data/lib/tasks/annotate_routes.rake

@@ -1,6 +1,21 @@
-desc "Prepends the route map to the top of routes.rb"
+desc "Adds the route map to routes.rb"
 task :annotate_routes => :environment do
   annotate_lib = File.expand_path(File.dirname(File.dirname(__FILE__)))
   require "#{annotate_lib}/annotate/annotate_routes"
-  AnnotateRoutes.do_annotate
+
+  options={}
+  ENV['position'] = options[:position] = Annotate.fallback(ENV['position'], 'before')
+  options[:position_in_routes] = Annotate.fallback(ENV['position_in_routes'], ENV['position'])
+  options[:require] = ENV['require'] ? ENV['require'].split(',') : []
+  AnnotateRoutes.do_annotations(options)
+end
+
+desc "Removes the route map from routes.rb"
+task :remove_routes => :environment do
+  annotate_lib = File.expand_path(File.dirname(File.dirname(__FILE__)))
+  require "#{annotate_lib}/annotate/annotate_routes"
+
+  options={}
+  options[:require] = ENV['require'] ? ENV['require'].split(',') : []
+  AnnotateRoutes.remove_annotations(options)
 end

metadata

@@ -1,35 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: annotate
 version: !ruby/object:Gem::Version
-  version: 2.5.0
-  prerelease: 
+  version: 2.6.0.beta2
 platform: ruby
 authors:
 - Cuong Tran
 - Alex Chaffee
 - Marcos Piccinini
 - Turadg Aleahmad
+- Jon Frisby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-28 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        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
   on the database schema.
 email:
@@ -37,55 +49,56 @@ email:
 - ctran@pragmaquest.com
 - x@nofxx.com
 - turadg@aleahmad.net
+- jon@cloudability.com
 executables:
 - annotate
 extensions: []
 extra_rdoc_files:
 - README.rdoc
+- CHANGELOG.rdoc
+- TODO.rdoc
 files:
+- CHANGELOG.rdoc
 - README.rdoc
-- History.txt
-- !binary |-
-  YmluL2Fubm90YXRl
+- 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/annotate.rb
-- lib/generators/annotate_models/install_generator.rb
-- lib/generators/annotate_models/templates/auto_annotate_models.rake
-- lib/generators/annotate_models/USAGE
+- 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
 homepage: http://github.com/ctran/annotate_models
-licenses: []
+licenses:
+- Ruby
+metadata: {}
 post_install_message: 
-rdoc_options:
-- --charset=UTF-8
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3303794202298947958
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: annotate
-rubygems_version: 1.8.21
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Annotates Rails Models, routes, fixtures, and others based on the database
   schema.
 test_files: []
+has_rdoc: 

data/lib/generators/annotate_models/templates/auto_annotate_models.rake

@@ -1,20 +0,0 @@
-# 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?)
-  task :set_annotation_options do
-    ENV['position_in_class']    = "before"
-    ENV['position_in_fixture']  = "before"
-    ENV['position_in_factory']  = "before"
-    ENV['show_indexes']         = "true"
-    ENV['include_version']      = "false"
-    ENV['exclude_tests']        = "false"
-    ENV['exclude_fixtures']     = "false"
-    ENV['ignore_model_sub_dir'] = "false"
-    ENV['skip_on_db_migrate']   = "false"
-    ENV['format_rdoc']          = "false"
-    ENV['format_markdown']      = "false"
-    ENV['no_sort']              = "false"
-    ENV['force']                = "false"
-  end
-end