annotate 2.7.4 → 3.1.1

data/lib/annotate/annotate_routes.rb

@@ -10,7 +10,7 @@
 # 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
+# Running this task will replace any existing route comment generated by the
 # task. Best to back up your routes file before running:
 #
 # Author:
@@ -19,26 +19,62 @@
 #
 # Released under the same license as Ruby. No Support. No Warranty.
 #
+
+require_relative './annotate_routes/helpers'
+
 module AnnotateRoutes
   PREFIX = '== Route Map'.freeze
   PREFIX_MD = '## Route Map'.freeze
-  HEADER_ROW = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action']
+  HEADER_ROW = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action'].freeze
 
   class << self
-    def content(line, maxs, options = {})
-      return line.rstrip unless options[:format_markdown]
+    def do_annotations(options = {})
+      if routes_file_exist?
+        existing_text = File.read(routes_file)
+        content, header_position = Helpers.strip_annotations(existing_text)
+        new_content = annotate_routes(header(options), content, header_position, options)
+        new_text = new_content.join("\n")
+
+        if rewrite_contents(existing_text, new_text)
+          puts "#{routes_file} was annotated."
+        else
+          puts "#{routes_file} was not changed."
+        end
+      else
+        puts "#{routes_file} could not be found."
+      end
+    end
 
-      line.each_with_index.map do |elem, index|
-        min_length = maxs.map { |arr| arr[index] }.max || 0
+    def remove_annotations(_options={})
+      if routes_file_exist?
+        existing_text = File.read(routes_file)
+        content, header_position = Helpers.strip_annotations(existing_text)
+        new_content = strip_on_removal(content, header_position)
+        new_text = new_content.join("\n")
+        if rewrite_contents(existing_text, new_text)
+          puts "Annotations were removed from #{routes_file}."
+        else
+          puts "#{routes_file} was not changed (Annotation did not exist)."
+        end
+      else
+        puts "#{routes_file} could not be found."
+      end
+    end
 
-        sprintf("%-#{min_length}.#{min_length}s", elem.tr('|', '-'))
-      end.join(' | ')
+    private
+
+    def routes_file_exist?
+      File.exist?(routes_file)
+    end
+
+    def routes_file
+      @routes_rb ||= File.join('config', 'routes.rb')
     end
 
     def header(options = {})
       routes_map = app_routes_map(options)
 
-      magic_comments_map, routes_map = extract_magic_comments_from_array(routes_map)
+      magic_comments_map, routes_map = Helpers.extract_magic_comments_from_array(routes_map)
 
       out = []
 
@@ -47,10 +83,10 @@ module AnnotateRoutes
       end
       out << '' if magic_comments_map.any?
 
-      out += ["# #{options[:wrapper_open]}"] if options[:wrapper_open]
+      out << comment(options[:wrapper_open]) if options[:wrapper_open]
 
-      out += ["# #{options[:format_markdown] ? PREFIX_MD : PREFIX}" + (options[:timestamp] ? " (Updated #{Time.now.strftime('%Y-%m-%d %H:%M')})" : '')]
-      out += ['#']
+      out << comment(options[:format_markdown] ? PREFIX_MD : PREFIX) + (options[:timestamp] ? " (Updated #{Time.now.strftime('%Y-%m-%d %H:%M')})" : '')
+      out << comment
       return out if routes_map.size.zero?
 
       maxs = [HEADER_ROW.map(&:size)] + routes_map[1..-1].map { |line| line.split.map(&:size) }
@@ -58,192 +94,100 @@ module AnnotateRoutes
       if options[:format_markdown]
         max = maxs.map(&:max).compact.max
 
-        out += ["# #{content(HEADER_ROW, maxs, options)}"]
-        out += ["# #{content(['-' * max, '-' * max, '-' * max, '-' * max], maxs, options)}"]
+        out << comment(content(HEADER_ROW, maxs, options))
+        out << comment(content(['-' * max, '-' * max, '-' * max, '-' * max], maxs, options))
       else
-        out += ["# #{content(routes_map[0], maxs, options)}"]
+        out << comment(content(routes_map[0], maxs, options))
       end
 
-      out += routes_map[1..-1].map { |line| "# #{content(options[:format_markdown] ? line.split(' ') : line, maxs, options)}" }
-      out += ["# #{options[:wrapper_close]}"] if options[:wrapper_close]
+      out += routes_map[1..-1].map { |line| comment(content(options[:format_markdown] ? line.split(' ') : line, maxs, options)) }
+      out << comment(options[:wrapper_close]) if options[:wrapper_close]
 
       out
     end
 
-    def do_annotations(options = {})
-      return unless routes_exists?
-      existing_text = File.read(routes_file)
-
-      if rewrite_contents_with_header(existing_text, header(options), options)
-        puts "#{routes_file} annotated."
+    def comment(row = '')
+      if row == ''
+        '#'
+      else
+        "# #{row}"
       end
     end
 
-    def remove_annotations(_options={})
-      return unless routes_exists?
-      existing_text = File.read(routes_file)
-      content, where_header_found = strip_annotations(existing_text)
-      new_content = strip_on_removal(content, where_header_found)
-      if rewrite_contents(existing_text, new_content)
-        puts "Removed annotations from #{routes_file}."
+    def strip_on_removal(content, header_position)
+      if header_position == :before
+        content.shift while content.first == ''
+      elsif header_position == :after
+        content.pop while content.last == ''
       end
-    end
-  end
 
-  def self.magic_comment_matcher
-    Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/)
-  end
+      # Make sure we end on a trailing newline.
+      content << '' unless content.last == ''
 
-  # @param [Array<String>] content
-  # @return [Array<String>] all found magic comments
-  # @return [Array<String>] content without magic comments
-  def self.extract_magic_comments_from_array(content_array)
-    magic_comments = []
-    new_content = []
+      # 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...
+      content
+    end
 
-    content_array.map do |row|
-      if row =~ magic_comment_matcher
-        magic_comments << row.strip
+    def rewrite_contents(existing_text, new_text)
+      if existing_text == new_text
+        false
       else
-        new_content << row
+        File.open(routes_file, 'wb') { |f| f.puts(new_text) }
+        true
       end
     end
 
-    [magic_comments, new_content]
-  end
-
-  def self.app_routes_map(options)
-    routes_map = `rake routes`.chomp("\n").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')
-  end
-
-  def self.routes_exists?
-    routes_exists = File.exists?(routes_file)
-    puts "Can't find routes.rb" unless routes_exists
-
-    routes_exists
-  end
+    def annotate_routes(header, content, header_position, options = {})
+      magic_comments_map, content = Helpers.extract_magic_comments_from_array(content)
+      if %w(before top).include?(options[:position_in_routes])
+        header = header << '' if content.first != ''
+        magic_comments_map << '' if magic_comments_map.any?
+        new_content = magic_comments_map + 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 == ''
 
-  # @param [String, Array<String>]
-  def self.rewrite_contents(existing_text, new_content)
-    # Make sure we end on a trailing newline.
-    new_content << '' unless new_content.last == ''
-    new_text = new_content.join("\n")
-
-    if existing_text == new_text
-      puts "#{routes_file} unchanged."
-      false
-    else
-      File.open(routes_file, 'wb') { |f| f.puts(new_text) }
-      true
-    end
-  end
+        # 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 header_position == :before && content.first == ''
 
-  def self.rewrite_contents_with_header(existing_text, header, options = {})
-    content, where_header_found = strip_annotations(existing_text)
-    new_content = annotate_routes(header, content, where_header_found, options)
+        new_content = magic_comments_map + content + header
+      end
 
-    # Make sure we end on a trailing newline.
-    new_content << '' unless new_content.last == ''
-    new_text = new_content.join("\n")
+      # Make sure we end on a trailing newline.
+      new_content << '' unless new_content.last == ''
 
-    if existing_text == new_text
-      puts "#{routes_file} unchanged."
-      false
-    else
-      File.open(routes_file, 'wb') { |f| f.puts(new_text) }
-      true
+      new_content
     end
-  end
-
-  def self.annotate_routes(header, content, where_header_found, options = {})
-    magic_comments_map, content = extract_magic_comments_from_array(content)
-    if %w(before top).include?(options[:position_in_routes])
-      header = header << '' if content.first != ''
-      magic_comments_map << '' if magic_comments_map.any?
-      new_content = magic_comments_map + 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 = magic_comments_map + content + header
-    end
+    def app_routes_map(options)
+      routes_map = `rake routes`.chomp("\n").split(/\n/, -1)
 
-    new_content
-  end
+      # 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 \//
 
-  # 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
-    header_found_at = 0
-
-    content.split(/\n/, -1).each_with_index do |line, line_number|
-      if mode == :header && line !~ /\s*#/
-        mode = :content
-        real_content << line unless line.blank?
-      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
+      # 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
-    end
 
-    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 ...
-    return real_content, :before if header_found_at == 1
+      routes_map
+    end
 
-    # ... or that it was at the end.
-    return real_content, :after if header_found_at >= real_content.count
+    def content(line, maxs, options = {})
+      return line.rstrip unless options[:format_markdown]
 
-    # and the default
-    return real_content, header_found_at
-  end
+      line.each_with_index.map do |elem, index|
+        min_length = maxs.map { |arr| arr[index] }.max || 0
 
-  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 == ''
+        sprintf("%-#{min_length}.#{min_length}s", elem.tr('|', '-'))
+      end.join(' | ')
     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...
-    content
   end
 end

data/lib/annotate/annotate_routes/helpers.rb

@@ -0,0 +1,69 @@
+module AnnotateRoutes
+  module Helpers
+    MAGIC_COMMENT_MATCHER = Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/).freeze
+
+    class << self
+      # TODO: write the method doc using ruby rdoc formats
+      # This method returns an array of 'real_content' and 'header_position'.
+      # 'header_position' 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 strip_annotations(content)
+        real_content = []
+        mode = :content
+        header_position = 0
+
+        content.split(/\n/, -1).each_with_index do |line, line_number|
+          if mode == :header && line !~ /\s*#/
+            mode = :content
+            real_content << line unless line.blank?
+          elsif mode == :content
+            if line =~ /^\s*#\s*== Route.*$/
+              header_position = line_number + 1 # index start's at 0
+              mode = :header
+            else
+              real_content << line
+            end
+          end
+        end
+
+        real_content_and_header_position(real_content, header_position)
+      end
+
+      # @param [Array<String>] content
+      # @return [Array<String>] all found magic comments
+      # @return [Array<String>] content without magic comments
+      def extract_magic_comments_from_array(content_array)
+        magic_comments = []
+        new_content = []
+
+        content_array.each do |row|
+          if row =~ MAGIC_COMMENT_MATCHER
+            magic_comments << row.strip
+          else
+            new_content << row
+          end
+        end
+
+        [magic_comments, new_content]
+      end
+
+      private
+
+      def real_content_and_header_position(real_content, header_position)
+        # By default assume the annotation was found in the middle of the file
+
+        # ... unless we have evidence it was at the beginning ...
+        return real_content, :before if header_position == 1
+
+        # ... or that it was at the end.
+        return real_content, :after if header_position >= real_content.count
+
+        # and the default
+        return real_content, header_position
+      end
+    end
+  end
+end

data/lib/annotate/constants.rb

@@ -0,0 +1,38 @@
+module Annotate
+  module Constants
+    TRUE_RE = /^(true|t|yes|y|1)$/i.freeze
+
+    ##
+    # The set of available options to customize the behavior of Annotate.
+    #
+    POSITION_OPTIONS = [
+      :position_in_routes, :position_in_class, :position_in_test,
+      :position_in_fixture, :position_in_factory, :position,
+      :position_in_serializer
+    ].freeze
+
+    FLAG_OPTIONS = [
+      :show_indexes, :simple_indexes, :include_version, :exclude_tests,
+      :exclude_fixtures, :exclude_factories, :ignore_model_sub_dir,
+      :format_bare, :format_rdoc, :format_yard, :format_markdown, :sort, :force, :frozen,
+      :trace, :timestamp, :exclude_serializers, :classified_sort,
+      :show_foreign_keys, :show_complete_foreign_keys,
+      :exclude_scaffolds, :exclude_controllers, :exclude_helpers,
+      :exclude_sti_subclasses, :ignore_unknown_models, :with_comment
+    ].freeze
+
+    OTHER_OPTIONS = [
+      :additional_file_patterns, :ignore_columns, :skip_on_db_migrate, :wrapper_open, :wrapper_close,
+      :wrapper, :routes, :models, :hide_limit_column_types, :hide_default_column_types,
+      :ignore_routes, :active_admin
+    ].freeze
+
+    PATH_OPTIONS = [
+      :require, :model_dir, :root_dir
+    ].freeze
+
+    ALL_ANNOTATE_OPTIONS = [
+      POSITION_OPTIONS, FLAG_OPTIONS, OTHER_OPTIONS, PATH_OPTIONS
+    ].freeze
+  end
+end