unparser 0.4.9 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10fe213bc822f4da69795458d89fc34693b5c57f1add6e910a77f8f456f5cff4
-  data.tar.gz: a1333c5af931e182f3fe0c5586d010f306f5b51d5e8f5204beb2bd47cce8a9d2
+  metadata.gz: 83c5893dd093e0f106fefd55abad7931fa775001f53a7449389e40afe0640359
+  data.tar.gz: d4caba221ba0b3dcd5afdff73d0df537c24c56f3219e0896e5f67b92b79f6afc
 SHA512:
-  metadata.gz: aa4d72074d1f1aeeafaf7f87cc53f5a6754dcb06ae99d1c73191b776bb10c9b58db0be2fdd8c9487e61e0cfdc1918e78aac35adccc7b706ea2b9b5b4101faaaf
-  data.tar.gz: 336938a288a1ada6f33db990535b7d487d618a4f60725101b282c5654fd8e1c953c412c5b8dc9cad9afb936c64ddafd65b5fa0797016022c0a8ce52df35c3ec7
+  metadata.gz: 7c7feff0af410abca14daa35166d64b95cda39959f5f6424fb2840a8c5f63b630be4aaba9d22018d745adb2578a9ed7ffc538f4d0c3e6b5224f00e8dd6fceca0
+  data.tar.gz: efd0a71dc4988fcf804eab203a4fbed157629c531135d7cbaf2e4ccf5c26c9b1ea2a694c1eb1c2f451f91cfe91b6420d683ff76da6779adaef1e3d015c8ab51b

data/README.md

@@ -4,7 +4,7 @@ unparser
 ![CI](https://github.com/mbj/unparser/workflows/CI/badge.svg)
 [![Gem Version](https://img.shields.io/gem/v/unparser.svg)](https://rubygems.org/gems/unparser)
 
-Generate equivalent source for ASTs from whitequarks [parser](https://github.com/whitequark/parser).
+Generate equivalent source for ASTs from [parser](https://github.com/whitequark/parser).
 
 The following constraints apply:
 
@@ -12,8 +12,13 @@ The following constraints apply:
 * Only support for the [modern AST](https://github.com/whitequark/parser/#usage) format
 * Only support for Ruby >= 2.5
 
-It serves well for [mutant](https://github.com/mbj/mutant) mutators and the in-memory vendoring for self hosting,
-and other tooling.
+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).
+
+(if you want your tool to be mentioned here please PR the addition with a TLDR of your use case).
 
 Public API:
 -----------
@@ -86,12 +91,22 @@ RUBY
 
 generated = Unparser.unparse(node) # ["foo", "bar"], NOT %w[foo bar] !
 
-code == generated                            # false, not identical code
+code == generated                 # false, not identical code
 Unparser.parse(generated) == node # true, but identical AST
 ```
 
 Summary: unparser does not reproduce your source! It produces equivalent source.
 
+Ruby Versions:
+--------------
+
+Unparsers primay reason for existance is mutant and its
+supported [Ruby-Versions](https://github.com/mbj/mutant#ruby-versions).
+
+Basically: All non EOL MRI releases.
+
+If you need to generate Ruby Syntax outside of this band feel free to contact me (email in gemspec).
+
 Testing:
 --------
 

data/bin/unparser

@@ -5,6 +5,6 @@ trap('INT') do |status|
   exit! 128 + status
 end
 
-require 'unparser/cli'
+require 'unparser'
 
 exit Unparser::CLI.run(ARGV)

data/lib/unparser.rb

@@ -6,6 +6,7 @@ require 'concord'
 require 'diff/lcs'
 require 'diff/lcs/hunk'
 require 'mprelude'
+require 'optparse'
 require 'parser/current'
 require 'procto'
 require 'set'
@@ -15,6 +16,12 @@ module Unparser
   # Unparser specific AST builder defaulting to modern AST format
   class Builder < Parser::Builders::Default
     modernize
+
+    def initialize
+      super
+
+      self.emit_file_line_as_literals = false
+    end
   end
 
   EMPTY_STRING = ''.freeze
@@ -32,12 +39,44 @@ module Unparser
   # @api private
   #
   def self.unparse(node, comment_array = [])
-    node = Preprocessor.run(node)
-    buffer = Buffer.new
-    comments = Comments.new(comment_array)
-    root = Emitter::Root.new(Parser::AST::Node.new(:root, [node]), buffer, comments)
-    Emitter.emitter(node, root).write_to_buffer
-    buffer.content
+    return '' if node.nil?
+
+    Buffer.new.tap do |buffer|
+      Emitter::Root.new(
+        buffer,
+        node,
+        Comments.new(comment_array)
+      ).write_to_buffer
+    end.content
+  end
+
+  # Unparse with validation
+  #
+  # @param [Parser::AST::Node, nil] node
+  # @param [Array] comment_array
+  #
+  # @return [Either<Validation,String>]
+  def self.unparse_validate(node, comment_array = [])
+    generated = unparse(node, comment_array)
+    validation = Validation.from_string(generated)
+
+    if validation.success?
+      MPrelude::Either::Right.new(generated)
+    else
+      MPrelude::Either::Left.new(validation)
+    end
+  end
+
+  # Unparse capturing errors
+  #
+  # This is mostly useful for writing testing tools against unparser.
+  #
+  # @param [Parser::AST::Node, nil] node
+  #
+  # @return [Either<Exception, String>]
+  def self.unparse_either(node)
+    MPrelude::Either
+      .wrap_error(Exception) { unparse(node) }
   end
 
   # Parse string into AST
@@ -74,8 +113,6 @@ module Unparser
   # @return [Parser::Base]
   #
   # @api private
-  #
-  # ignore :reek:NestedIterators
   def self.parser
     Parser::CurrentRuby.new(Builder.new).tap do |parser|
       parser.diagnostics.tap do |diagnostics|
@@ -100,75 +137,92 @@ module Unparser
   # @param [String] source
   #
   # @return [Parser::Source::Buffer]
-  def self.buffer(source)
-    Parser::Source::Buffer.new('(string)').tap do |buffer|
-      buffer.source = source
-    end
+  def self.buffer(source, identification = '(string)')
+    Parser::Source::Buffer.new(identification, source: source)
   end
 end # Unparser
 
-require 'unparser/buffer'
 require 'unparser/node_helpers'
-require 'unparser/preprocessor'
-require 'unparser/comments'
-require 'unparser/constants'
-require 'unparser/dsl'
 require 'unparser/ast'
 require 'unparser/ast/local_variable_scope'
-require 'unparser/diff'
+require 'unparser/buffer'
+require 'unparser/generation'
 require 'unparser/color'
+require 'unparser/comments'
+require 'unparser/constants'
+require 'unparser/diff'
+require 'unparser/dsl'
 require 'unparser/emitter'
-require 'unparser/emitter/literal'
-require 'unparser/emitter/literal/primitive'
-require 'unparser/emitter/literal/singleton'
-require 'unparser/emitter/literal/dynamic'
-require 'unparser/emitter/literal/regexp'
-require 'unparser/emitter/literal/array'
-require 'unparser/emitter/literal/hash'
-require 'unparser/emitter/literal/range'
-require 'unparser/emitter/literal/dynamic_body'
-require 'unparser/emitter/literal/execute_string'
-require 'unparser/emitter/meta'
-require 'unparser/emitter/send'
-require 'unparser/emitter/send/unary'
-require 'unparser/emitter/send/binary'
-require 'unparser/emitter/send/regular'
-require 'unparser/emitter/send/conditional'
-require 'unparser/emitter/send/attribute_assignment'
-require 'unparser/emitter/block'
-require 'unparser/emitter/assignment'
-require 'unparser/emitter/variable'
-require 'unparser/emitter/splat'
-require 'unparser/emitter/cbase'
+require 'unparser/emitter/alias'
+require 'unparser/emitter/args'
 require 'unparser/emitter/argument'
+require 'unparser/emitter/array'
+require 'unparser/emitter/array_pattern'
+require 'unparser/emitter/assignment'
 require 'unparser/emitter/begin'
-require 'unparser/emitter/flow_modifier'
-require 'unparser/emitter/undef'
-require 'unparser/emitter/def'
+require 'unparser/emitter/binary'
+require 'unparser/emitter/block'
+require 'unparser/emitter/case'
+require 'unparser/emitter/case_guard'
+require 'unparser/emitter/case_match'
+require 'unparser/emitter/cbase'
 require 'unparser/emitter/class'
-require 'unparser/emitter/module'
-require 'unparser/emitter/op_assign'
+require 'unparser/emitter/const_pattern'
+require 'unparser/emitter/def'
 require 'unparser/emitter/defined'
+require 'unparser/emitter/dstr'
+require 'unparser/emitter/dsym'
+require 'unparser/emitter/flipflop'
+require 'unparser/emitter/float'
+require 'unparser/emitter/flow_modifier'
+require 'unparser/emitter/for'
+require 'unparser/emitter/hash'
+require 'unparser/emitter/hash_pattern'
 require 'unparser/emitter/hookexe'
-require 'unparser/emitter/super'
-require 'unparser/emitter/retry'
-require 'unparser/emitter/redo'
 require 'unparser/emitter/if'
-require 'unparser/emitter/alias'
-require 'unparser/emitter/yield'
-require 'unparser/emitter/binary'
-require 'unparser/emitter/case'
-require 'unparser/emitter/for'
-require 'unparser/emitter/repetition'
-require 'unparser/emitter/root'
-require 'unparser/emitter/match'
-require 'unparser/emitter/empty'
-require 'unparser/emitter/flipflop'
-require 'unparser/emitter/rescue'
-require 'unparser/emitter/resbody'
-require 'unparser/emitter/ensure'
+require 'unparser/emitter/in_match'
+require 'unparser/emitter/in_pattern'
 require 'unparser/emitter/index'
+require 'unparser/emitter/kwbegin'
 require 'unparser/emitter/lambda'
+require 'unparser/emitter/masgn'
+require 'unparser/emitter/match'
+require 'unparser/emitter/match_alt'
+require 'unparser/emitter/match_as'
+require 'unparser/emitter/match_rest'
+require 'unparser/emitter/match_var'
+require 'unparser/emitter/mlhs'
+require 'unparser/emitter/module'
+require 'unparser/emitter/op_assign'
+require 'unparser/emitter/pin'
+require 'unparser/emitter/primitive'
+require 'unparser/emitter/range'
+require 'unparser/emitter/regexp'
+require 'unparser/emitter/repetition'
+require 'unparser/emitter/rescue'
+require 'unparser/emitter/root'
+require 'unparser/emitter/send'
+require 'unparser/emitter/simple'
+require 'unparser/emitter/splat'
+require 'unparser/emitter/super'
+require 'unparser/emitter/undef'
+require 'unparser/emitter/variable'
+require 'unparser/emitter/xstr'
+require 'unparser/emitter/yield'
+require 'unparser/writer'
+require 'unparser/writer/binary'
+require 'unparser/writer/dynamic_string'
+require 'unparser/writer/resbody'
+require 'unparser/writer/rescue'
+require 'unparser/writer/send'
+require 'unparser/writer/send/attribute_assignment'
+require 'unparser/writer/send/binary'
+require 'unparser/writer/send/regular'
+require 'unparser/writer/send/unary'
+require 'unparser/node_details'
+require 'unparser/node_details/send'
+require 'unparser/cli'
+
 require 'unparser/validation'
 # make it easy for zombie
 require 'unparser/finalize'

data/lib/unparser/ast.rb

@@ -2,7 +2,6 @@
 
 module Unparser
   # Namespace for AST processing tools
-  # :reek:TooManyConstants
   module AST
 
     FIRST_CHILD = ->(node) { node.children.first }.freeze

data/lib/unparser/ast/local_variable_scope.rb

@@ -61,35 +61,22 @@ module Unparser
       #
       # @api private
       #
-      def first_assignment_in_body_and_used_in_condition?(body, condition)
-        condition_reads = AST.local_variable_reads(condition)
+      def first_assignment_in?(left, right)
+        condition_reads = AST.local_variable_reads(right)
 
-        candidates = AST.local_variable_assignments(body).select do |node|
-          name = node.children.first
-          condition_reads.include?(name)
+        candidates = AST.local_variable_assignments(left).select do |node|
+          condition_reads.include?(node.children.first)
         end
 
-        candidates.any? do |node|
-          first_assignment?(node)
-        end
+        candidates.any?(&public_method(:first_assignment?))
       end
 
     private
 
-      # Match node
-      #
-      # @param [Parser::AST::Node] needle
-      #   if block given
-      #
-      # @return [Boolean]
-      #
-      # @api private
-      #
       def match(needle)
         @items.each do |node, current, before|
           return yield(current, before) if node.equal?(needle)
         end
-        false
       end
 
     end # LocalVariableScope
@@ -137,25 +124,10 @@ module Unparser
 
     private
 
-      # Return current set of local variables
-      #
-      # @return [Set<Symbol>]
-      #
-      # @api private
-      #
       def current
         @stack.last
       end
 
-      # Visit node and record local variable state
-      #
-      # @param [Parser::AST::Node] node
-      #
-      # @return [undefined]
-      #
-      # @api private
-      #
-      # ignore :reek:LongYieldList
       def visit(node, &block)
         before = current.dup
         enter(node)
@@ -166,75 +138,33 @@ module Unparser
         leave(node)
       end
 
-      # Record local variable state
-      #
-      # @param [Parser::AST::Node] node
-      #
-      # @return [undefined]
-      #
-      # @api private
-      #
       def enter(node)
         case node.type
         when *RESET_NODES
           push_reset
-        when *ASSIGN_NODES
+        when ASSIGN_NODES
           define(node.children.first)
         when *INHERIT_NODES
           push_inherit
         end
       end
 
-      # Pop from local variable state
-      #
-      # @param [Parser::AST::Node] node
-      #
-      # @return [undefined]
-      #
-      # @api private
-      #
       def leave(node)
         pop if CLOSE_NODES.include?(node.type)
       end
 
-      # Define a local variable on current stack
-      #
-      # @param [Symbol] name
-      #
-      # @return [undefined]
-      #
-      # @api private
-      #
       def define(name)
         current << name
       end
 
-      # Push reset scope on stack
-      #
-      # @return [undefined]
-      #
-      # @api private
-      #
       def push_reset
         @stack << Set.new
       end
 
-      # Push inherited lvar scope on stack
-      #
-      # @return [undefined]
-      #
-      # @api private
-      #
       def push_inherit
         @stack << current.dup
       end
 
-      # Pop lvar scope from stack
-      #
-      # @return [undefined]
-      #
-      # @api private
-      #
       def pop
         @stack.pop
       end

data/lib/unparser/buffer.rb

@@ -3,8 +3,6 @@
 module Unparser
 
   # Buffer used to emit into
-  #
-  # ignore :reek:TooManyMethods
   class Buffer
 
     NL = "\n".freeze
@@ -82,6 +80,13 @@ module Unparser
       self
     end
 
+    def root_indent
+      before = @indent
+      @indent = 0
+      yield
+      @indent = before
+    end
+
     # Test for a fresh line
     #
     # @return [Boolean]
@@ -114,26 +119,24 @@ module Unparser
       @content[size_before..-1]
     end
 
-  private
-
-    INDENT_SPACE = '  '.freeze
-
-    # Write prefix
-    #
-    # @return [String]
+    # Write raw fragment to buffer
     #
-    # @api private
-    #
-    def prefix
-      write(INDENT_SPACE * @indent)
-    end
-
-    # Write to content buffer
+    # Does not do indentation logic.
     #
     # @param [String] fragment
     #
+    # @return [self]
     def write(fragment)
       @content << fragment
+      self
+    end
+
+  private
+
+    INDENT_SPACE = '  '.freeze
+
+    def prefix
+      write(INDENT_SPACE * @indent)
     end
 
   end # Buffer