rspec 1.1.2 → 1.1.3

data/lib/spec/story/runner.rb

@@ -40,8 +40,6 @@ module Spec
         end
         
         def register_exit_hook # :nodoc:
-          # TODO - when story runner uses test/unit runners like example runner does we can kill
-          # this and also the assorted Kernel.stub!(:at_exit) in examples
           at_exit do
             Runner.story_runner.run_stories unless $!
           end

data/lib/spec/story/step.rb

@@ -39,14 +39,16 @@ module Spec
 
       private
       
-        def assign_expression(name)
-          expression = name.dup
-          if String === expression
+        def assign_expression(string_or_regexp)
+          if String === string_or_regexp
+            expression = string_or_regexp.dup
             expression.gsub! '(', '\('
             expression.gsub! ')', '\)'
-            while expression =~ PARAM_PATTERN
-              expression.gsub!($1, "(.*?)")
-            end
+          elsif Regexp === string_or_regexp
+            expression = string_or_regexp.source
+          end
+          while expression =~ PARAM_PATTERN
+            expression.gsub!($1, "(.*?)")
           end
           @expression = Regexp.new("^#{expression}$")
         end

data/lib/spec/story/world.rb

@@ -70,6 +70,7 @@ module Spec
           # story_server/prototype/rspec_stories.html (generated by rake stories)
           args = step.parse_args(name) if args.empty?
           begin
+            listeners.each { |l| l.step_upcoming(type, step_name, *args) }
             step.perform(world, *args) unless ::Spec::Story::Runner.dry_run
             listeners.each { |l| l.step_succeeded(type, step_name, *args) }
           rescue Exception => e

data/lib/spec/version.rb

@@ -1,22 +1,22 @@
-module Spec
-  module VERSION
-    unless defined? MAJOR
-      MAJOR  = 1
-      MINOR  = 1
-      TINY   = 2
-      RELEASE_CANDIDATE = nil
-
-      BUILD_TIME_UTC = 20080114022430
-
-      STRING = [MAJOR, MINOR, TINY].join('.')
-      TAG = "REL_#{[MAJOR, MINOR, TINY, RELEASE_CANDIDATE].compact.join('_')}".upcase.gsub(/\.|-/, '_')
-      FULL_VERSION = "#{[MAJOR, MINOR, TINY, RELEASE_CANDIDATE].compact.join('.')} (build #{BUILD_TIME_UTC})"
-
-      NAME   = "RSpec"
-      URL    = "http://rspec.rubyforge.org/"  
-    
-      DESCRIPTION = "#{NAME}-#{FULL_VERSION} - BDD for Ruby\n#{URL}"
-    end
-  end
-end
-
+module Spec
+  module VERSION
+    unless defined? MAJOR
+      MAJOR  = 1
+      MINOR  = 1
+      TINY   = 3
+      RELEASE_CANDIDATE = nil
+
+      BUILD_TIME_UTC = 20080131122909
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+      TAG = "REL_#{[MAJOR, MINOR, TINY, RELEASE_CANDIDATE].compact.join('_')}".upcase.gsub(/\.|-/, '_')
+      FULL_VERSION = "#{[MAJOR, MINOR, TINY, RELEASE_CANDIDATE].compact.join('.')} (build #{BUILD_TIME_UTC})"
+
+      NAME   = "RSpec"
+      URL    = "http://rspec.rubyforge.org/"  
+    
+      DESCRIPTION = "#{NAME}-#{FULL_VERSION} - BDD for Ruby\n#{URL}"
+    end
+  end
+end
+

data/pre_commit/lib/pre_commit.rb

@@ -0,0 +1,4 @@
+require "pre_commit/pre_commit"
+require "pre_commit/rspec"
+require "pre_commit/core"
+require "pre_commit/rspec_on_rails"

data/pre_commit/lib/pre_commit/core.rb

@@ -0,0 +1,50 @@
+class PreCommit::Core < PreCommit
+  def pre_commit
+    rake_invoke :examples
+    website
+  end
+
+  def website(run_webby=true)
+    clobber
+    rake_invoke :verify_rcov
+    rake_invoke :spec_html
+    webby
+    rake_invoke :failing_examples_with_html
+    rdoc
+    rdoc_rails
+  end
+
+  def clobber
+    rm_rf '../doc/output'
+    rm_rf 'translated_specs'
+  end
+
+  def webby
+    Dir.chdir '../doc' do
+      output = silent_sh('rake rebuild 2>&1')
+      if shell_error?(output)
+        raise "ERROR while generating web site: #{output}"
+      end
+
+      spec_page = File.expand_path('output/documentation/tools/spec.html')
+      spec_page_content = File.open(spec_page).read
+      unless spec_page_content =~/\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\./m
+        raise "#{'!'*400}\nIt seems like the output in the generated documentation is broken (no dots: ......)\n. Look in #{spec_page}"
+      end
+    end
+  end
+
+  def rdoc
+    Dir.chdir '../rspec' do
+      rake = (PLATFORM == "i386-mswin32") ? "rake.cmd" : "rake"
+      `#{rake} rdoc`
+    end
+  end
+
+  def rdoc_rails
+    Dir.chdir '../rspec_on_rails' do
+      rake = (PLATFORM == "i386-mswin32") ? "rake.cmd" : "rake"
+      `#{rake} rdoc`
+    end
+  end
+end

data/pre_commit/lib/pre_commit/pre_commit.rb

@@ -0,0 +1,54 @@
+class PreCommit
+  attr_reader :actor
+  def initialize(actor)
+    @actor = actor
+  end
+
+  protected
+  def rake_invoke(task_name)
+    Rake::Task[task_name].invoke
+  end
+
+  def rake_sh(task_name, env_hash={})
+    env = env_hash.collect{|key, value| "#{key}=#{value}"}.join(' ')
+    rake = (PLATFORM == "i386-mswin32") ? "rake.bat" : "rake"
+    cmd = "#{rake} #{task_name} #{env} --trace"
+    output = silent_sh(cmd)
+    puts output
+    if shell_error?(output)
+      raise "ERROR while running rake: #{cmd}"
+    end
+  end
+
+  def silent_sh(cmd, &block)
+    output = nil
+    IO.popen(cmd) do |io|
+      output = io.read
+      output.each_line do |line|
+        block.call(line) if block
+      end
+    end
+    output
+  end
+
+  def shell_error?(output)
+    output =~ /ERROR/n || error_code?
+  end
+
+  def error_code?
+    $?.exitstatus != 0
+  end
+
+  def root_dir
+    dir = File.dirname(__FILE__)
+    File.expand_path("#{dir}/../../../..")
+  end  
+
+  def method_missing(method_name, *args, &block)
+    if actor.respond_to?(method_name)
+      actor.send(method_name, *args, &block)
+    else
+      super
+    end
+  end
+end

data/pre_commit/lib/pre_commit/rspec.rb

@@ -0,0 +1,111 @@
+class PreCommit::Rspec < PreCommit
+  def pre_commit
+    check_for_gem_dependencies
+    fix_cr_lf
+    touch_revision_storing_files
+    pre_commit_core
+    pre_commit_textmate_bundle
+    pre_commit_rails
+    ok_to_commit
+  end
+  
+  def check_for_gem_dependencies
+    require "rubygems"
+    gem 'rake'
+    gem 'webby'
+    gem 'coderay'
+    gem 'RedCloth'
+    gem 'syntax'
+    gem 'diff-lcs'
+    gem 'heckle' unless PLATFORM == "i386-mswin32"
+    gem 'hpricot'
+  end
+
+  def fix_cr_lf
+    files = FileList['**/*.rb'].
+            exclude('example_rails_app/vendor/**').
+            exclude('rspec/translated_specs/**')
+    $\="\n"
+    files.each do |f|
+      raw_content = File.read(f)
+      fixed_content = ""
+      raw_content.each_line do |line|
+        fixed_content << line
+      end
+      unless raw_content == fixed_content
+        File.open(f, "w") do |io|
+          io.print fixed_content
+        end
+      end
+    end
+  end
+  
+  # TODO - move me up to the project root
+  def touch_revision_storing_files
+    files = [
+      'rspec/lib/spec/version.rb',
+      'rspec_on_rails/lib/spec/rails/version.rb'
+    ]
+    build_time_utc = Time.now.utc.strftime('%Y%m%d%H%M%S')
+    files.each do |path|
+      abs_path = File.join(root_dir, path)
+      content = File.open(abs_path).read
+      touched_content = content.gsub(/BUILD_TIME_UTC = (\d*)/, "BUILD_TIME_UTC = #{build_time_utc}")
+      File.open(abs_path, 'w') do |io|
+        io.write touched_content
+      end
+    end
+  end
+  
+  def pre_commit_core
+    Dir.chdir 'rspec' do
+      rake = (PLATFORM == "i386-mswin32") ? "rake.bat" : "rake"
+      system("#{rake} pre_commit --verbose --trace")
+      raise "RSpec Core pre_commit failed" if error_code?
+    end    
+  end
+
+  def pre_commit_textmate_bundle
+    Dir.chdir 'RSpec.tmbundle/Support' do
+      rake = (PLATFORM == "i386-mswin32") ? "rake.bat" : "rake"
+      system("#{rake} spec --verbose --trace")
+      raise "RSpec Textmate Bundle specs failed" if error_code?
+    end    
+  end
+
+  def install_dependencies
+    Dir.chdir 'example_rails_app' do
+      rake_sh("-f Multirails.rake install_dependencies")
+    end
+  end
+
+  def update_dependencies
+    Dir.chdir 'example_rails_app' do
+      rake_sh("-f Multirails.rake update_dependencies")
+    end
+  end
+
+  def pre_commit_rails
+    Dir.chdir 'example_rails_app' do
+      rake = (PLATFORM == "i386-mswin32") ? "rake.cmd" : "rake"
+      cmd = "#{rake} -f Multirails.rake pre_commit --trace"
+      system(cmd)
+      if error_code?
+        message = <<-EOF
+        ############################################################
+        RSpec on Rails Plugin pre_commit failed. For more info:
+
+          cd example_rails_app
+          #{cmd}
+
+        ############################################################
+        EOF
+        raise message.gsub(/^        /, '')
+      end
+    end
+  end
+  
+  def ok_to_commit
+    puts "OK TO COMMIT"
+  end
+end

data/pre_commit/lib/pre_commit/rspec_on_rails.rb

@@ -0,0 +1,313 @@
+class PreCommit::RspecOnRails < PreCommit
+  def pre_commit
+    install_plugins
+    check_dependencies
+    used_railses = []
+    VENDOR_DEPS.each do |dependency|
+      rails_dir = File.expand_path(dependency[:checkout_path])
+      rails_version = rails_version_from_dir(rails_dir)
+      begin
+        rspec_pre_commit(rails_version, false)
+        used_railses << rails_version
+      rescue Exception => e
+        unless rails_version == 'edge'
+          raise e
+        end
+      end
+    end
+    uninstall_plugins
+    puts "All specs passed against the following released versions of Rails: #{used_railses.join(", ")}"
+    unless used_railses.include?('edge')
+      puts "There were errors running pre_commit against edge"
+    end
+  end
+
+  def rails_version_from_dir(rails_dir)
+    File.basename(rails_dir)
+  end
+
+  def rspec_pre_commit(rails_version=ENV['RSPEC_RAILS_VERSION'],uninstall=true)
+    puts "#####################################################"
+    puts "running pre_commit against rails #{rails_version}"
+    puts "#####################################################"
+    ENV['RSPEC_RAILS_VERSION'] = rails_version
+    cleanup(uninstall)
+    ensure_db_config
+    clobber_sqlite_data
+    install_plugins
+    generate_rspec
+
+    generate_login_controller
+    create_purchase
+
+    rake_sh "spec"
+    rake_sh "spec:plugins:rspec_on_rails"
+    
+    # TODO - why is this necessary? Shouldn't the specs leave
+    # a clean DB?
+    rake_sh "db:test:prepare"
+    sh "ruby vendor/plugins/rspec_on_rails/stories/all.rb"
+    cleanup(uninstall)
+  end
+
+  def cleanup(uninstall=true)
+    revert_routes
+    rm_generated_login_controller_files
+    destroy_purchase
+    uninstall_plugins if uninstall
+  end
+
+  def revert_routes
+    output = silent_sh("cp config/routes.rb.bak config/routes.rb")
+    raise "Error reverting routes.rb" if shell_error?(output)
+  end
+
+  def create_purchase
+    generate_purchase
+    migrate_up
+  end
+
+  def install_plugins
+    install_rspec_on_rails_plugin
+    install_rspec_plugin
+  end
+
+  def install_rspec_on_rails_plugin
+    rm_rf 'vendor/plugins/rspec_on_rails'
+    copy '../rspec_on_rails', 'vendor/plugins/'
+  end
+
+  def install_rspec_plugin
+    rm_rf 'vendor/plugins/rspec'
+    copy '../rspec', 'vendor/plugins/'
+  end
+
+  def uninstall_plugins
+    rm_rf 'vendor/plugins/rspec_on_rails'
+    rm_rf 'vendor/plugins/rspec'
+    rm_rf 'script/spec'
+    rm_rf 'script/spec_server'
+    rm_rf 'spec/spec_helper.rb'
+    rm_rf 'spec/spec.opts'
+    rm_rf 'spec/rcov.opts'
+  end
+  
+  def copy(source, target)
+    output = silent_sh("cp -R #{File.expand_path(source)} #{File.expand_path(target)}")
+    raise "Error installing rspec" if shell_error?(output)
+  end
+  
+  def generate_rspec
+    result = silent_sh("ruby script/generate rspec --force")
+    if error_code? || result =~ /^Missing/
+      raise "Failed to generate rspec environment:\n#{result}"
+    end
+  end
+
+  def ensure_db_config
+    config_path = 'config/database.yml'
+    unless File.exists?(config_path)
+      message = <<-EOF
+      #####################################################
+      Could not find #{config_path}
+
+      You can get rake to generate this file for you using either of:
+        rake rspec:generate_mysql_config
+        rake rspec:generate_sqlite3_config
+
+      If you use mysql, you'll need to create dev and test
+      databases and users for each. To do this, standing
+      in rspec_on_rails, log into mysql as root and then...
+        mysql> source db/mysql_setup.sql;
+
+      There is also a teardown script that will remove
+      the databases and users:
+        mysql> source db/mysql_teardown.sql;
+      #####################################################
+      EOF
+      raise message.gsub(/^      /, '')
+    end
+  end
+
+  def generate_mysql_config
+    copy 'config/database.mysql.yml', 'config/database.yml'
+  end
+
+  def generate_sqlite3_config
+    copy 'config/database.sqlite3.yml', 'config/database.yml'
+  end
+
+  def clobber_db_config
+    rm 'config/database.yml'
+  end
+
+  def clobber_sqlite_data
+    rm_rf 'db/*.db'
+  end
+
+  def generate_purchase
+    generator = "ruby script/generate rspec_scaffold purchase order_id:integer created_at:datetime amount:decimal keyword:string description:text --force"
+    notice = <<-EOF
+    #####################################################
+    #{generator}
+    #####################################################
+    EOF
+    puts notice.gsub(/^    /, '')
+    result = silent_sh(generator)
+    if error_code? || result =~ /not/
+      raise "rspec_scaffold failed. #{result}"
+    end
+  end
+  
+  def purchase_migration_version
+    "005"
+  end
+
+  def migrate_up
+    rake_sh "db:migrate"
+  end
+
+  def destroy_purchase
+    migrate_down
+    rm_generated_purchase_files
+  end
+
+  def migrate_down
+    notice = <<-EOF
+    #####################################################
+    Migrating down and reverting config/routes.rb
+    #####################################################
+    EOF
+    puts notice.gsub(/^    /, '')
+    rake_sh "db:migrate", 'VERSION' => (purchase_migration_version.to_i - 1)
+    output = silent_sh("cp config/routes.rb.bak config/routes.rb")
+    raise "revert failed: #{output}" if error_code?
+  end
+
+  def rm_generated_purchase_files
+    puts "#####################################################"
+    puts "Removing generated files:"
+    generated_files = %W{
+      app/helpers/purchases_helper.rb
+      app/models/purchase.rb
+      app/controllers/purchases_controller.rb
+      app/views/purchases
+      db/migrate/#{purchase_migration_version}_create_purchases.rb
+      spec/models/purchase_spec.rb
+      spec/helpers/purchases_helper_spec.rb
+      spec/controllers/purchases_controller_spec.rb
+      spec/controllers/purchases_routing_spec.rb
+      spec/fixtures/purchases.yml
+      spec/views/purchases
+    }
+    generated_files.each do |file|
+      rm_rf file
+    end
+    puts "#####################################################"
+  end
+  
+  def generate_login_controller
+    generator = "ruby script/generate rspec_controller login signup login logout --force"
+    notice = <<-EOF
+    #####################################################
+    #{generator}
+    #####################################################
+    EOF
+    puts notice.gsub(/^    /, '')
+    result = silent_sh(generator)
+    if error_code? || result =~ /not/
+      raise "rspec_scaffold failed. #{result}"
+    end
+  end
+
+  def rm_generated_login_controller_files
+    puts "#####################################################"
+    puts "Removing generated files:"
+    generated_files = %W{
+      app/helpers/login_helper.rb
+      app/controllers/login_controller.rb
+      app/views/login
+      spec/helpers/login_helper_spec.rb
+      spec/controllers/login_controller_spec.rb
+      spec/views/login
+    }
+    generated_files.each do |file|
+      rm_rf file
+    end
+    puts "#####################################################"
+  end
+
+  def install_dependencies
+    VENDOR_DEPS.each do |dep|
+      puts "\nChecking for #{dep[:name]} ..."
+      dest = dep[:checkout_path]
+      if File.exists?(dest)
+        puts "#{dep[:name]} already installed"
+      else
+        cmd = "svn co #{dep[:url]} #{dest}"
+        puts "Installing #{dep[:name]}"
+        puts "This may take a while."
+        puts cmd
+        system(cmd)
+        puts "Done!"
+      end
+    end
+    puts
+  end
+
+  def check_dependencies
+    VENDOR_DEPS.each do |dep|
+      unless File.exist?(dep[:checkout_path])
+        raise "There is no checkout of #{dep[:checkout_path]}. Please run rake install_dependencies"
+      end
+      # Verify that the current working copy is right
+      if `svn info #{dep[:checkout_path]}` =~ /^URL: (.*)/
+        actual_url = $1
+        if actual_url != dep[:url]
+          raise "Your working copy in #{dep[:checkout_path]} points to \n#{actual_url}\nIt has moved to\n#{dep[:url]}\nPlease delete the working copy and run rake install_dependencies"
+        end
+      end
+    end
+  end
+  
+  def update_dependencies
+    check_dependencies
+    VENDOR_DEPS.each do |dep|
+      next if dep[:tagged?] #
+      puts "\nUpdating #{dep[:name]} ..."
+      dest = dep[:checkout_path]
+      system("svn cleanup #{dest}")
+      cmd = "svn up #{dest}"
+      puts cmd
+      system(cmd)
+      puts "Done!"
+    end
+  end
+
+  VENDOR_DEPS = [
+    {
+      :checkout_path => "vendor/rails/2.0.2",
+      :name =>  "rails 2.0.2",
+      :url => "http://dev.rubyonrails.org/svn/rails/tags/rel_2-0-2",
+      :tagged? => true
+    },
+    {
+      :checkout_path => "vendor/rails/1.2.6",
+      :name =>  "rails 1.2.6",
+      :url => "http://dev.rubyonrails.org/svn/rails/tags/rel_1-2-6",
+      :tagged? => true
+    },
+    {
+      :checkout_path => "vendor/rails/1.2.3",
+      :name =>  "rails 1.2.3",
+      :url => "http://dev.rubyonrails.org/svn/rails/tags/rel_1-2-3",
+      :tagged? => true
+    },
+    {
+      :checkout_path => "vendor/rails/edge",
+      :name =>  "edge rails",
+      :url => "http://svn.rubyonrails.org/rails/trunk",
+      :tagged? => false
+    }
+  ]
+end