rspec-feature_helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db4585ed2d947982695098708cb7a7918c49da46
+  data.tar.gz: 75bcf6a4eab7e15bc5da6d7d03b6367c17630b8e
+SHA512:
+  metadata.gz: fbe45bf9d2fed74c4af61d5d72aa4d9e06501d75cacc0b672ba336bab782d3296ab18836e276a559ff707bc42e9e07623d57a6ed1477f0a2b289aab10f001fc6
+  data.tar.gz: 0dff77e00eab1b51fff6474ad81c95210387c92cef3e2090ff4e3b6fe56bdd1319126b7f19d10c2245145c17362f2ba3fb20bb9f582abfa2050427e539ea32fa

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,96 @@
+# RSpec::FeatureHelpers
+
+This gem aims to allow developers to write focussed spec files by making heavy use of RSpec's memoization and tagging features. This project is intended to be used in the context of testing a Rails application, although it shouldn't strictly depend on it.
+
+A few things that you get:
+
+### Automatic login using Warden/Devise
+
+`Warden::Test::Helpers` get injected into the context of feature specs automatically. Tag your specs with `logged_in` and you get a user logged in automatically prior to specs:
+
+```ruby
+scenario 'test something', :logged_in do
+  # now your user should be logged in.
+end
+```
+
+The following code is executed as part of a `before` block:
+
+```ruby
+login_as user
+```
+
+In case of using Warden (Devise), the `login_as` method is automatically injected. If you use a different authentication solution, you can still define your own `login_as` method that would log the user in automatically. For example:
+
+```ruby
+module MyCustomAuthentication
+  def login_as(user)
+    # Do it here...
+  end
+end
+
+RSpec.configure do |config|
+  config.include MyCustomAuthentication, type: :feature
+end
+```
+
+By default, `user` corresponds to a `create(:user)` block which is what FactoryGirl users use. Again, you can customize what the `user` method lends. You can do this globally or on a per scenario, even a per context basis:
+
+```ruby
+feature "Administering our site" do
+  background do
+    visit admin_path
+  end
+
+  context 'as an admin', :logged_in do
+    # All scenarios in this given context will
+    # have an admin_user logged in prior to running.
+    let(:user) { create(:admin_user) }
+
+    scenario 'test something' do
+      # ...
+    end
+  end
+
+  context 'as a regular user', :logged_in do
+    # All scenarios in this given context will
+    # have a regular user logged in prior to running.
+
+    # This will use the fefault memoized user:
+    # let(:user) { create(:user) }
+
+    scenario 'test soething' do
+      # ...
+    end
+  end
+end
+```
+
+### Using Capybara with a JavaScript capable driver
+
+The gem also configures Capybara to run all feature tests using a JavaScript capable driver. This might not work for everyone, but I find that having JS errors surfaced as soon as possible is benefitial to testing only business-critical scenarios.
+
+The gem also cleans up Capybara sessions and reverts it to use the default driver after each feature spec is completed. This way you get a nice and clean state between each spec run.
+
+## Installation
+
+Add this line to your application's Gemfile, into the test group:
+
+```ruby
+group :test do
+  gem 'rspec-feature_helpers'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rspec-feature_helpers/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/feature_helpers"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec/feature_helpers.rb

@@ -0,0 +1,39 @@
+require "rspec/feature_helpers/version"
+
+module RSpec
+  module FeatureHelpers
+    extend ActiveSupport::Concern
+
+    included do
+      let(:user) { create(:user) }
+    end
+  end
+end
+
+RSpec.configure do |config|
+
+  config.include Warden::Test::Helpers, type: :feature if defined?(Warden)
+  config.include RSpec::FeatureHelpers, type: :feature
+
+  config.before :each, type: :feature, logged_in: true do
+    # Always log in a user prior to running scenarios with 'logged_in' metadata.
+    # You can customize the user instances on a per scenario context by using
+    # RSpec's memoization. For example:
+    # 
+    # let(:user) { create(:admin_user) }
+    login_as user
+  end
+
+  if defined?(Capybara)
+    config.before :each, type: :feature do
+      # Always use a JS capable driver when running feature tests
+      Capybara.current_driver = Capybara.javascript_driver
+    end
+
+    config.after :each, type: :feature do
+      # Cleanup after each feature!
+      Capybara.reset_sessions!
+      Capybara.use_default_driver
+    end
+  end
+end

data/lib/rspec/feature_helpers/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module FeatureHelpers
+    VERSION = "0.1.0"
+  end
+end

data/rspec-feature_helpers.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/feature_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-feature_helpers"
+  spec.version       = RSpec::FeatureHelpers::VERSION
+  spec.authors       = ["Attila Györffy"]
+  spec.email         = ["attila@attilagyorffy.com"]
+
+  spec.summary       = %q{Opinionated RSpec helpers to enhance your feature specs}
+  spec.description   = %q{A set of opinionated helpers to enhance testing features using RSpec.}
+  spec.homepage      = "http://github.com/liquid/rspec-feature_helpers"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rspec", ">= 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rspec-feature_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Attila Györffy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A set of opinionated helpers to enhance testing features using RSpec.
+email:
+- attila@attilagyorffy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/feature_helpers.rb
+- lib/rspec/feature_helpers/version.rb
+- rspec-feature_helpers.gemspec
+homepage: http://github.com/liquid/rspec-feature_helpers
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Opinionated RSpec helpers to enhance your feature specs
+test_files: []