heighliner 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2652edf0b183383b89645cee4e2d22210c2099773c124fdfb44073dd9755be47
-  data.tar.gz: ae906d0864fd3f2ceca23cb94c1675ffcf219a4ec4fd3de3082fbaf64a0cd4eb
+  metadata.gz: 07c572f9013340944a13b0fb7a784e97e4d9e589bddd9937d60df842346f9d80
+  data.tar.gz: 8d9c848d91867755298a95474fc53225f04d5bed4a7811f681b86b6930260300
 SHA512:
-  metadata.gz: 4134df6ece248fc364167114265cef9bbe7b39bb4b7746a0d0cbb23f1e0dc22b816d27093295edcc441fe2f0a5fd1e08ccac77cfe03fb37e44e7035a136f8753
-  data.tar.gz: 14d9595f84c5e5f545f942e6ce702bb0c8d97fc2e6603547a46c750caec41a32ebc7285059711b2e960a821d795da5f8ae36d814dd39fd289da071ef60fa3de6
+  metadata.gz: 26b7a442e80ee8249f08a854faa624f03b6af32845f151958f12fd35c162755f10642d9a098d0bbe76922f975feca0525fe9ba6a814abc9f74d1e6055eb0c028
+  data.tar.gz: 971f71b9a51aa4e27404289f2b8d61614168e0a59a83da1189d4ee2c6569500cfef412b968657e0338d3d185f7da74311ded0c074591078a0cbf59bb1bd1c9fc

data/README.md

@@ -112,6 +112,12 @@ open http://myapp.lvh.me
 
 And enjoy previewing your app!
 
+## Examples
+
+See the [examples](examples/) directory for starter projects:
+
+- [simple](examples/simple/) — a minimal Sinatra + Puma app
+
 ## More documentation
 
 You can find even more documentation in https://davidsiaw.github.io/heighliner.
@@ -145,6 +151,9 @@ alias heighliner='docker run --rm -ti \
   -e _HEIGHLINER_USER_HOME=$HOME \
   -e _HEIGHLINER_POS=docker \
   -e CONTEXT_DIR="`pwd`" \
+  -e GIT_CONFIG_COUNT=1 \
+  -e GIT_CONFIG_KEY_0=safe.directory \
+  -e GIT_CONFIG_VALUE_0="$PWD" \        
   davidsiaw/heighliner'
 ```
 
@@ -163,6 +172,9 @@ alias heighliner='docker run --rm -ti \
   -e _HEIGHLINER_USER_HOME=$HOME \
   -e _HEIGHLINER_POS=docker \
   -e CONTEXT_DIR="`pwd`" \
+  -e GIT_CONFIG_COUNT=1 \
+  -e GIT_CONFIG_KEY_0=safe.directory \
+  -e GIT_CONFIG_VALUE_0="$PWD" \        
   -e OP_SERVICE_ACCOUNT_TOKEN=`op read op://Private/local-dev/credential` \
   davidsiaw/heighliner'
 ```

data/lib/heighliner/cli.rb

@@ -503,60 +503,76 @@ module Heighliner
 
     def copy_keyfile(file)
       Config.info_out.puts "Loading certificate file: #{file}"
-      if Config.config[:cert_source][:folder]
-        Config.info_out.puts "  Source: folder (#{Config.config[:cert_source][:folder]})"
-        CommandRunner.run! Config.out, "docker run --rm
-          -v #{Config.config[:shared_names][:certs]}:/certs
-          -v #{Config.config[:cert_source][:folder]}:/cert_source
-          alpine cp /cert_source/#{file} /certs/#{file}"
-
-      elsif Config.config[:cert_source][:url]
-        Config.info_out.puts "  Source: URL (#{Config.config[:cert_source][:url]}/#{file})"
-        CommandRunner.run! Config.out, "docker run --rm
-          -v #{Config.config[:shared_names][:certs]}:/certs
-          alpine wget #{Config.config[:cert_source][:url]}/#{file}
-            -O /certs/#{file}"
-
-      elsif Config.config[:cert_source][:"1password"]
-        item = Config.config[:cert_source][:"1password"]
-        origfield = file.sub(/^#{http_suffix}\./, '')
-        token = ENV['OP_SERVICE_ACCOUNT_TOKEN']
-
-        field = origfield
-        if Config.config[:cert_source]["1password-fields"]
-          field = Config.config[:cert_source]["1password-fields"][origfield]
-        end
+      cert_source = Config.config[:cert_source]
+
+      if cert_source[:folder]
+        copy_keyfile_from_folder(file)
+      elsif cert_source[:url]
+        copy_keyfile_from_url(file)
+      elsif cert_source[:"1password"]
+        copy_keyfile_from_1password(file)
+      end
+    end
+
+    def copy_keyfile_from_folder(file)
+      folder = Config.config[:cert_source][:folder]
+      Config.info_out.puts "  Source: folder (#{folder})"
+      CommandRunner.run! Config.out, "docker run --rm
+        -v #{Config.config[:shared_names][:certs]}:/certs
+        -v #{folder}:/cert_source
+        alpine cp /cert_source/#{file} /certs/#{file}"
+    end
 
-        raise Heighliner::Error, 'OP_SERVICE_ACCOUNT_TOKEN is not set' unless token
+    def copy_keyfile_from_url(file)
+      url = Config.config[:cert_source][:url]
+      Config.info_out.puts "  Source: URL (#{url}/#{file})"
+      CommandRunner.run! Config.out, "docker run --rm
+        -v #{Config.config[:shared_names][:certs]}:/certs
+        alpine wget #{url}/#{file}
+          -O /certs/#{file}"
+    end
 
-        Config.info_out.puts "  Source: 1Password (item: #{item}, field: #{field} (#{origfield}) )"
+    def onepassword_field_for(file)
+      origfield = file.sub(/^#{http_suffix}\./, '')
+      fields = Config.config[:cert_source]['1password-fields']
+      field = fields ? fields[origfield] : origfield
+      [origfield, field]
+    end
 
-        # take it out
-        certstoredir = "#{ENV['CONTEXT_DIR']}/.tmp.certstore"
-        tmpfile = "#{certstoredir}/#{file}"
-        CommandRunner.run!(Config.out, "mkdir -p #{certstoredir}")
-        CommandRunner.run!(Config.out, "op read \"op://#{item}/#{field}\" > #{tmpfile}")
-        Config.info_out.puts("wrote into file #{tmpfile}")
-        CommandRunner.run!(Config.out, "ls #{tmpfile}")
+    def copy_keyfile_from_1password(file)
+      item = Config.config[:cert_source][:"1password"]
+      origfield, field = onepassword_field_for(file)
 
-        # put it in
-        CommandRunner.run! Config.out, "docker run --rm
-          -v #{Config.config[:shared_names][:certs]}:/certs
-          -v #{certstoredir}:/tmpcert
-          alpine
-          cp /tmpcert/#{file} /certs/#{file}"
+      raise Heighliner::Error, 'OP_SERVICE_ACCOUNT_TOKEN is not set' unless ENV['OP_SERVICE_ACCOUNT_TOKEN']
 
-        unless File.exist?(tmpfile) && File.size(tmpfile).positive?
-          raise Heighliner::Error,
-                "1Password field '#{field}' not found in item '#{item}'"
-        end
+      Config.info_out.puts "  Source: 1Password (item: #{item}, field: #{field} (#{origfield}) )"
+
+      certstoredir = "#{ENV['CONTEXT_DIR']}/.tmp.certstore"
+      tmpfile = "#{certstoredir}/#{file}"
 
-        CommandRunner.run! Config.out, "docker run --rm
-          -v #{Config.config[:shared_names][:certs]}:/certs
-          -v #{tmpfile}:/cert_source
-          alpine cp /cert_source /certs/#{file}"
-        CommandRunner.run!(Config.out, "rm #{tmpfile}")
+      # take it out
+      CommandRunner.run!(Config.out, "mkdir -p #{certstoredir}")
+      CommandRunner.run!(Config.out, "op read \"op://#{item}/#{field}\" > #{tmpfile}")
+      Config.info_out.puts("wrote into file #{tmpfile}")
+      CommandRunner.run!(Config.out, "ls #{tmpfile}")
+
+      # put it in
+      CommandRunner.run! Config.out, "docker run --rm
+        -v #{Config.config[:shared_names][:certs]}:/certs
+        -v #{certstoredir}:/tmpcert
+        alpine
+        cp /tmpcert/#{file} /certs/#{file}"
+
+      unless File.exist?(tmpfile) && File.size(tmpfile).positive?
+        raise Heighliner::Error,
+              "1Password field '#{field}' not found in item '#{item}'"
       end
+
+      CommandRunner.run! Config.out, "docker run --rm
+        -v #{Config.config[:shared_names][:certs]}:/certs
+        -v #{tmpfile}:/cert_source
+        alpine cp /cert_source /certs/#{file}"
+      CommandRunner.run!(Config.out, "rm #{tmpfile}")
     end
 
     def prepare_cert_volume!
@@ -596,8 +612,6 @@ module Heighliner
     def ensure_setup
       ensure_env
 
-      setup if network.nil?
-
       create_if_network_not_exist Config.config[:networkname]
       if_container_dead Config.config[:shared_names][:nginx] do
         prepare_cert_volume!
@@ -615,8 +629,11 @@ module Heighliner
           jwilder/nginx-proxy"
       )
 
-      innerdnsconffile = "#{ENV['HOME']}/.heighliner/dnsconf"
-      outerdnsconffile = "#{home_dir_loc}/.heighliner/dnsconf"
+      # The config dir is ~/.kaiser on hosts upgraded from Kaiser, so derive the
+      # directory name instead of hardcoding .heighliner.
+      config_dir_name = File.basename(Config.config_dir)
+      innerdnsconffile = "#{Config.config_dir}/dnsconf"
+      outerdnsconffile = "#{home_dir_loc}/#{config_dir_name}/dnsconf"
       File.write(innerdnsconffile, <<~HOSTS)
         log-queries
         no-resolv
@@ -656,8 +673,20 @@ module Heighliner
       `docker inspect -f '{{#{networkname}}}' #{containername}`.chomp
     end
 
-    def network
-      `docker network inspect #{Config.config[:networkname]} 2>/dev/null`
+    def network_inspect_output(net)
+      `docker network inspect #{net} 2>/dev/null`
+    end
+
+    def network_exists?(net)
+      out = network_inspect_output(net)
+      return false if out.strip.empty?
+
+      !JSON.parse(out).empty?
+    rescue JSON::ParserError
+      # Unparseable output is not evidence the network is absent, and guessing
+      # "absent" is the expensive guess: creating an existing network exits 1 and
+      # kills the command. Assume present and let docker report a real problem.
+      true
     end
 
     def container_dead?(container)
@@ -679,12 +708,14 @@ module Heighliner
     end
 
     def create_if_network_not_exist(net)
-      out = `docker inspect #{net} 2>/dev/null`
-      out = "[]" if out.strip.empty?
-      x = JSON.parse(out)
-      return unless x.empty?
+      return if network_exists?(net)
+
+      # Another heighliner process may create the network between the check and
+      # here, so a failure is not fatal by itself: re-check instead of raising.
+      CommandRunner.run Config.out, "docker network create #{net}"
+      return if network_exists?(net)
 
-      CommandRunner.run! Config.out, "docker network create #{net}"
+      raise Heighliner::Error, "could not create docker network #{net}"
     end
 
     def run_if_dead(container, command)

data/lib/heighliner/config.rb

@@ -14,7 +14,7 @@ module Heighliner
 
       def load(work_dir, use_steerfile: true)
         @work_dir = work_dir
-        @config_dir = "#{ENV['HOME']}/.heighliner"
+        @config_dir = detect_config_dir
 
         migrate_dotted_config_files
 
@@ -38,9 +38,7 @@ module Heighliner
         load_config
 
         if use_steerfile
-          POSSIBLE_STEERFILES.each do |x|
-            @fname = x if File.exist?(x)
-          end
+          @fname = detect_steerfile_name
 
           Optimist.die <<~ERROR if @fname.nil?
             No Steerfile in current directory.
@@ -53,16 +51,41 @@ module Heighliner
         @config
       end
 
+      # Later entries win over earlier ones, so the legacy Kaiser name comes
+      # first: a repo with both files uses the Steerfile.
       POSSIBLE_STEERFILES = %w[
+        Kaiserfile
         Steerfile
         Heighliner.config
         heighliner.config
       ].freeze
 
+      # Kaiserfile is the name Heighliner used when it was called Kaiser. It has
+      # the same contents as a Steerfile, so it is loaded the same way.
+      def detect_steerfile_name
+        POSSIBLE_STEERFILES.select { |x| File.exist?(x) }.last
+      end
+
       def always_verbose?
         @config[:always_verbose]
       end
 
+      # Heighliner used to be called Kaiser. If a user has an old ~/.kaiser
+      # directory and no ~/.heighliner directory yet, keep using the old one
+      # instead of starting from scratch.
+      def detect_config_dir
+        heighliner_dir = "#{home_dir}/.heighliner"
+        kaiser_dir = "#{home_dir}/.kaiser"
+
+        return kaiser_dir if !Dir.exist?(heighliner_dir) && Dir.exist?(kaiser_dir)
+
+        heighliner_dir
+      end
+
+      def home_dir
+        ENV['HOME']
+      end
+
       # Up until version 0.5.1, heighliner used dotfiles for all of it configuration.
       # It makes sense of hide the configuration directory itself but hiding the files
       # inside of it just causes confusion.

data/lib/heighliner/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Heighliner
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heighliner
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - David Siaw
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-06-20 00:00:00.000000000 Z
+date: 2026-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport