annotaterb 4.1.1 → 4.2.0

data/lib/annotate_rb/model_annotator/model_files_getter.rb

@@ -20,19 +20,21 @@ module AnnotateRb
           options[:model_dir].each do |dir|
             Dir.chdir(dir) do
               list = if options[:ignore_model_sub_dir]
-                       Dir["*.rb"].map { |f| [dir, f] }
-                     else
-                       Dir["**/*.rb"].reject { |f| f["concerns/"] }.map { |f| [dir, f] }
-                     end
+                Dir["*.rb"].map { |f| [dir, f] }
+              else
+                Dir["**/*.rb"]
+                  .reject { |f| f["concerns/"] }
+                  .map { |f| [dir, f] }
+              end
               model_files.concat(list)
             end
           end
 
           model_files
         rescue SystemCallError
-          $stderr.puts "No models found in directory '#{options[:model_dir].join("', '")}'."
-          $stderr.puts "Either specify models on the command line, or use the --model-dir option."
-          $stderr.puts "Call 'annotaterb --help' for more info."
+          warn "No models found in directory '#{options[:model_dir].join("', '")}'."
+          warn "Either specify models on the command line, or use the --model-dir option."
+          warn "Call 'annotaterb --help' for more info."
           # exit 1 # TODO: Return exit code back to caller. Right now it messes up RSpec being able to run
         end
 
@@ -47,12 +49,12 @@ module AnnotateRb
             absolute_dir_path = File.expand_path(dir)
             specified_files
               .find_all { |file| file.start_with?(absolute_dir_path) }
-              .map { |file| [dir, file.sub("#{absolute_dir_path}/", '')] }
+              .map { |file| [dir, file.sub("#{absolute_dir_path}/", "")] }
           end
 
           if model_files.size != specified_files.size
-            $stderr.puts "The specified file could not be found in directory '#{options[:model_dir].join("', '")}'."
-            $stderr.puts "Call 'annotaterb --help' for more info."
+            warn "The specified file could not be found in directory '#{options[:model_dir].join("', '")}'."
+            warn "Call 'annotaterb --help' for more info."
             # exit 1 # TODO: Return exit code back to caller. Right now it messes up RSpec being able to run
           end
 

data/lib/annotate_rb/model_annotator/model_wrapper.rb

@@ -13,22 +13,23 @@ module AnnotateRb
 
       # Gets the columns of the ActiveRecord model, processes them, and then returns them.
       def columns
-        @columns ||= begin
-                       cols = raw_columns
-                       cols += translated_columns
-
-                       ignore_columns = @options[:ignore_columns]
-                       if ignore_columns
-                         cols = cols.reject do |col|
-                           col.name.match(/#{ignore_columns}/)
-                         end
-                       end
-
-                       cols = cols.sort_by(&:name) if @options[:sort]
-                       cols = classified_sort(cols) if @options[:classified_sort]
-
-                       cols
-                     end
+        @columns ||=
+          begin
+            cols = raw_columns
+            cols += translated_columns
+
+            ignore_columns = @options[:ignore_columns]
+            if ignore_columns
+              cols = cols.reject do |col|
+                col.name.match(/#{ignore_columns}/)
+              end
+            end
+
+            cols = cols.sort_by(&:name) if @options[:sort]
+            cols = classified_sort(cols) if @options[:classified_sort]
+
+            cols
+          end
       end
 
       def connection
@@ -75,19 +76,25 @@ module AnnotateRb
       # Calculates the max width of the schema for the model by looking at the columns, schema comments, with respect
       # to the options.
       def max_schema_info_width
-        cols = columns
-
-        if with_comments?
-          max_size = cols.map do |column|
-            column.name.size + (column.comment ? Helper.width(column.comment) : 0)
-          end.max || 0
-          max_size += 2
-        else
-          max_size = cols.map(&:name).map(&:size).max
-        end
-        max_size += @options[:format_rdoc] ? 5 : 1
+        @max_schema_info_width ||=
+          begin
+            cols = columns
+
+            if with_comments?
+              column_widths = cols.map do |column|
+                column.name.size + (column.comment ? Helper.width(column.comment) : 0)
+              end
 
-        max_size
+              max_size = column_widths.max || 0
+              max_size += 2
+            else
+              max_size = cols.map(&:name).map(&:size).max
+            end
+
+            max_size += @options[:format_rdoc] ? 5 : 1
+
+            max_size
+          end
       end
 
       def retrieve_indexes_from_table
@@ -98,12 +105,12 @@ module AnnotateRb
         return indexes if indexes.any? || !@klass.table_name_prefix
 
         # Try to search the table without prefix
-        table_name_without_prefix = table_name.to_s.sub(@klass.table_name_prefix, '')
+        table_name_without_prefix = table_name.to_s.sub(@klass.table_name_prefix, "")
         @klass.connection.indexes(table_name_without_prefix)
       end
 
       def with_comments?
-        @options[:with_comment] &&
+        @with_comments ||= @options[:with_comment] &&
           raw_columns.first.respond_to?(:comment) &&
           raw_columns.map(&:comment).any? { |comment| !comment.nil? }
       end
@@ -115,11 +122,11 @@ module AnnotateRb
         id = nil
 
         cols.each do |c|
-          if c.name.eql?('id')
+          if c.name.eql?("id")
             id = c
-          elsif c.name.eql?('created_at') || c.name.eql?('updated_at')
+          elsif c.name.eql?("created_at") || c.name.eql?("updated_at")
             timestamps << c
-          elsif c.name[-3, 3].eql?('_id')
+          elsif c.name[-3, 3].eql?("_id")
             associations << c
           else
             rest_cols << c
@@ -137,9 +144,9 @@ module AnnotateRb
         # eg. Model: Car, foreign column name: car_id
         foreign_column_name = [
           @klass.translation_class.to_s
-               .gsub('::Translation', '').gsub('::', '_')
-               .downcase,
-          '_id'
+            .gsub("::Translation", "").gsub("::", "_")
+            .downcase,
+          "_id"
         ].join.to_sym
 
         [
@@ -152,4 +159,4 @@ module AnnotateRb
       end
     end
   end
-end
+end

data/lib/annotate_rb/model_annotator/pattern_getter.rb

@@ -3,25 +3,157 @@
 module AnnotateRb
   module ModelAnnotator
     class PatternGetter
+      module FilePatterns
+        # Controller files
+        CONTROLLER_DIR = File.join("app", "controllers")
+
+        # Active admin registry files
+        ACTIVEADMIN_DIR = File.join("app", "admin")
+
+        # Helper files
+        HELPER_DIR = File.join("app", "helpers")
+
+        # File.join for windows reverse bar compat?
+        # I dont use windows, can`t test
+        UNIT_TEST_DIR = File.join("test", "unit")
+        MODEL_TEST_DIR = File.join("test", "models") # since rails 4.0
+        SPEC_MODEL_DIR = File.join("spec", "models")
+
+        FIXTURE_TEST_DIR = File.join("test", "fixtures")
+        FIXTURE_SPEC_DIR = File.join("spec", "fixtures")
+
+        # Other test files
+        CONTROLLER_TEST_DIR = File.join("test", "controllers")
+        CONTROLLER_SPEC_DIR = File.join("spec", "controllers")
+        REQUEST_SPEC_DIR = File.join("spec", "requests")
+        ROUTING_SPEC_DIR = File.join("spec", "routing")
+
+        # Object Daddy http://github.com/flogic/object_daddy/tree/master
+        EXEMPLARS_TEST_DIR = File.join("test", "exemplars")
+        EXEMPLARS_SPEC_DIR = File.join("spec", "exemplars")
+
+        # Machinist http://github.com/notahat/machinist
+        BLUEPRINTS_TEST_DIR = File.join("test", "blueprints")
+        BLUEPRINTS_SPEC_DIR = File.join("spec", "blueprints")
+
+        # Factory Bot https://github.com/thoughtbot/factory_bot
+        FACTORY_BOT_TEST_DIR = File.join("test", "factories")
+        FACTORY_BOT_SPEC_DIR = File.join("spec", "factories")
+
+        # Fabrication https://github.com/paulelliott/fabrication.git
+        FABRICATORS_TEST_DIR = File.join("test", "fabricators")
+        FABRICATORS_SPEC_DIR = File.join("spec", "fabricators")
+
+        # Serializers https://github.com/rails-api/active_model_serializers
+        SERIALIZERS_DIR = File.join("app", "serializers")
+        SERIALIZERS_TEST_DIR = File.join("test", "serializers")
+        SERIALIZERS_SPEC_DIR = File.join("spec", "serializers")
+      end
+
       class << self
         def call(options, pattern_types = [])
-          current_patterns = []
+          new(options, pattern_types).get
+        end
+      end
+
+      def initialize(options, pattern_types = [])
+        @options = options
+        @pattern_types = pattern_types
+      end
 
-          options[:root_dir].each do |root_directory|
-            Array(pattern_types).each do |pattern_type|
-              patterns = FilePatterns.generate(root_directory, pattern_type, options)
+      def get
+        current_patterns = []
 
-              current_patterns += if pattern_type.to_sym == :additional_file_patterns
-                                    patterns
-                                  else
-                                    patterns.map { |p| p.sub(/^[\/]*/, '') }
-                                  end
+        @options[:root_dir].each do |root_directory|
+          Array(@pattern_types).each do |pattern_type|
+            patterns = generate(root_directory, pattern_type)
+
+            current_patterns += if pattern_type.to_sym == :additional_file_patterns
+              patterns
+            else
+              patterns.map { |p| p.sub(/^\/*/, "") }
             end
           end
+        end
+
+        current_patterns
+      end
 
-          current_patterns
+      private
+
+      def generate(root_directory, pattern_type)
+        case pattern_type
+        when "test" then test_files(root_directory)
+        when "fixture" then fixture_files(root_directory)
+        when "scaffold" then scaffold_files(root_directory)
+        when "factory" then factory_files(root_directory)
+        when "serializer" then serialize_files(root_directory)
+        when "additional_file_patterns"
+          [@options[:additional_file_patterns] || []].flatten
+        when "controller"
+          [File.join(root_directory, FilePatterns::CONTROLLER_DIR, "%PLURALIZED_MODEL_NAME%_controller.rb")]
+        when "admin"
+          [
+            File.join(root_directory, FilePatterns::ACTIVEADMIN_DIR, "%MODEL_NAME%.rb"),
+            File.join(root_directory, FilePatterns::ACTIVEADMIN_DIR, "%PLURALIZED_MODEL_NAME%.rb")
+          ]
+        when "helper"
+          [File.join(root_directory, FilePatterns::HELPER_DIR, "%PLURALIZED_MODEL_NAME%_helper.rb")]
+        else
+          []
         end
       end
+
+      def test_files(root_directory)
+        [
+          File.join(root_directory, FilePatterns::UNIT_TEST_DIR, "%MODEL_NAME%_test.rb"),
+          File.join(root_directory, FilePatterns::MODEL_TEST_DIR, "%MODEL_NAME%_test.rb"),
+          File.join(root_directory, FilePatterns::SPEC_MODEL_DIR, "%MODEL_NAME%_spec.rb")
+        ]
+      end
+
+      def fixture_files(root_directory)
+        [
+          File.join(root_directory, FilePatterns::FIXTURE_TEST_DIR, "%TABLE_NAME%.yml"),
+          File.join(root_directory, FilePatterns::FIXTURE_SPEC_DIR, "%TABLE_NAME%.yml"),
+          File.join(root_directory, FilePatterns::FIXTURE_TEST_DIR, "%PLURALIZED_MODEL_NAME%.yml"),
+          File.join(root_directory, FilePatterns::FIXTURE_SPEC_DIR, "%PLURALIZED_MODEL_NAME%.yml")
+        ]
+      end
+
+      def scaffold_files(root_directory)
+        [
+          File.join(root_directory, FilePatterns::CONTROLLER_TEST_DIR, "%PLURALIZED_MODEL_NAME%_controller_test.rb"),
+          File.join(root_directory, FilePatterns::CONTROLLER_SPEC_DIR, "%PLURALIZED_MODEL_NAME%_controller_spec.rb"),
+          File.join(root_directory, FilePatterns::REQUEST_SPEC_DIR, "%PLURALIZED_MODEL_NAME%_spec.rb"),
+          File.join(root_directory, FilePatterns::ROUTING_SPEC_DIR, "%PLURALIZED_MODEL_NAME%_routing_spec.rb")
+        ]
+      end
+
+      def factory_files(root_directory)
+        [
+          File.join(root_directory, FilePatterns::EXEMPLARS_TEST_DIR, "%MODEL_NAME%_exemplar.rb"),
+          File.join(root_directory, FilePatterns::EXEMPLARS_SPEC_DIR, "%MODEL_NAME%_exemplar.rb"),
+          File.join(root_directory, FilePatterns::BLUEPRINTS_TEST_DIR, "%MODEL_NAME%_blueprint.rb"),
+          File.join(root_directory, FilePatterns::BLUEPRINTS_SPEC_DIR, "%MODEL_NAME%_blueprint.rb"),
+          File.join(root_directory, FilePatterns::FACTORY_BOT_TEST_DIR, "%MODEL_NAME%_factory.rb"), # (old style)
+          File.join(root_directory, FilePatterns::FACTORY_BOT_SPEC_DIR, "%MODEL_NAME%_factory.rb"), # (old style)
+          File.join(root_directory, FilePatterns::FACTORY_BOT_TEST_DIR, "%TABLE_NAME%.rb"), # (new style)
+          File.join(root_directory, FilePatterns::FACTORY_BOT_SPEC_DIR, "%TABLE_NAME%.rb"), # (new style)
+          File.join(root_directory, FilePatterns::FACTORY_BOT_TEST_DIR, "%PLURALIZED_MODEL_NAME%.rb"), # (new style)
+          File.join(root_directory, FilePatterns::FACTORY_BOT_SPEC_DIR, "%PLURALIZED_MODEL_NAME%.rb"), # (new style)
+          File.join(root_directory, FilePatterns::FABRICATORS_TEST_DIR, "%MODEL_NAME%_fabricator.rb"),
+          File.join(root_directory, FilePatterns::FABRICATORS_SPEC_DIR, "%MODEL_NAME%_fabricator.rb")
+        ]
+      end
+
+      def serialize_files(root_directory)
+        [
+          File.join(root_directory, FilePatterns::SERIALIZERS_DIR, "%MODEL_NAME%_serializer.rb"),
+          File.join(root_directory, FilePatterns::SERIALIZERS_TEST_DIR, "%MODEL_NAME%_serializer_test.rb"),
+          File.join(root_directory, FilePatterns::SERIALIZERS_SPEC_DIR, "%MODEL_NAME%_serializer_spec.rb")
+        ]
+      end
     end
   end
 end

data/lib/annotate_rb/model_annotator/project_annotation_remover.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    class ProjectAnnotationRemover
+      def initialize(options)
+        @options = options
+      end
+
+      def remove_annotations
+        project_model_files = model_files
+
+        removal_instructions = project_model_files.map do |path, filename|
+          file = File.join(path, filename)
+
+          if AnnotationDecider.new(file, @options).annotate?
+            _instructions = build_instructions_for_file(file)
+          end
+        end.flatten.compact
+
+        deannotated = removal_instructions.map do |instruction|
+          if SingleFileAnnotationRemover.call_with_instructions(instruction)
+            instruction.file
+          end
+        rescue => e
+          warn "Unable to process #{File.join(instruction.file)}: #{e.message}"
+          warn "\t" + e.backtrace.join("\n\t") if @options[:trace]
+        end.flatten.compact
+
+        if deannotated.empty?
+          puts "Model files unchanged."
+        else
+          puts "Removed annotations (#{deannotated.length}) from: #{deannotated.join(", ")}"
+        end
+      end
+
+      private
+
+      def build_instructions_for_file(file)
+        klass = ModelClassGetter.call(file, @options)
+
+        instructions = []
+
+        klass.reset_column_information
+        model_name = klass.name.underscore
+        table_name = klass.table_name
+
+        model_instruction = SingleFileRemoveAnnotationInstruction.new(file, @options)
+        instructions << model_instruction
+
+        related_files = RelatedFilesListBuilder.new(file, model_name, table_name, @options).build
+        related_file_instructions = related_files.map do |f, _position_key|
+          _instruction = SingleFileRemoveAnnotationInstruction.new(f, @options)
+        end
+        instructions.concat(related_file_instructions)
+
+        instructions
+      end
+
+      def model_files
+        @model_files ||= ModelFilesGetter.call(@options)
+      end
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/project_annotator.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    class ProjectAnnotator
+      def initialize(options)
+        @options = options
+      end
+
+      def annotate
+        project_model_files = model_files
+
+        annotation_instructions = project_model_files.map do |path, filename|
+          file = File.join(path, filename)
+
+          if AnnotationDecider.new(file, @options).annotate?
+            _instructions = build_instructions_for_file(file)
+          end
+        end.flatten.compact
+
+        annotated = annotation_instructions.map do |instruction|
+          if SingleFileAnnotator.call_with_instructions(instruction)
+            instruction.file
+          end
+        end.compact
+
+        if annotated.empty?
+          puts "Model files unchanged."
+        else
+          puts "Annotated (#{annotated.length}): #{annotated.join(", ")}"
+        end
+      end
+
+      private
+
+      def build_instructions_for_file(file)
+        klass = ModelClassGetter.call(file, @options)
+
+        instructions = []
+
+        klass.reset_column_information
+        annotation = AnnotationBuilder.new(klass, @options).build
+        model_name = klass.name.underscore
+        table_name = klass.table_name
+
+        model_instruction = SingleFileAnnotatorInstruction.new(file, annotation, :position_in_class, @options)
+        instructions << model_instruction
+
+        related_files = RelatedFilesListBuilder.new(file, model_name, table_name, @options).build
+        related_file_instructions = related_files.map do |f, position_key|
+          _instruction = SingleFileAnnotatorInstruction.new(f, annotation, position_key, @options)
+        end
+        instructions.concat(related_file_instructions)
+
+        instructions
+      end
+
+      def model_files
+        @model_files ||= ModelFilesGetter.call(@options)
+      end
+    end
+  end
+end

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