annotaterb 4.1.0 → 4.2.0

data/lib/annotate_rb/model_annotator/related_files_list_builder.rb

@@ -5,7 +5,7 @@ module AnnotateRb
     # Given a model file and options, this class will return a list of related files (e.g. fixture, controllers, etc)
     # to also annotate
     class RelatedFilesListBuilder
-      RELATED_TYPES = %w(test fixture factory serializer scaffold controller helper).freeze
+      RELATED_TYPES = %w[test fixture factory serializer scaffold controller helper].freeze
 
       def initialize(file, model_name, table_name, options)
         @file = file
@@ -35,17 +35,15 @@ module AnnotateRb
       def related_files_for_pattern(pattern_type)
         patterns = PatternGetter.call(@options, pattern_type)
 
-        _related_files = patterns
-                          .map { |f| FileNameResolver.call(f, @model_name, @table_name) }
-                          .map { |f| Dir.glob(f) }
-                          .flatten
-
-        _related_files
+        patterns
+          .map { |f| FileNameResolver.call(f, @model_name, @table_name) }
+          .map { |f| Dir.glob(f) }
+          .flatten
       end
 
       def add_related_test_files
         position_key = :position_in_test
-        pattern_type = 'test'
+        pattern_type = "test"
 
         related_files = related_files_for_pattern(pattern_type)
         files_with_position_key = related_files.map { |f| [f, position_key] }
@@ -55,7 +53,7 @@ module AnnotateRb
 
       def add_related_fixture_files
         position_key = :position_in_fixture
-        pattern_type = 'fixture'
+        pattern_type = "fixture"
 
         related_files = related_files_for_pattern(pattern_type)
         files_with_position_key = related_files.map { |f| [f, position_key] }
@@ -65,7 +63,7 @@ module AnnotateRb
 
       def add_related_factory_files
         position_key = :position_in_factory
-        pattern_type = 'factory'
+        pattern_type = "factory"
 
         related_files = related_files_for_pattern(pattern_type)
         files_with_position_key = related_files.map { |f| [f, position_key] }
@@ -75,7 +73,7 @@ module AnnotateRb
 
       def add_related_serializer_files
         position_key = :position_in_serializer
-        pattern_type = 'serializer'
+        pattern_type = "serializer"
 
         related_files = related_files_for_pattern(pattern_type)
         files_with_position_key = related_files.map { |f| [f, position_key] }
@@ -85,7 +83,7 @@ module AnnotateRb
 
       def add_related_scaffold_files
         position_key = :position_in_scaffold # Key does not exist
-        pattern_type = 'scaffold'
+        pattern_type = "scaffold"
 
         related_files = related_files_for_pattern(pattern_type)
         files_with_position_key = related_files.map { |f| [f, position_key] }
@@ -95,7 +93,7 @@ module AnnotateRb
 
       def add_related_controller_files
         position_key = :position_in_controller # Key does not exist
-        pattern_type = 'controller'
+        pattern_type = "controller"
 
         related_files = related_files_for_pattern(pattern_type)
         files_with_position_key = related_files.map { |f| [f, position_key] }
@@ -105,7 +103,7 @@ module AnnotateRb
 
       def add_related_helper_files
         position_key = :position_in_helper # Key does not exist
-        pattern_type = 'helper'
+        pattern_type = "helper"
 
         related_files = related_files_for_pattern(pattern_type)
         files_with_position_key = related_files.map { |f| [f, position_key] }
@@ -115,7 +113,7 @@ module AnnotateRb
 
       def add_related_admin_files
         position_key = :position_in_admin # Key does not exist
-        pattern_type = 'admin'
+        pattern_type = "admin"
 
         related_files = related_files_for_pattern(pattern_type)
         files_with_position_key = related_files.map { |f| [f, position_key] }
@@ -124,8 +122,8 @@ module AnnotateRb
       end
 
       def add_additional_file_patterns
-        position_key = :position_in_additional_file_patterns # Key does not exist
-        pattern_type = 'additional_file_patterns'
+        position_key = :position_in_additional_file_patterns
+        pattern_type = "additional_file_patterns"
 
         related_files = related_files_for_pattern(pattern_type)
         files_with_position_key = related_files.map { |f| [f, position_key] }
@@ -134,4 +132,4 @@ module AnnotateRb
       end
     end
   end
-end
+end

data/lib/annotate_rb/model_annotator/single_file_annotation_remover.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    class SingleFileAnnotationRemover
+      class << self
+        def call_with_instructions(instruction)
+          call(instruction.file, instruction.options)
+        end
+
+        def call(file_name, options = Options.from({}))
+          return false unless File.exist?(file_name)
+          old_content = File.read(file_name)
+
+          file_components = FileComponents.new(old_content, "", options)
+
+          return false if file_components.has_skip_string?
+          # TODO: Uncomment below after tests are fixed
+          # return false if !file_components.has_annotations?
+
+          wrapper_open = if options[:wrapper_open]
+            "# #{options[:wrapper_open]}\n"
+          else
+            ""
+          end
+
+          generated_pattern = AnnotationPatternGenerator.call(options)
+          updated_file_content = old_content.sub!(/(#{wrapper_open})?#{generated_pattern}/, "")
+
+          File.open(file_name, "wb") { |f| f.puts updated_file_content }
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/single_file_annotator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    class SingleFileAnnotator
+      class << self
+        def call_with_instructions(instruction)
+          call(instruction.file, instruction.annotation, instruction.position, instruction.options)
+        end
+
+        # Add a schema block to a file. If the file already contains
+        # a schema info block (a comment starting with "== Schema Information"),
+        # check if it matches the block that is already there. If so, leave it be.
+        # If not, remove the old info block and write a new one.
+        #
+        # == Returns:
+        # true or false depending on whether the file was modified.
+        #
+        # === Options (opts)
+        #  :force<Symbol>:: whether to update the file even if it doesn't seem to need it.
+        #  :position_in_*<Symbol>:: where to place the annotated section in fixture or model file,
+        #                           :before, :top, :after or :bottom. Default is :before.
+        #
+        def call(file_name, annotation, annotation_position, options = {})
+          return false unless File.exist?(file_name)
+          old_content = File.read(file_name)
+
+          file_components = FileComponents.new(old_content, annotation, options)
+          builder = FileBuilder.new(file_components, annotation, annotation_position, options)
+
+          return false if file_components.has_skip_string?
+          return false if !file_components.annotations_changed? && !options[:force]
+
+          abort "AnnotateRb error. #{file_name} needs to be updated, but annotaterb was run with `--frozen`." if options[:frozen]
+
+          updated_file_content = if !file_components.has_annotations? || options[:force]
+            builder.generate_content_with_new_annotations
+          else
+            builder.update_existing_annotations
+          end
+
+          File.open(file_name, "wb") { |f| f.puts updated_file_content }
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/{file_annotator_instruction.rb → single_file_annotator_instruction.rb}

@@ -2,8 +2,8 @@
 
 module AnnotateRb
   module ModelAnnotator
-    # A plain old Ruby object (PORO) that contains all necessary information for FileAnnotator
-    class FileAnnotatorInstruction
+    # A plain old Ruby object (PORO) that contains all necessary information for SingleFileAnnotator
+    class SingleFileAnnotatorInstruction
       def initialize(file, annotation, position, options = {})
         @file = file # Path to file
         @annotation = annotation # Annotation string

data/lib/annotate_rb/model_annotator/single_file_remove_annotation_instruction.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    # A plain old Ruby object (PORO) that contains all necessary information for SingleFileAnnotationRemover
+    class SingleFileRemoveAnnotationInstruction
+      def initialize(file, options = {})
+        @file = file # Path to file
+        @options = options
+      end
+
+      attr_reader :file, :options
+    end
+  end
+end

data/lib/annotate_rb/model_annotator.rb

@@ -2,29 +2,30 @@
 
 module AnnotateRb
   module ModelAnnotator
-    autoload :Annotator, 'annotate_rb/model_annotator/annotator'
-    autoload :Helper, 'annotate_rb/model_annotator/helper'
-    autoload :FilePatterns, 'annotate_rb/model_annotator/file_patterns'
-    autoload :Constants, 'annotate_rb/model_annotator/constants'
-    autoload :PatternGetter, 'annotate_rb/model_annotator/pattern_getter'
-    autoload :BadModelFileError, 'annotate_rb/model_annotator/bad_model_file_error'
-    autoload :FileNameResolver, 'annotate_rb/model_annotator/file_name_resolver'
-    autoload :FileAnnotationRemover, 'annotate_rb/model_annotator/file_annotation_remover'
-    autoload :AnnotationPatternGenerator, 'annotate_rb/model_annotator/annotation_pattern_generator'
-    autoload :ModelClassGetter, 'annotate_rb/model_annotator/model_class_getter'
-    autoload :ModelFilesGetter, 'annotate_rb/model_annotator/model_files_getter'
-    autoload :FileAnnotator, 'annotate_rb/model_annotator/file_annotator'
-    autoload :ModelFileAnnotator, 'annotate_rb/model_annotator/model_file_annotator'
-    autoload :ModelWrapper, 'annotate_rb/model_annotator/model_wrapper'
-    autoload :AnnotationGenerator, 'annotate_rb/model_annotator/annotation_generator'
-    autoload :ColumnAttributesBuilder, 'annotate_rb/model_annotator/column_attributes_builder'
-    autoload :ColumnTypeBuilder, 'annotate_rb/model_annotator/column_type_builder'
-    autoload :ColumnWrapper, 'annotate_rb/model_annotator/column_wrapper'
-    autoload :ColumnAnnotationBuilder, 'annotate_rb/model_annotator/column_annotation_builder'
-    autoload :IndexAnnotationBuilder, 'annotate_rb/model_annotator/index_annotation_builder'
-    autoload :ForeignKeyAnnotationBuilder, 'annotate_rb/model_annotator/foreign_key_annotation_builder'
-    autoload :RelatedFilesListBuilder, 'annotate_rb/model_annotator/related_files_list_builder'
-    autoload :AnnotationDecider, 'annotate_rb/model_annotator/annotation_decider'
-    autoload :FileAnnotatorInstruction, 'annotate_rb/model_annotator/file_annotator_instruction'
+    autoload :Annotator, "annotate_rb/model_annotator/annotator"
+    autoload :PatternGetter, "annotate_rb/model_annotator/pattern_getter"
+    autoload :BadModelFileError, "annotate_rb/model_annotator/bad_model_file_error"
+    autoload :FileNameResolver, "annotate_rb/model_annotator/file_name_resolver"
+    autoload :SingleFileAnnotationRemover, "annotate_rb/model_annotator/single_file_annotation_remover"
+    autoload :AnnotationPatternGenerator, "annotate_rb/model_annotator/annotation_pattern_generator"
+    autoload :ModelClassGetter, "annotate_rb/model_annotator/model_class_getter"
+    autoload :ModelFilesGetter, "annotate_rb/model_annotator/model_files_getter"
+    autoload :SingleFileAnnotator, "annotate_rb/model_annotator/single_file_annotator"
+    autoload :ModelWrapper, "annotate_rb/model_annotator/model_wrapper"
+    autoload :AnnotationBuilder, "annotate_rb/model_annotator/annotation_builder"
+    autoload :ColumnAnnotation, "annotate_rb/model_annotator/column_annotation"
+    autoload :IndexAnnotation, "annotate_rb/model_annotator/index_annotation"
+    autoload :ForeignKeyAnnotation, "annotate_rb/model_annotator/foreign_key_annotation"
+    autoload :RelatedFilesListBuilder, "annotate_rb/model_annotator/related_files_list_builder"
+    autoload :AnnotationDecider, "annotate_rb/model_annotator/annotation_decider"
+    autoload :SingleFileAnnotatorInstruction, "annotate_rb/model_annotator/single_file_annotator_instruction"
+    autoload :SingleFileRemoveAnnotationInstruction, "annotate_rb/model_annotator/single_file_remove_annotation_instruction"
+    autoload :AnnotationDiffGenerator, "annotate_rb/model_annotator/annotation_diff_generator"
+    autoload :AnnotationDiff, "annotate_rb/model_annotator/annotation_diff"
+    autoload :FileBuilder, "annotate_rb/model_annotator/file_builder"
+    autoload :MagicCommentParser, "annotate_rb/model_annotator/magic_comment_parser"
+    autoload :FileComponents, "annotate_rb/model_annotator/file_components"
+    autoload :ProjectAnnotator, "annotate_rb/model_annotator/project_annotator"
+    autoload :ProjectAnnotationRemover, "annotate_rb/model_annotator/project_annotation_remover"
   end
 end

data/lib/annotate_rb/options.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module AnnotateRb
   # Used to hold all of the options when annotating models and routes.
@@ -16,12 +16,13 @@ module AnnotateRb
 
     POSITION_OPTIONS = {
       position: nil, # ModelAnnotator, RouteAnnotator
+      position_in_additional_file_patterns: nil, # ModelAnnotator
       position_in_class: nil, # ModelAnnotator
-      position_in_factory: nil, # Unused
-      position_in_fixture: nil, # Unused
+      position_in_factory: nil, # ModelAnnotator
+      position_in_fixture: nil, # ModelAnnotator
       position_in_routes: nil, # RouteAnnotator
-      position_in_serializer: nil, # Unused
-      position_in_test: nil, # Unused
+      position_in_serializer: nil, # ModelAnnotator
+      position_in_test: nil # ModelAnnotator
     }.freeze
 
     FLAG_OPTIONS = {
@@ -50,7 +51,7 @@ module AnnotateRb
       sort: false, # ModelAnnotator
       timestamp: false, # RouteAnnotator
       trace: false, # ModelAnnotator, but is part of Core
-      with_comment: true, # ModelAnnotator
+      with_comment: true # ModelAnnotator
     }.freeze
 
     OTHER_OPTIONS = {
@@ -59,10 +60,10 @@ module AnnotateRb
       debug: false, # Core
 
       # ModelAnnotator
-      hide_default_column_types: '',
+      hide_default_column_types: "",
 
       # ModelAnnotator
-      hide_limit_column_types: '',
+      hide_limit_column_types: "",
 
       ignore_columns: nil, # ModelAnnotator
       ignore_routes: nil, # RouteAnnotator
@@ -73,26 +74,20 @@ module AnnotateRb
       target_action: :do_annotations, # Core; Possible values: :do_annotations, :remove_annotations
       wrapper: nil, # ModelAnnotator, RouteAnnotator
       wrapper_close: nil, # ModelAnnotator, RouteAnnotator
-      wrapper_open: nil, # ModelAnnotator, RouteAnnotator
+      wrapper_open: nil # ModelAnnotator, RouteAnnotator
     }.freeze
 
     PATH_OPTIONS = {
       additional_file_patterns: [], # ModelAnnotator
-      model_dir: ['app/models'], # ModelAnnotator
+      model_dir: ["app/models"], # ModelAnnotator
       require: [], # Core
-      root_dir: [''], # Core; Old model Annotate code depends on it being empty when not provided another value
+      root_dir: [""] # Core; Old model Annotate code depends on it being empty when not provided another value
       # `root_dir` can also be a string but should get converted into an array with that string as the sole element when
       # that happens.
     }.freeze
 
     DEFAULT_OPTIONS = {}.merge(POSITION_OPTIONS, FLAG_OPTIONS, OTHER_OPTIONS, PATH_OPTIONS).freeze
 
-    POSITION_OPTION_KEYS = [
-      :position,
-      :position_in_class,
-      :position_in_routes,
-    ].freeze
-
     FLAG_OPTION_KEYS = [
       :classified_sort,
       :exclude_controllers,
@@ -118,7 +113,7 @@ module AnnotateRb
       :sort,
       :timestamp,
       :trace,
-      :with_comment,
+      :with_comment
     ].freeze
 
     OTHER_OPTION_KEYS = [
@@ -136,21 +131,21 @@ module AnnotateRb
       :target_action,
       :wrapper,
       :wrapper_close,
-      :wrapper_open,
+      :wrapper_open
     ].freeze
 
     PATH_OPTION_KEYS = [
       :additional_file_patterns,
       :model_dir,
       :require,
-      :root_dir,
+      :root_dir
     ].freeze
 
     ALL_OPTION_KEYS = [
-      POSITION_OPTION_KEYS, FLAG_OPTION_KEYS, OTHER_OPTION_KEYS, PATH_OPTION_KEYS
+      POSITION_OPTIONS.keys, FLAG_OPTION_KEYS, OTHER_OPTION_KEYS, PATH_OPTION_KEYS
     ].flatten.freeze
 
-    POSITION_DEFAULT = 'before'
+    POSITION_DEFAULT = "before"
 
     # Want this to be read only after initializing
     def_delegator :@options, :[]
@@ -175,8 +170,8 @@ module AnnotateRb
       # 1) Use the value if it's defined
       # 2) Use value from :position if it's defined
       # 3) Use default
-      POSITION_OPTION_KEYS.each do |key|
-        @options[key] = ModelAnnotator::Helper.fallback(
+      POSITION_OPTIONS.keys.each do |key|
+        @options[key] = Helper.fallback(
           @options[key], @options[:position], POSITION_DEFAULT
         )
       end
@@ -184,7 +179,7 @@ module AnnotateRb
       # Unpack path options if we're passed in a String
       PATH_OPTION_KEYS.each do |key|
         if @options[key].is_a?(String)
-          @options[key] = @options[key].split(',').map(&:strip).reject(&:empty?)
+          @options[key] = @options[key].split(",").map(&:strip).reject(&:empty?)
         end
       end