Add annotations to helpers

Author: djsegal

lib/annotate.rb

@@ -27,7 +27,7 @@ module Annotate
     :exclude_fixtures, :exclude_factories, :ignore_model_sub_dir,
     :format_bare, :format_rdoc, :format_markdown, :sort, :force, :trace,
     :timestamp, :exclude_serializers, :classified_sort, :show_foreign_keys,
-    :exclude_scaffolds, :exclude_controllers
+    :exclude_scaffolds, :exclude_controllers, :exclude_helpers
   ]
   OTHER_OPTIONS=[
     :ignore_columns, :skip_on_db_migrate, :wrapper_open, :wrapper_close, :wrapper

lib/annotate/annotate_models.rb

@@ -9,7 +9,7 @@ module AnnotateModels
   END_MARK         = "== Schema Information End"
   PATTERN          = /^\r?\n?# (?:#{COMPAT_PREFIX}|#{COMPAT_PREFIX_MD}).*?\r?\n(#.*\r?\n)*(\r?\n)*/
 
-  MATCHED_TYPES = %w(test fixture factory serializer scaffold controller)
+  MATCHED_TYPES = %w(test fixture factory serializer scaffold controller helper)
 
   # File.join for windows reverse bar compat?
   # I dont use windows, can`t test
@@ -49,6 +49,9 @@ module AnnotateModels
   # Controller files
   CONTROLLER_DIR        = File.join("app", "controllers")
 
+  # Helper files
+  HELPER_DIR        = File.join("app", "helpers")
+
   # Don't show limit (#) on these column types
   # Example: show "integer" instead of "integer(4)"
   NO_LIMIT_COL_TYPES = ["integer", "boolean"]
@@ -118,6 +121,10 @@ def get_patterns(pattern_types=MATCHED_TYPES)
             [
               File.join(root_directory, CONTROLLER_DIR,  "%PLURALIZED_MODEL_NAME%_controller.rb")
             ]
+          when 'helper'
+            [
+              File.join(root_directory, HELPER_DIR,  "%PLURALIZED_MODEL_NAME%_helper.rb")
+            ]
           end
         end
       end
@@ -389,6 +396,7 @@ def remove_annotation_of_file(file_name)
     #  :exclude_serializers<Symbol>:: whether to skip modification of serializer files
     #  :exclude_scaffolds<Symbol>:: whether to skip modification of scaffold files
     #  :exclude_controllers<Symbol>:: whether to skip modification of controller files
+    #  :exclude_helpers<Symbol>:: whether to skip modification of helper files
     #
     def annotate(klass, file, header, options={})
       begin

lib/generators/annotate/templates/auto_annotate_models.rake

@@ -25,6 +25,7 @@ if Rails.env.development?
       'exclude_serializers'     => 'false',
       'exclude_scaffolds'       => 'false',
       'exclude_controllers'     => 'false',
+      'exclude_helpers'         => 'false',
       'ignore_model_sub_dir'    => 'false',
       'ignore_columns'          => nil,
       'skip_on_db_migrate'      => 'false',

lib/tasks/annotate_models.rake

@@ -30,6 +30,7 @@ task :annotate_models => :environment do
   options[:exclude_serializers] = Annotate.true?(ENV['exclude_serializers'])
   options[:exclude_scaffolds] = Annotate.true?(ENV['exclude_scaffolds'])
   options[:exclude_controllers] = Annotate.true?(ENV['exclude_controllers'])
+  options[:exclude_helpers] = Annotate.true?(ENV['exclude_helpers'])
   options[:ignore_model_sub_dir] = Annotate.true?(ENV['ignore_model_sub_dir'])
   options[:format_bare] = Annotate.true?(ENV['format_bare'])
   options[:format_rdoc] = Annotate.true?(ENV['format_rdoc'])