wslc-wip 0.17.0 → 0.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b6d4bd2dc0f6ceb899efeaebe7378c6b043915b2d640bf4efff7501f5ca4852
-  data.tar.gz: e5d6c0ed4b89bacaa374482bc7e815a5b04883b4d817809b6dbb0a91c9801ae3
+  metadata.gz: ffab59f2ac2df1c7a566825b0ee97eeff0b515396b42f3b95b1067b361d3aa8c
+  data.tar.gz: 9500d0b3842aa86f2aaabdc41b89986cad0c66fa0b765b130c6b37679212b985
 SHA512:
-  metadata.gz: aed82d2db66e8036c55986181ce73fc032a1785c3ac3a314aadcc2ef7a8b91f6280dc31cbc209aa97dd25ad5eed536013954ca593b61ed966792004209ebcb2f
-  data.tar.gz: 94ee0961eddd267ca8fc8e8f1e198dbd4793801b15c2512539ff55c6cb5223c5ae7e331807030f7eca8d5264b38527db6f4e993ae61fb14d4ef6bdbf26eaf1ad
+  metadata.gz: 96991898c1e0b423ad14151ee6b7db24bc38c8ea84b7f5213c69d14d83786288faa5b2d1f71c94382611c0f4c569aa939333e66a3e050095b45a1d50b6ef4bb6
+  data.tar.gz: 963d62e619fab36835541421ce7f1642a98e063ba916a0c466311d6138ddce53bf6cae3660dbdadd779272defe81898fa153d9be17a661c11be4c93bff8179e5

data/lib/wip/cli.rb

@@ -70,6 +70,7 @@ module Wip
       extra.shift if extra.first == '--'
       settings = load_config.command('build') || {}
       context = settings['context'] || '.'
+      warn "wip: staging build context (#{context})"
       BuildContext.new(context).stage do |staged_context|
         execute(builder.build(settings: settings.merge('context' => staged_context), extra: extra))
       end
@@ -188,7 +189,11 @@ module Wip
 
     private
 
-    def loader = ConfigLoader.new(path: options[:config])
+    def loader
+      env_file = options[:env_file] && Pathname(options[:env_file]).expand_path
+      ConfigLoader.new(path: options[:config], env_file: env_file)
+    end
+
     def load_config = (@load_config ||= loader.load)
     def resolver = CommandResolver.new
 

data/lib/wip/command_runner.rb

@@ -26,8 +26,7 @@ module Wip
         threads.each(&:join)
         status = wait.value
       end
-      hint = @interpreter.interpret(captured)
-      @stderr.puts("\n#{hint}") if !status.success? && hint
+      report_hint(captured) unless status.success?
       status.exitstatus
     rescue Errno::ENOENT => e
       @stderr.puts e.message
@@ -39,6 +38,11 @@ module Wip
 
     private
 
+    def report_hint(captured)
+      hint = @interpreter.interpret(captured.force_encoding(Encoding::UTF_8).scrub)
+      @stderr.puts("\n#{hint}") if hint
+    end
+
     # Piping stdin/stdout/stderr (as `run` does above) closes the child's
     # stdin immediately, which breaks anything that reads from the terminal
     # (a shell, `rails console`, ...). Inherit the real file descriptors

data/lib/wip/compose_file.rb

@@ -30,8 +30,11 @@ module Wip
     BUILD_KEYS = %w[context dockerfile args].freeze
     SUPPORTED_CONDITIONS = %w[service_started].freeze
 
-    def self.load(path)
-      raw = YAML.safe_load_file(path, aliases: true)
+    # env interpolates compose.yml's ${VAR} references the way `docker compose` does,
+    # so values like `user: ${USER_ID}:${GROUP_ID}` reach wslc already substituted
+    # instead of literally (see Config#compose_interpolation_env for what's passed in).
+    def self.load(path, env: {})
+      raw = VariableInterpolation.tree(YAML.safe_load_file(path, aliases: true), env)
       raise ConfigError, "#{path}: services: must be a mapping" unless raw.is_a?(Hash) && raw['services'].is_a?(Hash)
 
       new(raw['services'], path: path)

data/lib/wip/config.rb

@@ -19,9 +19,10 @@ module Wip
     MODES = %w[container compose compose-native].freeze
     attr_reader :path
 
-    def initialize(raw, path = nil)
+    def initialize(raw, path = nil, env_file = nil)
       @raw = stringify(raw)
       @path = path
+      @env_file = env_file
       validate!
     end
 
@@ -202,7 +203,20 @@ module Wip
     def presence(value) = value.to_s.empty? ? nil : value.to_s
 
     def parsed_compose_file
-      @parsed_compose_file ||= ComposeFile.load(ComposeBridge.file_path(self))
+      @parsed_compose_file ||= ComposeFile.load(ComposeBridge.file_path(self), env: compose_interpolation_env)
+    end
+
+    # Compose interpolates ${VAR} references in compose.yml from the shell environment
+    # and a project .env file, shell values winning on conflict — mirror that here so
+    # `wip` doesn't need the value duplicated into wip.yml just to resolve a compose.yml
+    # reference. Uses the same dotenv file --env-file/DotenvLoader would (explicit
+    # override, else .env next to wip.yml), so compose interpolation and the env
+    # actually passed to containers never see two different .env files.
+    def compose_interpolation_env
+      env_file = @env_file || (path && Pathname(path).dirname.join('.env'))
+      return ENV.to_h unless env_file
+
+      DotenvLoader.new(env_file).load.merge(ENV.to_h)
     end
 
     def default_compose_network = path && Pathname(path).dirname.basename.to_s

data/lib/wip/config_loader.rb

@@ -8,9 +8,10 @@ module Wip
   class ConfigLoader
     FILENAME = 'wip.yml'
 
-    def initialize(start_dir: Dir.pwd, path: nil)
+    def initialize(start_dir: Dir.pwd, path: nil, env_file: nil)
       @start_dir = Pathname(start_dir).expand_path
       @path = path
+      @env_file = env_file
     end
 
     def find
@@ -28,7 +29,7 @@ module Wip
       raise ConfigError, "wip.yml was not found (searched from #{@start_dir} to the filesystem root)" unless path&.file?
 
       data = YAML.safe_load_file(path, permitted_classes: [], aliases: false) || {}
-      Config.new(data, path)
+      Config.new(data, path, @env_file)
     rescue Psych::Exception => e
       raise ConfigError, "Could not parse #{path}: #{e.message}"
     end

data/lib/wip/initializer.rb

@@ -122,23 +122,7 @@ module Wip
         # optional; exec (default, mirrors into the running container) | run (always a fresh container)
         mode: exec
 
-        # image/build below always cover `wip up`'s pre-boot mirror (a throwaway container, since
-        # the primary one isn't running yet — falls back to the primary image if neither is set).
-        # With mode: exec above (the default here), `wip sync`/`wip sync --watch` afterward run
-        # rsync inside the already-running primary container instead, so its own image needs
-        # rsync installed too — image/build below aren't read for those.
-
-        # image the pre-boot (and, under sync.mode: run, every) mirror container runs
-        # image: your/image:tag
-
-        # alternative to image — let wip build a small dedicated mirror image itself
-        # build:
-        #   dockerfile: |
-        #     FROM alpine:latest
-        #     RUN apk add --no-cache rsync
-
-        #   optional (default: wip-sync-<container>:latest)
-        #   tag: wip-sync-app:latest
+        # sync.image/sync.build — required for mode: compose and used by sync.mode: run; see README "Source sync"
       YAML
     end
 

data/lib/wip/variable_interpolation.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Wip
+  # Interpolates ${VAR} references the way `docker compose` does when reading
+  # compose.yml: ${VAR}, ${VAR:-default}/${VAR-default}, bare $VAR, and $$ as an
+  # escaped literal dollar sign. ${VAR:?err}/${VAR:+alt} aren't recognized by
+  # PATTERN at all, so — unlike an unset $VAR/${VAR}, which this resolves to an
+  # empty string — they pass through completely unchanged, "${...}" and all.
+  module VariableInterpolation
+    PATTERN = /\$\$|\$\{([A-Za-z_][A-Za-z0-9_]*)((:-|-)([^}]*))?\}|\$([A-Za-z_][A-Za-z0-9_]*)/
+
+    def self.call(text, env)
+      text.gsub(PATTERN) do |matched|
+        next '$' if matched == '$$'
+
+        name, _, operator, default, bare_name = Regexp.last_match.captures
+        resolve(env[name || bare_name], operator, default)
+      end
+    end
+
+    # Walks an already-parsed YAML structure and interpolates string values only —
+    # real Compose interpolates YAML values, never mapping keys (its docs call this
+    # out explicitly), and doing this after parsing means a substituted value can't
+    # introduce YAML syntax (e.g. a literal "#" turning into a comment marker).
+    #
+    # `seen` tracks Hash/Array objects on the current recursion path (by identity,
+    # not #==) so a self-referential YAML alias — ComposeFile.load parses with
+    # aliases: true — raises instead of recursing until SystemStackError. The same
+    # object reached again from a *different* branch (an anchor reused, not a
+    # cycle) is fine: it's removed from `seen` once its own subtree finishes.
+    def self.tree(value, env, seen = {}.compare_by_identity)
+      case value
+      when String then call(value, env)
+      when Hash, Array then walk_container(value, env, seen)
+      else value
+      end
+    end
+
+    def self.walk_container(value, env, seen)
+      raise ConfigError, 'compose.yml contains a self-referential YAML alias' if seen.key?(value)
+
+      seen[value] = true
+      begin
+        value.is_a?(Hash) ? value.transform_values { |v| tree(v, env, seen) } : value.map { |v| tree(v, env, seen) }
+      ensure
+        seen.delete(value)
+      end
+    end
+    private_class_method :walk_container
+
+    def self.resolve(value, operator, default)
+      case operator
+      when ':-' then value.nil? || value.empty? ? default.to_s : value
+      when '-' then value.nil? ? default.to_s : value
+      else value.to_s
+      end
+    end
+    private_class_method :resolve
+  end
+end

data/lib/wip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wip
-  VERSION = '0.17.0'
+  VERSION = '0.17.2'
 end

data/lib/wip.rb

@@ -13,6 +13,7 @@ require_relative 'wip/command_resolver'
 require_relative 'wip/error_interpreter'
 require_relative 'wip/command_builder'
 require_relative 'wip/compose_bridge'
+require_relative 'wip/variable_interpolation'
 require_relative 'wip/compose_file'
 require_relative 'wip/initializer'
 require_relative 'wip/command_display'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wslc-wip
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.17.2
 platform: ruby
 authors:
 - Wip contributors
@@ -53,6 +53,7 @@ files:
 - lib/wip/initializer.rb
 - lib/wip/resource_monitor.rb
 - lib/wip/sync_settings.rb
+- lib/wip/variable_interpolation.rb
 - lib/wip/version.rb
 homepage: https://wslc-wip.slidict.com/
 licenses: