label_weaver 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d4577814ad253da907628f3c86300dc89c2b362260fa6772af602670ce2aa63
-  data.tar.gz: a262362d186dca07c7789baca7cd642c3d9b43e5ea1ca3ec6259ac4a244ef90f
+  metadata.gz: 6bbe89444ed69fe936e7e64cb7c0e2b36c013df2afef71f1b33ae65a17e67fa3
+  data.tar.gz: db4917c239cf6502e3da219f7fe215af11d5fa5dd3668e16b01fad2389c93243
 SHA512:
-  metadata.gz: 64c146c67e07cb609d4c7ac458e37d071edd0e592ec460f3b692b559a5121b2dfa12c5294a71eb565cb7d2064d54053aae8a0cf09ccdae2fc94fe48f4970cbcd
-  data.tar.gz: 17f74363825bd9115228468d77b175b19c2895a680acd3809e0a7d25f3dda1338cae90e660fd26140fc57b78cd6aff80dd99f405938141d46cfcb5d56104d131
+  metadata.gz: edb992f4593c2de938debe63bc4ee1f60bf4f308b80e859a82c1fb6e3318f45aca96096c8b0859f33c72e916f61f2bffb5f627af4effae44b4135313490b92f1
+  data.tar.gz: 2d51c191608b5070f20f31ef818b26d4d21d67839427655974e8ff55b3911ce41b3a501418e9151bd1d61f8fc1d49393fdaa68f01e225d673687913f8a59f553

data/README.md

@@ -1,3 +1,66 @@
 # LabelWeaver
 
 [![Ruby Code Style](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/standardrb/standard)
+[![Gem Version](https://badge.fury.io/rb/label_weaver.svg)](https://badge.fury.io/rb/label_weaver)
+
+<!-- TOC -->
+* [LabelWeaver](#labelweaver)
+  * [Installation](#installation)
+  * [Setting up a new whitelabel project](#setting-up-a-new-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 -->
+
+LabelWeaver is a gem to help developing whitelabel applications of an existing code base.
+
+It does so by automatically merging the base code into the whitelabel code, leading to only the 
+changed files being part of a new repository or branch.
+
+## Installation
+
+```bash
+gem install label_weaver
+```
+
+## Setting up a new whitelabel project
+
+## Developing a whitelabel project
+
+### 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
+
+## CI Usage

data/label_weaver.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "label_weaver"
-  spec.version = "0.0.3"
+  spec.version = "0.0.5"
   spec.authors = ["Stefan Exner"]
   spec.email = ["stex@stex.codes"]
   spec.homepage = "https://gitlab.com/lopo-tech/label_weaver"
@@ -17,10 +17,8 @@ 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 "dry-monads", "~> 1.6"
   spec.add_dependency "dry-schema", "~> 1.6"
   spec.add_dependency "diffy", "~> 3.4"
-  spec.add_dependency "etcher", "~> 1.6"
   spec.add_dependency "git", "~> 2.1.1"
   spec.add_dependency "infusible", "~> 3.5"
   spec.add_dependency "ruby-next-core", "~> 1.0"

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

@@ -22,8 +22,11 @@ module LabelWeaver
               kernel.exit(1)
             end
 
+            Hooks.new.run(:develop, :before_start)
             repo.clone_or_update
             copy_repository_files
+            handle_file_merges
+            Hooks.new.run(:develop, :after_start)
           end
 
           private
@@ -49,11 +52,20 @@ 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,
-              repository_url: configuration.git_repository,
-              branch: configuration.git_branch,
+              repository_url: configuration.git[:repository],
+              branch: configuration.git[:branch],
               excludes: configuration.excludes,
               logger: logger
             )

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

@@ -22,7 +22,10 @@ module LabelWeaver
               kernel.exit(1)
             end
 
+            Hooks.new.run(:develop, :before_stop)
+            restore_merged_files
             remove_base_files
+            Hooks.new.run(:develop, :after_stop)
           end
 
           private
@@ -35,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
@@ -57,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
@@ -64,8 +75,8 @@ module LabelWeaver
           def repo
             @repo ||= LabelWeaver::TempRepo.new(
               context.repository_dir,
-              repository_url: configuration.git_repository,
-              branch: configuration.git_branch,
+              repository_url: configuration.git[:repository],
+              branch: configuration.git[:branch],
               excludes: configuration.excludes,
               logger: logger
             )

data/lib/label_weaver/cli/shell.rb

@@ -39,7 +39,6 @@ module LabelWeaver
           project_root_dir: Pathname.new(Dir.pwd),
           local_tmp_dir: Pathname.new(Dir.pwd).join(".config", "label_weaver"),
           repository_dir: Pathname.new(Dir.pwd).join(".config", "label_weaver", "repository"),
-          tracking_file: Pathname.new(Dir.pwd).join(".config", "label_weaver", "files.yml"),
           defaults_path:,
           xdg_config:,
           version_label: specification.labeled_version

data/lib/label_weaver/configuration/contract.rb

@@ -2,14 +2,23 @@
 
 require "dry/schema"
 
-Dry::Schema.load_extensions :monads
-
 module LabelWeaver
   module Configuration
     Contract = Dry::Schema.Params do
-      required(:git_repository).filled :string
-      required(:git_branch).filled :string
+      required(:git).hash do
+        required(:repository).filled(:string)
+        required(:branch).filled(:string)
+      end
       optional(:excludes).array :string
+      optional(:hooks).hash do
+        optional(:develop).hash do
+          optional(:before_start).array(:string)
+          optional(:after_start).array(:string)
+          optional(:before_stop).array(:string)
+          optional(:after_stop).array(:string)
+        end
+      end
+      optional(:merges).array(:hash)
     end
   end
 end

data/lib/label_weaver/configuration/defaults.yml

@@ -5,6 +5,19 @@ git:
 # Shell filename globbing rules apply, not regular expressions
 excludes:
   - .git/**
+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

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

data/lib/label_weaver/container.rb

@@ -2,7 +2,6 @@
 
 require "cogger"
 require "containable"
-require "etcher"
 require "runcom"
 require "spek"
 
@@ -12,19 +11,29 @@ module LabelWeaver
     extend Containable
 
     register :configuration do
-      self[:defaults].add_loader(:yaml, self[:xdg_config].active)
-        .then { |registry| Etcher.call registry }
+      if self[:xdg_config].active
+        data = self[:defaults].merge(YAML.load_file(self[:xdg_config].active, symbolize_names: true))
+        contract = Configuration::Contract.call(**data)
+
+        raise ArgumentError.new(contract.errors.to_h) if contract.failure?
+
+        Configuration::Model.new(**data)
+      else
+        Configuration::Model.new(**self[:defaults])
+      end
     end
 
     register :defaults do
-      Etcher::Registry.new(contract: Configuration::Contract, model: Configuration::Model)
-        .add_loader(:yaml, self[:defaults_path])
+      YAML.load_file(self[:defaults_path], symbolize_names: true)
     end
 
     register(:specification) { Spek::Loader.call "#{__dir__}/../../label_weaver.gemspec" }
     register(:defaults_path) { Pathname(__dir__).join("configuration/defaults.yml") }
     register(:xdg_config) { Runcom::Config.new("label_weaver/configuration.yml") }
-    register(:logger) { Cogger.new(id: "label_weaver") }
+    register(:logger) do
+      Cogger.add_emoji :any, "🪝"
+      Cogger.new(id: "label_weaver")
+    end
     register :kernel, Kernel
   end
 end

data/lib/label_weaver/hooks.rb

@@ -0,0 +1,12 @@
+module LabelWeaver
+  class Hooks
+    include Import[:configuration, :logger]
+
+    def run(*path)
+      configuration.hooks.dig(*path)&.each do |hook|
+        logger.any "$> #{hook}"
+        system(hook)
+      end
+    end
+  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.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Stefan Exner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-27 00:00:00.000000000 Z
+date: 2024-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cogger
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
-- !ruby/object:Gem::Dependency
-  name: dry-monads
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: dry-schema
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: etcher
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -246,7 +218,9 @@ files:
 - lib/label_weaver/configuration/defaults.yml
 - lib/label_weaver/configuration/model.rb
 - 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: