litbuild 1.0.3 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79441e2b11890ec0e9a3271224f80ed9ca7c40f548fc3ee59bf774a55d3ff54f
-  data.tar.gz: 77ab5c060afb201d5a0014e92bd8e2ad1352efc8dbc0d37d864992d159a53be9
+  metadata.gz: 021106eb1915ada36b41382da16fdde8d9c2762d3e250dc0cbdb5067c7432bcf
+  data.tar.gz: a42ebf4088c9c1f7b9ae2d3d4f238ec2e9610c17c6fd07da1e0af6a5938c71dd
 SHA512:
-  metadata.gz: 5f0a0bb98c15066ad8f945a1717ccbfdaa59bb7ac60caa8975459cf62a2601367dab0d68e3e7722999726de22f3d1acbac92a957972574184b430a8ee1d8dbef
-  data.tar.gz: a366a4a6c91629107a7f9d3868273b8bce8baf26670dc22b4d1edb53d5c31dcbd8fc1e9c2835561f96d576c6cc5a113d6cd261663a12edff7e285085b8d07d0e
+  metadata.gz: 93da197d79732d1944ec9821f2d567c76962408923e68a2642789a4408176ab341dcf6e2fb61b2274413b98272e2d4f3cf979c38b20d11186d7f80a6a8e90238
+  data.tar.gz: 2a38bdce9e787c5685ccaf92fca51cffc16da80c900694701fc6a169aef9c9e8797eedbf8fe53d317e2129000126bff9076d69ba4da0f0bba086630e367b6928

data/bin/lb

@@ -4,14 +4,10 @@
 gem 'litbuild'
 require 'litbuild'
 require 'optparse'
-require 'ostruct'
 require 'fileutils'
 
-options = OpenStruct.new
-
-# defaults:
-options.query = nil
-options.version = false
+Options = Struct.new(:query, :version)
+options = Options.new(nil, false)
 
 OptionParser.new do |opts|
   opts.banner = 'Usage: lb [options] target'

data/lib/litbuild/ascii_doc_visitor.rb

@@ -139,10 +139,9 @@ module Litbuild
       FileUtils.mkdir_p(location)
       doc_name = format('%<count>02d-%<doc>s',
                         count: @written[location].size,
-                        doc: blueprint.file_name + '.adoc')
-      File.open(File.join(location, doc_name), 'w') do |f|
-        f.write(to_asciidoc(blueprint, extra, summary, block))
-      end
+                        doc: "#{blueprint.file_name}.adoc")
+      content = to_asciidoc(blueprint, extra, summary, block)
+      File.write(File.join(location, doc_name), content)
       @written[location] << doc_name
       @all_written_targets << blueprint.target_name
     end
@@ -180,12 +179,12 @@ module Litbuild
       extra.call(doc)
       # If there are any extraneous blank lines in the document, get rid
       # of them.
-      doc.string.gsub(/\n\n\n+/, "\n\n").strip + "\n"
+      "#{doc.string.gsub(/\n\n\n+/, "\n\n").strip}\n"
     end
 
     def phase_heading(level, blueprint)
       "[[#{blueprint.name_with_phase},#{blueprint.header_text_with_phase}]]\n" \
-      "#{level} #{blueprint.header_text_with_phase}\n\n"
+        "#{level} #{blueprint.header_text_with_phase}\n\n"
     end
 
     def render_grafs(doc, grafs, block)
@@ -397,9 +396,8 @@ module Litbuild
         end
         if !package.phases? || for_phase
           write_environment_row(doc, package)
-          if package.build_dir
+          package.build_dir &&
             doc.puts("|Build Directory| `#{package.build_dir}`")
-          end
         end
         doc.puts("|===\n\n")
       end

data/lib/litbuild/bash_script_visitor.rb

@@ -104,6 +104,7 @@ module Litbuild
         skip_line(f)
         f.puts("trap 'echo UTTER FAILURE on line $LINENO' ERR")
         f.puts('set -e -v')
+        f.puts('cd $(dirname $0)')
         skip_line(f)
         write_components(location: script_dir, script: f)
         f.puts('set +v')
@@ -120,13 +121,11 @@ module Litbuild
       FileUtils.mkdir_p(location)
       script_name = format('%<count>02d-%<script>s',
                            count: @written[location].size,
-                           script: blueprint.file_name + '.sh')
+                           script: "#{blueprint.file_name}.sh")
       script_path = File.join(location, script_name)
-      File.open(script_path, 'w') do |f|
-        f.write(to_bash_script(blueprint, block))
-      end
+      File.write(script_path, to_bash_script(blueprint, block))
       FileUtils.chmod('ugo+x', script_path)
-      envcmds = environment_commands(blueprint).reject { |c| c =~ /^mkdir/ }
+      envcmds = environment_commands(blueprint).grep_v(/^mkdir/)
       unless envcmds.empty?
         envscript = File.join(location, "env_#{blueprint.file_name}.sh")
         File.open(envscript, 'w') do |f|
@@ -214,11 +213,11 @@ module Litbuild
       return [] if running_as_root
 
       raw_sudo_cmds = @all_commands.select do |c|
-        c =~ /sudo / && c.lines.size < 2
+        c.include?('sudo ') && c.lines.size < 2
       end.uniq
       sudo_cmds = raw_sudo_cmds.map do |c|
         sudoed_cmd = c.sub(/^.*sudo (.*)$/, '\\1')
-        sudoed_cmd = sudoed_cmd.sub(/;.*$/, '') if sudoed_cmd.match?(/;/)
+        sudoed_cmd = sudoed_cmd.sub(/;.*$/, '') if sudoed_cmd.include?(';')
         sudoed_cmd = convert_to_absolute(sudoed_cmd)
         sudoed_cmd.gsub(/([,:=\\])/, '\\\\\1')
       end
@@ -241,17 +240,39 @@ module Litbuild
       build_location = dir_for_build(package)
 
       if package.build_dir
-        render_command(script, "mkdir -p #{build_location}", '/dev/null')
+        render_command(script, "mkdir -p #{build_location}")
         skip_line(script)
       end
 
+      # When actually running stage commands: if something goes wrong we
+      # want to try one more time without MAKEFLAGS set. This addresses
+      # the case where parallelism breaks builds, and also addresses
+      # ephemeral compiler errors that can crop up when using an
+      # emulated virtual machine.
+      #
+      # The simplest way of doing that, with proper `set -e` behavior,
+      # is to have a separate script for each stage and possibly run
+      # each script twice. (Shell functions don't work the same way.
+      # Bash is complicated.) So here we are going to write out
+      # temporary scripts that we can then invoke.
+      render_command(script, 'scriptdir=$(mktemp -d pkg.XXXXXX)')
+      render_command(script, 'trap "rm -rf $scriptdir" EXIT')
+      skip_line(script)
       Package::BUILD_STAGES.each do |stage|
+        path = "$scriptdir/#{stage}.sh"
+        render_command(script, "cat > #{path} <<'LBEOF'")
+        render_command(script, '#!/bin/bash')
+        render_command(script, 'set -e')
         log = package.logfile(stage, phase)
         render_in_dir(script, build_location) do
           package.build_commands(stage).each do |command|
             render_command(script, command, log)
           end
         end
+        render_command(script, 'LBEOF')
+        render_command(script, "chmod 755 #{path}")
+        exec_cmd = "#{path} >> #{log} 2>&1"
+        render_command(script, "#{exec_cmd} || MAKEFLAGS='' #{exec_cmd}")
       end
       render_restart_trailer(script, restart_file, package.version)
     end
@@ -311,7 +332,6 @@ module Litbuild
       log = package.logfile('pkgusr')
       pkgusr_dir = "~#{pkgusr}"
       package.directives['configuration-files'] ||= []
-      package.directives['configuration-files'] << "~#{pkgusr}/options"
       restart_file = ".#{package.active_phase || 'default'}"
       render_restart_header(script, restart_file, package.version, pkgusr_dir)
       pkgusr_srcdir = File.join(pkgusr_dir, package.name_and_version)
@@ -366,7 +386,7 @@ module Litbuild
       package.build_dir && options.puts("export build_dir=#{package.build_dir}")
       render_intree_commands(package, options)
       Package::BUILD_STAGES.each do |stage|
-        options.puts("function #{stage}_commands()\n{")
+        options.puts("function #{stage}_commands\n{")
         cmds = package.build_commands(stage)
         if cmds.empty?
           options.puts(':')
@@ -425,11 +445,14 @@ module Litbuild
       script.puts('fi')
     end
 
-    def render_command(script, command, log)
+    def render_command(script, command, log = nil)
       unfolded_command = command.gsub(/ ?\\\n */, ' ')
       @all_commands << unfolded_command
-      if unfolded_command.match?(/>/)
-        # redirecting output of command, can't put stdout in log.
+
+      # If a command's output is being redirected, it can't be logged.
+      # And if logging is being done elsewhere, we don't need to do it
+      # here.
+      if unfolded_command.include?('>') || log.nil?
         script.puts(unfolded_command)
       else
         script.puts("#{unfolded_command} >> #{log} 2>&1")
@@ -485,9 +508,8 @@ module Litbuild
       sdirs = spipe['servicedirs']
       sdirs.each_with_index do |sdir, i|
         render_service_dir(script, sdir)
-        if i == sdirs.size - 1
+        i == sdirs.size - 1 &&
           script.puts("echo #{pname} > #{sdir['name'].first}/pipeline-name")
-        end
         if i < sdirs.size - 1
           next_svc = sdirs[i + 1]['name'].first
           script.puts("echo #{next_svc} > #{sdir['name'].first}/producer-for")
@@ -537,7 +559,10 @@ module Litbuild
       cfgs = blueprint['configuration-files']
       return unless cfgs
 
-      render_command(script, "cfggit add #{cfgs.join(' ')}", log)
+      unless cfgs.empty?
+        cmd = "cfggit add #{cfgs.join(' ')}"
+        render_command(script, cmd, log)
+      end
       render_command(script, 'cfggit stageall', log)
       bp = "#{blueprint.class.name.split('::').last} #{blueprint.name}"
       cmd = "cfggit as-default -m 'Configuration files for #{bp}'"
@@ -553,11 +578,12 @@ module Litbuild
       # now, if the value contains ' -- backslash-quote everything (incl spaces)
       # if the value contains " -- single-quote the whole thing
       # if the value contains other punctuation -- double-quote the whole thing
-      if oneline.match?(/'/)
+      case oneline
+      when /'/
         oneline.gsub(/([\\ "'`$])/, '\\\\\1')
-      elsif oneline.match?(/"/)
+      when /"/
         "'#{oneline}'"
-      elsif oneline.match?(/[\\ `]/)
+      when /[\\ `]/
         "\"#{oneline}\""
       else
         oneline

data/lib/litbuild/blueprint.rb

@@ -8,7 +8,7 @@ require 'litbuild/visitor'
 
 module Litbuild
   class Blueprint
-    class <<self
+    class << self
       # This should simply be the name of the directory where blueprints
       # of each specific type are expected to be found by Driver.
       def self.directory_name
@@ -16,9 +16,7 @@ module Litbuild
       end
     end
 
-    attr_reader :active_phase
-    attr_reader :base_grafs
-    attr_writer :logfile_namer
+    attr_reader :active_phase, :base_grafs, :logfile_namer
 
     def self.descendants
       ObjectSpace.each_object(Class).select { |c| c < self }
@@ -180,7 +178,7 @@ module Litbuild
     # to avoid including two versions of the dependency.
     def deduped_dependency_names
       dep_names = self['depends-on'].clone || []
-      deps_with_phase = dep_names.select { |dep| dep.match?(/::/) }
+      deps_with_phase = dep_names.select { |dep| dep.include?('::') }
       deps_with_phase.each do |dep|
         dep_without_phase = dep.split('::')[0]
         dep_names.delete(dep_without_phase)
@@ -209,7 +207,7 @@ module Litbuild
     def resolve_all(parameters, something)
       case something
       when Hash
-        something.values.each { |element| resolve_all(parameters, element) }
+        something.each_value { |element| resolve_all(parameters, element) }
       when Array
         something.each { |element| resolve_all(parameters, element) }
       when String
@@ -220,9 +218,8 @@ module Litbuild
     def resolve(parameters:, a_string:)
       params = a_string.scan(/PARAM\[([A-Z_]+)\]/).flatten.sort.uniq
       params.each do |p|
-        unless parameters[p]
+        parameters[p] ||
           raise(ParameterMissing, "Parameter #{p} is not defined")
-        end
 
         a_string.gsub!(/PARAM\[#{p}\]/, parameters[p])
       end

data/lib/litbuild/blueprint_library.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'litbuild/commands.rb'
-require 'litbuild/narrative.rb'
-require 'litbuild/package.rb'
-require 'litbuild/section.rb'
+require 'litbuild/commands'
+require 'litbuild/narrative'
+require 'litbuild/package'
+require 'litbuild/section'
 
 module Litbuild
   # BlueprintLibrary initializes and sets configuration parameters for
@@ -33,9 +33,7 @@ module Litbuild
     def blueprint_for(target:)
       name, phase = split_name_and_phase(target: target)
       bp = blueprints[name]
-      unless bp
-        raise(UnknownBlueprint, "Blueprint #{name} not found in library")
-      end
+      bp || raise(UnknownBlueprint, "Blueprint #{name} not found in library")
 
       bp.for_phase(phase)
     end
@@ -46,7 +44,7 @@ module Litbuild
     def dependencies_for(blueprint)
       dep_names = blueprint.deduped_dependency_names
       dep_names.map do |dep|
-        if dep.match?(/::/) # Explicit phase specified
+        if dep.include?('::') # Explicit phase specified
           blueprint_for(target: dep)
         else
           bp = blueprint_for(target: dep)
@@ -64,7 +62,7 @@ module Litbuild
     # split a target name, like linux::headers, into a blueprint name
     # (linux) and a phase name (headers).
     def split_name_and_phase(target:)
-      if target.match?(/::/)
+      if target.include?('::')
         target.strip.match(/(.*)::(.*)/)[1..2]
       else
         [target.strip, nil]
@@ -82,13 +80,15 @@ module Litbuild
       # works around the issue, whatever it is.
       return unless blueprint_type.name
 
+      # All blueprints have a name and a full-name. If a blueprint has
+      # no `name:` or `full-name:` directive, they will be provided at
+      # load time.
+      automatic_directives = %w[name full-name]
+
       Dir.glob("./#{blueprint_type.directory_name}/*.txt").each do |a_file|
         bp_text = File.read(a_file)
         begin
-          # All blueprints have a name and a full-name. If a blueprint
-          # has no `name:` or `full-name:` directive, they will be
-          # provided at load time.
-          %w[name full-name].each do |directive|
+          automatic_directives.each do |directive|
             unless bp_text.match?(/^#{directive}:/)
               bp_text = "#{directive}: #{File.basename(a_file, '.txt')}\n\n" +
                         bp_text

data/lib/litbuild/blueprint_parser.rb

@@ -97,7 +97,7 @@ module Litbuild
     end
 
     def directives?(paragraph)
-      paragraph.split(' ').first =~ /^[a-z-]+:/
+      paragraph.split.first =~ /^[a-z-]+:/
     end
 
     def add_directives(directives, parsed)
@@ -124,13 +124,11 @@ module Litbuild
         firstline_value = md[2]
         value_lines = related_lines(directive_line, lines_to_process)
         value = parse_directive_value(firstline_value, value_lines)
-        if value == "''"
-          # two literal apostrophes is a special case, we treat it as an
-          # empty string. Probably ought to document that.
-          graf_directives[directive_name] << ''
-        else
-          graf_directives[directive_name] << value
-        end
+        graf_directives[directive_name] << if value == "''"
+                                             ''
+                                           else
+                                             value
+                                           end
         graf_directives[directive_name].flatten!
       end
       graf_directives
@@ -178,7 +176,7 @@ module Litbuild
     end
 
     def multiline_value(lines)
-      lines.join("\n") + "\n"
+      "#{lines.join("\n")}\n"
     end
 
     def array_value(lines)

data/lib/litbuild/commands.rb

@@ -26,9 +26,8 @@ module Litbuild
     protected
 
     def add_file_content(directive)
-      unless directive['name'] && directive['content']
+      (directive['name'] && directive['content']) ||
         raise(InvalidDirective, 'file directive missing name or content')
-      end
 
       content = @files[directive['name'].first] ||= StringIO.new
       content.puts(directive['content'].first)

data/lib/litbuild/logfile_namer.rb

@@ -8,7 +8,7 @@ module Litbuild
     end
 
     def path_for(blueprint, phase = nil, stage = nil)
-      count = format('%03d', @counter)
+      count = format('%<counter>03d', counter: @counter)
       @counter += 1
       file_name = build_name(count, blueprint, phase, stage)
       File.join(@log_dir, file_name)
@@ -17,7 +17,7 @@ module Litbuild
     protected
 
     def build_name(*elements)
-      elements.uniq.compact.join('-') + '.log'
+      "#{elements.uniq.compact.join('-')}.log"
     end
   end
 end

data/lib/litbuild/multi_part_visitor.rb

@@ -29,7 +29,6 @@ module Litbuild
 
     protected
 
-    attr_reader :other_parts
-    attr_reader :appendices
+    attr_reader :other_parts, :appendices
   end
 end

data/lib/litbuild/source_code_manager.rb

@@ -67,14 +67,12 @@ module Litbuild
       end
       copy_commands = []
       package.tar_files_needed.each do |filename|
-        unless pkgusr_file_available?(package, filename)
-          copy_commands << "cp #{find_tarfile(filename)} ~#{pkgusr}/src"
-        end
+        pkgusr_file_available?(package, filename) ||
+          (copy_commands << "cp #{find_tarfile(filename)} ~#{pkgusr}/src")
       end
       package.patch_files.each do |filename|
-        unless pkgusr_file_available?(package, filename)
-          copy_commands << "cp #{find_file(filename)} ~#{pkgusr}/patches"
-        end
+        pkgusr_file_available?(package, filename) ||
+          (copy_commands << "cp #{find_file(filename)} ~#{pkgusr}/patches")
       end
       mkdir_commands + copy_commands.sort
     end

data/lib/litbuild/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Litbuild
-  VERSION = '1.0.3'
+  VERSION = '1.0.9'
 end

metadata

@@ -1,40 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: litbuild
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.9
 platform: ruby
 authors:
 - Brett Neumeier
-autorequire: 
+autorequire:
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIEMDCCApigAwIBAgIBATANBgkqhkiG9w0BAQsFADAhMR8wHQYDVQQDDBZicmV0
-  dC9EQz1mcmVlc2EvREM9b3JnMB4XDTE5MDkwMTEyNDkxMFoXDTIwMDgzMTEyNDkx
-  MFowITEfMB0GA1UEAwwWYnJldHQvREM9ZnJlZXNhL0RDPW9yZzCCAaIwDQYJKoZI
-  hvcNAQEBBQADggGPADCCAYoCggGBALKrZnh07ME+wnUpu3EYsKisqaD68WomtNpt
-  pOIPUWtQnRD3iVKmPfIsCrwGbU1NQDohiwz0SdLlLVDHIovwZB/j9sI5tzSfltas
-  5dNgN4mgtURqlILYNmuyDbOOsWtOec9Nz7OJfvV6oat7m4prf+rU0j8JtzCAsFNT
-  B/IdLSqJlJEQ4UMeHPaC06RjOJJJOXSE+yh0Sm2dHjNnUyFnrzfHehMMFJ0wpL42
-  RFaxRNGp/U9fn/h94lXz8h42ksoWXWG8RrsnRA3Olsu6uWQJsggnMbD7zzHlQ9Xf
-  0cV9ePbXmyKm2EfvcoVLBybimPmvYxrXOOxblbIMFl3yWX+YfJKrEsLb5F54RSao
-  N4wy76RNF+d7m2yarhiqPf1dm8kzPRzJmhLLMpPa89N3mQaQtC+jrVEME6ahLNhl
-  lnxLd3zcT7ExrHJQQnQgei5AsJe80Noq9K2+8QjLSYDSNsc80SuBczqMeybHxVVA
-  4CJKSU+amFYp/Z414cJr9AG+/xal8wIDAQABo3MwcTAJBgNVHRMEAjAAMAsGA1Ud
-  DwQEAwIEsDAdBgNVHQ4EFgQUtedZFs4wsrrlPms2Gt+1jV7JYYwwGwYDVR0RBBQw
-  EoEQYnJldHRAZnJlZXNhLm9yZzAbBgNVHRIEFDASgRBicmV0dEBmcmVlc2Eub3Jn
-  MA0GCSqGSIb3DQEBCwUAA4IBgQAfjb44P0zp86q4cvN8Wv/VEyvVLEiTT/DFWmER
-  UBMPB1lIUxxgCs6MqxpRK8icX4IRb/W9qeC2nIBsmY7u4Xoj3JiaOLmoJImXt+tO
-  KdGUu7ygymVZ7991XaAf4dpOcVYMmUDqS+G7mo/nbHBT4440AG2SSL02Nj7zDfn8
-  Ut0XU+6UT3WxpBIA1o/BTmLkPvQhkOEMv7sWBWHdvS0eSxNTSfXpwkjIYpXMsUIg
-  BbgMcxnxUIv5Y+Xb/TIbrRYqiDtqsDT+vsadKk3qjN0bx7vCVdibh2cfGTJA9Spe
-  pi1q/NcnHXSeMFJ4iWyp6lyZxo+B7KIFkgD/irWbBoyZYpbMYJexasmoVuFgyvND
-  VBt/HnbucMCrdU4EqbBQHFimTIyvOaI12/TaU4362smlgZhZdnlHyBeOUBGzDSLX
-  PvrrfEkjwo+u4dPBTaO5ZBa4qsFE5bK/1l6d4AVV5Yi5NohUwmpp1bFFCGPqvzVA
-  bhee2x0YS1uGTnADpv2GLkmNMIA=
-  -----END CERTIFICATE-----
-date: 2019-09-14 00:00:00.000000000 Z
+cert_chain: []
+date: 2021-12-25 00:00:00.000000000 Z
 dependencies: []
 description: A build system based on Knuth's idea of literate programming.
 email:
@@ -71,8 +45,9 @@ files:
 homepage: http://git.freesa.org/freesa/litbuild
 licenses:
 - GPL-3.0
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,15 +55,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: A literate build system
 test_files: []

metadata.gz.sig

@@ -1,4 +0,0 @@
-H�8�,�Bj��
-8
-ik�[���ѩ�o����P})2~�ѷ�0����V�
�����ϥt�
-��N�Q-)�ET����?^5C�1P<�H7?�w��T>Nui�$Y5�f��u2O�����S;BQ2�()�bI�ǩ5M[�s��
-�/"s���XkC��23[�R)ioM��c,7� &K	N�cu���J�'L��=�my�fӵW����b=R���+n��wK���