Use refactor from ctran/annotate_models#793

Author: drwl

lib/annotate_rb/route_annotator.rb

@@ -5,5 +5,8 @@ module RouteAnnotator
     autoload :Annotator, 'annotate_rb/route_annotator/annotator'
     autoload :Helper, 'annotate_rb/route_annotator/helper'
     autoload :HeaderGenerator, 'annotate_rb/route_annotator/header_generator'
+    autoload :BaseProcessor, 'annotate_rb/route_annotator/base_processor'
+    autoload :AnnotationProcessor, 'annotate_rb/route_annotator/annotation_processor'
+    autoload :RemovalProcessor, 'annotate_rb/route_annotator/removal_processor'
   end
 end

lib/annotate_rb/route_annotator/annotation_processor.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# This module provides methods for annotating config/routes.rb.
+module AnnotateRb
+  module RouteAnnotator
+    # This class is abstract class of classes adding and removing annotation to config/routes.rb.
+    class AnnotationProcessor < BaseProcessor
+
+      # @return [String]
+      def execute
+        if routes_file_exist?
+          if update
+            "#{routes_file} was annotated."
+          else
+            "#{routes_file} was not changed."
+          end
+        else
+          "#{routes_file} could not be found."
+        end
+      end
+
+      private
+
+      def header
+        @header ||= HeaderGenerator.generate(options)
+      end
+
+      def generate_new_content_array(content, header_position)
+        magic_comments_map, content = Helper.extract_magic_comments_from_array(content)
+        if %w(before top).include?(options[:position_in_routes])
+          new_content_array = []
+          new_content_array += magic_comments_map
+          new_content_array << '' if magic_comments_map.any?
+          new_content_array += header
+          new_content_array << '' if content.first != ''
+          new_content_array += 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 header_position == :before && content.first == ''
+
+          new_content_array = magic_comments_map + content + header
+        end
+
+        # Make sure we end on a trailing newline.
+        new_content_array << '' unless new_content_array.last == ''
+
+        new_content_array
+      end
+    end
+  end
+end

lib/annotate_rb/route_annotator/annotator.rb

@@ -18,60 +18,17 @@ def initialize(options = {})
       end
 
       def add_annotations
-        if Helper.routes_file_exist?
-          existing_text = File.read(Helper.routes_file)
-          content, header_position = Helper.strip_annotations(existing_text)
-          new_content = annotate_routes(HeaderGenerator.generate(@options), content, header_position, @options)
-          new_text = new_content.join("\n")
-
-          if Helper.rewrite_contents(existing_text, new_text)
-            puts "#{Helper.routes_file} was annotated."
-          else
-            puts "#{Helper.routes_file} was not changed."
-          end
-        else
-          puts "#{Helper.routes_file} could not be found."
+        routes_file = File.join('config', 'routes.rb')
+        AnnotationProcessor.execute(@options, routes_file).tap do |result|
+          puts result
         end
       end
 
       def remove_annotations
-        if Helper.routes_file_exist?
-          existing_text = File.read(Helper.routes_file)
-          content, header_position = Helper.strip_annotations(existing_text)
-          new_content = Helper.strip_on_removal(content, header_position)
-          new_text = new_content.join("\n")
-          if Helper.rewrite_contents(existing_text, new_text)
-            puts "Annotations were removed from #{Helper.routes_file}."
-          else
-            puts "#{Helper.routes_file} was not changed (Annotation did not exist)."
-          end
-        else
-          puts "#{Helper.routes_file} could not be found."
-        end
-      end
-
-      def annotate_routes(header, content, header_position, options = {})
-        magic_comments_map, content = Helper.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 header_position == :before && content.first == ''
-
-          new_content = magic_comments_map + content + header
+        routes_file = File.join('config', 'routes.rb')
+        RemovalProcessor.execute(@options, routes_file).tap do |result|
+          puts result
         end
-
-        # Make sure we end on a trailing newline.
-        new_content << '' unless new_content.last == ''
-
-        new_content
       end
     end
   end

lib/annotate_rb/route_annotator/base_processor.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+# This module provides methods for annotating config/routes.rb.
+module AnnotateRb
+  module RouteAnnotator
+    # This class is abstract class of classes adding and removing annotation to config/routes.rb.
+    class BaseProcessor
+      class << self
+        # @param options [Hash]
+        # @param routes_file [String]
+        # @return [String]
+        def execute(options, routes_file)
+          new(options, routes_file).execute
+        end
+
+        private :new
+      end
+
+      def initialize(options, routes_file)
+        @options = options
+        @routes_file = routes_file
+      end
+
+      # @return [Boolean]
+      def update
+        if existing_text == new_text
+          false
+        else
+          write(new_text)
+          true
+        end
+      end
+
+      def routes_file_exist?
+        File.exist?(routes_file)
+      end
+
+      private
+
+      attr_reader :options, :routes_file
+
+      def generate_new_content_array(_content, _header_position)
+        raise NoMethodError
+      end
+
+      def existing_text
+        @existing_text ||= File.read(routes_file)
+      end
+
+      # @return [String]
+      def new_text
+        content, header_position = strip_annotations(existing_text)
+        new_content = generate_new_content_array(content, header_position)
+        new_content.join("\n")
+      end
+
+      def write(text)
+        File.open(routes_file, 'wb') { |f| f.puts(text) }
+      end
+
+      # 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
+
+      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

lib/annotate_rb/route_annotator/removal_processor.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# This module provides methods for annotating config/routes.rb.
+module AnnotateRb
+  module RouteAnnotator
+    # This class is abstract class of classes adding and removing annotation to config/routes.rb.
+    class RemovalProcessor < BaseProcessor
+      # @return [String]
+      def execute
+        if routes_file_exist?
+          if update
+            "Annotations were removed from #{routes_file}."
+          else
+            "#{routes_file} was not changed (Annotation did not exist)."
+          end
+        else
+          "#{routes_file} could not be found."
+        end
+      end
+
+      private
+
+      def generate_new_content_array(content, header_position)
+        if header_position == :before
+          content.shift while content.first == ''
+        elsif header_position == :after
+          content.pop while content.last == ''
+        end
+
+        # Make sure we end on a trailing newline.
+        content << '' unless content.last == ''
+
+        # 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
+  end
+end