test_parser 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.2-p180@test_parser"
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficicent compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]] ; then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id"
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]] ; then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+#
+# If you use bundler and would like to run bundle each time you enter the
+# directory, you can uncomment the following code.
+#
+#   # Ensure that Bundler is installed. Install it if it is not.
+#   if ! command -v bundle >/dev/null; then
+#      printf "The rubygem 'bundler' is not installed. Installing it now.\n"
+#      gem install bundler
+#   fi
+#
+#   # Bundle while reducing excess noise.
+#   printf "Bundling your gems. This may take a few minutes on a fresh clone.\n"
+#   bundle | grep -v '^Using ' | grep -v ' is complete' | sed '/^$/d'
+#
+

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in test_parser.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'fakefs', :require => 'fakefs/safe'
+end

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:test, :spec]

data/bin/test_parser

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "test_parser"
+require 'yaml'
+
+$stdout << TestParser.all_tests(ARGV.last).to_yaml

data/lib/test_parser/common.rb

@@ -0,0 +1,17 @@
+require 'test_parser/source_code'
+require 'test_parser/test_information'
+
+module TestParser
+
+  module Common
+
+    def build_test(extras = {})
+      TestInformation.new(parser_type, test_identification, test_file_name, extras)
+    end
+
+    def test_source_code
+      SourceCode.for(test_file_name)
+    end
+
+  end
+end

data/lib/test_parser/extensions/minitest.rb

@@ -0,0 +1,7 @@
+module MiniTest
+  class Unit
+    def self.dont_install_at_exit!
+      @@installed_at_exit = true
+    end
+  end
+end

data/lib/test_parser/extensions/rspec.rb

@@ -0,0 +1,16 @@
+module RSpec
+
+  def self.world=(new_world)
+    @world = new_world
+  end
+
+  def self.with_world(world)
+    old_world, self.world = self.world, world
+    result = yield(world)
+    self.world = old_world
+    result
+  end
+
+end
+
+RSpec::Core::Runner.disable_autorun!

data/lib/test_parser/minitest.rb

@@ -0,0 +1,48 @@
+require 'minitest/unit'
+require_relative 'extensions/minitest'
+
+require 'test_parser'
+
+module TestParser
+  class MiniTest
+    attr_reader :klass, :test_method
+
+    def self.find_tests!(path, options = {})
+      glob = options[:glob] || 'test/**/*_test.rb'
+
+      ::MiniTest::Unit.dont_install_at_exit!
+      
+      TestParser.require_all(path, glob)
+
+      ::MiniTest::Unit::TestCase.test_suites.collect_concat do |klass|
+        klass.test_methods.map do |test| 
+          new(klass, test).test_info
+        end
+      end
+    end
+
+    include Common
+
+    def parser_type
+      :minitest
+    end
+
+    def initialize(klass, test_method)
+      @klass, @test_method = klass, test_method
+    end
+
+    def test_info
+      build_test(:method_name => test_method)
+    end
+
+    def test_identification
+      "#{klass.name}##{test_method}"
+    end
+
+    def test_file_name
+      klass.instance_method(test_method).source_location.first
+    end
+
+  end
+
+end

data/lib/test_parser/rspec.rb

@@ -0,0 +1,68 @@
+require 'rspec/core'
+require_relative 'extensions/rspec'
+
+require 'test_parser'
+
+module TestParser
+  class RSpec
+    attr_reader :example
+
+    def self.find_tests!(path, options = {})
+      glob = options[:glob] || 'spec/**/*_spec.rb'
+
+      ::RSpec.with_world ::RSpec::Core::World.new do |world|
+
+        TestParser.require_all(path, glob)
+
+        groups   = world.example_groups
+        examples = groups.collect_concat(&:descendant_filtered_examples)
+        examples.map do |example|
+          new(example).test_info
+        end
+      end
+    end
+
+    include Common
+    
+    def initialize(example)
+      @example = example
+    end
+
+    def parser_type
+      :rspec2
+    end
+
+    def test_info
+      build_test(:line_number => line_number)
+    end
+
+    def test_snippet
+      @test_snippet ||= test_source_code.extract_code_from_line(line_number)
+    end
+
+    def test_file_name
+      example.file_path
+    end
+
+    def test_identification
+      (example_group_names.reverse + [example_description]).join('/')
+    end
+
+    def line_number
+      example.metadata[:line_number]
+    end
+
+    def example_group_names
+      example.example_group.ancestors.map(&:display_name)
+    end
+
+    def example_description
+      unless example.description.empty? 
+        example.description
+      else
+        test_snippet.get_block.to_code
+      end
+    end
+
+  end
+end

data/lib/test_parser/snippet.rb

@@ -0,0 +1,15 @@
+require 'ruby2ruby'
+
+module TestParser
+  class Snippet < Struct.new(:sexp)
+
+    def to_code
+      @to_code ||= Ruby2Ruby.new.process(self.sexp.deep_clone)
+    end
+
+    def get_block
+      Snippet.new(sexp[3])
+    end
+
+  end
+end

data/lib/test_parser/source_code.rb

@@ -0,0 +1,40 @@
+require 'ruby_parser'
+require 'test_parser/snippet'
+
+module TestParser
+
+  class SourceCode < Snippet
+
+    def self.source_codes
+      @source_codes ||= begin
+        parser = RubyParser.new
+        Hash.new do |h, k|
+          h[k] = new(parser.parse File.read(k))
+        end
+      end
+    end
+
+    def self.clear_cache
+      @source_codes = nil
+    end
+
+    def self.for(filename)
+      source_codes[File.expand_path(filename)]
+    end
+
+    def extract_method(name)
+      name        = name.to_sym
+      definitions = sexp.enum_for(:each_of_type, :defn)
+      method_sexp = definitions.find {|def_sexp| def_sexp[1] == name }
+      Snippet.new(method_sexp)
+    end
+
+    def extract_code_from_line(line_number)
+      method_calls = sexp.enum_for(:each_of_type, :iter)
+      code_sexp    = method_calls.find {|sexp| sexp[1].line == line_number }
+      Snippet.new(code_sexp)
+    end
+
+  end
+
+end

data/lib/test_parser/test_information.rb

@@ -0,0 +1,3 @@
+module TestParser
+  TestInformation = Struct.new(:type, :identification, :file, :extras)
+end

data/lib/test_parser/version.rb

@@ -0,0 +1,3 @@
+module TestParser
+  VERSION = "0.0.1"
+end

data/lib/test_parser.rb

@@ -0,0 +1,35 @@
+require 'test_parser/common'
+require 'test_parser/minitest'
+require 'test_parser/rspec'
+
+module TestParser
+
+  def all_tests(path, options = {})
+    frameworks = options[:frameworks] ||= [:rspec, :minitest]
+    path = sanitize_path(path)
+    frameworks.collect_concat do |framework|
+      send "#{framework}_tests", path, options[framework]
+    end
+  end
+
+  def minitest_tests(path, options = nil)
+    options ||= {}
+    MiniTest.find_tests!(path, options)
+  end
+
+  def rspec_tests(path, options = nil)
+    options ||= {}
+    RSpec.find_tests!(path, options)
+  end
+
+  def require_all(path, glob)
+    Dir[sanitize_path(path) + glob].each {|f| require f }
+  end
+
+  def sanitize_path(path)
+    return path if path.is_a? Pathname
+    Pathname.new(path).expand_path
+  end
+
+  extend self
+end

data/spec/minitest_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+require 'test_parser'
+describe TestParser::MiniTest do
+  before(:all) do
+    MiniTest::Unit::TestCase.reset
+  end
+  after(:all) do
+    MiniTest::Unit::TestCase.reset
+  end
+
+  describe '.find_tests!' do
+
+    context 'within test_project' do
+      before(:all) do
+        @tests = TestParser::MiniTest.find_tests! path_for_test_project
+        @test_identifications = @tests.map(&:identification)
+      end
+
+      it 'finds all the tests' do
+        @tests.should have(2).tests
+      end
+
+      it 'finds normally declared test' do
+        @test_identifications.should include('TestSomething#test_foo')
+        test = @tests[@test_identifications.index('TestSomething#test_foo')]
+        test.file.should == (path_for_test_project('test/example_test.rb')).to_s
+        test.extras[:method_name].should == 'test_foo'
+      end
+
+      it 'finds module shared tests' do
+        @test_identifications.should include('TestSomething#test_truth')
+        test = @tests[@test_identifications.index('TestSomething#test_truth')]
+        test.file.should == (path_for_test_project('test/test_helper.rb')).to_s
+        test.extras[:method_name].should == 'test_truth'
+      end
+    end
+  end
+end

data/spec/rspec_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+require 'test_parser/rspec'
+
+describe TestParser::RSpec do
+  describe '.find_test_suite!' do
+    context 'within test_project' do
+
+      before(:all) do
+        @test_suite = TestParser::RSpec.find_tests!(path_for_test_project)
+        @test_names = @test_suite.map(&:identification)
+      end
+
+      it 'finds all the test_suite' do
+        @test_suite.should have(2).test_suite
+      end
+
+      it 'finds nested test_suite' do
+        @test_names.should include('Life/with death sentence/should(be_alive)')
+        test = @test_suite[@test_names.index('Life/with death sentence/should(be_alive)')]
+        test.file.should == (path_for_test_project('spec/example_spec.rb')).to_s
+        test.extras[:line_number].should == 11
+      end
+
+      it 'finds not nested test_suite' do
+        @test_names.should include('Life/actually lives')
+        test = @test_suite[@test_names.index('Life/actually lives')]
+    
+        test.file.should == (path_for_test_project('spec/example_spec.rb')).to_s
+        test.extras[:line_number].should == 5
+      end
+
+    end
+  end
+end

data/spec/source_code_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'test_parser/source_code'
+
+describe TestParser::SourceCode do
+  include FakeFS::SpecHelpers
+
+  before(:each) do
+    File.open('standard_class_source.rb', 'w') do |f|
+      f << standard_class_source
+    end
+    File.open('dsl_source.rb', 'w') do |f|
+      f << dsl_source
+    end
+  end
+
+  after(:each) do
+    TestParser::SourceCode.clear_cache
+  end
+
+  it 'has the sexp of the original file' do
+    sexp = RubyParser.new.parse standard_class_source
+    TestParser::SourceCode.for('standard_class_source.rb').sexp.should == sexp
+  end
+
+  describe '.extract_method' do
+    it 'finds the method definition from the method name' do
+      snippet = TestParser::SourceCode.for('standard_class_source.rb').extract_method('method')
+      snippet.to_code.should match_code(<<-METHOD)
+        def method(some)
+          puts some
+        end
+      METHOD
+    end
+  end
+
+  describe '.extract_code_from_line' do
+    it 'finds the line with its block' do
+      snippet = TestParser::SourceCode.for('dsl_source.rb').extract_code_from_line(2)
+      snippet.to_code.should match_code(<<-METHOD)
+        method 'ble' do
+          testing_something
+        end
+      METHOD
+    end
+  end
+
+  def standard_class_source
+    <<-SOURCE
+      class A
+        def method(some)
+          puts some
+        end
+      end
+    SOURCE
+  end
+
+  def dsl_source
+    <<-SOURCE
+      calling :something do 
+        method 'ble' do
+          testing_something
+        end
+      end
+    SOURCE
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler.setup
+Bundler.require :default, :test
+
+Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each {|f| require f }
+
+require 'fakefs/spec_helpers'
+
+RSpec.configure do |config|
+  config.include ProjectsPaths
+end

data/spec/support/matchers/match_code.rb

@@ -0,0 +1,10 @@
+RSpec::Matchers.define :match_code do |expected|
+  expected_sexp = RubyParser.new.parse(expected)
+
+  match do |actual|
+    actual_sexp = actual.sexp if actual.respond_to? :sexp
+    actual_sexp ||= RubyParser.new.parse(actual)
+    expected_sexp == actual_sexp
+  end
+
+end

data/spec/support/projects_paths.rb

@@ -0,0 +1,13 @@
+require 'pathname'
+
+module ProjectsPaths
+
+  def devotest_path
+    Pathname.new File.join(File.dirname(__FILE__), '..', '..')
+  end
+
+  def path_for_test_project(*append)
+    ([devotest_path, 'test_project'] + append).reduce(:+).cleanpath
+  end
+
+end

data/spec/test_parser_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+require 'test_parser'
+
+describe TestParser do
+  
+  describe ".minitest_tests" do
+    it 'delegates test finding to TestParser::MiniTest' do
+      TestParser::MiniTest.should_receive(:find_tests!).
+        with(path_for_test_project, {}).and_return []
+        
+      TestParser.minitest_tests(path_for_test_project)
+    end
+    it 'passes extra options to TestParser::Minitest' do
+      TestParser::MiniTest.should_receive(:find_tests!).
+        with(path_for_test_project, {:some_option => true}).and_return []
+        
+      TestParser.minitest_tests(path_for_test_project, {:some_option => true})
+    end
+  end
+  
+  describe ".rspec_tests" do
+    it 'delegates test finding to TestParser::RSpec' do
+      TestParser::RSpec.should_receive(:find_tests!).
+        with(path_for_test_project, {}).and_return []
+        
+      TestParser.rspec_tests(path_for_test_project)
+    end
+    it 'passes extra options to TestParser::RSpec' do
+      TestParser::RSpec.should_receive(:find_tests!).
+        with(path_for_test_project, {:some_option => true}).and_return []
+
+      TestParser.rspec_tests(path_for_test_project, {:some_option => true})
+    end
+  end
+
+  describe ".all_tests" do
+    it "collects all the test from the default frameworks" do
+      stub_frameworks
+
+      tests = TestParser.all_tests(path_for_test_project)
+      tests.should == [:rspec, :minitest]
+    end
+    
+    context "when :frameworks are specified" do
+      it 'collects only for the given frameworks' do
+        stub_frameworks
+        
+        options = {:frameworks => [:rspec]}
+        tests   = TestParser.all_tests(path_for_test_project, options)
+        tests.should == [:rspec]
+      end
+    end
+    
+    def stub_frameworks
+      TestParser::RSpec.stub(:find_tests!) { [:rspec]}
+      TestParser::MiniTest.stub(:find_tests!) {[:minitest]}
+    end
+  end
+end

data/test/rspec_test.rb

@@ -0,0 +1,24 @@
+require 'minitest/autorun'
+
+require 'bundler'
+Bundler.setup
+Bundler.require :default
+
+require_relative '../spec/support/projects_paths'
+require 'test_parser'
+
+# This test is only to check there isn't any side effect for testing with Rspec
+# while parsing RSpec specs.
+class RSpecTest < MiniTest::Unit::TestCase
+
+  include ProjectsPaths
+  
+  def test_rspec_parsing
+    tests = TestParser::RSpec.find_tests!(path_for_test_project)
+    test = tests.first
+    assert_equal 'Life/actually lives', test.identification
+    assert_equal path_for_test_project('spec/example_spec.rb').to_s, test.file
+    assert_equal 5, test.extras[:line_number]
+  end
+
+end

data/test_parser.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "test_parser/version"
+
+Gem::Specification.new do |s|
+  s.name        = "test_parser"
+  s.version     = TestParser::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Juan Manuel Barreneche"]
+  s.email       = ["juanmanuel.barreneche@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Retrieves information of your test suite}
+  s.description = %q{Retrieves information of your test suite}
+
+  s.rubyforge_project = "test_parser"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'ruby_parser', '~> 2.0.5'
+  s.add_dependency 'ruby2ruby', '~> 1.2.5'
+  s.add_dependency 'rspec-core', '~> 2.5.0'
+  s.add_dependency 'minitest', '~> 2.0.2'
+
+end

data/test_project/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:test, :spec]

data/test_project/life.rb

@@ -0,0 +1,7 @@
+class Life
+  def alive?
+    true
+  end
+  def sentence_to_death!
+  end
+end

data/test_project/spec/example_spec.rb

@@ -0,0 +1,14 @@
+require_relative 'spec_helper'
+
+describe Life do
+
+  it 'actually lives' do
+    Life.new.should be_alive
+  end
+
+  context 'with death sentence' do
+    subject { Life.new.tap {|l| l.sentence_to_death! }}
+    it { should be_alive }
+  end
+
+end

data/test_project/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative '../life'

data/test_project/test/example_test.rb

@@ -0,0 +1,12 @@
+require_relative 'test_helper'
+require_relative '../life'
+
+class TestSomething < MiniTest::Unit::TestCase
+  include SomeSharedTest
+
+  def test_foo
+    life = Life.new
+    assert life.alive?
+  end
+
+end

data/test_project/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'minitest/autorun'
+
+module SomeSharedTest
+
+  def test_truth
+    assert true
+  end
+
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: test_parser
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Juan Manuel Barreneche
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-20 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby_parser
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.0.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby2ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.2.5
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec-core
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+  type: :runtime
+  version_requirements: *id004
+description: Retrieves information of your test suite
+email: 
+- juanmanuel.barreneche@gmail.com
+executables: 
+- test_parser
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Rakefile
+- bin/test_parser
+- lib/test_parser.rb
+- lib/test_parser/common.rb
+- lib/test_parser/extensions/minitest.rb
+- lib/test_parser/extensions/rspec.rb
+- lib/test_parser/minitest.rb
+- lib/test_parser/rspec.rb
+- lib/test_parser/snippet.rb
+- lib/test_parser/source_code.rb
+- lib/test_parser/test_information.rb
+- lib/test_parser/version.rb
+- spec/minitest_spec.rb
+- spec/rspec_spec.rb
+- spec/source_code_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/match_code.rb
+- spec/support/projects_paths.rb
+- spec/test_parser_spec.rb
+- test/rspec_test.rb
+- test_parser.gemspec
+- test_project/Rakefile
+- test_project/life.rb
+- test_project/spec/example_spec.rb
+- test_project/spec/spec_helper.rb
+- test_project/test/example_test.rb
+- test_project/test/test_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: test_parser
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Retrieves information of your test suite
+test_files: 
+- spec/minitest_spec.rb
+- spec/rspec_spec.rb
+- spec/source_code_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/match_code.rb
+- spec/support/projects_paths.rb
+- spec/test_parser_spec.rb
+- test/rspec_test.rb