feat!: multifile improvements

Author: mattkhan

.github/workflows/release.yml

@@ -30,7 +30,7 @@ jobs:
           bundler-cache: true
       - name: Install dependencies
         run:
-          npm i -g semantic-release-rubygem @semantic-release/changelog @semantic-release/git @semantic-release/release-notes-generator @semantic-release/github @semantic-release/commit-analyzer semantic-release
+          npm i -g semantic-release-rubygem conventional-changelog-conventionalcommits @semantic-release/changelog @semantic-release/git @semantic-release/release-notes-generator @semantic-release/github @semantic-release/commit-analyzer semantic-release
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.releaserc.json

@@ -1,7 +1,12 @@
 {
   "branches": ["main"],
   "plugins": [
-    "@semantic-release/commit-analyzer",
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "preset": "conventionalcommits"
+      }
+    ],
     "@semantic-release/release-notes-generator",
     "@semantic-release/changelog",
     [

lib/anchor/type_script/multifile_save_service.rb

@@ -0,0 +1,74 @@
+module Anchor::TypeScript
+  class MultifileSaveService
+    START_MARKER = "// START AUTOGEN\n"
+    END_MARKER = "\n// END AUTOGEN\n"
+    REGEX = /#{Regexp.escape(START_MARKER)}(.*?)#{Regexp.escape(END_MARKER)}/m
+
+    def self.call(...)
+      new(...).call
+    end
+
+    def initialize(generator:, folder_path:, force: false, resource_file_extension: ".ts")
+      @generator = generator
+      @folder_path = folder_path
+      @force = force
+      @resource_file_extension = "." + resource_file_extension.sub(/^\./, "")
+    end
+
+    def call
+      FileUtils.mkdir_p(@folder_path)
+      results = @generator.call
+      results.each { |result| save_result(result) }
+    end
+
+    private
+
+    def save_result(result)
+      filename = if result.type == MultifileSchemaGenerator::FileType::RESOURCE
+        resource_file_name(result.name)
+      else
+        result.name
+      end
+
+      path = Rails.root.join(@folder_path, filename)
+
+      if @force || !File.exist?(path)
+        File.open(path, "w") { |f| f.write(result.text) }
+        return
+      end
+
+      existing_content = File.read(path)
+
+      new_content = if manually_editable?(existing_content)
+        replace_between(
+          existing: existing_content,
+          new: result.text,
+        )
+      else
+        result.text
+      end
+
+      File.open(path, "w") { |f| f.write(new_content) }
+    end
+
+    def resource_file_name(name)
+      File.basename(name, ".ts") + @resource_file_extension
+    end
+
+    def manually_editable?(text)
+      !text.match(REGEX).nil?
+    end
+
+    def replace_between(existing:, new:)
+      new_content = extract_between(new)
+      raise "Was @generator initialized with manually_editable: false?" unless new_content
+
+      existing.gsub(REGEX, "#{START_MARKER}\n#{new_content}\n#{END_MARKER}")
+    end
+
+    def extract_between(text)
+      match = text.match(REGEX)
+      match[1].strip
+    end
+  end
+end

lib/anchor/type_script/multifile_schema_generator.rb

@@ -0,0 +1,55 @@
+module Anchor::TypeScript
+  class MultifileSchemaGenerator < Anchor::SchemaGenerator
+    Result = Struct.new(:name, :text, :type, keyword_init: true)
+
+    module FileType
+      RESOURCE = "resource"
+      UTIL = "util"
+    end
+
+    def initialize(register:, context: {}, include_all_fields: false, exclude_fields: nil, manually_editable: true) # rubocop:disable Lint/MissingSuper
+      @register = register
+      @context = context
+      @include_all_fields = include_all_fields
+      @exclude_fields = exclude_fields
+      @manually_editable = manually_editable
+    end
+
+    def call
+      [shared_file] + resource_files
+    end
+
+    private
+
+    def shared_file
+      maybe_type = "export type Maybe<T> = T | null;"
+
+      enum_expressions = enums.map(&:express)
+      text = ([maybe_type] + enum_expressions).join("\n\n") + "\n"
+      Result.new(name: "shared.ts", text:, type: FileType::UTIL)
+    end
+
+    def resource_files
+      resources.map do |r|
+        definition = r.definition(
+          context: @context,
+          include_all_fields: @include_all_fields,
+          exclude_fields: @exclude_fields.nil? ? [] : @exclude_fields[r.anchor_schema_name.to_sym],
+        )
+
+        file_structure = ::Anchor::TypeScript::FileStructure.new(definition)
+        text = file_structure.to_code(manually_editable: @manually_editable)
+        name = file_structure.name
+        Result.new(name:, text:, type: FileType::RESOURCE)
+      end
+    end
+
+    def resources
+      @resources ||= @register.resources.map { |r| Anchor::TypeScript::Resource.new(r) }
+    end
+
+    def enums
+      @enums ||= @register.enums.map { |e| Anchor::TypeScript::Types::Enum.new(e) }
+    end
+  end
+end

lib/anchor/type_script/schema_generator.rb

@@ -32,51 +32,4 @@ def enums
       @enums ||= @register.enums.map { |e| Anchor::TypeScript::Types::Enum.new(e) }
     end
   end
-
-  class MultifileSchemaGenerator < Anchor::SchemaGenerator
-    def initialize(register:, context: {}, include_all_fields: false, exclude_fields: nil, manually_editable: true) # rubocop:disable Lint/MissingSuper
-      @register = register
-      @context = context
-      @include_all_fields = include_all_fields
-      @exclude_fields = exclude_fields
-      @manually_editable = manually_editable
-    end
-
-    def call
-      [shared_file] + resource_files
-    end
-
-    private
-
-    def shared_file
-      maybe_type = "export type Maybe<T> = T | null;"
-
-      enum_expressions = enums.map(&:express)
-      content = ([maybe_type] + enum_expressions).join("\n\n") + "\n"
-      { name: "shared.ts", content: }
-    end
-
-    def resource_files
-      resources.map do |r|
-        definition = r.definition(
-          context: @context,
-          include_all_fields: @include_all_fields,
-          exclude_fields: @exclude_fields.nil? ? [] : @exclude_fields[r.anchor_schema_name.to_sym],
-        )
-
-        file_structure = ::Anchor::TypeScript::FileStructure.new(definition)
-        content = file_structure.to_code(manually_editable: @manually_editable)
-        name = file_structure.name
-        { name:, content: }
-      end
-    end
-
-    def resources
-      @resources ||= @register.resources.map { |r| Anchor::TypeScript::Resource.new(r) }
-    end
-
-    def enums
-      @enums ||= @register.enums.map { |e| Anchor::TypeScript::Types::Enum.new(e) }
-    end
-  end
 end

lib/jsonapi-resources-anchor.rb

@@ -15,6 +15,8 @@
 require "anchor/type_script/file_structure"
 require "anchor/type_script/types"
 require "anchor/type_script/schema_generator"
+require "anchor/type_script/multifile_save_service"
+require "anchor/type_script/multifile_schema_generator"
 require "anchor/type_script/serializer"
 require "anchor/type_script/resource"
 require "anchor/json_schema/serializer"

spec/anchor/example_multifile_schema_snapshot_spec.rb

@@ -4,11 +4,13 @@
 RSpec.describe "Example" do
   def self.multifile_snapshot_test(filename, generate)
     it "generates correct #{filename} schema" do
-      result = generate.call
-      result.each do |res|
-        filename = res[:name]
+      results = generate.call
+      results.each do |res|
+        filename = res.name
+
         path = Rails.root.join("test/files/multifile", filename)
-        schema = res[:content]
+        schema = res.text
+
         unless File.file?(path)
           File.open(path, "w") { |file| file.write(schema) }
         end

spec/example/lib/tasks/anchor.rake

@@ -9,27 +9,9 @@ namespace :anchor do
       puts "✅ #{File.basename(path)}"
     end
 
-    def write_to_multi(folder, force, generate)
-      FileUtils.mkdir_p("test/files/#{folder}")
-      result = generate.call
-      result.each do |res|
-        path = Rails.root.join("test/files/#{folder}", res[:name])
-        if force || !File.exist?(path)
-          File.open(path, "w") { |f| f.write(res[:content]) }
-          next
-        end
-
-        existing_content = File.read(path)
-        new_content =
-          if existing_content.starts_with?("// START AUTOGEN\n") && existing_content.include?("// END AUTOGEN\n")
-            after_end = existing_content.split("// END AUTOGEN\n").second
-            [res[:content].split("\n// END AUTOGEN\n").first, "// END AUTOGEN", after_end].join("\n")
-          else
-            res[:content]
-          end
-
-        File.open(path, "w") { |f| f.write(new_content) }
-      end
+    def write_to_multi(folder, force, generator)
+      folder_path = "test/files/#{folder}"
+      Anchor::TypeScript::MultifileSaveService.call(generator:, folder_path:, force:)
       puts "✅ #{folder}"
     end
 
@@ -43,15 +25,16 @@ namespace :anchor do
     write_to "excluded_fields_schema.ts", -> {
       Anchor::TypeScript::SchemaGenerator.call(register: Schema.register, exclude_fields: { User: [:name, :posts] })
     }
-    write_to_multi "multifile", false, -> {
-      Anchor::TypeScript::MultifileSchemaGenerator.call(
+    write_to_multi "multifile",
+      false,
+      Anchor::TypeScript::MultifileSchemaGenerator.new(
         register: Schema.register,
         context: {},
         include_all_fields: true,
         exclude_fields: nil,
         manually_editable: true,
       )
-    }
+
     write_to "json_schema.json", -> {
       Anchor::JSONSchema::SchemaGenerator.call(register: Schema.register, include_all_fields: true)
     }