foobara-files-generator 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a29c8bd81eb2b6e1a5c5739738b3dd3c3c149eb3425069057afc8a3b8de2dec4
-  data.tar.gz: 640aa309102175f3bbcf6107c05b0071dec9d731f10594ea5c2772b519ec2045
+  metadata.gz: 8cf98ecb24a6c06ed9168b0dbf7c14a4d6aa19b7a0365684634a295de86fed57
+  data.tar.gz: 2626b68d7005938cc276c044523857154aee0fbde4a4ce1717df847b7dc35cbe
 SHA512:
-  metadata.gz: b5462b15ba2d326a99fc8bc3632936592cba21d899c8f40f49f708edfbdf50d6f7c349222f46a079f1b6cfba261c1af5568330b6f21e1fba20908dc3f069e8c0
-  data.tar.gz: d4c6b4321096abcb484e462b6da54f34164e13a30aa0705d22dde1ac41f80a558daf7b8c24d5a7e490c3f63f65f699c7ade7b42dd8e12a6f8053792f45069640
+  metadata.gz: 65e71db48ca1463143cfbab679dba25423992018fddc5fe19858d2d7ccd8f5bd355600e4bb47727ac45e23c08a5b759b3e92908521422a6e07ac7c8b43356a52
+  data.tar.gz: a51167675d456aa2686f283f1679c929471d28f233f8599e7fc6d0909f0a7a392d224166ebc094fe25ffc00f7cf75359ed7129979717e44ff7396b7795de89f5

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.1.4] - 2026-09-19
+
+- Support creating symlinks
+
+## [0.1.3] - 2026-09-15
+
+- Fix deprecation warnings
+
 ## [0.1.2] - 2026-02-02
 
 - Fix bug where fileutils might not have been required yet

data/README.md

@@ -1,15 +1,6 @@
 # Foobara::FilesGenerator
 
-Contains common-code useful in different code generators.
-
-## Development
-
-For local development, for now, run the following:
-
-```
-bundle config set local.foobara ../foobara
-bundle config set disable_local_branch_check true
-```
+Contains common-code useful in different Foobara generators
 
 ## Contributing
 

data/src/files_generator.rb

@@ -6,9 +6,9 @@ module Foobara
 
     class << self
       def manifest_to_generator_classes(_manifest)
-        # :nocov:
+        # simplecov:disable
         raise "subclass responsibility"
-        # :nocov:
+        # simplecov:enable
       end
 
       def generators_for(manifest)
@@ -40,9 +40,9 @@ module Foobara
       if file.end_with?(".erb")
         [*path, file[0..-5]]
       else
-        # :nocov:
+        # simplecov:disable
         raise "expected a .erb extension. Maybe override #target_path"
-        # :nocov:
+        # simplecov:enable
       end
     end
 
@@ -55,9 +55,9 @@ module Foobara
     end
 
     def generators_for(...)
-      # :nocov:
+      # simplecov:disable
       self.class.generators_for(...)
-      # :nocov:
+      # simplecov:enable
     end
 
     def generator_for(...)
@@ -86,9 +86,9 @@ module Foobara
     end
 
     def template_path
-      # :nocov:
+      # simplecov:disable
       raise "Subclass responsibility"
-      # :nocov:
+      # simplecov:enable
     end
 
     def absolute_template_path
@@ -102,9 +102,9 @@ module Foobara
     end
 
     def templates_dir
-      # :nocov:
+      # simplecov:disable
       "#{Dir.pwd}/templates"
-      # :nocov:
+      # simplecov:enable
     end
 
     def template_string
@@ -128,9 +128,9 @@ module Foobara
       if relevant_manifest.respond_to?(method_name)
         relevant_manifest.send(method_name, *, &)
       else
-        # :nocov:
+        # simplecov:disable
         super
-        # :nocov:
+        # simplecov:enable
       end
     end
 

data/src/generate.rb

@@ -9,9 +9,9 @@ module Foobara
       attr_accessor :element_to_generate
 
       def base_generator
-        # :nocov:
+        # simplecov:disable
         raise "subclass responsibility"
-        # :nocov:
+        # simplecov:enable
       end
 
       def elements_to_generate
@@ -60,7 +60,9 @@ module Foobara
       end
 
       def generate_element
+        # simplecov:disable
         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)

data/src/symlink.rb

@@ -0,0 +1,43 @@
+module Foobara
+  class FilesGenerator
+    class Symlink < String
+      @mutex = Mutex.new
+
+      class << self
+        def supported?
+          return @supported if defined?(@supported)
+          # simplecov:disable-next
+          return @supported if @mutex.nil?
+
+          @mutex.synchronize do
+            target_path = ".foobara-symlink-test-target"
+            symlink_path = ".foobara-symlink-test-link"
+
+            @supported = begin
+              FileUtils.rm_f(target_path)
+              FileUtils.rm_f(symlink_path)
+
+              File.write(target_path, "hi!")
+              File.symlink(target_path, symlink_path)
+
+              File.symlink?(symlink_path)
+            # TODO: figure out which of these actually happen in Windows
+            # rubocop:disable-next Lint/ShadowedException
+            rescue Errno::EACCES, NotImplementedError, SystemCallError
+              # TODO: come up with a way to test this
+              # simplecov:disable
+              false
+            # simplecov:enable
+            ensure
+              FileUtils.rm_f(target_path)
+              FileUtils.rm_f(symlink_path)
+            end
+
+            @mutex = nil
+            @supported
+          end
+        end
+      end
+    end
+  end
+end

data/src/write_generated_files_to_disk.rb

@@ -30,18 +30,20 @@ module Foobara
         file_list_file = "#{output_directory}/#{generated_files_json_filename}"
 
         if File.exist?(file_list_file)
-          # :nocov:
+          # simplecov:disable
           file_list = JSON.parse(File.read(file_list_file))
 
           file_list.map do |file|
             Thread.new { FileUtils.rm_f("#{output_directory}/#{file}") }
           end.each(&:join)
-          # :nocov:
+          # simplecov:enable
         end
       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
 
@@ -53,7 +55,19 @@ module Foobara
       def write_file_to_disk(path, contents)
         path = "#{output_directory}/#{path}"
         FileUtils.mkdir_p(File.dirname(path))
-        File.write(path, contents)
+
+        if contents.is_a?(FilesGenerator::Symlink)
+          if FilesGenerator::Symlink.supported?
+            File.symlink(contents, path)
+            # simplecov:disable
+          else
+            # TODO: come up with a way to test this path
+            FileUtils.cp_r(contents, path)
+            # simplecov:enable
+          end
+        else
+          File.write(path, contents)
+        end
       end
 
       def generated_files_json_filename
@@ -61,9 +75,9 @@ module Foobara
 
         if key
           # TODO: test this path
-          # :nocov:
+          # simplecov:disable
           "#{key}-generator.json"
-          # :nocov:
+          # simplecov:enable
         else
           "foobara-generated.json"
         end
@@ -82,14 +96,14 @@ module Foobara
           exit_status = wait_thr.value
 
           unless exit_status.success?
-            # :nocov:
+            # simplecov:disable
             message = "Could not #{cmd}\n#{stderr.read}"
             if raise_if_fails
               raise CouldNotExecuteError, message
             else
               warn "WARNING: #{message}"
             end
-            # :nocov:
+            # simplecov:enable
           end
 
           exit_status
@@ -107,7 +121,7 @@ module Foobara
       end
 
       def run_cmd_and_return_output(cmd)
-        retval = ""
+        retval = +""
 
         Open3.popen3(cmd) do |_stdin, stdout, stderr, wait_thr|
           loop do
@@ -119,10 +133,10 @@ module Foobara
 
           exit_status = wait_thr.value
           unless exit_status.success?
-            # :nocov:
+            # simplecov:disable
             raise CouldNotExecuteError, "could not #{cmd}\n#{stderr.read}"
           end
-          # :nocov:
+          # simplecov:enable
         end
       rescue Errno::ENOENT
         raise CouldNotExecuteError, "Could not run: #{cmd}\nMaybe it is not installed?"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara-files-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Miles Georgi
@@ -44,6 +44,7 @@ files:
 - lib/foobara/files_generator/bundler_actions.rb
 - src/files_generator.rb
 - src/generate.rb
+- src/symlink.rb
 - src/write_generated_files_to_disk.rb
 homepage: https://github.com/foobara/files-generator
 licenses:
@@ -62,13 +63,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: 3.4.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Common code reused across code generator projects
 test_files: []