annotato 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40145b6423788c1e730c30b88fb7d0858f4e5103b5cf6848b888b58dbed9883b
-  data.tar.gz: 84c1713c14000ad436410c8c2ae408d312a439f82158a6fc1a7cccfdf378e537
+  metadata.gz: '0488e086a169e36da60498c64e3f92d5ef351585e45ef8f7a27d53ea46eb5dc2'
+  data.tar.gz: ea52a7a819b2fb542731001b2161bdfaad4b360bf917dcc533618b7dc684599c
 SHA512:
-  metadata.gz: 2b3103a08cccb5d2658e969eafddf36977b65e88f94cc72d35a1e485f841f67216071ee9bd37955a81d9c29844da11e4a3777d47dbf645e07ae861d4553f8d57
-  data.tar.gz: f38edaf28cc9ca220f2825219ffc619d8638301719bebecbc60aae6d7bdadf01811fd9a84ce4e5d05b2d0432f908608d991c2e6be8e40fcaaef8f34bbebd8440
+  metadata.gz: e1fbed2a6e5f43ab7007fa0bdc6cce04143b7530d5cf3891ab050f8e8ead1aa7b9307ae74347b8f7fd34c315af2951c498b1b9a5aef4910981d283d2facdd6e1
+  data.tar.gz: 6a4b2a9d0213f41b050ce8ae077c095ee34602fe6b99904ee7cea345849d65901ed933d4e55aa40ad81eac4fcb5af7d26cca393c7a443dc2c2c8df7cd8e15c07

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    annotato (0.1.7)
+    annotato (0.1.9)
       rails (>= 6.0)
 
 GEM

data/README.md

@@ -9,15 +9,15 @@
 
 ## Features
 
-- Annotates Rails models with:
-  - Columns and types
-  - Default values and constraints
-  - Enums with values
-  - Indexes (only if present)
-  - Triggers (only if present)
-- Skips unchanged annotations
-- Replaces legacy `annotate`/`annotate_models` blocks
-- Smart formatting with aligned columns
+* Annotates Rails models with:
+
+  * Columns and types
+  * Default values and constraints
+  * Enums with values
+  * Indexes (only if present)
+  * Triggers (only if present)
+* Skips unchanged annotations
+* Smart formatting with aligned columns
 
 Example:
 
@@ -57,23 +57,38 @@ bundle install
 
 ## Usage
 
-To annotate all models:
+### Annotate All Models
+
+To annotate all models, run:
 
 ```bash
 bundle exec rake annotato:models
 ```
 
+### Annotate Specific Models
+
+You can now pass one or multiple model names to the task.
+
+```bash
+# Annotate only the User model
+rake annotato:models[User]
+
+# Annotate multiple models (User and Admin::Account)
+rake annotato:models["User,Admin::Account"]
+```
+
 ---
 
 ## Rake Task
 
 ```bash
-rake annotato:models
+rake annotato:models[MODEL]
 ```
 
-- Automatically loads all models via `Rails.application.eager_load!`
-- Modifies model files in place
-- Existing Annotato and Annotate blocks will be replaced
+* Automatically loads all models via `Rails.application.eager_load!`
+* Modifies model files in place
+* Replace existing Annotato and legacy annotate blocks
+* **Pass `MODEL` argument (single or comma-separated) to target specific models**
 
 ---
 

data/lib/annotato/column_formatter.rb

@@ -1,77 +1,97 @@
 # frozen_string_literal: true
 
-require 'json'
+require "json"
 
 module Annotato
   class ColumnFormatter
+    # Main entry: returns an array of comment lines per column, flattened.
     def self.format(model, connection)
-      table_name = model.table_name
-      primary_key = model.primary_key
-      enums = model.defined_enums
+      table_name     = model.table_name
+      primary_key    = model.primary_key
       unique_indexes = connection.indexes(table_name).select(&:unique)
-      columns = connection.columns(table_name)
+      enums          = model.defined_enums
+      columns        = connection.columns(table_name)
 
-      raw_data = columns.map do |col|
+      # Compute max widths for name and sql_type so that the table lines up.
+      name_width = columns.map(&:name).map(&:length).max
+      type_width = columns.map(&:sql_type).map(&:length).max
+
+      columns.flat_map do |col|
         name = col.name
         type = col.sql_type
-        default = col.default
-        opts = []
-
-        opts << "default(#{default.inspect})" unless default.nil?
-        opts << "not null" unless col.null
-        opts << "primary key" if name == primary_key
-        opts << "is an Array" if type.end_with?("[]")
-        opts << "unique" if unique_indexes.any? { |idx| idx.columns == [name] }
-        opts << "enum" if enums.key?(name)
-
-        [name, type, default, opts]
-      end
-
-      name_width = raw_data.map { |name, *_| name.length }.max
-      type_width = raw_data.map { |_, type, *_| type.length }.max
-
-      raw_data.flat_map do |name, type, default, opts|
-        base_line = "#  %-#{name_width}s :%-#{type_width}s" % [name, type]
-        indent = ' ' * (base_line.length + 1)
 
-        if multiline_default?(default)
-          formatted_defaults = format_multiline_default(default)
-          remaining_opts = opts.reject { |o| o.start_with?("default(") }
+        # require "pry" if name == "allowed_statuses"
+        # binding.pry if name == "allowed_statuses"
+        # Build the left-hand side and calculate indent.
+        left  = "#  %-#{name_width}s :%-#{type_width}s" % [name, type]
+        # " default(" is 9 chars; +2 gives the extra gap.
+        indent_size = left.length + 1
+        indent_str  = " " * indent_size
+        closing_indent_str  = " " * (indent_size - 2)
 
-          lines = []
-          lines << "#{base_line} default(["
-          formatted_defaults.each do |v|
-            lines << "#{'#' + indent}#{v}"
-          end
+        # Gather all options, pulling out default_lines if multiline.
+        opts         = []
+        default_block = build_default_block(col.default)
+        if default_block
+          opts << "__MULTILINE__"  # placeholder
+        elsif col.default
+          opts << "default(#{col.default.inspect})"
+        end
+        opts << "not null"       unless col.null
+        opts << "primary key"    if name == primary_key
+        opts << "is an Array"    if type.end_with?("[]")
+        opts << "unique"         if unique_indexes.any? { |idx| idx.columns == [name] }
+        opts << "enum"           if enums.key?(name)
 
-          closing = "#{'#' + ' ' * (indent.length - 1)}]),"
-          closing += " #{remaining_opts.join(', ')}" unless remaining_opts.empty?
-          lines << closing.rstrip
+        # Emit either a multiline block or a single line.
+        if default_block
+          # 1) opening line
+          lines = ["#{left} default(#{col.default[0]}"]
+          # 2) each interior line, prefixed by "# " + indent_str
+          lines += default_block.map { |l| "# #{indent_str}#{l}" }
+          # 3) closing line with trailing options
+          closing = "# #{closing_indent_str}#{col.default[-1]})"
+          trailing = opts.reject { |o| o == "__MULTILINE__" }
+          closing += ", #{trailing.join(', ')}" unless trailing.empty?
+          lines << closing
           lines
         else
-          line = base_line
+          # single-line comment
+          line = left
           line += " #{opts.join(', ')}" unless opts.empty?
-          line.rstrip
+          [line.rstrip]
         end
       end
     end
 
-    def self.multiline_default?(value)
-      value.is_a?(String) && value.strip.start_with?("[") && value.strip.end_with?("]") && value.include?(",")
-    end
+    # Returns nil (no default) or an Array of un-indented lines:
+    #   ["[", "\"A\",", "\"B\"", "]"]   or   ["{", "\"k\":v,", ... , "}"]
+    # If the value is empty array or hash, returns ["[]"] or ["{}"].
+    def self.build_default_block(value)
+      return nil if value.nil?
+      s = value.strip
+      return nil unless s.start_with?("[") || s.start_with?("{")
 
-    def self.format_multiline_default(value)
-      parsed = JSON.parse(value)
-      return [value] unless parsed.is_a?(Array)
+      parsed = JSON.parse(s) rescue nil
+      return nil unless parsed.is_a?(Array) || parsed.is_a?(Hash)
 
-      items = parsed.is_a?(Array) && parsed[0].is_a?(Array) ? parsed[0] : parsed
+      if parsed.is_a?(Array)
+        return if parsed.empty? # empty array → ["[]"]
 
-      items.map.with_index do |item, idx|
-        comma = idx == items.size - 1 ? "" : ","
-        "#{item.to_json}#{comma}"
+        # Only a JSON array of strings?
+        parsed.map.with_index do |e, i|
+          comma = i == parsed.size - 1 ? "" : ","
+          %Q{"#{e}"#{comma}}
+        end
+      else
+        return if parsed.empty? # empty hash → ["{}"]
+
+        # JSON hash → key/value pairs
+        parsed.map.with_index do |(k, v), i|
+          comma = i == parsed.size - 1 ? "" : ","
+          %Q{"#{k}": #{v.inspect}#{comma}}
+        end
       end
-    rescue JSON::ParserError
-      [value]
     end
   end
 end

data/lib/annotato/model_annotator.rb

@@ -10,8 +10,10 @@ module Annotato
       @output = output
     end
 
-    def run
-      models.each do |model|
+    def run(one_model = nil)
+      mtd = one_model ? [one_model] : models
+
+      mtd.each do |model|
         next unless model.table_exists?
 
         annotation = AnnotationBuilder.build(model)
@@ -24,7 +26,10 @@ module Annotato
 
       def models
         Rails.application.eager_load!
-        ActiveRecord::Base.descendants.reject(&:abstract_class?)
+        # All AR models, but skip STI subclasses (only keep base classes)
+        ActiveRecord::Base.descendants
+          .reject(&:abstract_class?)
+          .select { |m| m.base_class == m }
       end
 
       def model_file(model)

data/lib/annotato/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Annotato
-  VERSION = "0.1.7"
+  VERSION = "0.1.9"
 end

data/lib/tasks/annotato.rake

@@ -1,8 +1,23 @@
+# lib/tasks/annotato.rake
+
 require "annotato/model_annotator"
 
 namespace :annotato do
-  desc "Annotate models with schema info"
-  task models: :environment do
-    Annotato::ModelAnnotator.new.run
+  desc "Annotate models with schema info. Pass MODEL=name or comma-separated list"
+  task :models, [:MODEL] => :environment do |t, args|
+    # Parse MODEL argument into an array of model names, if given
+    model_list = args[:MODEL]&.split(",")&.map(&:strip)
+
+    annotator = Annotato::ModelAnnotator.new
+
+    if model_list && model_list.any?
+      # Constantize each name and annotate only those classes
+      model_list.map(&:constantize).each do |klass|
+        annotator.run(klass)
+      end
+    else
+      # No MODEL passed → annotate all models
+      annotator.run
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: annotato
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Serhii Bodnaruk
 bindir: exe
 cert_chain: []
-date: 2025-05-16 00:00:00.000000000 Z
+date: 2025-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails