@@ -12,20 +12,37 @@ This project is for RSpec developers/contributors. git clone git://github.com/dchelimsky/rspec-dev.git cd rspec-dev + cp repos.yml.sample repos.yml + +Take a look at repos.yml, which is used to configure all of the other git +repositories that you'll need to do rspec-rails development. The sample file +is configured to point to public github urls for each repository. If you have +forks of any of the repos, or if you are an rspec core committer, change the +urls accordingly so that you'll be able to seamlessly push to github. + +Once that's confifigured: + rake git:update -== RUNNING EXAMPLES: +== RUNNING SPECS: + +In order to run RSpec's full suite of specs (rake pre_commit) you must install +the following gems: + +* cucumber # BDD framework for automating scenarios +* diff-lcs # Required if you use the --diff switch +* flexmock # Mocking/stubbing framework +* heckle # Required if you use the --heckle switch +* hoe # Required in order to make releases at RubyForge +* mocha # Mocking/stubbing framework +* nokogiri # Used for parsing HTML from the HTML output formatter in RSpec's own specs +* rake # Runs the build script +* rcov # Verifies that the code is 100% covered by specs +* rr # Mocking/stubbing framework -In order to run RSpec's full suite of examples (rake pre_commit) you must install the following gems: +If you're on windows, you'll also need: -* rake # Runs the build script -* rcov # Verifies that the code is 100% covered by specs -* syntax # Required to highlight ruby code -* diff-lcs # Required if you use the --diff switch * win32console # Required by the --colour switch if you're on Windows -* hoe # Required in order to make releases at RubyForge -* heckle # Required if you use the --heckle switch -* hpricot # Used for parsing HTML from the HTML output formatter in RSpec's own specs You can easily install all gems by using geminstaller. @@ -36,12 +53,16 @@ You can easily install all gems by using geminstaller. Once those are all installed, you should be able to run the suite with the following steps: cd /path/to/rspec-dev - rake install_dependencies cd example_rails_app - export RSPEC_RAILS_VERSION=2.1.0 + export RSPEC_RAILS_VERSION=2.3.2 rake rspec:generate_sqlite3_config cd .. rake pre_commit + +The rake pre_commit command runs all the specs and cucumber scenarios for +rspec, and then for rspec-rails. The rspec-rails specs are run against all of +the supported versions of rails defined in +pre_commit/lib/pre_commit/rspec-rails.rb, near the top. Note that RSpec itself - once built - doesn't have any dependencies outside the Ruby core and stdlib - with a few exceptions: README.txt @@ -76,16 +76,6 @@ if git.repos_fetched? rm_rf 'doc/output' end - desc "Installs dependencies for development environment" - task :install_dependencies do - pre_commit.install_dependencies - end - - desc "Updates dependencies for development environment" - task :update_dependencies do - pre_commit.update_dependencies - end - desc "Build the website, but do not publish it" task(:website) {core.website} @@ -117,14 +107,11 @@ if git.repos_fetched? git.add_remotes end end +else + puts "Missing repos - check repos.yml and run 'rake git:update'" + puts YAML.dump(git.repos) end -# desc "Run all specs and store html output in doc/output/report.html" -# Spec::Rake::SpecTask.new('spec_html') do |t| -# t.spec_files = FileList['spec/**/*_spec.rb'] -# t.spec_opts = ['--format html:../../../../doc/output/report.html', '--format progress','--backtrace'] -# end - def assign_version ENV["VERSION"] or abort "Must supply VERSION=x.y.z" end Rakefile @@ -9,16 +9,6 @@ task :pre_commit do tasks.pre_commit end -desc "Installs several versions of rails to run specs against" -task :install_dependencies do - tasks.install_dependencies -end - -desc "Updates the rails checkouts to run specs against" -task :update_dependencies do - tasks.update_dependencies -end - def tasks PreCommit::RspecOnRails.new(self) end \ No newline at end of file example_rails_app/Multirails.rake @@ -92,7 +92,13 @@ module RSpec end end - private + def repos + @yaml ||= YAML.load_file(File.join(File.dirname(__FILE__), "/../../repos.yml")) + @yaml[:repos] + end + + private + def check_for_clean_repos(message) unless all_repos_clean? puts "*** #{message} ***" @@ -111,11 +117,6 @@ module RSpec end end - def repos - @yaml = YAML.load_file(File.join(File.dirname(__FILE__), "/../../repos.yml")) - @yaml[:repos] - end - def subprojects [ {:name => "TextMate Bundle", :path => 'RSpec.tmbundle', lib/rspec/git.rb @@ -305,32 +305,13 @@ class PreCommit::RspecOnRails < PreCommit files.each {|file| rm_rf file} end - def install_dependencies - if File.exist?("#{RSPEC_DEV_ROOT}/example_rails_app/vendor/rails/.git") - puts "Rails is already installed" - else - if File.exist?("#{RSPEC_DEV_ROOT}/example_rails_app/vendor/rails") - sh "rm -rf #{RSPEC_DEV_ROOT}/example_rails_app/vendor/rails" - end - Dir.chdir "#{RSPEC_DEV_ROOT}/example_rails_app/vendor" do - puts "cloning rails - this might take a while" - sh "git clone git://github.com/rails/rails.git" - end - end - end - def check_dependencies - unless File.exist?("#{RSPEC_DEV_ROOT}/example_rails_app/vendor/rails/.git") - raise "Rails is not installed. Please run 'rake install_dependencies'" + ['plugins/rspec/.git','plugins/rspec-rails/.git','rails/.git'].each do |dep| + unless File.exist?("#{RSPEC_DEV_ROOT}/example_rails_app/vendor/#{dep}") + name = dep.sub(/\/\.git/,'').split('/').last + raise "#{name} is not installed. Please run 'rake git:update'" + end end end - def update_dependencies - check_dependencies - Dir.chdir "#{RSPEC_DEV_ROOT}/example_rails_app/vendor/rails" do - sh "git checkout master" - sh "git pull" - end - end - end pre_commit/lib/pre_commit/rspec-rails.rb @@ -84,18 +84,6 @@ class PreCommit::Rspec < PreCommit end end - def install_dependencies - Dir.chdir "#{RSPEC_DEV_ROOT}/example_rails_app" do - rake_sh("-f Multirails.rake install_dependencies") - end - end - - def update_dependencies - Dir.chdir "#{RSPEC_DEV_ROOT}/example_rails_app" do - rake_sh("-f Multirails.rake update_dependencies") - end - end - def pre_commit_rails Dir.chdir "#{RSPEC_DEV_ROOT}/example_rails_app" do rake = (RUBY_PLATFORM == "i386-mswin32") ? "rake.cmd" : "rake" pre_commit/lib/pre_commit/rspec.rb 86da61f0f26feda5c296a92fd97b14a11ec0a38d David Chelimsky dchelimsky@gmail.com http://github.com/dchelimsky/rspec-dev/commit/e9c6b4ae555ddda67f4ba70acea21aed0a2d1158 e9c6b4ae555ddda67f4ba70acea21aed0a2d1158 2009-06-24T21:25:38-07:00 2009-06-24T21:25:38-07:00 remove obsolete stuff and update readme 28e7fea5c53d51ee7f4c401cd14c567e8c6b1ac1 David Chelimsky dchelimsky@gmail.com