sorcerer 0.3.7 → 0.3.9

data/{README.textile → README.md}

@@ -1,135 +1,156 @@
-h1. Sorcerer -- Recovering the Source
+# Sorcerer -- Recovering the Source
 
-p. Sorcerer will generate Ruby code from a Ripper-like abstract syntax
+| Master |
+| :----: |
+| [![Master Build Status](https://secure.travis-ci.org/jimweirich/sorcerer.png?branch=master)](https://secure.travis-ci.org/jimweirich/sorcerer) |
+
+Sorcerer will generate Ruby code from a Ripper-like abstract syntax
 tree (i.e. S-Expressions).
 
-p. Sorcerer is targetted mainly at small snippets of Ruby code,
-expressable in a single line.  Longer examples may be re-sourced, but
+Sorcerer is targetted mainly at small snippets of Ruby code,
+expressable in a single line. Longer examples may be re-sourced, but
 they will be rendered in a single line format.
 
-*Version: 0.3.1*
-
-h2. Limitations
+**Version: 0.3.7**
 
-Sorcerer is only testing on Ruby 1.9.
+## Limitations
 
-bq. <em>Technically, Sorcerer should work on Ruby 1.8, but since Ripper is
-1.9 I've only tried it on that platform.</em>
+Sorcerer is only tested on Ruby 1.9.
 
-h2. Links
+## Links
 
-Documents              :: http://github.com/jimweirich/sorcerer
-Git Clone              :: git://github.com/jimweirich/sorcerer.git
-Issues / Bug Tracking  :: https://github.com/jimweirich/sorcerer/issues
-Continuous Integration :: http://travis-ci.org/#!/jimweirich/sorcerer
+| Description            | Link |
+| :---:                  | :---: |
+| Documents              | http://github.com/jimweirich/sorcerer |
+| Git Clone              | git://github.com/jimweirich/sorcerer.git |
+| Issues / Bug Tracking  | https://github.com/jimweirich/sorcerer/issues |
+| Continuous Integration | http://travis-ci.org/#!/jimweirich/sorcerer |
 
-h2. Examples
+## Examples
 
-<pre style="background: LightGray">
+```ruby
   sexp = [:binary,
            [:var_ref, [:@ident, "a", [1, 0]]],
            :+,
            [:var_ref, [:@ident, "b", [1, 4]]]]
   puts Sorcerer.source(sexp)
-</pre>
+```
 
 will generate
 
-<pre style="background: LightGray">
+```ruby
   a + b
-</pre>
+```
 
-Ripper may be used to produce the s-expressions used by Sorcerer.  The following will produce the same output.
+Ripper may be used to produce the s-expressions used by Sorcerer. The
+following will produce the same output.
 
-<pre style="background: LightGrey">
+```ruby
   sexp = Ripper::SexpBuilder.new("a + b").parse
   puts Sorcerer.source(sexp)
-</pre>
+```
 
-h2. Options
+## Options
 
-h3. No Options
+### No Options
 
 By default, sorcerer will output its source in single line mode.
 
 For example, given:
 
-<pre style="background: LightGrey">
+```ruby
   sexp = Ripper::SexpBuilder.new("def foo; bar; end").parse
-</pre>
+```
 
 Then the following
 
-<pre style="background: LightGrey">
+```ruby
   puts Sorcerer.source(sexp)
-</pre>
+```
 
 generates single line output (the default):
 
-<pre style="background: LightBlue">
+```ruby
 def foo; bar; end
-</pre>
+```
 
-h3. Multi-Line Output
+### Multi-Line Output
 
 If you want multi-line output of source, add the multiline option to
 the source command.
 
 For example, given the sexp generated above, then this
 
-<pre style="background: LightGrey">
+```ruby
   puts Sorcerer.source(sexp, multiline: true)
-</pre>
+```
 
 generates multi-line output
 
-<pre style="background: LightBlue">
+```ruby
 def foo
 bar
 end
-</pre>
+```
 
 (Note that all multi-line output will have a final newline.)
 
-h3. Indentation
+### Indentation
 
 By default, sorcerer does not indent its multiline output.  Adding the
 "indent" option will cause the output to be indented.
 
 For example, given the sexp generated above, then the following
 
-<pre style="background: LightGrey">
+```ruby
   puts Sorcerer.source(sexp, indent: true)
-</pre>
+```
 
 generates indented output:
 
-<pre style="background: LightBlue">
+```ruby
 def foo
   bar
 end
-</pre>
+```
 
-h3. Debugging Output
+### Debugging Output
 
 If you wish to see the S-Expressions processed by Sorcerer and the
 output emitted, then use the debug option:
 
-<pre style="background: LightGrey">
+```ruby
   puts Sorcerer.source(sexp, debug: true)
-</pre>
+```
 
-h2. History
+## History
 
-* 0.0.7 - Basic single line version
+* 0.3.9 - Support %i{} and %I{}.
 
-* 0.1.0 - Added support for multi-line output. Improved rendering of a
-          number of constructs
+* 0.3.8 - Include constants in sub-expressions.
 
-* 0.2.0 - Added support for indented output.
+* 0.3.7 - Include array in sub-expressions.
 
-* 0.3.0 - New hash literal support. Multi-line output always end with
-          a newline.
+* 0.3.6 - Support 'defined?'. Suppress nil, true, false in
+          sub-expressions.
+
+* 0.3.5 - Add handler for mrhs_new.
+
+* 0.3.4 - Support 'meth a, b'.
+
+* 0.3.3 - Fix unary not.
+
+* 0.3.2 - Support 'def mod.method' syntax.
 
 * 0.3.1 - 1.9.3 support. Indenting stabby procs. RedCloth not required
           for testing.
+
+* 0.3.0 - New hash literal support. Multi-line output always end with
+          a newline.
+
+* 0.2.0 - Added support for indented output.
+
+* 0.1.0 - Added support for multi-line output. Improved rendering of a
+          number of constructs
+
+* 0.0.7 - Basic single line version

data/Rakefile

@@ -20,7 +20,7 @@ RUBY = ENV['RUBY19'] || 'ruby19'
 PKG_VERSION = Sorcerer::VERSION
 
 PKG_FILES = FileList[
-  'README.textile',
+  'README.md',
   'Rakefile',
   'doc/*',
   'rakelib/*',
@@ -30,7 +30,6 @@ PKG_FILES = FileList[
 
 BASE_RDOC_OPTIONS = [
   '--line-numbers', '--inline-source',
-  '--main' , 'README.textile',
   '--title', 'Rake -- Ruby Make'
 ]
 

data/lib/sorcerer/resource.rb

@@ -154,7 +154,7 @@ module Sorcerer
       false
     end
 
-    def params(normal_args, default_args, rest_args, unknown, block_arg)
+    def params(normal_args, default_args, rest_arg, unknown, keyw_args, opts_arg, block_arg)
       first = true
       if normal_args
         normal_args.each do |sx|
@@ -170,9 +170,22 @@ module Sorcerer
           resource(sx[1])
         end
       end
-      if rest_args
+      if rest_arg
         first = emit_separator(", ", first)
-        resource(rest_args)
+        resource(rest_arg)
+      end
+      if keyw_args
+        keyw_args.each do |sx|
+          first = emit_separator(", ", first)
+          resource(sx[0])
+          emit(" ")
+          resource(sx[1])
+        end
+      end
+      if opts_arg
+        first = emit_separator(", ", first)
+        emit("**")
+        emit(opts_arg[1])
       end
       if block_arg
         first = emit_separator(", ", first)
@@ -180,10 +193,22 @@ module Sorcerer
       end
     end
 
+    def quoted_word_add?(sexp)
+      sexp &&
+        sexp[1] &&
+        [:words_add, :qwords_add, :qsymbols_add, :symbols_add].include?(sexp[1].first)
+    end
+
+    def quoted_word_new?(sexp)
+      sexp &&
+        sexp[1] &&
+        [:qwords_new, :words_new, :qsymbols_new, :symbols_new].include?(sexp[1].first)
+    end
+
     def words(marker, sexp)
       emit("%#{marker}{") if @word_level == 0
       @word_level += 1
-      if sexp[1] != [:qwords_new] && sexp[1] != [:words_new]
+      if !quoted_word_new?(sexp)
         resource(sexp[1])
         emit(" ")
       end
@@ -350,8 +375,7 @@ module Sorcerer
       :args_prepend => NYI,
       :array => lambda { |sexp|
         if !MISSES_ARRAY_NODE_FOR_WORDS &&
-             sexp[1] &&
-             [:words_add, :qwords_add].include?(sexp[1].first)
+            quoted_word_add?(sexp)
           resource(sexp[1])
         else
           emit("[")
@@ -683,7 +707,11 @@ module Sorcerer
       },
       :param_error => NYI,
       :params => lambda { |sexp|
-        params(sexp[1], sexp[2], sexp[3], sexp[4], sexp[5])
+        if sexp.size == 8
+          params(sexp[1], sexp[2], sexp[3], sexp[4], sexp[5], sexp[6], sexp[7])
+        else
+          params(sexp[1], sexp[2], sexp[3], sexp[4],nil, nil, sexp[5])
+        end
       },
       :paren => lambda { |sexp|
         emit("(")
@@ -692,6 +720,10 @@ module Sorcerer
       },
       :parse_error => NYI,
       :program => PASS1,
+      :qsymbols_add => lambda { |sexp|
+        words("i", sexp)
+      },
+      :qsymbols_new => NOOP,
       :qwords_add => lambda { |sexp|
         words("w", sexp)
       },
@@ -789,6 +821,10 @@ module Sorcerer
         resource(sexp[1])
       },
       :symbol_literal => PASS1,
+      :symbols_add => lambda { |sexp|
+        words("I", sexp)
+      },
+      :symbols_new => NOOP,
       :top_const_field => NYI,
       :top_const_ref => NYI,
       :unary => lambda { |sexp|

data/lib/sorcerer/subexpression.rb

@@ -46,8 +46,13 @@ module Sorcerer
       when :call, :method_add_block, :method_add_arg
         @result << sexp
         method_sexp(sexp)
+      when :const_path_ref
+        @result << sexp
+        recur(sexp[1])
       when :@kw
         # ignore
+      when :@const
+        @result << sexp
       when :zsuper, :super
         @result << sexp
         list_sexp(sexp)

data/lib/sorcerer/version.rb

@@ -2,7 +2,7 @@ module Sorcerer
   VERSION_NUMBERS = [
     VERSION_MAJOR = 0,
     VERSION_MINOR = 3,
-    VERSION_BUILD = 7,
+    VERSION_BUILD = 9,
   ]
 
   VERSION = VERSION_NUMBERS.join('.')

data/rakelib/testing.rake

@@ -4,6 +4,6 @@
 Rake::TestTask.new(:test) do |t|
   t.warning = true
   t.verbose = false
+  t.libs << "test"
   t.test_files = FileList["test/**/*_test.rb"]
 end
-

data/test/assert_resource_helper.rb

@@ -0,0 +1,76 @@
+module AssertResource
+
+  # Assert that a string can be parsed and then resourced without changes.
+  def assert_resource(string, options={})
+    assert_equal string, source(string, options)
+  end
+
+  # Assert that a string can be resourced properly in all the various
+  # output modes:
+  #
+  # * single line
+  # * multi-line
+  # * indentation
+  #
+  # Special markup is supported in the string to indicate different
+  # expected output.  The string is expressed in single line mode with
+  # the following interpretation:
+  #
+  # * "; " is expected to be literal in single line mode and a newline
+  # in multi-line and indented modes.
+  #
+  # * "~" is expected to be a space in single line mode and a newline
+  # in multi-line and indented modes.
+  #
+  # * "#" is expected to be a tabbed indent in indent mode and a null
+  # string in single line and multi-line modes.
+  #
+  def assert_resource_lines(string, options={})
+    assert_resource_for_mode(
+      string,
+      options.merge(multiline: false)) { |s|
+      for_single_line(s)
+    }
+    assert_resource_for_mode(
+      string,
+      options.merge(multiline: true)) { |s|
+      for_multi_line(s)
+    }
+    assert_resource_for_mode(
+      string,
+      options.merge(indent: true)) { |s|
+      for_indented(s)
+    }
+  end
+
+  # Assert the string is correctly resourced given the options and the
+  # block conversion.
+  def assert_resource_for_mode(string, options={})
+    expectation = yield(string)
+    assert_equal expectation, source(expectation, options)
+  end
+
+  def for_single_line(string)
+    string.
+      gsub(/\bTHEN~/, "then ").
+      gsub(/~/, " ").
+      gsub(/#/,'')
+  end
+
+  def for_multi_line(string)
+    string.
+      gsub(/\b THEN~/, "; ").
+      gsub(/~/, "\n").
+      gsub(/; /, "\n").
+      gsub(/#/,'') + "\n"
+  end
+
+  def for_indented(string)
+    string.
+      gsub(/\b THEN~/, "; ").
+      gsub(/~/, "\n").
+      gsub(/; /, "\n").
+      gsub(/#/,'  ') + "\n"
+  end
+
+end

data/test/sorcerer/resource_test.rb

@@ -3,82 +3,12 @@
 require 'test/unit'
 require 'ripper'
 require 'sorcerer'
+require 'assert_resource_helper'
 
-class SourcerTest < Test::Unit::TestCase
-  private
-
-  # Assert that a string can be parsed and then resourced without changes.
-  def assert_resource(string, options={})
-    assert_equal string, source(string, options)
-  end
-
-  # Assert that a string can be resourced properly in all the various
-  # output modes:
-  #
-  # * single line
-  # * multi-line
-  # * indentation
-  #
-  # Special markup is supported in the string to indicate different
-  # expected output.  The string is expressed in single line mode with
-  # the following interpretation:
-  #
-  # * "; " is expected to be literal in single line mode and a newline
-  # in multi-line and indented modes.
-  #
-  # * "~" is expected to be a space in single line mode and a newline
-  # in multi-line and indented modes.
-  #
-  # * "#" is expected to be a tabbed indent in indent mode and a null
-  # string in single line and multi-line modes.
-  #
-  def assert_resource_lines(string, options={})
-    assert_resource_for_mode(
-      string,
-      options.merge(multiline: false)) { |s|
-      for_single_line(s)
-    }
-    assert_resource_for_mode(
-      string,
-      options.merge(multiline: true)) { |s|
-      for_multi_line(s)
-    }
-    assert_resource_for_mode(
-      string,
-      options.merge(indent: true)) { |s|
-      for_indented(s)
-    }
-  end
-
-  # Assert the string is correctly resourced given the options and the
-  # block conversion.
-  def assert_resource_for_mode(string, options={})
-    expectation = yield(string)
-    assert_equal expectation, source(expectation, options)
-  end
-
-  def for_single_line(string)
-    string.
-      gsub(/\bTHEN~/, "then ").
-      gsub(/~/, " ").
-      gsub(/#/,'')
-  end
+class ResourceTest < Test::Unit::TestCase
+  include AssertResource
 
-  def for_multi_line(string)
-    string.
-      gsub(/\b THEN~/, "; ").
-      gsub(/~/, "\n").
-      gsub(/; /, "\n").
-      gsub(/#/,'') + "\n"
-  end
-
-  def for_indented(string)
-    string.
-      gsub(/\b THEN~/, "; ").
-      gsub(/~/, "\n").
-      gsub(/; /, "\n").
-      gsub(/#/,'  ') + "\n"
-  end
+  private
 
   def quietly
     original_verbosity = $VERBOSE
@@ -353,6 +283,13 @@ class SourcerTest < Test::Unit::TestCase
     assert_resource "/a/i"
   end
 
+  def test_can_source_symbol_quotes
+    if RUBY_VERSION >= "2.0"
+      assert_resource "%i{a b}"
+      assert_resource "%I{a b}"
+    end
+  end
+
   def test_can_source_range
     assert_resource "1..10"
     assert_resource "1...10"
@@ -636,12 +573,20 @@ class SourcerTest < Test::Unit::TestCase
     assert_resource_lines "def f(); end"
     assert_resource_lines "def f(a); end"
     assert_resource_lines "def f(a, b); end"
+    assert_resource_lines "def f(a, b=1); end"
     assert_resource_lines "def f(a, *args); end"
     assert_resource_lines "def f(a, *args, &block); end"
     assert_resource_lines "def f(a); #x; end"
     assert_resource_lines "def f(a); #x; #y; end"
   end
 
+  if RUBY_VERSION >= "2.0.0"
+    def test_can_source_ruby2_defs
+      assert_resource_lines "def f(a, b=1, *args, c: 2, **opts, &block); end"
+      assert_resource_lines "def f(a, aa, b=1, bb=2, *args, c: 3, cc: 4, **opts, &block); end"
+    end
+  end
+
   def test_can_source_def_self
     assert_resource_lines "def self.f; end"
     assert_resource_lines "def self.f(a, *args, &block); #x; #y; end"

data/test/sorcerer/subexpression_test.rb

@@ -4,7 +4,7 @@ require 'ripper'
 require 'pp'
 
 class SubexpressionTest < Test::Unit::TestCase
-  def assert_subexpressions code, subexpressions, debug=false
+  def assert_subexpressions(code, subexpressions, debug=false)
     sexp = Ripper::SexpBuilder.new(code).parse
     if debug
       pp sexp
@@ -140,4 +140,17 @@ class SubexpressionTest < Test::Unit::TestCase
     ]
   end
 
+  def test_constants_are_included
+    assert_subexpressions "a || A", [
+      "a || A",
+      "a",
+      "A",
+    ]
+    assert_subexpressions "A::B::C", [
+      "A::B::C",
+      "A::B",
+      "A",
+    ]
+  end
+
 end

metadata

@@ -1,63 +1,80 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: sorcerer
-version: !ruby/object:Gem::Version
-  version: 0.3.7
+version: !ruby/object:Gem::Version 
+  hash: 1
   prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 9
+  version: 0.3.9
 platform: ruby
-authors:
+authors: 
 - Jim Weirich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-27 00:00:00.000000000 Z
+
+date: 2013-02-04 00:00:00 Z
 dependencies: []
-description: Generate the original Ruby source from a Ripper-style abstract syntax
-  tree.
+
+description: Generate the original Ruby source from a Ripper-style abstract syntax tree.
 email: jim.weirich@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
-- README.textile
+
+files: 
+- README.md
 - Rakefile
 - doc/jamis.rb
 - rakelib/git.rake
 - rakelib/readme.rake
 - rakelib/testing.rake
-- lib/sorcerer.rb
 - lib/sorcerer/resource.rb
 - lib/sorcerer/subexpression.rb
 - lib/sorcerer/version.rb
+- lib/sorcerer.rb
+- test/assert_resource_helper.rb
 - test/sorcerer/resource_test.rb
 - test/sorcerer/subexpression_test.rb
 homepage: http://github.com/jimweirich/sorcerer
 licenses: []
+
 post_install_message: 
-rdoc_options:
+rdoc_options: 
 - --line-numbers
 - --inline-source
-- --main
-- README.textile
 - --title
 - Rake -- Ruby Make
-require_paths:
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: sorcerer
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Generate Source from Ripper ASTs
 test_files: []
+