Fix the default array value from being escaped (#58)

The Postgres adapter supports `array: true` for various column types
[1]. In #57, it was shown that annotaterb adds escaped string values.

[1] https://guides.rubyonrails.org/active_record_postgresql.html#array

Author: drwl

lib/annotate_rb/model_annotator/column_annotation.rb

@@ -7,6 +7,7 @@ module ColumnAnnotation
       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

lib/annotate_rb/model_annotator/column_annotation/column_wrapper.rb

@@ -88,17 +88,7 @@ def name
 
         # 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

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.to_s
+          end
+        end
+
+        def quote_array(value)
+          content = value.map { |v| quote(v) }.join(", ")
+          "[" + content + "]"
+        end
+      end
+    end
+  end
+end

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

@@ -54,6 +54,78 @@
         end
       end
 
+      context "when the column is string column and an array (postgres)" do
+        let(:column) { mock_column("notifications", :string, default: "{}", array: true, null: true) }
+        let(:model) do
+          instance_double(
+            AnnotateRb::ModelAnnotator::ModelWrapper,
+            primary_key: "something_else",
+            retrieve_indexes_from_table: [],
+            with_comments?: false,
+            column_defaults: {
+              "notifications" => []
+            }
+          )
+        end
+        let(:expected_result) do
+          <<~COLUMN
+            #  notifications   :string           default([]), is an Array
+          COLUMN
+        end
+
+        it "returns the column annotation" do
+          is_expected.to eq(expected_result)
+        end
+      end
+
+      context "when the column is string column and an array with a default (postgres)" do
+        let(:column) { mock_column("notifications", :string, default: "{}", array: true, null: true) }
+        let(:model) do
+          instance_double(
+            AnnotateRb::ModelAnnotator::ModelWrapper,
+            primary_key: "something_else",
+            retrieve_indexes_from_table: [],
+            with_comments?: false,
+            column_defaults: {
+              "notifications" => ["something"]
+            }
+          )
+        end
+        let(:expected_result) do
+          <<~COLUMN
+            #  notifications   :string           default(["something"]), is an Array
+          COLUMN
+        end
+
+        it "returns the column annotation" do
+          is_expected.to eq(expected_result)
+        end
+      end
+
+      context "when the column is a string column with a default" do
+        let(:column) { mock_column("notifications", :string, default: "alert", null: true) }
+        let(:model) do
+          instance_double(
+            AnnotateRb::ModelAnnotator::ModelWrapper,
+            primary_key: "something_else",
+            retrieve_indexes_from_table: [],
+            with_comments?: false,
+            column_defaults: {
+              "notifications" => "alert"
+            }
+          )
+        end
+        let(:expected_result) do
+          <<~COLUMN
+            #  notifications   :string           default("alert")
+          COLUMN
+        end
+
+        it "returns the column annotation" do
+          is_expected.to eq(expected_result)
+        end
+      end
+
       context "when the column has a comment" do
         let(:max_size) { 20 }
 

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

@@ -62,7 +62,7 @@
     context "when the value is an array" do
       let(:value) { [BigDecimal("1.2")] }
       it "returns an array of which elements are converted to string" do
-        is_expected.to eq(["1.2"])
+        is_expected.to eq("[1.2]")
       end
     end
   end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+RSpec.describe AnnotateRb::ModelAnnotator::ColumnAnnotation::DefaultValueBuilder do
+  describe "#build" do
+    subject { described_class.new(value).build }
+
+    context "when value is a String" do
+      let(:value) { "a random string" }
+
+      it { is_expected.to eq("\"a random string\"") }
+    end
+
+    context "when value is nil" do
+      let(:value) { nil }
+
+      it { is_expected.to eq("NULL") }
+    end
+
+    context "when value is true" do
+      let(:value) { true }
+
+      it { is_expected.to eq("TRUE") }
+    end
+
+    context "when value is false" do
+      let(:value) { false }
+
+      it { is_expected.to eq("FALSE") }
+    end
+
+    context "when value is an Integer" do
+      let(:value) { 42 }
+
+      it { is_expected.to eq("42") }
+    end
+
+    context "when value is an Decimal" do
+      let(:value) { 1.2 }
+
+      it { is_expected.to eq("1.2") }
+    end
+
+    context "when value is a BigDecimal" do
+      let(:value) { BigDecimal("1.2") }
+
+      it { is_expected.to eq("1.2") }
+    end
+
+    context "when value is an Array" do
+      context "array is empty" do
+        let(:value) { [] }
+
+        it { is_expected.to eq("[]") }
+      end
+
+      context "array has a String" do
+        let(:value) { ["string"] }
+
+        it { is_expected.to eq("[\"string\"]") }
+      end
+
+      context "array has Strings" do
+        let(:value) { ["a", "string"] }
+
+        it { is_expected.to eq("[\"a\", \"string\"]") }
+      end
+
+      context "array has Numbers" do
+        let(:value) { [42, 1.2] }
+
+        it { is_expected.to eq("[42, 1.2]") }
+      end
+
+      context "array has BigDecimals" do
+        let(:value) { [BigDecimal("0.1"), BigDecimal("0.2")] }
+
+        it { is_expected.to eq("[0.1, 0.2]") }
+      end
+
+      context "array has Booleans" do
+        let(:value) { [true, false] }
+
+        it { is_expected.to eq("[TRUE, FALSE]") }
+      end
+    end
+  end
+end