spec-converter 0.0.1

data/Manifest.txt

@@ -0,0 +1,6 @@
+Manifest.txt
+README.txt
+Rakefile
+bin/spec_converter
+lib/spec_converter.rb
+test/spec_converter_test.rb

data/README.txt

@@ -0,0 +1,47 @@
+= spec_converter
+
+== DESCRIPTION
+  Simple converter to go from test-unit or dust style tests to test-spec (http://rubyforge.org/projects/test-spec) specs.
+
+== FEATURES/PROBLEMS
+  This will change all files in place!!  Make sure you are properly backed up and/or committed to SVN before running.
+	
+== INSTALL
+  sudo gem install spec_converter
+
+== USAGE
+Assuming your project is at ~/work/project/:
+
+  cd ~/work/project
+  spec_converter
+
+== URLS:
+* test/spec:  http://rubyforge.org/projects/test-spec
+* trac:				http://opensource.thinkrelevance.com/wiki/spec-converter
+* svn trunk: 	https://opensource.thinkrelevance.com/svn/spec_converter/trunk
+* rdoc:     	http://spec-converter.rubyforge.org/rdoc
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Relevance
+
+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.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rake'
+require 'rake/testtask'
+require 'rubygems'
+require 'hoe'
+require 'lib/spec_converter'
+require 'rcov/rcovtask'
+
+Hoe.new('SpecConverter', SpecConverter::VERSION) do |p|
+  p.rubyforge_name = "spec-converter"
+  p.name = 'spec-converter'
+  p.remote_rdoc_dir = 'rdoc'
+  p.summary = "Convert your tests to test/spec specs"
+  p.author = "Relevance"
+  p.email = "opensource@thinkrelevance.com"
+  p.url = "http://opensource.thinkrelevance.com"
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Default for CruiseControl'
+task :cruise => ['test', 'test:flog']
+
+desc 'Test for flog failure'
+namespace :test do
+  task :flog do
+    threshold = (ENV['FLOG_THRESHOLD'] || 120).to_i
+    dirs = %w(lib tasks test)
+    result = IO.popen("flog #{dirs.join(' ')} 2>/dev/null | grep \"(\" | grep -v \"main#none\" | head -n 1").readlines.join('')
+    result =~ /\((.*)\)/
+    flog = $1.to_i
+    result =~ /^(.*):/
+    method = $1
+    if flog > threshold
+      raise "FLOG failed for #{method} with score of #{flog} (threshold is #{threshold})."
+    end  
+    puts "FLOG passed, with highest score being #{flog} for #{method}."
+  end
+end
+
+desc 'Test the relevance_tools plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+Rcov::RcovTask.new("rcov") do |t|
+  rcov_output = "tmp/coverage"
+  FileUtils.mkdir_p rcov_output unless File.exist? rcov_output
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.output_dir = "#{rcov_output}/"
+  t.verbose = true
+  t.rcov_opts = ["-x", "^/Library", "--sort coverage"]
+end          

data/bin/spec_converter

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'spec_converter'
+
+SpecConverter.start

data/lib/spec_converter.rb

@@ -0,0 +1,60 @@
+# Simple converter to go to test/spec style
+# This will change all files in place, so make sure you are properly backed up and/or committed to SVN!
+class SpecConverter
+  VERSION = "0.0.1"
+  
+  def self.start
+    spec_converter = SpecConverter.new
+    spec_converter.convert
+  end
+  
+  # Convert tests from old spec style to new style -- assumes you are in your project root and globs all tests 
+  # in your test directory.  
+  def convert
+    raise "No test diretory - you must run this script from your project root, which should also contain a test directory." unless File.directory?("test")
+    tests = Dir.glob('test/**/*_test.rb')
+    tests.each do |test_file|
+      translate_file(test_file)
+    end
+  end
+  
+  def translate_file(file)
+    translation = ""
+    File.open(file) do |io|
+      io.each_line do |line|
+        translation << convert_line(line)
+      end
+    end
+    File.open(file, "w") do |io|
+      io.write(translation)
+    end
+  end
+  
+  def convert_line(line)
+    convert_rspec_old_style_names(line)
+    convert_dust_style(line)
+    convert_test_unit_class_name(line)
+    convert_test_unit_methods(line)
+    line
+  end
+  
+  private
+  
+  def convert_rspec_old_style_names(line)
+    line.gsub!(/(^\s*)context(\s.*do)/, '\1describe\2')
+    line.gsub!(/(^\s*)specify(\s.*do)/, '\1it\2')
+  end
+
+  def convert_test_unit_class_name(line)
+    line.gsub!(/^class\s*([\w:]+)Test\s*<\s*Test::Unit::TestCase/, 'describe "\1" do')
+    line.gsub!(/^class\s*([\w:]+)Test\s*<\s*ActionController::IntegrationTest/, 'describe "\1", ActionController::IntegrationTest do')
+  end
+  
+  def convert_test_unit_methods(line)
+    line.gsub!(/(^\s*)def\s*test_([\w_!?,$]+)/) { %{#{$1}it "#{$2.split('_').join(' ')}" do} }
+  end
+  
+  def convert_dust_style(line)
+    line.gsub!(/(^\s*)test(\s.*do)/, '\1it\2')
+  end
+end

data/test/spec_converter_test.rb

@@ -0,0 +1,146 @@
+require 'rubygems'
+require 'test/spec'
+require 'mocha'
+require 'tempfile'
+require File.dirname(__FILE__) + '/../lib/spec_converter'
+
+describe "converting from test/spec old style to new style names" do
+  setup do
+    @converter = SpecConverter.new
+  end
+  
+  it "replaces spec context with describe" do
+    @converter.convert_line(%[context "should foo bar" do]).should == %[describe "should foo bar" do]
+    @converter.convert_line(%[    context "should foo bar" do]).should == %[    describe "should foo bar" do]
+  end
+  
+  it "ignores unrelated uses of 'context'" do
+    @converter.convert_line(%[# here is a comment with context]).should == %[# here is a comment with context]
+    @converter.convert_line(%[contexts.each do |context|]).should == %[contexts.each do |context|]
+  end
+
+  it "replaces spec specify with it" do
+    @converter.convert_line(%[    specify "remember me saves the user" do]).should == %[    it "remember me saves the user" do]
+  end
+  
+  it "ignores unrelated uses of 'specify'" do
+    @converter.convert_line(%[# I like to specify things]).should == %[# I like to specify things]
+    @converter.convert_line(%[  @user.should.specify.stuff]).should == %[  @user.should.specify.stuff]
+  end
+  
+end
+
+describe "SpecConverter.start" do
+  it "creates an instance and calls convert" do
+    SpecConverter.expects(:new).returns(converter = stub)
+    converter.expects(:convert)
+    SpecConverter.start
+  end
+end
+
+describe "translate file overwrites old file with translated stuff" do
+  it "works" do
+    file = Tempfile.open("some_file.rb")
+    file << "Here is some stuff that is cool!"
+    file.close
+    
+    converter = SpecConverter.new
+    converter.expects(:convert_line).with(anything).returns("Translated to be super awesome")
+    converter.translate_file(file.path)
+
+    File.open(file.path).read.should == "Translated to be super awesome"
+  end
+end
+
+describe "converting dust style to test/spec style" do
+  setup do
+    @converter = SpecConverter.new
+  end
+  
+  it "changes test...do to it...do" do
+    @converter.convert_line(%[test "should do something cool and fun!!" do]).should == %[it "should do something cool and fun!!" do]
+  end
+  
+  it "ignores unrelated lines" do
+    @converter.convert_line(%[# test that this class can do something right]).should == %[# test that this class can do something right]
+  end
+
+end
+
+describe "converting ActionController::IntegrationTest style to describe blocks" do
+  setup do
+    @converter = SpecConverter.new
+  end
+
+  it "replaces class FooTest < ActionController::IntegrationTest with describe foo do" do
+    @converter.convert_line(%[class ResearchTest < ActionController::IntegrationTest]).should == %[describe "Research", ActionController::IntegrationTest do]
+  end
+end
+
+describe "converting Test::Unit style to describe blocks" do
+  setup do
+    @converter = SpecConverter.new
+  end
+
+  it "replaces class FooTest < Test::Unit::TestCase with describe foo do" do
+    @converter.convert_line(%[class ResearchTest < Test::Unit::TestCase]).should == %[describe "Research" do]
+  end
+
+  it "replaces class FooTest < Test::Unit::TestCase with silly whitespacing with describe foo do" do
+    @converter.convert_line(%[class ResearchTest       < Test::Unit::TestCase]).should == %[describe "Research" do]
+  end
+  
+  it "converts namespaced test unit classes" do
+    @converter.convert_line(%[class Admin::DashboardControllerTest < Test::Unit::TestCase]).should == %[describe "Admin::DashboardController" do]
+  end
+
+  it "ignores unrelated classes" do
+    @converter.convert_line(%[class Foo]).should == %[class Foo]
+    @converter.convert_line(%[class Bar < ActiveRecord::Base]).should == %[class Bar < ActiveRecord::Base]
+  end
+
+end
+
+describe "converting Test::Unit methods to it blocks" do
+  setup do
+    @converter = SpecConverter.new
+  end
+
+  it "replaces class def test_something? with it something?  do" do
+    @converter.convert_line(%[def test_something?]).should == %[it "something?" do]
+  end
+
+  it "replaces class def test_something with it something do" do
+    @converter.convert_line(%[def test_something]).should == %[it "something" do]
+  end
+  
+  it "replaces class def test_something with it something do when it has leading whitespace" do
+    @converter.convert_line(%[   def test_something_here]).should == %[   it "something here" do]
+  end
+  
+  it "ignores unrelated lines" do
+    @converter.convert_line(%[def foo]).should == %[def foo]
+  end
+  
+  it "ignores unrelated lines with leading whitespace" do
+    @converter.convert_line(%[   def foo]).should == %[   def foo]
+  end
+
+end
+
+describe "converting things in batch" do
+  setup do
+    @converter = SpecConverter.new
+  end
+  
+  it "takes convert all test files in the test subdirectory" do
+    @convert.expects(:convert_line).never
+    files = %w[test/foo_test.rb test/models/another_test.rb]
+    files.each do |file|
+      @converter.expects(:translate_file).with(file)
+    end
+    Dir.expects(:glob).with(anything()).returns(files)
+    File.stubs(:directory?).with("test").returns(true)
+    @converter.convert
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: spec-converter
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Relevance
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-04 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: The author was too lazy to write a description
+email: opensource@thinkrelevance.com
+executables: 
+- spec_converter
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- README.txt
+files: 
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/spec_converter
+- lib/spec_converter.rb
+- test/spec_converter_test.rb
+has_rdoc: true
+homepage: http://opensource.thinkrelevance.com
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: spec-converter
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Convert your tests to test/spec specs
+test_files: []
+