annotaterb 4.7.0 → 4.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f31e6cf08a5d57a35274e5964a5da9e4a01d006e0ddf3d4ac4467932901709ac
-  data.tar.gz: 020ad6bab20eb3c029173d5764050d7c62855785c2fa357750bc2fbff27cd02b
+  metadata.gz: e7b61329d5886c3d24def7469ff273e6692c08a5f8f2340a7f6471f993190e17
+  data.tar.gz: 8fcb5a79d2be122867131b8a3779318958326564f6c3c36e4c53e4e0ee7b4250
 SHA512:
-  metadata.gz: 1a52c81202a634161721175021e8ee8742cad49f0eab0aab2e89319d856a8f81fe0e1e2ea3de1e78e3695f261a6d2ee5bd5b41ea1ac8c9b2d072a62bcec4b1cd
-  data.tar.gz: b01f86669748d083e52a0f3fef891632cff7fcf1c476ae1ce71e5e654cc028105435c4ceadcc73b23443dba28f3dd9c082ebbadeae541ad053a3cd93005d59cb
+  metadata.gz: 2c9fe857ae8f3627ff4fe42a419c6123cf9697419d766798abc81b3cf40c6cfb23ad6978d9daab4db7e6888fdfbf9574f4562a9949ab5344b7d3f6df168aff80
+  data.tar.gz: 3cf70f50b4c9ef6f97b08ab91dc7b538806dce0be9a1b4b45be68d132afa74828b306e63544f1be18739a7a85149f4af19f033feeb5899ae575ef61726be27d5

data/CHANGELOG.md

@@ -1,13 +1,23 @@
 # Changelog
 
+## [v4.7.0](https://github.com/drwl/annotaterb/tree/v4.7.0) (2024-03-27)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.6.0...v4.7.0)
+
+**Closed issues:**
+
+- Feature request: better custom type representation [\#97](https://github.com/drwl/annotaterb/issues/97)
+
+**Merged pull requests:**
+
+- Bump version to v4.7.0 [\#100](https://github.com/drwl/annotaterb/pull/100) ([drwl](https://github.com/drwl))
+- Add configurable classes list with `to_s` representation [\#98](https://github.com/drwl/annotaterb/pull/98) ([viralpraxis](https://github.com/viralpraxis))
+- Generate changelog for v4.6.0 [\#96](https://github.com/drwl/annotaterb/pull/96) ([drwl](https://github.com/drwl))
+
 ## [v4.6.0](https://github.com/drwl/annotaterb/tree/v4.6.0) (2024-02-27)
 
 [Full Changelog](https://github.com/drwl/annotaterb/compare/v4.5.0...v4.6.0)
 
-Adds two big changes: Fix annotations swallowing comments [\#72](https://github.com/drwl/annotaterb/pull/72) and 
-Add Zeitwerk support [\#85](https://github.com/drwl/annotaterb/pull/85).  
-Please report any issues you encounter. 
-
 **Closed issues:**
 
 - Add support for `data_migrate` gem [\#89](https://github.com/drwl/annotaterb/issues/89)

data/VERSION

@@ -1 +1 @@
-4.7.0
+4.7.1

data/lib/annotate_rb/model_annotator/annotation_builder.rb

@@ -44,6 +44,10 @@ module AnnotateRb
           @info += ForeignKeyAnnotation::AnnotationBuilder.new(@model, @options).build
         end
 
+        if @options[:show_check_constraints] && @model.table_exists?
+          @info += CheckConstraintAnnotation::AnnotationBuilder.new(@model, @options).build
+        end
+
         @info += schema_footer_text
 
         @info
@@ -52,12 +56,19 @@ module AnnotateRb
       def header
         header = @options[:format_markdown] ? PREFIX_MD.dup : PREFIX.dup
         header = "# #{header}"
-        version = begin
-          ActiveRecord::Migrator.current_version
-        rescue
-          0
+
+        if @options.get_state(:current_version).nil?
+          migration_version = begin
+            ActiveRecord::Migrator.current_version
+          rescue
+            0
+          end
+
+          @options.set_state(:current_version, migration_version)
         end
 
+        version = @options.get_state(:current_version)
+
         if @options[:include_version] && version > 0
           header += "\n# Schema version: #{version}"
         end

data/lib/annotate_rb/model_annotator/annotation_decider.rb

@@ -18,6 +18,10 @@ module AnnotateRb
           klass = ModelClassGetter.call(@file, @options)
 
           klass_is_a_class = klass.is_a?(Class)
+          # Methods such as #superclass only exist on a class. Because of how the code is structured, `klass` could be a
+          #  module that does not support the #superclass method, so we want to return early.
+          return false if !klass_is_a_class
+
           klass_inherits_active_record_base = klass < ActiveRecord::Base
           klass_is_not_abstract = klass.respond_to?(:abstract_class) && !klass.abstract_class?
           klass_table_exists = klass.respond_to?(:abstract_class) && klass.table_exists?

data/lib/annotate_rb/model_annotator/check_constraint_annotation/annotation_builder.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    module CheckConstraintAnnotation
+      class AnnotationBuilder
+        def initialize(model, options)
+          @model = model
+          @options = options
+        end
+
+        def build
+          constraint_info = if @options[:format_markdown]
+            "#\n# ### Check Constraints\n#\n"
+          else
+            "#\n# Check Constraints\n#\n"
+          end
+
+          return "" unless @model.connection.respond_to?(:supports_check_constraints?) &&
+            @model.connection.supports_check_constraints? && @model.connection.respond_to?(:check_constraints)
+
+          check_constraints = @model.connection.check_constraints(@model.table_name)
+          return "" if check_constraints.empty?
+
+          max_size = check_constraints.map { |check_constraint| check_constraint.name.size }.max + 1
+          check_constraints.sort_by(&:name).each do |check_constraint|
+            expression = check_constraint.expression ? "(#{check_constraint.expression.squish})" : nil
+
+            constraint_info += if @options[:format_markdown]
+              cc_info_in_markdown(check_constraint.name, expression)
+            else
+              cc_info_string(check_constraint.name, expression, max_size)
+            end
+          end
+
+          constraint_info
+        end
+
+        private
+
+        def cc_info_in_markdown(name, expression)
+          cc_info_markdown = sprintf("# * `%s`", name)
+          cc_info_markdown += sprintf(": `%s`", expression) if expression
+          cc_info_markdown += "\n"
+
+          cc_info_markdown
+        end
+
+        def cc_info_string(name, expression, max_size)
+          # standard:disable Lint/FormatParameterMismatch
+          sprintf("#  %-#{max_size}.#{max_size}s %s", name, expression).rstrip + "\n"
+          # standard:enable Lint/FormatParameterMismatch
+        end
+      end
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/check_constraint_annotation.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    module CheckConstraintAnnotation
+      autoload :AnnotationBuilder, "annotate_rb/model_annotator/check_constraint_annotation/annotation_builder"
+    end
+  end
+end

data/lib/annotate_rb/model_annotator.rb

@@ -26,5 +26,6 @@ module AnnotateRb
     autoload :AnnotatedFile, "annotate_rb/model_annotator/annotated_file"
     autoload :FileParser, "annotate_rb/model_annotator/file_parser"
     autoload :ZeitwerkClassGetter, "annotate_rb/model_annotator/zeitwerk_class_getter"
+    autoload :CheckConstraintAnnotation, "annotate_rb/model_annotator/check_constraint_annotation"
   end
 end

data/lib/annotate_rb/options.rb

@@ -45,6 +45,7 @@ module AnnotateRb
       ignore_unknown_models: false, # ModelAnnotator
       include_version: false, # ModelAnnotator
       show_complete_foreign_keys: false, # ModelAnnotator
+      show_check_constraints: false, # ModelAnnotator
       show_foreign_keys: true, # ModelAnnotator
       show_indexes: true, # ModelAnnotator
       simple_indexes: false, # ModelAnnotator
@@ -109,6 +110,7 @@ module AnnotateRb
       :ignore_model_sub_dir,
       :ignore_unknown_models,
       :include_version,
+      :show_check_constraints,
       :show_complete_foreign_keys,
       :show_foreign_keys,
       :show_indexes,

data/lib/annotate_rb/parser.rb

@@ -198,6 +198,12 @@ module AnnotateRb
         @options[:simple_indexes] = true
       end
 
+      option_parser.on("-c",
+        "--show-check-constraints",
+        "List the table's check constraints in the annotation") do
+        @options[:show_check_constraints] = true
+      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|
         @options[:hide_limit_column_types] = values.to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.7.1
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-27 00:00:00.000000000 Z
+date: 2024-05-09 00:00:00.000000000 Z
 dependencies: []
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.
@@ -46,6 +46,8 @@ files:
 - lib/annotate_rb/model_annotator/annotation_diff_generator.rb
 - lib/annotate_rb/model_annotator/annotator.rb
 - lib/annotate_rb/model_annotator/bad_model_file_error.rb
+- lib/annotate_rb/model_annotator/check_constraint_annotation.rb
+- lib/annotate_rb/model_annotator/check_constraint_annotation/annotation_builder.rb
 - lib/annotate_rb/model_annotator/column_annotation.rb
 - lib/annotate_rb/model_annotator/column_annotation/annotation_builder.rb
 - lib/annotate_rb/model_annotator/column_annotation/attributes_builder.rb