oppen 0.9.5 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2e8ac9f3609e4e4d0f64e5b4b9fdbbe6856e23532b995a52281a14577a894c9
-  data.tar.gz: 5451a9f1c73b37f7d66693698ba6d1cc6551c85b98a0953b057a4bf7de145081
+  metadata.gz: b656616fe07cf5b29b8dfa43f0b72ed6dbf80c56a9ca6790745a8db27f058ed7
+  data.tar.gz: 3d46ddc3a703d029ac22460ac504cf2928f95d804d32e0266f0de7ffbbfd3359
 SHA512:
-  metadata.gz: c3a98ad61c3486094b13cb9fd200f18184fd6b475c35fc76284e58e2b194c2c74ab4a42568ae405c385a0165e75f1b6d144c96e1fb2f70e330bde063fed7c89b
-  data.tar.gz: d760f00dc3c26800c254b07b19ecb62703920e4feaa6023814c1d611d3989768f2b916296615358a0729d45fdee2369f1fdf880e3c5c1e97ac7c97d5c4a46d65
+  metadata.gz: 7b69f0365a507dc9fca546cbfea064593a48d0d85140cd894ed2ff256e13c4c0e772bf9e0d2b29f9eefd9121c8b3adf03da93137c15b3c9570f6a7e49ed435b2
+  data.tar.gz: aa608fa2238dc8eea6bf3ce5d03f10e6f8059eda98c02d1e53fa06f9ac9301b03b42e54b38ed4f945c28766c4959b441cc190b76f0f176a72c7f52967096258a

data/lib/oppen/mixins.rb

@@ -21,30 +21,50 @@ module Oppen
     #
     # @param tokens [Array[Token]]
     # @param base_indent [Integer]
+    # @param printer_name [String]
     #
     # @return [String]
-    def tokens_to_wadler(tokens, base_indent = 4)
+    def tokens_to_wadler(tokens, base_indent: 0, printer_name: 'out')
+      nb_spaces = base_indent
       out = StringIO.new
-      write = ->(txt, nb_spaces) {
-        out.write("#{' ' * nb_spaces}#{txt}\n")
+
+      write = ->(txt) {
+        out << (' ' * nb_spaces) << txt << "\n"
       }
-      nb_spaces = base_indent
+      display_break_token = ->(token) {
+        if token.offset.positive?
+          write.("#{printer_name}.nest(#{token.offset}, \"\", \"\") {")
+          nb_spaces += 2
+        end
+
+        case token
+        in Token::LineBreak
+          write.("#{printer_name}.break(line_continuation: #{token.line_continuation.inspect})")
+        in Token::Break
+          write.("#{printer_name}.breakable(#{token.str.inspect}, width: #{token.width}, " \
+                 "line_continuation: #{token.line_continuation.inspect})")
+        end
+
+        if token.offset.positive?
+          nb_spaces -= 2
+          write.('}')
+        end
+      }
+
       tokens.each do |token|
         case token
         in Token::String
-          write.call("out.text '#{token}'", nb_spaces)
-        in Token::LineBreak
-          write.call('out.break', nb_spaces)
+          write.("#{printer_name}.text(#{token.value.inspect}, width: #{token.width})")
         in Token::Break
-          write.call('out.breakable', nb_spaces)
+          display_break_token.(token)
         in Token::Begin
-          write.call('out.group {', nb_spaces)
+          write.("#{printer_name}.group(#{token.offset}, \"\", \"\", #{token.break_type_name}) {")
           nb_spaces += 2
         in Token::End
           nb_spaces -= 2
-          write.call('}', nb_spaces)
+          write.('}')
         in Token::EOF
-          write.call('', nb_spaces) # new line
+          write.('') # new line
         end
       end
       out.string

data/lib/oppen/print_stack.rb

@@ -53,6 +53,7 @@ module Oppen
         else
           ->(n) { space * n }
         end
+      @indent = 0
       @items = []
       @new_line = new_line
       @width = width
@@ -63,6 +64,7 @@ module Oppen
     #
     # @return [String]
     def output
+      buffer.truncate(buffer.pos)
       buffer.string
     end
 
@@ -72,16 +74,17 @@ module Oppen
     #
     # @param token [Token]
     # @param token_width [Integer]
+    # @param trim_on_break [Integer] Number of trailing whitespace characters to trim.
     #
     # @return [Nil]
-    def print(token, token_width)
+    def print(token, token_width, trim_on_break: 0)
       case token
       in Token::Begin
         handle_begin token, token_width
       in Token::End
         handle_end
       in Token::Break
-        handle_break token, token_width
+        handle_break token, token_width, trim_on_break:
       in Token::String
         handle_string token, token_width
       end
@@ -130,11 +133,12 @@ module Oppen
     #
     # @param token [Token]
     # @param token_width [Integer]
+    # @param trim_on_break [Integer] Number of trailing whitespace characters to trim.
     #
     # @return [Nil]
     #
     # @see Token::Break
-    def handle_break(token, token_width)
+    def handle_break(token, token_width, trim_on_break: 0)
       block = top
       case block.break_type
       in Token::BreakType::FITS
@@ -148,6 +152,7 @@ module Oppen
           else
             width - space
           end
+        erase(trim_on_break)
         write token.line_continuation
         print_new_line indent
       in Token::BreakType::INCONSISTENT
@@ -159,6 +164,7 @@ module Oppen
             else
               width - space
             end
+          erase(trim_on_break)
           write token.line_continuation
           print_new_line indent
         else
@@ -177,7 +183,13 @@ module Oppen
     #
     # @see Token::String
     def handle_string(token, token_width)
+      return if token.value.empty?
+
       @space = [0, space - token_width].max
+      if @indent.positive?
+        indent @indent
+        @indent = 0
+      end
       write token
     end
 
@@ -223,9 +235,9 @@ module Oppen
       write new_line
       if config&.indent_anchor == Config::IndentAnchor::ON_BEGIN
         @space = width - top.offset - amount
-        indent width - space
+        @indent = width - space
       else
-        indent amount
+        @indent = amount
       end
     end
 
@@ -238,6 +250,18 @@ module Oppen
       buffer.write(obj.to_s)
     end
 
+    # Erase the last `count` characters.
+    #
+    # @param count [Integer]
+    #
+    # @return [Nil]
+    def erase(count = 0)
+      raise ArgumentError, "count = #{count} must be non-negative" if count.negative?
+
+      buffer.seek(-count, IO::SEEK_CUR)
+      @space += count
+    end
+
     # Add indentation by `amount`.
     #
     # @note Called Indent as well in the original paper.
@@ -248,7 +272,7 @@ module Oppen
     def indent(amount)
       raise ArgumentError 'Indenting using negative amount' if amount.negative?
 
-      write genspace.call(amount) if amount.positive?
+      write genspace.(amount) if amount.positive?
     end
   end
 end

data/lib/oppen/printer.rb

@@ -78,6 +78,7 @@ module Oppen
       n = 3 * width
 
       @config = config
+      @last_whitespaces_width = 0
       @left = 0
       @left_total = 1
       @print_stack = PrintStack.new width, new_line, config, space, out
@@ -110,7 +111,11 @@ module Oppen
         handle_end token
       in Token::Break
         handle_break token
+      in Token::Whitespace
+        @last_whitespaces_width += token.width
+        handle_string token
       in Token::String
+        @last_whitespaces_width = 0
         handle_string token
       end
     end
@@ -139,6 +144,9 @@ module Oppen
         @left_total = 1
         @right = 0
         @right_total = 1
+
+        # config.trim_trailing_whitespaces
+        @tokens[-1] = nil
       else
         advance_right
       end
@@ -179,6 +187,11 @@ module Oppen
         @left_total = 1
         @right = 0
         @right_total = 1
+
+        # config.trim_trailing_whitespaces
+        tokens[-1] = nil
+        print_stack.erase @last_whitespaces_width
+        @last_whitespaces_width = 0
       else
         advance_right
       end
@@ -202,7 +215,7 @@ module Oppen
         tokens[right] = token
         size[right] = token.width
         @right_total += token.width
-        check_stream
+        check_stream if @last_whitespaces_width.zero?
       end
     end
 
@@ -249,7 +262,26 @@ module Oppen
     def advance_left(token, token_width)
       return if token_width.negative?
 
-      print_stack.print token, token_width
+      trim_on_break =
+        if token.is_a?(Token::Break)
+          # Find the first previous String token.
+          idx = (left - 1) % tokens.length
+          while idx != right && tokens[idx] && !tokens[idx].is_a?(Token::String) \
+                && !tokens[idx].is_a?(Token::Break)
+            idx = (idx - 1) % tokens.length
+          end
+          # Sum the widths of the last whitespace tokens.
+          total = 0
+          while tokens[idx].is_a?(Token::Whitespace)
+            total += tokens[idx].width
+            idx = (idx - 1) % tokens.length
+          end
+          @last_whitespaces_width = 0
+          total
+        end
+      trim_on_break ||= 0
+
+      print_stack.print(token, token_width, trim_on_break:)
 
       case token
       when Token::Break
@@ -260,7 +292,7 @@ module Oppen
 
       return if left == right
 
-      @left = (left + 1) % scan_stack.length
+      @left = (left + 1) % tokens.length
       advance_left tokens[left], size[left]
     end
 

data/lib/oppen/token.rb

@@ -39,6 +39,12 @@ module Oppen
       def to_s = value
     end
 
+    # If a [Token::Break] follows [Token::Whitespace], and an actual break
+    # is issued, and `trim_trailing_whitespaces == true`, then all whitespace
+    # text will be omitted from the output.
+    class Whitespace < ::Oppen::Token::String
+    end
+
     # Break Token.
     class Break < Token
       # @return [String] If a new line is needed display this string before the new line
@@ -89,6 +95,17 @@ module Oppen
         @break_type = break_type
         super()
       end
+
+      # The break_type name as a String.
+      #
+      # @return [String]
+      def break_type_name
+        case @break_type
+        in BreakType::FITS         then 'Oppen::Token::BreakType::FITS'
+        in BreakType::INCONSISTENT then 'Oppen::Token::BreakType::INCONSISTENT'
+        in BreakType::CONSISTENT   then 'Oppen::Token::BreakType::CONSISTENT'
+        end
+      end
     end
 
     # End Token

data/lib/oppen/version.rb

@@ -5,5 +5,5 @@ module Oppen
   # Oppen version
   #
   # @return [String] current version
-  VERSION = '0.9.5' # managed by release.sh
+  VERSION = '0.9.7' # managed by release.sh
 end

data/lib/oppen.rb

@@ -51,9 +51,11 @@ module Oppen
 
     attr_accessor :indent_anchor
 
-    def initialize(indent_anchor: IndentAnchor::ON_BREAK, eager_print: false, upsize_stack: false)
+    def initialize(indent_anchor: IndentAnchor::ON_BREAK, eager_print: false,
+                   trim_trailing_whitespaces: false, upsize_stack: false)
       @indent_anchor = indent_anchor
       @eager_print = eager_print
+      @trim_trailing_whitespaces = trim_trailing_whitespaces
       @upsize_stack = upsize_stack
     end
 
@@ -88,6 +90,8 @@ module Oppen
     # @return [Boolean]
     def eager_print? = @eager_print
 
+    def trim_trailing_whitespaces? = @trim_trailing_whitespaces
+
     def upsize_stack? = @upsize_stack
 
     # Default config for Oppen usage
@@ -98,8 +102,8 @@ module Oppen
 
     # Default config for Wadler usage
     # @return [Config]
-    def self.wadler(eager_print: true, upsize_stack: true)
-      new(indent_anchor: IndentAnchor::ON_BEGIN, eager_print:, upsize_stack:)
+    def self.wadler(eager_print: true, trim_trailing_whitespaces: true, upsize_stack: true)
+      new(indent_anchor: IndentAnchor::ON_BEGIN, eager_print:, trim_trailing_whitespaces:, upsize_stack:)
     end
   end
 
@@ -111,6 +115,13 @@ module Oppen
     Token::String.new(value, width:)
   end
 
+  # @see Token::Whitespace
+  #
+  # @return [Oppen::Token::Whitespace] a new Whitespace token.
+  def self.whitespace(value)
+    Token::Whitespace.new(value, width: value.bytesize)
+  end
+
   # @param str [String]
   # @param line_continuation [String] If a new line is needed display this string before the new line
   # @param offset [Integer]

data/lib/wadler/print.rb

@@ -10,6 +10,7 @@ module Oppen
     attr_reader :new_line
     attr_reader :out
     attr_reader :tokens
+    attr_reader :whitespace
     attr_reader :width
 
     # @param config [Oppen::Config]
@@ -22,8 +23,11 @@ module Oppen
     # @param new_line [String]
     # @param out [Object] should have a write and string method
     # @param width [Integer]
+    # @param whitespace [String] the whitespace character. Used to trim trailing whitespaces.
+    # @see Token::Whitespace
     def initialize(config: Config.wadler, space: ' ',
-                   new_line: "\n", out: StringIO.new, width: 80)
+                   new_line: "\n", out: StringIO.new,
+                   width: 80, whitespace: ' ')
       @config = config
       @current_indent = 0
       @space = space
@@ -31,20 +35,37 @@ module Oppen
       @new_line = new_line
       @out = out
       @tokens = []
+      @whitespace = whitespace
     end
 
-    # @return [String]
-    def output
+    # Add missing Begin, End or EOF tokens.
+    # @return [Nil]
+    def add_missing_begin_and_end
       if !tokens.first.is_a? Token::Begin
         tokens.unshift Oppen.begin_consistent(offset: 0)
         tokens << Oppen.end
       end
-      if !tokens.last.is_a? Oppen::Token::EOF
-        tokens << Oppen.eof
-      end
+      tokens << Oppen.eof if !tokens.last.is_a?(Oppen::Token::EOF)
+    end
+
+    # Generate the output string of the built list of tokens
+    # using Oppen's pretty printing algorithm.
+    #
+    # @return [String]
+    def output
+      add_missing_begin_and_end
       Oppen.print(tokens:, new_line:, config:, space:, out:, width:)
     end
 
+    # Generate the the list of Wadler commands needed to build the built
+    # list of tokens.
+    #
+    # @return [String]
+    def show_print_commands(**)
+      add_missing_begin_and_end
+      Oppen.tokens_to_wadler(tokens, **)
+    end
+
     # @param indent [Integer] group indentation
     # @param open_obj [String] group opening delimiter
     # @param close_obj [String] group closing delimiter
@@ -84,11 +105,9 @@ module Oppen
     # @param indent [Integer] nest indentation
     # @param open_obj [String] nest opening delimiter
     # @param close_obj [String] nest closing delimiter
-    # @param break_type [Oppen::Token::BreakType] nest breaking type
     #
     # @return [Nil]
-    def nest(indent, open_obj = '', close_obj = '',
-             break_type = Oppen::Token::BreakType::CONSISTENT)
+    def nest(indent, open_obj = '', close_obj = '')
       raise ArgumentError, "#{open_obj.nil? ? 'open_obj' : 'close_obj'} cannot be nil" \
         if open_obj.nil? || close_obj.nil?
 
@@ -115,7 +134,16 @@ module Oppen
     #
     # @return [Nil]
     def text(value, width: value.length)
-      tokens << Oppen.string(value, width:)
+      if config.trim_trailing_whitespaces? && value.match(/((?:#{Regexp.escape(whitespace)})+)\z/)
+        match = Regexp.last_match(1)
+        matched_length = match.length
+        if value.length != matched_length
+          tokens << Oppen.string(value[0...-matched_length], width: width - matched_length)
+        end
+        tokens << Oppen.whitespace(match)
+      else
+        tokens << Oppen.string(value, width:)
+      end
     end
 
     # @param str [String]

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: oppen
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.7
 platform: ruby
 authors:
 - Amine Mike El Maalouf <amine.el-maalouf@epita.fr>
-- Firas al-Khalil <firasalkhalil@gmail.com>
+- Firas al-Khalil <firas.alkhalil@faveod.com>
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies: []
 description: Implementation of the Oppen's pretty printing algorithm
 email: