annotaterb 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6600bd03fb521f6d86e1f9dc7e86e2c2020b54cd666ccf21bb23dd7fcc18bdc5
-  data.tar.gz: bf68866b5ed4cbc5c52464464cc239bb8d9f22f642492400aaf88ca3296aee29
+  metadata.gz: 349c4c734ded99ebac4d6ec075372fe814dff54e7edd7834a4b7c254aa046571
+  data.tar.gz: 715b408a71123bc45986f4aca53c1c34b0debb92b01dc770085a7ba5aac6ae45
 SHA512:
-  metadata.gz: a1e0c299850467b29e7fb2a7fecb83464e4eb0a5d1325b688591d0ca03dc98ffcc691d4d1262861bc03aa2648249b54401020a6dbbf11600d7991b54d149be90
-  data.tar.gz: a85ea32f4acb1cbd189d501c41d8fffa18ba8ce930e871fb804686803e94474273aa7617f33229ff397840f7055e0f06222b8e2095e1617e9b1e660a54865d4b
+  metadata.gz: d843a40644a70550177193b9f1e559c541852384bf4e26f489a45d6ad486d8ddf6157d94abc9c98072acfad802e3144db40fe9ba1e6a3b00018d7865c92dc78a
+  data.tar.gz: e3706615de5bca13aa90353aec34bcc9a728400c139321d051edac045d4c2f24edc032129f666eb012da7b88587bd90bab979e40f77fb25c0568b39559a8302a

data/CHANGELOG.md

@@ -1,12 +1,36 @@
 # Changelog
 
-## [Unreleased](https://github.com/drwl/annotaterb/tree/HEAD)
+## [v4.3.1](https://github.com/drwl/annotaterb/tree/v4.3.1) (2023-06-15)
 
-[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.1.1...HEAD)
+[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)
+
+**Merged pull requests:**
+
+- Bump version to v4.3.0 [\#41](https://github.com/drwl/annotaterb/pull/41) ([drwl](https://github.com/drwl))
+- Add `ANNOTATERB_SKIP_ON_DB_TASKS` ENV var to skip auto annotations [\#40](https://github.com/drwl/annotaterb/pull/40) ([drwl](https://github.com/drwl))
+
+## [v4.2.0](https://github.com/drwl/annotaterb/tree/v4.2.0) (2023-06-02)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.1.1...v4.2.0)
 
 **Merged pull requests:**
 
 - Specify `standard` gem version [\#39](https://github.com/drwl/annotaterb/pull/39) ([drwl](https://github.com/drwl))
+- Generate changelog for 4.2 again [\#38](https://github.com/drwl/annotaterb/pull/38) ([drwl](https://github.com/drwl))
 - Bump version to v4.2.0 [\#37](https://github.com/drwl/annotaterb/pull/37) ([drwl](https://github.com/drwl))
 - Generate changelog for 4.2 [\#36](https://github.com/drwl/annotaterb/pull/36) ([drwl](https://github.com/drwl))
 - Improve tests for `ColumnAnnotation::*` [\#35](https://github.com/drwl/annotaterb/pull/35) ([drwl](https://github.com/drwl))

data/VERSION

@@ -1 +1 @@
-4.3.0
+4.4.0

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

@@ -21,11 +21,13 @@ module AnnotateRb
 
           table_indices = @model.retrieve_indexes_from_table
           column_indices = table_indices.select { |ind| ind.columns.include?(@column.name) }
+          column_defaults = @model.column_defaults
 
-          column_attributes = AttributesBuilder.new(@column, @options, is_primary_key, column_indices).build
-          formatted_column_type = TypeBuilder.new(@column, @options).build
+          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/attributes_builder.rb

@@ -7,8 +7,8 @@ module AnnotateRb
         # Don't show default value for these column types
         NO_DEFAULT_COL_TYPES = %w[json jsonb hstore].freeze
 
-        def initialize(column, options, is_primary_key, column_indices)
-          @column = ColumnWrapper.new(column)
+        def initialize(column, options, is_primary_key, column_indices, column_defaults)
+          @column = ColumnWrapper.new(column, column_defaults)
           @options = options
           @is_primary_key = is_primary_key
           @column_indices = column_indices
@@ -20,7 +20,7 @@ module AnnotateRb
           column_type = @column.column_type_string
           attrs = []
 
-          unless @column.default.nil? || hide_default?
+          if !@column.raw_default.nil? && !hide_default?
             schema_default = "default(#{@column.default_string})"
 
             attrs << schema_default

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

@@ -4,18 +4,21 @@ module AnnotateRb
   module ModelAnnotator
     module ColumnAnnotation
       class ColumnWrapper
-        def initialize(column)
+        def initialize(column, column_defaults)
           @column = column
+          @column_defaults = column_defaults
         end
 
-        def default
-          # Note: Used to be klass.column_defaults[name], where name is the column name.
-          # Looks to be identical, but keeping note here in case there are differences.
-          _column_default = @column.default
+        def raw_default
+          @column.default
+        end
+
+        def default_value
+          @column_defaults[@column.name]
         end
 
         def default_string
-          quote(@column.default)
+          quote(default_value)
         end
 
         def type

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

@@ -8,8 +8,9 @@ module AnnotateRb
         # Example: show "integer" instead of "integer(4)"
         NO_LIMIT_COL_TYPES = %w[integer bigint boolean].freeze
 
-        def initialize(column, options)
-          @column = ColumnWrapper.new(column)
+        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)
           @options = options
         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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-10 00:00:00.000000000 Z
+date: 2023-06-24 00:00:00.000000000 Z
 dependencies: []
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.