annotate 3.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e4ee3c38fb2ebf3d88712e8836f00570e891cd1a43a6c2bc32c95dc35b7a0d2
-  data.tar.gz: 1082be239480425543d84491e8c03d54ad99b362cc142b93224517499d4417fa
+  metadata.gz: 1ed01c42404ffa9b87f256ce671d68a47065b6dc6880bf2e351a2ca94bc01e24
+  data.tar.gz: 62fa4fa3174f2a32b3d045d50ab3be26ff4647053c3e455f2fce70e8d4f8e24e
 SHA512:
-  metadata.gz: 4896d07fc9b6d6b95d5916e566cc0d9a304cd16c1592ac0a0546bb273d533c7dfb275c55b2833586e677027e7f34f6a4f38281053e6e454553be527f4e23055c
-  data.tar.gz: c72e8ba788014600e40ba24fe7385b9c6c10c08d293ee98bd71e0d91cc235c1a14242293ae963c9265c8e318fa09a104e60547a24c7697218b06be68f320fa63
+  metadata.gz: ec228f10fb750acdc34f8708385daa5943e0cda4ebe1f59633d67c29b906ff70e13880c800b5e8778d242007cec75e123e67969cdc61e6a2c84af9c2122d1613
+  data.tar.gz: 492a844a0e1be69e77a689c79e3b5896d187813b02be71c0a16d8666dedc29aabae91387f0c0031b103338dbaae0ee4dac3cf2d13e7aecee3ba1bfae865b9fd6

data/CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+== 3.0.2
+* Fixes `LoadError` due to gemspec not referencing `parser.rb`, issue #657 (#660)
+* Changes `--additional_file_patterns` to use dashes `--additional-file-patterns` for consistency (#649)
+* Refactor: moving constants into `constants.rb` (#653)
+
+== 3.0.1
+* Skipped as an official release, used the 3.0.1 patch for setting up Github Actions (#619)
+
 == 3.0.0
 * Added `--models` CLI option fixing issue #563 (#647)
 * Added `--additional_file_patterns` option for additional file patterns (#633) #636) #637)

data/README.rdoc

@@ -163,7 +163,7 @@ you can do so with a simple environment variable, instead of editing the
 == Options
 
     Usage: annotate [options] [model_file]*
-            --additional_file_patterns   Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)
+            --additional-file-patterns   Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)
         -d, --delete                     Remove annotations from all model files or the routes.rb file
         -p [before|top|after|bottom],    Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/route/serializer file(s)
             --position
@@ -216,18 +216,18 @@ you can do so with a simple environment variable, instead of editing the
             --ignore-unknown-models      don't display warnings for bad model files
             --with-comment               include database comments in model annotations
 
-=== Option: +additional_file_patterns+
+=== Option: +additional-file-patterns+
 
-CLI: +--additional_file_patterns+<br>
-Ruby: +:additional_file_patterns+
+CLI: +--additional-file-patterns+<br>
+Ruby: +:additional-file-patterns+
 
 Provide additional paths for the gem to annotate.  These paths can include globs.
 It is recommended to use absolute paths.  Here are some examples:
 
 
-- <code>/app/lib/decorates/%MODEL_NAME%/&ast;.rb</code>
-- <code>/app/lib/forms/%PLURALIZED_MODEL_NAME%/&ast;&ast;/&ast;.rb</code>
-- <code>/app/lib/forms/%TABLE_NAME%/&ast;.rb</code>
+- <code>/app/lib/decorates/%MODEL_NAME%/*.rb</code>
+- <code>/app/lib/forms/%PLURALIZED_MODEL_NAME%/**/*.rb</code>
+- <code>/app/lib/forms/%TABLE_NAME%/*.rb</code>
 
 The appropriate model will be inferred using the <code>%*%</code> syntax, annotating any matching files.
 It works with existing filename resolutions (options for which can be found in the +resolve_filename+ method of

data/annotate.gemspec

@@ -26,6 +26,8 @@ Gem::Specification.new do |s|
     'lib/annotate/active_record_patch.rb',
     'lib/annotate/annotate_models.rb',
     'lib/annotate/annotate_routes.rb',
+    'lib/annotate/constants.rb',
+    'lib/annotate/parser.rb',
     'lib/annotate/tasks.rb',
     'lib/annotate/version.rb',
     'lib/generators/annotate/USAGE',

data/lib/annotate.rb

@@ -4,6 +4,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'annotate/version'
 require 'annotate/annotate_models'
 require 'annotate/annotate_routes'
+require 'annotate/constants'
 
 begin
   # ActiveSupport 3.x...
@@ -16,8 +17,6 @@ rescue StandardError
 end
 
 module Annotate
-  TRUE_RE = /^(true|t|yes|y|1)$/i
-
   ##
   # The set of available options to customize the behavior of Annotate.
   #
@@ -107,15 +106,15 @@ module Annotate
   end
 
   def self.skip_on_migration?
-    ENV['ANNOTATE_SKIP_ON_DB_MIGRATE'] =~ TRUE_RE || ENV['skip_on_db_migrate'] =~ TRUE_RE
+    ENV['ANNOTATE_SKIP_ON_DB_MIGRATE'] =~ Constants::TRUE_RE || ENV['skip_on_db_migrate'] =~ Constants::TRUE_RE
   end
 
   def self.include_routes?
-    ENV['routes'] =~ TRUE_RE
+    ENV['routes'] =~ Constants::TRUE_RE
   end
 
   def self.include_models?
-    ENV['models'] =~ TRUE_RE
+    ENV['models'] =~ Constants::TRUE_RE
   end
 
   def self.loaded_tasks=(val)
@@ -199,7 +198,7 @@ module Annotate
 
   def self.true?(val)
     return false if val.blank?
-    return false unless val =~ TRUE_RE
+    return false unless val =~ Constants::TRUE_RE
     true
   end
 end

data/lib/annotate/annotate_models.rb

@@ -2,9 +2,9 @@
 
 require 'bigdecimal'
 
-module AnnotateModels
-  TRUE_RE = /^(true|t|yes|y|1)$/i
+require 'annotate/constants'
 
+module AnnotateModels
   # Annotate Models plugin use this header
   COMPAT_PREFIX    = '== Schema Info'.freeze
   COMPAT_PREFIX_MD = '## Schema Info'.freeze
@@ -590,7 +590,7 @@ module AnnotateModels
 
     def matched_types(options)
       types = MATCHED_TYPES.dup
-      types << 'admin' if options[:active_admin] =~ TRUE_RE && !types.include?('admin')
+      types << 'admin' if options[:active_admin] =~ Annotate::Constants::TRUE_RE && !types.include?('admin')
       types << 'additional_file_patterns' if options[:additional_file_patterns].present?
 
       types

data/lib/annotate/constants.rb

@@ -0,0 +1,5 @@
+module Annotate
+  module Constants
+    TRUE_RE = /^(true|t|yes|y|1)$/i.freeze
+  end
+end

data/lib/annotate/parser.rb

@@ -0,0 +1,251 @@
+require 'optparse'
+
+module Annotate
+  # Class for handling command line arguments
+  class Parser # rubocop:disable Metrics/ClassLength
+    def self.parse(args, env = {})
+      new(args, env).parse
+    end
+
+    attr_reader :args, :options, :env
+
+    ANNOTATION_POSITIONS = %w[before top after bottom].freeze
+    FILE_TYPE_POSITIONS = %w[position_in_class position_in_factory position_in_fixture position_in_test position_in_routes position_in_serializer].freeze
+    EXCLUSION_LIST = %w[tests fixtures factories serializers].freeze
+    FORMAT_TYPES = %w[bare rdoc markdown].freeze
+
+    def initialize(args, env)
+      @args = args
+      @options = default_options
+      @env = env
+    end
+
+    def parse
+      # To split up because right now this method parses and commits
+      parser.parse!(args)
+
+      commit
+
+      options
+    end
+
+    private
+
+    def commit
+      env.each_pair do |key, value|
+        ENV[key] = value
+      end
+    end
+
+    def parser
+      OptionParser.new do |option_parser|
+        add_options_to_parser(option_parser)
+      end
+    end
+
+    def add_options_to_parser(option_parser) # rubocop:disable Metrics/MethodLength
+      has_set_position = {}
+      positions = ANNOTATION_POSITIONS
+
+      option_parser.banner = 'Usage: annotate [options] [model_file]*'
+
+      option_parser.on('--additional-file-patterns path1,path2,path3', Array, "Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)") do |additional_file_patterns|
+        ENV['additional_file_patterns'] = additional_file_patterns
+      end
+
+      option_parser.on('-d', '--delete', 'Remove annotations from all model files or the routes.rb file') do
+        @options[:target_action] = :remove_annotations
+      end
+
+      option_parser.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
+
+        FILE_TYPE_POSITIONS.each do |key|
+          env[key] = p unless has_set_position[key]
+        end
+      end
+
+      option_parser.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
+
+      option_parser.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
+
+      option_parser.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
+
+      option_parser.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
+
+      option_parser.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
+
+      option_parser.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
+
+      option_parser.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
+
+      option_parser.on('--wo', '--wrapper-open STR', 'Annotation wrapper opening.') do |p|
+        env['wrapper_open'] = p
+      end
+
+      option_parser.on('--wc', '--wrapper-close STR', 'Annotation wrapper closing') do |p|
+        env['wrapper_close'] = p
+      end
+
+      option_parser.on('-r', '--routes', "Annotate routes.rb with the output of 'rake routes'") do
+        env['routes'] = 'true'
+      end
+
+      option_parser.on('--models', "Annotate ActiveRecord models") do
+        env['models'] = 'true'
+      end
+
+      option_parser.on('-a', '--active-admin', 'Annotate active_admin models') do
+        env['active_admin'] = 'true'
+      end
+
+      option_parser.on('-v', '--version', 'Show the current version of this gem') do
+        puts "annotate v#{Annotate.version}"
+        @options[:exit] = true
+      end
+
+      option_parser.on('-m', '--show-migration', 'Include the migration version number in the annotation') do
+        env['include_version'] = 'yes'
+      end
+
+      option_parser.on('-k', '--show-foreign-keys',
+                       "List the table's foreign key constraints in the annotation") do
+        env['show_foreign_keys'] = 'yes'
+      end
+
+      option_parser.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
+
+      option_parser.on('-i', '--show-indexes',
+                       "List the table's database indexes in the annotation") do
+        env['show_indexes'] = 'yes'
+      end
+
+      option_parser.on('-s', '--simple-indexes',
+                       "Concat the column's related indexes in the annotation") do
+        env['simple_indexes'] = 'yes'
+      end
+
+      option_parser.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
+
+      option_parser.on('--root-dir dir',
+                       "Annotate files stored within root dir projects, separate multiple dirs with commas") do |dir|
+        env['root_dir'] = dir
+      end
+
+      option_parser.on('--ignore-model-subdirects',
+                       "Ignore subdirectories of the models directory") do |_dir|
+        env['ignore_model_sub_dir'] = 'yes'
+      end
+
+      option_parser.on('--sort',
+                       "Sort columns alphabetically, rather than in creation order") do |_dir|
+        env['sort'] = 'yes'
+      end
+
+      option_parser.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
+
+      option_parser.on('-R', '--require path',
+                       "Additional file to require before loading models, may be used multiple times") do |path|
+        env['require'] = if !env['require'].blank?
+                           env['require'] + ",#{path}"
+                         else
+                           path
+                         end
+      end
+
+      option_parser.on('-e', '--exclude [tests,fixtures,factories,serializers]', Array, "Do not annotate fixtures, test files, factories, and/or serializers") do |exclusions|
+        exclusions ||= EXCLUSION_LIST
+        exclusions.each { |exclusion| env["exclude_#{exclusion}"] = 'yes' }
+      end
+
+      option_parser.on('-f', '--format [bare|rdoc|markdown]', FORMAT_TYPES, 'Render Schema Infomation as plain/RDoc/Markdown') do |fmt|
+        env["format_#{fmt}"] = 'yes'
+      end
+
+      option_parser.on('--force', 'Force new annotations even if there are no changes.') do |_force|
+        env['force'] = 'yes'
+      end
+
+      option_parser.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
+
+      option_parser.on('--timestamp', 'Include timestamp in (routes) annotation') do
+        env['timestamp'] = 'true'
+      end
+
+      option_parser.on('--trace', 'If unable to annotate a file, print the full stack trace, not just the exception message.') do |_value|
+        env['trace'] = 'yes'
+      end
+
+      option_parser.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
+
+      option_parser.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
+
+      option_parser.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.to_s
+      end
+
+      option_parser.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.to_s
+      end
+
+      option_parser.on('--ignore-unknown-models', "don't display warnings for bad model files") do |_values|
+        env['ignore_unknown_models'] = 'true'
+      end
+
+      option_parser.on('--with-comment', "include database comments in model annotations") do |_values|
+        env['with_comment'] = 'true'
+      end
+    end
+
+    def default_options
+      {
+        target_action: :do_annotations,
+        exit: false
+      }
+    end
+  end
+end

data/lib/annotate/version.rb

@@ -1,5 +1,5 @@
 module Annotate
   def self.version
-    '3.0.0'
+    '3.0.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotate
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.2
 platform: ruby
 authors:
 - Alex Chaffee
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2019-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -81,6 +81,8 @@ files:
 - lib/annotate/active_record_patch.rb
 - lib/annotate/annotate_models.rb
 - lib/annotate/annotate_routes.rb
+- lib/annotate/constants.rb
+- lib/annotate/parser.rb
 - lib/annotate/tasks.rb
 - lib/annotate/version.rb
 - lib/generators/annotate/USAGE