rspectacular 0.12.0 → 0.13.0

data/README.md

@@ -1,2 +1,55 @@
-Rspectacular
+RSpectacular
 ==============================================================================
+
+**It's like RSpec, but more spectacularer**
+
+<img src="http://cdn.memegenerator.net/instances/300x/34275719.jpg" align="right" />
+
+When installing many of the most popular gems, they typically require some form
+of configuration to be added to your `spec_helper.rb` file in order to make them
+work properly in test mode.
+
+Additionally, there are RSpec settings which are pretty standard for most users
+of the framework. Personally we found ourselves copying and pasting files from
+project to project. This was a huge nightmare.
+
+What we decided to do was to package it all up as a gem so that we can simply
+include it in the project and update it as necessary. Version 1.x won't allow
+for too many different customizations, but the plan for 2.x is _selective_
+overriding of RSpectacular configuration decisions.
+
+The philosophy behind this gem is to:
+
+* Retain uber-fast test startup times
+* Keep per-project configurations to a minimum
+
+Obviously there may still need to be project-specific configurations that will
+need to take place.  However, what you should see when you look at your spec's
+configuration should be things that are exceptional to your project; nothing
+more.
+
+[Welcome to RSpectacular](#wiki).
+
+Usage
+------------------------------------------------------------------------------
+
+Take a look at the project's [Wiki](#wiki) for full details and usage.
+
+Issues
+------
+
+If you have problems, please create a [Github issue](issues).
+
+Credits
+-------
+
+![thekompanee](http://www.thekompanee.com/public_files/kompanee-github-readme-logo.png)
+
+rspectacular is maintained by [The Kompanee, Ltd.](http://www.thekompanee.com)
+
+The names and logos for The Kompanee are trademarks of The Kompanee, Ltd.
+
+License
+-------
+
+rspectacular is Copyright &copy; 2013 The Kompanee. It is free software, and may be redistributed under the terms specified in the LICENSE file.

data/lib/rspectacular/mock_authentications/omniauth.rb

@@ -0,0 +1 @@
+Dir[File.expand_path('../omniauth/*.rb', __FILE__)].each { |f| require f }

data/lib/rspectacular/mock_authentications/omniauth/facebook.rb

@@ -0,0 +1,43 @@
+module  OmniAuth
+module  Facebook
+module  MockAuthentication
+  def self.user
+    {
+      'provider'    => 'facebook',
+      'uid'         => '100002971692646',
+      'credentials' => {
+        'token' => 'my_facebook_token'
+      },
+      'info'        => {
+        'name'        => 'Sharon Letuchysky',
+        'email'       => nil,
+        'nickname'    => nil,
+        'first_name'  => 'Sharon',
+        'last_name'   => 'Letuchysky',
+        'location'    => nil,
+        'description' => nil,
+        'image'       => 'http://graph.facebook.com/100002971692646/picture?type=square',
+        'phone'       => nil,
+        'urls'        => {
+          'Facebook' => 'http://www.facebook.com/profile.php?id=100002971692646',
+          'Website'  => nil
+        }
+      },
+      'extra'       => {
+        'user_hash' => {
+          'id'           => '100002971692646',
+          'name'         => 'Sharon Ambiggjcaccg Letuchysky',
+          'first_name'   => 'Sharon',
+          'middle_name'  => 'Ambiggjcaccg',
+          'last_name'    => 'Letuchysky',
+          'link'         => 'http://www.facebook.com/profile.php?id=100002971692646',
+          'gender'       => 'female',
+          'locale'       => 'en_US',
+          'updated_time' => '2011-09-11T17:00:51+0000'
+        }
+      }
+    }
+  end
+end
+end
+end

data/lib/rspectacular/mock_authentications/omniauth/twitter.rb

@@ -0,0 +1,43 @@
+module  OmniAuth
+module  Twitter
+module  MockAuthentication
+  def self.user
+    {
+      'provider'    => 'twitter',
+      'uid'         => '100002971692646',
+      'credentials' => {
+        'token' => 'my_twitter_token'
+      },
+      'info'        => {
+        'name'        => 'Sharon Letuchysky',
+        'email'       => nil,
+        'nickname'    => nil,
+        'first_name'  => 'Sharon',
+        'last_name'   => 'Letuchysky',
+        'location'    => nil,
+        'description' => nil,
+        'image'       => 'http://graph.facebook.com/100002971692646/picture?type=square',
+        'phone'       => nil,
+        'urls'        => {
+          'Facebook' => 'http://www.facebook.com/profile.php?id=100002971692646',
+          'Website'  => nil
+        }
+      },
+      'extra'       => {
+        'user_hash' => {
+          'id'           => '100002971692646',
+          'name'         => 'Sharon Ambiggjcaccg Letuchysky',
+          'first_name'   => 'Sharon',
+          'middle_name'  => 'Ambiggjcaccg',
+          'last_name'    => 'Letuchysky',
+          'link'         => 'http://www.facebook.com/profile.php?id=100002971692646',
+          'gender'       => 'female',
+          'locale'       => 'en_US',
+          'updated_time' => '2011-09-11T17:00:51+0000'
+        }
+      }
+    }
+  end
+end
+end
+end

data/lib/rspectacular/plugins/capybara.rb

@@ -1,3 +1,24 @@
-if defined?(Capybara::Driver::Base) && defined?(Capybara::Webkit)
-  Capybara.javascript_driver = :webkit
+##############################################################################
+#                               Capybara Plugin
+##############################################################################
+#
+# This plugin does not attempt to require capybara. It assumes that if you're
+# using capybara, you're probably using something like Bundler which has already
+# required it for you.
+#
+# If this is not the case, you will need to require it prior to requiring
+# rspectacular.
+#
+# The same goes for capybara-webkit. It must be required before rspectacular.
+#
+if defined?(Capybara::Driver::Base)
+  if defined?(Capybara::Webkit)
+    Capybara.javascript_driver = :webkit
+  end
+
+  RSpec.configure do |config|
+    config.before(:each, :js => true) do
+      page.driver.reset!
+    end
+  end
 end

data/lib/rspectacular/plugins/carrier_wave.rb

@@ -1,24 +1,30 @@
-###
-# Make CarrierWave tests faster and more reliable
-#
-if defined? CarrierWave
+##############################################################################
+#                             CarrierWave Plugin
+##############################################################################
+
+begin
+  require 'carrierwave'
   require 'carrierwave/test/matchers'
 
+  RSpec.configure do |config|
+    config.include CarrierWave::Test::Matchers, :file_attachment => true
+  end
+
   CarrierWave.configure do |config|
     config.storage           = :file
-    config.root              = Rails.root.join('tmp')
+    config.root              = File.expand_path('./tmp')
     config.enable_processing = false
   end
 
   RSpec.configure do |config|
-    config.include CarrierWave::Test::Matchers, :carrier_wave => true
-
-    config.before(:each, :carrier_wave => true) do
+    config.around(:each, :file_attachment => true) do |example|
+      previous_carrierwave_processing_mode = subject.class.enable_processing
       subject.class.enable_processing = true
-    end
 
-    config.after(:each, :carrier_wave => true) do
-      subject.class.enable_processing = false
+      example.run
+
+      subject.class.enable_processing = previous_carrierwave_processing_mode
     end
   end
+rescue LoadError
 end

data/lib/rspectacular/plugins/database_cleaner.rb

@@ -1,7 +1,17 @@
-if defined? ActiveRecord::Base
+##############################################################################
+#                         Database Cleaner Plugin
+##############################################################################
+
+begin
+  require 'database_cleaner'
+
   begin
-    require 'database_cleaner'
+    autodetected = DatabaseCleaner::Base.new.send(:autodetect)
+  rescue DatabaseCleaner::NoORMDetected
+    autodetected = false
+  end
 
+  if autodetected
     RSpec.configure do |config|
       config.before(:suite) do
         DatabaseCleaner.clean_with(:truncation)
@@ -29,11 +39,11 @@ if defined? ActiveRecord::Base
         config.use_transactional_fixtures = false
       end
     end
-  rescue LoadError
-    if defined? RSpec::Rails
-      RSpec.configure do |config|
-        config.use_transactional_fixtures = true
-      end
+  end
+rescue LoadError, DatabaseCleaner::NoORMDetected
+  if defined? RSpec::Rails
+    RSpec.configure do |config|
+      config.use_transactional_fixtures = true
     end
   end
 end

data/lib/rspectacular/plugins/devise.rb

@@ -1,8 +1,14 @@
-if defined? Devise
-  # Don't go nuts encrypting the password, we're just testing
+##############################################################################
+#                               Devise Plugin
+##############################################################################
+
+begin
+  require 'devise'
+
   Devise.stretches = 1
 
   RSpec.configure do |config|
     config.include Devise::TestHelpers, :type => :controller
   end
+rescue LoadError
 end

data/lib/rspectacular/plugins/email.rb

@@ -1,8 +1,21 @@
-if defined? EmailSpec
+##############################################################################
+#                               Email Plugin
+##############################################################################
+#
+# The approach to this plugin is twofold. First it uses the excellent email_spec
+# gem to add helpers and matchers to any spec file with :email => true set.
+# Secondly, it will also clear all deliveries from ActionMailer if it is loaded.
+#
+# https://github.com/bmabey/email-spec/
+#
+begin
+  require 'email_spec'
+
   RSpec.configure do |config|
     config.include EmailSpec::Helpers,  :email => true
     config.include EmailSpec::Matchers, :email => true
   end
+rescue LoadError
 end
 
 if defined? ActionMailer

data/lib/rspectacular/plugins/factory_girl.rb

@@ -1,3 +1,7 @@
+##############################################################################
+#                             Factory Girl Plugin
+##############################################################################
+
 begin
   require 'factory_girl'
 

data/lib/rspectacular/plugins/features.rb

@@ -0,0 +1,42 @@
+##############################################################################
+#                               Features Plugin
+##############################################################################
+#
+# This plugin enables the feature/scenario/background/given syntax in RSpec
+# without requiring Capybara as a dependency (and may also be used outside of
+# Rails).  The contents of this file are taken verbatim from
+#
+# https://github.com/jnicklas/capybara/blob/cd4327857bd3bafa8614b7bffb2886a8ab401953/lib/capybara/rspec/features.rb
+#
+# and should be updated whenever that file is updated.
+#
+module Capybara
+  module Features
+    def self.included(base)
+      base.instance_eval do
+        alias :background :before
+        alias :scenario :it
+        alias :xscenario :xit
+        alias :given :let
+        alias :given! :let!
+
+        if defined?(RSpec::Rails)
+          include RSpec::Rails::RequestExampleGroup
+          include Rack::Test::Methods
+        end
+      end
+    end
+  end
+end
+
+def self.feature(*args, &block)
+  options = if args.last.is_a?(Hash) then args.pop else {} end
+  options[:capybara_feature] = true
+  options[:type] = :feature
+  options[:caller] ||= caller
+  args.push(options)
+
+  describe(*args, &block)
+end
+
+RSpec.configuration.include Capybara::Features, :capybara_feature => true

data/lib/rspectacular/plugins/omniauth.rb

@@ -1,9 +1,17 @@
-if defined? OmniAuth
+##############################################################################
+#                             OmniAuth Plugin
+##############################################################################
+
+begin
+  require 'omniauth'
+  require 'rspectacular/mock_authentications/omniauth'
+
   ###
   # Tell OmniAuth to just return whatever hash we want for each auth type
   #
   OmniAuth.config.test_mode            = true
-  OmniAuth.config.mock_auth[:facebook] = MockAuthentication::Facebook.user
+  OmniAuth.config.mock_auth[:facebook] = OmniAuth::Facebook::MockAuthentication.user
+  OmniAuth.config.mock_auth[:twitter]  = OmniAuth::Twitter::MockAuthentication.user
 
   ###
   # Except we don't want OmniAuth to fake anything when doing live tests
@@ -11,12 +19,12 @@ if defined? OmniAuth
   RSpec.configure do |config|
     config.around(:each, :js => true) do |example|
       previous_omniauth_test_mode = OmniAuth.config.test_mode
-
-      OmniAuth.config.test_mode = false
+      OmniAuth.config.test_mode   = false
 
       example.run
 
       OmniAuth.config.test_mode = previous_omniauth_test_mode
     end
   end
+rescue LoadError
 end

data/lib/rspectacular/plugins/paypal.rb

@@ -1,14 +1,11 @@
-###
-# PayPal requires that you log into the PayPal sandbox before getting access
-# to test users.
-#
+##############################################################################
+#                               PayPal Plugin
+##############################################################################
+
 RSpec.configure do |config|
   config.before(:each, :js => true, :paypal => true) do
-    log_in_to_paypal_sandbox
-  end
+    require 'rspectacular/helpers/paypal'
 
-  config.after(:each, :js => true, :paypal => true) do
-    log_out_of_paypal
-    log_out_of_paypal_sandbox
+    log_in_to_paypal_sandbox
   end
 end

data/lib/rspectacular/plugins/recaptcha.rb

@@ -1,5 +1,12 @@
-if defined? Recaptcha
+##############################################################################
+#                             Recaptcha Plugin
+##############################################################################
+
+begin
+  require 'recaptcha'
+
   Recaptcha.configure do |config|
     config.skip_verify_env = ['test']
   end
+rescue LoadError
 end

data/lib/rspectacular/plugins/shoulda.rb

@@ -1,15 +1,24 @@
-if defined? Shoulda::Matchers
-  module ShouldaRoutingMatchers
-    def route(method, path)
-      Shoulda::Matchers::ActionController::RouteMatcher.new(method, path, self)
+##############################################################################
+#                             Shoulda Plugin
+##############################################################################
+
+if defined? RSpec::Rails
+  begin
+    require 'shoulda-matchers'
+
+    module ShouldaRoutingMatchers
+      def route(method, path)
+        Shoulda::Matchers::ActionController::RouteMatcher.new(method, path, self)
+      end
     end
-  end
 
-  module RSpec
-    module Rails
-      module RoutingExampleGroup
-        include ShouldaRoutingMatchers
+    module RSpec
+      module Rails
+        module RoutingExampleGroup
+          include ShouldaRoutingMatchers
+        end
       end
     end
+  rescue LoadError
   end
 end

data/lib/rspectacular/plugins/singleton.rb

@@ -1,12 +1,15 @@
-require 'singleton'
+##############################################################################
+#                            Singleton Plugin
+##############################################################################
 
 RSpec.configure do |config|
-  config.around(:each, :singletons => lambda { |v| !!v }) do |example|
+  config.before(:each, :singletons => lambda { |v| !!v }) do |example|
+    require 'singleton'
+
     options             = example.metadata[:singletons]
+    options             = options.is_a?(TrueClass) ? subject.class : options
     singletons_to_reset = options.respond_to?(:each) ? options : [options]
 
-    example.run
-
     singletons_to_reset.each do |singleton|
       Singleton.__init__(singleton)
     end

data/lib/rspectacular/plugins/timecop.rb

@@ -1,3 +1,7 @@
+##############################################################################
+#                               Timecop Plugin
+##############################################################################
+
 begin
   require 'timecop'
 

data/lib/rspectacular/plugins/vcr.rb

@@ -1,12 +1,21 @@
+##############################################################################
+#                                 VCR Plugin
+##############################################################################
+
 begin
   require 'vcr'
+  require 'rspectacular/plugins/webmock'
 
   VCR.configure do |config|
-    config.cassette_library_dir = 'tmp/vcr_cassettes'
+    config.cassette_library_dir = File.expand_path('./tmp/vcr_cassettes')
 
-    config.hook_into :faraday
+    config.hook_into :webmock
     config.configure_rspec_metadata!
   end
 
+  RSpec.configure do |config|
+    config.extend VCR::RSpec::Macros
+  end
+
 rescue LoadError
 end

data/lib/rspectacular/plugins/webmock.rb

@@ -1,10 +1,17 @@
+##############################################################################
+#                              WebMock Plugin
+##############################################################################
+
 begin
   require 'webmock/rspec'
 
   RSpec.configure do |config|
     config.around(:each, :web_mock => lambda { |v| !!v }) do |example|
       options = example.metadata[:web_mock]
-      options = options.is_a?(Hash) ? options : {}
+      options = case options
+                when TrueClass
+                  { :allow_localhost => true }
+                end
 
       WebMock.disable_net_connect!(options)
 

data/lib/rspectacular/spec_helpers/{active_record_spec_helper.rb → active_record_basic.rb}

@@ -1,7 +1,7 @@
 require 'active_record'
 
-rails_database_yaml_file_path         = File.expand_path('../../config/database.yml',    __FILE__)
-rails_engine_database_yaml_file_path  = File.expand_path('../dummy/config/database.yml', __FILE__)
+rails_database_yaml_file_path         = File.join(Dir.pwd, 'config', 'database.yml')
+rails_engine_database_yaml_file_path  = File.join(Dir.pwd, 'spec', 'dummy', 'config', 'database.yml')
 
 database_yaml_file_path               = if File.exist? rails_engine_database_yaml_file_path
                                           rails_engine_database_yaml_file_path
@@ -15,8 +15,4 @@ ActiveRecord::Base.establish_connection(connection_info)
 
 require 'rspectacular'
 
-Dir[File.expand_path('../support/**/*.rb',   __FILE__)].each { |f| require f }
-
-RSpec.configure do |config|
-  config.order = 'random'
-end
+Dir[File.join(Dir.pwd, 'spec', 'support', '**', '*.rb')].each { |f| require f }

data/lib/rspectacular/spec_helpers/rails_engine.rb

@@ -0,0 +1,9 @@
+ENV["RAILS_ENV"] ||= 'test'
+require File.join(Dir.pwd, 'spec', 'dummy', 'config', 'environment')
+
+require 'rspec/rails'
+require 'rspec/autorun'
+
+require 'rspectacular'
+
+Dir[File.join(Dir.pwd, 'spec', 'support', '**', '*.rb')].each { |f| require f }

data/lib/rspectacular/support.rb

@@ -1,7 +1 @@
-require 'rspectacular/support/general'
-require 'rspectacular/support/garbage_collection'
-require 'rspectacular/support/random'
-require 'rspectacular/support/focused'
-require 'rspectacular/support/pending'
-require 'rspectacular/support/selenium'
-require 'rspectacular/support/formatters'
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }

data/lib/rspectacular/version.rb

@@ -1,3 +1,3 @@
 module RSpectacular
-  VERSION = '0.12.0'
+  VERSION = '0.13.0'
 end

metadata

@@ -1,19 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rspectacular
 version: !ruby/object:Gem::Version
+  version: 0.13.0
   prerelease: 
-  version: 0.12.0
 platform: ruby
 authors:
 - jfelchner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-23 00:00:00.000000000 Z
+date: 2013-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  type: :runtime
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -21,6 +19,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.12'
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -28,8 +28,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.12'
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  type: :runtime
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -37,6 +35,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -66,13 +66,16 @@ files:
 - lib/rspectacular/matchers/active_record.rb
 - lib/rspectacular/matchers/authentication.rb
 - lib/rspectacular/matchers.rb
+- lib/rspectacular/mock_authentications/omniauth/facebook.rb
+- lib/rspectacular/mock_authentications/omniauth/twitter.rb
+- lib/rspectacular/mock_authentications/omniauth.rb
 - lib/rspectacular/plugins/capybara.rb
 - lib/rspectacular/plugins/carrier_wave.rb
 - lib/rspectacular/plugins/database_cleaner.rb
 - lib/rspectacular/plugins/devise.rb
 - lib/rspectacular/plugins/email.rb
-- lib/rspectacular/plugins/facebook.rb
 - lib/rspectacular/plugins/factory_girl.rb
+- lib/rspectacular/plugins/features.rb
 - lib/rspectacular/plugins/omniauth.rb
 - lib/rspectacular/plugins/paypal.rb
 - lib/rspectacular/plugins/recaptcha.rb
@@ -84,7 +87,8 @@ files:
 - lib/rspectacular/plugins.rb
 - lib/rspectacular/selectors/defaults.rb
 - lib/rspectacular/selectors.rb
-- lib/rspectacular/spec_helpers/active_record_spec_helper.rb
+- lib/rspectacular/spec_helpers/active_record_basic.rb
+- lib/rspectacular/spec_helpers/rails_engine.rb
 - lib/rspectacular/support/focused.rb
 - lib/rspectacular/support/formatters.rb
 - lib/rspectacular/support/garbage_collection.rb
@@ -121,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rspectacular
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: RSpec Support And Matchers

data/lib/rspectacular/plugins/facebook.rb

@@ -1,14 +0,0 @@
-if defined?(Capybara::Driver::Base)
-  RSpec.configure do |config|
-    config.after(:each, :facebook => true) do
-      visit 'https://www.facebook.com'
-
-      if Capybara.current_session.has_link? idsf('the Facebook account menu')
-        click_link   idsf('the Facebook account menu')
-        click_button 'Log Out'
-
-        page.driver.browser.switch_to.alert.accept
-      end
-    end
-  end
-end