sorcerer 0.3.9 → 0.3.10

data/README.md

@@ -11,7 +11,7 @@ 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.7**
+**Version: 0.3.10**
 
 ## Limitations
 

data/lib/sorcerer.rb

@@ -11,6 +11,6 @@ module Sorcerer
 end
 
 require 'sorcerer/resource'
+require 'sorcerer/signature'
 require 'sorcerer/subexpression'
 require 'sorcerer/version'
-

data/lib/sorcerer/resource.rb

@@ -116,7 +116,8 @@ module Sorcerer
     def params_are_empty?(sexp)
       params = sexp
       params = sexp[1] if sexp.first == :paren || sexp.first == :arg_paren
-      params[1].nil? || params[1].empty?
+      sig = Signature.new(params)
+      sig.empty?
     end
 
     def opt_parens(sexp)
@@ -154,42 +155,42 @@ module Sorcerer
       false
     end
 
-    def params(normal_args, default_args, rest_arg, unknown, keyw_args, opts_arg, block_arg)
+    def params(sig)
       first = true
-      if normal_args
-        normal_args.each do |sx|
+      if sig.normal_args
+        sig.normal_args.each do |sx|
           first = emit_separator(", ", first)
           resource(sx)
         end
       end
-      if default_args
-        default_args.each do |sx|
+      if sig.default_args
+        sig.default_args.each do |sx|
           first = emit_separator(", ", first)
           resource(sx[0])
           emit("=")
           resource(sx[1])
         end
       end
-      if rest_arg
+      if sig.rest_arg
         first = emit_separator(", ", first)
-        resource(rest_arg)
+        resource(sig.rest_arg)
       end
-      if keyw_args
-        keyw_args.each do |sx|
+      if sig.keyword_args
+        sig.keyword_args.each do |sx|
           first = emit_separator(", ", first)
           resource(sx[0])
           emit(" ")
           resource(sx[1])
         end
       end
-      if opts_arg
+      if sig.opts_arg
         first = emit_separator(", ", first)
         emit("**")
-        emit(opts_arg[1])
+        emit(sig.opts_arg[1])
       end
-      if block_arg
+      if sig.block_arg
         first = emit_separator(", ", first)
-        resource(block_arg)
+        resource(sig.block_arg)
       end
     end
 
@@ -707,11 +708,7 @@ module Sorcerer
       },
       :param_error => NYI,
       :params => lambda { |sexp|
-        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
+        params(Signature.new(sexp))
       },
       :paren => lambda { |sexp|
         emit("(")

data/lib/sorcerer/signature.rb

@@ -0,0 +1,38 @@
+module Sorcerer
+  class Signature
+
+    attr_reader :normal_args, :default_args, :rest_arg, :keyword_args, :opts_arg, :block_arg
+
+    def initialize(sexp)
+      @normal_args = sexp[1]
+      @default_args = sexp[2]
+      @rest_arg = sexp[3]
+      if ruby2_style_param_list?(sexp)
+        @keyword_args = sexp[5]
+        @opts_arg = sexp[6]
+        @block_arg = sexp[7]
+      else
+        @block_arg = sexp[5]
+      end
+    end
+
+    def empty?
+      missing?(normal_args) &&
+        missing?(default_args) &&
+        missing?(rest_arg) &&
+        missing?(keyword_args) &&
+        missing?(opts_arg) &&
+        missing?(block_arg)
+    end
+
+    private
+
+    def missing?(args)
+      args.nil? || args.empty?
+    end
+
+    def ruby2_style_param_list?(sexp)
+      sexp.size == 8
+    end
+  end
+end

data/lib/sorcerer/version.rb

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

data/rakelib/readme.rake

@@ -1,44 +1,26 @@
 #!/usr/bin/env ruby
 
-begin
-  require 'redcloth'
-  directory "html"
+directory "html"
 
-  desc "Display the README file"
-  task :readme => "html/README.html" do
-    sh "open html/README.html"
-  end
-
-  desc "format the README file"
-  task "html/README.html" => ['html', 'README.textile', "readme:update"] do
-    open("README.textile") do |source|
-      open('html/README.html', 'w') do |out|
-        out.write(RedCloth.new(source.read).to_html)
-      end
-    end
-  end
+desc "Display the README file"
+task :readme => "README.md" do
+  sh "ghpreview README.md"
+end
 
-  namespace "readme" do
-    desc "Update the version in the readme"
-    task :update do
-      open("README.textile") do |ins|
-        open("new_readme.txt", "w") do |outs|
-          while line = ins.gets
-            if line =~ /^\*Version: .*\*$/
-              line = "*Version: #{PKG_VERSION}*"
-            end
-            outs.puts line
+namespace "readme" do
+  desc "Update the version in the readme"
+  file "README.md" => ["lib/sorcerer/version.rb"] do
+    open("README.md") do |ins|
+      open("new_readme.txt", "w") do |outs|
+        while line = ins.gets
+          if line =~ /^\*\*Version: .*\*\*$/
+            line = "**Version: #{PKG_VERSION}**"
           end
+          outs.puts line
         end
       end
-      mv "README.textile", "README.bak"
-      mv "new_readme.txt", "README.textile"
     end
-  end
-
-rescue LoadError => ex
-  task :readme do
-    fail "Install RedCloth to generate the README"
+    mv "README.md", "README.bak"
+    mv "new_readme.txt", "README.md"
   end
 end
-

data/test/sorcerer/resource_test.rb

@@ -567,9 +567,6 @@ class ResourceTest < Test::Unit::TestCase
   end
 
   def test_can_source_def
-    assert_resource_lines "def f; end"
-    assert_resource_lines "def f; #x; end"
-    assert_resource_lines "def f a; end"
     assert_resource_lines "def f(); end"
     assert_resource_lines "def f(a); end"
     assert_resource_lines "def f(a, b); end"
@@ -580,10 +577,29 @@ class ResourceTest < Test::Unit::TestCase
     assert_resource_lines "def f(a); #x; #y; end"
   end
 
+  def test_can_source_def_without_parens
+    assert_resource_lines "def f; end"
+    assert_resource_lines "def f; #x; end"
+    assert_resource_lines "def f a; end"
+    assert_resource_lines "def f b=1; end"
+    assert_resource_lines "def f *args; end"
+    assert_resource_lines "def f &block; 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"
+      assert_resource_lines "def f(c: 3); end"
+      assert_resource_lines "def f(**opts); end"
+    end
+  end
+
+  if RUBY_VERSION >= "2.0.0"
+    def test_can_source_ruby2_defs_without_parens
+      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"
+      assert_resource_lines "def f **opts; end"
     end
   end
 

data/test/sorcerer/signature_test.rb

@@ -0,0 +1,102 @@
+require 'test/unit'
+
+require 'sorcerer'
+require 'ripper'
+
+class SignatureTest < Test::Unit::TestCase
+
+  def test_populate_fields_with_nil
+    sig = signature_for("def foo; end")
+
+    assert_nil sig.normal_args
+    assert_nil sig.default_args
+    assert_nil sig.rest_arg
+    assert_nil sig.keyword_args
+    assert_nil sig.opts_arg
+    assert_nil sig.block_arg
+  end
+
+  def test_populate_fields_with_real_args
+    sig = signature_for("def foo(a, b=1, *args, &block); end")
+
+    assert_equal [[:@ident, "a", [1, 8]]], sig.normal_args
+    assert_equal [[[:@ident, "b", [1, 11]], [:@int, "1", [1, 13]]]], sig.default_args
+    assert_equal [:rest_param, [:@ident, "args", [1, 17]]], sig.rest_arg
+    assert_nil sig.keyword_args
+    assert_nil sig.opts_arg
+    assert_equal [:blockarg, [:@ident, "block", [1, 24]]], sig.block_arg
+  end
+
+  if RUBY_VERSION >= "2.0"
+    def test_populate_fields_with_real_args_in_ruby2
+      sig = signature_for("def foo(a, b=1, *args, c: 2, **opts, &block); end")
+
+      assert_equal [[:@ident, "a", [1, 8]]], sig.normal_args
+      assert_equal [[[:@ident, "b", [1, 11]], [:@int, "1", [1, 13]]]], sig.default_args
+      assert_equal [:rest_param, [:@ident, "args", [1, 17]]], sig.rest_arg
+      assert_equal [[[:@label, "c:", [1, 23]], [:@int, "2", [1, 26]]]], sig.keyword_args
+      assert_equal [:@ident, "opts", [1, 31]], sig.opts_arg
+      assert_equal [:blockarg, [:@ident, "block", [1, 38]]], sig.block_arg
+    end
+  end
+
+  def test_empty_when_no_args
+    sig = signature_for("def foo(); end")
+    assert sig.empty?, "should be empty"
+  end
+
+  def test_not_empty_when_normal_args
+    sig = signature_for("def foo(a); end")
+    assert ! sig.empty?, "should not be empty"
+  end
+
+  def test_not_empty_when_default_args
+    sig = signature_for("def foo(b=1); end")
+    assert ! sig.empty?, "should not be empty"
+  end
+
+  def test_not_empty_when_rest_arg
+    sig = signature_for("def foo(*rest); end")
+    assert ! sig.empty?, "should not be empty"
+  end
+
+  if RUBY_VERSION >= "2.0"
+    def test_not_empty_when_keyword_args
+      sig = signature_for("def foo(c: 1); end")
+      assert ! sig.empty?, "should not be empty"
+    end
+
+    def test_not_empty_when_options_args
+      sig = signature_for("def foo(**opts); end")
+      assert ! sig.empty?, "should not be empty"
+    end
+  end
+
+  def test_not_empty_when_block_arg
+    sig = signature_for("def foo(&block); end")
+    assert ! sig.empty?, "should not be empty"
+  end
+
+  private
+
+  def signature_for(string)
+    sexp = Ripper::SexpBuilder.new(string).parse
+    params = find_params(sexp)
+    Sorcerer::Signature.new(params)
+  end
+
+  def find_params(sexp)
+    if ! sexp.is_a?(Array)
+      nil
+    elsif sexp.first == :params
+      sexp
+    else
+      sexp.each { |subexp|
+        found = find_params(subexp)
+        return found if found
+      }
+      nil
+    end
+  end
+
+end

metadata

@@ -1,80 +1,64 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sorcerer
-version: !ruby/object:Gem::Version 
-  hash: 1
+version: !ruby/object:Gem::Version
+  version: 0.3.10
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 9
-  version: 0.3.9
 platform: ruby
-authors: 
+authors:
 - Jim Weirich
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-02-04 00:00:00 Z
+date: 2013-02-06 00:00:00.000000000 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: 
+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/signature.rb
 - lib/sorcerer/subexpression.rb
 - lib/sorcerer/version.rb
-- lib/sorcerer.rb
 - test/assert_resource_helper.rb
 - test/sorcerer/resource_test.rb
+- test/sorcerer/signature_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
 - --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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: sorcerer
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Generate Source from Ripper ASTs
 test_files: []
-