devise-specs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6effecf1c766dc1b0a188e9f18bdb48f8767e553
+  data.tar.gz: feb9ba88290c49452a30ced186dee6d3b93a0ac0
+SHA512:
+  metadata.gz: c44eeab458aa434a7487a668aaa9e1ce86f475a57ef982a7e24a99a2705067b21c8adcfa014dba39a64eb6e54f9a381ec755b66a5042b3040ab5627b0d7ef928
+  data.tar.gz: e8785b973c23cdb527d3d3713a4eccae2c0b0ad0cc34d6454ed4309b99e3bd9668753898ff2f779edba225d49fe1dcd4c350da1f5c573e92ea6895a510d45fb6

data/.codeclimate.yml

@@ -0,0 +1,18 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+    exclude_fingerprints:
+    - 9f7a179915ee4a7f1d639e9242aedd01
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- features/

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+tmp/

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,109 @@
+# devise-specs
+
+[![Build Status](https://travis-ci.org/andrii/devise-specs.svg?branch=master)](https://travis-ci.org/andrii/devise-specs)
+[![Code Climate](https://codeclimate.com/github/andrii/devise-specs/badges/gpa.svg)](https://codeclimate.com/github/andrii/devise-specs)
+
+devise-specs is a Rails generator that adds the Devise authentication acceptance tests when you run the `devise` generator. The tests are RSpec feature specs containing Factory Girl or Fabricatoin fixture replacement methods and Capybara actions.
+
+Generated feature specs test the following features:
+* Registration
+* Login
+* Logout
+* Password reset
+
+Works with Rails 4 and 5.
+
+## Installation
+
+Specify the required dependencies in a `Gemfile`:
+```ruby
+gem 'devise'
+
+group :development do
+  gem 'devise-specs'
+end
+
+group :test do
+  gem 'capybara'
+end
+
+group :development, :test do
+  gem 'rspec-rails'
+  gem 'factory_girl_rails' # or: gem 'fabrication'
+end
+```
+
+and then run `bundle install`.
+
+## Setup
+
+Generate the RSpec configuratoin files:
+```
+$ rails generate rspec:install
+```
+
+Generate the Devise configuration files and follow the setup instructions:
+```
+$ rails generate devise:install
+```
+
+Configure the Action Mailer URL options for the test environment using the following line in `config/environments/test.rb`:
+```ruby
+config.action_mailer.default_url_options = { host: 'localhost', port: 3001 }
+```
+
+Add the authentication links to the layout, `user_signed_in?` should be `admin_signed_in?` if your Devise model is `Admin`:
+```erb
+<% if user_signed_in? %>
+  <%= link_to 'Sign Out', destroy_user_session_path, method: :delete %>
+<% else %>
+  <%= link_to 'Sign In', new_user_session_path %>
+  <%= link_to 'Sign Up', new_user_registration_path %>
+<% end %>
+```
+
+Add the following lines to `config/application.rb` if you are using the Fabrication gem and gem version is less than 2.15.1:
+```ruby
+config.generators do |g|
+  g.fixture_replacement :fabrication
+end
+```
+
+## Usage
+
+Generate a Devise model, e.g. `User`:
+```
+$ rails generate devise User
+         ...
+      invoke  specs
+        gsub    spec/rails_helper.rb
+      insert    spec/factories/users.rb
+      create    spec/support/factory_girl.rb
+      create    spec/support/helpers.rb
+      create    spec/features/user_signs_up_spec.rb
+      create    spec/features/user_signs_in_spec.rb
+      create    spec/features/user_signs_out_spec.rb
+      create    spec/features/user_resets_password_spec.rb
+```
+
+Run the migrations:
+```
+$ rake db:migrate RAILS_ENV=test
+```
+
+Make sure the specs pass:
+```
+$ rspec spec/features
+.........
+
+Finished in 1.08 seconds (files took 2.1 seconds to load)
+9 examples, 0 failures
+```
+
+## Documentation
+
+Visit the [Relish docs](https://relishapp.com/andrii/devise-specs/docs) for all the available features and examples of the generated feature specs.
+
+## License
+
+MIT License

data/Rakefile

@@ -0,0 +1,5 @@
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new
+
+task default: :cucumber

data/devise-specs.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name     = 'devise-specs'
+  s.version  = '0.0.1'
+  s.authors  = ['Andrii Ponomarov']
+  s.email    = 'andrii.ponomarov@gmail.com'
+  s.summary  = 'Generates the Devise acceptance tests.'
+  s.homepage = 'https://github.com/andrii/devise-specs'
+  s.license  = 'MIT'
+  s.files    = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|features|fixtures)/}) }
+
+  s.add_runtime_dependency 'devise', '~> 4.1'
+
+  s.add_development_dependency 'rake', '~> 11.1'
+  s.add_development_dependency 'aruba', '~> 0.14.1'
+end

data/lib/devise/specs/railtie.rb

@@ -0,0 +1,11 @@
+module Devise
+  module Specs
+    class Railtie < Rails::Railtie
+      generators do
+        require 'generators/devise/devise_generator'
+
+        Devise::Generators::DeviseGenerator.hook_for :specs, type: :boolean, default: true
+      end
+    end
+  end
+end

data/lib/devise-specs.rb

@@ -0,0 +1 @@
+require 'devise/specs/railtie'

data/lib/generators/specs/devise_generator.rb

@@ -0,0 +1,71 @@
+module Specs
+  module Generators
+    class DeviseGenerator < Rails::Generators::NamedBase
+      ATTRIBUTES = %(
+        email 'username@example.com'
+        password 'password')
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def require_supporting_files
+        uncomment_lines 'spec/rails_helper.rb', /spec.support.*rb.*require/
+      end
+
+      def insert_fixture_replacement_attributes
+        return if behavior == :revoke
+
+        if fixture_replacement == :factory_girl
+          insert_factory_girl_attributes
+        elsif fixture_replacement == :fabrication
+          insert_fabrication_attributes
+        end
+      end
+
+      def create_factory_girl_config_file
+        if fixture_replacement == :factory_girl
+          template 'factory_girl.rb', 'spec/support/factory_girl.rb'
+        end
+      end
+
+      def create_helpers_file
+        template 'helpers.rb', 'spec/support/helpers.rb'
+      end
+
+      def create_specs
+        template 'resource_signs_up_spec.rb',
+                 "spec/features/#{singular_name}_signs_up_spec.rb"
+
+        template 'resource_signs_in_spec.rb',
+                 "spec/features/#{singular_name}_signs_in_spec.rb"
+
+        template 'resource_signs_out_spec.rb',
+                 "spec/features/#{singular_name}_signs_out_spec.rb"
+
+        template 'resource_resets_password_spec.rb',
+                 "spec/features/#{singular_name}_resets_password_spec.rb"
+      end
+
+      private
+
+      def fixture_replacement
+        Rails.application.config.generators.rails[:fixture_replacement]
+      end
+
+      def insert_factory_girl_attributes
+        path  = "spec/factories/#{plural_name}.rb"
+        attrs = ATTRIBUTES.gsub(/^ {4}/, '')
+        after = "factory :#{singular_name} do"
+
+        insert_into_file path, attrs, after: after
+      end
+
+      def insert_fabrication_attributes
+        path  = "spec/fabricators/#{singular_name}_fabricator.rb"
+        attrs = ATTRIBUTES.gsub(/^ {6}/, '')
+        after = "Fabricator(:#{singular_name}) do"
+
+        insert_into_file path, attrs, after: after
+      end
+    end
+  end
+end

data/lib/generators/specs/templates/factory_girl.rb.tt

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

data/lib/generators/specs/templates/helpers.rb.tt

@@ -0,0 +1,13 @@
+module Helpers
+  def sign_in(resource)
+    visit new_<%= singular_name %>_session_path
+
+    fill_in 'Email', with: resource.email
+    fill_in 'Password', with: resource.password
+    click_button 'Log in'
+  end
+end
+
+RSpec.configure do |config|
+  config.include Helpers, type: :feature
+end

data/lib/generators/specs/templates/resource_resets_password_spec.rb.tt

@@ -0,0 +1,53 @@
+require 'rails_helper'
+
+feature '<%= human_name %> resets a password' do
+  scenario '<%= singular_name %> enters a valid email' do
+<% if fixture_replacement == :factory_girl -%>
+    <%= singular_name %> = create :<%= singular_name %>
+<% elsif fixture_replacement == :fabrication -%>
+    <%= singular_name %> = Fabricate :<%= singular_name %>
+<% end -%>
+
+    visit new_<%= singular_name %>_password_path
+
+    fill_in 'Email', with: <%= singular_name %>.email
+    click_button 'Send me reset password instructions'
+
+    expect(page).to have_text 'You will receive an email with instructions'
+  end
+
+  scenario '<%= singular_name %> enters an invalid email' do
+    visit new_<%= singular_name %>_password_path
+
+    fill_in 'Email', with: 'username@example.com'
+    click_button 'Send me reset password instructions'
+
+    expect(page).to have_text 'Email not found'
+  end
+
+  scenario '<%= singular_name %> changes password' do
+<% if fixture_replacement == :factory_girl -%>
+    token = create(:<%= singular_name %>).send_reset_password_instructions
+<% elsif fixture_replacement == :fabrication -%>
+    token = Fabricate(:<%= singular_name %>).send_reset_password_instructions
+<% end -%>
+
+    visit edit_<%= singular_name %>_password_path(reset_password_token: token)
+
+    fill_in 'New password', with: 'p4ssw0rd'
+    fill_in 'Confirm new password', with: 'p4ssw0rd'
+    click_button 'Change my password'
+
+    expect(page).to have_text 'Your password has been changed successfully.'
+  end
+
+  scenario 'password reset token is invalid' do
+    visit edit_<%= singular_name %>_password_path(reset_password_token: 'token')
+
+    fill_in 'New password', with: 'p4ssw0rd'
+    fill_in 'Confirm new password', with: 'p4ssw0rd'
+    click_button 'Change my password'
+
+    expect(page).to have_text 'Reset password token is invalid'
+  end
+end

data/lib/generators/specs/templates/resource_signs_in_spec.rb.tt

@@ -0,0 +1,27 @@
+require 'rails_helper'
+
+feature '<%= human_name %> signs in' do
+  scenario 'with valid credentials' do
+<% if fixture_replacement == :factory_girl -%>
+    <%= singular_name %> = create :<%= singular_name %>
+<% elsif fixture_replacement == :fabrication -%>
+    <%= singular_name %> = Fabricate :<%= singular_name %>
+<% end -%>
+
+    sign_in <%= singular_name %>
+
+    expect(page).to have_text 'Signed in successfully.'
+  end
+
+  scenario 'with invalid credentials' do
+<% if fixture_replacement == :factory_girl -%>
+    <%= singular_name %> = build :<%= singular_name %>
+<% elsif fixture_replacement == :fabrication -%>
+    <%= singular_name %> = Fabricate.build :<%= singular_name %>
+<% end -%>
+
+    sign_in <%= singular_name %>
+
+    expect(page).to have_text 'Invalid Email or password.'
+  end
+end

data/lib/generators/specs/templates/resource_signs_out_spec.rb.tt

@@ -0,0 +1,17 @@
+require 'rails_helper'
+
+feature '<%= human_name %> signs out' do
+  scenario '<%= singular_name %> signed in' do
+<% if fixture_replacement == :factory_girl -%>
+    <%= singular_name %> = create :<%= singular_name %>
+<% elsif fixture_replacement == :fabrication -%>
+    <%= singular_name %> = Fabricate :<%= singular_name %>
+<% end -%>
+
+    sign_in <%= singular_name %>
+
+    click_link 'Sign Out'
+
+    expect(page).to have_text 'Signed out successfully.'
+  end
+end

data/lib/generators/specs/templates/resource_signs_up_spec.rb.tt

@@ -0,0 +1,23 @@
+require 'rails_helper'
+
+feature '<%= human_name %> signs up' do
+  scenario 'with valid data' do
+    visit new_<%= singular_name %>_registration_path
+
+    fill_in 'Email', with: 'username@example.com'
+    fill_in 'Password', with: 'password'
+    fill_in 'Password confirmation', with: 'password'
+    click_button 'Sign up'
+
+    expect(page).to have_text 'Welcome! You have signed up successfully.'
+  end
+
+  scenario 'with invalid data' do
+    visit new_<%= singular_name %>_registration_path
+
+    click_button 'Sign up'
+
+    expect(page).to have_text "Email can't be blank"
+    expect(page).to have_text "Password can't be blank"
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: devise-specs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrii Ponomarov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+description: 
+email: andrii.ponomarov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- devise-specs.gemspec
+- lib/devise-specs.rb
+- lib/devise/specs/railtie.rb
+- lib/generators/specs/devise_generator.rb
+- lib/generators/specs/templates/factory_girl.rb.tt
+- lib/generators/specs/templates/helpers.rb.tt
+- lib/generators/specs/templates/resource_resets_password_spec.rb.tt
+- lib/generators/specs/templates/resource_signs_in_spec.rb.tt
+- lib/generators/specs/templates/resource_signs_out_spec.rb.tt
+- lib/generators/specs/templates/resource_signs_up_spec.rb.tt
+homepage: https://github.com/andrii/devise-specs
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Generates the Devise acceptance tests.
+test_files: []