devise_specs 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 81d919f6bedb5fd92fa4c892518b62f68fc888cce3a85c8f668870507bee10c9
+  data.tar.gz: dcf1599ab23ca4ba5774701c0561bde7465f0d5b9f9d52603c85bf404290cb4c
+SHA512:
+  metadata.gz: 3073813fd46d908597a3ccbe2346cc0b21183602263531993bcb07f7615024c95e7d50583e60bf915af1e3d7f60361c6f23d230f61ebc072c680ced4db444b10
+  data.tar.gz: 9aeba75a355fa2e5a66ae238e2f1b28eefbcfea6af453e30dbf090d030e88051c9e7c7f1a97d74fb9764ff4a0a6f0ab472234da0da167c03d49bb54a4d06d7cb

data/.codeclimate.yml

@@ -0,0 +1,18 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+    exclude_fingerprints:
+    - 3b39f38c33cdc3b6dc57a5d8160f707b
+  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/CHANGELOG.md

@@ -0,0 +1,14 @@
+### 0.0.4
+
+* Make internal tests pass on Rails 5.1 and clean up docs
+
+
+### 0.0.3
+
+* Use the new `Devise::Test::IntegrationHelpers` instead of the custom `sign_in` helper
+
+### 0.0.2
+
+* Add more thorough expectations to generated specs
+* Rename specs:devise generator to devise:specs
+* Update README with Output and Testing sections

data/Gemfile

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

data/README.md

@@ -0,0 +1,144 @@
+# 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 Bot or Fabrication fixture replacement methods and Capybara actions.
+
+Generated feature specs test the following features:
+* Registration
+* Login
+* Logout
+* Password reset
+
+Works with Rails 6+.
+
+## Installation
+
+Make sure `devise_specs`, `devise`, `rspec-rails`, `capybara` and fixture replacement gems are added to the `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_bot_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 to define the default url options, root route and flash messages:
+```
+$ 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 %>
+```
+
+## Usage
+
+Specs are created automatically when you 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_bot.rb
+      create    spec/support/devise.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
+```
+
+If a Devise model is already present, run the `devise:specs` generator directly:
+```
+$ rails generate devise:specs User
+```
+
+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.
+
+## Output
+
+`gsub    spec/rails_helper.rb`
+
+Uncomments the line that auto-requires all files in the support directory.
+
+`insert    spec/fabricators/*_fabricator.rb`
+
+Adds `email` and `password` attributes to the fabricator.
+
+`insert    spec/factories/*.rb`
+
+Adds `email` and `password` attributes to the factory.
+
+`create    spec/support/factory_bot.rb`
+
+Includes `FactoryBot::Syntax::Methods` into RSpec config to avoid prefacing Factory Bot methods with `FactoryBot`.
+
+`create    spec/support/devise.rb`
+
+Includes Devise integration test helpers into feature specs.
+
+`create    spec/features/*_spec.rb`
+
+Generates a corresponding feature spec.
+
+## Testing
+
+Install Ruby, development tools, Nokogiri, SQLite and JavaScript runtime system dependencies.
+
+On Ubuntu/Mint/Debian:
+```
+$ apt-get install ruby-full build-essential zlib1g-dev libsqlite3-dev nodejs
+```
+
+Install development dependencies with `bundle install` and run the tests: 
+```
+$ bundle exec rake
+```
+
+## 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,17 @@
+Gem::Specification.new do |s|
+  s.name     = 'devise_specs'
+  s.version  = '0.0.5'
+  s.authors  = ["Gaspard d'Hautefeuille"]
+  s.email    = 'ruby@dhautefeuille.eu'
+  s.summary  = 'Generates the Devise acceptance tests.'
+  s.homepage = 'https://github.com/HLFH/devise_specs'
+  s.license  = 'MIT'
+  s.files    = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|features|fixtures)/}) }
+  
+  s.required_ruby_version = '>= 2.6.5'
+
+  s.add_runtime_dependency 'devise', '~> 4.7', '>= 4.7.1'
+
+  s.add_development_dependency 'rake', '~> 13.0', '>= 13.0.1'
+  s.add_development_dependency 'aruba', '~> 1.0'
+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/devise/specs_generator.rb

@@ -0,0 +1,71 @@
+module Devise
+  module Generators
+    class SpecsGenerator < 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_bot
+          insert_factory_bot_attributes
+        elsif fixture_replacement == :fabrication
+          insert_fabrication_attributes
+        end
+      end
+
+      def create_factory_bot_config_file
+        if fixture_replacement == :factory_bot
+          template 'factory_bot.rb', 'spec/support/factory_bot.rb'
+        end
+      end
+
+      def create_devise_config_file
+        template 'devise.rb', 'spec/support/devise.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_bot_attributes
+        path  = "spec/factories/#{plural_name}.rb"
+        attrs = ATTRIBUTES.gsub(/^ {4}/, '')
+        data = "factory :#{singular_name} do"
+
+        create_file path, data + attrs
+      end
+
+      def insert_fabrication_attributes
+        path  = "spec/fabricators/#{singular_name}_fabricator.rb"
+        attrs = ATTRIBUTES.gsub(/^ {6}/, '')
+        after = "Fabricator(:#{singular_name}) do"
+
+        create_file path, data + attrs
+      end
+    end
+  end
+end

data/lib/generators/devise/templates/devise.rb.tt

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include Devise::Test::IntegrationHelpers, type: :feature
+end

data/lib/generators/devise/templates/factory_bot.rb.tt

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

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

@@ -0,0 +1,55 @@
+require 'rails_helper'
+
+feature '<%= human_name %> resets a password' do
+  scenario '<%= singular_name %> enters a valid email' do
+<% if fixture_replacement == :factory_bot -%>
+    <%= 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'
+    expect(page).to have_current_path new_<%= singular_name %>_session_path
+  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_bot -%>
+    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.'
+    expect(page).to have_current_path root_path
+  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/devise/templates/resource_signs_in_spec.rb.tt

@@ -0,0 +1,38 @@
+require 'rails_helper'
+
+feature '<%= human_name %> signs in' do
+  scenario 'with valid credentials' do
+<% if fixture_replacement == :factory_bot -%>
+    <%= singular_name %> = create :<%= singular_name %>
+<% elsif fixture_replacement == :fabrication -%>
+    <%= singular_name %> = Fabricate :<%= singular_name %>
+<% end -%>
+
+    visit new_<%= singular_name %>_session_path
+
+    fill_in 'Email', with: <%= singular_name %>.email
+    fill_in 'Password', with: <%= singular_name %>.password
+    click_button 'Log in'
+
+    expect(page).to have_text 'Signed in successfully.'
+    expect(page).to have_link 'Sign Out'
+    expect(page).to have_current_path root_path
+  end
+
+  scenario 'with invalid credentials' do
+<% if fixture_replacement == :factory_bot -%>
+    <%= singular_name %> = build :<%= singular_name %>
+<% elsif fixture_replacement == :fabrication -%>
+    <%= singular_name %> = Fabricate.build :<%= singular_name %>
+<% end -%>
+
+    visit new_<%= singular_name %>_session_path
+
+    fill_in 'Email', with: <%= singular_name %>.email
+    fill_in 'Password', with: <%= singular_name %>.password
+    click_button 'Log in'
+
+    expect(page).to have_text 'Invalid Email or password.'
+    expect(page).to have_no_link 'Sign Out'
+  end
+end

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

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

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

@@ -0,0 +1,26 @@
+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.'
+    expect(page).to have_link 'Sign Out'
+    expect(page).to have_current_path root_path
+  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"
+    expect(page).to have_no_link 'Sign Out'
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: devise_specs
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Gaspard d'Hautefeuille
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email: ruby@dhautefeuille.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- devise_specs.gemspec
+- lib/devise/specs/railtie.rb
+- lib/devise_specs.rb
+- lib/generators/devise/specs_generator.rb
+- lib/generators/devise/templates/devise.rb.tt
+- lib/generators/devise/templates/factory_bot.rb.tt
+- lib/generators/devise/templates/resource_resets_password_spec.rb.tt
+- lib/generators/devise/templates/resource_signs_in_spec.rb.tt
+- lib/generators/devise/templates/resource_signs_out_spec.rb.tt
+- lib/generators/devise/templates/resource_signs_up_spec.rb.tt
+homepage: https://github.com/HLFH/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: 2.6.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Generates the Devise acceptance tests.
+test_files: []