unparser 0.6.15 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d1d0033d21b1c64de6affcc9c555797edf5206dc2947484ff8391e3c8e739ce
-  data.tar.gz: 60732ffbcc8a43cd2f04a6cba76e955b7e764ada9d201cd51a0a624d093b3659
+  metadata.gz: e0e776dd7b47efb62b8ad18d7262d247362944f28ea67edb7e518d8a94c74649
+  data.tar.gz: 759ec6fb240c4c62835bd8c789877fc26fc974563d2566687a63b2c0dec1072f
 SHA512:
-  metadata.gz: 77db441f3e4da2b584065c597796d4adbb08b07e481b43ee85c80218375cbf8932bae847727afa9abee0be02ee5dea1c2effd5caa70216a5bafa34007d0c3820
-  data.tar.gz: c180d28c4ac14fe5d6b5756350592b472cd084ce932309fd6cc87f042dffb1f1870dd194260e71b53dbac71fa648bd359c7b4d3c8860c7508f7cc854c9d2ef25
+  metadata.gz: 11fe99943d2575e00ca2fc150a78cad1f2f830b3249f3692f473da7e520775fc9423b254fb2f7613e4b6811f03dd3d2af0d4bba1d0f2f143e048ab65281771ff
+  data.tar.gz: f08db4117aa2ebba9c5ac7a9e057ca7ddc9fc0613170752ac10cc7515058f491fe756b880db73629e2e7a8328cc979872b4c682197c061de39da52a44796587f

data/README.md

@@ -10,7 +10,7 @@ The following constraints apply:
 
 * No support for macruby extensions
 * Only support for the [modern AST](https://github.com/whitequark/parser/#usage) format
-* Only support for Ruby >= 3.1
+* Only support for Ruby >= 3.2
 
 Notable Users:
 
@@ -44,9 +44,9 @@ To preserve the comments from the source:
 require 'parser/current'
 require 'unparser'
 
-ast, comments = Unparser.parse_with_comments('your(ruby(code)) # with comments')
+ast, comments = Unparser.parser.parse_with_comments(Unparser.buffer('your(ruby(code)) # with comments'))
 
-Unparser.unparse(ast, comments) # => 'your(ruby(code)) # with comments'
+Unparser.unparse(ast, comments: comments) # => 'your(ruby(code)) # with comments'
 ```
 
 Passing in manually constructed AST:
@@ -114,7 +114,7 @@ Unparser currently successfully round trips almost all ruby code around. Using R
 If there is a non round trippable example that is NOT subjected to known [Limitations](#limitations).
 please report a bug.
 
-On CI unparser is currently tested against rubyspec with minor [excludes](https://github.com/mbj/unparser/blob/master/spec/integrations.yml).
+On CI unparser is currently tested against rubyspec with minor [excludes](https://github.com/mbj/unparser/blob/main/spec/integrations.yml).
 
 Limitations:
 ------------

data/lib/unparser/anima.rb

@@ -134,14 +134,25 @@ module Unparser
     # @param [Class, Module] scope
     #
     # @return [undefined]
+    #
+    # mutant:disable
     def included(descendant)
       descendant.instance_exec(self, attribute_names) do |anima, names|
         # Define anima method
+
+        class << self
+          undef_method(:anima) if method_defined?(:anima)
+        end
+
         define_singleton_method(:anima) { anima }
 
         # Define instance methods
         include InstanceMethods
 
+        names.each do |name|
+          undef_method(name) if method_defined?(name)
+        end
+
         # Define attribute readers
         attr_reader(*names)
 

data/lib/unparser/ast/local_variable_scope.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
 module Unparser
-  module AST
-
+  class AST
     # Calculated local variable scope for a given node
     class LocalVariableScope
-      include Enumerable, Adamantium
+      include Adamantium, Anima.new(:static_local_variables, :node)
 
       # Initialize object
       #
@@ -13,13 +12,17 @@ module Unparser
       #
       # @return [undefined]
       #
-      # @api private
-      #
-      def initialize(node)
+      # mutant:disable
+      def initialize(*arguments)
+        super
+
         items = []
-        LocalVariableScopeEnumerator.each(node) do |*scope|
-          items << scope
-        end
+
+        LocalVariableScopeEnumerator.each(
+          node:  node,
+          stack: static_local_variables.dup
+        ) { |*scope| items << scope }
+
         @items = items
       end
 
@@ -53,6 +56,15 @@ module Unparser
         end
       end
 
+      # mutant:disable
+      def local_variables_for_node(needle)
+        @items.each do |node, current|
+          return current if node.equal?(needle)
+        end
+
+        Set.new
+      end
+
       # Test if local variables where first assigned in body and read by conditional
       #
       # @param [Parser::AST::Node] body
@@ -90,21 +102,13 @@ module Unparser
       #
       # @api private
       #
-      def initialize
-        @stack = [Set.new]
+      def initialize(stack:)
+        @stack = [stack]
       end
 
       # Enumerate each node with its local variable scope
-      #
-      # @param [Parser::AST::Node] node
-      #
-      # @return [self]
-      #
-      # @api private
-      #
-      def self.each(node, &block)
-        new.each(node, &block)
-        self
+      def self.each(node:, stack:, &block)
+        new(stack: stack).each(node: node, &block)
       end
 
       # Enumerate local variable scope scope
@@ -117,7 +121,7 @@ module Unparser
       #
       # @api private
       #
-      def each(node, &block)
+      def each(node:, &block)
         visit(node, &block)
       end
 
@@ -132,7 +136,7 @@ module Unparser
         enter(node)
         yield node, current.dup, before
         node.children.each do |child|
-          visit(child, &block) if child.is_a?(Parser::AST::Node)
+          visit(child, &block) if child.instance_of?(Parser::AST::Node)
         end
         leave(node)
       end
@@ -142,7 +146,7 @@ module Unparser
         when *RESET_NODES
           push_reset
         when ASSIGN_NODES
-          define(node.children.first)
+          value = node.children.first and define(value)
         when *INHERIT_NODES
           push_inherit
         end

data/lib/unparser/ast.rb

@@ -2,9 +2,10 @@
 
 module Unparser
   # Namespace for AST processing tools
-  module AST
+  class AST
+    include Anima.new(:comments, :explicit_encoding, :node, :static_local_variables)
+
     FIRST_CHILD = ->(node) { node.children.first }.freeze
-    TAUTOLOGY   = ->(_node) { true }.freeze
 
     RESET_NODES   = %i[module class sclass def defs].freeze
     INHERIT_NODES = [:block].freeze
@@ -16,12 +17,22 @@ module Unparser
         arg
         kwarg
         kwoptarg
+        kwrestarg
         lvasgn
         optarg
-        procarg0
         restarg
       ].to_set.freeze
 
+    # mutant:disable
+    def self.from_node(node:)
+      new(
+        comments:               EMPTY_ARRAY,
+        explicit_encoding:      nil,
+        node:,
+        static_local_variables: Set.new
+      )
+    end
+
     # Test for local variable inherited scope reset
     #
     # @param [Parser::AST::Node] node
@@ -69,6 +80,7 @@ module Unparser
     #
     # @api private
     #
+    # mutant:disable
     def self.local_variable_reads(node)
       Enumerator.new(
         node,
@@ -80,19 +92,6 @@ module Unparser
     class Enumerator
       include Adamantium, Concord.new(:node, :controller), Enumerable
 
-      # Return new instance
-      #
-      # @param [Parser::AST::Node] node
-      # @param [#call(node)] controller
-      #
-      # @return [Enumerator]
-      #
-      # @api private
-      #
-      def self.new(node, controller = TAUTOLOGY)
-        super
-      end
-
       # Return each node
       #
       # @return [Enumerator<Parser::AST::Node>]
@@ -103,8 +102,8 @@ module Unparser
       #
       # @api private
       #
-      def each(&block)
-        Walker.call(node, controller, &block)
+      def each(&)
+        Walker.call(node, controller, &)
       end
 
       # Return nodes selected by types
@@ -168,13 +167,10 @@ module Unparser
       #
       # @param [Parser::AST::Node] node
       #
-      # @return [self]
-      #
       # @api private
       #
-      def self.call(node, controller = TAUTOLOGY, &block)
+      def self.call(node, controller, &block)
         new(block, controller).call(node)
-        self
       end
 
       # Call walker with node

data/lib/unparser/buffer.rb

@@ -14,8 +14,10 @@ module Unparser
     # @api private
     #
     def initialize
-      @content = +''
-      @indent = 0
+      @content  = +''
+      @heredocs = []
+      @indent   = 0
+      @no_nl    = true
     end
 
     # Append string
@@ -34,6 +36,13 @@ module Unparser
       self
     end
 
+    # Push to heredoc stack
+    #
+    # @param [String] heredoc
+    def push_heredoc(heredoc)
+      @heredocs << heredoc
+    end
+
     # Append a string without an indentation prefix
     #
     # @param [String] string
@@ -68,6 +77,10 @@ module Unparser
       self
     end
 
+    def ensure_nl
+      nl unless fresh_line?
+    end
+
     # Write newline
     #
     # @return [self]
@@ -75,7 +88,27 @@ module Unparser
     # @api private
     #
     def nl
+      @no_nl = false
       write(NL)
+      flush_heredocs
+      self
+    end
+
+    # Write final newline
+    def final_newline
+      return if fresh_line? || @no_nl
+
+      write(NL)
+    end
+
+    def nl_flush_heredocs
+      return if @heredocs.empty?
+
+      if fresh_line?
+        flush_heredocs
+      else
+        nl
+      end
     end
 
     def root_indent
@@ -117,6 +150,10 @@ module Unparser
       self
     end
 
+    def write_encoding(encoding)
+      write("# -*- encoding: #{encoding} -*-\n")
+    end
+
   private
 
     INDENT_SPACE = '  '.freeze
@@ -125,5 +162,10 @@ module Unparser
       write(INDENT_SPACE * @indent)
     end
 
+    def flush_heredocs
+      @heredocs.each(&public_method(:write))
+      @heredocs = []
+    end
+
   end # Buffer
 end # Unparser

data/lib/unparser/cli.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'pathname'
+
 module Unparser
   # Unparser CLI implementation
   class CLI
@@ -60,6 +62,7 @@ module Unparser
     #
     # @api private
     #
+    # mutant:disable
     def self.run(*arguments)
       new(*arguments).exit_status
     end
@@ -71,15 +74,17 @@ module Unparser
     # @return [undefined]
     #
     # @api private
+    # mutant:disable
     def initialize(arguments)
       @ignore  = Set.new
       @targets = []
 
-      @fail_fast  = false
-      @start_with = nil
-      @success    = true
-      @validation = :validation
-      @verbose    = false
+      @fail_fast                    = false
+      @start_with                   = nil
+      @success                      = true
+      @validation                   = :validation
+      @verbose                      = false
+      @ignore_original_syntax_error = false
 
       opts = OptionParser.new do |builder|
         add_options(builder)
@@ -98,6 +103,7 @@ module Unparser
     #
     # @api private
     #
+    # mutant:disable
     # rubocop:disable Metrics/MethodLength
     def add_options(builder)
       builder.banner = 'usage: unparse [options] FILE [FILE]'
@@ -114,6 +120,9 @@ module Unparser
       builder.on('-l', '--literal') do
         @validation = :literal_validation
       end
+      builder.on('--ignore-original-syntax-error') do
+        @ignore_original_syntax_error = true
+      end
       builder.on('--ignore FILE') do |file|
         @ignore.merge(targets(file))
       end
@@ -129,6 +138,7 @@ module Unparser
     #
     # @api private
     #
+    # mutant:disable
     def exit_status
       effective_targets.each do |target|
         process_target(target)
@@ -140,11 +150,15 @@ module Unparser
 
   private
 
+    # mutant:disable
     def process_target(target)
       validation = target.public_send(@validation)
       if validation.success?
         puts validation.report if @verbose
         puts "Success: #{validation.identification}"
+      elsif ignore_original_syntax_error?(validation)
+        exception = validation.original_node.from_left
+        puts "#{exception.class}: #{validation.identification} #{exception}"
       else
         puts validation.report
         puts "Error: #{validation.identification}"
@@ -152,6 +166,14 @@ module Unparser
       end
     end
 
+    # mutant:disable
+    def ignore_original_syntax_error?(validation)
+      @ignore_original_syntax_error && validation.original_node.from_left do
+        nil
+      end.instance_of?(Parser::SyntaxError)
+    end
+
+    # mutant:disable
     def effective_targets
       if @start_with
         reject = true
@@ -167,6 +189,7 @@ module Unparser
       end.reject(&@ignore.method(:include?))
     end
 
+    # mutant:disable
     def targets(file_name)
       if File.directory?(file_name)
         Dir.glob(File.join(file_name, '**/*.rb'))

data/lib/unparser/color.rb

@@ -30,10 +30,10 @@ module Unparser
 
       # Well rubocop you are static so you do not have a clue here ;)
       # rubocop:disable Style/RedundantInitialize
-      # rubocop:disable Style/MissingSuper
+      # rubocop:disable Lint/MissingSuper
       def initialize; end
       # rubocop:enable Style/RedundantInitialize
-      # rubocop:enable Style/MissingSuper
+      # rubocop:enable Lint/MissingSuper
 
     end.new
 

data/lib/unparser/either.rb

@@ -54,15 +54,15 @@ module Unparser
       # Evaluate functor block
       #
       # @return [Either::Left<Object>]
-      def fmap(&block)
-        require_block(&block)
+      def fmap(&)
+        require_block(&)
       end
 
       # Evaluate applicative block
       #
       # @return [Either::Left<Object>]
-      def bind(&block)
-        require_block(&block)
+      def bind(&)
+        require_block(&)
       end
 
       # Unwrap value from left
@@ -137,8 +137,8 @@ module Unparser
       # Map over left value
       #
       # @return [Either::Right<Object>]
-      def lmap(&block)
-        require_block(&block)
+      def lmap(&)
+        require_block(&)
       end
 
       # Evaluate right side of branch

data/lib/unparser/emitter/args.rb

@@ -13,7 +13,11 @@ module Unparser
       end
 
       def emit_def_arguments
-        delimited(normal_arguments)
+        if children.one? && n_mlhs?(Util.one(children))
+          emitter(Util.one(children)).dispatch_def
+        else
+          delimited(normal_arguments)
+        end
       end
 
       def emit_lambda_arguments

data/lib/unparser/emitter/array.rb

@@ -6,10 +6,6 @@ module Unparser
     class Array < self
       handle :array
 
-      def emit_heredoc_reminders
-        emitters.each(&:emit_heredoc_reminders)
-      end
-
     private
 
       def dispatch

data/lib/unparser/emitter/array_pattern.rb

@@ -12,18 +12,10 @@ module Unparser
 
       def dispatch
         write('[')
-        delimited(children, &method(:emit_member))
+        delimited(children)
         write(', ') if node_type.equal?(:array_pattern_with_tail)
         write(']')
       end
-
-      def emit_member(node)
-        if n_match_rest?(node)
-          writer_with(MatchRest, node).emit_array_pattern
-        else
-          visit(node)
-        end
-      end
     end # Pin
   end # Emitter
 end # Unparser

data/lib/unparser/emitter/assignment.rb

@@ -11,12 +11,6 @@ module Unparser
         true
       end
 
-      def emit_heredoc_reminders
-        return unless right
-
-        emitter(right).emit_heredoc_reminders
-      end
-
     private
 
       def dispatch
@@ -30,12 +24,27 @@ module Unparser
         write(' = ')
 
         if BINARY_OPERATOR.include?(right.type)
-          writer_with(Writer::Binary, right).emit_operator
+          writer_with(Writer::Binary, node: right).emit_operator
+        elsif n_array?(right)
+          emit_array
+        else
+          right_emitter.write_to_buffer
+        end
+      end
+
+      def emit_array
+        if right.children.size > 1
+          delimited(right.children)
         else
-          visit(right)
+          right_emitter.write_to_buffer
         end
       end
 
+      def right_emitter
+        emitter(right)
+      end
+      memoize :right_emitter
+
       abstract_method :emit_left
 
       # Variable assignment emitter

data/lib/unparser/emitter/begin.rb

@@ -8,12 +8,6 @@ module Unparser
       handle :begin
       children :body
 
-      def emit_heredoc_reminders
-        children.each do |child|
-          emitter(child).emit_heredoc_reminders
-        end
-      end
-
     private
 
       def dispatch

data/lib/unparser/emitter/binary.rb

@@ -13,7 +13,7 @@ module Unparser
       end
 
       def writer
-        writer_with(Writer::Binary, node)
+        writer_with(Writer::Binary, node:)
       end
       memoize :writer
     end # Binary

data/lib/unparser/emitter/block.rb

@@ -5,7 +5,7 @@ module Unparser
 
     # Block emitter
     class Block < self
-      handle :block, :numblock
+      handle :block, :numblock, :itblock
 
       children :target, :arguments, :body
 
@@ -16,7 +16,6 @@ module Unparser
         ws
         write_open
         emit_block_arguments unless n_lambda?(target)
-        target_writer.emit_heredoc_reminders if n_send?(target)
         emit_optional_body_ensure_rescue(body)
         write_close
       end
@@ -42,7 +41,7 @@ module Unparser
       end
 
       def target_writer
-        writer_with(Writer::Send::Regular, target)
+        writer_with(Writer::Send::Regular, node: target)
       end
       memoize :target_writer
 
@@ -65,20 +64,28 @@ module Unparser
       end
 
       def emit_lambda_arguments
-        parentheses { writer_with(Args, arguments).emit_lambda_arguments }
+        parentheses { writer_with(Args, node: arguments).emit_lambda_arguments }
       end
 
       def numblock?
         node.type.equal?(:numblock)
       end
 
+      # NOTE: mutant fails on Ruby < 3.4
+      # mutant:disable
+      def itblock?
+        node.type.equal?(:itblock)
+      end
+
+      # NOTE: mutant fails on Ruby < 3.4
+      # mutant:disable
       def emit_block_arguments
-        return if numblock? || arguments.children.empty?
+        return if numblock? || itblock? || arguments.children.empty?
 
         ws
 
         parentheses('|', '|') do
-          writer_with(Args, arguments).emit_block_arguments
+          writer_with(Args, node: arguments).emit_block_arguments
         end
       end
 

data/lib/unparser/emitter/def.rb

@@ -26,7 +26,7 @@ module Unparser
         return if arguments.children.empty?
 
         parentheses do
-          writer_with(Args, arguments).emit_def_arguments
+          writer_with(Args, node: arguments).emit_def_arguments
         end
       end