wslc-wip 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be995c6781c440a7fd84dd3c3bbbddd6799154b59694edce5aa653d80c7d6e53
-  data.tar.gz: 7fb1638a125b2bce92212e8ff525a38e31e2d8aa4386e3e74e379420d4df9c91
+  metadata.gz: '0845dfb67f17323b8a99e6f2f92ef06c17bc03fd1316680cf5f43f2640d73da3'
+  data.tar.gz: 6eea9bb520aed0fff5b401b71a20dccdade6b50d9a71403037e59e4e5b83ab2e
 SHA512:
-  metadata.gz: 539721780baa7f366f215581629a761c85e396823e05ff08a3da97c2d0de7808d1470c959240867a5a0ab762f4441ea8b2cb22c92f0063712a18c6b0f80dc4fe
-  data.tar.gz: fc00ceceeeb01cd63ac931ff2ffeea1f64848f38a1222b60b8c5de7a501e914a3820d61abbd7d437ebd412e2046958223edab7b46d582b5cb6ef693badf5cc3e
+  metadata.gz: 1b522d206ba3070244f51bda9d4e144dfe95df63ab01bb92b35d0fe0e84a29035c997d7b061c2ec23286c8bd9f586c69e276b7304abd1c8ad81fe808293599b5
+  data.tar.gz: d7fc237820edfcc734f55775e027133c5f9877c24b16f5b1ca6aa98304b35fdea5825a179ff7f64b4d22fe2634d52d11761777284b68a86e76faa56432d33230

data/README.md

@@ -103,6 +103,22 @@ commands:
 credential, or auth. Keep real secrets out of the config file and in your runtime environment
 instead.
 
+### .env
+
+Like `docker compose`, `wip` automatically loads a `.env` file next to `wip.yml` (one `KEY=VALUE`
+per line; `#` comments, blank lines, `export` prefixes, and quoted values are all supported) and
+passes its keys through as container environment variables on `build`, `up`, `run`, `exec`, and
+custom commands. `.env` only fills in keys that aren't already set by `defaults.env` or a
+command/dependency's own `env` — those always win on conflict. Pass `--env-file PATH` to load a
+different file instead.
+
+### .dockerignore
+
+`wip build` reads `.dockerignore` from the build context and stages a filtered copy of the
+context (skipping anything it matches) before handing it to `wslc build`, since `wslc` sends the
+context as-is otherwise. If there's no `.dockerignore`, the original context directory is used
+directly with no copying.
+
 ### Dependency containers
 
 If your app needs sidecar services (a database, Redis, ...), declare them under `dependencies`

data/lib/wip/build_context.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'pathname'
+require 'tmpdir'
+
+module Wip
+  # Stages a build context into a scratch directory with anything matched by
+  # .dockerignore left out, since wslc build (unlike `docker build`) sends the
+  # context as-is instead of filtering it itself.
+  class BuildContext
+    def initialize(context, ignore: nil)
+      @root = Pathname(context).expand_path
+      @ignore = ignore || DockerIgnore.load(@root.join('.dockerignore'))
+    end
+
+    def stage
+      return yield @root.to_s if @ignore.empty?
+
+      Dir.mktmpdir('wip-build-context-') do |dir|
+        copy_included_files(Pathname(dir))
+        yield dir
+      end
+    end
+
+    private
+
+    def copy_included_files(destination)
+      each_included_file do |relative_path|
+        target = destination.join(relative_path)
+        FileUtils.mkdir_p(target.dirname)
+        FileUtils.cp(@root.join(relative_path), target)
+      end
+    end
+
+    def each_included_file
+      Dir.glob('**/*', File::FNM_DOTMATCH, base: @root.to_s).each do |entry|
+        next if %w[. ..].include?(entry)
+
+        path = @root.join(entry)
+        next unless path.file?
+        next if @ignore.ignored?(entry)
+
+        yield entry
+      end
+    end
+  end
+end

data/lib/wip/cli.rb

@@ -9,6 +9,7 @@ module Wip
   # Thor-based command-line interface for wip.
   class CLI < Thor
     class_option :config, type: :string, desc: 'Path to wip.yml'
+    class_option :env_file, type: :string, desc: 'Path to a dotenv file (default: .env next to wip.yml)'
     class_option :debug, type: :boolean, default: false, desc: 'Print progress and timing for each step'
     class_option :debug_log, type: :string, desc: 'Where --debug snapshots go: a file path, or "-" for inline'
     default_task :dispatch
@@ -52,7 +53,11 @@ module Wip
     desc 'build [OPTIONS]', 'Build the configured image'
     def build(*extra)
       extra.shift if extra.first == '--'
-      execute(builder.build(settings: load_config.command('build') || {}, extra: extra))
+      settings = load_config.command('build') || {}
+      context = settings['context'] || load_config.defaults['context'] || '.'
+      BuildContext.new(context).stage do |staged_context|
+        execute(builder.build(settings: settings.merge('context' => staged_context), extra: extra))
+      end
     end
 
     desc 'up', 'Start the configured container and its dependencies, creating them if necessary'
@@ -118,7 +123,16 @@ module Wip
     def loader = ConfigLoader.new(path: options[:config])
     def load_config = (@load_config ||= loader.load)
     def resolver = CommandResolver.new
-    def builder = CommandBuilder.new(wslc: resolver.resolve(load_config.wslc_command), config: load_config)
+
+    def dotenv_path
+      options[:env_file] ? Pathname(options[:env_file]).expand_path : Pathname(load_config.path).dirname.join('.env')
+    end
+
+    def dotenv = @dotenv ||= DotenvLoader.new(dotenv_path).load
+
+    def builder
+      CommandBuilder.new(wslc: resolver.resolve(load_config.wslc_command), config: load_config, dotenv: dotenv)
+    end
 
     def execute(command, interactive: false, exit_on_failure: true)
       runner = CommandRunner.new(debug: debug?)

data/lib/wip/command_builder.rb

@@ -5,10 +5,11 @@ require 'shellwords'
 module Wip
   # Builds the argument arrays for wslc build/exec/run/custom invocations.
   class CommandBuilder
-    def initialize(wslc:, config:, environment: Environment.new)
+    def initialize(wslc:, config:, environment: Environment.new, dotenv: {})
       @wslc = wslc
       @config = config
       @environment = environment
+      @dotenv = dotenv
     end
 
     def exec(arguments, settings: {}, interactive: true)
@@ -115,7 +116,7 @@ module Wip
     def options(values, include_container: false, include_publish: true)
       result = []
       result.push('-w', values['workdir']) unless values['workdir'].to_s.empty?
-      values.fetch('env', {}).each { |key, value| result.push('-e', "#{key}=#{value}") }
+      merged_env(values).each { |key, value| result.push('-e', "#{key}=#{value}") }
       if include_publish
         Array(values['ports']).each { |port| result.push('-p', port.to_s) }
         Array(values['volumes']).each { |volume| result.push('-v', volume.to_s) }
@@ -124,6 +125,9 @@ module Wip
       result
     end
 
+    # .env supplies defaults; env set in wip.yml (defaults or per-command) wins on conflict.
+    def merged_env(values) = @dotenv.merge(values.fetch('env', {}))
+
     def required(values, key)
       value = values[key]
       raise ConfigError, "Configured #{key} must not be empty" if value.to_s.empty?

data/lib/wip/docker_ignore.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Wip
+  # Parses a .dockerignore file and decides whether a build-context-relative
+  # path should be excluded, following the same pattern rules as the Docker
+  # CLI (gitignore-like globs, later rules override earlier ones, `!` negates).
+  class DockerIgnore
+    Rule = Struct.new(:pattern, :negate)
+
+    FNMATCH_FLAGS = File::FNM_PATHNAME | File::FNM_DOTMATCH | File::FNM_EXTGLOB
+
+    def self.load(path)
+      path = Pathname(path)
+      return new([]) unless path.file?
+
+      new(path.readlines)
+    end
+
+    def initialize(lines)
+      @rules = lines.filter_map { |line| parse(line) }
+    end
+
+    def empty? = @rules.empty?
+
+    def ignored?(relative_path)
+      @rules.reduce(false) do |ignored, rule|
+        matches?(rule.pattern, relative_path) ? !rule.negate : ignored
+      end
+    end
+
+    private
+
+    def parse(line)
+      line = line.strip
+      return nil if line.empty? || line.start_with?('#')
+
+      negate = line.start_with?('!')
+      pattern = negate ? line[1..] : line
+      pattern = pattern.delete_suffix('/')
+      anchored = pattern.start_with?('/')
+      pattern = pattern.delete_prefix('/')
+      pattern = "**/#{pattern}" if !anchored && !pattern.include?('/')
+      Rule.new(pattern, negate)
+    end
+
+    # A match on a directory component also excludes everything under it,
+    # so every prefix of the path (not just the full path) is tested.
+    def matches?(pattern, relative_path)
+      components = relative_path.split('/')
+      (1..components.size).any? do |i|
+        File.fnmatch(pattern, components[0...i].join('/'), FNMATCH_FLAGS)
+      end
+    end
+  end
+end

data/lib/wip/dotenv_loader.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Wip
+  # Parses a .env file the way `docker compose` does, so values don't have to
+  # be duplicated into wip.yml just to reach the container as -e flags.
+  class DotenvLoader
+    LINE_PATTERN = /\A(?:export\s+)?([A-Za-z_][A-Za-z0-9_]*)=(.*)\z/
+
+    def initialize(path)
+      @path = Pathname(path)
+    end
+
+    def load
+      return {} unless @path.file?
+
+      @path.readlines.each_with_object({}) do |line, env|
+        line = line.strip
+        next if line.empty? || line.start_with?('#')
+
+        match = LINE_PATTERN.match(line)
+        next unless match
+
+        env[match[1]] = unquote(match[2])
+      end
+    end
+
+    private
+
+    def unquote(value)
+      value = value.strip
+      return value[1..-2] if value.start_with?('"') && value.end_with?('"') && value.length >= 2
+      return value[1..-2] if value.start_with?("'") && value.end_with?("'") && value.length >= 2
+
+      value.split(/\s+#/, 2).first.to_s.strip
+    end
+  end
+end

data/lib/wip/version.rb

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

data/lib/wip.rb

@@ -5,6 +5,9 @@ require_relative 'wip/errors'
 require_relative 'wip/config'
 require_relative 'wip/config_loader'
 require_relative 'wip/environment'
+require_relative 'wip/dotenv_loader'
+require_relative 'wip/docker_ignore'
+require_relative 'wip/build_context'
 require_relative 'wip/command_resolver'
 require_relative 'wip/error_interpreter'
 require_relative 'wip/command_builder'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wslc-wip
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Wip contributors
@@ -33,6 +33,7 @@ files:
 - README.md
 - exe/wip
 - lib/wip.rb
+- lib/wip/build_context.rb
 - lib/wip/cli.rb
 - lib/wip/command_builder.rb
 - lib/wip/command_display.rb
@@ -41,7 +42,9 @@ files:
 - lib/wip/config.rb
 - lib/wip/config_loader.rb
 - lib/wip/debug_reporter.rb
+- lib/wip/docker_ignore.rb
 - lib/wip/doctor.rb
+- lib/wip/dotenv_loader.rb
 - lib/wip/environment.rb
 - lib/wip/error_interpreter.rb
 - lib/wip/errors.rb