Contents

# 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

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
annotaterb-4.3.1	lib/annotate_rb/model_annotator/single_file_annotator.rb
annotaterb-4.3.0	lib/annotate_rb/model_annotator/single_file_annotator.rb
annotaterb-4.2.0	lib/annotate_rb/model_annotator/single_file_annotator.rb