xmp2assert 2 → 3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 499b5b5dbee30515d03a50c57cebc85905904a2d
-  data.tar.gz: 90b1f2cfb97885b646aec7568750020ff5f6399d
+  metadata.gz: 37e895dead7be33e2d883950ffc4472e4ed4c49b
+  data.tar.gz: 81805143514b795409f5258853471d67794f698a
 SHA512:
-  metadata.gz: 4fad80ca13043b9d11e1048fb023c3c5327260526ba8d7fa9578b11d2d883799b83a8e0d15208681260998547f14934a5493dc35f330ff700b4c2f9cbfb78df5
-  data.tar.gz: 335f6ec8854569273212213b4635b6aba37ef37b037371ae52dc90892dbf70a09ed822e8b6635da6f7ab3ca4fb7db3b4bbd355011ed9be11fa1850b92a43b18d
+  metadata.gz: 974409606e9bc0812d5d01ba91329b51f2a095ced6fc5cf64b765685a4d978bd260e4279274a0402b7ca6480777df07d095cd883b53bd269d70e2333464e5897
+  data.tar.gz: 32860b61ca5ebf164f81e4209b8c66bc8ea243bd48793d75eb0f8f6fc6ff87b09477cb76810a4f1b15f19efc7827ad78fb639ffbe2db8854464c8bd01f6a1ccf

data/.rubocop.yml

@@ -37,12 +37,18 @@ Lint/EmptyWhen:
 Rails:
   Enabled: false
 
+Style/Alias:
+  Enabled: false
+
 Style/AlignHash:
   Enabled: false
 
 Style/AlignParameters:
   Enabled: false
 
+Style/AndOr:
+  Enabled: false
+
 Style/BracesAroundHashParameters:
   Enabled: false
 
@@ -52,6 +58,9 @@ Style/CaseEquality:
 Style/CaseIndentation:
   Enabled: false
 
+Style/ClassAndModuleCamelCase:
+  Enabled: false
+
 Style/ClassAndModuleChildren:
   Enabled: false
 
@@ -82,6 +91,9 @@ Style/ExtraSpacing:
 Style/FormatString:
   Enabled: false
 
+Style/GuardClause:
+  Enabled: false
+
 Style/IndentHash:
   Enabled: false
 
@@ -94,24 +106,45 @@ Style/IndentationWidth:
 Style/MethodDefParentheses:
   Enabled: false
 
+Style/MethodName:
+  Enabled: false
+
 Style/MultilineIfThen:
   Enabled: false
 
+Style/MultilineMethodCallIndentation:
+  Enabled: false
+
 Style/ParallelAssignment:
   Enabled: false
 
 Style/PercentLiteralDelimiters:
   Enabled: false
 
+Style/PerlBackrefs:
+  Enabled: false
+
 Style/RedundantReturn:
   Enabled: false
 
+Style/RedundantSelf:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/Semicolon:
+  Enabled: false
+
 Style/SpaceAroundOperators:
   Enabled: false
 
 Style/SpaceInsideBrackets:
   Enabled: false
 
+Style/SpecialGlobalVars:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: false
 
@@ -127,40 +160,45 @@ Style/TrailingCommaInLiteral:
 Style/TrailingUnderscoreVariable:
   Enabled: false
 
+Style/VariableInterpolation:
+  Enabled: false
+
 Style/VariableName:
   Enabled: false
 
 Style/WordArray:
   Enabled: false
 
-Lint/UselessAssignment:
-  Exclude:
-    - 'test/**/*'
-    - '*.gemspec'
+Style/WhileUntilDo:
+  Enabled: false
 
-Metrics/AbcSize:
+Style/WhileUntilModifier:
+  Enabled: false
+
+Lint/UselessAccessModifier:
   Exclude:
-    - 'test/**/*'
-    - '*.gemspec'
+    # I think detecting this file is a rubocop bug.
+    - 'lib/xmp2assert/validator.rb'
 
-Metrics/BlockLength:
+Lint/UselessAssignment:
   Exclude:
     - 'test/**/*'
     - '*.gemspec'
 
-Metrics/ClassLength:
+Metrics/AbcSize:
   Exclude:
     - 'test/**/*'
     - '*.gemspec'
 
-Style/ClassAndModuleCamelCase:
+Metrics/ClassLength:
   Exclude:
     - 'test/**/*'
     - '*.gemspec'
 
-Style/Semicolon:
-  Exclude:
-    - 'lib/*/version.rb' # for YARD
+Metrics/BlockLength:
+  ExcludedMethods:
+    - new
+    - sub_test_case
 
 Metrics/LineLength:
   AllowURI: true
@@ -170,3 +208,14 @@ Metrics/MethodLength:
   CountComments: false
   Enabled: true
   Max: 30
+
+Style/EmptyElse:
+  Enabled: true
+  EnforcedStyle: empty
+
+Style/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyle: space
+  SpaceBeforeBlockParameters: false
+  Exclude:
+    - '*.gemspec'

data/exe/xmpcheck.rb

@@ -29,6 +29,7 @@ require 'test/unit/autorunner'
 require 'pathname'
 require 'xmp2assert'
 
+# This class introduces the test auto-run.
 class TC_Main < Test::Unit::TestCase
   include XMP2Assert::Assertions
 
@@ -44,12 +45,8 @@ class TC_Main < Test::Unit::TestCase
     else
       test f.__FILE__ do
         t, o = XMP2Assert::Converter.convert f
-        if k.include? :'=>' then
-          t.eval binding
-        end
-        if k.include? :'>>' then
-          assert_capture2e o, f
-        end
+        t.eval binding        if k.include? :'=>'
+        assert_capture2e o, f if k.include? :'>>'
       end
     end
   end

data/lib/xmp2assert/assertions.rb

@@ -30,6 +30,8 @@ require 'erb'
 require 'test/unit'
 require 'test/unit/assertions'
 require 'test/unit/assertion-failed-error'
+require_relative 'namespace'
+require_relative 'quasifile'
 require_relative 'xmp2rexp'
 
 # Helper module that implements assertions.
@@ -52,7 +54,8 @@ module XMP2Assert::Assertions
   #   As the method name implies the assertion is against both stdin and stderr
   #   at once.  This is for convenience.
   def assert_capture2e expected, script, message = nil, rubyopts: nil, **opts
-    actual, _ = ruby script, rubyopts: rubyopts, **opts
+    qscript = XMP2Assert::Quasifile.new script
+    actual, _ = ruby qscript, rubyopts: rubyopts, **opts
     actual.force_encoding expected.encoding
     return assert_xmp_raw expected, actual, message
   end
@@ -74,20 +77,20 @@ module XMP2Assert::Assertions
 
   # :TODO: is it private?
   def assert_xmp_raw xmp, actual, message = nil
-    msg      = genmsg xmp, actual, message
     expected = xmp2rexp xmp
 
     raise unless expected.match actual
   rescue
     # Regexp#match can raise. That should also be a failure.
-    ix = Test::Unit::Assertions::AssertionMessage.convert xmp
-    ia = Test::Unit::Assertions::AssertionMessage.convert actual
-    ex = Test::Unit::AssertionFailedError.new(msg,
-                  expected: xmp,
-                    actual: actual,
-        inspected_expected: ix,
-          inspected_actual: ia,
-              user_message: message)
+    msg = genmsg xmp, actual, message
+    ix  = Test::Unit::Assertions::AssertionMessage.convert xmp
+    ia  = Test::Unit::Assertions::AssertionMessage.convert actual
+    ex  = Test::Unit::AssertionFailedError.new(msg,
+                    expected: xmp,
+                      actual: actual,
+          inspected_expected: ix,
+            inspected_actual: ia,
+                user_message: message)
     raise ex
   else
     return self # or...?
@@ -102,7 +105,10 @@ module XMP2Assert::Assertions
 
   def genmsg x, y, z = nil
     diff = Test::Unit::Assertions::AssertionMessage.delayed_diff x, y
-    if try(x, :encoding) != try(y, :encoding) then
+    if try(x, :ascii_only?) && try(y, :ascii_only?) then
+      fmt  = "<?> expected but was\n<?>.?"
+      argv = [x, y, diff]
+    elsif try(x, :encoding) != try(y, :encoding) then
       fmt  = "<?>(?) expected but was\n<?>(?).?"
       argv = [x, x.encoding.name, y, y.encoding.name, diff]
     else

data/lib/xmp2assert/classifier.rb

@@ -24,6 +24,8 @@
 # SOFTWARE.
 
 require 'ripper'
+require_relative 'namespace'
+require_relative 'parser'
 
 # Usually, you  want to check  LOTS of  files that may  or may not  contain xmp
 # comments at once, maybe  from inside of a CI process.  That's  OK but we want
@@ -37,35 +39,21 @@ require 'ripper'
 #   XMP2Assert::Classifier.classify(f)
 # end
 # ```
-class XMP2Assert::Classifier < Ripper
-  private_class_method :new
-
-  # @param qfile [Quasifile] file-ish
-  # @return      [<Symbol>]  either empty, :=>, :>>, or both.
-  # @note                    syntax error results in empty return value.
-  def self.classify qfile
-    case qfile when XMP2Assert::Quasifile then
-      this = new qfile.read, qfile.__FILE__, qfile.__LINE__
-      return this.send :parse
-    else
-      q = XMP2Assert::Quasifile.new qfile
-      return classify q
-    end
-  end
-
-  private
-
-  def parse
-    @ret = []
-    super
-    return @ret
-  end
-
-  def on_comment tok
-    case tok
-    when /^# =>/ then @ret |= [:'=>']
-    when /^# >>/ then @ret |= [:'>>']
-    when /^# ~>/ then @ret |= [:'>>']
-    end
+module XMP2Assert::Classifier
+  # @param  (see XMP2Assert::Parser.new)
+  # @return [<Symbol>]  either empty, :=>, :>>, or both.
+  # @note               syntax error results in empty return value.
+  def self.classify obj, file = nil, line = nil
+    parser = XMP2Assert::Parser.new obj, file, line
+  rescue SyntaxError
+    return []
+  else
+    return parser                                              \
+      .tokens                                                  \
+      .map(&:to_sym)                                           \
+      .sort                                                    \
+      .uniq                                                    \
+      .map {|i| case i when :'=>', :'>>' then i else nil end } \
+      .compact
   end
 end

data/lib/xmp2assert/converter.rb

@@ -25,89 +25,219 @@
 
 require 'ripper'
 require 'uuid'
+require_relative 'namespace'
+require_relative 'parser'
+require_relative 'quasifile'
 
-class XMP2Assert::Converter < Ripper
+# This class converts a Ruby script into assertions
+class XMP2Assert::Converter
   private_class_method :new
 
-  def self.convert qfile
-    case qfile when XMP2Assert::Quasifile then
-      this = new qfile.read, qfile.__FILE__, qfile.__LINE__
-      s, o = this.send :convert
-      r = XMP2Assert::Quasifile.new s, qfile.__FILE__, qfile.__LINE__
-      return r, o
-    else
-      q = XMP2Assert::Quasifile.new qfile
-      return convert q
-    end
+  # Detects XMP and make them assertions.  For example:
+  #
+  # ```ruby
+  # def foo; 2; end
+  # 1 + foo # => 3
+  # ```
+  #
+  # would become
+  #
+  # ```ruby
+  # def foo; 2; end
+  # (1 + foo).tap {|i| assert_xmp("3", i ) }
+  # ```
+  #
+  # @param  (see #initialize)
+  # @return [(Quasifile,String)] tuple  of  generated  file  and  its  expected
+  #                              output.
+  def self.convert obj, file = nil, line = nil
+    this = new obj, file, line
+    return this.send :convert
   end
 
   private
 
-  def pos
-    return [filename, lineno, column]
+  # @param (see XMP2Assert::Parser.new)
+  def initialize obj, file = nil, line = nil
+    @program = XMP2Assert::Parser.new obj, file, line
   end
 
   def convert
-    @ret = []
-    @xmps = []
-    @last_seen_xmp = nil
-    @outputs = String.new
-    parse
-    postprocess
-    return @ret.join, @outputs
+    @tokens = @program.tokens
+    outputs = aggregate
+    merge_xmp
+    render
+    ret = XMP2Assert::Quasifile.new @tokens.join, *@program.locations
+    return ret, outputs
   end
 
-  def postprocess
-    @ret.sort!
-    @ret.map! do |(_, xmp, tok)|
-      if xmp
-        n = UUID.create_sha1 tok, Namespace
-        n = n.to_uri
-        n.gsub! %r/[:-]/, '_'
-        sprintf ".tap {|%s| assert_xmp(%s, %s) }\n", n, tok.chomp.dump, n
-      else
-        tok
-      end
-    end
+  def gensym expr
+    n = UUID.create_sha1 expr, Namespace
+    n = n.to_uri
+    n.gsub! %r/[:-]/, '_'
+    return n
   end
 
   Namespace = UUID.create_random
   private_constant :Namespace
 
-  def on_comment tok
-    xmp = false
-    case tok
-    when /^\# [~>]> (.+\n)/ then
-      @outputs << $1
-    when /^\# => (.+\n)/ then
-      if @last_seen_xmp
-        @last_seen_xmp << $1
-        tok = "#\n"
-      else
-        tok = @last_seen_xmp = $1
-        xmp = true
+  def gen_tap xmp
+    n = gensym xmp
+    x = xmp.chomp.dump
+    return sprintf ".tap {|%s| assert_xmp(%s, %s) }", n, x, n
+  end
+
+  def end_of_expr? tok
+    case tok.to_sym
+    when :sp          then return false
+    when :comma       then return false
+    when :semicolon   then return false
+    when :comment     then return false
+    when :'=>'        then return false
+    when :>>          then return false
+    when :nl          then return false
+    when :ignored_nl  then return false
+    when :heredoc_end then return nil # give up. too complicated
+    when :kw          then
+      case tok.to_s
+      when 'then'     then return false
+      when 'end'      then return nil # give up. too complicated
+      else                 return true
       end
+    else                   return true
+    end
+  end
+
+  def find_stop xmp
+    pos = @tokens.index xmp
+    (pos - 1).downto 0 do |i|
+      case end_of_expr? @tokens[i]
+      when TrueClass  then return true, @tokens[i]
+      when FalseClass then next
+      when NilClass   then return nil, @tokens[i + 1]
+      end
+    end
+    # reaching here indicates no stop; fatal.
+    @tokens[pos].raise
+  end
+
+  def valid? line
+    XMP2Assert::Parser.new line.join
+  rescue SyntaxError
+    return false
+  else
+    return true
+  end
+
+  def find_start stop
+    line = @program.same_line_as stop
+    line.sort!
+    line.select! {|i| i.__COLUMN__ <= stop.__COLUMN__ }
+    line = line.drop_while {|i| i.to_sym == :sp }
+    until valid? line do
+      line.shift
+    end
+    return line
+  end
+
+  def need_paren? list
+    start = list.first.to_sym.to_s
+    stop  = list.last .to_sym.to_s
+
+    if %r/(.+)_beg$/ =~ start then
+      return %r/#{$1}_end$/ !~ stop
+    elsif %r/^l(paren|brace|bracket)$/ =~ start then
+      return %r/^r#{$1}$/ !~ stop
+    else
+      return true
+    end
+  end
+
+  # 1. take the line that has xmp.
+  # 2. if that line is syntactically valid, use it.
+  # 3. pop some tokens so that punctuations disappear, e.g. take `1` for
+  #
+  #    ```ruby
+  #    {
+  #      one:
+  #      1, # => 1
+  #    }
+  #    ```
+  #
+  # 4. shift some tokens so that parens etc. disappear, e.g. take `1` for
+  #
+  #    ```ruby
+  #    {
+  #      one: 1, # => 1
+  #    }
+  #    ```
+  #
+  # 5. if  above 3  and  4 resulted  in  deleting all  tokens,  that means  the
+  #    expression started before that line.  Give up and take the whole line to
+  #    expect it peacefully terminates something. e.g. take `}` for
+  #
+  #    ```ruby
+  #    {
+  #      one: 1,
+  #    } # => {:one=>1}
+  #    ```
+  def rev_lookup_expr xmp
+    needs_start, stop = find_stop xmp
+    return nil, stop unless needs_start
+    list = find_start stop
+
+    if list.empty? then
+      return nil, stop
+    elsif need_paren? list then
+      return list.first, stop
     else
-      @last_seen_xmp = nil
+      return nil, stop
     end
-    @ret << [pos, xmp, tok]
   end
 
-  def on_sp tok
-    # no reset @last_seen_xmp
-    @ret << [pos, false, tok]
+  def aggregate
+    return @tokens.each_with_object String.new do |tok, r|
+      next unless tok.to_sym == :>>
+      str = tok.to_s
+      r << str
+      str.replace "\n"
+    end
   end
 
-  def on_scanner_event tok
-    @last_seen_xmp = nil
-    @ret << [pos, false, tok]
+  def merge_xmp
+    xmp = nil
+    @tokens.each do |tok|
+      case tok.to_sym
+      when :sp then next
+      when :'=>' then
+        str = tok.to_s
+        if xmp then
+          xmp << str
+          str.replace "\n"
+          tok.yylex = :nl
+        else
+          xmp = str
+        end
+      else
+        xmp = nil
+      end
+    end
   end
 
-  pim = private_instance_methods false
-  SCANNER_EVENTS.each do |e|
-    m = :"on_#{e}"
-    unless pim.include? m then
-      alias_method m, :on_scanner_event
+  def render
+    @tokens.each do |tok|
+      next unless tok.to_sym == :'=>'
+      xmp = tok.to_s
+      tap = gen_tap xmp
+      xmp.replace "\n"
+      x, y = rev_lookup_expr tok
+      if x and x != y then
+        x.to_s.sub! %r/^/, '('
+        y.to_s.sub! %r/$/, ')'
+      end
+      y.to_s.sub! %r/$/ do
+        tap # use block to prevent backslash substitution
+      end
     end
   end
 end

data/lib/xmp2assert/namespace.rb

@@ -0,0 +1,34 @@
+#! /your/favourite/path/to/ruby
+# -*- mode: ruby; coding: utf-8; indent-tabs-mode: nil; ruby-indent-level 2 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+# Copyright (c) 2017 Urabe, Shyouhei
+#
+# Permission is hereby granted, free of  charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction,  including without limitation the rights
+# to use,  copy, modify,  merge, publish,  distribute, sublicense,  and/or sell
+# copies  of the  Software,  and to  permit  persons to  whom  the Software  is
+# furnished to do so, subject to the following conditions:
+#
+#         The above copyright notice and this permission notice shall be
+#         included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE  IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY  KIND, EXPRESS OR
+# IMPLIED,  INCLUDING BUT  NOT LIMITED  TO THE  WARRANTIES OF  MERCHANTABILITY,
+# FITNESS FOR A  PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO  EVENT SHALL THE
+# AUTHORS  OR COPYRIGHT  HOLDERS  BE LIABLE  FOR ANY  CLAIM,  DAMAGES OR  OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+;
+
+# This is a namespace.  Look at each classes under this module:
+#
+# - {XMP2Assert::Assertions} The assertion framework.
+# - {XMP2Assert::Classifier} Check if the given file actually has the comment.
+# - {XMP2Assert::Converter}  Source code in-place editor using Ripper.
+# - {XMP2Assert::Quasifile}  IO/String abstraction layer
+# - {XMP2Assert::PrettierInspect} Helper module to ease inspection.
+module XMP2Assert; end

data/lib/xmp2assert/parser.rb

@@ -0,0 +1,136 @@
+#! /your/favourite/path/to/ruby
+# -*- mode: ruby; coding: utf-8; indent-tabs-mode: nil; ruby-indent-level 2 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+# Copyright (c) 2017 Urabe, Shyouhei
+#
+# Permission is hereby granted, free of  charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction,  including without limitation the rights
+# to use,  copy, modify,  merge, publish,  distribute, sublicense,  and/or sell
+# copies  of the  Software,  and to  permit  persons to  whom  the Software  is
+# furnished to do so, subject to the following conditions:
+#
+#         The above copyright notice and this permission notice shall be
+#         included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE  IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY  KIND, EXPRESS OR
+# IMPLIED,  INCLUDING BUT  NOT LIMITED  TO THE  WARRANTIES OF  MERCHANTABILITY,
+# FITNESS FOR A  PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO  EVENT SHALL THE
+# AUTHORS  OR COPYRIGHT  HOLDERS  BE LIABLE  FOR ANY  CLAIM,  DAMAGES OR  OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'ripper'
+require_relative 'namespace'
+require_relative 'quasifile'
+require_relative 'token'
+
+# This is a Ruby parser. Generates ASTs from the given program.
+class XMP2Assert::Parser < Ripper
+  attr_reader :tokens # @return [Array<Token>] program, split into tokens.
+  attr_reader :sexp   # @return [Array]        constructed s-expression.
+
+  # @param (see XMP2Assert::Quasifile.new)
+  # @raise [SyntaxError] failed to parse the program.
+  def initialize obj, file = nil, line = nil
+    @qfile = XMP2Assert::Quasifile.new obj, file, line
+    super @qfile.read, *locations
+    @tokens = []
+    @sexp = parse
+    @tokens.sort!
+  end
+
+  # @return [String, Integer] the program's file name and line offset.
+  def locations
+    return @qfile.__FILE__, @qfile.__LINE__
+  end
+
+  # Find tokens that are in the same line as the argument.
+  #
+  # ```ruby
+  # [ 1, # => 1
+  #   2, # => 2
+  # ]    # => [1, 2]
+  # ```
+  #
+  # It will return `[(:sp ' ') (:int 2) (:'=>' "2")]` for `(:'=>' "2")`.
+  #
+  # @param tok [Token] a token to look at.
+  # @return    [Array] tokens of the same line as the argument.
+  def same_line_as tok
+    f, l = tok.__FILE__, tok.__LINE__
+    return @tokens.select {|i| i.__FILE__ == f }.select {|i| i.__LINE__ == l }
+  end
+
+  private
+
+  def on_error msg
+    raise SyntaxError, msg
+  end
+
+  def on_comment c
+    case c
+    when /^# => / then
+      yylex = :'=>'
+      yylval = $'
+    when /^# [~>]> / then
+      yylex = :>>
+      yylval = $'
+    else
+      yylex = :comment
+      yylval = c
+    end
+    yylloc = [filename, lineno, column]
+    tok = XMP2Assert::Token.new yylex, yylval, yylloc
+    @tokens << tok
+    return tok
+  end
+
+  def on_scanner_event yylval
+    yylex = __callee__.to_s.sub(/^on_/, '').intern
+    yylloc = [filename, lineno, column]
+    tok = XMP2Assert::Token.new yylex, yylval, yylloc
+    @tokens << tok
+    return tok
+  end
+
+  def on_parser_event *argv
+    nonterminal = __callee__.to_s.sub(/^on_/, '').intern
+    return [nonterminal, *argv]
+  end
+
+  def on_parser_list_new *argv
+    nonterminal = __callee__.to_s.sub(/^on_(.+)_new$/, '\\1').intern
+    raise [__callee__, argv].inspect unless argv.empty?
+    return [nonterminal]
+  end
+
+  def on_parser_list_append list, cdr
+    return list << cdr
+  end
+
+  pim = private_instance_methods false
+
+  SCANNER_EVENTS.each do |e|
+    m = :"on_#{e}"
+    next if pim.include? m
+    alias_method m, :on_scanner_event
+  end
+
+  PARSER_EVENTS.each do |e|
+    m = :"on_#{e}"
+    next if pim.include? m
+    case m
+    when :on_assoc_new then alias_method m, :on_parser_event
+    when /_new$/       then alias_method m, :on_parser_list_new
+    when /_add$/       then alias_method m, :on_parser_list_append
+    else                    alias_method m, :on_parser_event
+    end
+  end
+
+  alias on_parse_error on_error
+  alias compile_error  on_error
+end

data/lib/xmp2assert/prettier_inspect.rb

@@ -24,6 +24,7 @@
 # SOFTWARE.
 
 require 'pp'
+require_relative 'namespace'
 
 # By  including this  module your  class gets  a {#inspect}  method which  uses
 # {::PP} methods to control outputs.  You  don't have to worry about redefining
@@ -35,7 +36,7 @@ module XMP2Assert::PrettierInspect
   #
   # Prettier inspection.
   def inspect
-    str = PP.pp self, '', Float::INFINITY
+    str = PP.singleline_pp self, ''
     str.chomp!
     return str
   end

data/lib/xmp2assert/quasifile.rb

@@ -25,14 +25,14 @@
 
 require 'open-uri'
 require 'pathname'
+require_relative 'namespace'
+require_relative 'prettier_inspect'
 
 # XMP2Assert  converts a  ruby script  into a  test file  but we  want to  hold
 # original path name / line number for diagnostic purposes.  So this class.
 class XMP2Assert::Quasifile
   include XMP2Assert::PrettierInspect
 
-  # @return [Quasifile] a new quasifile.
-  #
   # @overload new(qfile)
   #   Just return the given object (for possible recursive calls).
   #
@@ -84,6 +84,10 @@ class XMP2Assert::Quasifile
   #   @param  line  [Integer]   line offset.
   #   @return       [Quasifile] generated qiasifile.
   #
+  # @return [Quasifile] a new quasifile.
+  # @param obj  [Quasifile, URI, Pathname, String, File, IO] a file-ish.
+  # @param file [String] path of the file (optional).
+  # @param line [Integer] line offset (optional).
   def self.new(obj, file = nil, line = nil)
     case
     when src  = switch { obj.to_str  } then # LIKELY

data/lib/xmp2assert/token.rb

@@ -0,0 +1,88 @@
+#! /your/favourite/path/to/ruby
+# -*- mode: ruby; coding: utf-8; indent-tabs-mode: nil; ruby-indent-level 2 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+# Copyright (c) 2017 Urabe, Shyouhei
+#
+# Permission is hereby granted, free of  charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction,  including without limitation the rights
+# to use,  copy, modify,  merge, publish,  distribute, sublicense,  and/or sell
+# copies  of the  Software,  and to  permit  persons to  whom  the Software  is
+# furnished to do so, subject to the following conditions:
+#
+#         The above copyright notice and this permission notice shall be
+#         included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE  IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY  KIND, EXPRESS OR
+# IMPLIED,  INCLUDING BUT  NOT LIMITED  TO THE  WARRANTIES OF  MERCHANTABILITY,
+# FITNESS FOR A  PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO  EVENT SHALL THE
+# AUTHORS  OR COPYRIGHT  HOLDERS  BE LIABLE  FOR ANY  CLAIM,  DAMAGES OR  OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require_relative 'namespace'
+require_relative 'prettier_inspect'
+
+# Token is a tiny class that represents a token of a Ruby program.
+#
+# @!attribute [rw]     yylex
+#     @return [Symbol] terminal symbol
+# @!attribute [rw]     yylval
+#     @return [String] terminal value
+# @!attribute [rw]     yylloc
+#     @return [Array]  terminal location
+XMP2Assert::Token = Struct.new :yylex, :yylval, :yylloc do
+  include Comparable
+
+  # Comparison of location in a file, to be used with sort.
+  # @param other [Token] token to compare
+  def <=> other
+    yylloc <=> other.yylloc
+  end
+
+  alias to_sym yylex
+  alias to_s yylval
+
+  # @!group Token locations
+
+  # @return [String] file name
+  def __FILE__
+    return yylloc[0]
+  end
+
+  # @return [String] line number (1 origin)
+  def __LINE__
+    return yylloc[1]
+  end
+
+  # @return [String] column in a line
+  def __COLUMN__
+    return yylloc[2]
+  end
+  # @!endgroup
+
+  # Considet this token being an error.
+  # @param klass [Exception] exception to raise
+  # @param msg   [String]    diagnostic message
+  def raise klass = SyntaxError, msg = ""
+    l = sprintf "%s:%s", self.__FILE__, self.__LINE__
+    m = sprintf 'syntax error near "%s" at line %d:%d %s',
+          to_s, self.__LINE__, self.__COLUMN__, msg
+    super klass, m, [l, *caller]
+  end
+
+  unless $DEBUG
+    include ::XMP2Assert::PrettierInspect
+
+    def pretty_print pp
+      pp.text "("
+      yylex.pretty_print pp
+      pp.breakable " "
+      yylval.pretty_print pp
+      pp.text ")"
+    end
+  end
+end

data/lib/xmp2assert/version.rb

@@ -24,4 +24,4 @@
 # SOFTWARE.
 ;
 
-XMP2Assert::VERSION = 2
+XMP2Assert::VERSION = 3

data/lib/xmp2assert/xmp2rexp.rb

@@ -23,6 +23,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require_relative 'namespace'
+
 # An XMP comment normally looks like this:
 #
 # ```ruby

data/lib/xmp2assert.rb

@@ -23,19 +23,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-# This is a namespace.  Look at each classes under this module:
-#
-# - XMP2Assert::Assertions    the assertion framework.
-# - XMP2Assert::Classifier    check if the given file actually has the comment.
-# - XMP2Assert::Converter     source code in-place editor using Ripper.
-# - XMP2Assert::Quasifile     IO/String abstraction layer
-# - XMP2Assert::PrttierInpect helper module to ease inspection.
-module XMP2Assert
-  # These files assume the namespace, hence required here inside.
-  require_relative 'xmp2assert/version'
-  require_relative 'xmp2assert/prettier_inspect'
-  require_relative 'xmp2assert/quasifile'
-  require_relative 'xmp2assert/converter'
-  require_relative 'xmp2assert/classifier'
-  require_relative 'xmp2assert/assertions'
-end
+require_relative 'xmp2assert/namespace' # needs be first
+require_relative 'xmp2assert/version'
+require_relative 'xmp2assert/prettier_inspect'
+require_relative 'xmp2assert/quasifile'
+require_relative 'xmp2assert/converter'
+require_relative 'xmp2assert/classifier'
+require_relative 'xmp2assert/assertions'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xmp2assert
 version: !ruby/object:Gem::Version
-  version: '2'
+  version: '3'
 platform: ruby
 authors:
 - Urabe, Shyouhei
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-04 00:00:00.000000000 Z
+date: 2017-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -210,15 +210,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- Stylegiude.md
+- Styleguide.md
 - exe/xmpcheck.rb
 - lib/xmp2assert.rb
 - lib/xmp2assert/assertions.rb
 - lib/xmp2assert/classifier.rb
 - lib/xmp2assert/converter.rb
+- lib/xmp2assert/namespace.rb
+- lib/xmp2assert/parser.rb
 - lib/xmp2assert/prettier_inspect.rb
 - lib/xmp2assert/quasifile.rb
 - lib/xmp2assert/template.erb
+- lib/xmp2assert/token.rb
 - lib/xmp2assert/version.rb
 - lib/xmp2assert/xmp2rexp.rb
 - xmp2assert.gemspec
@@ -242,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: auto-generate assertions from `# =>` comments