app/views/sessions/new.html.erb app/views/users/_user_bar.html.erb app/views/users/new.html.erb config/initializers/site_keys.rb lib/authenticated_test_helper.rb script/autospec script/dbconsole spec/fixtures/users.yml spec/helpers/users_helper_spec.rb stories/all.rb stories/helper.rb stories/rest_auth_stories.rb stories/rest_auth_stories_helper.rb stories/steps/ra_navigation_steps.rb stories/steps/ra_resource_steps.rb stories/steps/ra_response_steps.rb stories/steps/user_steps.rb stories/users/accounts.story stories/users/sessions.story vendor/plugins/model_stubbing/init.rb vendor/plugins/restful_authentication/.gitignore vendor/plugins/restful_authentication/CHANGELOG vendor/plugins/restful_authentication/README.textile vendor/plugins/restful_authentication/TODO vendor/plugins/restful_authentication/generators/authenticated/lib/insert_routes.rb vendor/plugins/restful_authentication/generators/authenticated/templates/_model_partial.html.erb vendor/plugins/restful_authentication/generators/authenticated/templates/activation.erb vendor/plugins/restful_authentication/generators/authenticated/templates/login.html.erb vendor/plugins/restful_authentication/generators/authenticated/templates/model_helper_spec.rb vendor/plugins/restful_authentication/generators/authenticated/templates/signup.html.erb vendor/plugins/restful_authentication/generators/authenticated/templates/signup_notification.erb vendor/plugins/restful_authentication/generators/authenticated/templates/site_keys.rb vendor/plugins/restful_authentication/generators/authenticated/templates/spec/controllers/access_control_spec.rb vendor/plugins/restful_authentication/generators/authenticated/templates/spec/controllers/authenticated_system_spec.rb vendor/plugins/restful_authentication/generators/authenticated/templates/spec/controllers/sessions_controller_spec.rb vendor/plugins/restful_authentication/generators/authenticated/templates/spec/controllers/users_controller_spec.rb vendor/plugins/restful_authentication/generators/authenticated/templates/spec/fixtures/users.yml vendor/plugins/restful_authentication/generators/authenticated/templates/spec/helpers/users_helper_spec.rb vendor/plugins/restful_authentication/generators/authenticated/templates/spec/models/user_spec.rb vendor/plugins/restful_authentication/generators/authenticated/templates/stories/rest_auth_stories.rb vendor/plugins/restful_authentication/generators/authenticated/templates/stories/rest_auth_stories_helper.rb vendor/plugins/restful_authentication/generators/authenticated/templates/stories/steps/ra_navigation_steps.rb vendor/plugins/restful_authentication/generators/authenticated/templates/stories/steps/ra_resource_steps.rb vendor/plugins/restful_authentication/generators/authenticated/templates/stories/steps/ra_response_steps.rb vendor/plugins/restful_authentication/generators/authenticated/templates/stories/steps/user_steps.rb vendor/plugins/restful_authentication/generators/authenticated/templates/stories/users/accounts.story vendor/plugins/restful_authentication/generators/authenticated/templates/stories/users/sessions.story vendor/plugins/restful_authentication/generators/authenticated/templates/test/functional_test.rb vendor/plugins/restful_authentication/generators/authenticated/templates/test/mailer_test.rb vendor/plugins/restful_authentication/generators/authenticated/templates/test/model_functional_test.rb vendor/plugins/restful_authentication/generators/authenticated/templates/test/unit_test.rb vendor/plugins/restful_authentication/init.rb vendor/plugins/restful_authentication/lib/authentication.rb vendor/plugins/restful_authentication/lib/authentication/by_cookie_token.rb vendor/plugins/restful_authentication/lib/authentication/by_password.rb vendor/plugins/restful_authentication/lib/authorization.rb vendor/plugins/restful_authentication/lib/authorization/aasm_roles.rb vendor/plugins/restful_authentication/lib/authorization/stateful_roles.rb vendor/plugins/restful_authentication/lib/trustification.rb vendor/plugins/restful_authentication/lib/trustification/email_validation.rb vendor/plugins/restful_authentication/notes/AccessControl.txt vendor/plugins/restful_authentication/notes/Authentication.txt vendor/plugins/restful_authentication/notes/Authorization.txt vendor/plugins/restful_authentication/notes/RailsPlugins.txt vendor/plugins/restful_authentication/notes/SecurityFramework.graffle vendor/plugins/restful_authentication/notes/SecurityFramework.png vendor/plugins/restful_authentication/notes/SecurityPatterns.txt vendor/plugins/restful_authentication/notes/Tradeoffs.txt vendor/plugins/restful_authentication/notes/Trustification.txt vendor/plugins/restful_authentication/tasks/auth.rake vendor/plugins/rspec-rails/generators/rspec/templates/script/autospec vendor/plugins/rspec-rails/generators/rspec_default_values.rb vendor/plugins/rspec-rails/lib/spec/rails/interop/testcase.rb vendor/plugins/rspec-rails/spec/rails/interop/testcase_spec.rb vendor/plugins/rspec-rails/spec/rails/matchers/render_template_spec.rb vendor/plugins/rspec-rails/spec_resources/views/layouts/application.rhtml vendor/plugins/rspec-rails/spec_resources/views/layouts/simple.rhtml vendor/plugins/rspec-rails/spec_resources/views/objects/_object.html.erb vendor/plugins/rspec-rails/spec_resources/views/render_spec/action_with_alternate_layout.rhtml vendor/plugins/rspec-rails/spec_resources/views/view_spec/block_helper.rhtml vendor/plugins/rspec-rails/spec_resources/views/view_spec/should_not_receive.rhtml vendor/plugins/rspec/examples/pure/yielding_example.rb vendor/plugins/rspec/lib/spec/runner/formatter/story/progress_bar_formatter.rb vendor/plugins/rspec/spec/spec/example/base_formatter_spec.rb vendor/plugins/rspec/spec/spec/mocks/bug_report_496.rb vendor/plugins/rspec/spec/spec/runner/formatter/story/progress_bar_formatter_spec.rb vendor/plugins/will_paginate/.gitignore vendor/plugins/will_paginate/.manifest vendor/plugins/will_paginate/CHANGELOG.rdoc vendor/plugins/will_paginate/README.rdoc vendor/plugins/will_paginate/examples/apple-circle.gif vendor/plugins/will_paginate/examples/index.haml vendor/plugins/will_paginate/examples/index.html vendor/plugins/will_paginate/examples/pagination.css vendor/plugins/will_paginate/examples/pagination.sass vendor/plugins/will_paginate/lib/will_paginate/array.rb vendor/plugins/will_paginate/lib/will_paginate/named_scope.rb vendor/plugins/will_paginate/lib/will_paginate/named_scope_patch.rb vendor/plugins/will_paginate/lib/will_paginate/version.rb vendor/plugins/will_paginate/test/collection_test.rb vendor/plugins/will_paginate/test/database.yml vendor/plugins/will_paginate/test/lib/view_test_process.rb vendor/plugins/will_paginate/test/tasks.rake vendor/plugins/will_paginate/test/view_test.rb vendor/plugins/will_paginate/will_paginate.gemspec @@ -6,7 +6,7 @@ module ApplicationHelper end def pagination(collection) - if collection.page_count > 1 + if collection.total_entries > 1 "<p class='pages'>" + 'Pages'[:pages_title] + ": <strong>" + will_paginate(collection, :inner_window => 10, :next_label => "next"[], :prev_label => "previous"[]) + "</strong></p>" @@ -14,7 +14,7 @@ module ApplicationHelper end def next_page(collection) - unless collection.current_page == collection.page_count or collection.page_count == 0 + unless collection.current_page == collection.total_entries or collection.total_entries == 0 "<p style='float:right;'>" + link_to("Next page"[], { :page => collection.current_page.next }.merge(params.reject{|k,v| k=="page"})) + "</p>" end end app/helpers/application_helper.rb @@ -1,15 +1,104 @@ module UsersHelper - def user_count pluralize current_site.users.size, 'user'[:user] end - + def active_user_count pluralize current_site.users.count('users.posts_count > 0'), 'active user'[:active_user] end - + def lurking_user_count pluralize current_site.users.count('users.posts_count = 0'), 'lurking user'[:lurking_user] end + + # + # Use this to wrap view elements that the user can't access. + # !! Note: this is an *interface*, not *security* feature !! + # You need to do all access control at the controller level. + # + # Example: + # <%= if_authorized?(:index, User) do link_to('List all users', users_path) end %> | + # <%= if_authorized?(:edit, @user) do link_to('Edit this user', edit_user_path) end %> | + # <%= if_authorized?(:destroy, @user) do link_to 'Destroy', @user, :confirm => 'Are you sure?', :method => :delete end %> + # + # + def if_authorized?(action, resource, &block) + if authorized?(action, resource) + yield action, resource + end + end + + # + # Link to user's page ('users/1') + # + # By default, their login is used as link text and link title (tooltip) + # + # Takes options + # * :content_text => 'Content text in place of user.login', escaped with + # the standard h() function. + # * :content_method => :user_instance_method_to_call_for_content_text + # * :title_method => :user_instance_method_to_call_for_title_attribute + # * as well as link_to()'s standard options + # + # Examples: + # link_to_user @user + # # => <a href="/users/3" title="barmy">barmy</a> + # + # # if you've added a .name attribute: + # content_tag :span, :class => :vcard do + # (link_to_user user, :class => 'fn n', :title_method => :login, :content_method => :name) + + # ': ' + (content_tag :span, user.email, :class => 'email') + # end + # # => <span class="vcard"><a href="/users/3" title="barmy" class="fn n">Cyril Fotheringay-Phipps</a>: <span class="email">barmy@blandings.com</span></span> + # + # link_to_user @user, :content_text => 'Your user page' + # # => <a href="/users/3" title="barmy" class="nickname">Your user page</a> + # + def link_to_user(user, options={}) + raise "Invalid user" unless user + options.reverse_merge! :content_method => :login, :title_method => :login, :class => :nickname + content_text = options.delete(:content_text) + content_text ||= user.send(options.delete(:content_method)) + options[:title] ||= user.send(options.delete(:title_method)) + link_to h(content_text), user_path(user), options + end + + # + # Link to login page using remote ip address as link content + # + # The :title (and thus, tooltip) is set to the IP address + # + # Examples: + # link_to_login_with_IP + # # => <a href="/login" title="169.69.69.69">169.69.69.69</a> + # + # link_to_login_with_IP :content_text => 'not signed in' + # # => <a href="/login" title="169.69.69.69">not signed in</a> + # + def link_to_login_with_IP content_text=nil, options={} + ip_addr = request.remote_ip + content_text ||= ip_addr + options.reverse_merge! :title => ip_addr + if tag = options.delete(:tag) + content_tag tag, h(content_text), options + else + link_to h(content_text), login_path, options + end + end + + # + # Link to the current user's page (using link_to_user) or to the login page + # (using link_to_login_with_IP). + # + def link_to_current_user(options={}) + if current_user + link_to_user current_user, options + else + content_text = options.delete(:content_text) || 'not signed in' + # kill ignored options from link_to_user + [:content_method, :title_method].each{|opt| options.delete(opt)} + link_to_login_with_IP content_text, options + end + end -end \ No newline at end of file +end app/helpers/users_helper.rb @@ -1,4 +1,8 @@ class User < ActiveRecord::Base + #include Authentication + # include Authentication::ByPassword + # include Authentication::ByCookieToken + concerned_with :validation, :states, :activation, :posting formats_attributes :bio app/models/user.rb @@ -35,11 +35,11 @@ <%= '{count} post(s)'[(count=@forum.posts.size)==1 ? :post_count : :posts_count, number_with_delimiter(count)] %> </p> -<% if @topics.page_count > 1 -%> +<% if @topics.total_entries > 1 -%> <% if logged_in? %> <p style="float:right; margin-top:0;"><%= link_to 'New topic'[], new_topic_path(@forum), :class => "utility" %></p> <% end %> -<%= pagination @topics %> +<%= will_paginate @topics %> <% end -%> <table border="0" cellspacing="0" cellpadding="0" class="wide topics"> @@ -88,8 +88,7 @@ <% end %> </table> -<%= next_page @topics %> -<%= pagination @topics %> +<%= will_paginate @topics %> <% if logged_in? %> <p><%= link_to 'New topic'[:new_topic], new_forum_topic_path(@forum), :class => "utility" %></p> app/views/forums/show.html.erb @@ -24,9 +24,8 @@ module Rails File.exist?("#{RAILS_ROOT}/vendor/rails") end - # FIXME : Ruby 1.9 def preinitialize - load(preinitializer_path) if File.exists?(preinitializer_path) + load(preinitializer_path) if File.exist?(preinitializer_path) end def preinitializer_path @@ -44,6 +43,7 @@ module Rails class VendorBoot < Boot def load_initializer require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer" + Rails::Initializer.run(:install_gem_spec_stubs) end end @@ -82,14 +82,14 @@ module Rails def load_rubygems require 'rubygems' - - unless rubygems_version >= '0.9.4' - $stderr.puts %(Rails requires RubyGems >= 0.9.4 (you have #{rubygems_version}). Please `gem update --system` and try again.) + min_version = '1.1.1' + unless rubygems_version >= min_version + $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.) exit 1 end rescue LoadError - $stderr.puts %(Rails requires RubyGems >= 0.9.4. Please install RubyGems and try again: http://rubygems.rubyforge.org) + $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org) exit 1 end config/boot.rb @@ -5,7 +5,7 @@ # ENV['RAILS_ENV'] ||= 'production' # Specifies gem version of Rails to use when vendor/rails is not present -RAILS_GEM_VERSION = '2.0.2' unless defined? RAILS_GEM_VERSION +RAILS_GEM_VERSION = '2.1.1' unless defined? RAILS_GEM_VERSION # Bootstrap the Rails environment, frameworks, and default configuration require File.join(File.dirname(__FILE__), 'boot') config/environment.rb @@ -12,7 +12,6 @@ config.whiny_nils = true config.action_controller.consider_all_requests_local = true config.action_view.debug_rjs = true config.action_controller.perform_caching = false -config.action_view.cache_template_extensions = false # Don't care if the mailer can't send config.action_mailer.raise_delivery_errors = false \ No newline at end of file config/environments/development.rb @@ -1,4 +1,6 @@ ActionController::Routing::Routes.draw do |map| + map.resource :session + map.resources :sites, :moderatorships map.resources :forums, :has_many => :posts do |forum| config/routes.rb @@ -1,5 +1,5 @@ # This file is auto-generated from the current state of the database. Instead of editing this file, -# please use the migrations feature of ActiveRecord to incrementally modify your database, and +# please use the migrations feature of Active Record to incrementally modify your database, and # then regenerate this schema definition. # # Note that this schema.rb definition is the authoritative source for your database schema. If you need db/schema.rb @@ -3,36 +3,37 @@ module AuthenticatedSystem def current_site @current_site ||= Site.find_by_host(request.host) or raise Site::UndefinedError end - + # Returns true or false if the user is logged in. # Preloads @current_user with the user model if they're logged in. def logged_in? - current_user != :false + !!current_user end - - # Accesses the current user from the session. Set it to :false if login fails - # so that future calls do not hit the database. + + # Accesses the current user from the session. + # Future calls avoid the database because nil is not equal to false. def current_user - @current_user ||= (login_from_session || login_from_basic_auth || login_from_cookie || :false) + @current_user ||= (login_from_session || login_from_basic_auth || login_from_cookie) unless @current_user == false end - - # Store the given user in the session. + + # Store the given user id in the session. def current_user=(new_user) - session[:user] = (new_user.nil? || new_user.is_a?(Symbol)) ? nil : new_user.id - @current_user = new_user + session[:user_id] = new_user ? new_user.id : nil + @current_user = new_user || false end - + def admin? logged_in? && current_user.admin? end def moderator_of?(record) - return true if admin? + return true if admin? return false unless logged_in? forum = record.respond_to?(:forum) ? record.forum : record current_user.moderator_of? forum end - + + # Check if the user is authorized # # Override this method in your controllers if you want to restrict access @@ -45,8 +46,9 @@ module AuthenticatedSystem # def authorized? # current_user.login != "bob" # end - def authorized? - true + # + def authorized?(action = action_name, resource = nil) + logged_in? end # Filter method to enforce a login requirement. @@ -64,9 +66,9 @@ module AuthenticatedSystem # skip_before_filter :login_required # def login_required - (logged_in? && authorized?) || access_denied + authorized? || access_denied end - + def admin_required admin? || access_denied end @@ -80,67 +82,128 @@ module AuthenticatedSystem # to access the requested action. For example, a popup window might # simply close itself. def access_denied - respond_to do |accepts| - accepts.html do + respond_to do |format| + format.html do store_location - redirect_to :controller => '/sessions', :action => 'new' + redirect_to new_session_path end - accepts.xml do - headers["Status"] = "Unauthorized" - headers["WWW-Authenticate"] = %(Basic realm="Web Password") - render :text => "Could't authenticate you", :status => '401 Unauthorized' + # format.any doesn't work in rails version < http://dev.rubyonrails.org/changeset/8987 + # Add any other API formats here. (Some browsers, notably IE6, send Accept: */* and trigger + # the 'format.any' block incorrectly. See http://bit.ly/ie6_borken or http://bit.ly/ie6_borken2 + # for a workaround.) + format.any(:json, :xml) do + request_http_basic_authentication 'Web Password' end end - false - end - + end + # Store the URI of the current request in the session. # # We can return to this location by calling #redirect_back_or_default. def store_location session[:return_to] = request.request_uri end - + # Redirect to the URI stored by the most recent store_location call or - # to the passed default. + # to the passed default. Set an appropriately modified + # after_filter :store_location, :only => [:index, :new, :show, :edit] + # for any controller you want to be bounce-backable. def redirect_back_or_default(default) redirect_to(session[:return_to] || default) session[:return_to] = nil end - + # Inclusion hook to make #current_user and #logged_in? # available as ActionView helper methods. def self.included(base) - base.send :helper_method, :current_user, :logged_in?, :current_site, :admin?, :moderator_of? + base.send :helper_method, :current_user, :logged_in?, :current_site, :admin?, :moderator_of? if base.respond_to? :helper_method end + # + # Login + # + # Called from #current_user. First attempt to login by the user id stored in the session. def login_from_session - self.current_user = current_site.users.find_by_id(session[:user]) if session[:user] + self.current_user = User.find_by_id(session[:user_id]) if session[:user_id] end # Called from #current_user. Now, attempt to login by basic authentication information. def login_from_basic_auth - username, passwd = get_auth_data - self.current_user = current_site.users.authenticate(username, passwd) if username && passwd + authenticate_with_http_basic do |login, password| + self.current_user = User.authenticate(login, password) + end end + + # + # Logout + # # Called from #current_user. Finaly, attempt to login by an expiring token in the cookie. + # for the paranoid: we _should_ be storing user_token = hash(cookie_token, request IP) def login_from_cookie - user = cookies[:auth_token] && current_site.users.find_by_remember_token(cookies[:auth_token]) + user = cookies[:auth_token] && User.find_by_remember_token(cookies[:auth_token]) if user && user.remember_token? - user.remember_me - cookies[:auth_token] = { :value => user.remember_token, :expires => user.remember_token_expires_at } self.current_user = user + handle_remember_cookie! false # freshen cookie token (keeping date) + self.current_user end end - private - @@http_auth_headers = %w(X-HTTP_AUTHORIZATION HTTP_AUTHORIZATION Authorization) - # gets BASIC auth info - def get_auth_data - auth_key = @@http_auth_headers.detect { |h| request.env.has_key?(h) } - auth_data = request.env[auth_key].to_s.split unless auth_key.blank? - return auth_data && auth_data[0] == 'Basic' ? Base64.decode64(auth_data[1]).split(':')[0..1] : [nil, nil] + # This is ususally what you want; resetting the session willy-nilly wreaks + # havoc with forgery protection, and is only strictly necessary on login. + # However, **all session state variables should be unset here**. + def logout_keeping_session! + # Kill server-side auth cookie + @current_user.forget_me if @current_user.is_a? User + @current_user = false # not logged in, and don't do it for me + kill_remember_cookie! # Kill client-side auth cookie + session[:user_id] = nil # keeps the session but kill our variable + # explicitly kill any other session variables you set end + + # The session should only be reset at the tail end of a form POST -- + # otherwise the request forgery protection fails. It's only really necessary + # when you cross quarantine (logged-out to logged-in). + def logout_killing_session! + logout_keeping_session! + reset_session + end + + # + # Remember_me Tokens + # + # Cookies shouldn't be allowed to persist past their freshness date, + # and they should be changed at each login + + # Cookies shouldn't be allowed to persist past their freshness date, + # and they should be changed at each login + + def valid_remember_cookie? + return nil unless @current_user + (@current_user.remember_token?) && + (cookies[:auth_token] == @current_user.remember_token) + end + + # Refresh the cookie auth token if it exists, create it otherwise + def handle_remember_cookie!(new_cookie_flag) + return unless @current_user + case + when valid_remember_cookie? then @current_user.refresh_token # keeping same expiry date + when new_cookie_flag then @current_user.remember_me + else @current_user.forget_me + end + send_remember_cookie! + end + + def kill_remember_cookie! + cookies.delete :auth_token + end + + def send_remember_cookie! + cookies[:auth_token] = { + :value => @current_user.remember_token, + :expires => @current_user.remember_token_expires_at } + end + end lib/authenticated_system.rb @@ -1,4 +1,4 @@ -// Copyright (c) 2005-2007 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us) +// Copyright (c) 2005-2008 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us) // (c) 2005-2007 Ivan Krstic (http://blogs.law.harvard.edu/ivan) // (c) 2005-2007 Jon Tirsen (http://www.tirsen.com) // Contributors: public/javascripts/controls.js @@ -1,4 +1,4 @@ -// Copyright (c) 2005-2007 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us) +// Copyright (c) 2005-2008 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us) // (c) 2005-2007 Sammi Williams (http://www.oriontransfer.co.nz, sammi@oriontransfer.co.nz) // // script.aculo.us is freely distributable under the terms of an MIT-style license. public/javascripts/dragdrop.js @@ -1,4 +1,4 @@ -// Copyright (c) 2005-2007 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us) +// Copyright (c) 2005-2008 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us) // Contributors: // Justin Palmer (http://encytemedia.com/) // Mark Pilgrim (http://diveintomark.org/) public/javascripts/effects.js @@ -1,5 +1,4 @@ #!/usr/bin/env ruby -$LOAD_PATH.unshift File.dirname(__FILE__) + '/../../rspec/lib' # For svn $LOAD_PATH.unshift File.dirname(__FILE__) + '/../vendor/plugins/rspec/lib' # For rspec installed as plugin require 'rubygems' require 'drb/drb' @@ -23,17 +22,29 @@ module Spec active_connections.delete(name) end end - end + end - if ::Dispatcher.respond_to?(:cleanup_application) - ::Dispatcher.cleanup_application + if ActionController.const_defined?(:Dispatcher) + dispatcher = ::ActionController::Dispatcher.new($stdout) + dispatcher.cleanup_application elsif ::Dispatcher.respond_to?(:reset_application!) ::Dispatcher.reset_application! + else + raise "Application reloading failed" + end + if Object.const_defined?(:Fixtures) && Fixtures.respond_to?(:reset_cache) + Fixtures.reset_cache end + ::Dependencies.mechanism = :load require_dependency('application.rb') unless Object.const_defined?(:ApplicationController) load File.dirname(__FILE__) + '/../spec/spec_helper.rb' + if in_memory_database? + load "#{RAILS_ROOT}/db/schema.rb" # use db agnostic schema by default + ActiveRecord::Migrator.up('db/migrate') # use migrations + end + ::Spec::Runner::CommandLine.run( ::Spec::Runner::OptionParser.parse( argv, @@ -42,6 +53,12 @@ module Spec ) ) end + + def in_memory_database? + ENV["RAILS_ENV"] == "test" and + ::ActiveRecord::Base.connection.class.to_s == "ActiveRecord::ConnectionAdapters::SQLite3Adapter" and + ::Rails::Configuration.new.database_configuration['test']['database'] == ':memory:' + end end end end @@ -88,7 +105,7 @@ opts.parse!(ARGV) puts "Ready" exec_server = lambda { trap("USR2") { restart_test_server } if Signal.list.has_key?("USR2") - DRb.start_service("druby://localhost:8989", Spec::Runner::RailsSpecServer.new) + DRb.start_service("druby://127.0.0.1:8989", Spec::Runner::RailsSpecServer.new) DRb.thread.join } script/spec_server @@ -21,7 +21,9 @@ describe ModeratorshipsController, "POST #create" do it_assigns :moderatorship, :flash => {:notice => nil, :error => :not_nil} it_redirects_to { user_path(users(:default)) } end - + +# Seriously, I could give a crap about XML. +=begin describe ModeratorshipsController, "(successful creation, xml)" do define_models act! { post :create, :moderatorship => @attributes, :format => 'xml' } @@ -41,6 +43,7 @@ describe ModeratorshipsController, "POST #create" do assigns(:moderatorship).errors.to_xml end end +=end end describe ModeratorshipsController, "DELETE #destroy" do spec/controllers/moderatorships_controller_spec.rb @@ -1,4 +1,5 @@ require File.dirname(__FILE__) + '/../spec_helper' +require 'model_stubbing' describe Forum do define_models do spec/models/forum_spec.rb @@ -7,10 +7,11 @@ require 'spec/rails' require 'rspec_on_rails_on_crack' require 'model_stubbing' require File.dirname(__FILE__) + "/model_stubs" -require 'ruby-debug' -Debugger.start +#require 'ruby-debug' +#Debugger.start Spec::Runner.configure do |config| + include AuthenticatedTestHelper config.use_transactional_fixtures = true config.use_instantiated_fixtures = false config.fixture_path = RAILS_ROOT + '/spec/fixtures/' @@ -18,13 +19,13 @@ Spec::Runner.configure do |config| def current_site(site) @controller.stub!(:current_site).and_return(@site = site ? sites(site) : nil) end - + # Sets the current user in the session from the user fixtures. - def login_as(user) - controller.stub!(:current_user).and_return(@user = user ? users(user) : nil) - end - - def authorize_as(user) - @request.env["HTTP_AUTHORIZATION"] = user ? "Basic #{Base64.encode64("#{users(user).login}:test")}" : nil - end -end \ No newline at end of file +# def login_as(user) + # controller.stub!(:current_user).and_return(@user = user ? users(user) : nil) + # end + + #def authorize_as(user) + # @request.env["HTTP_AUTHORIZATION"] = user ? "Basic #{Base64.encode64("#{users(user).login}:test")}" : nil + #end +end spec/spec_helper.rb @@ -50,7 +50,7 @@ module ModelStubbing # if options are given first, assume that base_name is default when Hash options = base_name - base_name = nil + base_name = self when nil else unless options[:copy] || block.nil? vendor/plugins/model_stubbing/lib/model_stubbing.rb @@ -115,7 +115,7 @@ module ModelStubbing ModelStubbing.records.clear ModelStubbing.stub_current_time_with(current_time) if current_time return unless database? - ActiveRecord::Base.send :increment_open_transactions + ActiveRecord::Base.connection.increment_open_transactions ActiveRecord::Base.connection.begin_db_transaction end vendor/plugins/model_stubbing/lib/model_stubbing/definition.rb @@ -2,7 +2,7 @@ module ModelStubbing # Models hold one or more stubs. class Model attr_accessor :name, :plural, :singular - attr_reader :definition, :stubs, :model_class, :options + attr_reader :definition, :stubs, :model_class, :options, :ordered_stubs # Creates a stub for this model. A stub with no name is assumed to be the default # stub. A global key for the definition is also created based on the singular @@ -17,13 +17,14 @@ module ModelStubbing end def initialize(definition, klass, options = {}, &block) - @definition = definition - @model_class = klass - @name = options.delete(:name) || default_name.to_sym - @plural = options.delete(:plural) || name - @singular = options.delete(:singular) || name.to_s.singularize - @options = options - @stubs = {} + @definition = definition + @model_class = klass + @name = options.delete(:name) || default_name.to_sym + @plural = options.delete(:plural) || name + @singular = options.delete(:singular) || name.to_s.singularize + @options = options + @stubs = {} + @ordered_stubs = [] unless @model_class.respond_to?(:mock_id) class << @model_class define_method :mock_id do @@ -92,7 +93,11 @@ module ModelStubbing def insert purge - @stubs.values.each &:insert + @ordered_stubs.each do |name| + if stub = @stubs[name] + stub.insert + end + end end def purge @@ -104,5 +109,19 @@ module ModelStubbing def connection @connection ||= model_class.respond_to?(:connection) && model_class.connection end + + protected + def method_missing(model_name, stub_name, *args) + named_model = @definition.models[model_name] + if named_model.nil? + raise "No #{model_name.inspect} model found when calling #{model_name}(#{stub_name})" + end + stub = named_model.stubs[stub_name] + if stub.nil? + raise "No #{stub_name.inspect} stub found in the #{model_name.inspect} model when calling #{model_name}(#{stub_name})" + else + stub + end + end end end \ No newline at end of file vendor/plugins/model_stubbing/lib/model_stubbing/model.rb @@ -19,6 +19,8 @@ module ModelStubbing end @global_key = (name == :default ? @model.singular : "#{name}_#{@model.singular}").to_sym + @model.ordered_stubs << name + @model.ordered_stubs.uniq! @model.all_stubs[@global_key] = @model.stubs[name] = self end @@ -39,7 +41,11 @@ module ModelStubbing # pass :id => :new to specify you want a new record, not one in the database def record(attributes = {}) this_record_key = record_key(attributes) - ModelStubbing.records[this_record_key] ||= instantiate(this_record_key, attributes) + if attributes[:id] != :new && ModelStubbing.records.key?(this_record_key) + ModelStubbing.records[this_record_key] + else + ModelStubbing.records[this_record_key] = instantiate(this_record_key, attributes) + end end def inspect @@ -157,7 +163,6 @@ module ModelStubbing def record_key(attributes) return @record_key if @record_key && attributes.empty? key = [model.model_class.name, @global_key, @attributes.merge(attributes).inspect] * ":" - key << model.model_class.base_class.mock_id.to_s if attributes[:id] == :new @record_key = key if attributes.empty? key end vendor/plugins/model_stubbing/lib/model_stubbing/stub.rb @@ -1,10 +1,9 @@ namespace :stubs do - desc "Load a ModelStubbing definition into the database. Specify Stub file with STUBS= and Definition with DEF=" task :load do root = File.dirname(__FILE__) + '/../../../../' require File.expand_path(root + "config/environment") - + begin require 'spec' rescue @@ -12,15 +11,10 @@ namespace :stubs do require 'spec' end require 'model_stubbing' - - # note to Rick: I've taken to using 'stubs.rb' instead of 'model_stubs.rb' - # because 'model_stubs' has a tab-completion collision with 'spec/models' and - # that drives me batty. Change the default to 'spec/model_stubs' if you want, - # you won't hurt my feelings. + require root + (ENV['STUBS'] || 'spec/stubs') defn = (ENV['DEF'] || 'default').intern ModelStubbing.definitions[defn].insert! end - end \ No newline at end of file vendor/plugins/model_stubbing/tasks/stubs.rake @@ -1 +1 @@ -./script/generate authenticated USERMODEL CONTROLLERNAME [--include-activation] [--stateful] [--rspec] \ No newline at end of file +./script/generate authenticated USERMODEL CONTROLLERNAME \ No newline at end of file vendor/plugins/restful_authentication/generators/authenticated/USAGE @@ -1,4 +1,11 @@ +require File.expand_path(File.dirname(__FILE__) + "/lib/insert_routes.rb") +require 'digest/sha1' class AuthenticatedGenerator < Rails::Generator::NamedBase + default_options :skip_migration => false, + :skip_routes => false, + :old_passwords => false, + :include_activation => false + attr_reader :controller_name, :controller_class_path, :controller_file_path, @@ -6,8 +13,11 @@ class AuthenticatedGenerator < Rails::Generator::NamedBase :controller_class_nesting_depth, :controller_class_name, :controller_singular_name, - :controller_plural_name - alias_method :controller_file_name, :controller_singular_name + :controller_plural_name, + :controller_routing_name, # new_session_path + :controller_routing_path, # /session/new + :controller_controller_name, # sessions + :controller_file_name alias_method :controller_table_name, :controller_plural_name attr_reader :model_controller_name, :model_controller_class_path, @@ -16,37 +26,52 @@ class AuthenticatedGenerator < Rails::Generator::NamedBase :model_controller_class_nesting_depth, :model_controller_class_name, :model_controller_singular_name, - :model_controller_plural_name + :model_controller_plural_name, + :model_controller_routing_name, # new_user_path + :model_controller_routing_path, # /users/new + :model_controller_controller_name # users alias_method :model_controller_file_name, :model_controller_singular_name alias_method :model_controller_table_name, :model_controller_plural_name def initialize(runtime_args, runtime_options = {}) super - + @rspec = has_rspec? - @controller_name = args.shift || 'sessions' + @controller_name = (args.shift || 'sessions').pluralize @model_controller_name = @name.pluralize # sessions controller base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name) - @controller_class_name_without_nesting, @controller_singular_name, @controller_plural_name = inflect_names(base_name) - + @controller_class_name_without_nesting, @controller_file_name, @controller_plural_name = inflect_names(base_name) + @controller_singular_name = @controller_file_name.singularize if @controller_class_nesting.empty? @controller_class_name = @controller_class_name_without_nesting else @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}" end + @controller_routing_name = @controller_singular_name + @controller_routing_path = @controller_file_path.singularize + @controller_controller_name = @controller_plural_name # model controller base_name, @model_controller_class_path, @model_controller_file_path, @model_controller_class_nesting, @model_controller_class_nesting_depth = extract_modules(@model_controller_name) @model_controller_class_name_without_nesting, @model_controller_singular_name, @model_controller_plural_name = inflect_names(base_name) - + if @model_controller_class_nesting.empty? @model_controller_class_name = @model_controller_class_name_without_nesting else @model_controller_class_name = "#{@model_controller_class_nesting}::#{@model_controller_class_name_without_nesting}" end + @model_controller_routing_name = @table_name + @model_controller_routing_path = @model_controller_file_path + @model_controller_controller_name = @model_controller_plural_name + + load_or_initialize_site_keys() + + if options[:dump_generator_attribute_names] + dump_generator_attribute_names + end end def manifest @@ -70,16 +95,21 @@ class AuthenticatedGenerator < Rails::Generator::NamedBase m.directory File.join('app/controllers', model_controller_class_path) m.directory File.join('app/helpers', model_controller_class_path) m.directory File.join('app/views', model_controller_class_path, model_controller_file_name) + m.directory File.join('config/initializers') if @rspec m.directory File.join('spec/controllers', controller_class_path) m.directory File.join('spec/controllers', model_controller_class_path) m.directory File.join('spec/models', class_path) + m.directory File.join('spec/helpers', model_controller_class_path) m.directory File.join('spec/fixtures', class_path) + m.directory File.join('stories', model_controller_file_path) + m.directory File.join('stories', 'steps') else m.directory File.join('test/functional', controller_class_path) m.directory File.join('test/functional', model_controller_class_path) m.directory File.join('test/unit', class_path) + m.directory File.join('test/fixtures', class_path) end m.template 'model.rb', @@ -111,40 +141,76 @@ class AuthenticatedGenerator < Rails::Generator::NamedBase m.template 'authenticated_test_helper.rb', File.join('lib', 'authenticated_test_helper.rb') + m.template 'site_keys.rb', site_keys_file + if @rspec - m.template 'functional_spec.rb', + # RSpec Specs + m.template 'spec/controllers/users_controller_spec.rb', + File.join('spec/controllers', + model_controller_class_path, + "#{model_controller_file_name}_controller_spec.rb") + m.template 'spec/controllers/sessions_controller_spec.rb', File.join('spec/controllers', controller_class_path, "#{controller_file_name}_controller_spec.rb") - m.template 'model_functional_spec.rb', + m.template 'spec/controllers/access_control_spec.rb', + File.join('spec/controllers', + controller_class_path, + "access_control_spec.rb") + m.template 'spec/controllers/authenticated_system_spec.rb', File.join('spec/controllers', + controller_class_path, + "authenticated_system_spec.rb") + m.template 'spec/helpers/users_helper_spec.rb', + File.join('spec/helpers', model_controller_class_path, - "#{model_controller_file_name}_controller_spec.rb") - m.template 'unit_spec.rb', + "#{table_name}_helper_spec.rb") + m.template 'spec/models/user_spec.rb', File.join('spec/models', class_path, "#{file_name}_spec.rb") - m.template 'fixtures.yml', + m.template 'spec/fixtures/users.yml', File.join('spec/fixtures', + class_path, "#{table_name}.yml") + + # RSpec Stories + m.template 'stories/steps/ra_navigation_steps.rb', + File.join('stories/steps/ra_navigation_steps.rb') + m.template 'stories/steps/ra_response_steps.rb', + File.join('stories/steps/ra_response_steps.rb') + m.template 'stories/steps/ra_resource_steps.rb', + File.join('stories/steps/ra_resource_steps.rb') + m.template 'stories/steps/user_steps.rb', + File.join('stories/steps/', "#{file_name}_steps.rb") + m.template 'stories/users/accounts.story', + File.join('stories', model_controller_file_path, 'accounts.story') + m.template 'stories/users/sessions.story', + File.join('stories', model_controller_file_path, 'sessions.story') + m.template 'stories/rest_auth_stories_helper.rb', + File.join('stories', 'rest_auth_stories_helper.rb') + m.template 'stories/rest_auth_stories.rb', + File.join('stories', 'rest_auth_stories.rb') + else - m.template 'functional_test.rb', + m.template 'test/functional_test.rb', File.join('test/functional', controller_class_path, "#{controller_file_name}_controller_test.rb") - m.template 'model_functional_test.rb', + m.template 'test/model_functional_test.rb', File.join('test/functional', model_controller_class_path, "#{model_controller_file_name}_controller_test.rb") - m.template 'unit_test.rb', + m.template 'test/unit_test.rb', File.join('test/unit', class_path, "#{file_name}_test.rb") if options[:include_activation] - m.template 'mailer_test.rb', File.join('test/unit', class_path, "#{file_name}_mailer_test.rb") + m.template 'test/mailer_test.rb', File.join('test/unit', class_path, "#{file_name}_mailer_test.rb") end - m.template 'fixtures.yml', + m.template 'spec/fixtures/users.yml', File.join('test/fixtures', + class_path, "#{table_name}.yml") end @@ -160,14 +226,15 @@ class AuthenticatedGenerator < Rails::Generator::NamedBase # Controller templates - m.template 'login.rhtml', File.join('app/views', controller_class_path, controller_file_name, "new.rhtml") - m.template 'signup.rhtml', File.join('app/views', model_controller_class_path, model_controller_file_name, "new.rhtml") + m.template 'login.html.erb', File.join('app/views', controller_class_path, controller_file_name, "new.html.erb") + m.template 'signup.html.erb', File.join('app/views', model_controller_class_path, model_controller_file_name, "new.html.erb") + m.template '_model_partial.html.erb', File.join('app/views', model_controller_class_path, model_controller_file_name, "_#{file_name}_bar.html.erb") if options[:include_activation] # Mailer templates %w( activation signup_notification ).each do |action| - m.template "#{action}.rhtml", - File.join('app/views', "#{file_name}_mailer", "#{action}.rhtml") + m.template "#{action}.erb", + File.join('app/views', "#{file_name}_mailer", "#{action}.erb") end end @@ -176,83 +243,236 @@ class AuthenticatedGenerator < Rails::Generator::NamedBase :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}" }, :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}" end + unless options[:skip_routes] + # Note that this fails for nested classes -- you're on your own with setting up the routes. + m.route_resource controller_singular_name + m.route_resources model_controller_plural_name + m.route_name('signup', '/signup', {:controller => model_controller_plural_name, :action => 'new'}) + m.route_name('register', '/register', {:controller => model_controller_plural_name, :action => 'create'}) + m.route_name('login', '/login', {:controller => controller_controller_name, :action => 'new'}) + m.route_name('logout', '/logout', {:controller => controller_controller_name, :action => 'destroy'}) + end end - action = nil - action = $0.split("/")[1] + # + # Post-install notes + # + action = File.basename($0) # grok the action from './script/generate' or whatever case action - when "generate" - puts - puts ("-" * 70) - puts "Don't forget to:" - puts - puts " - add restful routes in config/routes.rb" - puts " map.resources :#{model_controller_file_name}" - puts " map.resource :#{controller_singular_name.singularize}" - puts - puts " Rails 1.2.3 may need a :controller option for the singular resource:" - puts " - map.resource :#{controller_singular_name.singularize}, :controller => '#{controller_file_name}'" - puts - if options[:include_activation] - puts " map.activate '/activate/:activation_code', :controller => '#{model_controller_file_name}', :action => 'activate'" - puts - puts " - add an observer to config/environment.rb" - puts " config.active_record.observers = :#{file_name}_observer" - puts - end - if options[:stateful] - puts "Also, don't forget to install the acts_as_state_machine plugin!" - puts - puts " svn co http://elitists.textdriven.com/svn/plugins/acts_as_state_machine/trunk vendor/plugins/acts_as_state_machine" - puts - end - puts "Try these for some familiar login URLs if you like:" - puts - puts " map.signup '/signup', :controller => '#{model_controller_file_name}', :action => 'new'" - puts " map.login '/login', :controller => '#{controller_file_name}', :action => 'new'" - puts " map.logout '/logout', :controller => '#{controller_file_name}', :action => 'destroy'" - puts - puts ("-" * 70) - puts - when "destroy" - puts - puts ("-" * 70) - puts - puts "Thanks for using restful_authentication" - puts - puts "Don't forget to comment out the observer line in environment.rb" - puts " (This was optional so it may not even be there)" - puts " # config.active_record.observers = :#{file_name}_observer" - puts - puts ("-" * 70) - puts + when "generate" + puts "Ready to generate." + puts ("-" * 70) + puts "Once finished, don't forget to:" + puts + if options[:include_activation] + puts "- Add an observer to config/environment.rb" + puts " config.active_record.observers = :#{file_name}_observer" + end + if options[:aasm] + puts "- Install the acts_as_state_machine gem:" + puts " sudo gem sources -a http://gems.github.com (If you haven't already)" + puts " sudo gem install rubyist-aasm" + elsif options[:stateful] + puts "- Install the acts_as_state_machine plugin:" + puts " svn export http://elitists.textdriven.com/svn/plugins/acts_as_state_machine/trunk vendor/plugins/acts_as_state_machine" + end + puts "- Add routes to these resources. In config/routes.rb, insert routes like:" + puts %( map.signup '/signup', :controller => '#{model_controller_file_name}', :action => 'new') + puts %( map.login '/login', :controller => '#{controller_file_name}', :action => 'new') + puts %( map.logout '/logout', :controller => '#{controller_file_name}', :action => 'destroy') + if options[:include_activation] + puts %( map.activate '/activate/:activation_code', :controller => '#{model_controller_file_name}', :action => 'activate', :activation_code => nil) + end + if options[:stateful] + puts " and modify the map.resources :#{model_controller_file_name} line to include these actions:" + puts " map.resources :#{model_controller_file_name}, :member => { :suspend => :put, :unsuspend => :put, :purge => :delete }" + end + puts + puts ("-" * 70) + puts + if $rest_auth_site_key_from_generator.blank? + puts "You've set a nil site key. This preserves existing users' passwords," + puts "but allows dictionary attacks in the unlikely event your database is" + puts "compromised and your site code is not. See the README for more." + elsif $rest_auth_keys_are_new + puts "We've create a new site key in #{site_keys_file}. If you have existing" + puts "user accounts their passwords will no longer work (see README). As always," + puts "keep this file safe but don't post it in public." else - puts + puts "We've reused the existing site key in #{site_keys_file}. As always," + puts "keep this file safe but don't post it in public." + end + puts + puts ("-" * 70) + when "destroy" + puts + puts ("-" * 70) + puts + puts "Thanks for using restful_authentication" + puts + puts "Don't forget to comment out the observer line in environment.rb" + puts " (This was optional so it may not even be there)" + puts " # config.active_record.observers = :#{file_name}_observer" + puts + puts ("-" * 70) + puts + else + puts "Didn't understand the action '#{action}' -- you might have missed the 'after running me' instructions." end + # + # Do the thing + # recorded_session end def has_rspec? - options[:rspec] || (File.exist?('spec') && File.directory?('spec')) + spec_dir = File.join(RAILS_ROOT, 'spec') + options[:rspec] ||= (File.exist?(spec_dir) && File.directory?(spec_dir)) unless (options[:rspec] == false) end - - protected - # Override with your own usage banner. - def banner - "Usage: #{$0} authenticated ModelName [ControllerName]" + + # + # !! These must match the corresponding routines in by_password.rb !! + # + def secure_digest(*args) + Digest::SHA1.hexdigest(args.flatten.join('--')) + end + def make_token + secure_digest(Time.now, (1..10).map{ rand.to_s }) + end + def password_digest(password, salt) + digest = $rest_auth_site_key_from_generator + $rest_auth_digest_stretches_from_generator.times do + digest = secure_digest(digest, salt, password, $rest_auth_site_key_from_generator) end + digest + end - def add_options!(opt) - opt.separator '' - opt.separator 'Options:' - opt.on("--skip-migration", - "Don't generate a migration file for this model") { |v| options[:skip_migration] = v } - opt.on("--include-activation", - "Generate signup 'activation code' confirmation via email") { |v| options[:include_activation] = true } - opt.on("--stateful", - "Use acts_as_state_machine. Assumes --include-activation") { |v| options[:include_activation] = options[:stateful] = true } - opt.on("--rspec", - "Force rspec mode (checks for RAILS_ROOT/spec by default)") { |v| options[:rspec] = true } + # + # Try to be idempotent: + # pull in the existing site key if any, + # seed it with reasonable defaults otherwise + # + def load_or_initialize_site_keys + case + when defined? REST_AUTH_SITE_KEY + if (options[:old_passwords]) && ((! REST_AUTH_SITE_KEY.blank?) || (REST_AUTH_DIGEST_STRETCHES != 1)) + raise "You have a site key, but --old-passwords will overwrite it. If this is really what you want, move the file #{site_keys_file} and re-run." + end + $rest_auth_site_key_from_generator = REST_AUTH_SITE_KEY + $rest_auth_digest_stretches_from_generator = REST_AUTH_DIGEST_STRETCHES + when options[:old_passwords] + $rest_auth_site_key_from_generator = nil + $rest_auth_digest_stretches_from_generator = 1 + $rest_auth_keys_are_new = true + else + $rest_auth_site_key_from_generator = make_token + $rest_auth_digest_stretches_from_generator = 10 + $rest_auth_keys_are_new = true end + end + def site_keys_file + File.join("config", "initializers", "site_keys.rb") + end + +protected + # Override with your own usage banner. + def banner + "Usage: #{$0} authenticated ModelName [ControllerName]" + end + + def add_options!(opt) + opt.separator '' + opt.separator 'Options:' + opt.on("--skip-migration", + "Don't generate a migration file for this model") { |v| options[:skip_migration] = v } + opt.on("--include-activation", + "Generate signup 'activation code' confirmation via email") { |v| options[:include_activation] = true } + opt.on("--stateful", + "Use acts_as_state_machine. Assumes --include-activation") { |v| options[:include_activation] = options[:stateful] = true } + opt.on("--aasm", + "Use (gem) aasm. Assumes --include-activation") { |v| options[:include_activation] = options[:stateful] = options[:aasm] = true } + opt.on("--rspec", + "Force rspec mode (checks for RAILS_ROOT/spec by default)") { |v| options[:rspec] = true } + opt.on("--no-rspec", + "Force test (not RSpec mode") { |v| options[:rspec] = false } + opt.on("--skip-routes", + "Don't generate a resource line in config/routes.rb") { |v| options[:skip_routes] = v } + opt.on("--old-passwords", + "Use the older password encryption scheme (see README)") { |v| options[:old_passwords] = v } + opt.on("--dump-generator-attrs", + "(generator debug helper)") { |v| options[:dump_generator_attribute_names] = v } + end + + def dump_generator_attribute_names + generator_attribute_names = [ + :table_name, + :file_name, + :class_name, + :controller_name, + :controller_class_path, + :controller_file_path, + :controller_class_nesting, + :controller_class_nesting_depth, + :controller_class_name, + :controller_singular_name, + :controller_plural_name, + :controller_routing_name, # new_session_path + :controller_routing_path, # /session/new + :controller_controller_name, # sessions + :controller_file_name, + :controller_table_name, :controller_plural_name, + :model_controller_name, + :model_controller_class_path, + :model_controller_file_path, + :model_controller_class_nesting, + :model_controller_class_nesting_depth, + :model_controller_class_name, + :model_controller_singular_name, + :model_controller_plural_name, + :model_controller_routing_name, # new_user_path + :model_controller_routing_path, # /users/new + :model_controller_controller_name, # users + :model_controller_file_name, :model_controller_singular_name, + :model_controller_table_name, :model_controller_plural_name, + ] + generator_attribute_names.each do |attr| + puts "%-40s %s" % ["#{attr}:", self.send(attr)] # instance_variable_get("@#{attr.to_s}" + end + + end end + +# ./script/generate authenticated FoonParent::Foon SporkParent::Spork -p --force --rspec --dump-generator-attrs +# table_name: foon_parent_foons +# file_name: foon +# class_name: FoonParent::Foon +# controller_name: SporkParent::Sporks +# controller_class_path: spork_parent +# controller_file_path: spork_parent/sporks +# controller_class_nesting: SporkParent +# controller_class_nesting_depth: 1 +# controller_class_name: SporkParent::Sporks +# controller_singular_name: spork +# controller_plural_name: sporks +# controller_routing_name: spork +# controller_routing_path: spork_parent/spork +# controller_controller_name: sporks +# controller_file_name: sporks +# controller_table_name: sporks +# controller_plural_name: sporks +# model_controller_name: FoonParent::Foons +# model_controller_class_path: foon_parent +# model_controller_file_path: foon_parent/foons +# model_controller_class_nesting: FoonParent +# model_controller_class_nesting_depth: 1 +# model_controller_class_name: FoonParent::Foons +# model_controller_singular_name: foons +# model_controller_plural_name: foons +# model_controller_routing_name: foon_parent_foons +# model_controller_routing_path: foon_parent/foons +# model_controller_controller_name: foons +# model_controller_file_name: foons +# model_controller_singular_name: foons +# model_controller_table_name: foons +# model_controller_plural_name: foons vendor/plugins/restful_authentication/generators/authenticated/authenticated_generator.rb @@ -1,23 +1,23 @@ module AuthenticatedSystem protected - # Returns true or false if the user is logged in. - # Preloads @current_<%= file_name %> with the user model if they're logged in. + # Returns true or false if the <%= file_name %> is logged in. + # Preloads @current_<%= file_name %> with the <%= file_name %> model if they're logged in. def logged_in? - current_<%= file_name %> != :false + !!current_<%= file_name %> end - - # Accesses the current <%= file_name %> from the session. Set it to :false if login fails - # so that future calls do not hit the database. + + # Accesses the current <%= file_name %> from the session. + # Future calls avoid the database because nil is not equal to false. def current_<%= file_name %> - @current_<%= file_name %> ||= (login_from_session || login_from_basic_auth || login_from_cookie || :false) + @current_<%= file_name %> ||= (login_from_session || login_from_basic_auth || login_from_cookie) unless @current_<%= file_name %> == false end - - # Store the given <%= file_name %> in the session. + + # Store the given <%= file_name %> id in the session. def current_<%= file_name %>=(new_<%= file_name %>) - session[:<%= file_name %>] = (new_<%= file_name %>.nil? || new_<%= file_name %>.is_a?(Symbol)) ? nil : new_<%= file_name %>.id - @current_<%= file_name %> = new_<%= file_name %> + session[:<%= file_name %>_id] = new_<%= file_name %> ? new_<%= file_name %>.id : nil + @current_<%= file_name %> = new_<%= file_name %> || false end - + # Check if the <%= file_name %> is authorized # # Override this method in your controllers if you want to restrict access @@ -30,7 +30,8 @@ module AuthenticatedSystem # def authorized? # current_<%= file_name %>.login != "bob" # end - def authorized? + # + def authorized?(action = action_name, resource = nil) logged_in? end @@ -61,67 +62,128 @@ module AuthenticatedSystem # to access the requested action. For example, a popup window might # simply close itself. def access_denied - respond_to do |accepts| - accepts.html do + respond_to do |format| + format.html do store_location - redirect_to :controller => '/<%= controller_file_name %>', :action => 'new' + redirect_to new_<%= controller_routing_name %>_path end - accepts.xml do - headers["Status"] = "Unauthorized" - headers["WWW-Authenticate"] = %(Basic realm="Web Password") - render :text => "Could't authenticate you", :status => '401 Unauthorized' + # format.any doesn't work in rails version < http://dev.rubyonrails.org/changeset/8987 + # Add any other API formats here. (Some browsers, notably IE6, send Accept: */* and trigger + # the 'format.any' block incorrectly. See http://bit.ly/ie6_borken or http://bit.ly/ie6_borken2 + # for a workaround.) + format.any(:json, :xml) do + request_http_basic_authentication 'Web Password' end end - false - end - + end + # Store the URI of the current request in the session. # # We can return to this location by calling #redirect_back_or_default. def store_location session[:return_to] = request.request_uri end - + # Redirect to the URI stored by the most recent store_location call or - # to the passed default. + # to the passed default. Set an appropriately modified + # after_filter :store_location, :only => [:index, :new, :show, :edit] + # for any controller you want to be bounce-backable. def redirect_back_or_default(default) redirect_to(session[:return_to] || default) session[:return_to] = nil end - + # Inclusion hook to make #current_<%= file_name %> and #logged_in? # available as ActionView helper methods. def self.included(base) - base.send :helper_method, :current_<%= file_name %>, :logged_in? + base.send :helper_method, :current_<%= file_name %>, :logged_in?, :authorized? if base.respond_to? :helper_method end - # Called from #current_user. First attempt to login by the user id stored in the session. + # + # Login + # + + # Called from #current_<%= file_name %>. First attempt to login by the <%= file_name %> id stored in the session. def login_from_session - self.current_<%= file_name %> = <%= class_name %>.find_by_id(session[:<%= file_name %>]) if session[:<%= file_name %>] + self.current_<%= file_name %> = <%= class_name %>.find_by_id(session[:<%= file_name %>_id]) if session[:<%= file_name %>_id] end - # Called from #current_user. Now, attempt to login by basic authentication information. + # Called from #current_<%= file_name %>. Now, attempt to login by basic authentication information. def login_from_basic_auth - username, passwd = get_auth_data - self.current_<%= file_name %> = <%= class_name %>.authenticate(username, passwd) if username && passwd + authenticate_with_http_basic do |login, password| + self.current_<%= file_name %> = <%= class_name %>.authenticate(login, password) + end end + + # + # Logout + # - # Called from #current_user. Finaly, attempt to login by an expiring token in the cookie. - def login_from_cookie + # Called from #current_<%= file_name %>. Finaly, attempt to login by an expiring token in the cookie. + # for the paranoid: we _should_ be storing <%= file_name %>_token = hash(cookie_token, request IP) + def login_from_cookie <%= file_name %> = cookies[:auth_token] && <%= class_name %>.find_by_remember_token(cookies[:auth_token]) if <%= file_name %> && <%= file_name %>.remember_token? - <%= file_name %>.remember_me - cookies[:auth_token] = { :value => <%= file_name %>.remember_token, :expires => <%= file_name %>.remember_token_expires_at } self.current_<%= file_name %> = <%= file_name %> + handle_remember_cookie! false # freshen cookie token (keeping date) + self.current_<%= file_name %> end end - private - @@http_auth_headers = %w(X-HTTP_AUTHORIZATION HTTP_AUTHORIZATION Authorization) - # gets BASIC auth info - def get_auth_data - auth_key = @@http_auth_headers.detect { |h| request.env.has_key?(h) } - auth_data = request.env[auth_key].to_s.split unless auth_key.blank? - return auth_data && auth_data[0] == 'Basic' ? Base64.decode64(auth_data[1]).split(':')[0..1] : [nil, nil] + # This is ususally what you want; resetting the session willy-nilly wreaks + # havoc with forgery protection, and is only strictly necessary on login. + # However, **all session state variables should be unset here**. + def logout_keeping_session! + # Kill server-side auth cookie + @current_<%= file_name %>.forget_me if @current_<%= file_name %>.is_a? <%= class_name %> + @current_<%= file_name %> = false # not logged in, and don't do it for me + kill_remember_cookie! # Kill client-side auth cookie + session[:<%= file_name %>_id] = nil # keeps the session but kill our variable + # explicitly kill any other session variables you set + end + + # The session should only be reset at the tail end of a form POST -- + # otherwise the request forgery protection fails. It's only really necessary + # when you cross quarantine (logged-out to logged-in). + def logout_killing_session! + logout_keeping_session! + reset_session + end + + # + # Remember_me Tokens + # + # Cookies shouldn't be allowed to persist past their freshness date, + # and they should be changed at each login + + # Cookies shouldn't be allowed to persist past their freshness date, + # and they should be changed at each login + + def valid_remember_cookie? + return nil unless @current_<%= file_name %> + (@current_<%= file_name %>.remember_token?) && + (cookies[:auth_token] == @current_<%= file_name %>.remember_token) + end + + # Refresh the cookie auth token if it exists, create it otherwise + def handle_remember_cookie!(new_cookie_flag) + return unless @current_<%= file_name %> + case + when valid_remember_cookie? then @current_<%= file_name %>.refresh_token # keeping same expiry date + when new_cookie_flag then @current_<%= file_name %>.remember_me + else @current_<%= file_name %>.forget_me + end + send_remember_cookie! end + + def kill_remember_cookie! + cookies.delete :auth_token + end + + def send_remember_cookie! + cookies[:auth_token] = { + :value => @current_<%= file_name %>.remember_token, + :expires => @current_<%= file_name %>.remember_token_expires_at } + end + end vendor/plugins/restful_authentication/generators/authenticated/templates/authenticated_system.rb @@ -1,10 +1,22 @@ module AuthenticatedTestHelper # Sets the current <%= file_name %> in the session from the <%= file_name %> fixtures. def login_as(<%= file_name %>) - @request.session[:<%= file_name %>] = <%= file_name %> ? <%= table_name %>(<%= file_name %>).id : nil + @request.session[:<%= file_name %>_id] = <%= file_name %> ? <%= table_name %>(<%= file_name %>).id : nil end - def authorize_as(user) - @request.env["HTTP_AUTHORIZATION"] = user ? "Basic #{Base64.encode64("#{users(user).login}:test")}" : nil + def authorize_as(<%= file_name %>) + @request.env["HTTP_AUTHORIZATION"] = <%= file_name %> ? ActionController::HttpAuthentication::Basic.encode_credentials(<%= table_name %>(<%= file_name %>).login, 'monkey') : nil end -end \ No newline at end of file + +<% if options[:rspec] -%> + # rspec + def mock_<%= file_name %> + <%= file_name %> = mock_model(<%= class_name %>, :id => 1, + :login => 'user_name', + :name => 'U. Surname', + :to_xml => "<%= class_name %>-in-XML", :to_json => "<%= class_name %>-in-JSON", + :errors => []) + <%= file_name %> + end +<% end -%> +end vendor/plugins/restful_authentication/generators/authenticated/templates/authenticated_test_helper.rb @@ -8,24 +8,36 @@ class <%= controller_class_name %>Controller < ApplicationController end def create - self.current_<%= file_name %> = <%= class_name %>.authenticate(params[:login], params[:password]) - if logged_in? - if params[:remember_me] == "1" - self.current_<%= file_name %>.remember_me - cookies[:auth_token] = { :value => self.current_<%= file_name %>.remember_token , :expires => self.current_<%= file_name %>.remember_token_expires_at } - end + logout_keeping_session! + <%= file_name %> = <%= class_name %>.authenticate(params[:login], params[:password]) + if <%= file_name %> + # Protects against session fixation attacks, causes request forgery + # protection if user resubmits an earlier form using back + # button. Uncomment if you understand the tradeoffs. + # reset_session + self.current_<%= file_name %> = <%= file_name %> + new_cookie_flag = (params[:remember_me] == "1") + handle_remember_cookie! new_cookie_flag redirect_back_or_default('/') flash[:notice] = "Logged in successfully" else + note_failed_signin + @login = params[:login] + @remember_me = params[:remember_me] render :action => 'new' end end def destroy - self.current_<%= file_name %>.forget_me if logged_in? - cookies.delete :auth_token - reset_session + logout_killing_session! flash[:notice] = "You have been logged out." redirect_back_or_default('/') end + +protected + # Track failed login attempts + def note_failed_signin + flash[:error] = "Couldn't log you in as '#{params[:login]}'" + logger.warn "Failed login for '#{params[:login]}' from #{request.remote_ip} at #{Time.now.utc}" + end end vendor/plugins/restful_authentication/generators/authenticated/templates/controller.rb @@ -1,19 +1,23 @@ class <%= migration_name %> < ActiveRecord::Migration def self.up create_table "<%= table_name %>", :force => true do |t| - t.column :login, :string - t.column :email, :string + t.column :login, :string, :limit => 40 + t.column :name, :string, :limit => 100, :default => '', :null => true + t.column :email, :string, :limit => 100 t.column :crypted_password, :string, :limit => 40 t.column :salt, :string, :limit => 40 t.column :created_at, :datetime t.column :updated_at, :datetime - t.column :remember_token, :string + t.column :remember_token, :string, :limit => 40 t.column :remember_token_expires_at, :datetime - <% if options[:include_activation] %>t.column :activation_code, :string, :limit => 40 - t.column :activated_at, :datetime<% end %> - <% if options[:stateful] %>t.column :state, :string, :null => :no, :default => 'passive' - t.column :deleted_at, :datetime<% end %> +<% if options[:include_activation] -%> + t.column :activation_code, :string, :limit => 40 + t.column :activated_at, :datetime<% end %> +<% if options[:stateful] -%> + t.column :state, :string, :null => :no, :default => 'passive' + t.column :deleted_at, :datetime<% end %> end + add_index :<%= table_name %>, :login, :unique => true end def self.down vendor/plugins/restful_authentication/generators/authenticated/templates/migration.rb @@ -1,141 +1,83 @@ require 'digest/sha1' -class <%= class_name %> < ActiveRecord::Base - # Virtual attribute for the unencrypted password - attr_accessor :password - validates_presence_of :login, :email - validates_presence_of :password, :if => :password_required? - validates_presence_of :password_confirmation, :if => :password_required? - validates_length_of :password, :within => 4..40, :if => :password_required? - validates_confirmation_of :password, :if => :password_required? +class <%= class_name %> < ActiveRecord::Base + include Authentication + include Authentication::ByPassword + include Authentication::ByCookieToken +<% if options[:aasm] -%> + include Authorization::AasmRoles +<% elsif options[:stateful] -%> + include Authorization::StatefulRoles<% end %> + validates_presence_of :login validates_length_of :login, :within => 3..40 - validates_length_of :email, :within => 3..100 - validates_uniqueness_of :login, :email, :case_sensitive => false - before_save :encrypt_password + validates_uniqueness_of :login + validates_format_of :login, :with => Authentication.login_regex, :message => Authentication.bad_login_message + + validates_format_of :name, :with => Authentication.name_regex, :message => Authentication.bad_name_message, :allow_nil => true + validates_length_of :name, :maximum => 100 + + validates_presence_of :email + validates_length_of :email, :within => 6..100 #r@a.wk + validates_uniqueness_of :email + validates_format_of :email, :with => Authentication.email_regex, :message => Authentication.bad_email_message + <% if options[:include_activation] && !options[:stateful] %>before_create :make_activation_code <% end %> + + # HACK HACK HACK -- how to do attr_accessible from here? # prevents a user from submitting a crafted form that bypasses activation # anything else you want your user to change should be added here. - attr_accessible :login, :email, :password, :password_confirmation -<% if options[:stateful] %> - acts_as_state_machine :initial => :pending - state :passive - state :pending, :enter => :make_activation_code - state :active, :enter => :do_activate - state :suspended - state :deleted, :enter => :do_delete + attr_accessible :login, :email, :name, :password, :password_confirmation - event :register do - transitions :from => :passive, :to => :pending, :guard => Proc.new {|u| !(u.crypted_password.blank? && u.password.blank?) } - end - - event :activate do - transitions :from => :pending, :to => :active - end - - event :suspend do - transitions :from => [:passive, :pending, :active], :to => :suspended - end - - event :delete do - transitions :from => [:passive, :pending, :active, :suspended], :to => :deleted - end - - event :unsuspend do - transitions :from => :suspended, :to => :active, :guard => Proc.new {|u| !u.activated_at.blank? } - transitions :from => :suspended, :to => :pending, :guard => Proc.new {|u| !u.activation_code.blank? } - transitions :from => :suspended, :to => :passive - end -<% elsif options[:include_activation] %> +<% if options[:include_activation] && !options[:stateful] %> # Activates the user in the database. - def activate + def activate! @activated = true self.activated_at = Time.now.utc self.activation_code = nil save(false) end + # Returns true if the user has just been activated. + def recently_activated? + @activated + end + def active? # the existence of an activation code means they have not activated yet activation_code.nil? - end + end<% end %> - # Returns true if the user has just been activated. - def pending? - @activated - end -<% end %> # Authenticates a user by their login name and unencrypted password. Returns the user or nil. + # + # uff. this is really an authorization, not authentication routine. + # We really need a Dispatch Chain here or something. + # This will also let us return a human error message. + # def self.authenticate(login, password) - u = <% - if options[:stateful] %>find_in_state :first, :active, :conditions => {:login => login}<% - elsif options[:include_activation] %>find :first, :conditions => ['login = ? and activated_at IS NOT NULL', login]<% - else %>find_by_login(login)<% - end %> # need to get the salt + return nil if login.blank? || password.blank? + u = <% if options[:stateful] %>find_in_state :first, :active, :conditions => {:login => login}<% + elsif options[:include_activation] %>find :first, :conditions => ['login = ? and activated_at IS NOT NULL', login]<% + else %>find_by_login(login)<% end %> # need to get the salt u && u.authenticated?(password) ? u : nil end - # Encrypts some data with the salt. - def self.encrypt(password, salt) - Digest::SHA1.hexdigest("--#{salt}--#{password}--") - end - - # Encrypts the password with the user salt - def encrypt(password) - self.class.encrypt(password, salt) - end - - def authenticated?(password) - crypted_password == encrypt(password) - end - - def remember_token? - remember_token_expires_at && Time.now.utc < remember_token_expires_at - end - - # These create and unset the fields required for remembering users between browser closes - def remember_me - remember_me_for 2.weeks + def login=(value) + write_attribute :login, (value ? value.downcase : nil) end - def remember_me_for(time) - remember_me_until time.from_now.utc - end - - def remember_me_until(time) - self.remember_token_expires_at = time - self.remember_token = encrypt("#{email}--#{remember_token_expires_at}") - save(false) - end - - def forget_me - self.remember_token_expires_at = nil - self.remember_token = nil - save(false) + def email=(value) + write_attribute :email, (value ? value.downcase : nil) end protected - # before filter - def encrypt_password - return if password.blank? - self.salt = Digest::SHA1.hexdigest("--#{Time.now.to_s}--#{login}--") if new_record? - self.crypted_password = encrypt(password) - end - - def password_required? - crypted_password.blank? || !password.blank? - end - <% if options[:include_activation] %> + +<% if options[:include_activation] -%> def make_activation_code -<% if options[:stateful] %> self.deleted_at = nil<% end %> - self.activation_code = Digest::SHA1.hexdigest( Time.now.to_s.split(//).sort_by {rand}.join ) - end<% end %> - <% if options[:stateful] %> - def do_delete - self.deleted_at = Time.now.utc + <% if options[:stateful] -%> + self.deleted_at = nil + <% end -%> + self.activation_code = self.class.make_token end +<% end %> - def do_activate - self.activated_at = Time.now.utc - self.deleted_at = self.activation_code = nil - end<% end %> end vendor/plugins/restful_authentication/generators/authenticated/templates/model.rb @@ -9,56 +9,77 @@ class <%= model_controller_class_name %>Controller < ApplicationController # render new.rhtml def new + @<%= file_name %> = <%= class_name %>.new end - + def create - cookies.delete :auth_token - # protects against session fixation attacks, wreaks havoc with - # request forgery protection. - # uncomment at your own risk - # reset_session + logout_keeping_session! @<%= file_name %> = <%= class_name %>.new(params[:<%= file_name %>]) -<% if options[:stateful] %> raise ActiveRecord::RecordInvalid.new(@user) unless @user.valid?<% end %> - @<%= file_name %>.<% if options[:stateful] %>register<% else %>save<% end %>! - self.current_<%= file_name %> = @<%= file_name %> - redirect_back_or_default('/') - flash[:notice] = "Thanks for signing up!" - rescue ActiveRecord::RecordInvalid - render :action => 'new' +<% if options[:stateful] -%> + @<%= file_name %>.register! if @<%= file_name %> && @<%= file_name %>.valid? + success = @<%= file_name %> && @<%= file_name %>.valid? +<% else -%> + success = @<%= file_name %> && @<%= file_name %>.save +<% end -%> + if success && @<%= file_name %>.errors.empty? + <% if !options[:include_activation] -%> + # Protects against session fixation attacks, causes request forgery + # protection if visitor resubmits an earlier form using back + # button. Uncomment if you understand the tradeoffs. + # reset session + self.current_<%= file_name %> = @<%= file_name %> # !! now logged in + <% end -%>redirect_back_or_default('/') + flash[:notice] = "Thanks for signing up! We're sending you an email with your activation code." + else + flash[:error] = "We couldn't set up that account, sorry. Please try again, or contact an admin (link is above)." + render :action => 'new' + end end <% if options[:include_activation] %> def activate - self.current_<%= file_name %> = params[:activation_code].blank? ? :false : <%= class_name %>.find_by_activation_code(params[:activation_code]) - if logged_in? && !current_<%= file_name %>.active? - current_<%= file_name %>.activate<% if options[:stateful] %>!<% end %> - flash[:notice] = "Signup complete!" + logout_keeping_session! + <%= file_name %> = <%= class_name %>.find_by_activation_code(params[:activation_code]) unless params[:activation_code].blank? + case + when (!params[:activation_code].blank?) && <%= file_name %> && !<%= file_name %>.active? + <%= file_name %>.activate! + flash[:notice] = "Signup complete! Please sign in to continue." + redirect_to '/login' + when params[:activation_code].blank? + flash[:error] = "The activation code was missing. Please follow the URL from your email." + redirect_back_or_default('/') + else + flash[:error] = "We couldn't find a <%= file_name %> with that activation code -- check your email? Or maybe you've already activated -- try signing in." + redirect_back_or_default('/') end - redirect_back_or_default('/') end <% end %><% if options[:stateful] %> def suspend - @user.suspend! - redirect_to users_url + @<%= file_name %>.suspend! + redirect_to <%= model_controller_routing_name %>_path end def unsuspend - @user.unsuspend! - redirect_to users_url + @<%= file_name %>.unsuspend! + redirect_to <%= model_controller_routing_name %>_path end def destroy - @user.delete! - redirect_to users_url + @<%= file_name %>.delete! + redirect_to <%= model_controller_routing_name %>_path end def purge - @user.destroy - redirect_to users_url + @<%= file_name %>.destroy + redirect_to <%= model_controller_routing_name %>_path end + + # There's no page here to update or destroy a <%= file_name %>. If you add those, be + # smart -- make sure you check that the visitor is authorized to do so, that they + # supply their old password along with a new one to update it, etc. protected def find_<%= file_name %> - @<%= file_name %> = User.find(params[:id]) + @<%= file_name %> = <%= class_name %>.find(params[:id]) end -<% end %> +<% end -%> end vendor/plugins/restful_authentication/generators/authenticated/templates/model_controller.rb @@ -1,2 +1,93 @@ module <%= model_controller_class_name %>Helper -end \ No newline at end of file + + # + # Use this to wrap view elements that the user can't access. + # !! Note: this is an *interface*, not *security* feature !! + # You need to do all access control at the controller level. + # + # Example: + # <%%= if_authorized?(:index, User) do link_to('List all users', users_path) end %> | + # <%%= if_authorized?(:edit, @user) do link_to('Edit this user', edit_user_path) end %> | + # <%%= if_authorized?(:destroy, @user) do link_to 'Destroy', @user, :confirm => 'Are you sure?', :method => :delete end %> + # + # + def if_authorized?(action, resource, &block) + if authorized?(action, resource) + yield action, resource + end + end + + # + # Link to user's page ('<%= table_name %>/1') + # + # By default, their login is used as link text and link title (tooltip) + # + # Takes options + # * :content_text => 'Content text in place of <%= file_name %>.login', escaped with + # the standard h() function. + # * :content_method => :<%= file_name %>_instance_method_to_call_for_content_text + # * :title_method => :<%= file_name %>_instance_method_to_call_for_title_attribute + # * as well as link_to()'s standard options + # + # Examples: + # link_to_<%= file_name %> @<%= file_name %> + # # => <a href="/<%= table_name %>/3" title="barmy">barmy</a> + # + # # if you've added a .name attribute: + # content_tag :span, :class => :vcard do + # (link_to_<%= file_name %> <%= file_name %>, :class => 'fn n', :title_method => :login, :content_method => :name) + + # ': ' + (content_tag :span, <%= file_name %>.email, :class => 'email') + # end + # # => <span class="vcard"><a href="/<%= table_name %>/3" title="barmy" class="fn n">Cyril Fotheringay-Phipps</a>: <span class="email">barmy@blandings.com</span></span> + # + # link_to_<%= file_name %> @<%= file_name %>, :content_text => 'Your user page' + # # => <a href="/<%= table_name %>/3" title="barmy" class="nickname">Your user page</a> + # + def link_to_<%= file_name %>(<%= file_name %>, options={}) + raise "Invalid <%= file_name %>" unless <%= file_name %> + options.reverse_merge! :content_method => :login, :title_method => :login, :class => :nickname + content_text = options.delete(:content_text) + content_text ||= <%= file_name %>.send(options.delete(:content_method)) + options[:title] ||= <%= file_name %>.send(options.delete(:title_method)) + link_to h(content_text), <%= model_controller_routing_name.singularize %>_path(<%= file_name %>), options + end + + # + # Link to login page using remote ip address as link content + # + # The :title (and thus, tooltip) is set to the IP address + # + # Examples: + # link_to_login_with_IP + # # => <a href="/login" title="169.69.69.69">169.69.69.69</a> + # + # link_to_login_with_IP :content_text => 'not signed in' + # # => <a href="/login" title="169.69.69.69">not signed in</a> + # + def link_to_login_with_IP content_text=nil, options={} + ip_addr = request.remote_ip + content_text ||= ip_addr + options.reverse_merge! :title => ip_addr + if tag = options.delete(:tag) + content_tag tag, h(content_text), options + else + link_to h(content_text), login_path, options + end + end + + # + # Link to the current user's page (using link_to_<%= file_name %>) or to the login page + # (using link_to_login_with_IP). + # + def link_to_current_<%= file_name %>(options={}) + if current_<%= file_name %> + link_to_<%= file_name %> current_<%= file_name %>, options + else + content_text = options.delete(:content_text) || 'not signed in' + # kill ignored options from link_to_<%= file_name %> + [:content_method, :title_method].each{|opt| options.delete(opt)} + link_to_login_with_IP content_text, options + end + end + +end vendor/plugins/restful_authentication/generators/authenticated/templates/model_helper.rb @@ -5,7 +5,7 @@ class <%= class_name %>Observer < ActiveRecord::Observer def after_save(<%= file_name %>) <% if options[:include_activation] %> - <%= class_name %>Mailer.deliver_activation(<%= file_name %>) if <%= file_name %>.pending? + <%= class_name %>Mailer.deliver_activation(<%= file_name %>) if <%= file_name %>.recently_activated? <% end %> end end vendor/plugins/restful_authentication/generators/authenticated/templates/observer.rb @@ -1,11 +1,25 @@ === In Development (git clone git://github.com/dchelimsky/rspec-rails.git) +IMPORTANT: use 'script/autospec' (or just 'autospec' if you have the rspec gem +installed) instead of 'autotest'. We changed the way autotest discovers rspec +so the autotest executable won't automatically load rspec anymore. This allows +rspec to live side by side other spec frameworks without always co-opting +autotest through autotest's discovery mechanism. + +ALSO IMPORTANT: Rails v2.1.1 changed assert_select_rjs such that it doesn't +always fail when it should. Please see +http://rails.lighthouseapp.com/projects/8994/tickets/982. + +* Generated route specs have shorter names, making it less painful to modify their implementation * Add conditional so Rails 2.1.0 doesn't warn about cache_template_extensions (patch from James Herdman) * Fixed stub_model examples to work with Rails 2.1.0 (the code was fine, just the examples needed patching) * use hoe for build/release * reworked generated examples for rspec_scaffold - thanks to Mikel Lindsaar and Dan Manges for their feedback * bye, bye translator * Added proxy to cookies so you can set them in examples the same way you set them in controllers +* Added script/autospec so you can run autospec without installing the gem +* Support --skip-fixture in the rspec_model generator (patches from Alex Tomlins and Niels Ganser) +* Add mock_model#as_new_record (patch from Zach Dennis) === Version 1.1.4 vendor/plugins/rspec-rails/History.txt @@ -1,6 +1,4 @@ -.gitignore History.txt -MIT-LICENSE Manifest.txt README.txt Rakefile @@ -11,6 +9,7 @@ generators/rspec/templates/all_stories.rb generators/rspec/templates/previous_failures.txt generators/rspec/templates/rcov.opts generators/rspec/templates/rspec.rake +generators/rspec/templates/script/autospec generators/rspec/templates/script/spec generators/rspec/templates/script/spec_server generators/rspec/templates/spec.opts @@ -21,6 +20,7 @@ generators/rspec_controller/rspec_controller_generator.rb generators/rspec_controller/templates/controller_spec.rb generators/rspec_controller/templates/helper_spec.rb generators/rspec_controller/templates/view_spec.rb +generators/rspec_default_values.rb generators/rspec_model/USAGE generators/rspec_model/rspec_model_generator.rb generators/rspec_model/templates/model_spec.rb @@ -39,6 +39,7 @@ lib/spec/rails.rb lib/spec/rails/example.rb lib/spec/rails/example/assigns_hash_proxy.rb lib/spec/rails/example/controller_example_group.rb +lib/spec/rails/example/cookies_proxy.rb lib/spec/rails/example/functional_example_group.rb lib/spec/rails/example/helper_example_group.rb lib/spec/rails/example/model_example_group.rb @@ -54,6 +55,7 @@ lib/spec/rails/extensions/active_record/base.rb lib/spec/rails/extensions/object.rb lib/spec/rails/extensions/spec/example/configuration.rb lib/spec/rails/extensions/spec/matchers/have.rb +lib/spec/rails/interop/testcase.rb lib/spec/rails/matchers.rb lib/spec/rails/matchers/assert_select.rb lib/spec/rails/matchers/have_text.rb @@ -64,11 +66,11 @@ lib/spec/rails/mocks.rb lib/spec/rails/story_adapter.rb lib/spec/rails/version.rb spec/rails/autotest/mappings_spec.rb -spec/rails/autotest/rails_rspec_spec.rb spec/rails/example/assigns_hash_proxy_spec.rb spec/rails/example/configuration_spec.rb spec/rails/example/controller_isolation_spec.rb spec/rails/example/controller_spec_spec.rb +spec/rails/example/cookies_proxy_spec.rb spec/rails/example/example_group_factory_spec.rb spec/rails/example/helper_spec_spec.rb spec/rails/example/model_spec_spec.rb @@ -78,13 +80,14 @@ spec/rails/example/view_spec_spec.rb spec/rails/extensions/action_controller_rescue_action_spec.rb spec/rails/extensions/action_view_base_spec.rb spec/rails/extensions/active_record_spec.rb +spec/rails/interop/testcase_spec.rb spec/rails/matchers/assert_select_spec.rb spec/rails/matchers/description_generation_spec.rb spec/rails/matchers/errors_on_spec.rb spec/rails/matchers/have_text_spec.rb spec/rails/matchers/include_text_spec.rb spec/rails/matchers/redirect_to_spec.rb -spec/rails/matchers/render_spec.rb +spec/rails/matchers/render_template_spec.rb spec/rails/mocks/ar_classes.rb spec/rails/mocks/mock_model_spec.rb spec/rails/mocks/stub_model_spec.rb @@ -109,7 +112,11 @@ spec_resources/views/controller_spec/action_setting_flash_before_session_reset.r spec_resources/views/controller_spec/action_setting_the_assigns_hash.rhtml spec_resources/views/controller_spec/action_with_errors_in_template.rhtml spec_resources/views/controller_spec/action_with_template.rhtml +spec_resources/views/layouts/application.rhtml +spec_resources/views/layouts/simple.rhtml +spec_resources/views/objects/_object.html.erb spec_resources/views/render_spec/_a_partial.rhtml +spec_resources/views/render_spec/action_with_alternate_layout.rhtml spec_resources/views/render_spec/some_action.js.rjs spec_resources/views/render_spec/some_action.rhtml spec_resources/views/render_spec/some_action.rjs @@ -131,6 +138,7 @@ spec_resources/views/view_spec/_partial_with_local_variable.rhtml spec_resources/views/view_spec/_partial_with_sub_partial.rhtml spec_resources/views/view_spec/_spacer.rhtml spec_resources/views/view_spec/accessor.rhtml +spec_resources/views/view_spec/block_helper.rhtml spec_resources/views/view_spec/entry_form.rhtml spec_resources/views/view_spec/explicit_helper.rhtml spec_resources/views/view_spec/foo/show.rhtml @@ -140,6 +148,7 @@ spec_resources/views/view_spec/template_with_partial.rhtml spec_resources/views/view_spec/template_with_partial_using_collection.rhtml spec_resources/views/view_spec/template_with_partial_with_array.rhtml stories/all.rb +stories/configuration/stories.rb stories/helper.rb stories/steps/people.rb stories/transactions_should_rollback vendor/plugins/rspec-rails/Manifest.txt @@ -14,13 +14,16 @@ class RspecGenerator < Rails::Generator::Base record do |m| script_options = { :chmod => 0755, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : options[:shebang] } + m.file 'rspec.rake', 'lib/tasks/rspec.rake' + + m.file 'script/autospec', 'script/autospec', script_options + m.file 'script/spec', 'script/spec', script_options + m.file 'script/spec_server', 'script/spec_server', script_options + m.directory 'spec' - m.template 'spec_helper.rb', 'spec/spec_helper.rb' - m.file 'spec.opts', 'spec/spec.opts' m.file 'rcov.opts', 'spec/rcov.opts' - m.file 'script/spec_server', 'script/spec_server', script_options - m.file 'script/spec', 'script/spec', script_options - m.file 'rspec.rake', 'lib/tasks/rspec.rake' + m.file 'spec.opts', 'spec/spec.opts' + m.template 'spec_helper.rb', 'spec/spec_helper.rb' m.directory 'stories' m.file 'all_stories.rb', 'stories/all.rb' vendor/plugins/rspec-rails/generators/rspec/rspec_generator.rb @@ -1,4 +1,5 @@ require 'rails_generator/generators/components/model/model_generator' +require File.dirname(__FILE__) + '/../rspec_default_values' class RspecModelGenerator < ModelGenerator @@ -11,12 +12,16 @@ class RspecModelGenerator < ModelGenerator # Model, spec, and fixture directories. m.directory File.join('app/models', class_path) m.directory File.join('spec/models', class_path) - m.directory File.join('spec/fixtures', class_path) + unless options[:skip_fixture] + m.directory File.join('spec/fixtures', class_path) + end # Model class, spec and fixtures. m.template 'model:model.rb', File.join('app/models', class_path, "#{file_name}.rb") - m.template 'model:fixtures.yml', File.join('spec/fixtures', class_path, "#{table_name}.yml") m.template 'model_spec.rb', File.join('spec/models', class_path, "#{file_name}_spec.rb") + unless options[:skip_fixture] + m.template 'model:fixtures.yml', File.join('spec/fixtures', "#{table_name}.yml") + end unless options[:skip_migration] m.migration_template 'model:migration.rb', 'db/migrate', :assigns => { vendor/plugins/rspec-rails/generators/rspec_model/rspec_model_generator.rb @@ -1,3 +1,5 @@ +require File.dirname(__FILE__) + '/../rspec_default_values' + class RspecScaffoldGenerator < Rails::Generator::NamedBase default_options :skip_migration => false @@ -140,20 +142,6 @@ end module Rails module Generator class GeneratedAttribute - def default_value - @default_value ||= case type - when :int, :integer then "\"1\"" - when :float then "\"1.5\"" - when :decimal then "\"9.99\"" - when :datetime, :timestamp, :time then "Time.now" - when :date then "Date.today" - when :string, :text then "\"value for #{@name}\"" - when :boolean then "false" - else - "" - end - end - def input_type @input_type ||= case type when :text then "textarea" vendor/plugins/rspec-rails/generators/rspec_scaffold/rspec_scaffold_generator.rb @@ -2,59 +2,57 @@ require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_dep describe <%= controller_class_name %>Controller do describe "route generation" do - - it "should map { :controller => '<%= table_name %>', :action => 'index' } to /<%= table_name %>" do + it "should map #index" do route_for(:controller => "<%= table_name %>", :action => "index").should == "/<%= table_name %>" end - it "should map { :controller => '<%= table_name %>', :action => 'new' } to /<%= table_name %>/new" do + it "should map #new" do route_for(:controller => "<%= table_name %>", :action => "new").should == "/<%= table_name %>/new" end - it "should map { :controller => '<%= table_name %>', :action => 'show', :id => 1 } to /<%= table_name %>/1" do + it "should map #show" do route_for(:controller => "<%= table_name %>", :action => "show", :id => 1).should == "/<%= table_name %>/1" end - it "should map { :controller => '<%= table_name %>', :action => 'edit', :id => 1 } to /<%= table_name %>/1<%= resource_edit_path %>" do + it "should map #edit" do route_for(:controller => "<%= table_name %>", :action => "edit", :id => 1).should == "/<%= table_name %>/1<%= resource_edit_path %>" end - it "should map { :controller => '<%= table_name %>', :action => 'update', :id => 1} to /<%= table_name %>/1" do + it "should map #update" do route_for(:controller => "<%= table_name %>", :action => "update", :id => 1).should == "/<%= table_name %>/1" end - it "should map { :controller => '<%= table_name %>', :action => 'destroy', :id => 1} to /<%= table_name %>/1" do + it "should map #destroy" do route_for(:controller => "<%= table_name %>", :action => "destroy", :id => 1).should == "/<%= table_name %>/1" end end describe "route recognition" do - - it "should generate params { :controller => '<%= table_name %>', action => 'index' } from GET /<%= table_name %>" do + it "should generate params for #index" do params_from(:get, "/<%= table_name %>").should == {:controller => "<%= table_name %>", :action => "index"} end - it "should generate params { :controller => '<%= table_name %>', action => 'new' } from GET /<%= table_name %>/new" do + it "should generate params for #new" do params_from(:get, "/<%= table_name %>/new").should == {:controller => "<%= table_name %>", :action => "new"} end - it "should generate params { :controller => '<%= table_name %>', action => 'create' } from POST /<%= table_name %>" do + it "should generate params for #create" do params_from(:post, "/<%= table_name %>").should == {:controller => "<%= table_name %>", :action => "create"} end - it "should generate params { :controller => '<%= table_name %>', action => 'show', id => '1' } from GET /<%= table_name %>/1" do + it "should generate params for #show" do params_from(:get, "/<%= table_name %>/1").should == {:controller => "<%= table_name %>", :action => "show", :id => "1"} end - it "should generate params { :controller => '<%= table_name %>', action => 'edit', id => '1' } from GET /<%= table_name %>/1;edit" do + it "should generate params for #edit" do params_from(:get, "/<%= table_name %>/1<%= resource_edit_path %>").should == {:controller => "<%= table_name %>", :action => "edit", :id => "1"} end - it "should generate params { :controller => '<%= table_name %>', action => 'update', id => '1' } from PUT /<%= table_name %>/1" do + it "should generate params for #update" do params_from(:put, "/<%= table_name %>/1").should == {:controller => "<%= table_name %>", :action => "update", :id => "1"} end - it "should generate params { :controller => '<%= table_name %>', action => 'destroy', id => '1' } from DELETE /<%= table_name %>/1" do + it "should generate params for #destroy" do params_from(:delete, "/<%= table_name %>/1").should == {:controller => "<%= table_name %>", :action => "destroy", :id => "1"} end end vendor/plugins/rspec-rails/generators/rspec_scaffold/templates/routing_spec.rb @@ -73,9 +73,4 @@ Autotest.add_hook :initialize do |at| end class Autotest::RailsRspec < Autotest::Rspec - - def spec_command - "script/spec" - end - end vendor/plugins/rspec-rails/lib/autotest/rails_rspec.rb @@ -1,6 +1,6 @@ silence_warnings { RAILS_ENV = "test" } -require 'application' +require_dependency 'application' require 'action_controller/test_process' require 'action_controller/integration' require 'active_record/fixtures' if defined?(ActiveRecord::Base) @@ -12,3 +12,4 @@ require 'spec/rails/matchers' require 'spec/rails/mocks' require 'spec/rails/example' require 'spec/rails/extensions' +require 'spec/rails/interop/testcase' \ No newline at end of file vendor/plugins/rspec-rails/lib/spec/rails.rb @@ -2,8 +2,9 @@ module Spec module Rails module Example class AssignsHashProxy #:nodoc: - def initialize(object) - @object = object + def initialize(example_group, &block) + @block = block + @example_group = example_group end def [](ivar) @@ -17,8 +18,7 @@ module Spec end def []=(ivar, val) - @object.instance_variable_set "@#{ivar}", val - assigns[ivar.to_s] = val + @block.call.instance_variable_set("@#{ivar}", val) end def delete(name) @@ -35,7 +35,7 @@ module Spec protected def assigns - @object.assigns + @example_group.orig_assigns end end end vendor/plugins/rspec-rails/lib/spec/rails/example/assigns_hash_proxy.rb @@ -158,7 +158,9 @@ module Spec protected def _assigns_hash_proxy - @_assigns_hash_proxy ||= AssignsHashProxy.new @controller + @_assigns_hash_proxy ||= AssignsHashProxy.new self do + @response.template + end end private @@ -183,20 +185,22 @@ module Spec unless integrate_views? if @template.respond_to?(:finder) (class << @template.finder; self; end).class_eval do - define_method :file_exists? do - true - end + define_method :file_exists? do; true; end end else (class << @template; self; end).class_eval do - define_method :file_exists? do - true - end + define_method :file_exists? do; true; end end end (class << @template; self; end).class_eval do define_method :render_file do |*args| - @first_render ||= args[0] + @first_render ||= args[0] unless args[0] =~ /^layouts/ + @_first_render ||= args[0] unless args[0] =~ /^layouts/ + end + + define_method :_pick_template do |*args| + @_first_render ||= args[0] unless args[0] =~ /^layouts/ + PickedTemplate.new end end end @@ -206,7 +210,9 @@ module Spec expect_render_mock_proxy.render(options, &block) @performed_render = true else - unless matching_stub_exists(options) + if matching_stub_exists(options) + @performed_render = true + else super(options, deprecated_status_or_extra_options, &block) end end @@ -266,6 +272,11 @@ module Spec Spec::Example::ExampleGroupFactory.register(:controller, self) end + + class PickedTemplate + def render_template(*ignore_args); end + def render_partial(*ignore_args); end + end end end end vendor/plugins/rspec-rails/lib/spec/rails/example/controller_example_group.rb @@ -8,12 +8,16 @@ module Spec @example = example end + def[]=(name, value) + @example.request.cookies[name.to_s] = CGI::Cookie.new(name.to_s, value) + end + def [](name) @example.response.cookies[name.to_s] end - def[]=(name, value) - @example.request.cookies[name.to_s] = CGI::Cookie.new(name.to_s, value) + def delete(name) + @example.response.cookies.delete(name.to_s) end end end vendor/plugins/rspec-rails/lib/spec/rails/example/cookies_proxy.rb @@ -52,6 +52,8 @@ module Spec def cookies @cookies ||= Spec::Rails::Example::CookiesProxy.new(self) end + + alias_method :orig_assigns, :assigns # :call-seq: # assigns() @@ -78,6 +80,7 @@ module Spec _assigns_hash_proxy[key] end end + end end end vendor/plugins/rspec-rails/lib/spec/rails/example/functional_example_group.rb @@ -148,7 +148,9 @@ module Spec protected def _assigns_hash_proxy - @_assigns_hash_proxy ||= AssignsHashProxy.new helper + @_assigns_hash_proxy ||= AssignsHashProxy.new self do + helper + end end end vendor/plugins/rspec-rails/lib/spec/rails/example/helper_example_group.rb @@ -11,11 +11,15 @@ module Spec class RailsExampleGroup < Test::Unit::TestCase # Rails >= r8570 uses setup/teardown_fixtures explicitly - before(:each) do - setup_fixtures if self.respond_to?(:setup_fixtures) - end - after(:each) do - teardown_fixtures if self.respond_to?(:teardown_fixtures) + # However, Rails >= r8664 extracted these out to use ActiveSupport::Callbacks. + # The latter case is handled at the TestCase level, in interop/testcase.rb + unless ActiveSupport.const_defined?(:Callbacks) and self.include?(ActiveSupport::Callbacks) + before(:each) do + setup_fixtures if self.respond_to?(:setup_fixtures) + end + after(:each) do + teardown_fixtures if self.respond_to?(:teardown_fixtures) + end end include Spec::Rails::Matchers vendor/plugins/rspec-rails/lib/spec/rails/example/rails_example_group.rb @@ -150,7 +150,9 @@ module Spec protected def _assigns_hash_proxy - @_assigns_hash_proxy ||= AssignsHashProxy.new @controller + @_assigns_hash_proxy ||= AssignsHashProxy.new self do + @response.template + end end end @@ -172,6 +174,9 @@ module Spec include helper_module end end + + def forget_variables_added_to_assigns + end end end end vendor/plugins/rspec-rails/lib/spec/rails/example/view_example_group.rb @@ -10,7 +10,11 @@ module ActionView #:nodoc: end end end - super(partial_path, local_assigns, deprecated_local_assigns) + begin + super(partial_path, local_assigns, deprecated_local_assigns) + rescue ArgumentError # edge rails > 2.1 changed render_partial to accept only one arg + super(partial_path) + end end alias_method :orig_render, :render vendor/plugins/rspec-rails/lib/spec/rails/extensions/action_view/base.rb @@ -16,6 +16,7 @@ module Spec # :nodoc: def matches?(response_or_text, &block) if ActionController::TestResponse === response_or_text and response_or_text.headers.key?('Content-Type') and + !response_or_text.headers['Content-Type'].blank? and response_or_text.headers['Content-Type'].to_sym == :xml @args.unshift(HTML::Document.new(response_or_text.body, false, true).root) elsif String === response_or_text vendor/plugins/rspec-rails/lib/spec/rails/matchers/assert_select.rb @@ -10,10 +10,18 @@ module Spec end def matches?(response) - @actual = response.rendered_file - full_path(@actual) == full_path(@expected) + + if response.respond_to?(:rendered_file) + @actual = response.rendered_file + else + @actual = response.rendered_template.to_s + end + return false if @actual.blank? + given_controller_path, given_file = path_and_file(@actual) + expected_controller_path, expected_file = path_and_file(@expected) + given_controller_path == expected_controller_path && given_file.match(expected_file) end - + def failure_message "expected #{@expected.inspect}, got #{@actual.inspect}" end @@ -27,9 +35,21 @@ module Spec end private - def full_path(path) - return nil if path.nil? - path.include?('/') ? path : "#{@controller.class.to_s.underscore.gsub('_controller','')}/#{path}" + def path_and_file(path) + parts = path.split('/') + file = parts.pop + controller = parts.empty? ? current_controller_path : parts.join('/') + return controller, file + end + + def controller_path_from(path) + parts = path.split('/') + parts.pop + parts.join('/') + end + + def current_controller_path + @controller.class.to_s.underscore.gsub(/_controller$/,'') end end vendor/plugins/rspec-rails/lib/spec/rails/matchers/render_template.rb @@ -9,15 +9,21 @@ module Spec # methods stubbed out. Additional methods may be easily stubbed (via # add_stubs) if +stubs+ is passed. def mock_model(model_class, options_and_stubs = {}) - id = next_id - options_and_stubs.reverse_merge!({ + id = options_and_stubs[:id] || next_id + options_and_stubs = options_and_stubs.reverse_merge({ :id => id, :to_param => id.to_s, :new_record? => false, :errors => stub("errors", :count => 0) }) - m = mock("#{model_class.name}_#{options_and_stubs[:id]}", options_and_stubs) + m = mock("#{model_class.name}_#{id}", options_and_stubs) m.send(:__mock_proxy).instance_eval <<-CODE + def @target.as_new_record + self.stub!(:id).and_return nil + self.stub!(:to_param).and_return nil + self.stub!(:new_record?).and_return true + self + end def @target.is_a?(other) #{model_class}.ancestors.include?(other) end @@ -123,4 +129,4 @@ module Spec end end -end \ No newline at end of file +end vendor/plugins/rspec-rails/lib/spec/rails/mocks.rb @@ -40,15 +40,23 @@ class ActiveRecordSafetyListener include Singleton def scenario_started(*args) if defined?(ActiveRecord::Base) - ActiveRecord::Base.send :increment_open_transactions unless Rails::VERSION::STRING == "1.1.6" - ActiveRecord::Base.connection.begin_db_transaction + if ActiveRecord::Base.connection.respond_to?(:increment_open_transactions) + ActiveRecord::Base.connection.increment_open_transactions + else + ActiveRecord::Base.send :increment_open_transactions + end end + ActiveRecord::Base.connection.begin_db_transaction end def scenario_succeeded(*args) if defined?(ActiveRecord::Base) ActiveRecord::Base.connection.rollback_db_transaction - ActiveRecord::Base.send :decrement_open_transactions unless Rails::VERSION::STRING == "1.1.6" + if ActiveRecord::Base.connection.respond_to?(:decrement_open_transactions) + ActiveRecord::Base.connection.decrement_open_transactions + else + ActiveRecord::Base.send :decrement_open_transactions + end end end alias :scenario_pending :scenario_succeeded vendor/plugins/rspec-rails/lib/spec/rails/story_adapter.rb @@ -1,31 +1,41 @@ require File.dirname(__FILE__) + '/../../spec_helper' describe "AssignsHashProxy" do + def orig_assigns + @object.assigns + end + before(:each) do - @object = Object.new - @assigns = Hash.new - @object.stub!(:assigns).and_return(@assigns) - @proxy = Spec::Rails::Example::AssignsHashProxy.new(@object) + @object = Class.new do + attr_accessor :assigns + end.new + @object.assigns = Hash.new + @proxy = Spec::Rails::Example::AssignsHashProxy.new self do + @object + end end - - it "has [] accessor" do + + it "should set ivars on object using string" do @proxy['foo'] = 'bar' - @assigns['foo'].should == 'bar' - @proxy['foo'].should == 'bar' + @object.instance_eval{@foo}.should == 'bar' end - - it "works for symbol key" do - @assigns[:foo] = 2 - @proxy[:foo].should == 2 + + it "should set ivars on object using symbol" do + @proxy[:foo] = 'bar' + @object.instance_eval{@foo}.should == 'bar' end - - it "checks for string key before symbol key" do - @assigns['foo'] = false - @assigns[:foo] = 2 - @proxy[:foo].should == false + + it "should access object's assigns with a string" do + @object.assigns['foo'] = 'bar' + @proxy[:foo].should == 'bar' + end + + it "should access object's assigns with a symbol" do + @object.assigns['foo'] = 'bar' + @proxy[:foo].should == 'bar' end - it "each method iterates through each element like a Hash" do + it "iterates through each element like a Hash" do values = { 'foo' => 1, 'bar' => 2, @@ -34,27 +44,22 @@ describe "AssignsHashProxy" do @proxy['foo'] = values['foo'] @proxy['bar'] = values['bar'] @proxy['baz'] = values['baz'] - + @proxy.each do |key, value| key.should == key value.should == values[key] end end - - it "delete method deletes the element of passed in key" do - @proxy['foo'] = 'bar' + + it "deletes the element of passed in key" do + @object.assigns['foo'] = 'bar' @proxy.delete('foo').should == 'bar' @proxy['foo'].should be_nil end - - it "has_key? detects the presence of a key" do - @proxy['foo'] = 'bar' + + it "detects the presence of a key" do + @object.assigns['foo'] = 'bar' @proxy.has_key?('foo').should == true @proxy.has_key?('bar').should == false end - - it "should sets an instance var" do - @proxy['foo'] = 'bar' - @object.instance_eval { @foo }.should == 'bar' - end end vendor/plugins/rspec-rails/spec/rails/example/assigns_hash_proxy_spec.rb @@ -5,7 +5,7 @@ require 'controller_spec_controller' describe "A controller example running in #{mode} mode", :type => :controller do controller_name :controller_spec integrate_views if mode == 'integration' - + it "should provide controller.session as session" do get 'action_with_template' session.should equal(controller.session) @@ -143,11 +143,6 @@ require 'controller_spec_controller' assigns[:indirect_assigns_key].should == :indirect_assigns_key_value end - it "should expose the assigns hash directly" do - get 'action_setting_the_assigns_hash' - assigns[:direct_assigns_key].should == :direct_assigns_key_value - end - it "should complain when calling should_receive(:render) on the controller" do lambda { controller.should_receive(:render) @@ -167,6 +162,12 @@ require 'controller_spec_controller' controller.rspec_verify }.should raise_error(Exception, /expected :anything_besides_render/) end + + it "should not run a skipped before_filter" do + lambda { + get 'action_with_skipped_before_filter' + }.should_not raise_error + end end describe "Given a controller spec for RedirectSpecController running in #{mode} mode", :type => :controller do @@ -207,6 +208,19 @@ require 'controller_spec_controller' end +['integration', 'isolation'].each do |mode| + describe "A controller example running in #{mode} mode", :type => :controller do + controller_name :controller_inheriting_from_application_controller + integrate_views if mode == 'integration' + + it "should only have a before filter inherited from ApplicationController run once..." do + controller.should_receive(:i_should_only_be_run_once).once + get :action_with_inherited_before_filter + end + end +end + + describe ControllerSpecController, :type => :controller do it "should not require naming the controller if describe is passed a type" do end vendor/plugins/rspec-rails/spec/rails/example/controller_spec_spec.rb @@ -38,26 +38,35 @@ module Spec describe "with a Symbol key" do it "should accept a String value" do - cookies = CookiesProxy.new(self) - cookies[:key] = 'value' + example_cookies = CookiesProxy.new(self) + example_cookies[:key] = 'value' get :index - cookies[:key].should == ['value'] + example_cookies[:key].should == ['value'] end if Rails::VERSION::STRING >= "2.0.0" it "should accept a Hash value" do - cookies = CookiesProxy.new(self) - cookies[:key] = { :value => 'value', :expires => expiration = 1.hour.from_now, :path => path = '/path' } + example_cookies = CookiesProxy.new(self) + example_cookies[:key] = { :value => 'value', :expires => expiration = 1.hour.from_now, :path => path = '/path' } get :index - cookies[:key].should == ['value'] - cookies[:key].value.should == ['value'] - cookies[:key].expires.should == expiration - cookies[:key].path.should == path + example_cookies[:key].should == ['value'] + example_cookies[:key].value.should == ['value'] + example_cookies[:key].expires.should == expiration + example_cookies[:key].path.should == path end end end + describe "#delete" do + it "should delete from the response cookies" do + example_cookies = CookiesProxy.new(self) + response_cookies = mock('cookies') + response.should_receive(:cookies).and_return(response_cookies) + response_cookies.should_receive(:delete).with('key') + example_cookies.delete :key + end + end end end vendor/plugins/rspec-rails/spec/rails/example/cookies_proxy_spec.rb @@ -149,37 +149,19 @@ describe "A view that includes a partial using :collection and :spacer_template" end -describe "A view that includes a partial using an array as partial_path", :type => :view do - before(:each) do - module ActionView::Partials - def render_template_with_partial_with_array_support(partial_path, local_assigns = nil, deprecated_local_assigns = nil) - if partial_path.is_a?(Array) - "Array Partial" - else - render_partial_without_array_support(partial_path, local_assigns, deprecated_local_assigns) - end - end - - alias :render_partial_without_array_support :render_partial - alias :render_partial :render_template_with_partial_with_array_support +if Rails::VERSION::MAJOR >= 2 + describe "A view that includes a partial using an array as partial_path", :type => :view do + before(:each) do + renderable_object = Object.new + renderable_object.stub!(:name).and_return("Renderable Object") + assigns[:array] = [renderable_object] end - @array = ['Alice', 'Bob'] - assigns[:array] = @array - end - - after(:each) do - module ActionView::Partials - alias :render_template_with_partial_with_array_support :render_partial - alias :render_partial :render_partial_without_array_support - undef render_template_with_partial_with_array_support + it "should render the array passed through to render_partial without modification" do + render "view_spec/template_with_partial_with_array" + response.body.should match(/^Renderable Object$/) end end - - it "should render have the array passed through to render_partial without modification" do - render "view_spec/template_with_partial_with_array" - response.body.should match(/^Array Partial$/) - end end describe "Different types of renders (not :template)", :type => :view do @@ -239,6 +221,20 @@ describe "An instantiated ViewExampleGroupController", :type => :view do end end +describe "a block helper", :type => :view do + it "should not yield when not told to in the example" do + template.should_receive(:if_allowed) + render "view_spec/block_helper" + response.should_not have_tag("div","block helper was rendered") + end + + it "should yield when told to in the example" do + template.should_receive(:if_allowed).and_yield + render "view_spec/block_helper" + response.should have_tag("div","block helper was rendered") + end +end + describe "render :inline => ...", :type => :view do it "should render ERB right in the spec" do render :inline => %|<%= text_field_tag('field_name', 'Value') %>| @@ -270,3 +266,14 @@ module Spec end end end + +describe "bug http://rspec.lighthouseapp.com/projects/5645/tickets/510", :type => :view do + describe "a view example with should_not_receive" do + it "should render the view" do + assigns[:model] = mock('model') + assigns[:model].should_receive(:render_partial?).and_return false + template.should_not_receive(:render).with(:partial => 'some_partial') + render "view_spec/should_not_receive" + end + end +end vendor/plugins/rspec-rails/spec/rails/example/view_spec_spec.rb @@ -601,9 +601,6 @@ describe "have_rjs behaviour_type", :type => :controller do with_tag("div", 1) with_tag("#1") end - lambda { - response.should have_rjs(:insert, :top, "test2") - }.should raise_error(SpecFailed) response.should have_rjs(:insert, :bottom) {|rjs| with_tag("div", 1) with_tag("#2") @@ -629,6 +626,17 @@ describe "have_rjs behaviour_type", :type => :controller do with_tag("#4") } end + + it "should find rjs using :insert (positioned)" do + pending("await fix for http://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/982") + render_rjs do |page| + page.insert_html :top, "test1", "<div id=\"1\">foo</div>" + page.insert_html :bottom, "test2", "<div id=\"2\">bar</div>" + end + lambda { + response.should have_rjs(:insert, :top, "test2") + }.should raise_error(SpecFailed) + end end describe "send_email behaviour_type", :type => :controller do vendor/plugins/rspec-rails/spec/rails/matchers/assert_select_spec.rb @@ -40,30 +40,24 @@ describe "include_text", :type => :controller do response.should include_text('text for this') end - it "should fail with matching text" do + it "should fail with incorrect text" do post 'text_action' lambda { - response.should include_text("this is NOT the text for this action") - }.should fail_with("expected to find \"this is NOT the text for this action\" in \"this is the text for this action\"") - end - - it "should fail when a template is rendered" do - post 'some_action' - failure_message = case mode - when 'isolation' - /expected to find \"this is the text for this action\" in \"render_spec\/some_action\"/ - when 'integration' - /expected to find \"this is the text for this action\" in \"\"/ - end - lambda { - response.should include_text("this is the text for this action") - }.should fail_with(failure_message) + response.should include_text("the accordian guy") + }.should fail_with("expected to find \"the accordian guy\" in \"this is the text for this action\"") end it "should pass using should_not with incorrect text" do post 'text_action' response.should_not include_text("the accordian guy") end + + it "should fail when a template is rendered" do + get 'some_action' + lambda { + response.should include_text("this is the text for this action") + }.should fail_with(/expected to find \"this is the text for this action\"/) + end end end end vendor/plugins/rspec-rails/spec/rails/matchers/include_text_spec.rb @@ -6,7 +6,7 @@ require File.dirname(__FILE__) + '/../../spec_helper' integrate_views end controller_name :redirect_spec - + it "redirected to another action" do get 'action_with_redirect_to_somewhere' response.should redirect_to(:action => 'somewhere') vendor/plugins/rspec-rails/spec/rails/matchers/redirect_to_spec.rb @@ -25,6 +25,14 @@ describe "mock_model" do end end +describe "mock_mode with params" do + it "should not mutate its parameters" do + params = {:a => 'b'} + model = mock_model(MockableModel, params) + params.should == {:a => 'b'} + end +end + describe "mock_model with stubbed id", :type => :view do before(:each) do @model = mock_model(MockableModel, :id => 1) @@ -32,6 +40,9 @@ describe "mock_model with stubbed id", :type => :view do it "should be named using the stubbed id value" do @model.instance_variable_get(:@name).should == "MockableModel_1" end + it "should return string of id value for to_param" do + @model.to_param.should == "1" + end end describe "mock_model with null_object", :type => :view do @@ -62,3 +73,18 @@ describe "mock_model as association", :type => :view do @real.mockable_model.should == @mock_model end end + +describe "mock_model #as_new_record" do + it "should say it is a new record" do + mock_model(MockableModel).as_new_record.should be_new_record + end + + it "should have a nil id" do + mock_model(MockableModel).as_new_record.id.should be(nil) + end + + it "should have a nil to_param" do + mock_model(MockableModel).as_new_record.to_param.should be(nil) + end +end + vendor/plugins/rspec-rails/spec/rails/mocks/mock_model_spec.rb @@ -1,96 +1,96 @@ -require File.dirname(__FILE__) + '/../spec_helper' - -describe "script/spec_server file", :shared => true do - attr_accessor :tmbundle_install_directory - attr_reader :animals_yml_path, :original_animals_content - - before do - @animals_yml_path = File.expand_path("#{RAILS_ROOT}/spec/fixtures/animals.yml") - @original_animals_content = File.read(animals_yml_path) - end - - after do - File.open(animals_yml_path, "w") do |f| - f.write original_animals_content - end - end - - after(:each) do - system "lsof -i tcp:8989 | sed /COMMAND/d | awk '{print $2}' | xargs kill" - end - - it "runs a spec" do - dir = File.dirname(__FILE__) - output = "" - Timeout.timeout(10) do - loop do - output = `#{RAILS_ROOT}/script/spec #{dir}/sample_spec.rb --drb 2>&1` - break unless output.include?("No server is running") - end - end - - if $?.exitstatus != 0 || output !~ /0 failures/ - flunk "command 'script/spec spec/sample_spec' failed\n#{output}" - end - - fixtures = YAML.load(@original_animals_content) - fixtures['pig']['name'] = "Piggy" - - File.open(animals_yml_path, "w") do |f| - f.write YAML.dump(fixtures) - end - - Timeout.timeout(10) do - loop do - output = `#{RAILS_ROOT}/script/spec #{dir}/sample_modified_fixture.rb --drb 2>&1` - break unless output.include?("No server is running") - end - end - - if $?.exitstatus != 0 || output !~ /0 failures/ - flunk "command 'script/spec spec/sample_modified_fixture' failed\n#{output}" - end - end - - def start_spec_server - dir = File.dirname(__FILE__) - Thread.start do - system "cd #{RAILS_ROOT}; script/spec_server" - end - - file_content = "" - end -end - -describe "script/spec_server file without TextMate bundle" do - it_should_behave_like "script/spec_server file" - before(:each) do - start_spec_server - end -end - -describe "script/spec_server file with TextMate bundle" do - it_should_behave_like "script/spec_server file" - before(:each) do - dir = File.dirname(__FILE__) - @tmbundle_install_directory = File.expand_path("#{Dir.tmpdir}/Library/Application Support/TextMate/Bundles") - @bundle_name = "RSpec.tmbundle" - FileUtils.mkdir_p(tmbundle_install_directory) - bundle_dir = File.expand_path("#{dir}/../../../../../../#{@bundle_name}") - File.directory?(bundle_dir).should be_true - unless system(%Q|ln -s #{bundle_dir} "#{tmbundle_install_directory}"|) - raise "Creating link to Textmate Bundle" - end - start_spec_server - end - - after(:each) do - bundle_file_to_remove = "#{tmbundle_install_directory}/#{@bundle_name}" - if bundle_file_to_remove == "/" - raise "bundle file path resolved to '/' - could not call rm" - end - unless system(%Q|rm "#{bundle_file_to_remove}"|) - raise "Removing Textmate bundle link failed" - end - end -end +# require File.dirname(__FILE__) + '/../spec_helper' +# +# describe "script/spec_server file", :shared => true do +# attr_accessor :tmbundle_install_directory +# attr_reader :animals_yml_path, :original_animals_content +# +# before do +# @animals_yml_path = File.expand_path("#{RAILS_ROOT}/spec/fixtures/animals.yml") +# @original_animals_content = File.read(animals_yml_path) +# end +# +# after do +# File.open(animals_yml_path, "w") do |f| +# f.write original_animals_content +# end +# end +# +# after(:each) do +# system "lsof -i tcp:8989 | sed /COMMAND/d | awk '{print $2}' | xargs kill" +# end +# +# it "runs a spec" do +# dir = File.dirname(__FILE__) +# output = "" +# Timeout.timeout(10) do +# loop do +# output = `#{RAILS_ROOT}/script/spec #{dir}/sample_spec.rb --drb 2>&1` +# break unless output.include?("No server is running") +# end +# end +# +# if $?.exitstatus != 0 || output !~ /0 failures/ +# flunk "command 'script/spec spec/sample_spec' failed\n#{output}" +# end +# +# fixtures = YAML.load(@original_animals_content) +# fixtures['pig']['name'] = "Piggy" +# +# File.open(animals_yml_path, "w") do |f| +# f.write YAML.dump(fixtures) +# end +# +# Timeout.timeout(10) do +# loop do +# output = `#{RAILS_ROOT}/script/spec #{dir}/sample_modified_fixture.rb --drb 2>&1` +# break unless output.include?("No server is running") +# end +# end +# +# if $?.exitstatus != 0 || output !~ /0 failures/ +# flunk "command 'script/spec spec/sample_modified_fixture' failed\n#{output}" +# end +# end +# +# def start_spec_server +# dir = File.dirname(__FILE__) +# Thread.start do +# system "cd #{RAILS_ROOT}; script/spec_server" +# end +# +# file_content = "" +# end +# end +# +# describe "script/spec_server file without TextMate bundle" do +# it_should_behave_like "script/spec_server file" +# before(:each) do +# start_spec_server +# end +# end +# +# describe "script/spec_server file with TextMate bundle" do +# it_should_behave_like "script/spec_server file" +# before(:each) do +# dir = File.dirname(__FILE__) +# @tmbundle_install_directory = File.expand_path("#{Dir.tmpdir}/Library/Application Support/TextMate/Bundles") +# @bundle_name = "RSpec.tmbundle" +# FileUtils.mkdir_p(tmbundle_install_directory) +# bundle_dir = File.expand_path("#{dir}/../../../../../../#{@bundle_name}") +# File.directory?(bundle_dir).should be_true +# unless system(%Q|ln -s #{bundle_dir} "#{tmbundle_install_directory}"|) +# raise "Creating link to Textmate Bundle" +# end +# start_spec_server +# end +# +# after(:each) do +# bundle_file_to_remove = "#{tmbundle_install_directory}/#{@bundle_name}" +# if bundle_file_to_remove == "/" +# raise "bundle file path resolved to '/' - could not call rm" +# end +# unless system(%Q|rm "#{bundle_file_to_remove}"|) +# raise "Removing Textmate bundle link failed" +# end +# end +# end vendor/plugins/rspec-rails/spec/rails/spec_server_spec.rb @@ -12,7 +12,12 @@ require File.expand_path("#{dir}/../spec_resources/helpers/more_explicit_helper" require File.expand_path("#{dir}/../spec_resources/helpers/view_spec_helper") require File.expand_path("#{dir}/../spec_resources/helpers/plugin_application_helper") -ActionController::Routing.controller_paths << File.expand_path("#{dir}/../spec_resources/controllers") +extra_controller_paths = File.expand_path("#{dir}/../spec_resources/controllers") + +unless ActionController::Routing.controller_paths.include?(extra_controller_paths) + ActionController::Routing.instance_eval {@possible_controllers = nil} + ActionController::Routing.controller_paths << extra_controller_paths +end module Spec module Rails @@ -38,6 +43,12 @@ class Proc end end +Spec::Runner.configure do |config| + config.before(:each, :type => :controller) do + end +end + + ActionController::Routing::Routes.draw do |map| map.resources :rspec_on_rails_specs map.connect 'custom_route', :controller => 'custom_route_spec', :action => 'custom_route' vendor/plugins/rspec-rails/spec/spec_helper.rb @@ -1,4 +1,12 @@ class ControllerSpecController < ActionController::Base + before_filter :raise_error, :only => :action_with_skipped_before_filter + + def raise_error + raise "from a before filter" + end + + skip_before_filter :raise_error + if ['edge','2.0.0'].include?(ENV['RSPEC_RAILS_VERSION']) set_view_path [File.join(File.dirname(__FILE__), "..", "views")] else @@ -54,7 +62,6 @@ class ControllerSpecController < ActionController::Base end def action_setting_the_assigns_hash - assigns['direct_assigns_key'] = :direct_assigns_key_value @indirect_assigns_key = :indirect_assigns_key_value end @@ -74,5 +81,14 @@ class ControllerSpecController < ActionController::Base :partial => 'non_existent_partial' end end + + def action_with_skipped_before_filter + render :text => "" + end end +class ControllerInheritingFromApplicationControllerController < ApplicationController + def action_with_inherited_before_filter + render :text => "" + end +end \ No newline at end of file vendor/plugins/rspec-rails/spec_resources/controllers/controller_spec_controller.rb @@ -23,4 +23,8 @@ class RenderSpecController < ApplicationController def action_that_renders_nothing render :nothing => true end + + def action_with_alternate_layout + render :layout => 'simple' + end end vendor/plugins/rspec-rails/spec_resources/controllers/render_spec_controller.rb @@ -6,6 +6,9 @@ automatically load rspec anymore. This allows rspec to live side by side other spec frameworks without always co-opting autotest through autotest's discovery mechanism. +ALSO IMPORTANT: $rspec_options is gone. If you were using this for anything +(like your own runners), use Spec::Runner.options instead. + * Consider MinGW as valid RUBY_PLATFORM for --colour option. (patch from Luis Lavena). Closes #406. * Added additional characters to be escaped in step strings (patch from Jake Cahoon). Closes #417. * Disable color codes on STDOUT when STDOUT.tty? is false (patch from Tim Pope). Closes #413. @@ -22,6 +25,10 @@ mechanism. * should and should_not return true on success * use hoe for build/release * bye, bye translator +* autotest/rspec uses ruby command instead of spec command (no need for spec command unless loading directories) +* Avoid 'invalid option -O' in autotest (patch from Jonathan del Strother). Closes #486. +* Fix: Unimplemented step with new line throws error (patch from Ben Mabey). Closes #494. +* Only use color codes on tty; override for autospec (patch from Tim Pope). Closes #413. === Version 1.1.4 vendor/plugins/rspec/History.txt @@ -2,7 +2,7 @@ * http://rspec.info * http://rspec.info/rdoc/ -* http://github.com/dchelimsky/rspec-rails/wikis +* http://github.com/dchelimsky/rspec/wikis * mailto:rspec-devel@rubyforge.org == DESCRIPTION: vendor/plugins/rspec/README.txt @@ -25,8 +25,8 @@ end Rake.application.instance_variable_get('@tasks').delete(task) end -task :default => :verify_rcov task :verify_rcov => [:spec, :stories] +task :default => :verify_rcov # # Some of the tasks are in separate files since they are also part of the website documentation load File.dirname(__FILE__) + '/rake_tasks/examples.rake' @@ -41,7 +41,7 @@ Spec::Rake::SpecTask.new do |t| unless ENV['NO_RCOV'] t.rcov = true t.rcov_dir = 'coverage' - t.rcov_opts = ['--exclude', 'lib/spec.rb,lib/spec/runner.rb,spec\/spec,bin\/spec,examples,\/var\/lib\/gems,\/Library\/Ruby,\.autotest'] + t.rcov_opts = ['--exclude', "lib/spec.rb,lib/spec/runner.rb,spec\/spec,bin\/spec,examples,\/var\/lib\/gems,\/Library\/Ruby,\.autotest,#{ENV['GEM_HOME']}"] end end vendor/plugins/rspec/Rakefile @@ -1,3 +1,4 @@ #!/usr/bin/env ruby ENV['RSPEC'] = 'true' -system 'autotest' \ No newline at end of file +ENV['AUTOTEST'] = 'true' +system ("autotest", *ARGV) vendor/plugins/rspec/bin/autospec @@ -1,4 +1,4 @@ #!/usr/bin/env ruby $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib")) require 'spec' -exit ::Spec::Runner::CommandLine.run(rspec_options) +exit ::Spec::Runner::CommandLine.run vendor/plugins/rspec/bin/spec @@ -36,37 +36,11 @@ class Autotest::Rspec < Autotest end def make_test_cmd(files_to_test) - return "#{ruby} -S #{spec_command} #{add_options_if_present} #{files_to_test.keys.flatten.join(' ')}" + return '' if files_to_test.empty? + return "#{ruby} -S #{files_to_test.keys.flatten.join(' ')} #{add_options_if_present}" end def add_options_if_present # :nodoc: File.exist?("spec/spec.opts") ? "-O spec/spec.opts " : "" end - - # Finds the proper spec command to use. Precendence is set in the - # lazily-evaluated method spec_commands. Alias + Override that in - # ~/.autotest to provide a different spec command then the default - # paths provided. - def spec_command(separator=File::ALT_SEPARATOR) - unless defined? @spec_command then - @spec_command = spec_commands.find { |cmd| File.exists? cmd } - - raise RspecCommandError, "No spec command could be found!" unless @spec_command - - @spec_command.gsub! File::SEPARATOR, separator if separator - end - @spec_command - end - - # Autotest will look for spec commands in the following - # locations, in this order: - # - # * bin/spec - # * default spec bin/loader installed in Rubygems - def spec_commands - [ - File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'bin', 'spec')), - File.join(Config::CONFIG['bindir'], 'spec') - ] - end end vendor/plugins/rspec/lib/autotest/rspec.rb @@ -13,16 +13,13 @@ end module Spec class << self def run? - @run || rspec_options.examples_run? + Runner.options.examples_run? end def run return true if run? - result = rspec_options.run_examples - @run = true - result + Runner.options.run_examples end - attr_writer :run def exit? !Object.const_defined?(:Test) || Test::Unit.run? vendor/plugins/rspec/lib/spec.rb @@ -1,6 +1,12 @@ module Spec module Example class ExamplePendingError < StandardError + def initialize(a_message=nil) + super + @pending_caller = caller[2] + end + + attr_reader :pending_caller end class PendingExampleFixedError < StandardError vendor/plugins/rspec/lib/spec/example/errors.rb @@ -171,7 +171,7 @@ module Spec def examples #:nodoc: examples = example_objects.dup add_method_examples(examples) - rspec_options.reverse ? examples.reverse : examples + Spec::Runner.options.reverse ? examples.reverse : examples end def number_of_examples #:nodoc: @@ -252,11 +252,11 @@ module Spec def register(&registration_binding_block) @registration_binding_block = registration_binding_block - rspec_options.add_example_group self + Spec::Runner.options.add_example_group self end def unregister #:nodoc: - rspec_options.remove_example_group self + Spec::Runner.options.remove_example_group self end def registration_backtrace @@ -278,8 +278,8 @@ module Spec private def dry_run(examples) examples.each do |example| - rspec_options.reporter.example_started(example) - rspec_options.reporter.example_finished(example) + Spec::Runner.options.reporter.example_started(example) + Spec::Runner.options.reporter.example_finished(example) end return true end @@ -302,7 +302,7 @@ module Spec after_all_instance_variables = instance_variables examples.each do |example_group_instance| - success &= example_group_instance.execute(rspec_options, instance_variables) + success &= example_group_instance.execute(Spec::Runner.options, instance_variables) after_all_instance_variables = example_group_instance.instance_variable_hash end return [success, after_all_instance_variables] @@ -335,15 +335,15 @@ module Spec end def specified_examples - rspec_options.examples + Spec::Runner.options.examples end def reporter - rspec_options.reporter + Spec::Runner.options.reporter end def dry_run? - rspec_options.dry_run + Spec::Runner.options.dry_run end def example_objects @@ -398,7 +398,7 @@ module Spec case scope when :each; before_each_parts when :all; before_all_parts - when :suite; rspec_options.before_suite_parts + when :suite; Spec::Runner.options.before_suite_parts end end @@ -406,7 +406,7 @@ module Spec case scope when :each; after_each_parts when :all; after_all_parts - when :suite; rspec_options.after_suite_parts + when :suite; Spec::Runner.options.after_suite_parts end end vendor/plugins/rspec/lib/spec/example/example_group_methods.rb @@ -23,7 +23,7 @@ module Spec raise ArgumentError if args.empty? raise ArgumentError unless block args << {} unless Hash === args.last - args.last[:spec_path] = caller(0)[1] + args.last[:spec_path] = File.expand_path(caller(0)[1]) Spec::Example::ExampleGroupFactory.create_example_group(*args, &block) end alias :context :describe @@ -80,23 +80,8 @@ module Spec raise NameError.new(e.message + "\nThe first argument to share_as must be a legal name for a constant\n") end end - - private - - def rspec_options - $rspec_options ||= begin; \ - parser = ::Spec::Runner::OptionParser.new(STDERR, STDOUT); \ - parser.order!(ARGV); \ - $rspec_options = parser.options; \ - end - $rspec_options - end - - def init_rspec_options(options) - $rspec_options = options if $rspec_options.nil? - end end end end -include Spec::Extensions::Main \ No newline at end of file +include Spec::Extensions::Main vendor/plugins/rspec/lib/spec/extensions/main.rb @@ -27,9 +27,9 @@ EOF end def execute_change - @before = @block.nil? ? @receiver.send(@message) : @block.call + @before = @block.nil? ? @receiver.__send__(@message) : @block.call @target.call - @after = @block.nil? ? @receiver.send(@message) : @block.call + @after = @block.nil? ? @receiver.__send__(@message) : @block.call end def failure_message vendor/plugins/rspec/lib/spec/matchers/change.rb @@ -8,7 +8,7 @@ module Spec end def matches?(target) - target.send(predicate, *@args) + target.__send__(predicate, *@args) end def failure_message vendor/plugins/rspec/lib/spec/matchers/has.rb @@ -1,6 +1,5 @@ module Spec module Matchers - class Have #:nodoc: def initialize(expected, relativity=:exactly) @expected = (expected == :no ? 0 : expected) @@ -15,25 +14,15 @@ module Spec } end - def method_missing(sym, *args, &block) - @collection_name = sym - if inflector = (defined?(ActiveSupport::Inflector) ? ActiveSupport::Inflector : (defined?(Inflector) ? Inflector : nil)) - @plural_collection_name = inflector.pluralize(sym.to_s) - end - @args = args - @block = block - self - end - def matches?(collection_owner) if collection_owner.respond_to?(@collection_name) - collection = collection_owner.send(@collection_name, *@args, &@block) + collection = collection_owner.__send__(@collection_name, *@args, &@block) elsif (@plural_collection_name && collection_owner.respond_to?(@plural_collection_name)) - collection = collection_owner.send(@plural_collection_name, *@args, &@block) + collection = collection_owner.__send__(@plural_collection_name, *@args, &@block) elsif (collection_owner.respond_to?(:length) || collection_owner.respond_to?(:size)) collection = collection_owner else - collection_owner.send(@collection_name, *@args, &@block) + collection_owner.__send__(@collection_name, *@args, &@block) end @actual = collection.size if collection.respond_to?(:size) @actual = collection.length if collection.respond_to?(:length) @@ -77,8 +66,22 @@ EOF "have #{relative_expectation} #{@collection_name}" end + def respond_to?(sym) + @expected.respond_to?(sym) || super + end + private + def method_missing(sym, *args, &block) + @collection_name = sym + if inflector = (defined?(ActiveSupport::Inflector) ? ActiveSupport::Inflector : (defined?(Inflector) ? Inflector : nil)) + @plural_collection_name = inflector.pluralize(sym.to_s) + end + @args = args + @block = block + self + end + def relative_expectation "#{relativities[@relativity]}#{@expected}" end vendor/plugins/rspec/lib/spec/matchers/have.rb @@ -57,7 +57,7 @@ module Spec def __delegate_method_missing_to_target(operator, expected) @operator = operator ::Spec::Matchers.last_matcher = self - return true if @target.send(operator, expected) + return true if @target.__send__(operator, expected) return fail_with_message("expected: #{expected.inspect},\n got: #{@target.inspect} (using #{operator})") if ['==','===', '=~'].include?(operator) return fail_with_message("expected: #{operator} #{expected.inspect},\n got: #{operator.gsub(/./, ' ')} #{@target.inspect}") end @@ -69,7 +69,7 @@ module Spec def __delegate_method_missing_to_target(operator, expected) @operator = operator ::Spec::Matchers.last_matcher = self - return true unless @target.send(operator, expected) + return true unless @target.__send__(operator, expected) return fail_with_message("expected not: #{operator} #{expected.inspect},\n got: #{operator.gsub(/./, ' ')} #{@target.inspect}") end vendor/plugins/rspec/lib/spec/matchers/operator_matcher.rb @@ -3,6 +3,10 @@ module Spec class BaseExpectation attr_reader :sym + attr_writer :expected_received_count, :method_block, :expected_from, :args_to_yield + protected :expected_received_count=, :method_block=, :expected_from=, :args_to_yield= + attr_accessor :error_generator + protected :error_generator, :error_generator= def initialize(error_generator, expectation_ordering, expected_from, sym, method_block, expected_received_count=1, opts={}) @error_generator = error_generator @@ -23,6 +27,23 @@ module Spec @args_to_yield = [] end + def build_child(expected_from, method_block, expected_received_count, opts={}) + child = clone + child.expected_from = expected_from + child.method_block = method_block + child.expected_received_count = expected_received_count + new_gen = error_generator.clone + new_gen.opts = opts + child.error_generator = new_gen + child.args_to_yield = @args_to_yield.clone + child + end + + def error_generator_opts=(opts={}) + @error_generator.opts = opts + end + protected :error_generator_opts= + def expected_args @args_expectation.args end @@ -103,6 +124,11 @@ module Spec @actual_received_count += 1 end end + + def called_max_times? + @expected_received_count != :any && + @actual_received_count >= @expected_received_count + end protected vendor/plugins/rspec/lib/spec/mocks/message_expectation.rb @@ -9,8 +9,12 @@ module Spec __mock_proxy.add_negative_message_expectation(caller(1)[0], sym.to_sym, &block) end - def stub!(sym, opts={}) - __mock_proxy.add_stub(caller(1)[0], sym.to_sym, opts) + def stub!(sym_or_hash, opts={}) + if Hash === sym_or_hash + sym_or_hash.each {|method, value| stub!(method).and_return value } + else + __mock_proxy.add_stub(caller(1)[0], sym_or_hash.to_sym, opts) + end end def received_message?(sym, *args, &block) #:nodoc: @@ -24,6 +28,14 @@ module Spec def rspec_reset #:nodoc: __mock_proxy.reset end + + def as_null_object + __mock_proxy.act_as_null_object + end + + def null_object? + __mock_proxy.null_object? + end private vendor/plugins/rspec/lib/spec/mocks/methods.rb @@ -20,10 +20,20 @@ module Spec def null_object? @options[:null_object] end + + def act_as_null_object + @options[:null_object] = true + @target + end def add_message_expectation(expected_from, sym, opts={}, &block) __add sym - @expectations << MessageExpectation.new(@error_generator, @expectation_ordering, expected_from, sym, block_given? ? block : nil, 1, opts) + if existing_stub = @stubs.detect {|s| s.sym == sym } + expectation = existing_stub.build_child(expected_from, block_given?? block : nil, 1, opts) + else + expectation = MessageExpectation.new(@error_generator, @expectation_ordering, expected_from, sym, block_given? ? block : nil, 1, opts) + end + @expectations << expectation @expectations.last end @@ -61,13 +71,17 @@ module Spec end def message_received(sym, *args, &block) - if expectation = find_matching_expectation(sym, *args) - expectation.invoke(args, block) - elsif (stub = find_matching_method_stub(sym, *args)) + expectation = find_matching_expectation(sym, *args) + stub = find_matching_method_stub(sym, *args) + + if (stub && expectation && expectation.called_max_times?) || + (stub && !expectation) if expectation = find_almost_matching_expectation(sym, *args) expectation.advise(args, block) unless expectation.expected_messages_received? end stub.invoke([], block) + elsif expectation + expectation.invoke(args, block) elsif expectation = find_almost_matching_expectation(sym, *args) expectation.advise(args, block) if null_object? unless expectation.expected_messages_received? raise_unexpected_message_args_error(expectation, *args) unless (has_negative_expectation?(sym) or null_object?) vendor/plugins/rspec/lib/spec/mocks/proxy.rb @@ -35,11 +35,11 @@ module RCov def define desc "Verify that rcov coverage is at least #{threshold}%" task @name do - total_coverage = nil + total_coverage = 0 File.open(index_html).each_line do |line| - if line =~ /<tt class='coverage_total'>(\d+\.\d+)%<\/tt>/ - total_coverage = eval($1) + if line =~ /<tt class='coverage_total'>\s*(\d+\.\d+)%\s*<\/tt>/ + total_coverage = $1.to_f break end end vendor/plugins/rspec/lib/spec/rake/verify_rcov.rb @@ -185,17 +185,30 @@ module Spec end def register_at_exit_hook # :nodoc: - $spec_runner_at_exit_hook_registered ||= nil - unless $spec_runner_at_exit_hook_registered + @spec_runner_at_exit_hook_registered ||= nil + unless @spec_runner_at_exit_hook_registered at_exit do unless $! || Spec.run? success = Spec.run exit success if Spec.exit? end end - $spec_runner_at_exit_hook_registered = true + @spec_runner_at_exit_hook_registered = true end end + + def options # :nodoc: + @options ||= begin + parser = ::Spec::Runner::OptionParser.new(STDERR, STDOUT) + parser.order!(ARGV) + parser.options + end + end + + def use options + @options = options + end + end end end vendor/plugins/rspec/lib/spec/runner.rb @@ -40,15 +40,14 @@ module Spec def tweak_backtrace(error) return if error.backtrace.nil? - error.backtrace.collect! do |line| - clean_up_double_slashes(line) - IGNORE_PATTERNS.each do |ignore| - if line =~ ignore - line = nil - break + error.backtrace.collect! do |message| + clean_up_double_slashes(message) + kept_lines = message.split("\n").select do |line| + IGNORE_PATTERNS.each do |ignore| + break if line =~ ignore end end - line + kept_lines.empty?? nil : kept_lines.join("\n") end error.backtrace.compact! end vendor/plugins/rspec/lib/spec/runner/backtrace_tweaker.rb @@ -2,25 +2,14 @@ require 'spec/runner/option_parser' module Spec module Runner - # Facade to run specs without having to fork a new ruby process (using `spec ...`) class CommandLine class << self - # Runs specs. +argv+ is the commandline args as per the spec commandline API, +err+ - # and +out+ are the streams output will be written to. - def run(instance_rspec_options) - # NOTE - this call to init_rspec_options is not spec'd, but neither is any of this - # swapping of $rspec_options. That is all here to enable rspec to run against itself - # and maintain coverage in a single process. Therefore, DO NOT mess with this stuff - # unless you know what you are doing! - init_rspec_options(instance_rspec_options) - orig_rspec_options = rspec_options - begin - $rspec_options = instance_rspec_options - return $rspec_options.run_examples - ensure - ::Spec.run = true - $rspec_options = orig_rspec_options - end + def run(tmp_options=Spec::Runner.options) + orig_options = Spec::Runner.options + Spec::Runner.use tmp_options + tmp_options.run_examples + ensure + Spec::Runner.use orig_options end end end vendor/plugins/rspec/lib/spec/runner/command_line.rb @@ -45,7 +45,9 @@ module Spec # been provided a block), or when an ExamplePendingError is raised. # +message+ is the message from the ExamplePendingError, if it exists, or the # default value of "Not Yet Implemented" - def example_pending(example, message) + # +pending_caller+ is the file and line number of the spec which + # has called the pending method + def example_pending(example, message, pending_caller) end # This method is invoked after all of the examples have executed. The next method vendor/plugins/rspec/lib/spec/runner/formatter/base_formatter.rb @@ -15,19 +15,14 @@ module Spec super if where.is_a?(String) @output = File.open(where, 'w') - elsif where == STDOUT - @output = Kernel - def @output.flush - STDOUT.flush - end else @output = where end @pending_examples = [] end - def example_pending(example, message) - @pending_examples << [example.__full_description, message] + def example_pending(example, message, pending_caller) + @pending_examples << [example.__full_description, message, pending_caller] end def dump_failure(counter, failure) @@ -75,13 +70,14 @@ module Spec @output.puts "Pending:" @pending_examples.each do |pending_example| @output.puts "#{pending_example[0]} (#{pending_example[1]})" + @output.puts " Called from #{pending_example[2]}" end end @output.flush end def close - if IO === @output + if IO === @output && @output != STDOUT @output.close end end @@ -112,7 +108,7 @@ module Spec def output_to_tty? begin - @output == Kernel || @output.tty? + @output.tty? || ENV.has_key?("AUTOTEST") rescue NoMethodError false end vendor/plugins/rspec/lib/spec/runner/formatter/base_text_formatter.rb @@ -85,7 +85,7 @@ module Spec @output.flush end - def example_pending(example, message) + def example_pending(example, message, pending_caller) @output.puts " <script type=\"text/javascript\">makeYellow('rspec-header');</script>" unless @header_red @output.puts " <script type=\"text/javascript\">makeYellow('example_group_#{example_group_number}');</script>" unless @example_group_red move_progress vendor/plugins/rspec/lib/spec/runner/formatter/html_formatter.rb @@ -40,7 +40,7 @@ module Spec output.flush end - def example_pending(example, message) + def example_pending(example, message, pending_caller) super output.puts yellow("#{current_indentation}#{example.description} (PENDING: #{message})") output.flush vendor/plugins/rspec/lib/spec/runner/formatter/nested_text_formatter.rb @@ -14,7 +14,7 @@ module Spec @output.flush end - def example_pending(example, message) + def example_pending(example, message, pending_caller) super @output.print yellow('P') @output.flush vendor/plugins/rspec/lib/spec/runner/formatter/progress_bar_formatter.rb @@ -28,7 +28,7 @@ module Spec output.flush end - def example_pending(example, message) + def example_pending(example, message, pending_caller) super output.puts yellow("- #{example.description} (PENDING: #{message})") output.flush vendor/plugins/rspec/lib/spec/runner/formatter/specdoc_formatter.rb @@ -86,6 +86,7 @@ EOF end def scenario_started(story_title, scenario_name) + @previous_type = nil @scenario_failed = false @scenario_text = <<-EOF <dt>Scenario: #{h scenario_name}</dt> @@ -149,10 +150,22 @@ EOF spans = args.map { |arg| "<span class=\"param\">#{arg}</span>" } desc_string = description.step_name arg_regexp = description.arg_regexp + inner = if(type == @previous_type) + "And " + else + "#{type.to_s.capitalize} " + end i = -1 - inner = type.to_s.capitalize + ' ' + desc_string.gsub(arg_regexp) { |param| spans[i+=1] } + inner += desc_string.gsub(arg_regexp) { |param| spans[i+=1] } + @scenario_text += " <li class=\"#{klass}\">#{inner}</li>\n" + if type == :'given scenario' + @previous_type = :given + else + @previous_type = type + end + end end end vendor/plugins/rspec/lib/spec/runner/formatter/story/html_formatter.rb @@ -104,7 +104,14 @@ module Spec end def run_ended - @output.puts "#@count scenarios: #@successful_scenario_count succeeded, #{@failed_scenarios.size} failed, #@pending_scenario_count pending" + summary_text = "#@count scenarios: #@successful_scenario_count succeeded, #{@failed_scenarios.size} failed, #@pending_scenario_count pending" + if !@failed_scenarios.empty? + @output.puts red(summary_text) + elsif !@pending_steps.empty? + @output.puts yellow(summary_text) + else + @output.puts green(summary_text) + end unless @pending_steps.empty? @output.puts "\nPending Steps:" @pending_steps.each_with_index do |pending, i| @@ -116,11 +123,10 @@ module Spec @output.print "\nFAILURES:" @failed_scenarios.each_with_index do |failure, i| title, scenario_name, err = failure - @output.print %[ - #{i+1}) #{title} (#{scenario_name}) FAILED - #{err.class}: #{err.message} - #{err.backtrace.join("\n")} -] + @output.print "\n #{i+1}) " + @output.print red("#{title} (#{scenario_name}) FAILED") + @output.print red("\n #{err.class}: #{err.message}") + @output.print "\n #{err.backtrace.join("\n")}\n" end end end vendor/plugins/rspec/lib/spec/runner/formatter/story/plain_text_formatter.rb @@ -25,7 +25,7 @@ module Spec def heckle_method(class_name, method_name) verify_constant(class_name) - heckle = @heckle_class.new(class_name, method_name, rspec_options) + heckle = @heckle_class.new(class_name, method_name, Spec::Runner.options) heckle.validate end @@ -39,7 +39,7 @@ module Spec classes.each do |klass| klass.instance_methods(false).each do |method_name| - heckle = @heckle_class.new(klass.name, method_name, rspec_options) + heckle = @heckle_class.new(klass.name, method_name, Spec::Runner.options) heckle.validate end end vendor/plugins/rspec/lib/spec/runner/heckle_runner.rb @@ -54,6 +54,7 @@ module Spec "Builtin formats for stories: ", "plain|p : Plain Text", "html|h : A nice HTML report", + "progress|r : Text progress", " ", "FORMAT can also be the name of a custom formatter class", "(in which case you should also specify --require to load it)"], vendor/plugins/rspec/lib/spec/runner/option_parser.rb @@ -24,10 +24,13 @@ module Spec } STORY_FORMATTERS = { - 'plain' => ['spec/runner/formatter/story/plain_text_formatter', 'Formatter::Story::PlainTextFormatter'], - 'p' => ['spec/runner/formatter/story/plain_text_formatter', 'Formatter::Story::PlainTextFormatter'], - 'html' => ['spec/runner/formatter/story/html_formatter', 'Formatter::Story::HtmlFormatter'], - 'h' => ['spec/runner/formatter/story/html_formatter', 'Formatter::Story::HtmlFormatter'] + 'plain' => ['spec/runner/formatter/story/plain_text_formatter', 'Formatter::Story::PlainTextFormatter'], + 'p' => ['spec/runner/formatter/story/plain_text_formatter', 'Formatter::Story::PlainTextFormatter'], + 'html' => ['spec/runner/formatter/story/html_formatter', 'Formatter::Story::HtmlFormatter'], + 'h' => ['spec/runner/formatter/story/html_formatter', 'Formatter::Story::HtmlFormatter'], + 'progress' => ['spec/runner/formatter/story/progress_bar_formatter', 'Formatter::Story::ProgressBarFormatter'], + 'r' => ['spec/runner/formatter/story/progress_bar_formatter', 'Formatter::Story::ProgressBarFormatter'] + } attr_accessor( @@ -54,7 +57,7 @@ module Spec :argv ) attr_reader :colour, :differ_class, :files, :example_groups - + def initialize(error_stream, output_stream) @error_stream = error_stream @output_stream = output_stream @@ -89,9 +92,6 @@ module Spec return true unless examples_should_be_run? success = true begin - before_suite_parts.each do |part| - part.call - end runner = custom_runner || ExampleGroupRunner.new(self) unless @files_loaded @@ -99,6 +99,15 @@ module Spec @files_loaded = true end + # TODO - this has to happen after the files get loaded, + # otherwise the before_suite_parts are not populated + # from the configuration. There is no spec for this + # directly, but stories/configuration/before_blocks.story + # will fail if this happens before the files are loaded. + before_suite_parts.each do |part| + part.call + end + if example_groups.empty? true else vendor/plugins/rspec/lib/spec/runner/options.rb @@ -1,6 +1,11 @@ module Spec module Runner class Reporter + PENDING_FORMATTER_DEPRECATION_MESSAGE = <<-HERE + Formatter deprecation: pending_example now takes three arguments, not two. + See http://rspec.info/deprecation_warnings for more info + HERE + attr_reader :options, :example_groups def initialize(options) @@ -26,7 +31,7 @@ module Spec if error.nil? example_passed(example) elsif Spec::Example::ExamplePendingError === error - example_pending(example, error.message) + example_pending(example, error.pending_caller, error.message) else example_failed(example, error) end @@ -104,13 +109,26 @@ module Spec formatters.each{|f| f.example_passed(example)} end - def example_pending(example, message="Not Yet Implemented") + def example_pending(example, pending_caller, message="Not Yet Implemented") @pending_count += 1 - formatters.each do |f| - f.example_pending(example, message) + formatters.each do |formatter| + if pending_method_deprecated_on_formatter?(formatter) + warn_with_deprecation_message PENDING_FORMATTER_DEPRECATION_MESSAGE + formatter.example_pending(example, message) + else + formatter.example_pending(example, message, pending_caller) + end end end + def pending_method_deprecated_on_formatter?(formatter) + formatter.method(:example_pending).arity == 2 + end + + def warn_with_deprecation_message(message) + Kernel.warn(message) + end + class Failure attr_reader :example, :exception vendor/plugins/rspec/lib/spec/runner/reporter.rb @@ -11,7 +11,7 @@ module Spec def spec_name_for(file, line_number) best_match.clear file = File.expand_path(file) - rspec_options.example_groups.each do |example_group| + Spec::Runner.options.example_groups.each do |example_group| consider_example_groups_for_best_match example_group, file, line_number example_group.examples.each do |example| vendor/plugins/rspec/lib/spec/runner/spec_parser.rb @@ -10,8 +10,7 @@ module Spec module Runner class << self def run_options # :nodoc: - rspec_options - # @run_options ||= ::Spec::Runner::OptionParser.parse(ARGV, $stderr, $stdout) + Spec::Runner.options end def story_runner # :nodoc: vendor/plugins/rspec/lib/spec/story/runner.rb @@ -19,11 +19,11 @@ module Spec end def matches?(name) - !(matches = name.match(@expression)).nil? + !(name.strip =~ @expression).nil? end def parse_args(name) - name.match(@expression)[1..-1] + name.strip.match(@expression)[1..-1] end private @@ -60,7 +60,7 @@ module Spec expression = string_or_regexp.source end while expression =~ PARAM_PATTERN - expression.gsub!($2, "(.*?)") + expression.sub!($2, "(.*?)") end @expression = Regexp.new("\\A#{expression}\\Z", Regexp::MULTILINE) end vendor/plugins/rspec/lib/spec/story/step.rb @@ -13,7 +13,8 @@ module Spec @steps.add(type, step) end - def find(type, name) + def find(type, unstripped_name) + name = unstripped_name.strip if @steps.find(type, name).nil? @steps.add(type, Step.new(name) do vendor/plugins/rspec/lib/spec/story/step_mother.rb @@ -2,6 +2,6 @@ require 'rake' require 'spec/rake/verify_rcov' RCov::VerifyTask.new(:verify_rcov => :spec) do |t| - t.threshold = 100.0 # Make sure you have rcov 0.7 or higher! + t.threshold = 100.0 t.index_html = 'coverage/index.html' end vendor/plugins/rspec/rake_tasks/verify_rcov.rake @@ -37,62 +37,6 @@ HERE end describe Rspec do - describe "selection of rspec command" do - include AutotestHelper - - before(:each) do - common_setup - @rspec_autotest = Rspec.new - end - - it "should try to find the spec command if it exists in ./bin and use it above everything else" do - File.stub!(:exists?).and_return true - - spec_path = File.expand_path("#{File.dirname(__FILE__)}/../../bin/spec") - File.should_receive(:exists?).with(spec_path).and_return true - @rspec_autotest.spec_command.should == spec_path - end - - it "should otherwise select the default spec command in gem_dir/bin/spec" do - @rspec_autotest.stub!(:spec_commands).and_return ["/foo/spec"] - Config::CONFIG.stub!(:[]).and_return "/foo" - File.should_receive(:exists?).with("/foo/spec").and_return(true) - - @rspec_autotest.spec_command.should == "/foo/spec" - end - - it "should raise an error if no spec command is found at all" do - File.stub!(:exists?).and_return false - - lambda { - @rspec_autotest.spec_command - }.should raise_error(RspecCommandError, "No spec command could be found!") - end - end - - describe "selection of rspec command (windows compatibility issues)" do - include AutotestHelper - - before(:each) do - common_setup - end - - it "should use the ALT_SEPARATOR if it is non-nil" do - @rspec_autotest = Rspec.new - spec_command = File.expand_path("#{File.dirname(__FILE__)}/../../bin/spec") - @rspec_autotest.stub!(:spec_commands).and_return [spec_command] - @rspec_autotest.spec_command(@windows_alt_separator).should == spec_command.gsub('/', @windows_alt_separator) - end - - it "should not use the ALT_SEPATOR if it is nil" do - @windows_alt_separator = nil - @rspec_autotest = Rspec.new - spec_command = File.expand_path("#{File.dirname(__FILE__)}/../../bin/spec") - @rspec_autotest.stub!(:spec_commands).and_return [spec_command] - @rspec_autotest.spec_command.should == spec_command - end - end - describe "adding spec.opts --options" do before(:each) do @rspec_autotest = Rspec.new @@ -116,7 +60,6 @@ HERE @rspec_autotest.stub!(:add_options_if_present).and_return "-O spec/spec.opts" @ruby = @rspec_autotest.ruby - @spec_command = @rspec_autotest.spec_command @options = @rspec_autotest.add_options_if_present @files_to_test = { :spec => ["file_one", "file_two"] @@ -126,16 +69,13 @@ HERE @files_to_test.stub!(:keys).and_return @files_to_test[:spec] @to_test = @files_to_test.keys.flatten.join ' ' end - - it "should contain the various commands, ordered by preference" do - Rspec.new.spec_commands.should == [ - File.expand_path("#{File.dirname(__FILE__)}/../../bin/spec"), - "#{Config::CONFIG['bindir']}/spec" - ] - end - it "should make the apropriate test command" do - @rspec_autotest.make_test_cmd(@files_to_test).should == "#{@ruby} -S #{@spec_command} #{@options} #{@to_test}" + it "should make the appropriate test command" do + @rspec_autotest.make_test_cmd(@files_to_test).should == "#{@ruby} -S #{@to_test} #{@options}" + end + + it "should return a blank command for no files" do + @rspec_autotest.make_test_cmd({}).should == '' end end vendor/plugins/rspec/spec/autotest/rspec_spec.rb @@ -125,14 +125,14 @@ module Spec it "should register ExampleGroup by default" do example_group = Spec::Example::ExampleGroupFactory.create_example_group("The ExampleGroup") do end - rspec_options.example_groups.should include(example_group) + Spec::Runner.options.example_groups.should include(example_group) end it "should enable unregistering of ExampleGroups" do example_group = Spec::Example::ExampleGroupFactory.create_example_group("The ExampleGroup") do unregister end - rspec_options.example_groups.should_not include(example_group) + Spec::Runner.options.example_groups.should_not include(example_group) end after(:each) do vendor/plugins/rspec/spec/spec/example/example_group_factory_spec.rb @@ -3,10 +3,12 @@ require File.dirname(__FILE__) + '/../../spec_helper' module Spec module Example describe 'ExampleGroupMethods' do - it_should_behave_like "sandboxed rspec_options" + include SandboxedOptions attr_reader :example_group, :result, :reporter before(:each) do - options.formatters << mock("formatter", :null_object => true) + # See http://rspec.lighthouseapp.com/projects/5645-rspec/tickets/525-arity-changed-on-partial-mocks#ticket-525-2 + method_with_three_args = lambda { |arg1, arg2, arg3| } + options.formatters << mock("formatter", :null_object => true, :example_pending => method_with_three_args) options.backtrace_tweaker = mock("backtrace_tweaker", :null_object => true) @reporter = FakeReporter.new(@options) options.reporter = reporter vendor/plugins/rspec/spec/spec/example/example_group_methods_spec.rb @@ -65,10 +65,11 @@ module Spec end describe ExampleGroup, "#run" do - it_should_behave_like "sandboxed rspec_options" + include SandboxedOptions attr_reader :example_group, :formatter, :reporter before :each do - @formatter = mock("formatter", :null_object => true) + method_with_three_args = lambda { |arg1, arg2, arg3| } + @formatter = mock("formatter", :null_object => true, :example_pending => method_with_three_args) options.formatters << formatter options.backtrace_tweaker = mock("backtrace_tweaker", :null_object => true) @reporter = FakeReporter.new(options) vendor/plugins/rspec/spec/spec/example/example_group_spec.rb @@ -23,9 +23,9 @@ module Spec describe "lifecycle" do before do - @original_rspec_options = $rspec_options + @original_rspec_options = Spec::Runner.options @options = ::Spec::Runner::Options.new(StringIO.new, StringIO.new) - $rspec_options = @options + Spec::Runner.use @options @options.formatters << mock("formatter", :null_object => true) @options.backtrace_tweaker = mock("backtrace_tweaker", :null_object => true) @reporter = FakeReporter.new(@options) @@ -43,7 +43,7 @@ module Spec end after do - $rspec_options = @original_rspec_options + Spec::Runner.use @original_rspec_options ExampleMethods.instance_variable_set("@before_all_parts", []) ExampleMethods.instance_variable_set("@before_each_parts", []) ExampleMethods.instance_variable_set("@after_each_parts", []) vendor/plugins/rspec/spec/spec/example/example_methods_spec.rb @@ -38,5 +38,32 @@ module Spec }.should raise_error(PendingExampleFixedError, /TODO/) end end + + describe ExamplePendingError do + it "should have the caller (from two calls from initialization)" do + two_calls_ago = caller[0] + ExamplePendingError.new("a message").pending_caller.should == two_calls_ago + end + + it "should keep the trace information from initialization" do + two_calls_ago = caller[0] + obj = ExamplePendingError.new("a message") + obj.pending_caller + def another_caller(obj) + obj.pending_caller + end + + another_caller(obj).should == two_calls_ago + end + + it "should have the message provided" do + ExamplePendingError.new("a message").message.should == "a message" + end + + it "should use a 'ExamplePendingError' as it's default message" do + ExamplePendingError.new.message.should == "Spec::Example::ExamplePendingError" + end + end + end end vendor/plugins/rspec/spec/spec/example/pending_module_spec.rb @@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/../../spec_helper' module Spec module Example describe ExampleGroup, "with :shared => true" do - it_should_behave_like "sandboxed rspec_options" + include SandboxedOptions attr_reader :formatter, :example_group before(:each) do @formatter = Spec::Mocks::Mock.new("formatter", :null_object => true) vendor/plugins/rspec/spec/spec/example/shared_example_group_spec.rb @@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/../../spec_helper.rb' module Spec module Extensions describe Main do - it_should_behave_like "sandboxed rspec_options" + include SandboxedOptions before(:each) do @main = Class.new do; include Main; end end @@ -12,11 +12,6 @@ module Spec $rspec_story_steps = @original_rspec_story_steps end - it "should create an Options object" do - @main.send(:rspec_options).should be_instance_of(Spec::Runner::Options) - @main.send(:rspec_options).should === $rspec_options - end - specify {@main.should respond_to(:describe)} specify {@main.should respond_to(:context)} @@ -30,7 +25,7 @@ module Spec it "should registered ExampleGroups by default" do example_group = @main.describe("The ExampleGroup") do end - rspec_options.example_groups.should include(example_group) + Spec::Runner.options.example_groups.should include(example_group) end it "should not run unregistered ExampleGroups" do @@ -38,7 +33,7 @@ module Spec unregister end - rspec_options.example_groups.should_not include(example_group) + Spec::Runner.options.example_groups.should_not include(example_group) end it "should create a shared ExampleGroup with share_examples_for" do vendor/plugins/rspec/spec/spec/extensions/main_spec.rb @@ -315,3 +315,15 @@ describe "should change{ block }.from(old).to(new)" do lambda { @instance.some_value = "cat" }.should change{@instance.some_value}.from("string").to("cat") end end + +describe Spec::Matchers::Change do + it "should work when the receiver has implemented #send" do + @instance = SomethingExpected.new + @instance.some_value = "string" + def @instance.send(*args); raise "DOH! Library developers shouldn't use #send!" end + + lambda { + lambda { @instance.some_value = "cat" }.should change(@instance, :some_value) + }.should_not raise_error + end +end vendor/plugins/rspec/spec/spec/matchers/change_spec.rb @@ -51,3 +51,13 @@ describe "should_not have_sym(*args)" do lambda { o.should_not have_sym(:foo) }.should raise_error("Funky exception") end end + +describe Spec::Matchers::Has do + it "should work when the target implements #send" do + o = {:a => "A"} + def o.send(*args); raise "DOH! Library developers shouldn't use #send!" end + lambda { + o.should have_key(:a) + }.should_not raise_error + end +end vendor/plugins/rspec/spec/spec/matchers/has_spec.rb @@ -324,3 +324,71 @@ describe "have(n).things on an object which is not a collection nor contains one lambda { Object.new.should have(2).things }.should raise_error(NoMethodError, /undefined method `things' for #<Object:/) end end + +describe Spec::Matchers::Have, "for a collection owner that implements #send" do + include HaveSpecHelper + + before(:each) do + @collection = Object.new + def @collection.floozles; [1,2] end + def @collection.send(*args); raise "DOH! Library developers shouldn't use #send!" end + end + + it "should work in the straightforward case" do + lambda { + @collection.should have(2).floozles + }.should_not raise_error + end + + it "should work when doing automatic pluralization" do + lambda { + @collection.should have_at_least(1).floozle + }.should_not raise_error + end + + it "should blow up when the owner doesn't respond to that method" do + lambda { + @collection.should have(99).problems + }.should raise_error(NoMethodError, /problems/) + end +end + +module Spec + module Matchers + describe Have do + it "should have method_missing as private" do + Have.private_instance_methods.should include("method_missing") + end + + describe "respond_to?" do + before :each do + @have = Have.new(:foo) + @a_method_which_have_defines = Have.instance_methods.first + @a_method_which_object_defines = Object.instance_methods.first + end + + it "should be true for a method which Have defines" do + @have.should respond_to(@a_method_which_have_defines) + end + + it "should be true for a method that it's superclass (Object) defines" do + @have.should respond_to(@a_method_which_object_defines) + end + + it "should be false for a method which neither Object nor nor Have defines" do + @have.should_not respond_to(:foo_bar_baz) + end + + it "should be false if the owner doesn't respond to the method" do + have = Have.new(99) + have.should_not respond_to(:problems) + end + + it "should be true if the owner responds to the method" do + have = Have.new(:a_symbol) + have.should respond_to(:to_sym) + end + end + end + end +end vendor/plugins/rspec/spec/spec/matchers/have_spec.rb @@ -20,7 +20,7 @@ describe "should ==" do Spec::Expectations.should_receive(:fail_with).with(%[expected: "orange",\n got: "apple" (using ==)], "orange", "apple") subject.should == "orange" end - + end describe "should_not ==" do @@ -166,3 +166,26 @@ describe "should <=" do end +describe Spec::Matchers::PositiveOperatorMatcher do + + it "should work when the target has implemented #send" do + o = Object.new + def o.send(*args); raise "DOH! Library developers shouldn't use #send!" end + lambda { + o.should == o + }.should_not raise_error + end + +end + +describe Spec::Matchers::NegativeOperatorMatcher do + + it "should work when the target has implemented #send" do + o = Object.new + def o.send(*args); raise "DOH! Library developers shouldn't use #send!" end + lambda { + o.should_not == :foo + }.should_not raise_error + end + +end vendor/plugins/rspec/spec/spec/matchers/operator_matcher_spec.rb @@ -23,6 +23,13 @@ module Spec it "should pass if any number of times method is not called" do @mock.should_receive(:random_call).any_number_of_times end + + it "should return the mocked value when called after a similar stub" do + @mock.stub!(:message).and_return :stub_value + @mock.should_receive(:message).any_number_of_times.and_return(:mock_value) + @mock.message.should == :mock_value + @mock.message.should == :mock_value + end end end vendor/plugins/rspec/spec/spec/mocks/any_number_of_times_spec.rb @@ -23,6 +23,18 @@ module Spec end end + it "should report line number of expectation of unreceived message after #should_receive after similar stub" do + @mock.stub!(:wont_happen) + expected_error_line = __LINE__; @mock.should_receive(:wont_happen).with("x", 3) + begin + @mock.rspec_verify + violated + rescue MockExpectationError => e + # NOTE - this regexp ended w/ $, but jruby adds extra info at the end of the line + e.backtrace[0].should match(/#{File.basename(__FILE__)}:#{expected_error_line}/) + end + end + it "should pass when not receiving message specified as not to be received" do @mock.should_not_receive(:not_expected) @mock.rspec_verify @@ -403,7 +415,16 @@ module Spec @mock.msg.should equal(:stub_value) @mock.rspec_verify end - + + it "should not require a different signature to replace a method stub" do + @mock.stub!(:msg).and_return(:stub_value) + @mock.should_receive(:msg).and_return(:mock_value) + @mock.msg(:arg).should equal(:mock_value) + @mock.msg.should equal(:stub_value) + @mock.msg.should equal(:stub_value) + @mock.rspec_verify + end + it "should temporarily replace a method stub on a non-mock" do non_mock = Object.new non_mock.stub!(:msg).and_return(:stub_value) @@ -413,7 +434,22 @@ module Spec non_mock.msg.should equal(:stub_value) non_mock.rspec_verify end - + + it "should return the stubbed value when no new value specified" do + @mock.stub!(:msg).and_return(:stub_value) + @mock.should_receive(:msg) + @mock.msg.should equal(:stub_value) + @mock.rspec_verify + end + + it "should not mess with the stub's yielded values when also mocked" do + @mock.stub!(:yield_back).and_yield(:stub_value) + @mock.should_receive(:yield_back).and_yield(:mock_value) + @mock.yield_back{|v| v}.should == :mock_value + @mock.yield_back{|v| v}.should == :stub_value + @mock.rspec_verify + end + it "should assign stub return values" do mock = Mock.new('name', :message => :response) mock.message.should == :response @@ -439,6 +475,15 @@ module Spec @calls.should == 1 end + it "should call the block after #should_receive after a similar stub" do + @mock.stub!(:foo).and_return(:bar) + @mock.should_receive(:foo) { add_call } + + @mock.foo + + @calls.should == 1 + end + it "should call the block after #once" do @mock.should_receive(:foo).once { add_call } vendor/plugins/rspec/spec/spec/mocks/mock_spec.rb @@ -36,5 +36,19 @@ module Spec @mock.message(:unexpected_arg) end end + + describe "#null_object?" do + it "should default to false" do + obj = mock('anything') + obj.should_not be_null_object + end + end + + describe "#as_null_object" do + it "should set the object to null_object" do + obj = mock('anything').as_null_object + obj.should be_null_object + end + end end end vendor/plugins/rspec/spec/spec/mocks/null_object_mock_spec.rb @@ -3,42 +3,32 @@ require File.dirname(__FILE__) + '/../../spec_helper.rb' module Spec module Mocks describe "calling :should_receive with an options hash" do - it_should_behave_like "sandboxed rspec_options" - attr_reader :reporter, :example_group - before do - @reporter = ::Spec::Runner::Reporter.new(options) - @example_group = Class.new(::Spec::Example::ExampleGroup) do - plugin_mock_framework - describe("Some Examples") - end - reporter.add_example_group example_group - end - it "should report the file and line submitted with :expected_from" do - example_definition = example_group.it "spec" do + begin mock = Spec::Mocks::Mock.new("a mock") mock.should_receive(:message, :expected_from => "/path/to/blah.ext:37") mock.rspec_verify + rescue => e + ensure + e.backtrace.to_s.should =~ /\/path\/to\/blah.ext:37/m end - example = example_group.new(example_definition) - - reporter.should_receive(:example_finished) do |spec, error| - error.backtrace.detect {|line| line =~ /\/path\/to\/blah.ext:37/}.should_not be_nil - end - example.execute(options, {}) end it "should use the message supplied with :message" do - example_definition = @example_group.it "spec" do - mock = Spec::Mocks::Mock.new("a mock") - mock.should_receive(:message, :message => "recebi nada") - mock.rspec_verify - end - example = @example_group.new(example_definition) - @reporter.should_receive(:example_finished) do |spec, error| - error.message.should == "recebi nada" - end - example.execute(@options, {}) + lambda { + m = Spec::Mocks::Mock.new("a mock") + m.should_receive(:message, :message => "recebi nada") + m.rspec_verify + }.should raise_error("recebi nada") + end + + it "should use the message supplied with :message after a similar stub" do + lambda { + m = Spec::Mocks::Mock.new("a mock") + m.stub!(:message) + m.should_receive(:message, :message => "from mock") + m.rspec_verify + }.should raise_error("from mock") end end end vendor/plugins/rspec/spec/spec/mocks/options_hash_spec.rb @@ -44,6 +44,12 @@ module Spec @instance.rspec_verify end.should_not raise_error end + + it "should handle multiple stubbed methods" do + @instance.stub!(:msg1 => 1, :msg2 => 2) + @instance.msg1.should == 1 + @instance.msg2.should == 2 + end it "should clear itself when verified" do @instance.stub!(:this_should_go).and_return(:blah) vendor/plugins/rspec/spec/spec/mocks/stub_spec.rb @@ -3,16 +3,16 @@ require File.dirname(__FILE__) + '/../../spec_helper.rb' module Spec module Runner describe CommandLine, ".run" do - it_should_behave_like "sandboxed rspec_options" + include SandboxedOptions attr_reader :options, :err, :out before do @err = options.error_stream @out = options.output_stream end - + it "should run directory" do file = File.dirname(__FILE__) + '/../../../examples/pure' - Spec::Runner::CommandLine.run(OptionParser.parse([file,"-p","**/*.rb"], @err, @out)) + run_with(OptionParser.parse([file,"-p","**/*.rb"], @err, @out)) @out.rewind @out.read.should =~ /\d+ examples, 0 failures, 3 pending/n @@ -20,7 +20,7 @@ module Spec it "should run file" do file = File.dirname(__FILE__) + '/../../../failing_examples/predicate_example.rb' - Spec::Runner::CommandLine.run(OptionParser.parse([file], @err, @out)) + run_with(OptionParser.parse([file], @err, @out)) @out.rewind @out.read.should =~ /2 examples, 1 failure/n @@ -130,18 +130,11 @@ module Spec options.reporter.should_receive(:add_example_group).with(example_group) options.add_example_group example_group - Spec::Runner::CommandLine.run(OptionParser.parse([], @err, @out)) + run_with(options) should_has_run.should be_true should_not_has_run.should be_false end - - it "sets Spec.run to true" do - ::Spec.run = false - ::Spec.should_not be_run - Spec::Runner::CommandLine.run(OptionParser.parse([], @err, @out)) - ::Spec.should be_run - end end end end \ No newline at end of file vendor/plugins/rspec/spec/spec/runner/command_line_spec.rb @@ -3,6 +3,8 @@ require File.dirname(__FILE__) + '/../../spec_helper.rb' module Spec module Runner describe DrbCommandLine, "without running local server" do + include SandboxedOptions + unless Config::CONFIG['ruby_install_name'] == 'jruby' it "should print error when there is no running local server" do err = StringIO.new @@ -15,12 +17,16 @@ module Spec end end - class DrbCommandLineSpec < ::Spec::Example::ExampleGroup - describe DrbCommandLine, "with local server" + describe "with local server" do class CommandLineForSpec def self.run(argv, stderr, stdout) - exit Spec::Runner::CommandLine.run(OptionParser.parse(argv, stderr, stdout)) + orig_options = Spec::Runner.options + tmp_options = OptionParser.parse(argv, stderr, stdout) + Spec::Runner.use tmp_options + Spec::Runner::CommandLine.run(tmp_options) + ensure + Spec::Runner.use orig_options end end @@ -86,7 +92,8 @@ module Spec out.rewind; out.read end end - + end + end end vendor/plugins/rspec/spec/spec/runner/drb_command_line_spec.rb @@ -6,6 +6,7 @@ module Spec module Runner module Formatter describe HtmlFormatter do + include SandboxedOptions ['--diff', '--dry-run'].each do |opt| def jruby? PLATFORM == 'java' @@ -22,7 +23,7 @@ module Spec args = ['failing_examples/mocking_example.rb', 'failing_examples/diffing_spec.rb', 'examples/pure/stubbing_example.rb', 'examples/pure/pending_example.rb', '--format', 'html', opt] err = StringIO.new out = StringIO.new - CommandLine.run( + run_with( OptionParser.parse(args, err, out) ) vendor/plugins/rspec/spec/spec/runner/formatter/html_formatter_spec.rb @@ -5,7 +5,7 @@ module Spec module Runner module Formatter describe NestedTextFormatter do - it_should_behave_like "sandboxed rspec_options" + include SandboxedOptions attr_reader :io, :options, :formatter, :example_group before(:each) do @io = StringIO.new @@ -304,7 +304,7 @@ module Spec describe "#example_pending" do it "should push pending example name and message" do - formatter.example_pending(example_group.examples.first, 'reason') + formatter.example_pending(example_group.examples.first, 'reason', "#{__FILE__}:#{__LINE__}") expected_output = <<-OUT ExampleGroup example (PENDING: reason) @@ -313,7 +313,7 @@ module Spec end it "should dump pending" do - formatter.example_pending(example_group.examples.first, 'reason') + formatter.example_pending(example_group.examples.first, 'reason', "#{__FILE__}:#{__LINE__}") io.rewind formatter.dump_pending io.string.should =~ /Pending\:\nExampleGroup example \(reason\)\n/ vendor/plugins/rspec/spec/spec/runner/formatter/nested_text_formatter_spec.rb @@ -29,7 +29,7 @@ module Spec end end example = example_group.examples.first - @formatter.example_pending(example, "message") + @formatter.example_pending(example, "message", "#{__FILE__}:#{__LINE__}") @io.rewind @formatter.dump_summary(3, 2, 1, 1) @io.string.should eql(%Q| @@ -94,10 +94,28 @@ EOE end end example = example_group.examples.first - @formatter.example_pending(example, "message") + @formatter.example_pending(example, "message", "#{__FILE__}:#{__LINE__}") @formatter.dump_pending @io.string.should =~ /Pending\:\nexample_group example \(message\)\n/ end + + it "should dump pending with file and line number" do + example_group = ExampleGroup.describe("example_group") do + specify "example" do + end + end + example = example_group.examples.first + file = __FILE__ + line = __LINE__ + 1 + @formatter.example_pending(example, "message", "#{__FILE__}:#{__LINE__}") + @formatter.dump_pending + @io.string.should ==(<<-HERE) +P +Pending: +example_group example (message) + Called from #{file}:#{line} +HERE + end end describe "ProgressBarFormatter outputting to custom out" do vendor/plugins/rspec/spec/spec/runner/formatter/progress_bar_formatter_spec.rb @@ -6,6 +6,7 @@ module Spec module Runner module Formatter describe TextMateFormatter do + include SandboxedOptions attr_reader :root, :suffix, :expected_file before do @root = File.expand_path(File.dirname(__FILE__) + '/../../../..') @@ -33,7 +34,7 @@ module Spec err = StringIO.new out = StringIO.new options = ::Spec::Runner::OptionParser.parse(args, err, out) - Spec::Runner::CommandLine.run(options) + run_with(options) yield(out.string) end vendor/plugins/rspec/spec/spec/runner/formatter/spec_mate_formatter_spec.rb @@ -5,7 +5,7 @@ module Spec module Runner module Formatter describe SpecdocFormatter do - it_should_behave_like "sandboxed rspec_options" + include SandboxedOptions attr_reader :io, :options, :formatter, :example_group before(:each) do @io = StringIO.new @@ -133,12 +133,12 @@ module Spec describe "#example_pending" do it "should push pending example name and message" do - formatter.example_pending(example_group.examples.first, 'reason') + formatter.example_pending(example_group.examples.first, 'reason', "#{__FILE__}:#{__LINE__}") io.string.should have_example_group_output("- example (PENDING: reason)\n") end it "should dump pending" do - formatter.example_pending(example_group.examples.first, 'reason') + formatter.example_pending(example_group.examples.first, 'reason', "#{__FILE__}:#{__LINE__}") io.rewind formatter.dump_pending io.string.should =~ /Pending\:\nExampleGroup example \(reason\)\n/ vendor/plugins/rspec/spec/spec/runner/formatter/specdoc_formatter_spec.rb @@ -61,6 +61,54 @@ module Spec EOF end + it 'should document additional givens using And' do + # when + @reporter.step_succeeded :given, 'step 1' + @reporter.step_succeeded :given, 'step 2' + @reporter.scenario_ended + @reporter.story_ended '', '' + + # then + @out.string.should include("Given step 1") + @out.string.should include("And step 2") + end + + it 'should document additional events using And' do + # when + @reporter.step_succeeded :when, 'step 1' + @reporter.step_succeeded :when, 'step 2' + @reporter.scenario_ended + @reporter.story_ended '', '' + + # then + @out.string.should include("When step 1") + @out.string.should include("And step 2") + end + + it 'should document additional outcomes using And' do + # when + @reporter.step_succeeded :then, 'step 1' + @reporter.step_succeeded :then, 'step 2' + @reporter.scenario_ended + @reporter.story_ended '', '' + + # then + @out.string.should include("Then step 1") + @out.string.should include("And step 2") + end + + it 'should document a GivenScenario followed by a Given using And' do + # when + @reporter.step_succeeded :'given scenario', 'a scenario' + @reporter.step_succeeded :given, 'a context' + @reporter.scenario_ended + @reporter.story_ended '', '' + + # then + @out.string.should include("Given scenario a scenario") + @out.string.should include("And a context") + end + it "should create a failed story if one of its scenarios fails" do @reporter.story_started('story_title', 'narrative') @reporter.scenario_started('story_title', 'succeeded_scenario_name') vendor/plugins/rspec/spec/spec/runner/formatter/story/html_formatter_spec.rb @@ -159,6 +159,45 @@ module Spec @out.string.should include("3 scenarios: 1 succeeded, 1 failed, 1 pending") end + it 'should show test summary in red if there were failed scenarios' do + # when + @out.stub!(:tty?).and_return(true) + @options.stub!(:colour).and_return(true) + + @formatter.scenario_started(nil, nil) + @formatter.scenario_failed('story', 'scenario', exception_from { raise RuntimeError, 'oops' }) + @formatter.run_ended + + # then + @out.string.should include("\e[31m scenarios: 0 succeeded, 1 failed, 0 pending\e[0m") + end + + it 'should show test summary in yellow if there are pending scenarios' do + # when + @out.stub!(:tty?).and_return(true) + @options.stub!(:colour).and_return(true) + + @formatter.scenario_started(nil, nil) + @formatter.scenario_pending('story', 'scenario', '') + @formatter.run_ended + + # then + @out.string.should include("\e[32m scenarios: 0 succeeded, 0 failed, 1 pending\e[0m") + end + + it 'should show test summary in green if all scenarios pass' do + # when + @out.stub!(:tty?).and_return(true) + @options.stub!(:colour).and_return(true) + + @formatter.scenario_started(nil, nil) + @formatter.scenario_succeeded('story', 'scenario') + @formatter.run_ended + + # then + @out.string.should include("\e[32m scenarios: 1 succeeded, 0 failed, 0 pending\e[0m") + end + it 'should produce details of the first failure each failed scenario when the run ends' do # when @formatter.run_started(3) @@ -180,6 +219,19 @@ module Spec @out.string.should include("RuntimeError: oops3") end + it 'should produce details of the failures in red when the run ends' do + # when + @out.stub!(:tty?).and_return(true) + @options.stub!(:colour).and_return(true) + @formatter.scenario_started(nil, nil) + @formatter.scenario_failed('story', 'scenario1', exception_from { raise RuntimeError, 'oops1' }) + @formatter.run_ended + + # then + @out.string.should =~ /\e\[31m[\n\s]*story \(scenario1\) FAILED\e\[0m/m + @out.string.should =~ /\e\[31m[\n\s]*RuntimeError: oops1\e\[0m/m + end + it 'should produce details of each pending step when the run ends' do # when @formatter.run_started(2) vendor/plugins/rspec/spec/spec/runner/formatter/story/plain_text_formatter_spec.rb @@ -21,18 +21,18 @@ unless [/mswin/, /java/].detect{|p| p =~ RUBY_PLATFORM} end it "should heckle all methods in all classes in a module" do - @heckle_class.should_receive(:new).with("Foo::Bar", "one", rspec_options).and_return(@heckle) - @heckle_class.should_receive(:new).with("Foo::Bar", "two", rspec_options).and_return(@heckle) - @heckle_class.should_receive(:new).with("Foo::Zap", "three", rspec_options).and_return(@heckle) - @heckle_class.should_receive(:new).with("Foo::Zap", "four", rspec_options).and_return(@heckle) + @heckle_class.should_receive(:new).with("Foo::Bar", "one", Spec::Runner.options).and_return(@heckle) + @heckle_class.should_receive(:new).with("Foo::Bar", "two", Spec::Runner.options).and_return(@heckle) + @heckle_class.should_receive(:new).with("Foo::Zap", "three", Spec::Runner.options).and_return(@heckle) + @heckle_class.should_receive(:new).with("Foo::Zap", "four", Spec::Runner.options).and_return(@heckle) heckle_runner = Spec::Runner::HeckleRunner.new("Foo", @heckle_class) heckle_runner.heckle_with end it "should heckle all methods in a class" do - @heckle_class.should_receive(:new).with("Foo::Bar", "one", rspec_options).and_return(@heckle) - @heckle_class.should_receive(:new).with("Foo::Bar", "two", rspec_options).and_return(@heckle) + @heckle_class.should_receive(:new).with("Foo::Bar", "one", Spec::Runner.options).and_return(@heckle) + @heckle_class.should_receive(:new).with("Foo::Bar", "two", Spec::Runner.options).and_return(@heckle) heckle_runner = Spec::Runner::HeckleRunner.new("Foo::Bar", @heckle_class) heckle_runner.heckle_with @@ -46,14 +46,14 @@ unless [/mswin/, /java/].detect{|p| p =~ RUBY_PLATFORM} end it "should heckle specific method in a class (with #)" do - @heckle_class.should_receive(:new).with("Foo::Bar", "two", rspec_options).and_return(@heckle) + @heckle_class.should_receive(:new).with("Foo::Bar", "two", Spec::Runner.options).and_return(@heckle) heckle_runner = Spec::Runner::HeckleRunner.new("Foo::Bar#two", @heckle_class) heckle_runner.heckle_with end it "should heckle specific method in a class (with .)" do - @heckle_class.should_receive(:new).with("Foo::Bar", "two", rspec_options).and_return(@heckle) + @heckle_class.should_receive(:new).with("Foo::Bar", "two", Spec::Runner.options).and_return(@heckle) heckle_runner = Spec::Runner::HeckleRunner.new("Foo::Bar.two", @heckle_class) heckle_runner.heckle_with vendor/plugins/rspec/spec/spec/runner/heckle_runner_spec.rb @@ -1,6 +1,21 @@ require File.dirname(__FILE__) + '/../../spec_helper.rb' require 'fileutils' +module Custom + class ExampleGroupRunner + attr_reader :options, :arg + def initialize(options, arg) + @options, @arg = options, arg + end + + def load_files(files) + end + + def run + end + end +end + describe "OptionParser" do before(:each) do @out = StringIO.new @@ -231,19 +246,19 @@ describe "OptionParser" do describe "when attempting a focussed spec" do attr_reader :file, :dir - before do - @original_rspec_options = $rspec_options + before(:each) do + @original_rspec_options = Spec::Runner.options @file = "#{File.dirname(__FILE__)}/spec_parser/spec_parser_fixture.rb" @dir = File.dirname(file) end - after do - $rspec_options = @original_rspec_options + after(:each) do + Spec::Runner.use @original_rspec_options end def parse(args) options = super - $rspec_options = options + Spec::Runner.use options options.filename_pattern = "*_fixture.rb" options end vendor/plugins/rspec/spec/spec/runner/option_parser_spec.rb @@ -1,7 +1,7 @@ dir = File.dirname(__FILE__) require "#{dir}/../../spec_helper" -triggering_double_output = rspec_options +triggering_double_output = Spec::Runner.options options = Spec::Runner::OptionParser.parse( ["#{dir}/output_one_time_fixture.rb"], $stderr, $stdout ) vendor/plugins/rspec/spec/spec/runner/output_one_time_fixture_runner.rb @@ -51,6 +51,12 @@ module Spec @tweaker.tweak_backtrace(@error) @error.backtrace.should include("/a/b/c/d.rb") end + + it "should gracefully handle backtraces with newlines" do + @error.set_backtrace(["we like\nbin/spec:\nnewlines"]) + @tweaker.tweak_backtrace(@error) + @error.backtrace.should include("we like\nnewlines") + end end end end vendor/plugins/rspec/spec/spec/runner/quiet_backtrace_tweaker_spec.rb @@ -155,26 +155,98 @@ module Spec end describe Reporter, "reporting one pending example (ExamplePendingError)" do + before :each do + @pending_error = Spec::Example::ExamplePendingError.new("reason") + @pending_caller = @pending_error.pending_caller + end + it "should tell formatter example is pending" do example = ExampleGroup.new("example") - formatter.should_receive(:example_pending).with(example, "reason") + formatter.should_receive(:example_pending).with(example, "reason", @pending_caller) formatter.should_receive(:add_example_group).with(example_group) reporter.add_example_group(example_group) - reporter.example_finished(example, Spec::Example::ExamplePendingError.new("reason")) + reporter.example_finished(example, @pending_error) end it "should account for pending example in stats" do example = ExampleGroup.new("example") - formatter.should_receive(:example_pending).with(example, "reason") + formatter.should_receive(:example_pending).with(example, "reason", @pending_caller) formatter.should_receive(:start_dump) formatter.should_receive(:dump_pending) formatter.should_receive(:dump_summary).with(anything(), 1, 0, 1) formatter.should_receive(:close).with(no_args) formatter.should_receive(:add_example_group).with(example_group) reporter.add_example_group(example_group) - reporter.example_finished(example, Spec::Example::ExamplePendingError.new("reason")) + reporter.example_finished(example, @pending_error) reporter.dump end + + describe "warning messages for formatters which have example_pending's arity of 2" do + before :each do + Kernel.stub!(:warn) + default_formatter = @formatter + + @file = __FILE__ + @line = __LINE__ + 3 + + @deprecated_formatter = Class.new(default_formatter.class) do + def example_pending(example_passed_to_method, message_passed_to_method) + @example_passed_to_method = example_passed_to_method + @message_passed_to_method = message_passed_to_method + end + + attr_reader :example_passed_to_method + attr_reader :message_passed_to_method + + end.new(options, formatter_output) + + options.formatters << @deprecated_formatter + end + + it "should not raise an error" do + lambda { + example = ExampleGroup.new("example") + reporter.add_example_group(example_group) + reporter.example_finished(example, @pending_error) + }.should_not raise_error + end + + it "should use correct example" do + example = ExampleGroup.new("example") + reporter.add_example_group(example_group) + reporter.example_finished(example, @pending_error) + + @deprecated_formatter.example_passed_to_method.should == example + end + + it "should use correct pending error message" do + example = ExampleGroup.new("example") + reporter.add_example_group(example_group) + reporter.example_finished(example, @pending_error) + + @deprecated_formatter.message_passed_to_method.should == "reason" + end + + it "should raise a warning (calling Kernel.warn)" do + Kernel.should_receive(:warn) + + example = ExampleGroup.new("example") + reporter.add_example_group(example_group) + reporter.example_finished(example, @pending_error) + end + + def warning_message + Spec::Runner::Reporter::PENDING_FORMATTER_DEPRECATION_MESSAGE + end + + it "should raise a warning with a warning message of the file and line number of the formatter" do + Kernel.should_receive(:warn).with(warning_message) + + example = ExampleGroup.new("example") + reporter.add_example_group(example_group) + reporter.example_finished(example, @pending_error) + end + end end describe Reporter, "reporting one pending example (PendingExampleFixedError)" do vendor/plugins/rspec/spec/spec/runner/reporter_spec.rb @@ -3,15 +3,15 @@ require File.dirname(__FILE__) + '/../../spec_helper.rb' describe "SpecParser" do attr_reader :parser, :file before(:each) do - @original_rspec_options = $rspec_options - $rspec_options = ::Spec::Runner::Options.new(StringIO.new, StringIO.new) + @original_rspec_options = Spec::Runner.options + Spec::Runner.use ::Spec::Runner::Options.new(StringIO.new, StringIO.new) @parser = Spec::Runner::SpecParser.new @file = "#{File.dirname(__FILE__)}/spec_parser/spec_parser_fixture.rb" load file end - after do - $rspec_options = @original_rspec_options + after(:each) do + Spec::Runner.use @original_rspec_options end it "should find spec name for 'specify' at same line" do vendor/plugins/rspec/spec/spec/runner/spec_parser_spec.rb @@ -22,11 +22,8 @@ module Spec it "should parse a story file" do runner = PlainTextStoryRunner.new("path") - during { - runner.run(mock('runner')) - }.expect { - @parser.should_receive(:parse).with(["this", "and that"]) - } + @parser.should_receive(:parse).with(["this", "and that"]) + runner.run(mock('runner')) end it "should build up a mediator with its own steps and the singleton story_runner" do vendor/plugins/rspec/spec/spec/story/runner/plain_text_story_runner_spec.rb @@ -8,9 +8,7 @@ module Spec story = StoryBuilder.new.to_story # when - error = exception_from do - Scenario.new story, 'name' - end + error = exception_from { Scenario.new story, 'name' } # then error.should be_nil vendor/plugins/rspec/spec/spec/story/scenario_spec.rb @@ -42,6 +42,18 @@ module Spec end.should raise_error(Spec::Example::ExamplePendingError, /Unimplemented/) end + it "should create a default step with it's name stripped" do + # given + step_mother = StepMother.new + + # when + step = step_mother.find(:given, "doesn't exist\n\n") + + # then + step.should be_an_instance_of(Step) + step.name.should == "doesn't exist" + end + it 'should clear itself' do # given step_mother = StepMother.new vendor/plugins/rspec/spec/spec/story/step_mother_spec.rb @@ -2,12 +2,17 @@ require File.dirname(__FILE__) + '/story_helper' module Spec module Story - describe Step, "matching" do + describe Step, "#matching" do it "should match a text string" do step = Step.new("this text") {} step.matches?("this text").should be_true end + it "should match a text string that has additional line returns" do + step = Step.new("this text") {} + step.matches?("this text\n\n").should be_true + end + it "should not match a text string that does not start the same" do step = Step.new("this text") {} step.matches?("Xthis text").should be_false @@ -32,6 +37,11 @@ module Spec step = Step.new("1 $one 2 $two 3 $three 4") {} step.matches?("1 a 2 b 3 c 4").should be_true end + + it "should match a text string with two params sharing a prefix" do + step = Step.new("I am cool $n times out of $n_total") + step.matches?("I am cool 3 times out of 7").should be_true + end it "should match a text string with a param at the beginning" do step = Step.new("$one 2 3") {} @@ -128,7 +138,7 @@ module Spec end it "should match a multiline regex" do - step = Step.new(/.* should have text.$text/) {} + step = Step.new(/.*should have text.$text/) {} step.matches?(<<TEXT).should be_true should have text this is the text @@ -153,6 +163,18 @@ TEXT end end + describe Step, "#parse_args" do + it "should return an empty array for a text string with no parameters" do + step = Step.new("this text") {} + step.parse_args("this text").should == [] + end + + it "should return an empty array for a text string with additional line returns and no parameters" do + step = Step.new("this text") {} + step.parse_args("this text\n\n").should == [] + end + end + describe Step do it "should be pending with no block" do step = Step.new("foo") vendor/plugins/rspec/spec/spec/story/step_spec.rb @@ -20,9 +20,7 @@ module Spec it 'should not raise an error if no block is supplied' do # when - error = exception_from do - Story.new 'title', 'narrative' - end + error = exception_from { Story.new 'title', 'narrative' } # then error.should be_nil vendor/plugins/rspec/spec/spec/story/story_spec.rb @@ -12,7 +12,11 @@ spec_classes_path = File.expand_path("#{dir}/../spec/spec/spec_classes") require spec_classes_path unless $LOAD_PATH.include?(spec_classes_path) require File.dirname(__FILE__) + '/../lib/spec/expectations/differs/default' -module Spec +module Spec + module Example + class NonStandardError < Exception; end + end + module Matchers def fail raise_error(Spec::Expectations::ExpectationNotMetError) @@ -22,82 +26,31 @@ module Spec raise_error(Spec::Expectations::ExpectationNotMetError, message) end - class Pass - def matches?(proc, &block) - begin - proc.call - true - rescue Exception => @error - false - end - end - - def failure_message - @error.message + "\n" + @error.backtrace.join("\n") - end - end - - def pass - Pass.new - end - - class CorrectlyOrderedMockExpectation - def initialize(&event) - @event = event - end - - def expect(&expectations) - expectations.call - @event.call + def exception_from(&block) + exception = nil + begin + yield + rescue StandardError => e + exception = e end - end - - def during(&block) - CorrectlyOrderedMockExpectation.new(&block) + exception end end end -class NonStandardError < Exception; end - -module Custom - class ExampleGroupRunner - attr_reader :options, :arg - def initialize(options, arg) - @options, @arg = options, arg - end - - def load_files(files) - end - - def run - end - end -end - -def exception_from(&block) - exception = nil - begin - yield - rescue StandardError => e - exception = e - end - exception -end - -describe "sandboxed rspec_options", :shared => true do +share_as :SandboxedOptions do attr_reader :options - before(:all) do - @original_rspec_options = $rspec_options + before(:each) do + @original_rspec_options = ::Spec::Runner.options + ::Spec::Runner.use(@options = ::Spec::Runner::Options.new(StringIO.new, StringIO.new)) end - before(:each) do - @options = ::Spec::Runner::Options.new(StringIO.new, StringIO.new) - $rspec_options = options + after(:each) do + ::Spec::Runner.use(@original_rspec_options) end - after do - $rspec_options = @original_rspec_options + def run_with(options) + ::Spec::Runner::CommandLine.run(options) end -end \ No newline at end of file +end unless Object.const_defined?(:SandboxedOptions) vendor/plugins/rspec/spec/spec_helper.rb @@ -13,8 +13,6 @@ Story: before suite Scenario: running with spec - Given this scenario fails because before(:suite) doesn't get run with the spec command - Given the file ../resources/spec/before_blocks_example.rb When I run it with the spec script vendor/plugins/rspec/stories/configuration/before_blocks.story @@ -18,7 +18,8 @@ module RspecOnRailsOnCrack describe @controller, "access for #{user.inspect}", :type => :controller do ControllerAccessGroup.new(self, blocks, filters).instance_eval(&block) before do - controller.stub!(:current_user).and_return(user == :anon ? :false : users(user)) + controller.stub!(:current_user).and_return(user == :anon ? nil : users(user)) + controller.stub!(:logged_in?).and_return(user != :anon) end end end @@ -420,7 +421,7 @@ module RspecOnRailsOnCrack acting do |response| asserts_status options[:status] asserts_content_type options[:format] || format - response.should have_text(instance_eval(&block)) if block + response.should have_text(block.call) if block end end end vendor/plugins/rspec_on_rails_on_crack/lib/rspec_on_rails_on_crack/controller_example_group_methods.rb @@ -1,26 +1,62 @@ -require 'rake' -require 'rake/testtask' -require 'rake/rdoctask' +require 'rubygems' +begin + hanna_dir = '/Users/mislav/Projects/Hanna/lib' + $:.unshift hanna_dir if File.exists? hanna_dir + require 'hanna/rdoctask' +rescue LoadError + require 'rake' + require 'rake/rdoctask' +end +load 'test/tasks.rake' desc 'Default: run unit tests.' task :default => :test -desc 'Test the will_paginate plugin.' -Rake::TestTask.new(:test) do |t| - t.pattern = 'test/**/*_test.rb' - t.verbose = true -end - desc 'Generate RDoc documentation for the will_paginate plugin.' Rake::RDocTask.new(:rdoc) do |rdoc| - files = ['README', 'LICENSE', 'lib/**/*.rb'] - rdoc.rdoc_files.add(files) - rdoc.main = "README" # page to start on - rdoc.title = "will_paginate" + rdoc.rdoc_files.include('README.rdoc', 'LICENSE', 'CHANGELOG.rdoc'). + include('lib/**/*.rb'). + exclude('lib/will_paginate/named_scope*'). + exclude('lib/will_paginate/array.rb'). + exclude('lib/will_paginate/version.rb') - templates = %w[/Users/chris/ruby/projects/err/rock/template.rb /var/www/rock/template.rb] - rdoc.template = templates.find { |t| File.exists? t } + rdoc.main = "README.rdoc" # page to start on + rdoc.title = "will_paginate documentation" rdoc.rdoc_dir = 'doc' # rdoc output folder - rdoc.options << '--inline-source' + rdoc.options << '--inline-source' << '--charset=UTF-8' + rdoc.options << '--webcvs=http://github.com/mislav/will_paginate/tree/master/' +end + +desc %{Update ".manifest" with the latest list of project filenames. Respect\ +.gitignore by excluding everything that git ignores. Update `files` and\ +`test_files` arrays in "*.gemspec" file if it's present.} +task :manifest do + list = Dir['**/*'].sort + spec_file = Dir['*.gemspec'].first + list -= [spec_file] if spec_file + + File.read('.gitignore').each_line do |glob| + glob = glob.chomp.sub(/^\//, '') + list -= Dir[glob] + list -= Dir["#{glob}/**/*"] if File.directory?(glob) and !File.symlink?(glob) + puts "excluding #{glob}" + end + + if spec_file + spec = File.read spec_file + spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do + assignment = $1 + bunch = $2 ? list.grep(/^test\//) : list + '%s%%w(%s)' % [assignment, bunch.join(' ')] + end + + File.open(spec_file, 'w') {|f| f << spec } + end + File.open('.manifest', 'w') {|f| f << list.join("\n") } +end + +task :examples do + %x(haml examples/index.haml examples/index.html) + %x(sass examples/pagination.sass examples/pagination.css) end vendor/plugins/will_paginate/Rakefile @@ -1,4 +1 @@ -unless ActiveRecord::Base.respond_to? :paginate - require 'will_paginate' - WillPaginate.enable -end +require 'will_paginate' vendor/plugins/will_paginate/init.rb @@ -9,44 +9,65 @@ require 'active_support' # Happy paginating! module WillPaginate class << self + # shortcut for <tt>enable_actionpack</tt> and <tt>enable_activerecord</tt> combined def enable enable_actionpack enable_activerecord end + # hooks WillPaginate::ViewHelpers into ActionView::Base def enable_actionpack return if ActionView::Base.instance_methods.include? 'will_paginate' require 'will_paginate/view_helpers' - ActionView::Base.class_eval { include ViewHelpers } + ActionView::Base.send :include, ViewHelpers + + if defined?(ActionController::Base) and ActionController::Base.respond_to? :rescue_responses + ActionController::Base.rescue_responses['WillPaginate::InvalidPage'] = :not_found + end end + # hooks WillPaginate::Finder into ActiveRecord::Base and classes that deal + # with associations def enable_activerecord return if ActiveRecord::Base.respond_to? :paginate require 'will_paginate/finder' - ActiveRecord::Base.class_eval { include Finder } - - associations = ActiveRecord::Associations - collection = associations::AssociationCollection - - # to support paginating finders on associations, we have to mix in the - # method_missing magic from WillPaginate::Finder::ClassMethods to AssociationProxy - # subclasses, but in a different way for Rails 1.2.x and 2.0 - (collection.instance_methods.include?(:create!) ? - collection : collection.subclasses.map(&:constantize) - ).push(associations::HasManyThroughAssociation).each do |klass| - klass.class_eval do - include Finder::ClassMethods - alias_method_chain :method_missing, :paginate + ActiveRecord::Base.send :include, Finder + + # support pagination on associations + a = ActiveRecord::Associations + returning([ a::AssociationCollection ]) { |classes| + # detect http://dev.rubyonrails.org/changeset/9230 + unless a::HasManyThroughAssociation.superclass == a::HasManyAssociation + classes << a::HasManyThroughAssociation end + }.each do |klass| + klass.send :include, Finder::ClassMethods + klass.class_eval { alias_method_chain :method_missing, :paginate } end end + + # Enable named_scope, a feature of Rails 2.1, even if you have older Rails + # (tested on Rails 2.0.2 and 1.2.6). + # + # You can pass +false+ for +patch+ parameter to skip monkeypatching + # *associations*. Use this if you feel that <tt>named_scope</tt> broke + # has_many, has_many :through or has_and_belongs_to_many associations in + # your app. By passing +false+, you can still use <tt>named_scope</tt> in + # your models, but not through associations. + def enable_named_scope(patch = true) + return if defined? ActiveRecord::NamedScope + require 'will_paginate/named_scope' + require 'will_paginate/named_scope_patch' if patch + + ActiveRecord::Base.send :include, WillPaginate::NamedScope + end end - module Deprecation + module Deprecation # :nodoc: extend ActiveSupport::Deprecation def self.warn(message, callstack = caller) - message = 'WillPaginate: ' + message.strip.gsub(/ {3,}/, ' ') + message = 'WillPaginate: ' + message.strip.gsub(/\s+/, ' ') behavior.call(message, callstack) if behavior && !silenced? end @@ -55,3 +76,7 @@ module WillPaginate end end end + +if defined?(Rails) and defined?(ActiveRecord) and defined?(ActionController) + WillPaginate.enable +end vendor/plugins/will_paginate/lib/will_paginate.rb @@ -1,23 +1,56 @@ module WillPaginate - # Arrays returned from paginating finds are, in fact, instances of this. - # You may think of WillPaginate::Collection as an ordinary array with some - # extra properties. Those properties are used by view helpers to generate + # = Invalid page number error + # This is an ArgumentError raised in case a page was requested that is either + # zero or negative number. You should decide how do deal with such errors in + # the controller. + # + # If you're using Rails 2, then this error will automatically get handled like + # 404 Not Found. The hook is in "will_paginate.rb": + # + # ActionController::Base.rescue_responses['WillPaginate::InvalidPage'] = :not_found + # + # If you don't like this, use your preffered method of rescuing exceptions in + # public from your controllers to handle this differently. The +rescue_from+ + # method is a nice addition to Rails 2. + # + # This error is *not* raised when a page further than the last page is + # requested. Use <tt>WillPaginate::Collection#out_of_bounds?</tt> method to + # check for those cases and manually deal with them as you see fit. + class InvalidPage < ArgumentError + def initialize(page, page_num) + super "#{page.inspect} given as value, which translates to '#{page_num}' as page number" + end + end + + # = The key to pagination + # Arrays returned from paginating finds are, in fact, instances of this little + # class. You may think of WillPaginate::Collection as an ordinary array with + # some extra properties. Those properties are used by view helpers to generate # correct page links. # # WillPaginate::Collection also assists in rolling out your own pagination # solutions: see +create+. + # + # If you are writing a library that provides a collection which you would like + # to conform to this API, you don't have to copy these methods over; simply + # make your plugin/gem dependant on the "mislav-will_paginate" gem: # + # gem 'mislav-will_paginate' + # require 'will_paginate/collection' + # + # # WillPaginate::Collection is now available for use class Collection < Array - attr_reader :current_page, :per_page, :total_entries + attr_reader :current_page, :per_page, :total_entries, :total_pages - # Arguments to this constructor are the current page number, per-page limit + # Arguments to the constructor are the current page number, per-page limit # and the total number of entries. The last argument is optional because it # is best to do lazy counting; in other words, count *conditionally* after # populating the collection using the +replace+ method. - # def initialize(page, per_page, total = nil) @current_page = page.to_i - @per_page = per_page.to_i + raise InvalidPage.new(page, @current_page) if @current_page < 1 + @per_page = per_page.to_i + raise ArgumentError, "`per_page` setting cannot be less than 1 (#{@per_page} given)" if @per_page < 1 self.total_entries = total if total end @@ -37,7 +70,7 @@ module WillPaginate # end # # The possibilities with this are endless. For another example, here is how - # WillPaginate defines pagination on Array instances: + # WillPaginate used to define pagination for Array instances: # # Array.class_eval do # def paginate(page = 1, per_page = 15) @@ -47,28 +80,25 @@ module WillPaginate # end # end # + # The Array#paginate API has since then changed, but this still serves as a + # fine example of WillPaginate::Collection usage. def self.create(page, per_page, total = nil, &block) pager = new(page, per_page, total) yield pager pager end - # The total number of pages. - def page_count - @total_pages - end - - # Helper method that is true when someone tries to fetch a page with a larger - # number than the last page or with a number smaller than 1 + # Helper method that is true when someone tries to fetch a page with a + # larger number than the last page. Can be used in combination with flashes + # and redirecting. def out_of_bounds? - current_page > page_count or current_page < 1 + current_page > total_pages end # Current offset of the paginated collection. If we're on the first page, # it is always 0. If we're on the 2nd page and there are 30 entries per page, # the offset is 30. This property is useful if you want to render ordinals - # besides your records: simply start with offset + 1. - # + # side by side with records in the view: simply start with offset + 1. def offset (current_page - 1) * per_page end @@ -80,9 +110,10 @@ module WillPaginate # current_page + 1 or nil if there is no next page def next_page - current_page < page_count ? (current_page + 1) : nil + current_page < total_pages ? (current_page + 1) : nil end - + + # sets the <tt>total_entries</tt> property and calculates <tt>total_pages</tt> def total_entries=(number) @total_entries = number.to_i @total_pages = (@total_entries / per_page.to_f).ceil @@ -101,13 +132,15 @@ module WillPaginate # +total_entries+ and set it to a proper value if it's +nil+. See the example # in +create+. def replace(array) - returning super do - # The collection is shorter then page limit? Rejoice, because - # then we know that we are on the last page! - if total_entries.nil? and length > 0 and length < per_page - self.total_entries = offset + length - end + result = super + + # The collection is shorter then page limit? Rejoice, because + # then we know that we are on the last page! + if total_entries.nil? and length < per_page and (current_page == 1 or length > 0) + self.total_entries = offset + length end + + result end end end vendor/plugins/will_paginate/lib/will_paginate/collection.rb @@ -1,4 +1,5 @@ require 'set' +require 'will_paginate/array' unless Hash.instance_methods.include? 'except' Hash.class_eval do @@ -29,33 +30,3 @@ unless Hash.instance_methods.include? 'slice' end end end - -require 'will_paginate/collection' - -unless Array.instance_methods.include? 'paginate' - # http://www.desimcadam.com/archives/8 - Array.class_eval do - def paginate(options_or_page = {}, per_page = nil) - if options_or_page.nil? or Fixnum === options_or_page - if defined? WillPaginate::Deprecation - WillPaginate::Deprecation.warn <<-DEPR - Array#paginate now conforms to the main, ActiveRecord::Base#paginate API. You should \ - call it with a parameters hash (:page, :per_page). The old API (numbers as arguments) \ - has been deprecated and is going to be unsupported in future versions of will_paginate. - DEPR - end - page = options_or_page - options = {} - else - options = options_or_page - page = options[:page] || 1 - raise ArgumentError, "wrong number of arguments (1 hash or 2 Fixnums expected)" if per_page - per_page = options[:per_page] - end - - WillPaginate::Collection.create(page || 1, per_page || 30, options[:total_entries] || size) do |pager| - pager.replace self[pager.offset, pager.per_page].to_a - end - end - end -end vendor/plugins/will_paginate/lib/will_paginate/core_ext.rb @@ -2,7 +2,7 @@ require 'will_paginate/core_ext' module WillPaginate # A mixin for ActiveRecord::Base. Provides +per_page+ class method - # and makes +paginate+ finders possible with some method_missing magic. + # and hooks things up to provide paginating finders. # # Find out more in WillPaginate::Finder::ClassMethods # @@ -11,66 +11,143 @@ module WillPaginate base.extend ClassMethods class << base alias_method_chain :method_missing, :paginate + # alias_method_chain :find_every, :paginate define_method(:per_page) { 30 } unless respond_to?(:per_page) end end # = Paginating finders for ActiveRecord models # - # WillPaginate doesn't really add extra methods to your ActiveRecord models (except +per_page+ - # unless it's already available). It simply intercepts - # the calls to paginating finders such as +paginate+, +paginate_by_user_id+ (and so on) and - # translates them to ordinary finders: +find+, +find_by_user_id+, etc. It does so with some - # method_missing magic, but you don't need to care for that. You simply use paginating finders - # same way you used ordinary ones. You only need to tell them what page you want in options. + # WillPaginate adds +paginate+, +per_page+ and other methods to + # ActiveRecord::Base class methods and associations. It also hooks into + # +method_missing+ to intercept pagination calls to dynamic finders such as + # +paginate_by_user_id+ and translate them to ordinary finders + # (+find_all_by_user_id+ in this case). + # + # In short, paginating finders are equivalent to ActiveRecord finders; the + # only difference is that we start with "paginate" instead of "find" and + # that <tt>:page</tt> is required parameter: # - # @topics = Topic.paginate :all, :page => params[:page] + # @posts = Post.paginate :all, :page => params[:page], :order => 'created_at DESC' # - # In paginating finders, "all" is implicit. No sense in paginating a single record, right? So: + # In paginating finders, "all" is implicit. There is no sense in paginating + # a single record, right? So, you can drop the <tt>:all</tt> argument: # - # Post.paginate => Post.find :all - # Post.paginate_all_by_something => Post.find_all_by_something - # Post.paginate_by_something => Post.find_all_by_something - # - # Knowing that, the above example can be written simply as: + # Post.paginate(...) => Post.find :all + # Post.paginate_all_by_something => Post.find_all_by_something + # Post.paginate_by_something => Post.find_all_by_something # - # @topics = Topic.paginate :page => params[:page] + # == The importance of the <tt>:order</tt> parameter # - # Don't forget to pass the +page+ parameter! Without it, paginating finders will raise an error. + # In ActiveRecord finders, <tt>:order</tt> parameter specifies columns for + # the <tt>ORDER BY</tt> clause in SQL. It is important to have it, since + # pagination only makes sense with ordered sets. Without the <tt>ORDER + # BY</tt> clause, databases aren't required to do consistent ordering when + # performing <tt>SELECT</tt> queries; this is especially true for + # PostgreSQL. # - # == Options - # Options for paginating finders are: - # - # page REQUIRED, but defaults to 1 if false or nil - # per_page (default is read from the model, which is 30 if not overridden) - # total entries not needed unless you want to count the records yourself somehow - # count hash of options that are used only for the call to count - # + # Therefore, make sure you are doing ordering on a column that makes the + # most sense in the current context. Make that obvious to the user, also. + # For perfomance reasons you will also want to add an index to that column. module ClassMethods - # This methods wraps +find_by_sql+ by simply adding LIMIT and OFFSET to your SQL string - # based on the params otherwise used by paginating finds: +page+ and +per_page+. + # This is the main paginating finder. + # + # == Special parameters for paginating finders + # * <tt>:page</tt> -- REQUIRED, but defaults to 1 if false or nil + # * <tt>:per_page</tt> -- defaults to <tt>CurrentModel.per_page</tt> (which is 30 if not overridden) + # * <tt>:total_entries</tt> -- use only if you manually count total entries + # * <tt>:count</tt> -- additional options that are passed on to +count+ + # * <tt>:finder</tt> -- name of the ActiveRecord finder used (default: "find") + # + # All other options (+conditions+, +order+, ...) are forwarded to +find+ + # and +count+ calls. + def paginate(*args, &block) + options = args.pop + page, per_page, total_entries = wp_parse_options(options) + finder = (options[:finder] || 'find').to_s + + if finder == 'find' + # an array of IDs may have been given: + total_entries ||= (Array === args.first and args.first.size) + # :all is implicit + args.unshift(:all) if args.empty? + end + + WillPaginate::Collection.create(page, per_page, total_entries) do |pager| + count_options = options.except :page, :per_page, :total_entries, :finder + find_options = count_options.except(:count).update(:offset => pager.offset, :limit => pager.per_page) + + args << find_options + # @options_from_last_find = nil + pager.replace send(finder, *args, &block) + + # magic counting for user convenience: + pager.total_entries = wp_count(count_options, args, finder) unless pager.total_entries + end + end + + # Iterates through all records by loading one page at a time. This is useful + # for migrations or any other use case where you don't want to load all the + # records in memory at once. + # + # It uses +paginate+ internally; therefore it accepts all of its options. + # You can specify a starting page with <tt>:page</tt> (default is 1). Default + # <tt>:order</tt> is <tt>"id"</tt>, override if necessary. + # + # See {Faking Cursors in ActiveRecord}[http://weblog.jamisbuck.org/2007/4/6/faking-cursors-in-activerecord] + # where Jamis Buck describes this and a more efficient way for MySQL. + def paginated_each(options = {}, &block) + options = { :order => 'id', :page => 1 }.merge options + options[:page] = options[:page].to_i + options[:total_entries] = 0 # skip the individual count queries + total = 0 + + begin + collection = paginate(options) + total += collection.each(&block).size + options[:page] += 1 + end until collection.size < collection.per_page + + total + end + + # Wraps +find_by_sql+ by simply adding LIMIT and OFFSET to your SQL string + # based on the params otherwise used by paginating finds: +page+ and + # +per_page+. # # Example: # # @developers = Developer.paginate_by_sql ['select * from developers where salary > ?', 80000], - # :page => params[:page], :per_page => 3 + # :page => params[:page], :per_page => 3 + # + # A query for counting rows will automatically be generated if you don't + # supply <tt>:total_entries</tt>. If you experience problems with this + # generated SQL, you might want to perform the count manually in your + # application. # def paginate_by_sql(sql, options) - options, page, per_page = wp_parse_options!(options) - - WillPaginate::Collection.create(page, per_page) do |pager| - query = sanitize_sql(sql) - count_query = "SELECT COUNT(*) FROM (#{query}) AS count_table" unless options[:total_entries] - options.update :offset => pager.offset, :limit => pager.per_page - - add_limit! query, options + WillPaginate::Collection.create(*wp_parse_options(options)) do |pager| + query = sanitize_sql(sql.dup) + original_query = query.dup + # add limit, offset + add_limit! query, :offset => pager.offset, :limit => pager.per_page + # perfom the find pager.replace find_by_sql(query) - pager.total_entries = options[:total_entries] || count_by_sql(count_query) unless pager.total_entries + unless pager.total_entries + count_query = original_query.sub /\bORDER\s+BY\s+[\w`,\s]+$/mi, '' + count_query = "SELECT COUNT(*) FROM (#{count_query})" + + unless ['oracle', 'oci'].include?(self.connection.adapter_name.downcase) + count_query << ' AS count_table' + end + # perform the count query + pager.total_entries = count_by_sql(count_query) + end end end - def respond_to?(method, include_priv = false) + def respond_to?(method, include_priv = false) #:nodoc: case method.to_sym when :paginate, :paginate_by_sql true @@ -81,59 +158,70 @@ module WillPaginate protected - def method_missing_with_paginate(method, *args, &block) + def method_missing_with_paginate(method, *args, &block) #:nodoc: # did somebody tried to paginate? if not, let them be unless method.to_s.index('paginate') == 0 return method_missing_without_paginate(method, *args, &block) end - - options, page, per_page, total_entries = wp_parse_options!(args.pop) - # an array of IDs may have been given: - total_entries ||= (Array === args.first and args.first.size) # paginate finders are really just find_* with limit and offset - finder = method.to_s.sub /^paginate/, 'find' + finder = method.to_s.sub('paginate', 'find') + finder.sub!('find', 'find_all') if finder.index('find_by_') == 0 + + options = args.pop + raise ArgumentError, 'parameter hash expected' unless options.respond_to? :symbolize_keys + options = options.dup + options[:finder] = finder + args << options + + paginate(*args, &block) + end - # :all is implicit - if finder == 'find' - args.unshift(:all) if args.empty? - elsif finder.index('find_by_') == 0 - finder.sub! /^find/, 'find_all' - end + # Does the not-so-trivial job of finding out the total number of entries + # in the database. It relies on the ActiveRecord +count+ method. + def wp_count(options, args, finder) + excludees = [:count, :order, :limit, :offset, :readonly] - WillPaginate::Collection.create(page, per_page, total_entries) do |pager| - args << options.except(:count).merge(:offset => pager.offset, :limit => pager.per_page) - pager.replace send(finder, *args) - - # magic counting for user convenience: - pager.total_entries = wp_count!(options, args, finder) unless pager.total_entries - end - end + # we may be in a model or an association proxy + klass = (@owner and @reflection) ? @reflection.klass : self + + # Use :select from scope if it isn't already present. + options[:select] = scope(:find, :select) unless options[:select] - def wp_count!(options, args, finder) - excludees = [:count, :order, :limit, :offset] - unless options[:select] and options[:select] =~ /^\s*DISTINCT/i + if options[:select] and options[:select] =~ /^\s*DISTINCT\b/i + # Remove quoting and check for table_name.*-like statement. + if options[:select].gsub('`', '') =~ /\w+\.\*/ + options[:select] = "DISTINCT #{klass.table_name}.#{klass.primary_key}" + end + else excludees << :select # only exclude the select param if it doesn't begin with DISTINCT end + # count expects (almost) the same options as find count_options = options.except *excludees # merge the hash found in :count # this allows you to specify :select, :order, or anything else just for the count query - count_options.update(options.delete(:count) || {}) if options.key? :count + count_options.update options[:count] if options[:count] + + # forget about includes if they are irrelevant (Rails 2.1) + if count_options[:include] and + klass.private_methods.include?('references_eager_loaded_tables?') and + !klass.send(:references_eager_loaded_tables?, count_options) + count_options.delete :include + end # we may have to scope ... counter = Proc.new { count(count_options) } - # we may be in a model or an association proxy! - klass = (@owner and @reflection) ? @reflection.klass : self - - count = if finder =~ /^find_/ and klass.respond_to?(scoper = finder.sub(/^find_/, 'with_')) + count = if finder.index('find_') == 0 and klass.respond_to?(scoper = finder.sub('find', 'with')) # scope_out adds a 'with_finder' method which acts like with_scope, if it's present - # then execute the count with the scoping provided by the with_finder + # then execute the count with the scoping provided by the with_finder send(scoper, &counter) - elsif conditions = wp_extract_finder_conditions(finder, args) - # extracted the conditions from calls like "paginate_by_foo_and_bar" + elsif match = /^find_(all_by|by)_([_a-zA-Z]\w*)$/.match(finder) + # extract conditions from calls like "paginate_by_foo_and_bar" + attribute_names = extract_attribute_names_from_match(match) + conditions = construct_attributes_from_arguments(attribute_names, args) with_scope(:find => { :conditions => conditions }, &counter) else counter.call @@ -142,33 +230,27 @@ module WillPaginate count.respond_to?(:length) ? count.length : count end - def wp_parse_options!(options) - raise ArgumentError, 'hash parameters expected' unless options.respond_to? :symbolize_keys! - options.symbolize_keys! + def wp_parse_options(options) #:nodoc: + raise ArgumentError, 'parameter hash expected' unless options.respond_to? :symbolize_keys + options = options.symbolize_keys raise ArgumentError, ':page parameter required' unless options.key? :page if options[:count] and options[:total_entries] - raise ArgumentError, ':count and :total_entries are mutually exclusive parameters' + raise ArgumentError, ':count and :total_entries are mutually exclusive' end - page = options.delete(:page) || 1 - per_page = options.delete(:per_page) || self.per_page - total = options.delete(:total_entries) - [options, page, per_page, total] + page = options[:page] || 1 + per_page = options[:per_page] || self.per_page + total = options[:total_entries] + [page, per_page, total] end private - # thanks to active record for making us duplicate this code - def wp_extract_finder_conditions(finder, arguments) - return unless match = /^find_(all_by|by)_([_a-zA-Z]\w*)$/.match(finder.to_s) - - attribute_names = extract_attribute_names_from_match(match) - unless all_attributes_exists?(attribute_names) - raise "I can't make sense of `#{finder}`. Try doing the count manually" - end - construct_attributes_from_arguments(attribute_names, arguments) - end + # def find_every_with_paginate(options) + # @options_from_last_find = options + # find_every_without_paginate(options) + # end end end end vendor/plugins/will_paginate/lib/will_paginate/finder.rb @@ -1,136 +1,383 @@ require 'will_paginate/core_ext' module WillPaginate - # = Global options for pagination helpers + # = Will Paginate view helpers + # + # The main view helper, #will_paginate, renders + # pagination links for the given collection. The helper itself is lightweight + # and serves only as a wrapper around LinkRenderer instantiation; the + # renderer then does all the hard work of generating the HTML. + # + # == Global options for helpers # # Options for pagination helpers are optional and get their default values from the - # WillPaginate::ViewHelpers.pagination_options hash. You can write to this hash to + # <tt>WillPaginate::ViewHelpers.pagination_options</tt> hash. You can write to this hash to # override default options on the global level: # - # WillPaginate::ViewHelpers.pagination_options[:prev_label] = 'Previous page' + # WillPaginate::ViewHelpers.pagination_options[:previous_label] = 'Previous page' # - # By putting this into your environment.rb you can easily translate link texts to previous + # By putting this into "config/initializers/will_paginate.rb" (or simply environment.rb in + # older versions of Rails) you can easily translate link texts to previous # and next pages, as well as override some other defaults to your liking. module ViewHelpers # default options that can be overridden on the global level - @@pagination_options = { :class => 'pagination', - :prev_label => '&laquo; Previous', - :next_label => 'Next &raquo;', - :inner_window => 4, # links around the current page - :outer_window => 1, # links around beginning and end - :separator => ' ', # single space is friendly to spiders and non-graphic browsers - :param_name => :page - } + @@pagination_options = { + :class => 'pagination', + :previous_label => '&laquo; Previous', + :next_label => 'Next &raquo;', + :inner_window => 4, # links around the current page + :outer_window => 1, # links around beginning and end + :separator => ' ', # single space is friendly to spiders and non-graphic browsers + :param_name => :page, + :params => nil, + :renderer => 'WillPaginate::LinkRenderer', + :page_links => true, + :container => true + } mattr_reader :pagination_options - # Renders Digg-style pagination. (We know you wanna!) - # Returns nil if there is only one page in total (can't paginate that). + # Renders Digg/Flickr-style pagination for a WillPaginate::Collection + # object. Nil is returned if there is only one page in total; no point in + # rendering the pagination in that case... # - # Options for will_paginate view helper: + # ==== Options + # Display options: + # * <tt>:previous_label</tt> -- default: "« Previous" (this parameter is called <tt>:prev_label</tt> in versions <b>2.3.2</b> and older!) + # * <tt>:next_label</tt> -- default: "Next »" + # * <tt>:page_links</tt> -- when false, only previous/next links are rendered (default: true) + # * <tt>:inner_window</tt> -- how many links are shown around the current page (default: 4) + # * <tt>:outer_window</tt> -- how many links are around the first and the last page (default: 1) + # * <tt>:separator</tt> -- string separator for page HTML elements (default: single space) # - # class: CSS class name for the generated DIV (default "pagination") - # prev_label: default '&laquo; Previous', - # next_label: default 'Next &raquo;', - # inner_window: how many links are shown around the current page, defaults to 4 - # outer_window: how many links are around the first and the last page, defaults to 1 - # separator: string separator for page HTML elements, default " " (single space) - # param_name: parameter name for page number in URLs, defaults to "page" - # - # All extra options are passed to the generated container DIV, so eventually - # they become its HTML attributes. - # - def will_paginate(entries = @entries, options = {}) - total_pages = - - if entries.page_count > 1 - renderer = WillPaginate::LinkRenderer.new entries, options, self - links = renderer.items - - content_tag :div, links, renderer.html_options + # HTML options: + # * <tt>:class</tt> -- CSS class name for the generated DIV (default: "pagination") + # * <tt>:container</tt> -- toggles rendering of the DIV container for pagination links, set to + # false only when you are rendering your own pagination markup (default: true) + # * <tt>:id</tt> -- HTML ID for the container (default: nil). Pass +true+ to have the ID + # automatically generated from the class name of objects in collection: for example, paginating + # ArticleComment models would yield an ID of "article_comments_pagination". + # + # Advanced options: + # * <tt>:param_name</tt> -- parameter name for page number in URLs (default: <tt>:page</tt>) + # * <tt>:params</tt> -- additional parameters when generating pagination links + # (eg. <tt>:controller => "foo", :action => nil</tt>) + # * <tt>:renderer</tt> -- class name, class or instance of a link renderer (default: + # <tt>WillPaginate::LinkRenderer</tt>) + # + # All options not recognized by will_paginate will become HTML attributes on the container + # element for pagination links (the DIV). For example: + # + # <%= will_paginate @posts, :style => 'font-size: small' %> + # + # ... will result in: + # + # <div class="pagination" style="font-size: small"> ... </div> + # + # ==== Using the helper without arguments + # If the helper is called without passing in the collection object, it will + # try to read from the instance variable inferred by the controller name. + # For example, calling +will_paginate+ while the current controller is + # PostsController will result in trying to read from the <tt>@posts</tt> + # variable. Example: + # + # <%= will_paginate :id => true %> + # + # ... will result in <tt>@post</tt> collection getting paginated: + # + # <div class="pagination" id="posts_pagination"> ... </div> + # + def will_paginate(collection = nil, options = {}) + options, collection = collection, nil if collection.is_a? Hash + unless collection or !controller + collection_name = "@#{controller.controller_name}" + collection = instance_variable_get(collection_name) + raise ArgumentError, "The #{collection_name} variable appears to be empty. Did you " + + "forget to pass the collection object for will_paginate?" unless collection + end + # early exit if there is nothing to render + return nil unless WillPaginate::ViewHelpers.total_pages_for_collection(collection) > 1 + + options = options.symbolize_keys.reverse_merge WillPaginate::ViewHelpers.pagination_options + if options[:prev_label] + WillPaginate::Deprecation::warn(":prev_label view parameter is now :previous_label; the old name has been deprecated.") + options[:previous_label] = options.delete(:prev_label) + end + + # get the renderer instance + renderer = case options[:renderer] + when String + options[:renderer].to_s.constantize.new + when Class + options[:renderer].new + else + options[:renderer] + end + # render HTML for pagination + renderer.prepare collection, options, self + renderer.to_html + end + + # Wrapper for rendering pagination links at both top and bottom of a block + # of content. + # + # <% paginated_section @posts do %> + # <ol id="posts"> + # <% for post in @posts %> + # <li> ... </li> + # <% end %> + # </ol> + # <% end %> + # + # will result in: + # + # <div class="pagination"> ... </div> + # <ol id="posts"> + # ... + # </ol> + # <div class="pagination"> ... </div> + # + # Arguments are passed to a <tt>will_paginate</tt> call, so the same options + # apply. Don't use the <tt>:id</tt> option; otherwise you'll finish with two + # blocks of pagination links sharing the same ID (which is invalid HTML). + def paginated_section(*args, &block) + pagination = will_paginate(*args).to_s + content = pagination + capture(&block) + pagination + concat content, block.binding + end + + # Renders a helpful message with numbers of displayed vs. total entries. + # You can use this as a blueprint for your own, similar helpers. + # + # <%= page_entries_info @posts %> + # #-> Displaying posts 6 - 10 of 26 in total + # + # By default, the message will use the humanized class name of objects + # in collection: for instance, "project types" for ProjectType models. + # Override this with the <tt>:entry_name</tt> parameter: + # + # <%= page_entries_info @posts, :entry_name => 'item' %> + # #-> Displaying items 6 - 10 of 26 in total + def page_entries_info(collection, options = {}) + entry_name = options[:entry_name] || + (collection.empty?? 'entry' : collection.first.class.name.underscore.sub('_', ' ')) + + if collection.total_pages < 2 + case collection.size + when 0; "No #{entry_name.pluralize} found" + when 1; "Displaying <b>1</b> #{entry_name}" + else; "Displaying <b>all #{collection.size}</b> #{entry_name.pluralize}" + end + else + %{Displaying #{entry_name.pluralize} <b>%d&nbsp;-&nbsp;%d</b> of <b>%d</b> in total} % [ + collection.offset + 1, + collection.offset + collection.length, + collection.total_entries + ] end end + + def self.total_pages_for_collection(collection) #:nodoc: + if collection.respond_to?('page_count') and !collection.respond_to?('total_pages') + WillPaginate::Deprecation.warn <<-MSG + You are using a paginated collection of class #{collection.class.name} + which conforms to the old API of WillPaginate::Collection by using + `page_count`, while the current method name is `total_pages`. Please + upgrade yours or 3rd-party code that provides the paginated collection. + MSG + class << collection + def total_pages; page_count; end + end + end + collection.total_pages + end end # This class does the heavy lifting of actually building the pagination - # links. It is used by +will_paginate+ helper internally, but avoid using it - # directly (for now) because its API is not set in stone yet. + # links. It is used by the <tt>will_paginate</tt> helper internally. class LinkRenderer - def initialize(collection, options, template) + # The gap in page links is represented by: + # + # <span class="gap">&hellip;</span> + attr_accessor :gap_marker + + def initialize + @gap_marker = '<span class="gap">&hellip;</span>' + end + + # * +collection+ is a WillPaginate::Collection instance or any other object + # that conforms to that API + # * +options+ are forwarded from +will_paginate+ view helper + # * +template+ is the reference to the template being rendered + def prepare(collection, options, template) @collection = collection - @options = options.symbolize_keys.reverse_merge WillPaginate::ViewHelpers.pagination_options - @template = template + @options = options + @template = template + + # reset values in case we're re-using this instance + @total_pages = @param_name = @url_string = nil end - def items - returning windowed_paginator do |links| - # next and previous buttons - links.unshift page_link_or_span(@collection.previous_page, 'disabled', @options[:prev_label]) - links.push page_link_or_span(@collection.next_page, 'disabled', @options[:next_label]) - end.join(@options[:separator]) + # Process it! This method returns the complete HTML string which contains + # pagination links. Feel free to subclass LinkRenderer and change this + # method as you see fit. + def to_html + links = @options[:page_links] ? windowed_links : [] + # previous/next buttons + links.unshift page_link_or_span(@collection.previous_page, 'disabled prev_page', @options[:previous_label]) + links.push page_link_or_span(@collection.next_page, 'disabled next_page', @options[:next_label]) + + html = links.join(@options[:separator]) + @options[:container] ? @template.content_tag(:div, html, html_attributes) : html end - def html_options - @options.except *(WillPaginate::ViewHelpers.pagination_options.keys - [:class]) + # Returns the subset of +options+ this instance was initialized with that + # represent HTML attributes for the container element of pagination links. + def html_attributes + return @html_attributes if @html_attributes + @html_attributes = @options.except *(WillPaginate::ViewHelpers.pagination_options.keys - [:class]) + # pagination of Post models will have the ID of "posts_pagination" + if @options[:container] and @options[:id] === true + @html_attributes[:id] = @collection.first.class.name.underscore.pluralize + '_pagination' + end + @html_attributes end protected - def windowed_paginator + # Collects link items for visible page numbers. + def windowed_links + prev = nil + + visible_page_numbers.inject [] do |links, n| + # detect gaps: + links << gap_marker if prev and n > prev + 1 + links << page_link_or_span(n, 'current') + prev = n + links + end + end + + # Calculates visible page numbers using the <tt>:inner_window</tt> and + # <tt>:outer_window</tt> options. + def visible_page_numbers inner_window, outer_window = @options[:inner_window].to_i, @options[:outer_window].to_i - min = page - inner_window - max = page + inner_window + window_from = current_page - inner_window + window_to = current_page + inner_window + # adjust lower or upper limit if other is out of bounds - if max > total_pages then min -= max - total_pages - elsif min < 1 then max += 1 - min + if window_to > total_pages + window_from -= window_to - total_pages + window_to = total_pages + end + if window_from < 1 + window_to += 1 - window_from + window_from = 1 + window_to = total_pages if window_to > total_pages end - current = min..max - beginning = 1..(1 + outer_window) - tail = (total_pages - outer_window)..total_pages - visible = [beginning, current, tail].map(&:to_a).flatten.sort.uniq + visible = (1..total_pages).to_a + left_gap = (2 + outer_window)...window_from + right_gap = (window_to + 1)...(total_pages - outer_window) + visible -= left_gap.to_a if left_gap.last - left_gap.first > 1 + visible -= right_gap.to_a if right_gap.last - right_gap.first > 1 + + visible + end + + def page_link_or_span(page, span_class, text = nil) + text ||= page.to_s - links, prev = [], 0 + if page and page != current_page + classnames = span_class && span_class.index(' ') && span_class.split(' ', 2).last + page_link page, text, :rel => rel_value(page), :class => classnames + else + page_span page, text, :class => span_class + end + end - visible.each do |n| - next if n < 1 - break if n > total_pages + def page_link(page, text, attributes = {}) + @template.link_to text, url_for(page), attributes + end - unless n - prev > 1 - prev = n - links << page_link_or_span((n != page ? n : nil), 'current', n) + def page_span(page, text, attributes = {}) + @template.content_tag :span, text, attributes + end + + # Returns URL params for +page_link_or_span+, taking the current GET params + # and <tt>:params</tt> option into account. + def url_for(page) + page_one = page == 1 + unless @url_string and !page_one + @url_params = {} + # page links should preserve GET parameters + stringified_merge @url_params, @template.params if @template.request.get? + stringified_merge @url_params, @options[:params] if @options[:params] + + if complex = param_name.index(/[^\w-]/) + page_param = (defined?(CGIMethods) ? CGIMethods : ActionController::AbstractRequest). + parse_query_parameters("#{param_name}=#{page}") + + stringified_merge @url_params, page_param else - # ellipsis represents the gap between windows - prev = n - 1 - links << '...' - redo + @url_params[param_name] = page_one ? 1 : 2 end - end - - links - end - def page_link_or_span(page, span_class, text) - unless page - @template.content_tag :span, text, :class => span_class - else - # page links should preserve GET/POST parameters - @template.link_to text, @template.params.merge(param => page != 1 ? page : nil) + url = @template.url_for(@url_params) + return url if page_one + + if complex + @url_string = url.sub(%r!((?:\?|&amp;)#{CGI.escape param_name}=)#{page}!, '\1@') + return url + else + @url_string = url + @url_params[param_name] = 3 + @template.url_for(@url_params).split(//).each_with_index do |char, i| + if char == '3' and url[i, 1] == '2' + @url_string[i] = '@' + break + end + end + end end + # finally! + @url_string.sub '@', page.to_s end private - def page + def rel_value(page) + case page + when @collection.previous_page; 'prev' + (page == 1 ? ' start' : '') + when @collection.next_page; 'next' + when 1; 'start' + end + end + + def current_page @collection.current_page end def total_pages - @collection.page_count + @total_pages ||= WillPaginate::ViewHelpers.total_pages_for_collection(@collection) + end + + def param_name + @param_name ||= @options[:param_name].to_s end - def param - @options[:param_name].to_sym + # Recursively merge into target hash by using stringified keys from the other one + def stringified_merge(target, other) + other.each do |key, value| + key = key.to_s # this line is what it's all about! + existing = target[key] + + if value.is_a?(Hash) and (existing.is_a?(Hash) or existing.nil?) + stringified_merge(existing || (target[key] = {}), value) + else + target[key] = value + end + end end end end vendor/plugins/will_paginate/lib/will_paginate/view_helpers.rb @@ -1,24 +1,21 @@ plugin_root = File.join(File.dirname(__FILE__), '..') +version = ENV['RAILS_VERSION'] +version = nil if version and version == "" # first look for a symlink to a copy of the framework -if framework_root = ["#{plugin_root}/rails", "#{plugin_root}/../../rails"].find { |p| File.directory? p } +if !version and framework_root = ["#{plugin_root}/rails", "#{plugin_root}/../../rails"].find { |p| File.directory? p } puts "found framework root: #{framework_root}" - # this allows for a plugin to be tested outside an app + # this allows for a plugin to be tested outside of an app and without Rails gems $:.unshift "#{framework_root}/activesupport/lib", "#{framework_root}/activerecord/lib", "#{framework_root}/actionpack/lib" else - # is the plugin installed in an application? - app_root = plugin_root + '/../../..' - - if File.directory? app_root + '/config' - puts 'using config/boot.rb' - ENV['RAILS_ENV'] = 'test' - require File.expand_path(app_root + '/config/boot') + # simply use installed gems if available + puts "using Rails#{version ? ' ' + version : nil} gems" + require 'rubygems' + + if version + gem 'rails', version else - # simply use installed gems if available - puts 'using rubygems' - require 'rubygems' - gem 'actionpack'; gem 'activerecord' + gem 'actionpack' + gem 'activerecord' end end - -$:.unshift "#{plugin_root}/lib" vendor/plugins/will_paginate/test/boot.rb @@ -1,9 +1,8 @@ #!/usr/bin/env ruby irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb' libs = [] -dirname = File.dirname(__FILE__) libs << 'irb/completion' -libs << File.join(dirname, 'lib', 'load_fixtures') +libs << File.join('lib', 'load_fixtures') -exec "#{irb}#{libs.map{ |l| " -r #{l}" }.join} --simple-prompt" +exec "#{irb} -Ilib:test#{libs.map{ |l| " -r #{l}" }.join} --simple-prompt" vendor/plugins/will_paginate/test/console @@ -1,8 +1,9 @@ -require File.dirname(__FILE__) + '/helper' -require File.dirname(__FILE__) + '/lib/activerecord_test_case' +require 'helper' +require 'lib/activerecord_test_case' require 'will_paginate' WillPaginate.enable_activerecord +WillPaginate.enable_named_scope class FinderTest < ActiveRecordTestCase fixtures :topics, :replies, :users, :projects, :developers_projects @@ -12,18 +13,18 @@ class FinderTest < ActiveRecordTestCase end def test_simple_paginate - entries = Topic.paginate :page => nil - assert_equal 1, entries.current_page - assert_nil entries.previous_page - assert_nil entries.next_page - assert_equal 1, entries.page_count - assert_equal 4, entries.size + assert_queries(1) do + entries = Topic.paginate :page => nil + assert_equal 1, entries.current_page + assert_equal 1, entries.total_pages + assert_equal 4, entries.size + end - entries = Topic.paginate :page => 2 - assert_equal 2, entries.current_page - assert_equal 1, entries.previous_page - assert_equal 1, entries.page_count - assert entries.empty? + assert_queries(2) do + entries = Topic.paginate :page => 2 + assert_equal 1, entries.total_pages + assert entries.empty? + end end def test_parameter_api @@ -41,31 +42,31 @@ class FinderTest < ActiveRecordTestCase def test_paginate_with_per_page entries = Topic.paginate :page => 1, :per_page => 1 assert_equal 1, entries.size - assert_equal 4, entries.page_count + assert_equal 4, entries.total_pages # Developer class has explicit per_page at 10 entries = Developer.paginate :page => 1 assert_equal 10, entries.size - assert_equal 2, entries.page_count + assert_equal 2, entries.total_pages entries = Developer.paginate :page => 1, :per_page => 5 assert_equal 11, entries.total_entries assert_equal 5, entries.size - assert_equal 3, entries.page_count + assert_equal 3, entries.total_pages end def test_paginate_with_order entries = Topic.paginate :page => 1, :order => 'created_at desc' expected = [topics(:futurama), topics(:harvey_birdman), topics(:rails), topics(:ar)].reverse assert_equal expected, entries.to_a - assert_equal 1, entries.page_count + assert_equal 1, entries.total_pages end def test_paginate_with_conditions entries = Topic.paginate :page => 1, :conditions => ["created_at > ?", 30.minutes.ago] expected = [topics(:rails), topics(:ar)] assert_equal expected, entries.to_a - assert_equal 1, entries.page_count + assert_equal 1, entries.total_pages end def test_paginate_with_include_and_conditions @@ -85,11 +86,14 @@ class FinderTest < ActiveRecordTestCase end def test_paginate_with_include_and_order - entries = Topic.paginate \ - :page => 1, - :include => :replies, - :order => 'replies.created_at asc, topics.created_at asc', - :per_page => 10 + entries = nil + assert_queries(2) do + entries = Topic.paginate \ + :page => 1, + :include => :replies, + :order => 'replies.created_at asc, topics.created_at asc', + :per_page => 10 + end expected = Topic.find :all, :include => 'replies', @@ -104,7 +108,7 @@ class FinderTest < ActiveRecordTestCase entries, project = nil, projects(:active_record) assert_nothing_raised "THIS IS A BUG in Rails 1.2.3 that was fixed in [7326]. " + - "Please upgrade to the 1-2-stable branch or edge Rails." do + "Please upgrade to a newer version of Rails." do entries = project.topics.paginate \ :page => 1, :include => :replies, @@ -125,10 +129,12 @@ class FinderTest < ActiveRecordTestCase expected_name_ordered = [projects(:action_controller), projects(:active_record)] expected_id_ordered = [projects(:active_record), projects(:action_controller)] - # with association-specified order - entries = dhh.projects.paginate(:page => 1) - assert_equal expected_name_ordered, entries - assert_equal 2, entries.total_entries + assert_queries(2) do + # with association-specified order + entries = dhh.projects.paginate(:page => 1) + assert_equal expected_name_ordered, entries + assert_equal 2, entries.total_entries + end # with explicit order entries = dhh.projects.paginate(:page => 1, :order => 'projects.id') @@ -148,30 +154,45 @@ class FinderTest < ActiveRecordTestCase def test_paginate_association_extension project = Project.find(:first) - entries = project.replies.paginate_recent :page => 1 - assert_equal [replies(:brave)], entries + + assert_queries(2) do + entries = project.replies.paginate_recent :page => 1 + assert_equal [replies(:brave)], entries + end end def test_paginate_with_joins - entries = Developer.paginate :page => 1, - :joins => 'LEFT JOIN developers_projects ON users.id = developers_projects.developer_id', - :conditions => 'project_id = 1' - assert_equal 2, entries.size - developer_names = entries.map { |d| d.name } - assert developer_names.include?('David') - assert developer_names.include?('Jamis') - - expected = entries.to_a - entries = Developer.paginate :page => 1, - :joins => 'LEFT JOIN developers_projects ON users.id = developers_projects.developer_id', - :conditions => 'project_id = 1', :count => { :select => "users.id" } - assert_equal expected, entries.to_a + entries = nil + + assert_queries(1) do + entries = Developer.paginate :page => 1, + :joins => 'LEFT JOIN developers_projects ON users.id = developers_projects.developer_id', + :conditions => 'project_id = 1' + assert_equal 2, entries.size + developer_names = entries.map &:name + assert developer_names.include?('David') + assert developer_names.include?('Jamis') + end + + assert_queries(1) do + expected = entries.to_a + entries = Developer.paginate :page => 1, + :joins => 'LEFT JOIN developers_projects ON users.id = developers_projects.developer_id', + :conditions => 'project_id = 1', :count => { :select => "users.id" } + assert_equal expected, entries.to_a + assert_equal 2, entries.total_entries + end end def test_paginate_with_group - entries = Developer.paginate :page => 1, :per_page => 10, :group => 'salary' + entries = nil + assert_queries(1) do + entries = Developer.paginate :page => 1, :per_page => 10, + :group => 'salary', :select => 'salary', :order => 'salary' + end + expected = [ users(:david), users(:jamis), users(:dev_10), users(:poor_jamis) ].map(&:salary).sort - assert_equal expected, entries.map(&:salary).sort + assert_equal expected, entries.map(&:salary) end def test_paginate_with_dynamic_finder @@ -193,55 +214,95 @@ class FinderTest < ActiveRecordTestCase end end - def test_paginate_by_sql - assert_respond_to Developer, :paginate_by_sql - entries = Developer.paginate_by_sql ['select * from users where salary > ?', 80000], - :page => 2, :per_page => 3, :total_entries => 9 + def test_scoped_paginate + entries = Developer.with_poor_ones { Developer.paginate :page => 1 } - assert_equal (5..7).to_a, entries.map(&:id) - assert_equal 9, entries.total_entries + assert_equal 2, entries.size + assert_equal 2, entries.total_entries end - def test_count_by_sql - entries = Developer.paginate_by_sql ['select * from users where salary > ?', 60000], - :page => 2, :per_page => 3 + ## named_scope ## + + def test_paginate_in_named_scope + entries = Developer.poor.paginate :page => 1, :per_page => 1 - assert_equal 12, entries.total_entries + assert_equal 1, entries.size + assert_equal 2, entries.total_entries end + + def test_paginate_in_named_scope_on_habtm_association + project = projects(:active_record) + assert_queries(2) do + entries = project.developers.poor.paginate :page => 1, :per_page => 1 - def test_count_distinct - entries = Developer.paginate :select => 'DISTINCT salary', :page => 1, :per_page => 4 - assert_equal 4, entries.size - assert_equal 4, entries.total_entries + assert_equal 1, entries.size, 'one developer should be found' + assert_equal 1, entries.total_entries, 'only one developer should be found' + end end - def test_scoped_paginate - entries = - Developer.with_poor_ones do - Developer.paginate :page => 1 - end + def test_paginate_in_named_scope_on_hmt_association + project = projects(:active_record) + expected = [replies(:brave)] + + assert_queries(2) do + entries = project.replies.recent.paginate :page => 1, :per_page => 1 + assert_equal expected, entries + assert_equal 1, entries.total_entries, 'only one reply should be found' + end + end - assert_equal 2, entries.size - assert_equal 2, entries.total_entries + def test_paginate_in_named_scope_on_has_many_association + project = projects(:active_record) + expected = [topics(:ar)] + + assert_queries(2) do + entries = project.topics.mentions_activerecord.paginate :page => 1, :per_page => 1 + assert_equal expected, entries + assert_equal 1, entries.total_entries, 'only one topic should be found' + end + end + + ## misc ## + + def test_count_and_total_entries_options_are_mutually_exclusive + e = assert_raise ArgumentError do + Developer.paginate :page => 1, :count => {}, :total_entries => 1 + end + assert_match /exclusive/, e.to_s + end + + def test_readonly + assert_nothing_raised { Developer.paginate :readonly => true, :page => 1 } + end + + # this functionality is temporarily removed + def xtest_pagination_defines_method + pager = "paginate_by_created_at" + assert !User.methods.include?(pager), "User methods should not include `#{pager}` method" + # paginate! + assert 0, User.send(pager, nil, :page => 1).total_entries + # the paging finder should now be defined + assert User.methods.include?(pager), "`#{pager}` method should be defined on User" end - # Are we on edge? Find out by testing find_all which was removed in [6998] - unless Developer.respond_to? :find_all + # Is this Rails 2.0? Find out by testing find_all which was removed in [6998] + unless ActiveRecord::Base.respond_to? :find_all def test_paginate_array_of_ids # AR finders also accept arrays of IDs # (this was broken in Rails before [6912]) - entries = Developer.paginate((1..8).to_a, :per_page => 3, :page => 2) - assert_equal (4..6).to_a, entries.map(&:id) - assert_equal 8, entries.total_entries + assert_queries(1) do + entries = Developer.paginate((1..8).to_a, :per_page => 3, :page => 2, :order => 'id') + assert_equal (4..6).to_a, entries.map(&:id) + assert_equal 8, entries.total_entries + end end end - uses_mocha 'parameter' do + uses_mocha 'internals' do def test_implicit_all_with_dynamic_finders Topic.expects(:find_all_by_foo).returns([]) - Topic.expects(:wp_extract_finder_conditions) - Topic.expects(:count) - Topic.paginate_by_foo :page => 1 + Topic.expects(:count).returns(0) + Topic.paginate_by_foo :page => 2 end def test_guessing_the_total_count @@ -252,18 +313,37 @@ class FinderTest < ActiveRecordTestCase assert_equal 6, entries.total_entries end + def test_guessing_that_there_are_no_records + Topic.expects(:find).returns([]) + Topic.expects(:count).never + + entries = Topic.paginate :page => 1, :per_page => 4 + assert_equal 0, entries.total_entries + end + def test_extra_parameters_stay_untouched - Topic.expects(:find).with() { |*args| args.last.key? :foo }.returns(Array.new(5)) - Topic.expects(:count).with(){ |*args| args.last.key? :foo }.returns(1) + Topic.expects(:find).with(:all, {:foo => 'bar', :limit => 4, :offset => 0 }).returns(Array.new(5)) + Topic.expects(:count).with({:foo => 'bar'}).returns(1) Topic.paginate :foo => 'bar', :page => 1, :per_page => 4 end - def test_count_doesnt_use_select_options - Developer.expects(:find).with() { |*args| args.last.key? :select }.returns(Array.new(5)) - Developer.expects(:count).with(){ |*args| !args.last.key?(:select) }.returns(1) - - Developer.paginate :select => 'users.*', :page => 1, :per_page => 4 + def test_count_skips_select + Developer.stubs(:find).returns([]) + Developer.expects(:count).with({}).returns(0) + Developer.paginate :select => 'salary', :page => 2 + end + + def test_count_select_when_distinct + Developer.stubs(:find).returns([]) + Developer.expects(:count).with(:select => 'DISTINCT salary').returns(0) + Developer.paginate :select => 'DISTINCT salary', :page => 2 + end + + def test_count_with_scoped_select_when_distinct + Developer.stubs(:find).returns([]) + Developer.expects(:count).with(:select => 'DISTINCT users.id').returns(0) + Developer.distinct.paginate :page => 2 end def test_should_use_scoped_finders_if_present @@ -274,12 +354,95 @@ class FinderTest < ActiveRecordTestCase Topic.paginate_best :page => 1, :per_page => 4 end + def test_paginate_by_sql + assert_respond_to Developer, :paginate_by_sql + Developer.expects(:find_by_sql).with(regexp_matches(/sql LIMIT 3(,| OFFSET) 3/)).returns([]) + Developer.expects(:count_by_sql).with('SELECT COUNT(*) FROM (sql) AS count_table').returns(0) + + entries = Developer.paginate_by_sql 'sql', :page => 2, :per_page => 3 + end + + def test_paginate_by_sql_respects_total_entries_setting + Developer.expects(:find_by_sql).returns([]) + Developer.expects(:count_by_sql).never + + entries = Developer.paginate_by_sql 'sql', :page => 1, :total_entries => 999 + assert_equal 999, entries.total_entries + end + + def test_paginate_by_sql_strips_order_by_when_counting + Developer.expects(:find_by_sql).returns([]) + Developer.expects(:count_by_sql).with("SELECT COUNT(*) FROM (sql\n ) AS count_table").returns(0) + + Developer.paginate_by_sql "sql\n ORDER\nby foo, bar, `baz` ASC", :page => 2 + end + + # TODO: counts are still wrong def test_ability_to_use_with_custom_finders - # acts_as_taggable defines `find_tagged_with(tag, options)` - Topic.expects(:find_tagged_with).with('will_paginate', :offset => 0, :limit => 5).returns([]) + # acts_as_taggable defines find_tagged_with(tag, options) + Topic.expects(:find_tagged_with).with('will_paginate', :offset => 5, :limit => 5).returns([]) Topic.expects(:count).with({}).returns(0) - Topic.paginate_tagged_with 'will_paginate', :page => 1, :per_page => 5 + Topic.paginate_tagged_with 'will_paginate', :page => 2, :per_page => 5 + end + + def test_array_argument_doesnt_eliminate_count + ids = (1..8).to_a + Developer.expects(:find_all_by_id).returns([]) + Developer.expects(:count).returns(0) + + Developer.paginate_by_id(ids, :per_page => 3, :page => 2, :order => 'id') + end + + def test_paginating_finder_doesnt_mangle_options + Developer.expects(:find).returns([]) + options = { :page => 1, :per_page => 2, :foo => 'bar' } + options_before = options.dup + + Developer.paginate(options) + assert_equal options_before, options + end + + def test_paginate_by_sql_doesnt_change_original_query + query = 'SQL QUERY' + original_query = query.dup + Developer.expects(:find_by_sql).returns([]) + + Developer.paginate_by_sql query, :page => 1 + assert_equal original_query, query + end + + def test_paginated_each + collection = stub('collection', :size => 5, :empty? => false, :per_page => 5) + collection.expects(:each).times(2).returns(collection) + last_collection = stub('collection', :size => 4, :empty? => false, :per_page => 5) + last_collection.expects(:each).returns(last_collection) + + params = { :order => 'id', :total_entries => 0 } + + Developer.expects(:paginate).with(params.merge(:page => 2)).returns(collection) + Developer.expects(:paginate).with(params.merge(:page => 3)).returns(collection) + Developer.expects(:paginate).with(params.merge(:page => 4)).returns(last_collection) + + assert_equal 14, Developer.paginated_each(:page => '2') { } + end + + # detect ActiveRecord 2.1 + if ActiveRecord::Base.private_methods.include?('references_eager_loaded_tables?') + def test_removes_irrelevant_includes_in_count + Developer.expects(:find).returns([1]) + Developer.expects(:count).with({}).returns(0) + + Developer.paginate :page => 1, :per_page => 1, :include => :projects + end + + def test_doesnt_remove_referenced_includes_in_count + Developer.expects(:find).returns([1]) + Developer.expects(:count).with({ :include => :projects, :conditions => 'projects.id > 2' }).returns(0) + + Developer.paginate :page => 1, :per_page => 1, + :include => :projects, :conditions => 'projects.id > 2' + end end end end vendor/plugins/will_paginate/test/finder_test.rb @@ -7,5 +7,8 @@ class Developer < User end end + named_scope :distinct, :select => 'DISTINCT `users`.*' + named_scope :poor, :conditions => ['salary <= ?', 80000], :order => 'salary' + def self.per_page() 10 end end vendor/plugins/will_paginate/test/fixtures/developer.rb @@ -1,7 +1,6 @@ -action_controller: - id: 2 - name: Active Controller - active_record: id: 1 name: Active Record +action_controller: + id: 2 + name: Active Controller vendor/plugins/will_paginate/test/fixtures/projects.yml @@ -3,32 +3,27 @@ witty_retort: topic_id: 1 content: Birdman is better! created_at: <%= 6.hours.ago.to_s(:db) %> - updated_at: nil another: id: 2 topic_id: 2 content: Nuh uh! created_at: <%= 1.hour.ago.to_s(:db) %> - updated_at: nil spam: id: 3 topic_id: 1 content: Nice site! created_at: <%= 1.hour.ago.to_s(:db) %> - updated_at: nil decisive: id: 4 topic_id: 4 content: "I'm getting to the bottom of this" created_at: <%= 30.minutes.ago.to_s(:db) %> - updated_at: nil brave: id: 5 topic_id: 4 content: "AR doesn't scare me a bit" created_at: <%= 10.minutes.ago.to_s(:db) %> - updated_at: nil vendor/plugins/will_paginate/test/fixtures/replies.yml @@ -1,5 +1,7 @@ class Reply < ActiveRecord::Base belongs_to :topic, :include => [:replies] + + named_scope :recent, :conditions => ['replies.created_at > ?', 15.minutes.ago] validates_presence_of :content end vendor/plugins/will_paginate/test/fixtures/reply.rb @@ -1,21 +1,22 @@ ActiveRecord::Schema.define do - create_table "developers_projects", :id => false, :force => true do |t| - t.column "developer_id", :integer, :null => false - t.column "project_id", :integer, :null => false - t.column "joined_on", :date - t.column "access_level", :integer, :default => 1 + create_table "users", :force => true do |t| + t.column "name", :text + t.column "salary", :integer, :default => 70000 + t.column "created_at", :datetime + t.column "updated_at", :datetime + t.column "type", :text end create_table "projects", :force => true do |t| t.column "name", :text end - create_table "replies", :force => true do |t| - t.column "content", :text - t.column "created_at", :datetime - t.column "updated_at", :datetime - t.column "topic_id", :integer + create_table "developers_projects", :id => false, :force => true do |t| + t.column "developer_id", :integer, :null => false + t.column "project_id", :integer, :null => false + t.column "joined_on", :date + t.column "access_level", :integer, :default => 1 end create_table "topics", :force => true do |t| @@ -27,12 +28,11 @@ ActiveRecord::Schema.define do t.column "updated_at", :datetime end - create_table "users", :force => true do |t| - t.column "name", :text - t.column "salary", :integer, :default => 70000 + create_table "replies", :force => true do |t| + t.column "content", :text t.column "created_at", :datetime t.column "updated_at", :datetime - t.column "type", :text + t.column "topic_id", :integer end end vendor/plugins/will_paginate/test/fixtures/schema.rb @@ -1,4 +1,6 @@ class Topic < ActiveRecord::Base has_many :replies, :dependent => :destroy, :order => 'replies.created_at DESC' belongs_to :project + + named_scope :mentions_activerecord, :conditions => ['topics.title LIKE ?', '%ActiveRecord%'] end vendor/plugins/will_paginate/test/fixtures/topic.rb @@ -4,7 +4,7 @@ require 'rubygems' # gem install redgreen for colored test output begin require 'redgreen'; rescue LoadError; end -require File.join(File.dirname(__FILE__), 'boot') unless defined?(ActiveRecord) +require 'boot' unless defined?(ActiveRecord) class Test::Unit::TestCase protected @@ -13,13 +13,25 @@ class Test::Unit::TestCase [method.to_s, method.to_sym].each { |m| assert_respond_to object, m } end end + + def collect_deprecations + old_behavior = WillPaginate::Deprecation.behavior + deprecations = [] + WillPaginate::Deprecation.behavior = Proc.new do |message, callstack| + deprecations << message + end + result = yield + [result, deprecations] + ensure + WillPaginate::Deprecation.behavior = old_behavior + end end # Wrap tests that use Mocha and skip if unavailable. def uses_mocha(test_name) require 'mocha' unless Object.const_defined?(:Mocha) - yield rescue LoadError => load_error - raise unless load_error.message =~ /mocha/i $stderr.puts "Skipping #{test_name} tests. `gem install mocha` and try again." +else + yield end vendor/plugins/will_paginate/test/helper.rb @@ -1,10 +1,10 @@ -require File.join(File.dirname(__FILE__), 'activerecord_test_connector') +require 'lib/activerecord_test_connector' class ActiveRecordTestCase < Test::Unit::TestCase # Set our fixture path if ActiveRecordTestConnector.able_to_connect self.fixture_path = File.join(File.dirname(__FILE__), '..', 'fixtures') - self.use_transactional_fixtures = false + self.use_transactional_fixtures = true end def self.fixtures(*args) @@ -18,6 +18,19 @@ class ActiveRecordTestCase < Test::Unit::TestCase # Default so Test::Unit::TestCase doesn't complain def test_truth end + + protected + + def assert_queries(num = 1) + $query_count = 0 + yield + ensure + assert_equal num, $query_count, "#{$query_count} instead of #{num} queries were executed." + end + + def assert_no_queries(&block) + assert_queries(0, &block) + end end ActiveRecordTestConnector.setup vendor/plugins/will_paginate/test/lib/activerecord_test_case.rb @@ -6,6 +6,8 @@ class ActiveRecordTestConnector cattr_accessor :able_to_connect cattr_accessor :connected + FIXTURES_PATH = File.join(File.dirname(__FILE__), '..', 'fixtures') + # Set our defaults self.connected = false self.able_to_connect = true @@ -14,54 +16,58 @@ class ActiveRecordTestConnector unless self.connected || !self.able_to_connect setup_connection load_schema - # require_fixture_models - Dependencies.load_paths.unshift(File.dirname(__FILE__) + "/../fixtures") + add_load_path FIXTURES_PATH self.connected = true end rescue Exception => e # errors from ActiveRecord setup - $stderr.puts "\nSkipping ActiveRecord assertion tests: #{e}" - #$stderr.puts " #{e.backtrace.join("\n ")}\n" + $stderr.puts "\nSkipping ActiveRecord tests: #{e}\n\n" self.able_to_connect = false end private + + def self.add_load_path(path) + dep = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : ::Dependencies + dep.load_paths.unshift path + end def self.setup_connection - if Object.const_defined?(:ActiveRecord) - defaults = { :database => ':memory:' } - ActiveRecord::Base.logger = Logger.new STDOUT if $0 == 'irb' - - begin - options = defaults.merge :adapter => 'sqlite3', :timeout => 500 - ActiveRecord::Base.establish_connection(options) - ActiveRecord::Base.configurations = { 'sqlite3_ar_integration' => options } - ActiveRecord::Base.connection - rescue Exception # errors from establishing a connection - $stderr.puts 'SQLite 3 unavailable; trying SQLite 2.' - options = defaults.merge :adapter => 'sqlite' - ActiveRecord::Base.establish_connection(options) - ActiveRecord::Base.configurations = { 'sqlite2_ar_integration' => options } - ActiveRecord::Base.connection - end + db = ENV['DB'].blank?? 'sqlite3' : ENV['DB'] + + configurations = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'database.yml')) + raise "no configuration for '#{db}'" unless configurations.key? db + configuration = configurations[db] + + ActiveRecord::Base.logger = Logger.new(STDOUT) if $0 == 'irb' + puts "using #{configuration['adapter']} adapter" unless ENV['DB'].blank? + + ActiveRecord::Base.establish_connection(configuration) + ActiveRecord::Base.configurations = { db => configuration } + prepare ActiveRecord::Base.connection - unless Object.const_defined?(:QUOTED_TYPE) - Object.send :const_set, :QUOTED_TYPE, ActiveRecord::Base.connection.quote_column_name('type') - end - else - raise "Can't setup connection since ActiveRecord isn't loaded." + unless Object.const_defined?(:QUOTED_TYPE) + Object.send :const_set, :QUOTED_TYPE, ActiveRecord::Base.connection.quote_column_name('type') end end def self.load_schema ActiveRecord::Base.silence do ActiveRecord::Migration.verbose = false - load File.dirname(__FILE__) + "/../fixtures/schema.rb" + load File.join(FIXTURES_PATH, 'schema.rb') end end - def self.require_fixture_models - models = Dir.glob(File.dirname(__FILE__) + "/../fixtures/*.rb") - models = (models.grep(/user.rb/) + models).uniq - models.each { |f| require f } + def self.prepare(conn) + class << conn + IGNORED_SQL = [/^PRAGMA/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SHOW FIELDS /] + + def execute_with_counting(sql, name = nil, &block) + $query_count ||= 0 + $query_count += 1 unless IGNORED_SQL.any? { |r| sql =~ r } + execute_without_counting(sql, name, &block) + end + + alias_method_chain :execute, :counting + end end end vendor/plugins/will_paginate/test/lib/activerecord_test_connector.rb @@ -1,13 +1,11 @@ -dirname = File.dirname(__FILE__) -require File.join(dirname, '..', 'boot') -require File.join(dirname, 'activerecord_test_connector') +require 'boot' +require 'lib/activerecord_test_connector' # setup the connection ActiveRecordTestConnector.setup # load all fixtures -fixture_path = File.join(dirname, '..', 'fixtures') -Fixtures.create_fixtures(fixture_path, ActiveRecord::Base.connection.tables) +Fixtures.create_fixtures(ActiveRecordTestConnector::FIXTURES_PATH, ActiveRecord::Base.connection.tables) require 'will_paginate' WillPaginate.enable_activerecord vendor/plugins/will_paginate/test/lib/load_fixtures.rb vendor/plugins/restful_authentication/README vendor/plugins/restful_authentication/generators/authenticated/templates/activation.rhtml vendor/plugins/restful_authentication/generators/authenticated/templates/fixtures.yml vendor/plugins/restful_authentication/generators/authenticated/templates/functional_spec.rb vendor/plugins/restful_authentication/generators/authenticated/templates/functional_test.rb vendor/plugins/restful_authentication/generators/authenticated/templates/login.rhtml vendor/plugins/restful_authentication/generators/authenticated/templates/mailer_test.rb vendor/plugins/restful_authentication/generators/authenticated/templates/model_functional_spec.rb vendor/plugins/restful_authentication/generators/authenticated/templates/model_functional_test.rb vendor/plugins/restful_authentication/generators/authenticated/templates/signup.rhtml vendor/plugins/restful_authentication/generators/authenticated/templates/signup_notification.rhtml vendor/plugins/restful_authentication/generators/authenticated/templates/unit_spec.rb vendor/plugins/restful_authentication/generators/authenticated/templates/unit_test.rb vendor/plugins/rspec-rails/spec/rails/autotest/rails_rspec_spec.rb vendor/plugins/rspec-rails/spec/rails/matchers/render_spec.rb vendor/plugins/will_paginate/README vendor/plugins/will_paginate/test/array_pagination_test.rb vendor/plugins/will_paginate/test/pagination_test.rb ed82a25ebee7761420a493d915237723e9b4a5b2 Nick Quaranto nick@quaran.to http://github.com/courtenay/altered_beast/commit/e6d3af7e6258e346969e2f8be780fbb4ea744bfa e6d3af7e6258e346969e2f8be780fbb4ea744bfa 2008-09-23T17:07:26-07:00 2008-09-23T17:07:26-07:00 Trying to update this thing to 2.1 e01aee4349c790c2e04422f379661a58a85ddef1 Nick Quaranto nick@quaran.to