Refactor AnnotatedFile classes (#91)

This PR does a small refactor to tidy up `AnnotatedFile::Generator` and
`AnnotatedFile::Updater`.

Author: drwl

lib/annotate_rb/model_annotator/annotated_file/generator.rb

@@ -17,6 +17,7 @@ def initialize(file_content, new_annotations, annotation_position, options)
           @parsed_file = FileParser::ParsedFile.new(@file_content, @new_annotations, options).parse
         end
 
+        # @return [String] Returns the annotated file content to be written back to a file
         def generate
           # Need to keep `.to_s` for now since the it can be either a String or Symbol
           annotation_write_position = @options[@annotation_position].to_s
@@ -33,33 +34,43 @@ def generate
           # We need to get class start and class end depending on the position
           parsed = FileParser::CustomParser.new(content_without_annotations, "", 0).tap(&:parse)
 
-          same_write_position = @parsed_file.has_annotations? && @parsed_file.annotation_position.to_s == annotation_write_position
+          _content = if %w[after bottom].include?(annotation_write_position)
+            content_annotated_after(parsed, content_without_annotations)
+          else
+            content_annotated_before(parsed, content_without_annotations, annotation_write_position)
+          end
+        end
+
+        private
+
+        def content_annotated_before(parsed, content_without_annotations, write_position)
+          same_write_position = @parsed_file.has_annotations? && @parsed_file.annotation_position.to_s == write_position
 
           # Could error if there's no class or module declaration
           _constant_name, line_number_before = parsed.starts.first
+
           content_with_annotations_written_before = []
           content_with_annotations_written_before << content_without_annotations.lines[0...line_number_before]
           content_with_annotations_written_before << $/ if @parsed_file.has_leading_whitespace? && same_write_position
           content_with_annotations_written_before << @new_wrapped_annotations.lines
           content_with_annotations_written_before << $/ if @parsed_file.has_trailing_whitespace? && same_write_position
           content_with_annotations_written_before << content_without_annotations.lines[line_number_before..]
 
+          content_with_annotations_written_before.join
+        end
+
+        def content_annotated_after(parsed, content_without_annotations)
           _constant_name, line_number_after = parsed.ends.last
+
           content_with_annotations_written_after = []
           content_with_annotations_written_after << content_without_annotations.lines[0..line_number_after]
           content_with_annotations_written_after << $/
           content_with_annotations_written_after << @new_wrapped_annotations.lines
           content_with_annotations_written_after << content_without_annotations.lines[(line_number_after + 1)..]
 
-          _content = if %w[after bottom].include?(annotation_write_position)
-            content_with_annotations_written_after.join
-          else
-            content_with_annotations_written_before.join
-          end
+          content_with_annotations_written_after.join
         end
 
-        private
-
         def wrapped_content(content)
           wrapper_open = if @options[:wrapper_open]
             "# #{@options[:wrapper_open]}\n"

lib/annotate_rb/model_annotator/annotated_file/updater.rb

@@ -14,6 +14,7 @@ def initialize(file_content, new_annotations, _annotation_position, options)
           @parsed_file = FileParser::ParsedFile.new(@file_content, @new_annotations, options).parse
         end
 
+        # @return [String] Returns the annotated file content to be written back to a file
         def update
           return "" if !@parsed_file.has_annotations?
 

lib/annotate_rb/model_annotator/single_file_annotation_remover.rb

@@ -18,12 +18,9 @@ def call(file_name, options = Options.from({}))
             warn "Unable to process #{file_name}: #{e.message}"
             warn "\t" + e.backtrace.join("\n\t") if @options[:trace]
             return false
-            # rescue FileParser::AnnotationFinder::NoAnnotationFound => _e
-            #   return false # False since there's no annotations to remove
           end
 
           return false if !parsed_file.has_annotations?
-
           return false if parsed_file.has_skip_string?
 
           updated_file_content = old_content.sub(parsed_file.annotations_with_whitespace, "")

lib/annotate_rb/model_annotator/single_file_annotator.rb

@@ -31,8 +31,6 @@ def call(file_name, annotation, annotation_position, options)
             warn "Unable to process #{file_name}: #{e.message}"
             warn "\t" + e.backtrace.join("\n\t") if @options[:trace]
             return false
-            # rescue FileParser::AnnotationFinder::NoAnnotationFound => _e
-            #   return false # False since there's no annotations to remove
           end
 
           return false if parsed_file.has_skip_string?