Annotate controllers for models: ctran#293

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_scaffolds, :exclude_controllers
   ]
   OTHER_OPTIONS=[
     :ignore_columns, :skip_on_db_migrate, :wrapper_open, :wrapper_close, :wrapper

lib/annotate/annotate_models.rb

@@ -44,6 +44,9 @@ module AnnotateModels
   SERIALIZERS_TEST_DIR  = File.join("test", "serializers")
   SERIALIZERS_SPEC_DIR  = File.join("spec", "serializers")
 
+  # Controller files
+  CONTROLLER_DIR        = File.join("app", "controllers")
+
   # Don't show limit (#) on these column types
   # Example: show "integer" instead of "integer(4)"
   NO_LIMIT_COL_TYPES = ["integer", "boolean"]
@@ -109,6 +112,10 @@ def get_patterns(pattern_types)
               File.join(root_directory, SERIALIZERS_TEST_DIR,  "%MODEL_NAME%_serializer_spec.rb"),
               File.join(root_directory, SERIALIZERS_SPEC_DIR,  "%MODEL_NAME%_serializer_spec.rb")
             ]
+          when 'controller'
+            [
+              File.join(root_directory, CONTROLLER_DIR,  "%PLURALIZED_MODEL_NAME%_controller.rb")
+            ]
           end
         end
       end
@@ -376,6 +383,7 @@ def remove_annotation_of_file(file_name)
     #  :exclude_factories<Symbol>:: whether to skip modification of factory files
     #  :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
     #
     def annotate(klass, file, header, options={})
       begin
@@ -389,7 +397,7 @@ def annotate(klass, file, header, options={})
           did_annotate = true
         end
 
-        %w(test fixture factory serializer scaffold).each do |key|
+        %w(test fixture factory serializer scaffold controller).each do |key|
           exclusion_key = "exclude_#{key.pluralize}".to_sym
           patterns_type = "#{key.downcase}"
           position_key = "position_in_#{key}".to_sym
@@ -544,7 +552,7 @@ def remove_annotations(options={})
             model_file_name = file
             deannotated_klass = true if(remove_annotation_of_file(model_file_name))
 
-            (get_patterns(%w[test scaffold fixture factory serializer])).
+            (get_patterns(%w[test scaffold fixture factory serializer controller])).
               map { |file| resolve_filename(file, model_name, table_name) }.
               each do |file|
                 if File.exist?(file)

lib/generators/annotate/templates/auto_annotate_models.rake

@@ -24,6 +24,7 @@ if Rails.env.development?
       'exclude_factories'       => 'false',
       'exclude_serializers'     => 'false',
       'exclude_scaffolds'       => 'false',
+      'exclude_controllers'     => 'true',
       'ignore_model_sub_dir'    => 'false',
       'skip_on_db_migrate'      => 'false',
       'format_bare'             => 'true',

lib/tasks/annotate_models.rake

@@ -29,6 +29,7 @@ task :annotate_models => :environment do
   options[:exclude_fixtures] = Annotate.true?(ENV['exclude_fixtures'])
   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[: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'])