annotate 2.7.0 → 2.7.1

data/lib/annotate/annotate_routes.rb

@@ -18,139 +18,153 @@
 # Released under the same license as Ruby. No Support. No Warranty.
 #
 module AnnotateRoutes
-  PREFIX = "# == Route Map"
+  PREFIX = '# == Route Map'
 
   def self.do_annotations(options={})
-    return unless(routes_exists?)
+    return unless routes_exists?
 
-    position_after = ! %w(before top).include?(options[:position_in_routes])
-
-    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 \//)
+    routes_map = AnnotateRoutes.app_routes_map(options)
 
     header = [
-      "#{PREFIX}" + (options[:timestamp] ? " (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 }
 
     existing_text = File.read(routes_file)
-    (content, where_header_found) = strip_annotations(existing_text)
-    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
-    else
-      header = header << '' if(content.first != '' || changed)
-    end
-
-    content = position_after ? (content + header) : header + content
-
-    if write_contents(existing_text, content)
+    if write_contents(existing_text, header, options)
       puts "#{routes_file} annotated."
-    else
-      puts "#{routes_file} unchanged."
     end
   end
 
   def self.remove_annotations(options={})
-    return unless(routes_exists?)
+    return unless routes_exists?
     existing_text = File.read(routes_file)
-    (content, where_header_found) = strip_annotations(existing_text)
+    content, where_header_found = strip_annotations(existing_text)
 
     content = strip_on_removal(content, where_header_found)
 
-    if write_contents(existing_text, content)
+    if write_contents(existing_text, content, options)
       puts "Removed annotations from #{routes_file}."
-    else
-      puts "#{routes_file} unchanged."
     end
   end
 
-protected
+  private
+
+  def self.app_routes_map(options)
+    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 \//
+
+    # Skip routes which match given regex
+    # Note: it matches the complete line (route_name, path, controller/action)
+    if options[:ignore_routes]
+      routes_map.reject! { |line| line =~ /#{options[:ignore_routes]}/ }
+    end
+
+    routes_map
+  end
 
   def self.routes_file
-    @routes_rb ||= File.join("config", "routes.rb")
+    @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
+    puts "Can't find routes.rb" unless routes_exists
+
+    routes_exists
   end
 
-  def self.write_contents(existing_text, new_content)
+  def self.write_contents(existing_text, header, options = {})
+    content, where_header_found = strip_annotations(existing_text)
+    new_content = annotate_routes(header, content, where_header_found, options)
+
     # Make sure we end on a trailing newline.
-    new_content << '' unless(new_content.last == '')
+    new_content << '' unless new_content.last == ''
     new_text = new_content.join("\n")
 
-    return false if existing_text == new_text
+    if existing_text == new_text
+      puts "#{routes_file} unchanged."
+      false
+    else
+      File.open(routes_file, 'wb') { |f| f.puts(new_text) }
+      true
+    end
+  end
 
-    File.open(routes_file, "wb") { |f| f.puts(new_text) }
-    return true
+  def self.annotate_routes(header, content, where_header_found, options = {})
+    if %w(before top).include?(options[:position_in_routes])
+      header = header << '' if content.first != ''
+      new_content = header + content
+    else
+      # Ensure we have adequate trailing newlines at the end of the file to
+      # ensure a blank line separating the content from the annotation.
+      content << '' unless 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.
+      content.shift if where_header_found == :before && content.first == ''
+
+      new_content = content + header
+    end
+
+    new_content
   end
 
+  # TODO: write the method doc using ruby rdoc formats
+  # where_header_found => 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.
   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
+
+    content.split(/\n/, -1).each_with_index do |line, line_number|
+      if mode == :header && line !~ /\s*#/
+        mode = :content
+        next unless line == ''
+      elsif mode == :content
+        if line =~ /^\s*#\s*== Route.*$/
+          header_found_at = line_number + 1 # index start's at 0
+          mode = :header
+        else
+          real_content << line
         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
+    where_header_found(real_content, header_found_at)
+  end
+
+  def self.where_header_found(real_content, header_found_at)
+    # By default assume the annotation was found in the middle of the file
+
     # ... unless we have evidence it was at the beginning ...
-    where_header_found = :before if(header_found_at == 1)
+    return real_content, :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, :after if header_found_at >= real_content.count
 
-    return real_content, where_header_found
+    # and the default
+    return real_content, header_found_at
   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 == '')
+    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
+    content
   end
 end

data/lib/annotate/version.rb

@@ -1,5 +1,5 @@
 module Annotate
   def self.version
-    '2.7.0'
+    '2.7.1'
   end
 end

data/lib/generators/annotate/install_generator.rb

@@ -1,14 +1,13 @@
 module Annotate
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      desc "Copy annotate_models rakefiles for automatic annotation"
+      desc 'Copy annotate_models rakefiles for automatic annotation'
       source_root File.expand_path('../templates', __FILE__)
 
       # copy rake tasks
       def copy_tasks
-        template "auto_annotate_models.rake", "lib/tasks/auto_annotate_models.rake"
+        template 'auto_annotate_models.rake', 'lib/tasks/auto_annotate_models.rake'
       end
-
     end
   end
 end

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

@@ -24,13 +24,14 @@ if Rails.env.development?
       'exclude_fixtures'        => 'false',
       'exclude_factories'       => 'false',
       'exclude_serializers'     => 'false',
-      'exclude_scaffolds'       => 'false',
-      'exclude_controllers'     => 'false',
-      'exclude_helpers'         => 'false',
+      'exclude_scaffolds'       => 'true',
+      'exclude_controllers'     => 'true',
+      'exclude_helpers'         => 'true',
       'ignore_model_sub_dir'    => 'false',
       'ignore_columns'          => nil,
+      'ignore_routes'           => nil,
       'ignore_unknown_models'   => 'false',
-      'hide_limit_column_types' => '<%= AnnotateModels::NO_LIMIT_COL_TYPES.join(',') %>',
+      'hide_limit_column_types' => '<%= AnnotateModels::NO_LIMIT_COL_TYPES.join(",") %>',
       'skip_on_db_migrate'      => 'false',
       'format_bare'             => 'true',
       'format_rdoc'             => 'false',
@@ -39,7 +40,7 @@ if Rails.env.development?
       'force'                   => 'false',
       'trace'                   => 'false',
       'wrapper_open'            => nil,
-      'wrapper_close'           => nil,
+      'wrapper_close'           => nil
     )
   end
 

data/lib/tasks/annotate_models.rake

@@ -1,16 +1,16 @@
 annotate_lib = File.expand_path(File.dirname(File.dirname(__FILE__)))
 
-if !ENV['is_cli']
+unless ENV['is_cli']
   task :set_annotation_options
-  task :annotate_models => :set_annotation_options
+  task annotate_models: :set_annotation_options
 end
 
-desc "Add schema information (as comments) to model and fixture files"
-task :annotate_models => :environment do
+desc 'Add schema information (as comments) to model and fixture files'
+task annotate_models: :environment do
   require "#{annotate_lib}/annotate/annotate_models"
   require "#{annotate_lib}/annotate/active_record_patch"
 
-  options={ :is_rake => true }
+  options={is_rake: true}
   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'])
@@ -29,8 +29,8 @@ task :annotate_models => :environment do
   options[:exclude_fixtures] = Annotate.true?(ENV['exclude_fixtures'])
   options[:exclude_serializers] = Annotate.true?(ENV['exclude_serializers'])
   options[:exclude_scaffolds] = Annotate.true?(ENV['exclude_scaffolds'])
-  options[:exclude_controllers] = Annotate.true?(ENV['exclude_controllers'])
-  options[:exclude_helpers] = Annotate.true?(ENV['exclude_helpers'])
+  options[:exclude_controllers] = Annotate.true?(ENV.fetch('exclude_controllers', 'true'))
+  options[:exclude_helpers] = Annotate.true?(ENV.fetch('exclude_helpers', 'true'))
   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'])
@@ -42,16 +42,18 @@ task :annotate_models => :environment do
   options[:wrapper_open] = Annotate.fallback(ENV['wrapper_open'], ENV['wrapper'])
   options[:wrapper_close] = Annotate.fallback(ENV['wrapper_close'], ENV['wrapper'])
   options[:ignore_columns] = ENV.fetch('ignore_columns', nil)
+  options[:ignore_routes] = ENV.fetch('ignore_routes', nil)
+  options[:hide_limit_column_types] = Annotate.fallback(ENV['hide_limit_column_types'], '')
 
   AnnotateModels.do_annotations(options)
 end
 
-desc "Remove schema information from model and fixture files"
-task :remove_annotation => :environment do
+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={is_rake: true}
   options[:model_dir] = ENV['model_dir']
   options[:root_dir] = ENV['root_dir']
   options[:require] = ENV['require'] ? ENV['require'].split(',') : []

data/lib/tasks/annotate_routes.rake

@@ -6,6 +6,7 @@ task :annotate_routes => :environment do
   options={}
   ENV['position'] = options[:position] = Annotate.fallback(ENV['position'], 'before')
   options[:position_in_routes] = Annotate.fallback(ENV['position_in_routes'], ENV['position'])
+  options[:ignore_routes] = Annotate.fallback(ENV['ignore_routes'],  nil)
   options[:require] = ENV['require'] ? ENV['require'].split(',') : []
   AnnotateRoutes.do_annotations(options)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotate
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.7.1
 platform: ruby
 authors:
 - Alex Chaffee
@@ -12,22 +12,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '12.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -103,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: annotate
-rubygems_version: 2.5.0
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Annotates Rails Models, routes, fixtures, and others based on the database