Skip to content

Commit a0682a4

Browse files
committed
Merge pull request #299 from djsegal/develop
Annotate controllers and helpers
2 parents 7325e3c + e7c612b commit a0682a4

File tree

4 files changed

+22
-2
lines changed

4 files changed

+22
-2
lines changed

lib/annotate.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ module Annotate
2727
:exclude_fixtures, :exclude_factories, :ignore_model_sub_dir,
2828
:format_bare, :format_rdoc, :format_markdown, :sort, :force, :trace,
2929
:timestamp, :exclude_serializers, :classified_sort, :show_foreign_keys,
30-
:exclude_scaffolds
30+
:exclude_scaffolds, :exclude_controllers, :exclude_helpers
3131
]
3232
OTHER_OPTIONS=[
3333
:ignore_columns, :skip_on_db_migrate, :wrapper_open, :wrapper_close, :wrapper

lib/annotate/annotate_models.rb

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ module AnnotateModels
99
END_MARK = "== Schema Information End"
1010
PATTERN = /^\r?\n?# (?:#{COMPAT_PREFIX}|#{COMPAT_PREFIX_MD}).*?\r?\n(#.*\r?\n)*(\r?\n)*/
1111

12-
MATCHED_TYPES = %w(test fixture factory serializer scaffold)
12+
MATCHED_TYPES = %w(test fixture factory serializer scaffold controller helper)
1313

1414
# File.join for windows reverse bar compat?
1515
# I dont use windows, can`t test
@@ -46,6 +46,12 @@ module AnnotateModels
4646
SERIALIZERS_TEST_DIR = File.join("test", "serializers")
4747
SERIALIZERS_SPEC_DIR = File.join("spec", "serializers")
4848

49+
# Controller files
50+
CONTROLLER_DIR = File.join("app", "controllers")
51+
52+
# Helper files
53+
HELPER_DIR = File.join("app", "helpers")
54+
4955
# Don't show limit (#) on these column types
5056
# Example: show "integer" instead of "integer(4)"
5157
NO_LIMIT_COL_TYPES = ["integer", "boolean"]
@@ -111,6 +117,14 @@ def get_patterns(pattern_types=MATCHED_TYPES)
111117
File.join(root_directory, SERIALIZERS_TEST_DIR, "%MODEL_NAME%_serializer_spec.rb"),
112118
File.join(root_directory, SERIALIZERS_SPEC_DIR, "%MODEL_NAME%_serializer_spec.rb")
113119
]
120+
when 'controller'
121+
[
122+
File.join(root_directory, CONTROLLER_DIR, "%PLURALIZED_MODEL_NAME%_controller.rb")
123+
]
124+
when 'helper'
125+
[
126+
File.join(root_directory, HELPER_DIR, "%PLURALIZED_MODEL_NAME%_helper.rb")
127+
]
114128
end
115129
end
116130
end
@@ -381,6 +395,8 @@ def remove_annotation_of_file(file_name)
381395
# :exclude_factories<Symbol>:: whether to skip modification of factory files
382396
# :exclude_serializers<Symbol>:: whether to skip modification of serializer files
383397
# :exclude_scaffolds<Symbol>:: whether to skip modification of scaffold files
398+
# :exclude_controllers<Symbol>:: whether to skip modification of controller files
399+
# :exclude_helpers<Symbol>:: whether to skip modification of helper files
384400
#
385401
def annotate(klass, file, header, options={})
386402
begin

lib/generators/annotate/templates/auto_annotate_models.rake

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ if Rails.env.development?
2424
'exclude_factories' => 'false',
2525
'exclude_serializers' => 'false',
2626
'exclude_scaffolds' => 'false',
27+
'exclude_controllers' => 'false',
28+
'exclude_helpers' => 'false',
2729
'ignore_model_sub_dir' => 'false',
2830
'ignore_columns' => nil,
2931
'skip_on_db_migrate' => 'false',

lib/tasks/annotate_models.rake

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ task :annotate_models => :environment do
2929
options[:exclude_fixtures] = Annotate.true?(ENV['exclude_fixtures'])
3030
options[:exclude_serializers] = Annotate.true?(ENV['exclude_serializers'])
3131
options[:exclude_scaffolds] = Annotate.true?(ENV['exclude_scaffolds'])
32+
options[:exclude_controllers] = Annotate.true?(ENV['exclude_controllers'])
33+
options[:exclude_helpers] = Annotate.true?(ENV['exclude_helpers'])
3234
options[:ignore_model_sub_dir] = Annotate.true?(ENV['ignore_model_sub_dir'])
3335
options[:format_bare] = Annotate.true?(ENV['format_bare'])
3436
options[:format_rdoc] = Annotate.true?(ENV['format_rdoc'])

0 commit comments

Comments
 (0)