rails_apps_testing 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fb7540e115f41fded77bfa902e5c64fdca2ecce
+  data.tar.gz: 78b787c1c2a71c8b930b6f73ee89da1759b556b7
+SHA512:
+  metadata.gz: 3e4096bd8495eed4b5b6a036152e296d0c9a2fee2d92e1a783a6784aa53eec710502b2826cb619502fab4f52743a18fcb74f199e40c3c4d8a1983cad99709e63
+  data.tar.gz: d15ba5272e3255e0f8d15a03a6fff0f2f124c3fdd051d010cb4254469a5dbe435c8499624307b84042f558afb9fad2b92a863f3ff298f00bbb758bad56e60fbe

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/CHANGELOG.textile

@@ -0,0 +1,5 @@
+h1. CHANGELOG
+
+h3. 0.1.0 April 26, 2014
+
+* set up RSpec and friends in a Rails application

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_apps_testing.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel Kehoe
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,191 @@
+h1. !http://railsapps.github.io/images/rails-36x36.jpg(RailsAppsTesting Gem)! RailsAppsTesting Gem
+
+Use this gem to set up a testing framework. The gem modifies a Rails application and configures:
+
+* "RSpec Rails":https://github.com/rspec/rspec-rails – installs RSpec gems with support for Rails
+* "Capybara":https://github.com/jnicklas/capybara – tests web pages
+* "Database Cleaner":https://github.com/bmabey/database_cleaner – a clean slate for databases
+* "FactoryGirl Rails":https://github.com/thoughtbot/factory_girl_rails – creates test data
+* "Launchy":https://github.com/copiousfreetime/launchy – view errors in your web browser
+* "Selenium Webdriver":http://docs.seleniumhq.org/projects/webdriver/ – for tests that require JavaScript
+
+This suite of gems is popular for testing Rails applications. Typically, a developer makes several small configuration changes when setting up a test framework with these gems. The configuration changes are easy to make manually, but this gem provides a generator to make the changes, for ease of use with an automated process such as an application template.
+
+RailsAppsTesting is a utility gem to use during development. You can remove it after setting up your test framework. It was originally written for use by the "Rails Composer":http://railsapps.github.io/rails-composer/ tool. Use Rails Composer to build any of the "RailApps example applications":http://railsapps.github.io/ for use as starter apps.
+
+h4. !http://railsapps.github.io/images/join/join-railsapps.png(Join RailsApps)!:http://railsapps.github.io/
+
+h4. Support the RailsApps Project
+
+If the RailsAppsTesting gem is useful to you, please accept our invitation to "join the RailsApps project":http://railsapps.github.io/. The RailsApps project provides example applications, tutorials, and starter tools, including the RailsAppsTesting gem.
+
+h2. Install a Testing Framework
+
+The RailsApps project offers a tutorial:
+
+* "RSpec Tutorial":http://railsapps.github.io/rspec.html
+
+To install a testing framework, add the gems you need. Then use the RailsAppsTesting gem. It will set up and configure your testing framework.
+
+Add the gems you need to your Rails application Gemfile:
+
+<pre>
+group :development do
+  gem 'rails_apps_testing'
+end
+group :development, :test do
+  gem 'rspec-rails'
+  gem 'factory_girl_rails'
+end
+group :test do
+  gem 'capybara'
+  gem 'database_cleaner'
+  gem 'launchy'
+  gem 'selenium-webdriver'
+end
+</pre>
+
+You don't need the RailsAppsTesting gem deployed to production, so put it in the @development@ group.
+
+If you want to use a newer unreleased version from GitHub:
+
+<pre>
+group :development do
+  gem 'rails_apps_testing', github: 'RailsApps/rails_apps_testing'
+end
+</pre>
+
+h4. Use Bundler
+
+Use Bundler to install the gems:
+
+<pre>
+$ bundle install
+</pre>
+
+h2. Configure RSpec and Friends
+
+To run the generator and configure the testing framework:
+
+<pre>
+$ rails generate testing:configure rspec
+</pre>
+
+Use @--force@ if you want to overwrite existing files:
+
+<pre>
+$ rails generate testing:configure rspec --force
+</pre>
+
+h3. RSpec Configuration
+
+The RailsAppsTesting generator will remove the legacy *test/* folder if it exists (it is not needed for RSpec).
+
+The RailsAppsTesting generator will run @rails generate rspec:install@ to create two files and a folder:
+
+* *.rspec*
+* *spec/*
+* *spec/spec_helper.rb*
+
+Then the RailsAppsTesting generator will configure RSpec.
+
+It will modify the file *.rspec* to add:
+
+<pre>
+--format documentation
+</pre>
+
+It will modify the file *config/application.rb* to suppress creation of stub files that many developers don't use:
+
+<pre>
+config.generators do |g|
+  g.test_framework :rspec,
+    fixtures: true,
+    view_specs: false,
+    helper_specs: false,
+    routing_specs: false,
+    controller_specs: false,
+    request_specs: false
+  g.fixture_replacement :factory_girl, dir: "spec/factories"
+end
+</pre>
+
+h3. Capybara and Launchy Configuration
+
+The generator will set up Capybara and Launchy to display CSS and JavaScript with a file *spec/support/capybara.rb*:
+
+<pre>
+Capybara.asset_host = 'http://localhost:3000'
+</pre>
+
+h3. Database Cleaner Configuration
+
+The generator will set up Database Cleaner to test JavaScript with a file *spec/support/database_cleaner.rb*:
+
+<pre>
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, :js => true) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.append_after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+</pre>
+
+It will also modify *spec/spec_helper.rb*:
+
+<pre>
+config.use_transactional_fixtures = false
+</pre>
+
+h3. FactoryGirl Configuration
+
+The generator will set up FactoryGirl shortcuts with a file *spec/support/factory_girl.rb*:
+
+<pre>
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end
+</pre>
+
+h3. Devise Configuration
+
+If Devise in installed in your application, the generator will add a file *spec/support/devise.rb*:
+
+<pre>
+RSpec.configure do |config|
+  config.include Devise::TestHelpers, :type => :controller
+end
+</pre>
+
+h2. Issues
+
+Any issues? Please create an "issue":http://github.com/RailsApps/rails_apps_testing/issues on GitHub. Reporting issues (and patching!) helps everyone.
+
+h2. Credits
+
+Daniel Kehoe maintains this gem as part of the "RailsApps project":http://railsapps.github.io/.
+
+Please see the "CHANGELOG":https://github.com/RailsApps/rails_apps_testing/blob/master/CHANGELOG.textile for a list of contributors.
+
+Is the gem useful to you? Follow the project on Twitter: "@rails_apps":http://twitter.com/rails_apps. I'd love to know you were helped out by the gem.
+
+h2. MIT License
+
+"MIT License":http://www.opensource.org/licenses/mit-license
+
+Copyright © 2014 Daniel Kehoe

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/generators/testing/configure/configure_generator.rb

@@ -0,0 +1,34 @@
+require 'rails/generators'
+
+module Testing
+  module Generators
+    class ConfigureGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      argument :framework_name, :type => :string, :default => "rspec"
+
+      desc "Sets up a testing framework."
+
+      attr_reader :app_name
+
+      def configure_framework
+        case framework_name
+          when 'rspec'
+            run 'rm -rf test/' # Removing test folder (not needed for RSpec)
+            generate 'rspec:install'
+            inject_into_file '.rspec', "--format documentation\n", :after => "--color\n"
+            tweaks = File.read(find_in_source_paths('application.rb'))
+            inject_into_file 'config/application.rb', tweaks + "\n", :after => "Rails::Application\n"
+            gsub_file 'spec/spec_helper.rb', /check_pending/, 'maintain_test_schema'
+            copy_file 'capybara.rb', 'spec/support/capybara.rb'
+            gsub_file 'spec/spec_helper.rb', /config.use_transactional_fixtures = true/, "config.use_transactional_fixtures = false"
+            copy_file 'database_cleaner.rb', 'spec/support/database_cleaner.rb'
+            copy_file 'factory_girl.rb', 'spec/support/factory_girl.rb'
+            if File.exists?('config/initializers/devise.rb')
+              copy_file 'devise.rb', 'spec/support/devise.rb'
+            end
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/testing/configure/templates/application.rb

@@ -0,0 +1,11 @@
+
+    config.generators do |g|
+      g.test_framework :rspec,
+        fixtures: true,
+        view_specs: false,
+        helper_specs: false,
+        routing_specs: false,
+        controller_specs: false,
+        request_specs: false
+      g.fixture_replacement :factory_girl, dir: "spec/factories"
+    end

data/lib/generators/testing/configure/templates/capybara.rb

@@ -0,0 +1 @@
+Capybara.asset_host = 'http://localhost:3000'

data/lib/generators/testing/configure/templates/database_cleaner.rb

@@ -0,0 +1,21 @@
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, :js => true) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.append_after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/lib/generators/testing/configure/templates/devise.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include Devise::TestHelpers, :type => :controller
+end

data/lib/generators/testing/configure/templates/factory_girl.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/lib/rails_apps_testing.rb

@@ -0,0 +1,5 @@
+require "rails_apps_testing/version"
+
+module RailsAppsTesting
+  # Your code goes here...
+end

data/lib/rails_apps_testing/version.rb

@@ -0,0 +1,3 @@
+module RailsAppsTesting
+  VERSION = "0.0.1"
+end

data/rails_apps_testing.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_apps_testing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_apps_testing"
+  spec.version       = RailsAppsTesting::VERSION
+  spec.authors       = ["Daniel Kehoe"]
+  spec.email         = ["daniel@danielkehoe.com"]
+  spec.summary       = %q{Sets up a testing framework for a Rails application.}
+  spec.description   = %q{Configures a suite of gems used for testing Rails applications.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: rails_apps_testing
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Kehoe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Configures a suite of gems used for testing Rails applications.
+email:
+- daniel@danielkehoe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.textile
+- Gemfile
+- LICENSE.txt
+- README.textile
+- Rakefile
+- lib/generators/testing/configure/configure_generator.rb
+- lib/generators/testing/configure/templates/application.rb
+- lib/generators/testing/configure/templates/capybara.rb
+- lib/generators/testing/configure/templates/database_cleaner.rb
+- lib/generators/testing/configure/templates/devise.rb
+- lib/generators/testing/configure/templates/factory_girl.rb
+- lib/rails_apps_testing.rb
+- lib/rails_apps_testing/version.rb
+- rails_apps_testing.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Sets up a testing framework for a Rails application.
+test_files: []