label_weaver 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c9548ad5700605d0b7809e4a1e7d41444728bdfdb31aefa23da2aab812bf250
-  data.tar.gz: 9eff12ebcc85a52eb4e46768d3a37f72a61eb9087464fcaea50bfdf731918115
+  metadata.gz: 6bbe89444ed69fe936e7e64cb7c0e2b36c013df2afef71f1b33ae65a17e67fa3
+  data.tar.gz: db4917c239cf6502e3da219f7fe215af11d5fa5dd3668e16b01fad2389c93243
 SHA512:
-  metadata.gz: b825c71ab2b865e46af1df187f5f125ee5ec234b900e2f9e9e5df5105410cf2ee013aec6ada2ea306e8aa90362ed562d93259634a71eb4abcec60c7a1a19d00f
-  data.tar.gz: d04fb881bcc8ff5ad003b6fd2664bee1b0359d920d550754e95db838572857fe2c0b7eb23b20ea57669a224eb1a82b53245bb25411259a322c8aec4f5c334990
+  metadata.gz: edb992f4593c2de938debe63bc4ee1f60bf4f308b80e859a82c1fb6e3318f45aca96096c8b0859f33c72e916f61f2bffb5f627af4effae44b4135313490b92f1
+  data.tar.gz: 2d51c191608b5070f20f31ef818b26d4d21d67839427655974e8ff55b3911ce41b3a501418e9151bd1d61f8fc1d49393fdaa68f01e225d673687913f8a59f553

data/README.md

@@ -7,7 +7,10 @@
 * [LabelWeaver](#labelweaver)
   * [Installation](#installation)
   * [Setting up a new whitelabel project](#setting-up-a-new-whitelabel-project)
-  * [Developing the whitelabel project](#developing-the-whitelabel-project)
+  * [Developing a whitelabel project](#developing-a-whitelabel-project)
+    * [Starting local development](#starting-local-development)
+    * [Stopping local development](#stopping-local-development)
+    * [Diffs](#diffs)
   * [CI Usage](#ci-usage)
 <!-- TOC -->
 
@@ -24,10 +27,39 @@ gem install label_weaver
 
 ## Setting up a new whitelabel project
 
-
 ## Developing a whitelabel project
 
-### Local Development
+### Starting local development
+
+```
+label_weaver develop --start
+```
+
+This command will perform the following actions:
+
+1. Run any `before_start` hooks 
+2. Clone or check out the base repository
+3. Copy all files from the base repository to the whitelabel project that do not already exist
+4. Merge configured files
+5. Run any `after_start` hooks
+
+Please note that the gem will inform you about files with a newer version in the base repository.
+This could mean that you have to update them in your whitelabel project as well to ensure compatibility.
+
+### Stopping local development
+
+```
+label_weaver develop --stop
+```
+
+This command will perform the following actions:
+
+1. Run any `before_start` hooks
+2. Restore all files that were automatically created through merging
+3. Remove all files from the project that do not differ from the base project
+4. Run any `after_start` hooks
+
+You should be left with only the changed files in your repository now.
 
 ### Diffs
 

data/label_weaver.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "label_weaver"
-  spec.version = "0.0.4"
+  spec.version = "0.0.5"
   spec.authors = ["Stefan Exner"]
   spec.email = ["stex@stex.codes"]
   spec.homepage = "https://gitlab.com/lopo-tech/label_weaver"

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

@@ -23,10 +23,9 @@ module LabelWeaver
             end
 
             Hooks.new.run(:develop, :before_start)
-
             repo.clone_or_update
             copy_repository_files
-
+            handle_file_merges
             Hooks.new.run(:develop, :after_start)
           end
 
@@ -53,6 +52,15 @@ module LabelWeaver
             end
           end
 
+          def handle_file_merges
+            merger = ::LabelWeaver::Merger.new(project_root_dir: context.project_root_dir, repo:)
+            if merger.present?
+              logger.info "Merging files..."
+
+              merger.merge!
+            end
+          end
+
           def repo
             @repo ||= LabelWeaver::TempRepo.new(
               context.repository_dir,

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

@@ -23,6 +23,7 @@ module LabelWeaver
             end
 
             Hooks.new.run(:develop, :before_stop)
+            restore_merged_files
             remove_base_files
             Hooks.new.run(:develop, :after_stop)
           end
@@ -37,9 +38,8 @@ module LabelWeaver
               project_file = context.project_root_dir + relative_filename
 
               if project_file.exist?
-                # TODO: Should we get a time component in here to check for possible newer base repo files?
                 if digest(project_file) != digest(repository_file)
-                  logger.info "File '#{relative_filename}' is kept as it was changed in the whitelabel project (r: #{repo.timestamp_for(repository_file)} vs w: #{project_file.mtime})."
+                  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
@@ -59,6 +59,15 @@ module LabelWeaver
             remove_empty_tree(dir.parent)
           end
 
+          def restore_merged_files
+            merger = ::LabelWeaver::Merger.new(project_root_dir: context.project_root_dir, repo:)
+            if merger.present?
+              logger.info "Restoring merged files..."
+
+              merger.restore!
+            end
+          end
+
           def digest(file)
             Digest::SHA1.file(file).hexdigest
           end

data/lib/label_weaver/configuration/contract.rb

@@ -18,6 +18,7 @@ module LabelWeaver
           optional(:after_stop).array(:string)
         end
       end
+      optional(:merges).array(:hash)
     end
   end
 end

data/lib/label_weaver/configuration/defaults.yml

@@ -9,6 +9,15 @@ hooks:
   develop:
     after_start:
       - echo "Development Mode Started"
+
+# Define files from the base and whitelabel projects that should be merged into
+# a new or existing file.
+# Currently supported formats are JSON and YAML
+#merges:
+#  - source_file: package.json
+#    target_file: package.json
+#    overrides_file: package.whitelabel.json
+
 # 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

@@ -6,9 +6,10 @@ module LabelWeaver
     Model = Data.define(
       :excludes,
       :git,
-      :hooks
+      :hooks,
+      :merges
     ) do
-      def initialize(git:, hooks: {}, excludes: [])
+      def initialize(git:, hooks: {}, excludes: [], merges: [])
         super
       end
     end

data/lib/label_weaver/merger.rb

@@ -0,0 +1,77 @@
+module LabelWeaver
+  class Merger
+    include Import[:configuration, :logger]
+
+    attr_reader :project_root_dir, :repo
+
+    def initialize(project_root_dir:, repo:, configuration: nil, logger: nil)
+      @configuration = configuration
+      @logger = logger
+      @project_root_dir = project_root_dir
+      @repo = repo
+    end
+
+    def present?
+      merge_entries.any?
+    end
+
+    def merge!
+      merge_entries.each do |entry|
+        entry => {source_file:, target_file:, overrides_file:}
+        logger.debug "Merging '#{overrides_file}' and '#{source_file}' into '#{target_file}'..."
+
+        merge_file(project_root_dir + source_file, project_root_dir + target_file, project_root_dir + overrides_file)
+      end
+    end
+
+    def restore!
+      merge_entries.each do |entry|
+        logger.debug "Restoring '#{entry[:target_file]}'..."
+
+        restore_file(entry[:target_file])
+      end
+    end
+
+    private
+
+    def merge_file(source_file, target_file, overrides_file)
+      source = load_file(source_file)
+      overrides = load_file(overrides_file)
+
+      write_file(target_file, source.deep_merge(overrides))
+    end
+
+    def restore_file(relative_file_path)
+      repository_file = repo.root_path + relative_file_path
+      project_file = project_root_dir + relative_file_path
+
+      FileUtils.cp(repository_file, project_file, preserve: true)
+    end
+
+    def merge_entries
+      configuration.merges.map { _1.transform_keys(&:to_sym) }
+    end
+
+    def load_file(file)
+      case file.extname
+      when ".yaml", ".yml"
+        YAML.load_file(file)
+      when ".json"
+        JSON.parse(File.read(file))
+      else
+        raise ArgumentError, "Unsupported file type: #{file.extname}"
+      end
+    end
+
+    def write_file(file, content)
+      case file.extname
+      when ".yaml", ".yml"
+        File.write(file, content.to_yaml)
+      when ".json"
+        File.write(file, JSON.pretty_generate(content))
+      else
+        raise ArgumentError, "Unsupported file type: #{file.extname}"
+      end
+    end
+  end
+end

data/lib/label_weaver/temp_repo.rb

@@ -17,6 +17,8 @@ module LabelWeaver
       @logger = logger
     end
 
+    alias_method :root_path, :repository_path
+
     #
     # @return [Time] the last time the file was part of a commit, closest we can get to an mtime
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: label_weaver
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Stefan Exner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2024-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cogger
@@ -220,6 +220,7 @@ files:
 - lib/label_weaver/container.rb
 - lib/label_weaver/hooks.rb
 - lib/label_weaver/import.rb
+- lib/label_weaver/merger.rb
 - lib/label_weaver/temp_repo.rb
 homepage: https://gitlab.com/lopo-tech/label_weaver
 licenses: