litbuild 1.0.9 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 021106eb1915ada36b41382da16fdde8d9c2762d3e250dc0cbdb5067c7432bcf
-  data.tar.gz: a42ebf4088c9c1f7b9ae2d3d4f238ec2e9610c17c6fd07da1e0af6a5938c71dd
+  metadata.gz: 450a93fb7a60735ed6618b58aff828dd2c6a8846b7664e7916df70ca319f1f4c
+  data.tar.gz: 0f7523cd36707b6748f868b6229d69413874503282511929891e1d4ea344d8df
 SHA512:
-  metadata.gz: 93da197d79732d1944ec9821f2d567c76962408923e68a2642789a4408176ab341dcf6e2fb61b2274413b98272e2d4f3cf979c38b20d11186d7f80a6a8e90238
-  data.tar.gz: 2a38bdce9e787c5685ccaf92fca51cffc16da80c900694701fc6a169aef9c9e8797eedbf8fe53d317e2129000126bff9076d69ba4da0f0bba086630e367b6928
+  metadata.gz: '08ee5269104135777fb2dd06c225b03854b8b38c61723c0652b98aebc1fef19cad4ded3267249312e8821de764fab8360189216bf50e6b039f442a48cc9ed169'
+  data.tar.gz: 4626ce942e4afd88bca32d3613488bd2ac509107c90f467ae0deb3f14c0086ff6fd401647a9173ab5906284a042422802c0dc0fb067e80645217cf70e98e4686

data/lib/litbuild/ascii_doc_visitor.rb

@@ -3,6 +3,7 @@
 require 'stringio'
 require 'litbuild/multi_part_visitor'
 require 'litbuild/service_dir'
+require 'litbuild/string_indentation'
 
 module Litbuild
   ##
@@ -15,6 +16,8 @@ module Litbuild
   # blueprint (phase). AsciiDocVisitor can also write a top-level
   # AsciiDoc document that includes all top-level fragments.
   class AsciiDocVisitor < MultiPartVisitor
+    include StringIndentation
+
     def initialize(parameters:)
       @parameters = parameters
       super(directory: @parameters['DOCUMENT_DIR'])
@@ -274,7 +277,7 @@ module Litbuild
       end
       svc.multiline_files.keys.sort.each do |filename|
         doc.puts("|#{filename.capitalize} script\nl|")
-        doc.puts(svc.multiline_files[filename])
+        doc.puts(strip_indentation_from_value(svc.multiline_files[filename]))
         doc.puts
       end
     end
@@ -358,7 +361,7 @@ module Litbuild
       end
       doc.puts('[source,indent=0]')
       doc.puts('----')
-      doc.puts(file['content'])
+      doc.puts(strip_indentation_from_value(file['content']))
       doc.puts('----')
     end
 
@@ -371,7 +374,7 @@ module Litbuild
         doc.puts("=== #{filename}\n\n")
         doc.puts('[source,indent=0]')
         doc.puts('----')
-        doc.puts(files[filename])
+        doc.puts(strip_indentation_from_string(files[filename].join))
         doc.puts('----')
       end
     end

data/lib/litbuild/bash_script_visitor.rb

@@ -2,6 +2,7 @@
 
 require 'litbuild/service_dir'
 require 'litbuild/source_code_manager'
+require 'litbuild/string_indentation'
 require 'litbuild/visitor'
 
 module Litbuild
@@ -13,6 +14,8 @@ module Litbuild
   # phase) has already been written to any directory, BashScriptVisitor
   # will ignore subsequent requests to write that blueprint (phase).
   class BashScriptVisitor < Visitor
+    include StringIndentation
+
     INSTALL_GID = 9999
 
     attr_reader :blueprint_dir
@@ -179,7 +182,7 @@ module Litbuild
       blueprint.files.keys.sort.map do |name|
         accum = StringIO.new
         accum.puts("cat > #{name} <<'LBEOF'")
-        accum.puts(blueprint.files[name].string)
+        accum.puts(strip_indentation_from_string(blueprint.files[name].string))
         accum.puts('LBEOF')
         accum.string
       end
@@ -534,7 +537,7 @@ module Litbuild
       end
       multiline = sd.multiline_files
       deps = sd.dependencies
-      multiline['dependencies'] = deps.join("\n") unless deps.empty?
+      multiline['dependencies'] = [deps.join("\n")] unless deps.empty?
       multiline.keys.sort.each do |filename|
         # I always terminate here documents in litbuild-generated
         # scripts with "LBEOF", partly because I'm thinking "Litbuild
@@ -542,7 +545,7 @@ module Litbuild
         # Shia LaBoeuf, and then I remember the Rob Cantor song of
         # that name and giggle.
         script.puts("cat > #{sd.name}/#{filename} <<'LBEOF'")
-        script.puts(multiline[filename])
+        script.puts(strip_indentation_from_value(multiline[filename]))
         script.puts('LBEOF')
       end
       env = sd.env

data/lib/litbuild/blueprint.rb

@@ -7,6 +7,15 @@ require 'litbuild/logfile_namer'
 require 'litbuild/visitor'
 
 module Litbuild
+  # Blueprints are described in the `doc` directory.
+  #
+  # tl;dr: Blueprints are considered as "chunks" separated by blank
+  # lines. Each chunk can be either directives or narrative. Narrative
+  # is AsciiDoc and does not get parsed or transformed. Directives are
+  # basically a simplified version of YAML.
+  #
+  # After parsing, the narrative is found in the `grafs` variables and
+  # directives are found in `directive` hashes.
   class Blueprint
     class << self
       # This should simply be the name of the directory where blueprints

data/lib/litbuild/blueprint_parser.rb

@@ -1,20 +1,18 @@
 # frozen_string_literal: false
 
 require 'litbuild/errors'
+require 'litbuild/string_indentation'
 require 'json'
 
 module Litbuild
   # This is a kludgy hand-built parser. Blueprint structure is not (at
   # least, at this point) complicated enough that I can see any point in
   # defining a grammar and using a parser generator. The structure of
-  # blueprint directives is described informally in
-  # `doc/blueprints.txt` (and blueprint-type-specific files under `doc`
-  # as well).
-  #
-  # tl;dr: each paragraph can be either directives or narrative.
-  # Narrative is AsciiDoc and does not get parsed or transformed.
-  # Directives are basically a simplified version of YAML.
+  # blueprints is described informally in `doc/blueprints.txt` (and
+  # blueprint-type-specific files under `doc` as well).
   class BlueprintParser
+    include StringIndentation
+
     # _directives_ are for use in scripts. _grafs_ are for use in
     # documents.
     attr_reader :base_directives, :phase_directives, :base_grafs, :phase_grafs
@@ -30,9 +28,8 @@ module Litbuild
       # blueprint. If there are no phase directives, this is the entire
       # blueprint, obvs.
       @base_grafs = []
-      base = parse_phase(phase_chunks.shift, {}, @base_grafs)
-      base['full-name'] ||= base['name']
-      @base_directives = base
+      @base_directives = parse_phase(phase_chunks.shift, {}, @base_grafs)
+      @base_directives['full-name'] ||= @base_directives['name']
 
       # The rest of the blueprint, if any, consists of directives and
       # narrative for specific phases. The directives for each phase
@@ -42,13 +39,15 @@ module Litbuild
         phase_name = phase_chunks.shift
         phase_contents = phase_chunks.shift
         grafs = []
-        @phase_directives[phase_name] = parse_phase(phase_contents, base, grafs)
+        @phase_directives[phase_name] = parse_phase(phase_contents,
+                                                    @base_directives,
+                                                    grafs)
         @phase_grafs[phase_name] = grafs
       end
 
       # Any directives at the beginning of a blueprint are actually a
-      # file header that should not be rendered as part of the narrative
-      # for it.
+      # file header that should not be considered as part of the
+      # narrative for it.
       @base_grafs.shift while @base_grafs[0].is_a?(Hash)
     rescue StandardError => e
       msg = "Cannot parse blueprint starting: #{@text.lines[0..3].join}"
@@ -122,8 +121,8 @@ module Litbuild
         end
         directive_name = md[1]
         firstline_value = md[2]
-        value_lines = related_lines(directive_line, lines_to_process)
-        value = parse_directive_value(firstline_value, value_lines)
+        value_lines, indent = related_lines(directive_line, lines_to_process)
+        value = parse_directive_value(firstline_value, value_lines, indent)
         graf_directives[directive_name] << if value == "''"
                                              ''
                                            else
@@ -137,7 +136,9 @@ module Litbuild
     # Regardless of what kind of directive structure we're dealing with,
     # all of the lines that are indented more than the initial directive
     # line are part of that directive.  This method finds all those
-    # related lines and strips away the common initial indentation.
+    # related lines and strips away the common initial indentation; it
+    # returns both the related lines and the amount of indentation that
+    # was removed.
     def related_lines(directive_line, lines_to_process)
       directive_indent = indent_for(directive_line)
       related = []
@@ -145,16 +146,15 @@ module Litbuild
             (indent_for(lines_to_process[0]) > directive_indent)
         related << lines_to_process.shift
       end
-      common_indent = related.map { |l| indent_for(l) }.min
-      related.map { |l| l.slice(common_indent..-1) }
+      strip_indentation_from_array(related)
     end
 
     # What kind of directive are we dealing with? Could be a simple
     # value (with zero or more continuation lines), or a multiline
     # value, or an array, or a subdirective block.
-    def parse_directive_value(firstline_value, other_lines)
+    def parse_directive_value(firstline_value, other_lines, indentation)
       if firstline_value == '|'
-        multiline_value(other_lines)
+        multiline_value(other_lines, indentation)
       elsif other_lines.empty?
         firstline_value
       elsif other_lines[0].match?(/^ *- /)
@@ -175,8 +175,15 @@ module Litbuild
       stripped.join(" \\\n  ")
     end
 
-    def multiline_value(lines)
-      "#{lines.join("\n")}\n"
+    # While parsing multiline values, we want to restore the indentation
+    # that was previously stripped away -- this is typically used for
+    # `file` directives, which often appear in multiple directive blocks
+    # and should be treated as a whole. The indentation for multi-line
+    # values must be removed *later*, during rendering of scripts and
+    # documents.
+    def multiline_value(lines, indentation)
+      lines_with_indentation = lines.map { |l| (' ' * indentation) + l }
+      "#{lines_with_indentation.join("\n")}\n"
     end
 
     def array_value(lines)
@@ -184,8 +191,8 @@ module Litbuild
       until lines.empty?
         array_member = lines.shift
         firstline_value = /^- *(.*)$/.match(array_member)[1]
-        related = related_lines(array_member, lines)
-        value << parse_directive_value(firstline_value, related)
+        related, indentation = related_lines(array_member, lines)
+        value << parse_directive_value(firstline_value, related, indentation)
       end
       value
     rescue StandardError
@@ -198,11 +205,5 @@ module Litbuild
     def subdirective_value(lines)
       parse_lines(lines)
     end
-
-    # Utility method to find the amount of blank space at the beginning
-    # of a line.
-    def indent_for(line)
-      /^([[:blank:]]*).*/.match(line)[1].size
-    end
   end
 end

data/lib/litbuild/section.rb

@@ -35,8 +35,8 @@ module Litbuild
 
       blueprints = self['blueprints'].clone || []
       if $DEBUG
-        warn("Explicit blueprints for section #{name}:" \
-             " #{blueprints.join(', ')}")
+        warn("Explicit blueprints for section #{name}: " \
+             "#{blueprints.join(', ')}")
       end
       blueprints << automatic_inclusions
       deduped = blueprints.flatten.uniq
@@ -56,8 +56,8 @@ module Litbuild
         end
       end
       if $DEBUG
-        warn("Automatically-added blueprints for section #{name}:" \
-             " #{auto_adds.sort.join(', ')}")
+        warn("Automatically-added blueprints for section #{name}: " \
+             "#{auto_adds.sort.join(', ')}")
       end
       auto_adds.sort
     end

data/lib/litbuild/string_indentation.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: false
+
+module Litbuild
+  module StringIndentation
+    # Utility method to find the amount of blank space at the beginning
+    # of a line.
+    def indent_for(line)
+      /^([[:blank:]]*).*/.match(line)[1].size
+    end
+
+    # Utility method to strip the common indentation from all strings in
+    # an array. Returns both the stripped strings and the amount of
+    # indentation removed.
+    def strip_indentation_from_array(strings)
+      common_indent = strings.map { |l| indent_for(l) }.min
+      [strings.map { |l| l.slice(common_indent..-1) }, common_indent]
+    end
+
+    # Utility method to strip the common indentation from all lines of a
+    # multi-line string. (Does not return the amount of indentation
+    # removed.)
+    def strip_indentation_from_string(string)
+      strip_indentation_from_array(string.lines)[0]
+    end
+
+    # Utility method to strip the common indentation from all lines of a
+    # directive value (which is expected to be an array containing a
+    # single string element)
+    def strip_indentation_from_value(value)
+      strip_indentation_from_string(value[0])
+    end
+  end
+end

data/lib/litbuild/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: litbuild
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.11
 platform: ruby
 authors:
 - Brett Neumeier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-25 00:00:00.000000000 Z
+date: 2022-12-19 00:00:00.000000000 Z
 dependencies: []
 description: A build system based on Knuth's idea of literate programming.
 email:
@@ -39,6 +39,7 @@ files:
 - lib/litbuild/service_dir.rb
 - lib/litbuild/source_code_manager.rb
 - lib/litbuild/source_files_visitor.rb
+- lib/litbuild/string_indentation.rb
 - lib/litbuild/url_visitor.rb
 - lib/litbuild/version.rb
 - lib/litbuild/visitor.rb
@@ -62,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A literate build system