annotaterb 4.2.0 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5864a6030a7b4cfbf7751761c07136690ebafe15393d67147789f70319036205
-  data.tar.gz: a1dc2b99206b342bbd0dbc66795db4156abddfee307acecf6c2c383e8dbe89b1
+  metadata.gz: 638be873328bb99a7c5b8196ee15749e0c40e36fc3660204ceec28af42678f09
+  data.tar.gz: 0e88670fc1257d20e6282aaf4f510d8b2be29829983dce6c63bcfc4078deb996
 SHA512:
-  metadata.gz: b7cbd03e31fdc24f27d23d700773c157eca461078cddcd87739605980d6f5f07887b59f345ef41d91994547d8efbc2b82595e454f9e4619a5fe4e0fb506d29cd
-  data.tar.gz: f162544608cce0746a92250287ca4a5c7d25d151fe5bfe8bf4d18075834e98ce68939dc8b176dbe97d16f1f039a1a001cbb71066b26280f9fb5e83df763ba158
+  metadata.gz: 2142be1d47c96ac81a3ab97cfbb6d852ea952be8a179785b5cf48eadf9eec3e9ceff3588353a2d3efa6efeed071589664776948b96eda8e1df5cd4dd7335d0c6
+  data.tar.gz: e6cc12cc6d7110283ba23243cc27f355f594d71fc2f5ce5ee50f535f84bfb2e8e6a440546e86a4e2ffa1f300afd819321bb81968e7a235486605bd219c5284bb

data/CHANGELOG.md

@@ -1,12 +1,22 @@
 # Changelog
 
-## [Unreleased](https://github.com/drwl/annotaterb/tree/HEAD)
+## [v4.3.0](https://github.com/drwl/annotaterb/tree/v4.3.0) (2023-06-10)
 
-[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.1.1...HEAD)
+[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/README.md

@@ -59,6 +59,12 @@ $ bin/rails g annotate_rb:install
 
 This will copy a rake task into your Rails project's `lib/tasks` directory that will hook into the Rails project rake tasks, automatically running AnnotateRb after database migration rake tasks.
 
+To skip the automatic annotation that happens after a db task, pass the environment variable `ANNOTATERB_SKIP_ON_DB_TASKS=1` before your command.
+
+```sh
+$ ANNOTATERB_SKIP_ON_DB_TASKS=1 bin/rails db:migrate
+```
+
 ## Migrating from the annotate gem
 Refer to the [migration guide](MIGRATION_GUIDE.md).
 

data/VERSION

@@ -1 +1 @@
-4.2.0
+4.3.1

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

@@ -21,9 +21,10 @@ 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
             "#{@column.name}(#{@column.comment.gsub(/\n/, '\\n')})"

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/generators/annotate_rb/install/templates/annotate_rb.rake

@@ -1,6 +1,7 @@
 # This rake task was added by annotate_rb gem.
 
-if Rails.env.development?
+# Can set `ANNOTATERB_SKIP_ON_DB_TASKS` to be anything to skip this
+if Rails.env.development? && ENV["ANNOTATERB_SKIP_ON_DB_TASKS"].nil?
   require "annotate_rb"
 
   AnnotateRb::Core.load_rake_tasks

metadata

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