string-text 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cb6091be55dccdd85e5ed00b7348573a768833a782725e00a0aa6258506c31b
-  data.tar.gz: 5faa4885c3a303f1eed4ee21ad30a80b779701df7be15be9fda079ea353d9c3b
+  metadata.gz: 5f6c8858a8db9e8092584a772dfaf14f37ea992f5281a88419f42873f6ee2557
+  data.tar.gz: 1e0e8b6db1a0b3184f1141dd38891fc2c628b28f53edfedd7013c84657bed6ce
 SHA512:
-  metadata.gz: ee4799f3ac56b221c362e00c6627282aa03dcf294af5ce88422e3134c60fa96e5d3d25eb2bbbe09ad5720a7890e205beb7bfb34c91efb22122f4e64eeead656b
-  data.tar.gz: 8ebb89255417583f8dc30ec33ca08db50d2ea88a748c186cf95d6bf3df511eb6a6ae84d1502c077277c7585a17f569333b855210b054ba503df7e3d67a7fcebe
+  metadata.gz: e2f147ba4df73785325b7f7f316cfc21419b2cd79cb4cf7daa3c58a2f909c5ada95d99c566b5d7759b50d518491b96d1389e2c5fde0e78b584932f6fab2c917b
+  data.tar.gz: dab721a833b6afb441ec26ea881fed1975d65fd33a27843c9dbf236b6d1d2114ecccce1d1b848d01f0e03325352ed0b8819cd3b5612c72f2a4ca8a2a0619e8e2

data/lib/string-text/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module String::Text
-  VERSION = "0.5.0"
+  VERSION = "0.6.1"
 end

data/lib/string-text.rb

@@ -5,11 +5,16 @@ require_relative "string-text/version"
 module String::Text
   class Error < StandardError; end
 
+  def self.indentation(s) s =~ /^(\s*)/; $1.size end
+
   refine String do
     # Indent or outdent a block of text to the given column (default 1). It
     # uses the indent of the least indented non-empty line as the indent of the
-    # whole block that is then aligned as a whole (including internal indents)
-    # to the given column. Initial and final empty lines are ignored
+    # block that is then aligned as a whole to the given column; lines starting
+    # at column one are realigned to the indent of the previous line. Initial
+    # and final empty lines are ignored.
+    #
+    # FIXME: make the special rule for lines starting at column one an option
     #
     # #align is often handy when you call methods with a %(...) argument
     # and don't want weird indentation in your output
@@ -19,36 +24,61 @@ module String::Text
     #       This line will start at column 3
     #   ).align
     #
-    # If :bol is false then the first line won't be indented or outdented. It
-    # is used when including a block of text in another block:
+    #   This line will start at column 1
+    #     This line will start at column 3
+    #
+    # Because unindented lines are realigned to the previous line's indent,
+    # lists can be indented like this
     #
-    #   innert_text = %(
-    #     first line
-    #     second line
-    #   )
+    #   words = %w(hello world)
     #   puts %(
-    #     Here is the outer text
-    #       #{inner_text.align(2, bol: false)}
-    #     Rest of the outer text
+    #     Array elements on separate lines and starting at column 3:
+    #       #{words.join("\n")}
     #   ).align
     #
+    #   Array elements on separate lines and starting at column 3:
+    #     hello
+    #     world
+    #
+    # The trick is that the words expression makes the string expand to
+    #
+    #   Array elements on separate lines and starting at column 3:
+    #     hello
+    #   world
+    #
+    # If :bol is false then the first line won't be indented or outdented
+    #
     def align(column = 1, bol: true)
       column > 0 or raise ArgumentError "Illegal column: #{column}"
       initial = " " * (column - 1)
-      lines = self.split(/\n/)
+
+      # Remove initial and final empty lines
+      lines = self.split(/\n/).map &:rstrip
       lines.pop while !lines.empty? && !(lines.last =~ /^\s*\S/)
       lines.shift while !lines.empty? && !(lines.first =~ /^\s*\S/)
       return "" if lines.empty?
 
-      indent = lines.map { _1 =~ /^(\s*)/; $1.size }.select { _1 > 0 }.min || 0
+      # Identation level of each line
+      indents = lines.map { String::Text.indentation(_1) }
+
+      # Find minimal indent. If the first line is not indented the minimal
+      # indent is 0, otherwise the smallest non-zero indent used
+      indent = String::Text.indentation(lines.first) == 0 ? 0 : indents.select { _1 > 0 }.min || 0
+
       first = true
-      lines.map { |line|
-        l = line[indent..-1]&.rstrip
+      lines.map.with_index { |line, i|
         if !bol && first
           first = false
-          l || ""
+          line[indents[0]..-1]
         else
-          l ? initial + l : ""
+          if line.empty?
+            ""
+          elsif indents[i] == 0 && i > 0 # Unindented lines
+            indents[i] = indents[i-1] # use previous line's indent
+            ' ' * (indents[i] - indent) + line
+          else # Regular line
+            initial + line[indent..-1]
+          end
         end
       }.join("\n")
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: string-text
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Claus Rasmussen