unparser 0.6.7 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43c55e0072230fba02c24266555e1599559396739677e4371b6c9bca4b2a29b1
-  data.tar.gz: 4743b675c63ed3cf84ee3c784b70fd5078f8ed4e022e02bde27473a7bf44dbbe
+  metadata.gz: 55ff925fe35a0edc1d97f78f4c2cf18590a3f2b4a11bc33e4b786a5954b4a38b
+  data.tar.gz: 41298c66c043f4f886215b23f6e1b16cd5bfc4fda9cac590a4dcfbf79c7b3ad8
 SHA512:
-  metadata.gz: 94bc33d333f3652cbdfa12169432d7a139b568cb72d4ae08994921760d2f7c8348a8d35f717053c059866ce7e640d08c9af6495a5e37132b2b667d1895b889da
-  data.tar.gz: ee2ee8e37250de111c419566c74d7b5954b02137f9e6fcb88cf9ff26820583698faf2533e6d01ae5738481bab91797060e2773781e9c93cb8da26efce602c1b0
+  metadata.gz: '08b368b24f292f467d75f2cbbea4488dc117fbfc1619c0ab14eee351121221bf63d0c60aa8cffb1cc9f795eb87fd0a5e0d1cefd196ec955f8d3c0b12784f57a6'
+  data.tar.gz: 9a21fffcd287e446c6e5a459556d1c863490ebbaa906ea4f775619286405d18fab3821c5fc3e14ba4ab8fc8f68de344b6a71565f7e8980f8eac43a762b7caf66

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.3
 
 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:
 ------------
@@ -173,12 +173,12 @@ Included Libraries
 
 For dependency reduction reasons unparser ships vendored (and reduced) versions of:
 
-* [abstract_type](https://github.com/mbj/concord) -> Unparser::AbstractType
+* [abstract_type](https://github.com/dkubb/abstract_type) -> Unparser::AbstractType
 * [adamantium](https://github.com/dkubb/adamantium) -> Unparser::Adamantium
-* [anima](https://github.com/mbj/concord) -> Unparser::Anima
-* [concord](https://github.com/mbj/concord) -> Unparser::Concord
-* [memoizable](https://github.com/dkubb/memoizable) -> Unparser::Adamantium
-* [mprelude](https://github.com/dkubb/memoizable) -> Unparser::Either
+* [anima](https://github.com/mbj/anima) -> Unparser::Anima
+* [equalizer](https://github.com/dkubb/equalizer) -> Unparser::Equalizer
+* [memoizable](https://github.com/dkubb/memoizable) -> Unparser::Memoizable
+* [mprelude](http://prelude.rubyforge.org/) -> Unparser::Either
 
 Contributing
 -------------

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

@@ -50,9 +50,7 @@ module Unparser
     #
     # @return [Hash]
     def attributes_hash(object)
-      attributes.each_with_object({}) do |attribute, attributes_hash|
-        attributes_hash[attribute.name] = attribute.get(object)
-      end
+      attributes.to_h { |attribute| [attribute.name, attribute.get(object)] }
     end
 
     # Return attribute names
@@ -134,14 +132,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:, &)
+        new(stack: stack).each(node: node, &)
       end
 
       # Enumerate local variable scope scope
@@ -118,8 +121,8 @@ module Unparser
       #
       # @api private
       #
-      def each(node, &block)
-        visit(node, &block)
+      def each(node:, &)
+        visit(node, &)
       end
 
     private
@@ -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,
@@ -78,19 +90,13 @@ module Unparser
 
     # AST enumerator
     class Enumerator
-      include Adamantium, Concord.new(:node, :controller), Enumerable
+      include Adamantium, Equalizer.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
+      attr_reader :node, :controller
+
+      def initialize(node, controller)
+        @node = node
+        @controller = controller
       end
 
       # Return each node
@@ -103,8 +109,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
@@ -131,50 +137,27 @@ module Unparser
         select { |node| node.type.equal?(type) }
       end
 
-      # Return frozne set of objects
-      #
-      # @param [Enumerable] enumerable
-      #
-      # @return [Set]
-      #
-      # @api private
-      #
-      def self.set(enumerable)
-        enumerable.to_set.freeze
-      end
-      private_class_method :set
-
-      # Return nodes of type
-      #
-      # @param [Parser::AST::Node] node
-      # @param [Symbol] type
-      #
-      # @return [Enumerable<Parser::AST::Node]
-      #
-      # @api private
-      #
-      def self.type(node, type)
-        new(node).type(type)
-      end
-      private_class_method :type
-
     end # Enumerator
 
     # Controlled AST walker walking the AST in deeth first search with pre order
     class Walker
-      include Concord.new(:block, :controller)
+      include Equalizer.new(:block, :controller)
+
+      attr_reader :block, :controller
+
+      def initialize(block, controller)
+        @block = block
+        @controller = controller
+      end
 
       # Call ast walker
       #
       # @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
@@ -12,7 +14,15 @@ module Unparser
 
       # Path target
       class Path < self
-        include Concord.new(:path)
+        include Equalizer.new(:path)
+
+        attr_reader :path
+
+        # rubocop:disable Lint/MissingSuper
+        def initialize(path)
+          @path = path
+        end
+        # rubocop:enable Lint/MissingSuper
 
         # Validation for this target
         #
@@ -31,7 +41,13 @@ module Unparser
 
       # String target
       class String
-        include Concord.new(:string)
+        include Equalizer.new(:string)
+
+        attr_reader :string
+
+        def initialize(string)
+          @string = string
+        end
 
         # Validation for this target
         #
@@ -60,8 +76,9 @@ module Unparser
     #
     # @api private
     #
-    def self.run(*arguments)
-      new(*arguments).exit_status
+    # mutant:disable
+    def self.run(*)
+      new(*).exit_status
     end
 
     # Initialize object
@@ -71,15 +88,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 +117,7 @@ module Unparser
     #
     # @api private
     #
+    # mutant:disable
     # rubocop:disable Metrics/MethodLength
     def add_options(builder)
       builder.banner = 'usage: unparse [options] FILE [FILE]'
@@ -114,6 +134,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 +152,7 @@ module Unparser
     #
     # @api private
     #
+    # mutant:disable
     def exit_status
       effective_targets.each do |target|
         process_target(target)
@@ -140,11 +164,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 +180,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 +203,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

@@ -3,7 +3,13 @@
 module Unparser
   # Class to colorize strings
   class Color
-    include Adamantium, Concord.new(:code)
+    include Adamantium, Equalizer.new(:code)
+
+    attr_reader :code
+
+    def initialize(code)
+      @code = code
+    end
 
     # Format text with color
     #
@@ -30,8 +36,10 @@ module Unparser
 
       # 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/comments.rb

@@ -15,8 +15,8 @@ module Unparser
     #
     # @api private
     #
-    def source_range(*arguments)
-      self.class.source_range(*arguments)
+    def source_range(*)
+      self.class.source_range(*)
     end
 
     # Initialize object

data/lib/unparser/diff.rb

@@ -3,7 +3,14 @@
 module Unparser
   # Class to create diffs from source code
   class Diff
-    include Adamantium, Concord.new(:old, :new)
+    include Adamantium, Equalizer.new(:old, :new)
+
+    attr_reader :old, :new
+
+    def initialize(old, new)
+      @old = old
+      @new = new
+    end
 
     ADDITION = '+'
     DELETION = '-'