magic_comments_extractor.rb

module AnnotateRoutes
  # namespace to contain module function to extract magic comments
  module MagicCommentsExtractor
    MAGIC_COMMENT_MATCHER = Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/).freeze

    class << self
      # @param [Array<String>] content
      # @return [Array<String>] all found magic comments
      # @return [Array<String>] content without magic comments
      def execute(content_array)
        magic_comments = []
        new_content = []

        content_array.each do |row|
          if row =~ MAGIC_COMMENT_MATCHER
            magic_comments << row.strip
          else
            new_content << row
          end
        end

        [magic_comments, new_content]
      end
    end
  end
end