annotaterb 4.3.1 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 638be873328bb99a7c5b8196ee15749e0c40e36fc3660204ceec28af42678f09
-  data.tar.gz: 0e88670fc1257d20e6282aaf4f510d8b2be29829983dce6c63bcfc4078deb996
+  metadata.gz: a337f543f32142efaffbfd396196692d42a98438352b3bdd406c104c25a9958a
+  data.tar.gz: 27d091e7fed5953ccdd26c4b4874e45a0fcff541630595fa467e010629efb9ba
 SHA512:
-  metadata.gz: 2142be1d47c96ac81a3ab97cfbb6d852ea952be8a179785b5cf48eadf9eec3e9ceff3588353a2d3efa6efeed071589664776948b96eda8e1df5cd4dd7335d0c6
-  data.tar.gz: e6cc12cc6d7110283ba23243cc27f355f594d71fc2f5ce5ee50f535f84bfb2e8e6a440546e86a4e2ffa1f300afd819321bb81968e7a235486605bd219c5284bb
+  metadata.gz: 44125b3f65246ad1b5a0dd0d354487462ea6584c6147165650268244fd8d3c9826cf337873f24c31e008efa1c560b37bcb71e36af7fc05c9bc381d48e2b1e4b0
+  data.tar.gz: 7979e2309e3c09ee11fc090a424e7006a94634c7a970fe34b61028b3a90d495b684cc2a4a6fa78221b288dfe5e6682567835fb6839ada3903dfaa599a4f8cfdc

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## [v4.4.0](https://github.com/drwl/annotaterb/tree/v4.4.0) (2023-06-24)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.3.1...v4.4.0)
+
+**Merged pull requests:**
+
+- Bump version to v4.4.0 [\#52](https://github.com/drwl/annotaterb/pull/52) ([drwl](https://github.com/drwl))
+- Flatten tests in `annotation_builder_spec.rb` [\#51](https://github.com/drwl/annotaterb/pull/51) ([drwl](https://github.com/drwl))
+- Add support for table comments [\#50](https://github.com/drwl/annotaterb/pull/50) ([drwl](https://github.com/drwl))
+- Improve some model annotator tests [\#49](https://github.com/drwl/annotaterb/pull/49) ([drwl](https://github.com/drwl))
+- Make tests that use `mock_column` more accurate [\#48](https://github.com/drwl/annotaterb/pull/48) ([drwl](https://github.com/drwl))
+- Generate changelog for v4.3.1 [\#47](https://github.com/drwl/annotaterb/pull/47) ([drwl](https://github.com/drwl))
+
+## [v4.3.1](https://github.com/drwl/annotaterb/tree/v4.3.1) (2023-06-15)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.3.0...v4.3.1)
+
+**Closed issues:**
+
+- Column defaults change in migration [\#45](https://github.com/drwl/annotaterb/issues/45)
+
+**Merged pull requests:**
+
+- Bump version to v4.3.1 [\#46](https://github.com/drwl/annotaterb/pull/46) ([drwl](https://github.com/drwl))
+- Prettify column defaults [\#44](https://github.com/drwl/annotaterb/pull/44) ([drwl](https://github.com/drwl))
+- Generate changelog for v4.3.0 [\#42](https://github.com/drwl/annotaterb/pull/42) ([drwl](https://github.com/drwl))
+
 ## [v4.3.0](https://github.com/drwl/annotaterb/tree/v4.3.0) (2023-06-10)
 
 [Full Changelog](https://github.com/drwl/annotaterb/compare/v4.2.0...v4.3.0)

data/VERSION

@@ -1 +1 @@
-4.3.1
+4.4.1

data/exe/annotaterb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-unless File.exist?("./Rakefile") || File.exist?("./Gemfile")
+if !File.exist?("./Rakefile") && !File.exist?("./Gemfile")
   abort "Please run annotaterb from the root of the project."
 end
 

data/lib/annotate_rb/model_annotator/annotation_builder.rb

@@ -12,14 +12,14 @@ module AnnotateRb
       MD_NAMES_OVERHEAD = 6
       MD_TYPE_ALLOWANCE = 18
 
-      def initialize(klass, options = {})
+      def initialize(klass, options)
         @model = ModelWrapper.new(klass, options)
         @options = options
         @info = "" # TODO: Make array and build string that way
       end
 
       def build
-        @info = "# #{header}\n"
+        @info = "#{header}\n"
         @info += schema_header_text
 
         max_size = @model.max_schema_info_width
@@ -51,6 +51,7 @@ module AnnotateRb
 
       def header
         header = @options[:format_markdown] ? PREFIX_MD.dup : PREFIX.dup
+        header = "# #{header}"
         version = begin
           ActiveRecord::Migrator.current_version
         rescue
@@ -69,11 +70,11 @@ module AnnotateRb
         info << "#"
 
         if @options[:format_markdown]
-          info << "# Table name: `#{@model.table_name}`"
+          info << "# Table name: `#{table_name}`"
           info << "#"
           info << "# ### Columns"
         else
-          info << "# Table name: #{@model.table_name}"
+          info << "# Table name: #{table_name}"
         end
         info << "#\n" # We want the last line break
 
@@ -93,6 +94,20 @@ module AnnotateRb
 
         info.join("\n")
       end
+
+      private
+
+      def table_name
+        table_name = @model.table_name
+        display_table_comments = @options[:with_comment] && @options[:with_table_comments]
+
+        if display_table_comments && @model.has_table_comments?
+          table_comment = "(#{@model.table_comments.gsub(/\n/, "\\n")})"
+          table_name = "#{table_name}#{table_comment}"
+        end
+
+        table_name
+      end
     end
   end
 end

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

@@ -26,7 +26,8 @@ module AnnotateRb
           column_attributes = AttributesBuilder.new(@column, @options, is_primary_key, column_indices, column_defaults).build
           formatted_column_type = TypeBuilder.new(@column, @options, column_defaults).build
 
-          col_name = if @model.with_comments? && @column.comment
+          display_column_comments = @options[:with_comment] && @options[:with_column_comments]
+          col_name = if display_column_comments && @model.with_comments? && @column.comment
             "#{@column.name}(#{@column.comment.gsub(/\n/, '\\n')})"
           else
             @column.name

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

@@ -88,17 +88,7 @@ module AnnotateRb
 
         # Simple quoting for the default column value
         def quote(value)
-          case value
-          when NilClass then "NULL"
-          when TrueClass then "TRUE"
-          when FalseClass then "FALSE"
-          when Float, Integer then value.to_s
-          # BigDecimals need to be output in a non-normalized form and quoted.
-          when BigDecimal then value.to_s("F")
-          when Array then value.map { |v| quote(v) }
-          else
-            value.inspect
-          end
+          DefaultValueBuilder.new(value).build
         end
       end
     end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    module ColumnAnnotation
+      class DefaultValueBuilder
+        def initialize(value)
+          @value = value
+        end
+
+        # @return [String]
+        # Returns the value to get written to file by file.puts. Strings get written to file so escaped quoted strings
+        # get written as quoted. For example, if `value: "\"some_string\""` then "some_string" gets written.
+        # Same with arrays, if `value: "[\"a\", \"b\", \"c\"]"` then `["a", "b", "c"]` gets written.
+        #
+        # @example "\"some_string\""
+        # @example "NULL"
+        # @example "1.2"
+        def build
+          if @value.is_a?(Array)
+            quote_array(@value)
+          else
+            quote(@value)
+          end
+        end
+
+        private
+
+        def quote(value)
+          case value
+          when NilClass then "NULL"
+          when TrueClass then "TRUE"
+          when FalseClass then "FALSE"
+          when Float, Integer then value.to_s
+          # BigDecimals need to be output in a non-normalized form and quoted.
+          when BigDecimal then value.to_s("F")
+          when String then value.inspect
+          else
+            value.inspect
+          end
+        end
+
+        def quote_array(value)
+          content = value.map { |v| quote(v) }.join(", ")
+          "[" + content + "]"
+        end
+      end
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/column_annotation.rb

@@ -7,6 +7,7 @@ module AnnotateRb
       autoload :TypeBuilder, "annotate_rb/model_annotator/column_annotation/type_builder"
       autoload :ColumnWrapper, "annotate_rb/model_annotator/column_annotation/column_wrapper"
       autoload :AnnotationBuilder, "annotate_rb/model_annotator/column_annotation/annotation_builder"
+      autoload :DefaultValueBuilder, "annotate_rb/model_annotator/column_annotation/default_value_builder"
     end
   end
 end

data/lib/annotate_rb/model_annotator/file_builder.rb

@@ -4,13 +4,12 @@ module AnnotateRb
   module ModelAnnotator
     # Generates the text file content with annotations, these are then to be written to filesystem.
     class FileBuilder
-      def initialize(file_components, new_annotations, annotation_position, options)
+      def initialize(file_components, annotation_position, options)
         @file_components = file_components
-        @new_annotations = new_annotations
         @annotation_position = annotation_position
         @options = options
 
-        @new_wrapped_annotations = wrapped_content(new_annotations)
+        @new_wrapped_annotations = wrapped_content(@file_components.new_annotations)
       end
 
       def generate_content_with_new_annotations

data/lib/annotate_rb/model_annotator/file_components.rb

@@ -6,11 +6,14 @@ module AnnotateRb
       SKIP_ANNOTATION_STRING = "# -*- SkipSchemaAnnotations"
       SOME_PATTERN = /\A(?<start>\s*).*?\n(?<end>\s*)\z/m # Unsure what this pattern is
 
+      attr_reader :new_annotations
+
       def initialize(file_content, new_annotations, options)
         @file_content = file_content
         @diff = AnnotationDiffGenerator.new(file_content, new_annotations).generate
         @options = options
         @annotation_pattern = AnnotationPatternGenerator.call(options)
+        @new_annotations = new_annotations
       end
 
       def current_file_content

data/lib/annotate_rb/model_annotator/model_wrapper.rb

@@ -49,6 +49,15 @@ module AnnotateRb
         @klass.table_exists?
       end
 
+      def table_comments
+        @klass.connection.table_comment(@klass.table_name)
+      end
+
+      def has_table_comments?
+        @klass.connection.respond_to?(:table_comment) &&
+          @klass.connection.table_comment(@klass.table_name).present?
+      end
+
       def column_defaults
         @klass.column_defaults
       end
@@ -110,8 +119,7 @@ module AnnotateRb
       end
 
       def with_comments?
-        @with_comments ||= @options[:with_comment] &&
-          raw_columns.first.respond_to?(:comment) &&
+        @with_comments ||= raw_columns.first.respond_to?(:comment) &&
           raw_columns.map(&:comment).any? { |comment| !comment.nil? }
       end
 

data/lib/annotate_rb/model_annotator/single_file_annotator.rb

@@ -26,7 +26,7 @@ module AnnotateRb
           old_content = File.read(file_name)
 
           file_components = FileComponents.new(old_content, annotation, options)
-          builder = FileBuilder.new(file_components, annotation, annotation_position, options)
+          builder = FileBuilder.new(file_components, annotation_position, options)
 
           return false if file_components.has_skip_string?
           return false if !file_components.annotations_changed? && !options[:force]

data/lib/annotate_rb/options.rb

@@ -51,7 +51,9 @@ module AnnotateRb
       sort: false, # ModelAnnotator
       timestamp: false, # RouteAnnotator
       trace: false, # ModelAnnotator, but is part of Core
-      with_comment: true # ModelAnnotator
+      with_comment: true, # ModelAnnotator
+      with_column_comments: nil, # ModelAnnotator
+      with_table_comments: nil # ModelAnnotator
     }.freeze
 
     OTHER_OPTIONS = {
@@ -113,7 +115,9 @@ module AnnotateRb
       :sort,
       :timestamp,
       :trace,
-      :with_comment
+      :with_comment,
+      :with_column_comments,
+      :with_table_comments
     ].freeze
 
     OTHER_OPTION_KEYS = [
@@ -187,6 +191,10 @@ module AnnotateRb
       @options[:wrapper_open] ||= @options[:wrapper]
       @options[:wrapper_close] ||= @options[:wrapper]
 
+      # Set column and table comments to default to :with_comment, if not set
+      @options[:with_column_comments] = @options[:with_comment] if @options[:with_column_comments].nil?
+      @options[:with_table_comments] = @options[:with_comment] if @options[:with_table_comments].nil?
+
       self
     end
 

data/lib/annotate_rb/parser.rb

@@ -217,6 +217,31 @@ module AnnotateRb
         "include database comments in model annotations") do
         @options[:with_comment] = true
       end
+
+      option_parser.on("--without-comment",
+        "include database comments in model annotations") do
+        @options[:with_comment] = false
+      end
+
+      option_parser.on("--with-column-comments",
+        "include column comments in model annotations") do
+        @options[:with_column_comments] = true
+      end
+
+      option_parser.on("--without-column-comments",
+        "exclude column comments in model annotations") do
+        @options[:with_column_comments] = false
+      end
+
+      option_parser.on("--with-table-comments",
+        "include table comments in model annotations") do
+        @options[:with_table_comments] = true
+      end
+
+      option_parser.on("--without-table-comments",
+        "exclude table comments in model annotations") do
+        @options[:with_table_comments] = false
+      end
     end
 
     def add_route_options_to_parser(option_parser)

data/lib/annotate_rb.rb

@@ -10,8 +10,6 @@ require "active_support/core_ext/string/inflections"
 
 require "rake"
 
-require "annotate_rb/active_record_patch"
-
 require_relative "annotate_rb/helper"
 require_relative "annotate_rb/core"
 require_relative "annotate_rb/commands"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.4.1
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2023-09-11 00:00:00.000000000 Z
 dependencies: []
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.
@@ -25,7 +25,6 @@ files:
 - VERSION
 - exe/annotaterb
 - lib/annotate_rb.rb
-- lib/annotate_rb/active_record_patch.rb
 - lib/annotate_rb/commands.rb
 - lib/annotate_rb/commands/annotate_models.rb
 - lib/annotate_rb/commands/annotate_routes.rb
@@ -48,6 +47,7 @@ files:
 - lib/annotate_rb/model_annotator/column_annotation/annotation_builder.rb
 - lib/annotate_rb/model_annotator/column_annotation/attributes_builder.rb
 - lib/annotate_rb/model_annotator/column_annotation/column_wrapper.rb
+- lib/annotate_rb/model_annotator/column_annotation/default_value_builder.rb
 - lib/annotate_rb/model_annotator/column_annotation/type_builder.rb
 - lib/annotate_rb/model_annotator/file_builder.rb
 - lib/annotate_rb/model_annotator/file_components.rb

data/lib/annotate_rb/active_record_patch.rb

@@ -1,11 +0,0 @@
-# monkey patches
-
-# standard:disable Style/MissingRespondToMissing
-module ::ActiveRecord
-  class Base
-    def self.method_missing(_name, *_args)
-      # ignore this, so unknown/unloaded macros won't cause parsing to fail
-    end
-  end
-end
-# standard:enable Style/MissingRespondToMissing