annotate 2.7.5 → 3.2.0

data/bin/annotate

@@ -14,203 +14,19 @@ end
 here = File.expand_path(File.dirname __FILE__)
 $LOAD_PATH << "#{here}/../lib"
 
-require 'optparse'
 require 'annotate'
-Annotate.bootstrap_rake
-
-has_set_position = {}
-target_action = :do_annotations
-positions = %w(before top after bottom)
-
-OptionParser.new do |opts|
-  opts.banner = 'Usage: annotate [options] [model_file]*'
-
-  opts.on('-d', '--delete', 'Remove annotations from all model files or the routes.rb file') do
-    target_action = :remove_annotations
-  end
-
-  opts.on('-p', '--position [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/route/serializer file(s)') do |p|
-    ENV['position'] = p
-    %w(position_in_class position_in_factory position_in_fixture position_in_test position_in_routes position_in_serializer).each do |key|
-      ENV[key] = p unless has_set_position[key]
-    end
-  end
-
-  opts.on('--pc', '--position-in-class [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of the model file') do |p|
-    ENV['position_in_class'] = p
-    has_set_position['position_in_class'] = true
-  end
-
-  opts.on('--pf', '--position-in-factory [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of any factory files') do |p|
-    ENV['position_in_factory'] = p
-    has_set_position['position_in_factory'] = true
-  end
-
-  opts.on('--px', '--position-in-fixture [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of any fixture files') do |p|
-    ENV['position_in_fixture'] = p
-    has_set_position['position_in_fixture'] = true
-  end
-
-  opts.on('--pt', '--position-in-test [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of any test files') do |p|
-    ENV['position_in_test'] = p
-    has_set_position['position_in_test'] = true
-  end
-
-  opts.on('--pr', '--position-in-routes [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of the routes.rb file') do |p|
-    ENV['position_in_routes'] = p
-    has_set_position['position_in_routes'] = true
-  end
-
-  opts.on('--ps', '--position-in-serializer [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of the serializer files') do |p|
-    ENV['position_in_serializer'] = p
-    has_set_position['position_in_serializer'] = true
-  end
-
-  opts.on('--w', '--wrapper STR', 'Wrap annotation with the text passed as parameter.',
-          'If --w option is used, the same text will be used as opening and closing') do |p|
-    ENV['wrapper'] = p
-  end
-
-  opts.on('--wo', '--wrapper-open STR', 'Annotation wrapper opening.') do |p|
-    ENV['wrapper_open'] = p
-  end
-
-  opts.on('--wc', '--wrapper-close STR', 'Annotation wrapper closing') do |p|
-    ENV['wrapper_close'] = p
-  end
-
-  opts.on('-r', '--routes', "Annotate routes.rb with the output of 'rake routes'") do
-    ENV['routes'] = 'true'
-  end
-
-  opts.on('-a', '--active-admin', 'Annotate active_admin models') do
-    ENV['active_admin'] = 'true'
-  end
-
-  opts.on('-v', '--version', 'Show the current version of this gem') do
-    puts "annotate v#{Annotate.version}"; exit
-  end
-
-  opts.on('-m', '--show-migration', 'Include the migration version number in the annotation') do
-    ENV['include_version'] = 'yes'
-  end
-
-  opts.on('-k', '--show-foreign-keys',
-          "List the table's foreign key constraints in the annotation") do
-    ENV['show_foreign_keys'] = 'yes'
-  end
+require 'annotate/parser'
 
-  opts.on('--ck',
-          '--complete-foreign-keys', 'Complete foreign key names in the annotation') do
-    ENV['show_foreign_keys'] = 'yes'
-    ENV['show_complete_foreign_keys'] = 'yes'
-  end
-
-  opts.on('-i', '--show-indexes',
-          "List the table's database indexes in the annotation") do
-    ENV['show_indexes'] = 'yes'
-  end
-
-  opts.on('-s', '--simple-indexes',
-          "Concat the column's related indexes in the annotation") do
-    ENV['simple_indexes'] = 'yes'
-  end
-
-  opts.on('--model-dir dir',
-          "Annotate model files stored in dir rather than app/models, separate multiple dirs with commas") do |dir|
-    ENV['model_dir'] = dir
-  end
-
-  opts.on('--root-dir dir',
-          "Annotate files stored within root dir projects, separate multiple dirs with commas") do |dir|
-    ENV['root_dir'] = dir
-  end
-
-  opts.on('--ignore-model-subdirects',
-          "Ignore subdirectories of the models directory") do |dir|
-    ENV['ignore_model_sub_dir'] = 'yes'
-  end
-
-  opts.on('--sort',
-          "Sort columns alphabetically, rather than in creation order") do |dir|
-    ENV['sort'] = 'yes'
-  end
-
-  opts.on('--classified-sort',
-          "Sort columns alphabetically, but first goes id, then the rest columns, then the timestamp columns and then the association columns") do |dir|
-    ENV['classified_sort'] = 'yes'
-  end
-
-  opts.on('-R', '--require path',
-          "Additional file to require before loading models, may be used multiple times") do |path|
-    if !ENV['require'].blank?
-      ENV['require'] = ENV['require'] + ",#{path}"
-    else
-      ENV['require'] = path
-    end
-  end
-
-  opts.on('-e', '--exclude [tests,fixtures,factories,serializers]', Array, "Do not annotate fixtures, test files, factories, and/or serializers") do |exclusions|
-    exclusions ||= %w(tests fixtures factories)
-    exclusions.each { |exclusion| ENV["exclude_#{exclusion}"] = 'yes' }
-  end
-
-  opts.on('-f', '--format [bare|rdoc|markdown]', %w(bare rdoc markdown), 'Render Schema Infomation as plain/RDoc/Markdown') do |fmt|
-    ENV["format_#{fmt}"] = 'yes'
-  end
-
-  opts.on('--force', 'Force new annotations even if there are no changes.') do |force|
-    ENV['force'] = 'yes'
-  end
-
-  opts.on('--frozen', 'Do not allow to change annotations. Exits non-zero if there are going to be changes to files.') do
-    ENV['frozen'] = 'yes'
-  end
-
-  opts.on('--timestamp', 'Include timestamp in (routes) annotation') do
-    ENV['timestamp'] = 'true'
-  end
-
-  opts.on('--trace', 'If unable to annotate a file, print the full stack trace, not just the exception message.') do |value|
-    ENV['trace'] = 'yes'
-  end
-
-  opts.on('-I', '--ignore-columns REGEX', "don't annotate columns that match a given REGEX (i.e., `annotate -I '^(id|updated_at|created_at)'`") do |regex|
-    ENV['ignore_columns'] = regex
-  end
-
-  opts.on('--ignore-routes REGEX', "don't annotate routes that match a given REGEX (i.e., `annotate -I '(mobile|resque|pghero)'`") do |regex|
-    ENV['ignore_routes'] = regex
-  end
-
-  opts.on('--hide-limit-column-types VALUES', "don't show limit for given column types, separated by commas (i.e., `integer,boolean,text`)") do |values|
-    ENV['hide_limit_column_types'] = "#{values}"
-  end
-
-  opts.on('--hide-default-column-types VALUES', "don't show default for given column types, separated by commas (i.e., `json,jsonb,hstore`)") do |values|
-    ENV['hide_default_column_types'] = "#{values}"
-  end
+Annotate.bootstrap_rake
 
-  opts.on('--ignore-unknown-models', "don't display warnings for bad model files") do |values|
-    ENV['ignore_unknown_models'] = 'true'
-  end
+options_result = Annotate::Parser.parse(ARGV)
 
-  opts.on('--with-comment', "include database comments in model annotations") do |values|
-    ENV['with_comment'] = 'true'
-  end
-end.parse!
+exit if options_result[:exit]
 
 options = Annotate.setup_options(
   is_rake: ENV['is_rake'] && !ENV['is_rake'].empty?
 )
-Annotate.eager_load(options) if Annotate.include_models?
+Annotate.eager_load(options) if Annotate::Helpers.include_models?
 
-AnnotateModels.send(target_action, options) if Annotate.include_models?
-AnnotateRoutes.send(target_action, options) if Annotate.include_routes?
+AnnotateModels.send(options_result[:target_action], options) if Annotate::Helpers.include_models?
+AnnotateRoutes.send(options_result[:target_action], options) if Annotate::Helpers.include_routes?

data/lib/annotate/annotate_models/file_patterns.rb

@@ -0,0 +1,127 @@
+module AnnotateModels
+  # This module provides module method to get file paths.
+  module FilePatterns
+    # Controller files
+    CONTROLLER_DIR       = File.join('app', 'controllers')
+
+    # Active admin registry files
+    ACTIVEADMIN_DIR      = File.join('app', 'admin')
+
+    # Helper files
+    HELPER_DIR           = File.join('app', 'helpers')
+
+    # File.join for windows reverse bar compat?
+    # I dont use windows, can`t test
+    UNIT_TEST_DIR        = File.join('test', 'unit')
+    MODEL_TEST_DIR       = File.join('test', 'models') # since rails 4.0
+    SPEC_MODEL_DIR       = File.join('spec', 'models')
+
+    FIXTURE_TEST_DIR     = File.join('test', 'fixtures')
+    FIXTURE_SPEC_DIR     = File.join('spec', 'fixtures')
+
+    # Other test files
+    CONTROLLER_TEST_DIR  = File.join('test', 'controllers')
+    CONTROLLER_SPEC_DIR  = File.join('spec', 'controllers')
+    REQUEST_SPEC_DIR     = File.join('spec', 'requests')
+    ROUTING_SPEC_DIR     = File.join('spec', 'routing')
+
+    # Object Daddy http://github.com/flogic/object_daddy/tree/master
+    EXEMPLARS_TEST_DIR   = File.join('test', 'exemplars')
+    EXEMPLARS_SPEC_DIR   = File.join('spec', 'exemplars')
+
+    # Machinist http://github.com/notahat/machinist
+    BLUEPRINTS_TEST_DIR  = File.join('test', 'blueprints')
+    BLUEPRINTS_SPEC_DIR  = File.join('spec', 'blueprints')
+
+    # Factory Bot https://github.com/thoughtbot/factory_bot
+    FACTORY_BOT_TEST_DIR = File.join('test', 'factories')
+    FACTORY_BOT_SPEC_DIR = File.join('spec', 'factories')
+
+    # Fabrication https://github.com/paulelliott/fabrication.git
+    FABRICATORS_TEST_DIR = File.join('test', 'fabricators')
+    FABRICATORS_SPEC_DIR = File.join('spec', 'fabricators')
+
+    # Serializers https://github.com/rails-api/active_model_serializers
+    SERIALIZERS_DIR      = File.join('app',  'serializers')
+    SERIALIZERS_TEST_DIR = File.join('test', 'serializers')
+    SERIALIZERS_SPEC_DIR = File.join('spec', 'serializers')
+
+    class << self
+      def generate(root_directory, pattern_type, options)
+        case pattern_type
+        when 'test'       then test_files(root_directory)
+        when 'fixture'    then fixture_files(root_directory)
+        when 'scaffold'   then scaffold_files(root_directory)
+        when 'factory'    then factory_files(root_directory)
+        when 'serializer' then serialize_files(root_directory)
+        when 'additional_file_patterns'
+          [options[:additional_file_patterns] || []].flatten
+        when 'controller'
+          [File.join(root_directory, CONTROLLER_DIR, '%PLURALIZED_MODEL_NAME%_controller.rb')]
+        when 'admin'
+          [
+            File.join(root_directory, ACTIVEADMIN_DIR, '%MODEL_NAME%.rb'),
+            File.join(root_directory, ACTIVEADMIN_DIR, '%PLURALIZED_MODEL_NAME%.rb')
+          ]
+        when 'helper'
+          [File.join(root_directory, HELPER_DIR, '%PLURALIZED_MODEL_NAME%_helper.rb')]
+        else
+          []
+        end
+      end
+
+      private
+
+      def test_files(root_directory)
+        [
+          File.join(root_directory, UNIT_TEST_DIR,  '%MODEL_NAME%_test.rb'),
+          File.join(root_directory, MODEL_TEST_DIR, '%MODEL_NAME%_test.rb'),
+          File.join(root_directory, SPEC_MODEL_DIR, '%MODEL_NAME%_spec.rb')
+        ]
+      end
+
+      def fixture_files(root_directory)
+        [
+          File.join(root_directory, FIXTURE_TEST_DIR, '%TABLE_NAME%.yml'),
+          File.join(root_directory, FIXTURE_SPEC_DIR, '%TABLE_NAME%.yml'),
+          File.join(root_directory, FIXTURE_TEST_DIR, '%PLURALIZED_MODEL_NAME%.yml'),
+          File.join(root_directory, FIXTURE_SPEC_DIR, '%PLURALIZED_MODEL_NAME%.yml')
+        ]
+      end
+
+      def scaffold_files(root_directory)
+        [
+          File.join(root_directory, CONTROLLER_TEST_DIR, '%PLURALIZED_MODEL_NAME%_controller_test.rb'),
+          File.join(root_directory, CONTROLLER_SPEC_DIR, '%PLURALIZED_MODEL_NAME%_controller_spec.rb'),
+          File.join(root_directory, REQUEST_SPEC_DIR,    '%PLURALIZED_MODEL_NAME%_spec.rb'),
+          File.join(root_directory, ROUTING_SPEC_DIR,    '%PLURALIZED_MODEL_NAME%_routing_spec.rb')
+        ]
+      end
+
+      def factory_files(root_directory)
+        [
+          File.join(root_directory, EXEMPLARS_TEST_DIR,   '%MODEL_NAME%_exemplar.rb'),
+          File.join(root_directory, EXEMPLARS_SPEC_DIR,   '%MODEL_NAME%_exemplar.rb'),
+          File.join(root_directory, BLUEPRINTS_TEST_DIR,  '%MODEL_NAME%_blueprint.rb'),
+          File.join(root_directory, BLUEPRINTS_SPEC_DIR,  '%MODEL_NAME%_blueprint.rb'),
+          File.join(root_directory, FACTORY_BOT_TEST_DIR, '%MODEL_NAME%_factory.rb'),    # (old style)
+          File.join(root_directory, FACTORY_BOT_SPEC_DIR, '%MODEL_NAME%_factory.rb'),    # (old style)
+          File.join(root_directory, FACTORY_BOT_TEST_DIR, '%TABLE_NAME%.rb'),            # (new style)
+          File.join(root_directory, FACTORY_BOT_SPEC_DIR, '%TABLE_NAME%.rb'),            # (new style)
+          File.join(root_directory, FACTORY_BOT_TEST_DIR, '%PLURALIZED_MODEL_NAME%.rb'), # (new style)
+          File.join(root_directory, FACTORY_BOT_SPEC_DIR, '%PLURALIZED_MODEL_NAME%.rb'), # (new style)
+          File.join(root_directory, FABRICATORS_TEST_DIR, '%MODEL_NAME%_fabricator.rb'),
+          File.join(root_directory, FABRICATORS_SPEC_DIR, '%MODEL_NAME%_fabricator.rb')
+        ]
+      end
+
+      def serialize_files(root_directory)
+        [
+          File.join(root_directory, SERIALIZERS_DIR,      '%MODEL_NAME%_serializer.rb'),
+          File.join(root_directory, SERIALIZERS_TEST_DIR, '%MODEL_NAME%_serializer_test.rb'),
+          File.join(root_directory, SERIALIZERS_SPEC_DIR, '%MODEL_NAME%_serializer_spec.rb')
+        ]
+      end
+    end
+  end
+end