unparser 0.6.5 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd425c8abea3ba512e8652c7f913b5ed09b5254fa868358f000f3af1fcd3ed82
-  data.tar.gz: caf2e58c2f862bd94f63d3290876b61620cf100a22c88a07d3916d87f253c0c0
+  metadata.gz: e0e776dd7b47efb62b8ad18d7262d247362944f28ea67edb7e518d8a94c74649
+  data.tar.gz: 759ec6fb240c4c62835bd8c789877fc26fc974563d2566687a63b2c0dec1072f
 SHA512:
-  metadata.gz: f45782eed90b778fbde30cdbd90f388a4b9f649e0080c26618e9243014618774d3afd9eb2076c7a47d0a0d43e137d1940382c85d0dea0915afa232f87d9e950d
-  data.tar.gz: 2fda013558e05453f9ea1540b64bb51a9bd9269f6166395bd92f775aed3523abc5878b1c92c5ba4f0352842b6b4fb532f317f8a5d54aa108822f94dfcb7d9e9a
+  metadata.gz: 11fe99943d2575e00ca2fc150a78cad1f2f830b3249f3692f473da7e520775fc9423b254fb2f7613e4b6811f03dd3d2af0d4bba1d0f2f143e048ab65281771ff
+  data.tar.gz: f08db4117aa2ebba9c5ac7a9e057ca7ddc9fc0613170752ac10cc7515058f491fe756b880db73629e2e7a8328cc979872b4c682197c061de39da52a44796587f

data/README.md

@@ -10,13 +10,13 @@ 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 >= 2.7
+* Only support for Ruby >= 3.2
 
 Notable Users:
 
 * [mutant](https://github.com/mbj/mutant) - Code review engine via mutation testing.
 * [ruby-next](https://github.com/ruby-next/ruby-next) - Ruby Syntax Backports.
-* May other [reverse-dependencies](https://rubygems.org/gems/unparser/reverse_dependencies).
+* Many other [reverse-dependencies](https://rubygems.org/gems/unparser/reverse_dependencies).
 
 (if you want your tool to be mentioned here please PR the addition with a TLDR of your use case).
 
@@ -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:
 ------------
@@ -187,10 +187,15 @@ Contributing
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.
-* Commit, do not mess with Rakefile or version
+* Commit, do not mess with version
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+Known Users
+-------------
+
+* [RailsRocket](https://www.railsrocket.app) - A no-code app builder that creates Rails apps
+
 License
 -------
 

data/bin/unparser

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 trap('INT') do |status|
-  exit! 128 + status
+  exit! status + 128
 end
 
 require 'unparser'

data/lib/unparser/adamantium.rb

@@ -20,9 +20,11 @@ module Unparser
       # @return [Object]
       #
       # @api public
+      #
+      # mutant:disable
       def freeze
         memoized_method_cache
-        super()
+        super
       end
 
     private

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, Concord.new(:node)
+      include Adamantium, Anima.new(:static_local_variables, :node)
 
       # Initialize object
       #
@@ -13,15 +12,18 @@ 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
-        super(node)
       end
 
       # Test if local variable was first at given assignment
@@ -54,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
@@ -91,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
@@ -118,7 +121,7 @@ module Unparser
       #
       # @api private
       #
-      def each(node, &block)
+      def each(node:, &block)
         visit(node, &block)
       end
 
@@ -133,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
@@ -143,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
@@ -44,7 +53,6 @@ module Unparser
     #
     def append_without_prefix(string)
       write(string)
-      self
     end
 
     # Increase indent
@@ -69,6 +77,10 @@ module Unparser
       self
     end
 
+    def ensure_nl
+      nl unless fresh_line?
+    end
+
     # Write newline
     #
     # @return [self]
@@ -76,10 +88,29 @@ 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
       before = @indent
       @indent = 0
@@ -107,18 +138,6 @@ module Unparser
       @content.dup.freeze
     end
 
-    # Capture the content written to the buffer within the block
-    #
-    # @return [String]
-    #
-    # @api private
-    #
-    def capture_content
-      size_before = content.size
-      yield
-      content[size_before..]
-    end
-
     # Write raw fragment to buffer
     #
     # Does not do indentation logic.
@@ -131,6 +150,10 @@ module Unparser
       self
     end
 
+    def write_encoding(encoding)
+      write("# -*- encoding: #{encoding} -*-\n")
+    end
+
   private
 
     INDENT_SPACE = '  '.freeze
@@ -139,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,13 +189,14 @@ 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')).sort
+        Dir.glob(File.join(file_name, '**/*.rb'))
       elsif File.file?(file_name)
         [file_name]
       else
-        Dir.glob(file_name).sort
+        Dir.glob(file_name)
       end.map { |file| Target::Path.new(Pathname.new(file)) }
     end
   end # CLI

data/lib/unparser/color.rb

@@ -28,7 +28,12 @@ module Unparser
 
     private
 
+      # Well rubocop you are static so you do not have a clue here ;)
+      # rubocop:disable Style/RedundantInitialize
+      # rubocop:disable Lint/MissingSuper
       def initialize; end
+      # rubocop:enable Style/RedundantInitialize
+      # 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/argument.rb

@@ -2,11 +2,13 @@
 
 module Unparser
   class Emitter
-    # Emitter for block and kwrestarg arguments
-    class Morearg < self
+    # Emitter for forwarding arguments
+    class ForwardArg < self
       MAP = {
-        blockarg:  '&',
-        kwrestarg: '**'
+        blockarg:            '&',
+        forwarded_kwrestarg: '**',
+        forwarded_restarg:   '*',
+        kwrestarg:           '**'
       }.freeze
 
       handle(*MAP.keys)

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