rcodetools 0.4.0.0

data/test/test_method_args.rb

@@ -0,0 +1,134 @@
+require 'test/unit'
+module MethodArgsScriptConfig
+  DIR      = File.join(File.dirname(__FILE__))
+  SCRIPT   = File.join(DIR, "..", "bin", "rct-meth-args")
+  DATAFILE = File.join(DIR, "data/method_args.data.rb")
+end
+
+class TestMethodArgs < Test::Unit::TestCase
+  # (find-sh "cd ..; method_args.rb -n test/method_args.data.rb")
+  include MethodArgsScriptConfig
+  @@result = `ruby '#{SCRIPT}' -n '#{DATAFILE}'`.split(/\n/)
+  @@result.delete_if{ |line| line =~ /Digest/ and line !~ /method_in_Digest_Base/ }
+  @@result.delete "zzzz OK"
+
+  @@expected = <<XXX.split(/\n/)
+method_args.data.rb:3:FixedArgsMethods.singleton (a1)
+method_args.data.rb:4:FixedArgsMethods#initialize (arg)
+method_args.data.rb:5:FixedArgsMethods#f (a1)
+method_args.data.rb:6:FixedArgsMethods#b (a1, &block)
+method_args.data.rb:7:FixedArgsMethods#defmethod (...)
+method_args.data.rb:8:FixedArgsMethods#by_attr_accessor
+method_args.data.rb:8:FixedArgsMethods#by_attr_accessor= (value)
+method_args.data.rb:9:FixedArgsMethods#by_attr_false
+method_args.data.rb:10:FixedArgsMethods#by_attr_true
+method_args.data.rb:10:FixedArgsMethods#by_attr_true= (value)
+method_args.data.rb:11:FixedArgsMethods#by_attr_reader_1
+method_args.data.rb:11:FixedArgsMethods#by_attr_reader_2
+method_args.data.rb:12:FixedArgsMethods#by_attr_writer= (value)
+method_args.data.rb:13:FixedArgsMethods#private_meth (x)
+method_args.data.rb:16:FixedArgsMethods.singleton_attr_accessor
+method_args.data.rb:16:FixedArgsMethods.singleton_attr_accessor= (value)
+method_args.data.rb:17:FixedArgsMethods.singleton_defmethod (...)
+method_args.data.rb:22:VariableArgsMethods#s (a1, *splat)
+method_args.data.rb:23:VariableArgsMethods#sb (a1, *splat, &block)
+method_args.data.rb:24:VariableArgsMethods#d (a1, default = nil)
+method_args.data.rb:25:VariableArgsMethods#ds (a1, default = nil, *splat)
+method_args.data.rb:26:VariableArgsMethods#dsb (a1, default = nil, *splat, &block)
+method_args.data.rb:27:VariableArgsMethods#db (a1, default = nil, &block)
+method_args.data.rb:31:Fixnum#method_in_Fixnum (arg1, arg2)
+method_args.data.rb:32:Fixnum.singleton_method_in_Fixnum (arg1, arg2)
+method_args.data.rb:35:Bignum#method_in_Bignum (arg1, arg2)
+method_args.data.rb:38:Float#method_in_Float (arg1, arg2)
+method_args.data.rb:41:Symbol#method_in_Symbol (arg1, arg2)
+method_args.data.rb:44:Binding#method_in_Binding (arg1, arg2)
+method_args.data.rb:47:UnboundMethod#method_in_UnboundMethod (arg1, arg2)
+method_args.data.rb:50:Method#method_in_Method (arg1, arg2)
+method_args.data.rb:53:Proc#method_in_Proc (arg1, arg2)
+method_args.data.rb:56:Continuation#method_in_Continuation (arg1, arg2)
+method_args.data.rb:59:Thread#method_in_Thread (arg1, arg2)
+method_args.data.rb:66:TrueClass#method_in_TrueClass (arg1, arg2)
+method_args.data.rb:69:NilClass#method_in_NilClass (arg1, arg2)
+method_args.data.rb:72:Struct#method_in_Struct (arg1, arg2)
+Digest::Base#method_in_Digest_Base (...)
+AnAbstractClass#method_in_AnAbstractClass (...)
+method_args.data.rb:93:include AClass <= VariableArgsMethods
+method_args.data.rb:94:extend AClass <- VariableArgsMethods
+method_args.data.rb:97:class ASubClass < AClass
+method_args.data.rb:100:class <Struct: a,b> < Struct
+method_args.data.rb:101:class SubclassOfStructA < StructA
+method_args.data.rb:102:SubclassOfStructA#method_in_b
+method_args.data.rb:104:class <Struct: c> < Struct
+method_args.data.rb:104:class StructSubclass < <Struct: c>
+method_args.data.rb:105:StructSubclass#method_in_c
+XXX
+
+  # To avoid dependency of pwd.
+  module StripDir
+    def strip_dir!
+      slice! %r!^.*/!
+      self
+    end
+  end
+
+  @@expected.each do |line|
+    begin
+      file_lineno_klass_meth, rest = line.split(/\s+/,2)
+      if file_lineno_klass_meth =~ /:/
+        file, lineno, klass_meth = file_lineno_klass_meth.split(/:/)
+        klass_meth = rest if %w[class include extend].include? klass_meth
+      else                        # filename/lineno is unknown
+        klass_meth = file_lineno_klass_meth
+      end
+
+      test_method_name = "test_" + klass_meth
+      define_method(test_method_name) do 
+        actual = @@result.grep(/#{klass_meth}/)[0].extend(StripDir).strip_dir!
+        assert_equal line, actual
+      end
+    rescue Exception
+    end
+  end
+  
+  def test_all_tests
+    assert_equal @@expected.length, @@result.length, @@result.join("\n")
+  end
+
+  def test_without_n_option
+    first_line = "FixedArgsMethods.singleton (a1)"
+    command_output = `ruby '#{SCRIPT}'  '#{DATAFILE}'`
+    assert_match(/\A#{Regexp.quote(first_line)}\n/, command_output)
+  end
+end
+
+
+class TestTAGS < Test::Unit::TestCase
+  include MethodArgsScriptConfig
+
+  @@TAGS = `ruby '#{SCRIPT}' -t '#{DATAFILE}'`
+  def test_filename
+    # check whether full path is passed.
+    assert_match %r!^\cl\n/.+method_args.data.rb,\d!, @@TAGS
+  end
+
+  def test_singleton_method
+    # including line/byte test
+    assert @@TAGS.include?("  def self.singleton(a1) end::FixedArgsMethods.singleton
3,45")
+  end
+
+  def test_instance_method
+    assert @@TAGS.include?("  def initialize(arg) end::FixedArgsMethods#initialize
4,74")
+  end
+
+  def test_include
+    assert_match(/^  include VariableArgsMethods::AClass
/, @@TAGS)
+  end
+
+  def test_extend
+    assert_match(/^  extend VariableArgsMethods::AClass
/, @@TAGS)
+  end
+
+  def test_inheritance
+    assert_match(/^class ASubClass < AClass::ASubClass
/, @@TAGS)
+  end
+end

data/test/test_run.rb

@@ -0,0 +1,41 @@
+require 'test/unit'
+require 'rcodetools/xmpfilter'
+require 'rcodetools/xmptestunitfilter'
+require 'rcodetools/completion'
+require 'rcodetools/doc'
+require 'rcodetools/options'
+require 'stringio'
+
+class TestRun < Test::Unit::TestCase
+  tests = {
+    :simple_annotation => {:klass => XMPFilter},
+    :unit_test         => {:klass => XMPTestUnitFilter},
+    :rspec             => {:klass => XMPRSpecFilter,    :interpreter     => "spec"},
+    :rspec_poetry      => {:klass => XMPRSpecFilter,    :interpreter     => "spec", :use_parentheses => false},
+    :no_warnings       => {:klass => XMPFilter,         :warnings        => false},
+    :bindings          => {:klass => XMPTestUnitFilter, :use_parentheses => false},
+    :unit_test_poetry  => {:klass => XMPTestUnitFilter, :use_parentheses => false},
+    :add_markers       => {:klass => XMPAddMarkers},
+    
+    :completion       => {:klass => XMPCompletionFilter,      :lineno => 1},
+    :completion_emacs => {:klass => XMPCompletionEmacsFilter, :lineno => 1},
+    :completion_emacs_icicles => {:klass => XMPCompletionEmacsIciclesFilter, :lineno => 1},
+    
+    :doc      => {:klass => XMPDocFilter,     :lineno => 1},
+    :refe     => {:klass => XMPReFeFilter,    :lineno => 1},
+    :ri       => {:klass => XMPRiFilter,      :lineno => 1},
+    :ri_emacs => {:klass => XMPRiEmacsFilter, :lineno => 1},
+    :ri_vim   => {:klass => XMPRiVimFilter,   :lineno => 1},
+    
+  }
+  tests.each_pair do |test, opts|
+    define_method("test_#{test}") do
+      dir = File.expand_path(File.dirname(__FILE__))
+      inputfile = "#{dir}/data/#{test}-input.rb"
+      outputfile = "#{dir}/data/#{test}-output.rb"
+      sio = StringIO.new
+      sio.puts opts[:klass].run(File.read(inputfile), DEFAULT_OPTIONS.merge(opts))
+      assert_equal(File.read(outputfile), sio.string)
+    end
+  end 
+end

data/test/test_xmpfilter.rb

@@ -0,0 +1,36 @@
+
+require 'test/unit'
+$: << ".." << "../lib[s]"
+require "rcodetools/xmpfilter"
+
+class TestXMPFilter < Test::Unit::TestCase
+  def setup
+    @xmp = XMPFilter.new
+    @marker = XMPFilter::MARKER
+  end
+
+  def test_extract_data
+    str = <<-EOF
+#{@marker}[1] => Fixnum 42
+#{@marker}[1] => Fixnum 0
+#{@marker}[1] ==> var
+#{@marker}[1] ==> var2
+#{@marker}[4] ==> var3
+#{@marker}[2] ~> some exception
+#{@marker}[10] => Fixnum 42
+    EOF
+    data = @xmp.extract_data(str)
+    assert_kind_of(XMPFilter::RuntimeData, data)
+    assert_equal([[1, [["Fixnum", "42"], ["Fixnum", "0"]]], [10, [["Fixnum", "42"]]]], data.results.sort)
+    assert_equal([[2, ["some exception"]]], data.exceptions.sort)
+    assert_equal([[1, ["var", "var2"]], [4, ["var3"]]], data.bindings.sort)
+  end
+end
+
+class TestXMPAddMarkers < Test::Unit::TestCase
+  
+
+  def test_
+
+  end
+end

data/test/test_xmptestunitfilter.rb

@@ -0,0 +1,84 @@
+
+require 'test/unit'
+$: << ".." << "../lib"
+require "rcodetools/xmptestunitfilter"
+
+class TestXMPTestUnitFilter < Test::Unit::TestCase
+  def setup
+    @xmp = XMPTestUnitFilter.new
+  end
+
+  ANNOTATION_VAR_INFERENCE_INPUT = <<EOF
+arr = []
+X = Struct.new(:foo, :bar)
+x = X.new("foo", "bar")
+arr << x
+arr                                                # \=>
+arr.last                                           # \=>
+EOF
+  ANNOTATION_VAR_INFERENCE_OUTPUT = <<EOF
+arr = []
+X = Struct.new(:foo, :bar)
+x = X.new(\"foo\", \"bar\")
+arr << x
+assert_equal([x], arr)
+assert_kind_of(Array, arr)
+assert_equal(\"[#<struct X foo=\\\"foo\\\", bar=\\\"bar\\\">]\", arr.inspect)
+assert_equal(x, arr.last)
+assert_kind_of(X, arr.last)
+assert_equal(\"#<struct X foo=\\\"foo\\\", bar=\\\"bar\\\">\", arr.last.inspect)
+EOF
+
+  def test_annotation_var_inference
+    assert_equal(ANNOTATION_VAR_INFERENCE_OUTPUT, 
+                 @xmp.annotate(ANNOTATION_VAR_INFERENCE_INPUT).join(""))
+  end
+
+  def test_equality_assertions
+    assert_equal(["a = 1\n", "assert_equal(1, a)"], @xmp.annotate("a = 1\na # \=>"))
+    assert_equal(["a = {1,2}\n", "assert_equal({1=>2}, a)"], 
+                 @xmp.annotate("a = {1,2}\na # \=>"))
+    assert_equal(["a = [1,2]\n", "assert_equal([1, 2], a)"], 
+                 @xmp.annotate("a = [1,2]\na # \=>"))
+    assert_equal(["a = 'foo'\n", "assert_equal(\"foo\", a)"], 
+                 @xmp.annotate("a = 'foo'\na # \=>"))
+    assert_equal(["a = 1.0\n", "assert_in_delta(1.0, a, 0.0001)"], 
+                 @xmp.annotate("a = 1.0\na # \=>"))
+  end
+
+  def test_raise_assertion
+    code = <<EOF
+class NoGood < Exception; end
+raise NoGood                                       # \=>
+EOF
+    assert_equal(["class NoGood < Exception; end\n", 
+                 "assert_raise(NoGood){raise NoGood}\n"], @xmp.annotate(code))
+  end
+
+  def test_assert_nil
+    assert_equal(["a = nil\n", "assert_nil(a)"], @xmp.annotate("a = nil\na # \=>"))
+  end
+
+  def test_poetry_mode
+    code = <<EOF
+a = 1
+a # \=>
+a = 1.0
+a # \=>
+raise "foo" # \=>
+a = nil
+a # \=>
+EOF
+    output = <<EOF
+a = 1
+assert_equal 1, a
+a = 1.0
+assert_in_delta 1.0, a, 0.0001
+assert_raise(RuntimeError){raise "foo"}
+a = nil
+assert_nil a
+EOF
+    xmp = XMPTestUnitFilter.new(:use_parentheses => false)
+    assert_equal(output, xmp.annotate(code).join)
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: rcodetools
+version: !ruby/object:Gem::Version 
+  version: 0.4.0.0
+date: 2006-12-29 00:00:00 +01:00
+summary: rcodetools is a collection of Ruby code manipulation tools
+require_paths: 
+- lib
+email: "\"rubikitch\" <rubikitch@ruby-lang.org>, \"Mauricio Fernandez\" <mfp@acm.org>"
+homepage: http://eigenclass.org/hiki.rb?rcodetools
+rubyforge_project: 
+description: "rcodetools is a collection of Ruby code manipulation tools.  It includes xmpfilter and editor-independent Ruby development helper tools, as well as emacs and vim interfaces.  Currently, rcodetools comprises: * xmpfilter: Automagic Test::Unit assertions/RSpec expectations and code annotations * rct-complete: Accurate method/class/constant etc. completions * rct-doc: Document browsing and code navigator * rct-meth-args: Precise method info (meta-prog. aware) and TAGS generation"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: |+
+  
+  ==============================================================================
+  
+  rcodetools will work better if you use it along with FastRI, an alternative to
+  the standard 'ri' documentation browser which features intelligent searching,
+  better RubyGems integration, vastly improved performance, remote queries via
+  DRb... You can find it at http://eigenclass.org/hiki.rb?fastri and it is also
+  available in RubyGems format:
+  
+      gem install fastri
+  
+  Read README.emacs and README.vim for information on how to integrate
+  rcodetools in your editor.
+  
+  ==============================================================================
+  
+authors: 
+- rubikitch and Mauricio Fernandez
+files: 
+- bin/rct-complete
+- bin/rct-doc
+- bin/xmpfilter
+- bin/rct-meth-args
+- lib/method_analyzer.rb
+- lib/rcodetools/completion.rb
+- lib/rcodetools/doc.rb
+- lib/rcodetools/options.rb
+- lib/rcodetools/xmptestunitfilter.rb
+- lib/rcodetools/xmpfilter.rb
+- CHANGES
+- rcodetools.vim
+- rcodetools.el
+- icicles-rcodetools.el
+- README
+- README.emacs
+- README.vim
+- README.xmpfilter
+- README.method_analysis
+- THANKS
+- Rakefile
+- Rakefile.method_analysis
+- setup.rb
+- test/test_functional.rb
+- test/test_xmpfilter.rb
+- test/test_xmptestunitfilter.rb
+- test/test_doc.rb
+- test/test_completion.rb
+- test/test_method_args.rb
+- test/test_method_analyzer.rb
+- test/test_run.rb
+- test/data/simple_annotation-input.rb
+- test/data/unit_test-input.rb
+- test/data/rspec-input.rb
+- test/data/simple_annotation-output.rb
+- test/data/unit_test-output.rb
+- test/data/no_warnings-input.rb
+- test/data/no_warnings-output.rb
+- test/data/rspec-output.rb
+- test/data/bindings-input.rb
+- test/data/bindings-output.rb
+- test/data/method_analyzer-data.rb
+- test/data/add_markers-input.rb
+- test/data/add_markers-output.rb
+- test/data/completion-input.rb
+- test/data/completion-output.rb
+- test/data/completion_emacs-input.rb
+- test/data/completion_emacs-output.rb
+- test/data/doc-input.rb
+- test/data/doc-output.rb
+- test/data/refe-input.rb
+- test/data/refe-output.rb
+- test/data/ri-input.rb
+- test/data/ri-output.rb
+- test/data/ri_emacs-input.rb
+- test/data/ri_emacs-output.rb
+- test/data/ri_vim-input.rb
+- test/data/ri_vim-output.rb
+- test/data/rspec_poetry-input.rb
+- test/data/rspec_poetry-output.rb
+- test/data/unit_test_poetry-input.rb
+- test/data/unit_test_poetry-output.rb
+- test/data/method_args.data.rb
+- test/data/completion_emacs_icicles-input.rb
+- test/data/completion_emacs_icicles-output.rb
+test_files: 
+- test/test_functional.rb
+- test/test_xmpfilter.rb
+- test/test_xmptestunitfilter.rb
+- test/test_doc.rb
+- test/test_completion.rb
+- test/test_method_args.rb
+- test/test_method_analyzer.rb
+- test/test_run.rb
+rdoc_options: 
+- --main
+- README
+- --title
+- rcodetools
+extra_rdoc_files: 
+- README
+executables: 
+- rct-complete
+- rct-doc
+- xmpfilter
+- rct-meth-args
+extensions: []
+
+requirements: []
+
+dependencies: []
+