annotate_routes.rb

# == Annotate Routes
#
# Based on:
#
#
#
# Prepends the output of "rake routes" to the top of your routes.rb file.
# Yes, it's simple but I'm thick and often need a reminder of what my routes
# mean.
#
# Running this task will replace any existing route comment generated by the
# task. Best to back up your routes file before running:
#
# Author:
#  Gavin Montague
#  gavin@leftbrained.co.uk
#
# Released under the same license as Ruby. No Support. No Warranty.
#

require_relative './annotate_routes/annotation_processor'
require_relative './annotate_routes/removal_processor'

# This module provides methods for annotating config/routes.rb.
module AnnotateRoutes
  class << self
    # @param options [Hash]
    # @return [String]
    def do_annotations(options = {})
      routes_file = File.join('config', 'routes.rb')
      AnnotationProcessor.execute(options, routes_file).tap do |result|
        puts result
      end
    end

    # @param options [Hash]
    # @return [String]
    def remove_annotations(options = {})
      routes_file = File.join('config', 'routes.rb')
      RemovalProcessor.execute(options, routes_file).tap do |result|
        puts result
      end
    end
  end
end