oppen 0.9.1 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81c1832fc106f4f4622738ad55ea231c66bdb40a96523d9913b3426781aed296
-  data.tar.gz: 9c5797979a36d529317bf31cdc85a158309c26f5a0c298f8cd1e577a83f4386a
+  metadata.gz: f4bd96d5a824c1ad4de7d5d1e041365ba41a0ee56acf4ace9b95fcaa94600c6a
+  data.tar.gz: 911d25db3ee42855425bc8dc29bc4f2ff6af231a29b949de684d02ad6f28418d
 SHA512:
-  metadata.gz: e6a37e27b916fc83323a4b4b387c3990265094ac0c326b5770328ce8d43977b421c8cc0b2092b3c8a877d619ee56578abee1c0f5b2af9390c12f696211eb6446
-  data.tar.gz: 2548a7c7cd71299b8779714537916cf603f72a57bf2d02cf0ebcad163bafe7d53299e833cae07ada8a8cc30ddf2ba4e7ef19df6556656c2c920a90478c734ce4
+  metadata.gz: 61dc218e4918ee44bbe66d5926859153d3052547669943512e4d65844959cab13c9e180e1406be1e7c31328e0025533ee632a025d59173abb9264f80df5b6ca6
+  data.tar.gz: e79d9269ab5fd74f4726edf6e834d8f95cece52499d4730040df5e90dd1a365a4691262e780bc2a1efca0209e319d82a082416f727ed1a3ec193a1f353fe7e6d

data/lib/oppen/mixins.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Oppen
+  # Mixins.
+  module Mixins
+    # Rotates circular array and triples its size.
+    # This method is not for public use.
+    #
+    # @param arr [Array]
+    # @param offset [Integer] Rotation amount
+    #
+    # @return [Array<Array, Integer, Integer>] upsized array, lhs, rhs
+    def upsize_circular_array(arr, offset)
+      size = arr.size
+      arr = arr.rotate(offset)
+      arr.fill(nil, size, 2 * size)
+      [arr, 0, size]
+    end
+
+    # Convert a list of tokens to its wadler representation.
+    #
+    # @param tokens [Array[Token]]
+    # @param base_indent [Integer]
+    #
+    # @return [String]
+    def tokens_to_wadler(tokens, base_indent = 4)
+      out = StringIO.new
+      write = ->(txt, nb_spaces) {
+        out.write("#{' ' * nb_spaces}#{txt}\n")
+      }
+      nb_spaces = base_indent
+      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)
+        in Token::Break
+          write.call('out.breakable', nb_spaces)
+        in Token::Begin
+          write.call('out.group {', nb_spaces)
+          nb_spaces += 2
+        in Token::End
+          nb_spaces -= 2
+          write.call('}', nb_spaces)
+        in Token::EOF
+          write.call('', nb_spaces) # new line
+        end
+      end
+      out.string
+    end
+  end
+end

data/lib/oppen/printer.rb

@@ -4,12 +4,14 @@ require 'stringio'
 
 require_relative 'scan_stack'
 require_relative 'print_stack'
-require_relative 'utils'
+require_relative 'mixins'
 
 # Oppen.
 module Oppen
   # Oppen pretty-printer.
   class Printer
+    extend Mixins
+
     attr_reader :config
     # Ring buffer left index.
     #
@@ -227,13 +229,15 @@ module Oppen
     #
     # @return [Nil]
     def advance_right
-      @right = (right + 1) % scan_stack.length
+      @right = (right + 1) % @size.length
+
       return if right != left
 
       raise 'Token queue full' if !config.upsize_stack?
 
-      @size, = Utils.upsize_circular_array(@size, @left)
-      @tokens, @left, @right = Utils.upsize_circular_array(@tokens, @left)
+      @scan_stack.update_indexes(-@left)
+      @size, _left, _right = ScanStack.upsize_circular_array(@size, @left)
+      @tokens, @left, @right = ScanStack.upsize_circular_array(@tokens, @left)
     end
 
     # Advances the `left` pointer and lets the print stack

data/lib/oppen/scan_stack.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'utils'
+require_relative 'mixins'
 
 # Oppen.
 module Oppen
   # A fixed-size stack that can be popped from top and bottom.
   class ScanStack
+    extend Mixins
+
     def initialize(size, config)
       @bottom = 0
       @config = config
@@ -73,7 +75,7 @@ module Oppen
         if @top == @bottom
           raise 'Stack full' if !@config.upsize_stack?
 
-          @stack, @bottom, @top = Utils.upsize_circular_array(@stack, @bottom)
+          @stack, @bottom, @top = ScanStack.upsize_circular_array(@stack, @bottom)
         end
       end
       @stack[@top] = value
@@ -112,5 +114,16 @@ module Oppen
       end
       res
     end
+
+    # Offset the values of the stack.
+    #
+    # @param offset [Integer]
+    #
+    # @return [Array[Integer]]
+    def update_indexes(offset)
+      @stack = @stack.map { |val|
+        (val + offset) % length if val
+      }
+    end
   end
 end

data/lib/oppen/version.rb

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

data/lib/oppen.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'oppen/mixins'
 require_relative 'oppen/printer'
 require_relative 'oppen/print_stack'
 require_relative 'oppen/scan_stack'
@@ -9,6 +10,8 @@ require_relative 'wadler/print'
 
 # Oppen.
 module Oppen
+  extend Mixins
+
   # Entry point of the pretty printer.
   #
   # @param config [Config]

data/lib/wadler/print.rb

@@ -35,6 +35,10 @@ module Oppen
 
     # @return [String]
     def output
+      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
@@ -128,5 +132,72 @@ module Oppen
     def break(line_continuation: '')
       tokens << Oppen.line_break(line_continuation:, offset: current_indent)
     end
+
+    # @!group Helpers
+
+    # Set a base indenetaion level to the printer.
+    #
+    # @param indent [Integer]
+    #
+    # @return [Nil]
+    def base_indent(indent = 0)
+      @current_indent = indent if !indent.nil?
+    end
+
+    # Open a consistent group.
+    #
+    # @param indent [Integer]
+    #
+    # @return [Nil]
+    def group_open(indent: 0)
+      tokens << Oppen.begin_consistent(offset: indent)
+    end
+
+    # Close a group.
+    #
+    # @return [Nil]
+    def group_close(_)
+      tokens << Oppen.end
+    end
+
+    # Open a consistent group with indent.
+    #
+    # @param indent [Integer]
+    #
+    # @return [Nil]
+    def indent_open(indent)
+      @current_indent += indent
+      group_open
+    end
+
+    # Close a group with indent.
+    #
+    # @param indent [Integer]
+    #
+    # @return [Nil]
+    def indent_close(group, indent)
+      @current_indent -= indent
+      group_close(group)
+    end
+
+    # Open a nest by indent.
+    #
+    # @param indent [Integer]
+    #
+    # @return [Nil]
+    def nest_open(indent)
+      @current_indent += indent
+    end
+
+    # Close a nest by indent.
+    #
+    # @param indent [Integer]
+    #
+    # @return [Nil]
+    def nest_close(indent)
+      @current_indent -= indent
+    end
+
+    # @!endgroup
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oppen
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.3
 platform: ruby
 authors:
 - Amine Mike El Maalouf <amine.el-maalouf@epita.fr>
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies: []
 description: Implementation of the Oppen's pretty printing algorithm
 email: 
@@ -20,11 +20,11 @@ files:
 - LICENSE
 - README.md
 - lib/oppen.rb
+- lib/oppen/mixins.rb
 - lib/oppen/print_stack.rb
 - lib/oppen/printer.rb
 - lib/oppen/scan_stack.rb
 - lib/oppen/token.rb
-- lib/oppen/utils.rb
 - lib/oppen/version.rb
 - lib/wadler/print.rb
 homepage: http://github.com/Faveod/oppen-ruby

data/lib/oppen/utils.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-# Oppen.
-module Oppen
-  # Utils.
-  module Utils
-    # Rotates circular array and triples its size.
-    # @param arr [Array]
-    # @param offset [Integer] Rotation amount
-    #
-    # @return [Array(Array, Integer, Integer)] upsized array, lhs, rhs
-    def self.upsize_circular_array(arr, offset)
-      size = arr.size
-      arr = arr.rotate(offset)
-      arr.fill(nil, size, 2 * size)
-      [arr, 0, size]
-    end
-  end
-end