unparser 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96674256a364b20d34279b13821b1885615189db24c4ec229405b8305936fa4d
-  data.tar.gz: 1c5484ef44c86310837ad8626635228e56bf3227e11e3d4190f0159cb52dfc58
+  metadata.gz: 52e96163f8fc7a9a3da3464e326997c9dc5a094225806e0f2fc72e0474a97026
+  data.tar.gz: 719ac295c33e15c44cbe9bff91920536367b37409e71fb407f1fecef2cd69dbf
 SHA512:
-  metadata.gz: f5784148f66b8283b4b56a48f7b93c116b069a947ee3196012444bade8f02a67fb080cd52d6011068c8cdcf7ac82efe07bf1b3c2e7aa7215d66313369aa5e469
-  data.tar.gz: ce7223635f503a065e8d4826d6967817d9165adf76c424105bfc690f9c1b5dfee6c87dbb320c4ccb72af9ebcb78eb4b3fa2319977d89f0eb892e940bfd6b5eb6
+  metadata.gz: 661ff992d06f1c3f1ff05e66ecd789c08fc91432af9e082a036309a6d74bec83e99b58026f1e85080c86f2b8ab8d01de08bb8e743225e5204690670c9d0f280e
+  data.tar.gz: 338124c08c6e241f70f587db3e149da9562dfd18550bae2e1f4d6afaa76f9e3b9d39dae37ca1d81e7ff97d50e246a2a56faa984edb4988c05e9e69d6880d12ba

data/.circleci/config.yml

@@ -1,17 +1,41 @@
 defaults: &defaults
   working_directory: ~/unparser
-  steps:
-    - checkout
-    - run: bundle install
-    - run: bundle exec rake ci
+  docker:
+    - image: circleci/ruby:2.5.3
 version: 2
 jobs:
-  ruby_2_5:
+  unit_specs:
     <<: *defaults
-    docker:
-      - image: circleci/ruby:2.5.3
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rspec spec/unit
+  integration_specs:
+    <<: *defaults
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rspec spec/integration
+  metrics:
+    <<: *defaults
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rake metrics:rubocop
+      - run: bundle exec rake metrics:reek
+      - run: bundle exec rake metrics:flay
+      - run: bundle exec rake metrics:flog
+  mutant:
+    <<: *defaults
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rake metrics:mutant
 workflows:
   version: 2
   test:
     jobs:
-      - ruby_2_5
+      - unit_specs
+      - integration_specs
+      - metrics
+      - mutant

data/Changelog.md

@@ -1,3 +1,8 @@
+# v0.4.0 2018-12-01
+
+* Change to modern AST format.
+* Add experimental `Unparser.{parser,parse,parse_with_comments}`
+
 # v0.3.0 2018-11-16
 
 * Drop support for Ruby < 2.5

data/Gemfile

@@ -3,3 +3,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'mutant', git: 'https://github.com/mbj/mutant', branch: 'change/to-modern-ast'

data/Gemfile.lock

@@ -1,7 +1,31 @@
+GIT
+  remote: https://github.com/mbj/mutant
+  revision: 6b36372385ec1bedc0d170470e65d7d33740769e
+  branch: change/to-modern-ast
+  specs:
+    mutant (0.8.20)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      anima (~> 0.3.0)
+      ast (~> 2.2)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.3)
+      equalizer (~> 0.0.9)
+      ice_nine (~> 0.11.1)
+      memoizable (~> 0.4.2)
+      morpher (~> 0.2.6)
+      parser (~> 2.5.1)
+      procto (~> 0.0.2)
+      regexp_parser (~> 1.2)
+      unparser (~> 0.3.0)
+    mutant-rspec (0.8.20)
+      mutant (~> 0.8.20)
+      rspec-core (>= 3.4.0, < 4.0.0)
+
 PATH
   remote: .
   specs:
-    unparser (0.2.9)
+    unparser (0.4.0)
       abstract_type (~> 0.0.7)
       adamantium (~> 0.2.0)
       concord (~> 0.1.5)
@@ -82,25 +106,6 @@ GEM
       equalizer (~> 0.0.9)
       ice_nine (~> 0.11.0)
       procto (~> 0.0.2)
-    mutant (0.8.19)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2.0)
-      anima (~> 0.3.0)
-      ast (~> 2.2)
-      concord (~> 0.1.5)
-      diff-lcs (~> 1.3)
-      equalizer (~> 0.0.9)
-      ice_nine (~> 0.11.1)
-      memoizable (~> 0.4.2)
-      morpher (~> 0.2.6)
-      parallel (~> 1.3)
-      parser (~> 2.5.1)
-      procto (~> 0.0.2)
-      regexp_parser (~> 1.2)
-      unparser (~> 0.2.5)
-    mutant-rspec (0.8.19)
-      mutant (~> 0.8.19)
-      rspec-core (>= 3.4.0, < 4.0.0)
     parallel (1.12.1)
     parser (2.5.3.0)
       ast (~> 2.4.0)
@@ -166,6 +171,7 @@ DEPENDENCIES
   anima (~> 0.3.0)
   devtools (~> 0.1.21)
   morpher (~> 0.2.6)
+  mutant!
   unparser!
 
 BUNDLED WITH

data/README.md

@@ -7,12 +7,12 @@ unparser
 [![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).
-Excluding the macruby extensions the parser gem implemnents on top of ruby syntax.
 
-Excluding the MacRuby / RubyMotion extensions the parser gem implemenents on top of MRI Ruby
-syntax starting with parser release 2.3.  If you feel the need to get them supported, contact me.
+The following constraints apply:
 
-This library is able to reproduce 100% of Ruby 2.1 - 2.3 syntax. Including its own source code.
+* No support for macruby extensions
+* 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.
@@ -20,15 +20,19 @@ and other tooling.
 Public API:
 -----------
 
-While unparser is in the `0.x` versions its public API can change any moment. I recommend to use `~> 0.x.y` style
-version constraints that should give the best mileage.
+While unparser is in the `0.x` versions its public API can change any moment.
+I recommend to use `~> 0.x.y` style version constraints that should give the best mileage.
 
 Usage
 -----
 
 ```ruby
+require 'parser/current'
 require 'unparser'
-Unparser.unparse(your_ast) # => "the code"
+
+ast = Unpaser.parse('your(ruby(code))')
+
+Unparser.unparse(ast) # => 'your(ruby(code))'
 ```
 
 To preserve the comments from the source:
@@ -36,8 +40,10 @@ To preserve the comments from the source:
 ```ruby
 require 'parser/current'
 require 'unparser'
-ast, comments = Parser::CurrentRuby.parse_with_comments(your_source)
-Unparser.unparse(ast, comments) # => "the code # with comments"
+
+ast, comments = Unpaser.parse_with_comments('your(ruby(code)) # with comments')
+
+Unparser.unparse(ast, comments) # => 'your(ruby(code)) # with comments'
 ```
 
 Passing in manually constructed AST:
@@ -71,22 +77,19 @@ Unparser.unparse(node) # => "def foo(x)\n  x + 3\nend"
 Note: DO NOT attempt to pass in nodes generated via `AST::Sexp#s`, these ones return
 API incompatible `AST::Node` instances, unparser needs `Parser::AST::Node` instances.
 
-
 Equivalent vs identical:
 
 ```ruby
 require 'unparser'
 
-code = <<-RUBY
-%w(foo bar)
+node = Unparser.parse(<<~'RUBY')
+  %w[foo bar]
 RUBY
 
-node = Parser::CurrentRuby.parse(code)
-
-generated = Unparser.unparse(node) # ["foo", "bar"], NOT %w(foo bar) !
+generated = Unparser.unparse(node) # ["foo", "bar"], NOT %w[foo bar] !
 
 code == generated                            # false, not identical code
-Parser::CurrentRuby.parse(generated) == node # true, but identical AST
+Unparser.parse(generated) == node # true, but identical AST
 ```
 
 Summary: unparser does not reproduce your source! It produces equivalent source.
@@ -94,7 +97,7 @@ Summary: unparser does not reproduce your source! It produces equivalent source.
 Testing:
 --------
 
-Unparser currently successfully round trips almost all ruby code around. Using MRI-2.0.0.
+Unparser currently successfully round trips almost all ruby code around. Using MRI-2.5.x.
 If there is a non round trippable example that is NOT subjected to known [Limitations](#limitations).
 please report a bug.
 
@@ -106,10 +109,7 @@ Limitations:
 Source parsed with magic encoding headers other than UTF-8 and that have literal strings.
 where parts can be represented in UTF-8 will fail to get reproduced.
 
-Please note: If you are on 1.9.3 or any 1.9 mode ruby and use UTF-8 encoded source via the magic encoding header:
-Unparser does not reproduce these.
-
-A fix might be possible and requires some guessing or parser metadata the raw AST does not carry.
+A fix is possible as with latest updates the parser gem carries the information.
 
 Example:
 

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 13
-total_score: 632
+total_score: 640

data/config/reek.yml

@@ -11,8 +11,7 @@ detectors:
     exclude: []
   ControlParameter:
     enabled: true
-    exclude:
-    - Mutant::Expression#match_length
+    exclude: []
   DataClump:
     enabled: true
     exclude: []
@@ -31,9 +30,7 @@ detectors:
     exclude: []
   LongParameterList:
     enabled: true
-    exclude:
-    - Mutant::Matcher::Method::Instance#self.build
-    - Mutant::Meta::Example::DSL # 3 vars
+    exclude: []
     max_params: 2
   LongYieldList:
     enabled: true
@@ -41,55 +38,30 @@ detectors:
     max_params: 2
   NestedIterators:
     enabled: true
-    exclude:
-    - Mutant#self.singleton_subclass_instance
-    - Mutant::CLI#parse
-    - Mutant::Mutator::Node::Arguments#emit_argument_mutations
-    - Mutant::Mutator::Node::Resbody#mutate_captures
-    - Mutant::Mutator::Util::Array::Element#dispatch
-    - Mutant::Parallel::Master#run
-    - Mutant::RequireHighjack#self.call
-    - Mutant::Selector::Expression#call
-    - Parser::Lexer#self.new
+    exclude: []
     max_allowed_nesting: 1
     ignore_iterators: []
   NilCheck:
     enabled: false
   RepeatedConditional:
     enabled: true
-    exclude:
-    - Mutant::Mutator
-    - Mutant::Meta::Example::DSL
+    exclude: []
     max_ifs: 1
   TooManyInstanceVariables:
     enabled: true
-    exclude:
-    - Mutant::Mutator # 4 vars
-    - Mutant::Parallel::Master # 4 vars
-    - Mutant::Meta::Example::DSL # 4 vars
+    exclude: []
     max_instance_variables: 3
   TooManyMethods:
     enabled: true
-    exclude:
-    - Mutant::CLI
-    - Mutant::Mutator::Node
-    - Mutant::Parallel::Master
+    exclude: []
     max_methods: 10
   TooManyStatements:
     enabled: true
-    exclude:
-    - Mutant::CLI#add_debug_options
-    - Mutant::CLI#add_environment_options
-    - Mutant::Reporter::CLI::Printer::Config#run
-    - Mutant::Reporter::CLI::Printer::EnvProgress#run
-    - Mutant::Runner#run_driver
-    - Mutant::Zombifier::File#self.find
+    exclude: []
     max_statements: 7
   UncommunicativeMethodName:
     enabled: true
-    exclude:
-    - Mutant::AST::Sexp#s
-    - Mutant::Mutation#sha1
+    exclude: []
     reject:
     - '/^[a-z]$/'
     - '/[0-9]$/'
@@ -123,15 +95,4 @@ detectors:
     exclude: []
   UtilityFunction:
     enabled: true
-    exclude:
-    - Mutant::AST::Sexp#s
-    - Mutant::Actor::Env#new_mailbox
-    - Mutant::CLI#reporter
-    - Mutant::Integration::Null#call
-    - Mutant::Integration::Rspec#parse_example
-    - Mutant::Integration::Rspec#parse_expression # intentional, private
-    - Mutant::Meta::Example::Verification#format_mutations # intentional, private
-    - Mutant::Reporter::CLI::Format::Progressive#new_buffer
-    - Mutant::Reporter::CLI::Printer::StatusProgressive#object # False positive calls super
-    - Mutant::Repository::Diff#tracks? # intentional, private
-    - Mutant::Repository::Diff#within_working_directory? # intentional, private
+    exclude: []

data/lib/unparser.rb

@@ -8,10 +8,15 @@ require 'parser/current'
 
 # Library namespace
 module Unparser
+  # Unparser specific AST builder defaulting to modern AST format
+  class Builder < Parser::Builders::Default
+    modernize
+  end
 
   EMPTY_STRING = ''.freeze
+  EMPTY_ARRAY  = [].freeze
 
-  EMPTY_ARRAY = [].freeze
+  private_constant(*constants(false))
 
   # Unparse an AST (and, optionally, comments) into a string
   #
@@ -31,6 +36,60 @@ module Unparser
     buffer.content
   end
 
+  # Parse string into AST
+  #
+  # @param [String] source
+  #
+  # @return [Parser::AST::Node]
+  def self.parse(source)
+    parser.parse(buffer(source))
+  end
+
+  # Parse string into AST, with comments
+  #
+  # @param [String] source
+  #
+  # @return [Parser::AST::Node]
+  def self.parse_with_comments(source)
+    parser.parse_with_comments(buffer(source))
+  end
+
+  # Parser instance that produces AST unparser understands
+  #
+  # @return [Parser::Base]
+  #
+  # @api private
+  #
+  # ignore :reek:NestedIterators
+  def self.parser
+    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
+  #
+  # @return [Parser::Source::Buffer]
+  def self.buffer(source)
+    Parser::Source::Buffer.new('(string)').tap do |buffer|
+      buffer.source = source
+    end
+  end
 end # Unparser
 
 require 'unparser/buffer'
@@ -56,7 +115,6 @@ require 'unparser/emitter/meta'
 require 'unparser/emitter/send'
 require 'unparser/emitter/send/unary'
 require 'unparser/emitter/send/binary'
-require 'unparser/emitter/send/index'
 require 'unparser/emitter/send/regular'
 require 'unparser/emitter/send/conditional'
 require 'unparser/emitter/send/arguments'
@@ -93,5 +151,7 @@ require 'unparser/emitter/flipflop'
 require 'unparser/emitter/rescue'
 require 'unparser/emitter/resbody'
 require 'unparser/emitter/ensure'
+require 'unparser/emitter/index'
+require 'unparser/emitter/lambda'
 # make it easy for zombie
 require 'unparser/finalize'

data/lib/unparser/ast.rb

@@ -16,7 +16,7 @@ module Unparser
     #
     # FIXME: Kwargs are missing.
     #
-    ASSIGN_NODES = %i[lvasgn arg optarg restarg].freeze
+    ASSIGN_NODES = %i[arg lvasgn optarg procarg0 restarg].freeze
 
     # Test for local variable inherited scope reset
     #