label_weaver 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bbe89444ed69fe936e7e64cb7c0e2b36c013df2afef71f1b33ae65a17e67fa3
-  data.tar.gz: db4917c239cf6502e3da219f7fe215af11d5fa5dd3668e16b01fad2389c93243
+  metadata.gz: eca50ec7fe76eb58a454a92a3815af9037e80617e71fdf6cd53b81b27cce9f56
+  data.tar.gz: 5e6d191c664203f71feaba035e774b4fa492ae804b0d31cc5a0f645342ae9343
 SHA512:
-  metadata.gz: edb992f4593c2de938debe63bc4ee1f60bf4f308b80e859a82c1fb6e3318f45aca96096c8b0859f33c72e916f61f2bffb5f627af4effae44b4135313490b92f1
-  data.tar.gz: 2d51c191608b5070f20f31ef818b26d4d21d67839427655974e8ff55b3911ce41b3a501418e9151bd1d61f8fc1d49393fdaa68f01e225d673687913f8a59f553
+  metadata.gz: 711898d28b3baea45f8659e68a6c63d7537f5acb61e879f61c01268fcdad59b3f65c1067ef67a4a160575314d3577be856902d766131e146d3dce7a1a34fe675
+  data.tar.gz: d07d1c04a8936e7ada2e3bcf9c2a9f58381f4169faaea67ff9f8b245dd3646d8ca87031f9212f4b10503ca080838d8858826c4bb14ea28639f57c9aa963ce307

data/label_weaver.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "label_weaver"
-  spec.version = "0.0.5"
+  spec.version = "0.0.7"
   spec.authors = ["Stefan Exner"]
   spec.email = ["stex@stex.codes"]
   spec.homepage = "https://gitlab.com/lopo-tech/label_weaver"
@@ -17,10 +17,12 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = "~> 3.3"
   spec.add_dependency "cogger", "~> 0.21"
   spec.add_dependency "containable", "~> 0.0"
+  spec.add_dependency "dot-properties", "~> 0.1"
   spec.add_dependency "dry-schema", "~> 1.6"
   spec.add_dependency "diffy", "~> 3.4"
   spec.add_dependency "git", "~> 2.1.1"
   spec.add_dependency "infusible", "~> 3.5"
+  spec.add_dependency "plist", "~> 3.7"
   spec.add_dependency "ruby-next-core", "~> 1.0"
   spec.add_dependency "runcom", "~> 11.0"
   spec.add_dependency "sod", "~> 0.8"

data/lib/label_weaver/cli/actions/develop/start.rb

@@ -38,7 +38,10 @@ module LabelWeaver
               relative_filename = repo.relative_path(repository_file)
               project_file = context.project_root_dir + relative_filename
 
-              if project_file.exist?
+              if repo.forced_file?(repository_file)
+                # If the file is forced, we need to delete the existing file if it exists.
+                FileUtils.rm_f(project_file) if project_file.exist?
+              elsif Util.file_exists?(project_file)
                 if repo.timestamp_for(repository_file) > project_file.mtime
                   logger.warn "File '#{relative_filename}' has a newer version in the remote repository (#{repo.timestamp_for(repository_file)} vs #{project_file.mtime})."
                 end
@@ -48,7 +51,8 @@ module LabelWeaver
               end
 
               FileUtils.mkdir_p(project_file.dirname)
-              FileUtils.copy(repository_file, project_file, preserve: true)
+              # We're not using #copy here as it does not preserve symlinks.
+              FileUtils.copy_entry(repository_file, project_file, preserve: true)
             end
           end
 
@@ -66,7 +70,8 @@ module LabelWeaver
               context.repository_dir,
               repository_url: configuration.git[:repository],
               branch: configuration.git[:branch],
-              excludes: configuration.excludes,
+              excluded_upstream_files: configuration.excluded_upstream_files,
+              forced_upstream_files: configuration.forced_upstream_files,
               logger: logger
             )
           end

data/lib/label_weaver/cli/actions/develop/stop.rb

@@ -37,13 +37,16 @@ module LabelWeaver
               relative_filename = repo.relative_path(repository_file)
               project_file = context.project_root_dir + relative_filename
 
-              if project_file.exist?
-                if digest(project_file) != digest(repository_file)
+              if repo.forced_file?(repository_file) && Util.file_exists?(project_file)
+                logger.debug "Force-Deleting file '#{relative_filename}'..."
+                project_file.unlink
+                remove_empty_tree(project_file.dirname)
+              elsif Util.file_exists?(project_file)
+                if Util.digest(project_file) != Util.digest(repository_file)
                   logger.debug "File '#{relative_filename}' is kept as it was changed in the whitelabel project (r: #{repo.timestamp_for(repository_file)} vs w: #{project_file.mtime})."
                 else
                   logger.debug "Deleting file '#{relative_filename}'..."
                   project_file.unlink
-
                   remove_empty_tree(project_file.dirname)
                 end
               end
@@ -68,16 +71,13 @@ module LabelWeaver
             end
           end
 
-          def digest(file)
-            Digest::SHA1.file(file).hexdigest
-          end
-
           def repo
             @repo ||= LabelWeaver::TempRepo.new(
               context.repository_dir,
               repository_url: configuration.git[:repository],
               branch: configuration.git[:branch],
-              excludes: configuration.excludes,
+              excluded_upstream_files: configuration.excluded_upstream_files,
+              forced_upstream_files: configuration.forced_upstream_files,
               logger: logger
             )
           end

data/lib/label_weaver/configuration/contract.rb

@@ -9,7 +9,8 @@ module LabelWeaver
         required(:repository).filled(:string)
         required(:branch).filled(:string)
       end
-      optional(:excludes).array :string
+      optional(:excluded_upstream_files).array(:string)
+      optional(:forced_upstream_files).array(:string)
       optional(:hooks).hash do
         optional(:develop).hash do
           optional(:before_start).array(:string)

data/lib/label_weaver/configuration/defaults.yml

@@ -1,9 +1,9 @@
 git:
   repository: "git@gitlab.com:lopo-tech/label_weaver.git"
   branch: "main"
-# Files to exclude from the base repository, they will not be copied over to the whitelabel project.
+# Files to exclude from the upstream repository, they will not be copied over to the whitelabel project.
 # Shell filename globbing rules apply, not regular expressions
-excludes:
+excluded_upstream_files:
   - .git/**
 hooks:
   develop:
@@ -18,6 +18,13 @@ hooks:
 #    target_file: package.json
 #    overrides_file: package.whitelabel.json
 
+# Files to be **always** taken from the upstream repository.
+# They will always be copied over on development start and will be removed from the
+# whitelabel project on stop.
+# Shell filename globbing rules apply, not regular expressions
+#forced_upstream_files:
+#  - test/**
+
 # Files here will be appended on whitelabel development instead of being skipped if the
 # file already exists in a project
 #append:

data/lib/label_weaver/configuration/model.rb

@@ -4,12 +4,13 @@ module LabelWeaver
   module Configuration
     # Defines the configuration model for use throughout the gem.
     Model = Data.define(
-      :excludes,
+      :excluded_upstream_files,
       :git,
       :hooks,
-      :merges
+      :merges,
+      :forced_upstream_files
     ) do
-      def initialize(git:, hooks: {}, excludes: [], merges: [])
+      def initialize(git:, hooks: {}, excluded_upstream_files: [], forced_upstream_files: [], merges: [])
         super
       end
     end

data/lib/label_weaver/merger.rb

@@ -1,3 +1,5 @@
+require "dot_properties"
+
 module LabelWeaver
   class Merger
     include Import[:configuration, :logger]
@@ -38,7 +40,17 @@ module LabelWeaver
       source = load_file(source_file)
       overrides = load_file(overrides_file)
 
-      write_file(target_file, source.deep_merge(overrides))
+      validate_compatibility!(source, overrides)
+
+      case target_file.extname
+      when ".properties"
+        overrides.to_h.each do |k, v|
+          source[k] = v
+        end
+        write_file(target_file, source)
+      else
+        write_file(target_file, source.deep_merge(overrides))
+      end
     end
 
     def restore_file(relative_file_path)
@@ -52,8 +64,23 @@ module LabelWeaver
       configuration.merges.map { _1.transform_keys(&:to_sym) }
     end
 
+    def validate_compatibility!(source, overrides)
+      # Check for property files
+      if source.is_a?(DotProperties) || overrides.is_a?(DotProperties)
+        if nested_hash?(source) || nested_hash?(overrides)
+          raise ArgumentError, "Property files can only be merged with other property files or one-dimensional hashes"
+        end
+      end
+    end
+
+    def nested_hash?(value)
+      value.is_a?(Hash) && value.values.any? { |v| v.is_a?(Hash) }
+    end
+
     def load_file(file)
       case file.extname
+      when ".properties"
+        DotProperties.load(file)
       when ".yaml", ".yml"
         YAML.load_file(file)
       when ".json"
@@ -65,10 +92,13 @@ module LabelWeaver
 
     def write_file(file, content)
       case file.extname
+      when ".properties"
+        # TODO: Handle content that is not already a DotProperties instance
+        File.write(file, content.to_s)
       when ".yaml", ".yml"
-        File.write(file, content.to_yaml)
+        File.write(file, content.to_h.to_yaml)
       when ".json"
-        File.write(file, JSON.pretty_generate(content))
+        File.write(file, JSON.pretty_generate(content.to_h))
       else
         raise ArgumentError, "Unsupported file type: #{file.extname}"
       end

data/lib/label_weaver/temp_repo.rb

@@ -7,13 +7,21 @@ module LabelWeaver
   class TempRepo
     using Refinements::Pathname
 
-    attr_reader :repository_path, :repository_url, :branch, :excludes, :logger
-
-    def initialize(repository_path, repository_url:, branch: "main", excludes: [], logger: Logger.new($stdout))
+    attr_reader :repository_path, :repository_url, :branch, :logger, :excluded_upstream_files, :forced_upstream_files
+
+    def initialize(
+      repository_path,
+      repository_url:,
+      branch: "main",
+      excluded_upstream_files: [],
+      forced_upstream_files: [],
+      logger: Logger.new($stdout)
+    )
       @repository_path = repository_path
       @repository_url = repository_url
       @branch = branch
-      @excludes = excludes + %w[. ..]
+      @excluded_upstream_files = excluded_upstream_files + %w[. ..]
+      @forced_upstream_files = forced_upstream_files
       @logger = logger
     end
 
@@ -27,7 +35,7 @@ module LabelWeaver
     end
 
     def digest_for(file)
-      Digest::SHA1.file(file).hexdigest
+      Util.digest(file)
     end
 
     def changed_file?(repository_file, project_root_dir:)
@@ -60,12 +68,26 @@ module LabelWeaver
     def relevant_files
       files.filter do |file|
         # Reject any files that are set up to be excluded. Shell filename globbing rules apply
-        next false if excludes.any? { relative_path(file).fnmatch?(_1, File::FNM_DOTMATCH) }
+        next false if excluded_file?(file)
 
         true
       end
     end
 
+    #
+    # @return [Boolean] +true+ if the file should never be copied over from the repository
+    #
+    def excluded_file?(repository_file)
+      excluded_upstream_files.any? { relative_path(repository_file).fnmatch?(_1, File::FNM_DOTMATCH) }
+    end
+
+    #
+    # @return [Boolean] +true+ if the file should **always** be copied over from the repository
+    #
+    def forced_file?(repository_file)
+      forced_upstream_files.any? { relative_path(repository_file).fnmatch?(_1, File::FNM_DOTMATCH) }
+    end
+
     #
     # Updates the atime and mtime of each file in the repository to their latest commit time
     # TODO: Check if still needed
@@ -103,7 +125,9 @@ module LabelWeaver
     # @return [Array<Pathname>] All files inside the repository, including dotfiles. No folders.
     #
     def files
-      repository_path.glob("**/*", File::FNM_DOTMATCH).select(&:file?)
+      # The symlink check is necessary to include directory symlinks, but leave out
+      # regular directories
+      repository_path.glob("**/*", File::FNM_DOTMATCH).select { _1.file? || _1.symlink? }
     end
 
     def repo

data/lib/label_weaver/util.rb

@@ -0,0 +1,18 @@
+module LabelWeaver
+  module Util
+    def digest(file)
+      if file.symlink?
+        # for symlinks we just use the target path
+        file.readlink
+      else
+        Digest::SHA1.file(file).hexdigest
+      end
+    end
+    module_function :digest
+
+    def file_exists?(file)
+      file.symlink? || file.exist?
+    end
+    module_function :file_exists?
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: label_weaver
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Stefan Exner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-29 00:00:00.000000000 Z
+date: 2024-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cogger
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: dot-properties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: dry-schema
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: ruby-next-core
   requirement: !ruby/object:Gem::Requirement
@@ -222,6 +250,7 @@ files:
 - lib/label_weaver/import.rb
 - lib/label_weaver/merger.rb
 - lib/label_weaver/temp_repo.rb
+- lib/label_weaver/util.rb
 homepage: https://gitlab.com/lopo-tech/label_weaver
 licenses:
 - MIT