unparser 0.5.1 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5edf8f2731473b62649c92936d8c04ff8a19e598bdc9811feb332d8cd3cff58f
-  data.tar.gz: 8e47978900270932616a7c7b1a8869442d0d0e64c90a6147b7bd6d0938edea44
+  metadata.gz: 21e418840b351f5e697c472127300d7733ca1c20bdf4be321ae1832133447767
+  data.tar.gz: c130412892dcb6a1db4835c3ef9fa9738f2a181ede78ccca6a7a13336a348e8c
 SHA512:
-  metadata.gz: d5966f2f944ee5f596a3919d9c6d6b1ce1406ba4ab015b39d220941f35c4c5e5aeb401c270dab0b60883bd8b5fb3379d7dafe28be657a4af9fa4045be784a6f4
-  data.tar.gz: 837b201d4d4ea307cbdc50d04640957618f6ccec1e7d5782b5b3654901369d80f02425d5c4a9b61cb1f90fb87d14146fff4889b7b1d49039369d58fdc33aa7d8
+  metadata.gz: 4a25a3e71df443024af556d20ca97f9a627874ee5857a4badfa2c7bd228159732fac0060715b198acc5648879c25baf8c0b10496f6cb0303fa41841cf06521ad
+  data.tar.gz: 8dec6ae089dbf574a7687177993da010f2569677217032e95079e007598c04e0acbb35d967667532331187d6ab25c81346c5073454dda7665e8864fc0e31e42a

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/lib/unparser.rb

@@ -50,6 +50,23 @@ module Unparser
     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.
@@ -100,21 +117,10 @@ module Unparser
     Parser::CurrentRuby.new(Builder.new).tap do |parser|
       parser.diagnostics.tap do |diagnostics|
         diagnostics.all_errors_are_fatal = true
-        diagnostics.consumer             = method(:consume_diagnostic)
       end
     end
   end
 
-  # Consume diagnostic
-  #
-  # @param [Parser::Diagnostic] diagnostic
-  #
-  # @return [undefined]
-  def self.consume_diagnostic(diagnostic)
-    Kernel.warn(diagnostic.render)
-  end
-  private_class_method :consume_diagnostic
-
   # Construct a parser buffer from string
   #
   # @param [String] source
@@ -192,6 +198,9 @@ require 'unparser/emitter/undef'
 require 'unparser/emitter/variable'
 require 'unparser/emitter/xstr'
 require 'unparser/emitter/yield'
+require 'unparser/emitter/kwargs'
+require 'unparser/emitter/pair'
+require 'unparser/emitter/match_pattern'
 require 'unparser/writer'
 require 'unparser/writer/binary'
 require 'unparser/writer/dynamic_string'

data/lib/unparser/emitter/flow_modifier.rb

@@ -19,8 +19,11 @@ module Unparser
       def dispatch
         write(MAP.fetch(node.type))
 
-        unless children.empty?
-          emit_arguments
+        if children.one? && n_if?(children.first)
+          ws
+          emitter(children.first).emit_ternary
+        else
+          emit_arguments unless children.empty?
         end
       end
 

data/lib/unparser/emitter/hash.rb

@@ -4,10 +4,6 @@ module Unparser
   class Emitter
     # Emitter for Hash literals
     class Hash < self
-      BAREWORD = /\A[A-Za-z_][A-Za-z_0-9]*[?!]?\z/.freeze
-
-      private_constant(*constants(false))
-
       handle :hash
 
       def emit_last_argument_hash
@@ -41,34 +37,8 @@ module Unparser
       end
 
       def emit_hash_body
-        delimited(children, &method(:emit_hash_member))
-      end
-
-      def emit_hash_member(node)
-        if n_kwsplat?(node)
-          visit(node)
-        else
-          emit_pair(node)
-        end
+        delimited(children)
       end
-
-      def emit_pair(pair)
-        key, value = *pair.children
-
-        if colon?(key)
-          write(key.children.first.to_s, ': ')
-        else
-          visit(key)
-          write(' => ')
-        end
-
-        visit(value)
-      end
-
-      def colon?(key)
-        n_sym?(key) && BAREWORD.match?(key.children.first)
-      end
-
     end # Hash
   end # Emitter
 end # Unparser

data/lib/unparser/emitter/if.rb

@@ -8,6 +8,14 @@ module Unparser
 
       children :condition, :if_branch, :else_branch
 
+      def emit_ternary
+        visit(condition)
+        write(' ? ')
+        visit(if_branch)
+        write(' : ')
+        visit(else_branch)
+      end
+
     private
 
       def dispatch

data/lib/unparser/emitter/in_pattern.rb

@@ -27,6 +27,8 @@ module Unparser
           ws
           write('then')
           emit_body(branch)
+        else
+          nl
         end
       end
     end # InPattern

data/lib/unparser/emitter/kwargs.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Unparser
+  class Emitter
+    class Kwargs < self
+      handle :kwargs
+
+      def dispatch
+        delimited(children)
+      end
+    end # Kwargs
+  end # Emitter
+end # Unparser

data/lib/unparser/emitter/match_pattern.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Unparser
+  class Emitter
+    # Emitter for in pattern nodes
+    class MatchPattern < self
+
+      handle :match_pattern
+      handle :match_pattern_p
+
+      children :target, :pattern
+
+    private
+
+      def dispatch
+        visit(target)
+        write(' in ')
+        visit(pattern)
+      end
+    end # InPattern
+  end # Emitter
+end # Unparser

data/lib/unparser/emitter/pair.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Unparser
+  class Emitter
+    # Emitter for key value pairs in hash literals or kwargs
+    class Pair < self
+      BAREWORD = /\A[A-Za-z_][A-Za-z_0-9]*[?!]?\z/.freeze
+
+      private_constant(*constants(false))
+
+      handle :pair
+
+      children :key, :value
+
+    private
+
+      def dispatch
+        if colon?(key)
+          write(key.children.first.to_s, ': ')
+        else
+          visit(key)
+          write(' => ')
+        end
+
+        visit(value)
+      end
+
+      def colon?(key)
+        n_sym?(key) && BAREWORD.match?(key.children.first)
+      end
+    end
+  end
+end

data/lib/unparser/emitter/splat.rb

@@ -22,12 +22,22 @@ module Unparser
 
       children :subject
 
+      def emit_mlhs
+        write('*')
+        subject_emitter.emit_mlhs if subject
+      end
+
     private
 
       def dispatch
         write('*')
-        visit(subject) if subject
+        subject_emitter.write_to_buffer
+      end
+
+      def subject_emitter
+        emitter(subject)
       end
+      memoize :subject_emitter
     end
   end
 end # Unparser

data/lib/unparser/generation.rb

@@ -204,7 +204,9 @@ module Unparser
     end
 
     def emit_rescue_postcontrol(node)
-      writer_with(Writer::Rescue, node).emit_postcontrol
+      writer = writer_with(Writer::Rescue, node)
+      writer.emit_postcontrol
+      writer.emit_heredoc_reminders
     end
 
     def emit_rescue_regular(node)

data/lib/unparser/node_helpers.rb

@@ -45,6 +45,7 @@ module Unparser
       ensure
       hash
       hash_pattern
+      if
       in_pattern
       int
       kwsplat

data/lib/unparser/validation.rb

@@ -71,6 +71,27 @@ module Unparser
       )
     end
 
+    # Create validator from node
+    #
+    # @param [Parser::AST::Node] original_node
+    #
+    # @return [Validator]
+    def self.from_node(original_node)
+      generated_source = Unparser.unparse_either(original_node)
+
+      generated_node = generated_source
+        .lmap(&method(:const_unit))
+        .bind(&Unparser.public_method(:parse_either))
+
+      new(
+        identification:   '(string)',
+        original_source:  generated_source,
+        original_node:    MPrelude::Either::Right.new(original_node),
+        generated_source: generated_source,
+        generated_node:   generated_node
+      )
+    end
+
     # Create validator from file
     #
     # @param [Pathname] path

data/lib/unparser/writer/dynamic_string.rb

@@ -20,7 +20,7 @@ module Unparser
         ]
       )
 
-      FLAT_INTERPOLATION = %i[ivar cvar gvar].to_set.freeze
+      FLAT_INTERPOLATION = %i[ivar cvar gvar nth_ref].to_set.freeze
 
       private_constant(*constants(false))
 
@@ -42,7 +42,7 @@ module Unparser
     private
 
       def heredoc_header
-        need_squiggly? ? '<<~HEREDOC' : '<<-HEREDOC'
+        '<<-HEREDOC'
       end
 
       def heredoc?
@@ -55,11 +55,7 @@ module Unparser
 
       def emit_heredoc_body
         nl
-        if need_squiggly?
-          emit_squiggly_heredoc_body
-        else
-          emit_normal_heredoc_body
-        end
+        emit_normal_heredoc_body
       end
 
       def emit_heredoc_footer
@@ -119,10 +115,6 @@ module Unparser
         n_str?(last) && last.children.first[-1].eql?("\n")
       end
 
-      def need_squiggly?
-        children.any?(s(:str, ''))
-      end
-
       def emit_squiggly_heredoc_body
         buffer.indent
         children.each do |child|

data/lib/unparser/writer/rescue.rb

@@ -20,6 +20,10 @@ module Unparser
         end
       end
 
+      def emit_heredoc_reminders
+        emitter(body).emit_heredoc_reminders
+      end
+
       def emit_postcontrol
         visit(body)
         writer_with(Resbody, rescue_body).emit_postcontrol

data/lib/unparser/writer/send.rb

@@ -45,7 +45,7 @@ module Unparser
       def effective_writer_class
         if details.binary_syntax_allowed?
           Binary
-        elsif details.selector_unary_operator?
+        elsif details.selector_unary_operator? && n_send?(node)
           Unary
         elsif write_as_attribute_assignment?
           AttributeAssignment
@@ -75,20 +75,7 @@ module Unparser
       end
 
       def emit_normal_arguments
-        parentheses do
-          arguments.each_with_index do |node, index|
-            write(', ') unless index.zero?
-            emit_argument(node, index.succ.equal?(arguments.length))
-          end
-        end
-      end
-
-      def emit_argument(argument, last)
-        if n_hash?(argument) && last
-          writer_with(Emitter::Hash, argument).emit_last_argument_hash
-        else
-          visit(argument)
-        end
+        parentheses { delimited(arguments) }
       end
 
       def emit_heredoc_reminder(argument)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unparser
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.6
 platform: ruby
 authors:
 - Markus Schirp
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2020-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abstract_type
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.5
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.5
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: procto
   requirement: !ruby/object:Gem::Requirement
@@ -142,28 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.13
+        version: 0.10.21
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.13
+        version: 0.10.21
 - !ruby/object:Gem::Dependency
   name: mutant-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.13
+        version: 0.10.21
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.13
+        version: 0.10.21
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -198,42 +198,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.92.0
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.92.0
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.5'
 description: Generate equivalent source for parser gem AST nodes
 email: mbj@schirp-dso.com
 executables:
@@ -285,17 +285,20 @@ files:
 - lib/unparser/emitter/in_match.rb
 - lib/unparser/emitter/in_pattern.rb
 - lib/unparser/emitter/index.rb
+- lib/unparser/emitter/kwargs.rb
 - lib/unparser/emitter/kwbegin.rb
 - lib/unparser/emitter/lambda.rb
 - lib/unparser/emitter/masgn.rb
 - lib/unparser/emitter/match.rb
 - lib/unparser/emitter/match_alt.rb
 - lib/unparser/emitter/match_as.rb
+- lib/unparser/emitter/match_pattern.rb
 - lib/unparser/emitter/match_rest.rb
 - lib/unparser/emitter/match_var.rb
 - lib/unparser/emitter/mlhs.rb
 - lib/unparser/emitter/module.rb
 - lib/unparser/emitter/op_assign.rb
+- lib/unparser/emitter/pair.rb
 - lib/unparser/emitter/pin.rb
 - lib/unparser/emitter/primitive.rb
 - lib/unparser/emitter/range.rb
@@ -331,7 +334,10 @@ files:
 homepage: http://github.com/mbj/unparser
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/mbj/unparser/issues
+  changelog_uri: https://github.com/mbj/unparser/blob/master/Changelog.md
+  funding_uri: https://github.com/sponsors/mbj
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -340,14 +346,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Generate equivalent source for parser gem AST nodes