Add configurable classes list with to_s representation (#98)

Adds configuration option to convert custom class types to their string representation.

Will resolve #97

Author: viralpraxis

lib/annotate_rb/model_annotator/column_annotation/attributes_builder.rb

@@ -8,7 +8,7 @@ class AttributesBuilder
         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

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 @@ def name
 
         # Simple quoting for the default column value
         def quote(value)
-          DefaultValueBuilder.new(value).build
+          DefaultValueBuilder.new(value, @options).build
         end
       end
     end

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 @@ def build
         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"

lib/annotate_rb/model_annotator/column_annotation/type_builder.rb

@@ -10,7 +10,7 @@ class TypeBuilder
 
         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
 

lib/annotate_rb/options.rb

@@ -76,7 +76,8 @@ def from(options = {}, state = {})
       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 = {
@@ -135,7 +136,8 @@ def from(options = {}, state = {})
       :target_action,
       :wrapper,
       :wrapper_close,
-      :wrapper_open
+      :wrapper_open,
+      :classes_default_to_s
     ].freeze
 
     PATH_OPTION_KEYS = [

lib/annotate_rb/parser.rb

@@ -9,7 +9,7 @@ def self.parse(args, existing_options)
 
     BANNER_STRING = <<~BANNER.freeze
       Usage: annotaterb [command] [options]
-      
+
       Commands:
           models [options]
           routes [options]
@@ -248,6 +248,15 @@ def add_model_options_to_parser(option_parser)
         "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)

spec/lib/annotate_rb/model_annotator/column_annotation/column_wrapper_spec.rb

@@ -4,9 +4,10 @@
   include AnnotateTestHelpers
 
   describe "#default_string" do
-    subject { described_class.new(column, column_defaults).default_string }
+    subject { described_class.new(column, column_defaults, options).default_string }
     let(:column) { mock_column("field", nil, default: value) }
     let(:column_defaults) { {"field" => value} }
+    let(:options) { {} }
 
     context "when the value is nil" do
       let(:value) { nil }

spec/lib/annotate_rb/model_annotator/column_annotation/default_value_builder_spec.rb

@@ -2,7 +2,8 @@
 
 RSpec.describe AnnotateRb::ModelAnnotator::ColumnAnnotation::DefaultValueBuilder do
   describe "#build" do
-    subject { described_class.new(value).build }
+    subject { described_class.new(value, config).build }
+    let(:config) { {} }
 
     context "when value is a String" do
       let(:value) { "a random string" }
@@ -83,5 +84,24 @@
         it { is_expected.to eq("[TRUE, FALSE]") }
       end
     end
+
+    context "with specified `classes_default_to_s` config option" do
+      let(:config) { {classes_default_to_s: ["Integer"]} }
+
+      context "when value is an Integer" do
+        let(:value) { 42 }
+
+        it { is_expected.to eq("\"42\"") }
+      end
+
+      context "when config option includes unloaded class" do
+        let(:config) { {classes_default_to_s: ["Locale", "Float"]} }
+        let(:value) { 42 }
+
+        it "does not fail" do
+          expect(subject).to eq("42")
+        end
+      end
+    end
   end
 end