annotated 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c85b0403da4d884cb9bcad2c582deea76061b27f6cc5698eb71412d6dcacf63e
-  data.tar.gz: 4deb819b9a5c8c6a17a5c8acf93f33d3a2c6d10c5c536a18503b81fdfbb03669
+  metadata.gz: 322fcfe312ecabf47905840164d0a358f1b55ceb1e501f209dcd4dd005be7f2d
+  data.tar.gz: b8b68c701826e8675387644ce445afd7dd0b2ad7ee820a9753e54ccbc329cedc
 SHA512:
-  metadata.gz: b1cd2a160906a20a2e3e5ff6d334424acd2dbcad7d22711995cd04981cc0395b1a4e463e2ddcfd1d0042dc21746462dee0bd4a0e6a94f3b113aabb574aae7c42
-  data.tar.gz: 187a89fca82c468eece48c5302686fcb7ea10b387a0ac62e8981cca0be073aa66119eeff593a5db6f42e4f03d391a4b6db26a91aec5672d8fe53e7cd540b74f7
+  metadata.gz: 4f8a6bc14a6879e94988861ef372efbb839919c35677ab40e13e20f59b2b0f56516de3b189ab651100fa193c6fc1eb07cefa0f53c0c582e3df1ccf71acafa430
+  data.tar.gz: def9e9b25d63cf4dbbc4a1a50777c5dd30296bf9842e5f91452249d459eeb3603fc1f7134649d77df2f0af5523f317ff653f708fe4b79a9cce452fbc27df2dcf

data/README.md

@@ -55,31 +55,6 @@ when using `SpatialAdapter`, `PostgisAdapter` or `PostGISAdapter`:
 
 Also, if you pass the `-r` option, it'll annotate `routes.rb` with the output of `rake routes`.
 
-
-## Upgrading to 3.X and annotate models not working?
-
-In versions 2.7.X the annotate gem defaulted to annotating models if no arguments were passed in.
-The annotate gem by default would not allow for routes and models to be annotated together.
-A [change was added in #647](https://github.com/ctran/annotate_models/pull/647).
-You [can read more here](https://github.com/ctran/annotate_models/issues/663).
-
-There are a few ways of fixing this:
-
-- If using CLI explicitly pass in models flag using `--models`
-
-OR
-
-a) Running `rails g annotate:install` will overwrite your defaults with the annotating `models` option set to `'true'`.
-
-b) In `lib/tasks/auto_annotate_models.rake` add the `models` key-value option:
-
-```ruby
-    Annotated.set_defaults(
-      ...
-      'models'                      => 'true',
-      ...
-```
-
 ## Install
 
 Into Gemfile from rubygems.org:
@@ -90,12 +65,10 @@ group :development do
 end
 ```
 
-Into Gemfile from Github:
+Or
 
 ```ruby
-group :development do
-  gem 'annotated', git: 'https://github.com/thedumbtechguy/annotated.git'
-end
+bundle add annotated --group=development
 ```
 
 Into environment gems from rubygems.org:
@@ -106,7 +79,7 @@ Into environment gems from rubygems.org:
 
 ## Usage
 
-(If you used the Gemfile install, prefix the below commands with `bundle exec`.)
+(If you installed globally (`gem install`), you can drop the `bundle exec` prefix)
 
 ### Usage in Rails
 

data/lib/annotated/active_record_patch.rb

@@ -5,5 +5,9 @@ module ::ActiveRecord
     def self.method_missing(_name, *_args)
       # ignore this, so unknown/unloaded macros won't cause parsing to fail
     end
+
+    def self.respond_to_missing?(_name, *_args)
+      true
+    end
   end
 end

data/lib/annotated/annotate_models.rb

@@ -43,10 +43,16 @@ module AnnotateModels
 
   class << self
     def annotate_pattern(options = {})
+      # The annotation body runs up to its closing bare "#" (or "#++" for rdoc) line,
+      # so comments placed directly below it (e.g. class docs) are left alone.
+      body = /(?:(?:#.*\R)*#(?:\+\+)?\R|(?:#.*\R)*)/
+      wrapper_close = options[:wrapper_close] ? /(?:# #{options[:wrapper_close]}.*\R)?/ : //
+      annotation = /\R?# (?:#{COMPAT_PREFIX}|#{COMPAT_PREFIX_MD}).*?\R#{body}#{wrapper_close}\R*/
+
       if options[:wrapper_open]
-        return /(?:^(\n|\r\n)?# (?:#{options[:wrapper_open]}).*(\n|\r\n)?# (?:#{COMPAT_PREFIX}|#{COMPAT_PREFIX_MD}).*?(\n|\r\n)(#.*(\n|\r\n))*(\n|\r\n)*)|^(\n|\r\n)?# (?:#{COMPAT_PREFIX}|#{COMPAT_PREFIX_MD}).*?(\n|\r\n)(#.*(\n|\r\n))*(\n|\r\n)*/
+        return /(?:^\R?# (?:#{options[:wrapper_open]}).*#{annotation})|^#{annotation}/
       end
-      /^(\n|\r\n)?# (?:#{COMPAT_PREFIX}|#{COMPAT_PREFIX_MD}).*?(\n|\r\n)(#.*(\n|\r\n))*(\n|\r\n)*/o
+      /^#{annotation}/
     end
 
     def model_dir
@@ -145,7 +151,14 @@ module AnnotateModels
       bare_type_allowance = 16
 
       if options[:format_markdown]
-        info << sprintf("# %-#{max_size + md_names_overhead}.#{max_size + md_names_overhead}s | %-#{md_type_allowance}.#{md_type_allowance}s | %s\n", "Name", "Type", "Attributes")
+        info << sprintf(
+          "# %-*.*s | %-*.*s | %s\n",
+          max_size + md_names_overhead, max_size + md_names_overhead,
+          "Name",
+          md_type_allowance, md_type_allowance,
+          "Type",
+          "Attributes"
+        )
 
         info << "# #{"-" * (max_size + md_names_overhead)} | #{"-" * md_type_allowance} | #{"-" * 27}\n"
       end
@@ -179,7 +192,12 @@ module AnnotateModels
         col_comment = cols_meta[col.name][:col_comment]
 
         if options[:format_rdoc]
-          info << sprintf("# %-#{max_size}.#{max_size}s<tt>%s</tt>", "*#{col_name}*::", attrs.unshift(col_type).join(", ")).rstrip + "\n"
+          info << sprintf(
+            "# %-*.*s<tt>%s</tt>",
+            max_size, max_size,
+            "*#{col_name}*::",
+            attrs.unshift(col_type).join(", ")
+          ).rstrip + "\n"
         elsif options[:format_yard]
           info << sprintf("# @!attribute #{col_name}") + "\n"
           ruby_class = (col.respond_to?(:array) && col.array) ? "Array<#{map_col_type_to_ruby_classes(col_type)}>" : map_col_type_to_ruby_classes(col_type)
@@ -187,7 +205,14 @@ module AnnotateModels
         elsif options[:format_markdown]
           name_remainder = max_size - col_name.length - non_ascii_length(col_name)
           type_remainder = (md_type_allowance - 2) - col_type.length
-          info << sprintf("# **`%s`**%#{name_remainder}s | `%s`%#{type_remainder}s | `%s`", col_name, " ", col_type, " ", attrs.join(", ").rstrip).gsub("``", "  ").rstrip + "\n"
+          info << sprintf(
+            "# **`%s`**%*s | `%s`%*s | `%s`",
+            col_name,
+            name_remainder, " ",
+            col_type,
+            type_remainder, " ",
+            attrs.join(", ").rstrip
+          ).gsub("``", "  ").rstrip + "\n"
         elsif with_comments_column
           info << format_default(col_name, max_size, col_type, bare_type_allowance, simple_formatted_attrs, bare_max_attrs_length, col_comment)
         else
@@ -314,7 +339,8 @@ module AnnotateModels
 
     def final_index_string(index, max_size)
       sprintf(
-        "#  %-#{max_size}.#{max_size}s %s%s%s%s",
+        "#  %-*.*s %s%s%s%s",
+        max_size, max_size,
         index.name,
         "(#{index_columns_info(index).join(",")})",
         index_unique_info(index),
@@ -374,7 +400,7 @@ module AnnotateModels
         fk_info << if options[:format_markdown]
           sprintf("# * `%s`%s:\n#     * **`%s`**\n", format_name.call(fk), constraints_info.blank? ? "" : " (_#{constraints_info}_)", ref_info)
         else
-          sprintf("#  %-#{max_size}.#{max_size}s %s %s", format_name.call(fk), "(#{ref_info})", constraints_info).rstrip + "\n"
+          sprintf("#  %-*.*s %s %s", max_size, max_size, format_name.call(fk), "(#{ref_info})", constraints_info).rstrip + "\n"
         end
       end
 
@@ -403,7 +429,7 @@ module AnnotateModels
           cc_info_markdown << sprintf(": `%s`", expression) if expression
           cc_info_markdown << "\n"
         else
-          sprintf("#  %-#{max_size}.#{max_size}s %s", check_constraint.name, expression).rstrip + "\n"
+          sprintf("#  %-*.*s %s", max_size, max_size, check_constraint.name, expression).rstrip + "\n"
         end
       end
 
@@ -434,8 +460,8 @@ module AnnotateModels
       new_header = info_block.match(header_pattern).to_s
 
       column_pattern = /^#[\t ]+[\w\*\.`]+[\t ]+.+$/
-      old_columns = old_header && old_header.scan(column_pattern).sort
-      new_columns = new_header && new_header.scan(column_pattern).sort
+      old_columns = old_header&.scan(column_pattern)&.sort
+      new_columns = new_header&.scan(column_pattern)&.sort
 
       return false if old_columns == new_columns && !options[:force]
 
@@ -647,7 +673,7 @@ module AnnotateModels
         if File.file?(file_path) && Kernel.require(file_path)
           retry
         elsif /\//.match?(model_path)
-          model_path = model_path.split("/")[1..-1].join("/").to_s
+          model_path = model_path.split("/")[1..].join("/").to_s
           retry
         else
           raise
@@ -869,7 +895,7 @@ module AnnotateModels
     end
 
     def non_ascii_length(string)
-      string.to_s.chars.reject(&:ascii_only?).length
+      string.to_s.chars.count { |element| !element.ascii_only? }
     end
 
     def map_col_type_to_ruby_classes(col_type)
@@ -889,7 +915,7 @@ module AnnotateModels
       cols = klass.columns
       cols += translated_columns(klass)
 
-      if ignore_columns = options[:ignore_columns]
+      if (ignore_columns = options[:ignore_columns])
         cols = cols.reject do |col|
           col.name.match(/#{ignore_columns}/)
         end
@@ -969,7 +995,7 @@ module AnnotateModels
       # If the index includes another column, print it too.
       if options[:simple_indexes] && klass.table_exists? # Check out if this column is indexed
         indices = retrieve_indexes_from_table(klass)
-        if indices = indices.select { |ind| ind.columns.include? column.name }
+        if (indices = indices.select { |ind| ind.columns.include? column.name })
           indices.sort_by(&:name).each do |ind|
             next if ind.columns.is_a?(String)
             ind = ind.columns.reject! { |i| i == column.name }

data/lib/annotated/annotate_routes/header_generator.rb

@@ -57,7 +57,7 @@ module AnnotateRoutes
       out << comment
       return out if contents_without_magic_comments.size.zero?
 
-      maxs = [HEADER_ROW.map(&:size)] + contents_without_magic_comments[1..-1].map { |line| line.split.map(&:size) }
+      maxs = [HEADER_ROW.map(&:size)] + contents_without_magic_comments[1..].map { |line| line.split.map(&:size) }
 
       if markdown?
         max = maxs.map(&:max).compact.max
@@ -68,7 +68,7 @@ module AnnotateRoutes
         out << comment(content(contents_without_magic_comments[0], maxs))
       end
 
-      out += contents_without_magic_comments[1..-1].map { |line| comment(content(markdown? ? line.split(" ") : line, maxs)) }
+      out += contents_without_magic_comments[1..].map { |line| comment(content(markdown? ? line.split(" ") : line, maxs)) }
       out << comment(options[:wrapper_close]) if options[:wrapper_close]
 
       out

data/lib/annotated/version.rb

@@ -1,5 +1,5 @@
 module Annotated
   def self.version
-    "0.1.0"
+    "0.1.2"
   end
 end

data/lib/generators/annotated/templates/auto_annotate_models.rake

@@ -2,7 +2,8 @@
 # NOTE: are sensitive to local FS writes, and besides -- it's just not proper
 # NOTE: to have a dev-mode tool do its thing in production.
 if Rails.env.development?
-  require "annotate"
+  require "annotated"
+
   task :set_annotation_options do
     # You can override any of these by setting an environment variable of the
     # same name.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotated
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Stefan Froelich
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-11 00:00:00.000000000 Z
+date: 2026-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Annotates Rails Models, routes, fixtures, and others based on the database