annotaterb 4.0.0.beta.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ca3a25c118bfa3f5910e4fe455de3d9333c353d409f434cffde12694f87cff5
-  data.tar.gz: 417dcf943056ec0f44ba7eb973c3ad2dc99cb435315d41a13d1fc9f53bb87b9e
+  metadata.gz: af9f792c5cb7386482abff5b7fb151dd000785316e0849139795ce473d48d076
+  data.tar.gz: 3d96f0869c4fa6616570bd1e9d077c962e56f59be4437496fc0cd0e428b5f3e3
 SHA512:
-  metadata.gz: 2d34ca80e5686ef6cadfe0a2624aecd891fde3628653e68fa8b86613ac6382a4d7bdcf8e0c7504988dd653023be3d1190c5a072d46890b9c874ecaf1abbc20f7
-  data.tar.gz: 2ae8ca4a18c83437b379f7823291c094a87db9465742bf2c1c94c99fcfe1cb833f894367774a44ff2a9e7c8f41f9670f8baeedff1d5832bbbf2c49a6ced8ac80
+  metadata.gz: 8cf8cb1fe5183a9f814272173f8af849499789790a87c63fa15de25a561c249490c7fefc8605c69464298923c14d6349d29ece493ab35c22e37466a0707e27b1
+  data.tar.gz: 0e43bbc446a18dd28c08c68bda96e3acfe58b427e3d5d16f0836a713456629280dcc9eb67781013e1bf5a8c621cb3068b8e2058fb82267cc3a6e115805f64fad

data/README.md

@@ -1,8 +1,11 @@
 ## AnnotateRb
 ### forked from the [Annotate aka AnnotateModels gem](https://github.com/ctran/annotate_models)
 
+A Ruby Gem that adds annotations to your Rails models and route files.
+
 ----------
 [![CI](https://github.com/drwl/annotaterb/actions/workflows/ci.yml/badge.svg)](https://github.com/drwl/annotaterb/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/annotaterb.svg)](https://badge.fury.io/rb/annotaterb)
 
 Adds comments summarizing the model schema or routes in your:
 
@@ -57,8 +60,10 @@ $ bin/rails g annotate_rb:install
 This will copy a rake task into your Rails project's `lib/tasks` directory that will hook into the Rails project rake tasks, automatically running AnnotateRb after database migration rake tasks.
 
 ## Migrating from the annotate gem
+The old [annotate gem](https://github.com/ctran/annotate_models) relied on environment variables and hardcoded values in rake files for configuration. AnnotateRb is different. It reads from an optional configuration yml file and options from the CLI to function.
 
-Add steps for migrating from annotate gem.
+* Remove the following files `lib/tasks/annotate_models.rake`, `lib/tasks/annotate_models_migrate.rake`, `lib/tasks/annotate_routes.rake`.
+* Run the generator install command above.
 
 ## Usage
 
@@ -67,10 +72,95 @@ AnnotateRb has a CLI that you can use to add or remove annotations.
 ```sh
 # To show the CLI options
 $ bundle exec annotaterb 
+
+Usage: annotaterb [command] [options]
+
+Commands:
+    models [options]
+    routes [options]
+    help
+    version
+
+Options:
+    -v, --version                    Display the version..
+    -h, --help                       You're looking at it.
+
+Annotate model options:
+    Usage: annotaterb models [options]
+
+    -a, --active-admin               Annotate active_admin models
+        --show-migration             Include the migration version number in the annotation
+    -k, --show-foreign-keys          List the table's foreign key constraints in the annotation
+        --ck, --complete-foreign-keys
+                                     Complete foreign key names in the annotation
+    -i, --show-indexes               List the table's database indexes in the annotation
+    -s, --simple-indexes             Concat the column's related indexes in the annotation
+        --hide-limit-column-types VALUES
+                                     don't show limit for given column types, separated by commas (i.e., `integer,boolean,text`)
+        --hide-default-column-types VALUES
+                                     don't show default for given column types, separated by commas (i.e., `json,jsonb,hstore`)
+        --ignore-unknown-models      don't display warnings for bad model files
+    -I, --ignore-columns REGEX       don't annotate columns that match a given REGEX (i.e., `annotate -I '^(id|updated_at|created_at)'`
+        --with-comment               include database comments in model annotations
+
+Annotate routes options:
+    Usage: annotaterb routes [options]
+
+        --ignore-routes REGEX        don't annotate routes that match a given REGEX (i.e., `annotate -I '(mobile|resque|pghero)'`
+        --timestamp                  Include timestamp in (routes) annotation
+        --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
+        --wo, --wrapper-open STR     Annotation wrapper opening.
+        --wc, --wrapper-close STR    Annotation wrapper closing
+
+Command options:
+Additional options that work for annotating models and routes
+
+        --additional-file-patterns path1,path2,path3
+                                     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
+        --model-dir dir              Annotate model files stored in dir rather than app/models, separate multiple dirs with commas
+        --root-dir dir               Annotate files stored within root dir projects, separate multiple dirs with commas
+        --ignore-model-subdirects    Ignore subdirectories of the models directory
+        --sort                       Sort columns alphabetically, rather than in creation order
+        --classified-sort            Sort columns alphabetically, but first goes id, then the rest columns, then the timestamp columns and then the association columns
+    -R, --require path               Additional file to require before loading models, may be used multiple times
+    -e [tests,fixtures,factories,serializers],
+        --exclude                    Do not annotate fixtures, test files, factories, and/or serializers
+    -f [bare|rdoc|yard|markdown],    Render Schema Information as plain/RDoc/Yard/Markdown
+        --format
+    -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
+        --pc, --position-in-class [before|top|after|bottom]
+                                     Place the annotations at the top (before) or the bottom (after) of the model file
+        --pf, --position-in-factory [before|top|after|bottom]
+                                     Place the annotations at the top (before) or the bottom (after) of any factory files
+        --px, --position-in-fixture [before|top|after|bottom]
+                                     Place the annotations at the top (before) or the bottom (after) of any fixture files
+        --pt, --position-in-test [before|top|after|bottom]
+                                     Place the annotations at the top (before) or the bottom (after) of any test files
+        --pr, --position-in-routes [before|top|after|bottom]
+                                     Place the annotations at the top (before) or the bottom (after) of the routes.rb file
+        --ps, --position-in-serializer [before|top|after|bottom]
+                                     Place the annotations at the top (before) or the bottom (after) of the serializer files
+        --force                      Force new annotations even if there are no changes.
+        --debug                      Prints the options and outputs messages to make it easier to debug.
+        --frozen                     Do not allow to change annotations. Exits non-zero if there are going to be changes to files.
+        --trace                      If unable to annotate a file, print the full stack trace, not just the exception message.
 ```
 
 ## Configuration
 
+### Storing default options
+Previously in the [Annotate](https://github.com/ctran/annotate_models) you could pass options through the CLI or store them as environment variables. Annotaterb removes dependency on the environment variables and instead can read values from a `.annotaterb.yml` file stored in the Rails project root.
+
+```yml
+# .annotaterb.yml
+
+position: after
+```
+
+Annotaterb reads first from the configuration file, if it exists, then merges it with any options passed into the CLI.
 
 ### How to skip annotating a particular model
 If you want to always skip annotations on a particular model, add this string

data/VERSION

@@ -1 +1 @@
-4.0.0.beta.1
+4.0.0

data/lib/annotate_rb/parser.rb

@@ -78,7 +78,7 @@ module AnnotateRb
         # TODO: Should raise or alert user that multiple commands were selected but only 1 command will be ran
         @options[:command] = map[@commands.first]
       else # None
-        @options[:command] = nil
+        @options[:command] = map[:help]
       end
     end
 

data/lib/generators/annotate_rb/install/USAGE

@@ -0,0 +1,7 @@
+Description:
+    Generates a default configuration file and adds a rake task into
+    your Rails app's lib/tasks directory, that automatically
+    annotates models when you do a db:migrate in development mode.
+
+Example:
+    `rails generate annotate_rb:install`

data/lib/generators/annotate_rb/install/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'annotate_rb'
+
+module AnnotateRb
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_task
+        copy_file "annotate_rb.rake", "lib/tasks/annotate_rb.rake"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-26 00:00:00.000000000 Z
+date: 2023-05-03 00:00:00.000000000 Z
 dependencies: []
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.
@@ -63,9 +63,9 @@ files:
 - lib/annotate_rb/route_annotator/removal_processor.rb
 - lib/annotate_rb/runner.rb
 - lib/annotate_rb/tasks/annotate_models_migrate.rake
-- lib/generators/annotate_rb/USAGE
-- lib/generators/annotate_rb/install_generator.rb
-- lib/generators/annotate_rb/templates/auto_annotate_models.rake
+- lib/generators/annotate_rb/install/USAGE
+- lib/generators/annotate_rb/install/install_generator.rb
+- lib/generators/annotate_rb/install/templates/annotate_rb.rake
 homepage: https://github.com/drwl/annotaterb
 licenses:
 - BSD-2-Clause
@@ -85,9 +85,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.33
 signing_key:

data/lib/generators/annotate_rb/USAGE

@@ -1,4 +0,0 @@
-Add a .rake file that automatically annotates models when you do a db:migrate
-in development mode:
-
-    rails generate annotaterb:install

data/lib/generators/annotate_rb/install_generator.rb

@@ -1,15 +0,0 @@
-require 'annotate_rb'
-
-module AnnotateRb
-  module Generators
-    class InstallGenerator < Rails::Generators::Base
-      desc 'Copy annotaterb rakefiles for automatic annotation of models'
-      source_root File.expand_path('templates', __dir__)
-
-      def copy_tasks
-        # Copies the rake task into Rails project's lib/tasks directory
-        template 'auto_annotate_models.rake', 'lib/tasks/auto_annotate_models.rake'
-      end
-    end
-  end
-end