feat: add ar_comment_to_string config

Author: mattkhan

lib/anchor/config.rb

@@ -9,7 +9,8 @@ class Config
       :use_type_as_schema_name,
       :maybe_as_union,
       :array_bracket_notation,
-      :infer_default_as_non_null
+      :infer_default_as_non_null,
+      :ar_comment_to_string
 
     def initialize
       @ar_column_to_type = nil
@@ -22,6 +23,7 @@ def initialize
       @maybe_as_union = nil
       @array_bracket_notation = nil
       @infer_default_as_non_null = nil
+      @ar_comment_to_string = nil
     end
   end
 end

lib/anchor/resource.rb

@@ -79,7 +79,12 @@ def anchor_attributes_properties(included_fields:)
           column = !method_defined && _model_class.try(:columns_hash).try(:[], model_method.to_s)
           if column
             type = Anchor::Types::Inference::ActiveRecord::SQL.from(column)
-            description ||= column.comment if Anchor.config.use_active_record_comment
+            unless description
+              description = column.comment if Anchor.config.use_active_record_comment
+              if description && !Anchor.config.ar_comment_to_string.nil?
+                description = Anchor.config.ar_comment_to_string.call(description)
+              end
+            end
             check_presence = type.is_a?(Anchor::Types::Maybe) && Anchor.config.use_active_record_validations
             if check_presence && _model_class.validators_on(model_method).any? do |v|
                  if v.is_a?(ActiveRecord::Validations::NumericalityValidator)

spec/example/config/initializers/anchor.rb

@@ -10,6 +10,14 @@ module Anchor
       return Types::Literal.new("never") if column.name == "loljk"
       Types::Inference::ActiveRecord::SQL.default_ar_column_to_type(column)
     }
+    c.ar_comment_to_string = lambda { |comment|
+      begin
+        res = JSON.parse(comment)
+        res["description"]
+      rescue JSON::ParserError
+        comment
+      end
+    }
 
     c.empty_relationship_type = -> { Anchor::Types::Object }
   end

spec/example/test/files/all_fields_false_schema.ts

@@ -89,11 +89,7 @@ export type Exhaustive = {
   resourceOverridden: unknown;
   /** This is a comment. */
   withComment: Maybe<string>;
-  /** {
-  "description": "This is a parsed JSON comment.",
-  "test": 2
-}
- */
+  /** This is a parsed JSON comment. */
   withParsedComment: Maybe<string>;
   defaultedBoolean: boolean;
   defaultedAt: string;

spec/example/test/files/excluded_fields_schema.ts

@@ -87,11 +87,7 @@ export type Exhaustive = {
   resourceOverridden: unknown;
   /** This is a comment. */
   withComment: Maybe<string>;
-  /** {
-  "description": "This is a parsed JSON comment.",
-  "test": 2
-}
- */
+  /** This is a parsed JSON comment. */
   withParsedComment: Maybe<string>;
   defaultedBoolean: boolean;
   defaultedAt: string;

spec/example/test/files/multifile/Exhaustive.ts

@@ -54,11 +54,7 @@ type Model = {
   resourceOverridden: unknown;
   /** This is a comment. */
   withComment: Maybe<string>;
-  /** {
-  "description": "This is a parsed JSON comment.",
-  "test": 2
-}
- */
+  /** This is a parsed JSON comment. */
   withParsedComment: Maybe<string>;
   defaultedBoolean: boolean;
   defaultedAt: string;

spec/example/test/files/schema.ts

@@ -96,11 +96,7 @@ export type Exhaustive = {
   resourceOverridden: unknown;
   /** This is a comment. */
   withComment: Maybe<string>;
-  /** {
-  "description": "This is a parsed JSON comment.",
-  "test": 2
-}
- */
+  /** This is a parsed JSON comment. */
   withParsedComment: Maybe<string>;
   defaultedBoolean: boolean;
   defaultedAt: string;

spec/example/test/files/test_schema.ts

@@ -93,11 +93,7 @@ export type Exhaustive = {
   resourceOverridden: unknown;
   /** This is a comment. */
   withComment: Maybe<string>;
-  /** {
-  "description": "This is a parsed JSON comment.",
-  "test": 2
-}
- */
+  /** This is a parsed JSON comment. */
   withParsedComment: Maybe<string>;
   defaultedBoolean: boolean;
   defaultedAt: string;