foobara-files-generator 0.1.5 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3461e9456b77d42ef2b18982335d6dc249e4ab9d31aaa8021b53175994d1b6b
-  data.tar.gz: ce0b2ffa4258580acf8bdba8de4e02472e93bdcdff9a84da2e3195096e675312
+  metadata.gz: 403cd73716460c07e8b8c6a7cef1a9757d4d2a376e6cbc905660975395f6d9af
+  data.tar.gz: 6ee34983b9f2aa3e6abde8480ea05fc22476b89cc624da63d69a3d995b776630
 SHA512:
-  metadata.gz: 6f814407b5a575d59e94d54de20c793e50b9acb8a60c88ff08f0b7340bcad7c060df879da05925c3864e5282cac99de71daba7f2864ee967c0012581114d8308
-  data.tar.gz: fba7d452ac12189ed7507217e3b2478dfb34204690ed4afdf3202163300e2b3440bbd9e334e9fa1f5f6cf2f408a27ef805ac251a7793f275fb736bf88b237b15
+  metadata.gz: 46d07a4dd416e7a58bf74e1694138030af5650f499a86aea31f501ef78b0682ecfb57ebe3e7c0b45a9c9bbb1341da84686873405ee974f3e613a62610d3eeb7f
+  data.tar.gz: 32e65214cfc83f8cb4d8bb00f11a35361a520af6ff38e8f54eceb805933799fcf1b347cf6b37dbb2a7592b96e01c3860c458c08d074fabf29b7ec114d64ee497

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.2.1] - 2026-10-03
+
+- Support an array of generator keys
+- Deprecate requiring "foobara/files_generator/bundler_actions"
+
+## [0.2.0] - 2026-10-02
+
+- Introduce a new foobara-generated.json format
+- Support start_marker/end_marker for adding/removing sections from an existing file
+
 ## [0.1.5] - 2026-09-20
 
 - Don't fail if symlink already exists

data/lib/foobara/files_generator/bundler_actions.rb

@@ -1,16 +1 @@
-require "bundler"
-
-module Foobara
-  class FilesGenerator
-    module BundlerActions
-      def bundle_install
-        puts "bundling..."
-        cmd = "bundle install"
-
-        Bundler.with_unbundled_env do
-          run_cmd_and_return_output(cmd)
-        end
-      end
-    end
-  end
-end
+warn 'DEPRECATED: do not explicitly load require "foobara/files_generator/bundler_actions"'

data/lib/foobara/files_generator.rb

@@ -1,3 +1,9 @@
 require "foobara/all"
 
+module Foobara
+  class FilesGenerator
+    foobara_domain!
+  end
+end
+
 Foobara::Util.require_directory "#{__dir__}/../../src"

data/src/files_generator/bundler_actions.rb

@@ -0,0 +1,16 @@
+require "bundler"
+
+module Foobara
+  class FilesGenerator
+    module BundlerActions
+      def bundle_install
+        puts "bundling..."
+        cmd = "bundle install"
+
+        Bundler.with_unbundled_env do
+          run_cmd_and_return_output(cmd)
+        end
+      end
+    end
+  end
+end

data/src/files_generator.rb

@@ -3,6 +3,7 @@ require "erb"
 module Foobara
   class FilesGenerator
     include TruncatedInspect
+    include BundlerActions
 
     class << self
       def manifest_to_generator_classes(_manifest)

data/src/generate.rb

@@ -3,8 +3,7 @@ require "find"
 module Foobara
   module Generators
     class Generate < Foobara::Command
-      # TODO: specify a better type?
-      result :associative_array
+      result :generate_result
 
       attr_accessor :element_to_generate
 
@@ -64,8 +63,14 @@ module Foobara
         return unless element_to_generate.applicable?
         # simplecov:enable
 
-        paths_to_source_code[Util.array(element_to_generate.target_path).join("/")] =
-          element_to_generate.generate(elements_to_generate)
+        path = Util.array(element_to_generate.target_path).join("/")
+        generated_code = element_to_generate.generate(elements_to_generate)
+
+        if generated_code.is_a?(::String)
+          generated_code = ::Foobara::FilesGenerator::Types::GeneratedFile.new(content: generated_code)
+        end
+
+        paths_to_source_code[path] = generated_code
       end
 
       def include_non_templated_files
@@ -79,7 +84,10 @@ module Foobara
 
           relative_path = file_path.relative_path_from(templates_dir_pathname)
 
-          paths_to_source_code[relative_path.to_s] = File.read(file_path)
+          content = File.read(file_path)
+
+          paths_to_source_code[relative_path.to_s] =
+            ::Foobara::FilesGenerator::Types::GeneratedFile.new(content:)
         end
       end
 

data/src/types/generate_result.rb

@@ -0,0 +1,14 @@
+require_relative "generated_file"
+
+module Foobara
+  class FilesGenerator
+    module Types
+      GENERATE_RESULT = FilesGenerator.foobara_register_type(
+        [:Types, :generate_result],
+        :associative_array,
+        key_type_declaration: :string,
+        value_type_declaration: GeneratedFile
+      )
+    end
+  end
+end

data/src/types/generated_file.rb

@@ -0,0 +1,13 @@
+module Foobara
+  class FilesGenerator
+    module Types
+      class GeneratedFile < Foobara::Model
+        attributes do
+          content :string, :required
+          start_marker :string, :allow_nil
+          end_marker :string, :allow_nil
+        end
+      end
+    end
+  end
+end

data/src/types/generated_file_record.rb

@@ -0,0 +1,13 @@
+module Foobara
+  class FilesGenerator
+    module Types
+      class GeneratedFileRecord < Foobara::Model
+        attributes do
+          file_path :string, :required
+          start_marker :string, :allow_nil
+          end_marker :string, :allow_nil
+        end
+      end
+    end
+  end
+end

data/src/write_generated_files_to_disk.rb

@@ -20,42 +20,93 @@ module Foobara
 
       attr_accessor :paths_to_source_code
 
+      def empty_generated_files_json(version = FilesGenerator::VERSION)
+        {
+          files: [],
+          metadata: {
+            files_generator: version
+          }
+        }
+      end
+
       def generate_generated_files_json
-        paths_to_source_code[generated_files_json_filename] = "[\n#{
-          paths_to_source_code.keys.sort.map { |k| "  \"#{k}\"" }.join(",\n")
-        }\n]\n"
+        generated_files_hash = empty_generated_files_json
+        files = generated_files_hash[:files]
+
+        paths_to_source_code.keys.sort.each do |file_path|
+          generated_file = paths_to_source_code[file_path]
+          file_info = { file_path: }
+
+          start_marker = generated_file.start_marker
+          file_info[:start_marker] = start_marker if start_marker
+
+          end_marker = generated_file.end_marker
+          file_info[:end_marker] = end_marker if end_marker
+
+          files << file_info
+        end
+
+        content = JSON.generate(generated_files_hash)
+
+        paths_to_source_code[generated_files_json_filename] = FilesGenerator::Types::GeneratedFile.new(content:)
       end
 
-      def delete_old_files_if_needed
+      def old_generated_files_json_contents
         file_list_file = "#{output_directory}/#{generated_files_json_filename}"
 
-        if File.exist?(file_list_file)
-          # simplecov:disable
-          file_list = JSON.parse(File.read(file_list_file))
+        return unless File.exist?(file_list_file)
 
-          file_list.map do |file|
-            Thread.new { FileUtils.rm_f("#{output_directory}/#{file}") }
-          end.each(&:join)
-          # simplecov:enable
+        contents = JSON.parse(File.read(file_list_file))
+
+        if contents.is_a?(::Array)
+          file_paths = contents
+
+          contents = empty_generated_files_json("0.1.5")
+          files = contents[:files]
+
+          file_paths.each do |file_path|
+            files << FilesGenerator::Types::GeneratedFileRecord.new(file_path:)
+          end
+        else
+          contents = Util.deep_symbolize_keys(contents)
+
+          contents[:files].map! do |generated_file_data|
+            FilesGenerator::Types::GeneratedFileRecord.new(**generated_file_data)
+          end
         end
+
+        contents
       end
 
-      def write_all_files_to_disk
-        # simplecov:disable
-        if paths_to_source_code.key?(generated_files_json_filename)
-          # simplecov:enable
-          write_file_to_disk(generated_files_json_filename, paths_to_source_code[generated_files_json_filename])
-        end
+      def delete_old_files_if_needed
+        generated_files_info = old_generated_files_json_contents
+
+        return unless generated_files_info
 
-        paths_to_source_code.map do |path, contents|
+        generated_files_info[:files].map do |generated_file_record|
           Thread.new do
-            write_file_to_disk(path, contents) unless path == generated_files_json_filename
+            file_path = File.join(output_directory, generated_file_record.file_path)
+
+            if generated_file_record.start_marker
+              remove_generated_section_from_file(generated_file_record, file_path)
+            else
+              FileUtils.rm_f file_path
+            end
+          end
+        end.each(&:join)
+      end
+
+      def write_all_files_to_disk
+        paths_to_source_code.map do |path, generated_file|
+          Thread.new do
+            content = generated_file.content
+            write_file_to_disk(path, content) # unless path == generated_files_json_filename
           end
         end.each(&:join)
       end
 
       def write_file_to_disk(path, contents)
-        path = "#{output_directory}/#{path}"
+        path = File.join(output_directory, path)
         FileUtils.mkdir_p(File.dirname(path))
 
         if contents.is_a?(FilesGenerator::Symlink)
@@ -80,10 +131,9 @@ module Foobara
         key = self.class.generator_key
 
         if key
-          # TODO: test this path
-          # simplecov:disable
+          key = key.first if key.is_a?(::Array)
+
           "#{key}-generator.json"
-          # simplecov:enable
         else
           "foobara-generated.json"
         end
@@ -151,6 +201,39 @@ module Foobara
       def stats
         "Wrote #{paths_to_source_code.size} files to #{output_directory}"
       end
+
+      def remove_generated_section_from_file(generated_file_record, file_path)
+        # simplecov:disable
+        return unless File.exist?(file_path)
+        # simplecov:enable
+
+        start_marker = generated_file_record.start_marker
+        end_marker = generated_file_record.end_marker
+
+        contents = File.read(file_path)
+
+        start_index = contents.index(start_marker)
+
+        # simplecov:disable
+        return unless start_index
+        # simplecov:enable
+
+        end_index = contents[(start_index + start_marker.size)..].index(end_marker)
+
+        # simplecov:disable
+        return unless end_index
+        # simplecov:enable
+
+        end_index += start_index + start_marker.size + 1
+        end_index += end_marker.size
+
+        keep_first = contents[0...start_index]
+        keep_last = contents[end_index..]
+
+        contents = keep_first + keep_last
+
+        File.write(file_path, contents)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara-files-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.1
 platform: ruby
 authors:
 - Miles Georgi
@@ -43,8 +43,12 @@ files:
 - lib/foobara/files_generator.rb
 - lib/foobara/files_generator/bundler_actions.rb
 - src/files_generator.rb
+- src/files_generator/bundler_actions.rb
 - src/generate.rb
 - src/symlink.rb
+- src/types/generate_result.rb
+- src/types/generated_file.rb
+- src/types/generated_file_record.rb
 - src/write_generated_files_to_disk.rb
 homepage: https://github.com/foobara/files-generator
 licenses: