annotaterb 4.6.0 → 4.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c9e326fa73164a6a2e43edc402e6990cfbb5d953ac5fd1ccf8c71fa6d358ee1
-  data.tar.gz: dabf1afd54a8dec7a96ed8c259ca84e0a6085618713be78f43f075a51a22db7f
+  metadata.gz: e7b61329d5886c3d24def7469ff273e6692c08a5f8f2340a7f6471f993190e17
+  data.tar.gz: 8fcb5a79d2be122867131b8a3779318958326564f6c3c36e4c53e4e0ee7b4250
 SHA512:
-  metadata.gz: 12e277c2d09e37e1001e64b0f08542ff03981bf5bbe37e86ed3dca01b1ec52c5b1805ce6f5cb1a8e5b25c3b9d655cb2345d0c9d878ecf4ae6bbfd265870445ac
-  data.tar.gz: 88d7c9ba17c3abbf38e635365314d1c4b372e67ec5ef0dcba9f7f4f5b6ef90d0e285a2150887127fa75f847a1ee2e8e4c7a30548729a4f903cf71f42be793177
+  metadata.gz: 2c9fe857ae8f3627ff4fe42a419c6123cf9697419d766798abc81b3cf40c6cfb23ad6978d9daab4db7e6888fdfbf9574f4562a9949ab5344b7d3f6df168aff80
+  data.tar.gz: 3cf70f50b4c9ef6f97b08ab91dc7b538806dce0be9a1b4b45be68d132afa74828b306e63544f1be18739a7a85149f4af19f033feeb5899ae575ef61726be27d5

data/CHANGELOG.md

@@ -1,5 +1,44 @@
 # 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)
+
+**Closed issues:**
+
+- Add support for `data_migrate` gem [\#89](https://github.com/drwl/annotaterb/issues/89)
+
+**Merged pull requests:**
+
+- Bump version to v4.6.0 [\#95](https://github.com/drwl/annotaterb/pull/95) ([drwl](https://github.com/drwl))
+- Add support for parsing RSpec files [\#94](https://github.com/drwl/annotaterb/pull/94) ([drwl](https://github.com/drwl))
+- Add support for model name without namespace in resolver [\#93](https://github.com/drwl/annotaterb/pull/93) ([drwl](https://github.com/drwl))
+- Fixes for `RelatedFilesListBuilder` [\#92](https://github.com/drwl/annotaterb/pull/92) ([drwl](https://github.com/drwl))
+- Refactor `AnnotatedFile` classes [\#91](https://github.com/drwl/annotaterb/pull/91) ([drwl](https://github.com/drwl))
+- Add support for data\_migrate gem [\#90](https://github.com/drwl/annotaterb/pull/90) ([cmer](https://github.com/cmer))
+- Support non-model files in `CustomParser` [\#88](https://github.com/drwl/annotaterb/pull/88) ([drwl](https://github.com/drwl))
+- Fix flakey integration test [\#87](https://github.com/drwl/annotaterb/pull/87) ([drwl](https://github.com/drwl))
+- Improve integration tests [\#86](https://github.com/drwl/annotaterb/pull/86) ([drwl](https://github.com/drwl))
+- Add Zeitwerk support [\#85](https://github.com/drwl/annotaterb/pull/85) ([drwl](https://github.com/drwl))
+- Improve annotate after adding new migration integration test [\#84](https://github.com/drwl/annotaterb/pull/84) ([drwl](https://github.com/drwl))
+- Add integration test using force [\#81](https://github.com/drwl/annotaterb/pull/81) ([drwl](https://github.com/drwl))
+- Generate changelog for v4.5.0 [\#80](https://github.com/drwl/annotaterb/pull/80) ([drwl](https://github.com/drwl))
+- Fix annotations swallowing comments [\#72](https://github.com/drwl/annotaterb/pull/72) ([drwl](https://github.com/drwl))
+
 ## [v4.5.0](https://github.com/drwl/annotaterb/tree/v4.5.0) (2024-02-08)
 
 [Full Changelog](https://github.com/drwl/annotaterb/compare/v4.4.1...v4.5.0)

data/VERSION

@@ -1 +1 @@
-4.6.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/column_annotation/attributes_builder.rb

@@ -8,7 +8,7 @@ module AnnotateRb
         NO_DEFAULT_COL_TYPES = %w[json jsonb hstore].freeze
 
         def initialize(column, options, is_primary_key, column_indices, column_defaults)
-          @column = ColumnWrapper.new(column, column_defaults)
+          @column = ColumnWrapper.new(column, column_defaults, options)
           @options = options
           @is_primary_key = is_primary_key
           @column_indices = column_indices

data/lib/annotate_rb/model_annotator/column_annotation/column_wrapper.rb

@@ -4,9 +4,10 @@ module AnnotateRb
   module ModelAnnotator
     module ColumnAnnotation
       class ColumnWrapper
-        def initialize(column, column_defaults)
+        def initialize(column, column_defaults, options)
           @column = column
           @column_defaults = column_defaults
+          @options = options
         end
 
         def raw_default
@@ -88,7 +89,7 @@ module AnnotateRb
 
         # Simple quoting for the default column value
         def quote(value)
-          DefaultValueBuilder.new(value).build
+          DefaultValueBuilder.new(value, @options).build
         end
       end
     end

data/lib/annotate_rb/model_annotator/column_annotation/default_value_builder.rb

@@ -4,8 +4,9 @@ module AnnotateRb
   module ModelAnnotator
     module ColumnAnnotation
       class DefaultValueBuilder
-        def initialize(value)
+        def initialize(value, options)
           @value = value
+          @options = options
         end
 
         # @return [String]
@@ -27,6 +28,8 @@ module AnnotateRb
         private
 
         def quote(value)
+          return value.to_s.inspect if @options[:classes_default_to_s]&.include?(value.class.name)
+
           case value
           when NilClass then "NULL"
           when TrueClass then "TRUE"

data/lib/annotate_rb/model_annotator/column_annotation/type_builder.rb

@@ -10,7 +10,7 @@ module AnnotateRb
 
         def initialize(column, options, column_defaults)
           # Passing `column_defaults` for posterity, don't actually need it here since it's not used
-          @column = ColumnWrapper.new(column, column_defaults)
+          @column = ColumnWrapper.new(column, column_defaults, options)
           @options = options
         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
@@ -76,7 +77,8 @@ module AnnotateRb
       target_action: :do_annotations, # Core; Possible values: :do_annotations, :remove_annotations
       wrapper: nil, # ModelAnnotator, RouteAnnotator
       wrapper_close: nil, # ModelAnnotator, RouteAnnotator
-      wrapper_open: nil # ModelAnnotator, RouteAnnotator
+      wrapper_open: nil, # ModelAnnotator, RouteAnnotator,
+      classes_default_to_s: [] # ModelAnnotator
     }.freeze
 
     PATH_OPTIONS = {
@@ -108,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,
@@ -135,7 +138,8 @@ module AnnotateRb
       :target_action,
       :wrapper,
       :wrapper_close,
-      :wrapper_open
+      :wrapper_open,
+      :classes_default_to_s
     ].freeze
 
     PATH_OPTION_KEYS = [

data/lib/annotate_rb/parser.rb

@@ -9,7 +9,7 @@ module AnnotateRb
 
     BANNER_STRING = <<~BANNER.freeze
       Usage: annotaterb [command] [options]
-      
+
       Commands:
           models [options]
           routes [options]
@@ -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
@@ -248,6 +254,15 @@ module AnnotateRb
         "exclude table comments in model annotations") do
         @options[:with_table_comments] = false
       end
+
+      option_parser.on("--classes-default-to-s class",
+        "Custom classes to be represented with `to_s`, may be used multiple times") do |klass|
+        @options[:classes_default_to_s] = if @options[:classes_default_to_s].present?
+          [*@options[:classes_default_to_s], klass]
+        else
+          [klass]
+        end
+      end
     end
 
     def add_route_options_to_parser(option_parser)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.7.1
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-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