devise-specs 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6effecf1c766dc1b0a188e9f18bdb48f8767e553
-  data.tar.gz: feb9ba88290c49452a30ced186dee6d3b93a0ac0
+SHA256:
+  metadata.gz: be3f6fffcdfd6745c53813e98dff18e028631f927693c9632a81366d2d5ef8f0
+  data.tar.gz: 7134709344aab0354ac0d041d7222fc808674cfda488791ee9edf8f7c9b0adc2
 SHA512:
-  metadata.gz: c44eeab458aa434a7487a668aaa9e1ce86f475a57ef982a7e24a99a2705067b21c8adcfa014dba39a64eb6e54f9a381ec755b66a5042b3040ab5627b0d7ef928
-  data.tar.gz: e8785b973c23cdb527d3d3713a4eccae2c0b0ad0cc34d6454ed4309b99e3bd9668753898ff2f779edba225d49fe1dcd4c350da1f5c573e92ea6895a510d45fb6
+  metadata.gz: d2c8a1bf622e860236e2a6e7a61e22d6e0574833d83d8ed407c89d3038af38cf63861395444677ffadefd790fc2e6eec7cf2bb93722b24329cb5be74c3ca7c71
+  data.tar.gz: 928a9d44fe9db4918a0631cdde7eaed7ee98893ea471f0a6ad9a96c2440a89d089ab02a61102edc3276799e7c8d0a66111998320ea72f6b99d76a470dd1acefa

data/.github/workflows/build.yml

@@ -0,0 +1,26 @@
+name: build
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Bundle install
+      run:  bundle install
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+### 0.0.5
+
+* Support latest Factory Bot and RSpec Rails versions
+
+### 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/README.md

@@ -1,9 +1,6 @@
-# devise-specs
+# devise-specs [![Build Status][ci-image]][ci] [![Maintainability][grade-image]][grade]
 
-[![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.
+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
@@ -11,11 +8,9 @@ Generated feature specs test the following features:
 * Logout
 * Password reset
 
-Works with Rails 4 and 5.
-
 ## Installation
 
-Specify the required dependencies in a `Gemfile`:
+Make sure `devise`, `devise-specs`, `rspec-rails`, `capybara` and fixture replacement gems are added to the `Gemfile`:
 ```ruby
 gem 'devise'
 
@@ -29,7 +24,7 @@ end
 
 group :development, :test do
   gem 'rspec-rails'
-  gem 'factory_girl_rails' # or: gem 'fabrication'
+  gem 'factory_bot_rails' # or: gem 'fabrication'
 end
 ```
 
@@ -39,12 +34,12 @@ and then run `bundle install`.
 
 Generate the RSpec configuratoin files:
 ```
-$ rails generate rspec:install
+$ bin/rails generate rspec:install
 ```
 
-Generate the Devise configuration files and follow the setup instructions:
+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
+$ bin/rails generate devise:install
 ```
 
 Configure the Action Mailer URL options for the test environment using the following line in `config/environments/test.rb`:
@@ -62,33 +57,31 @@ Add the authentication links to the layout, `user_signed_in?` should be `admin_s
 <% 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`:
+Specs are created automatically when you generate a Devise model, e.g. `User`:
 ```
-$ rails generate devise User
+$ bin/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/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:
+```
+$ bin/rails generate devise:specs User
+```
+
 Run the migrations:
 ```
-$ rake db:migrate RAILS_ENV=test
+$ bin/rails db:migrate RAILS_ENV=test
 ```
 
 Make sure the specs pass:
@@ -104,6 +97,44 @@ Finished in 1.08 seconds (files took 2.1 seconds to load)
 
 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 system and development dependencies and run the tests:
+```
+$ bundle exec rake
+```
+
 ## License
 
 MIT License
+
+[ci-image]: https://github.com/ponosoft/devise-specs/actions/workflows/build.yml/badge.svg
+[ci]: https://github.com/ponosoft/devise-specs/actions/workflows/build.yml
+[grade-image]: https://api.codeclimate.com/v1/badges/b7e541f2f5171790638f/maintainability
+[grade]: https://codeclimate.com/github/ponosoft/devise-specs/maintainability

data/cucumber.yml

@@ -0,0 +1 @@
+default: --publish-quiet

data/devise-specs.gemspec

@@ -1,15 +1,17 @@
 Gem::Specification.new do |s|
   s.name     = 'devise-specs'
-  s.version  = '0.0.1'
+  s.version  = '0.0.5'
   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.homepage = 'https://github.com/ponosoft/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.required_ruby_version = '>= 2.5.0'
 
-  s.add_development_dependency 'rake', '~> 11.1'
-  s.add_development_dependency 'aruba', '~> 0.14.1'
+  s.add_runtime_dependency 'devise', '~> 4.8'
+
+  s.add_development_dependency 'aruba', '~> 1.1', '>= 1.1.2'
+  s.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
 end

data/lib/generators/{specs/devise_generator.rb → devise/specs_generator.rb}

@@ -1,34 +1,35 @@
-module Specs
+module Devise
   module Generators
-    class DeviseGenerator < Rails::Generators::NamedBase
+    class SpecsGenerator < Rails::Generators::NamedBase
       ATTRIBUTES = %(
-        email 'username@example.com'
-        password 'password')
+        email { 'username@example.com' }
+        password { 'password' }
+      ).freeze
 
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('../templates', __FILE__)
 
-      def require_supporting_files
-        uncomment_lines 'spec/rails_helper.rb', /spec.support.*rb.*require/
+      def require_support_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
+        if fixture_replacement == :factory_bot
+          insert_factory_bot_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'
+      def create_factory_bot_config_file
+        if fixture_replacement == :factory_bot
+          template 'factory_bot.rb', 'spec/support/factory_bot.rb'
         end
       end
 
-      def create_helpers_file
-        template 'helpers.rb', 'spec/support/helpers.rb'
+      def create_devise_config_file
+        template 'devise.rb', 'spec/support/devise.rb'
       end
 
       def create_specs
@@ -51,7 +52,7 @@ module Specs
         Rails.application.config.generators.rails[:fixture_replacement]
       end
 
-      def insert_factory_girl_attributes
+      def insert_factory_bot_attributes
         path  = "spec/factories/#{plural_name}.rb"
         attrs = ATTRIBUTES.gsub(/^ {4}/, '')
         after = "factory :#{singular_name} do"

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/{specs → devise}/templates/resource_resets_password_spec.rb.tt

@@ -1,8 +1,8 @@
 require 'rails_helper'
 
-feature '<%= human_name %> resets a password' do
+RSpec.feature '<%= human_name %> resets a password' do
   scenario '<%= singular_name %> enters a valid email' do
-<% if fixture_replacement == :factory_girl -%>
+<% if fixture_replacement == :factory_bot -%>
     <%= singular_name %> = create :<%= singular_name %>
 <% elsif fixture_replacement == :fabrication -%>
     <%= singular_name %> = Fabricate :<%= singular_name %>
@@ -14,6 +14,7 @@ feature '<%= human_name %> resets a password' do
     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
@@ -26,7 +27,7 @@ feature '<%= human_name %> resets a password' do
   end
 
   scenario '<%= singular_name %> changes password' do
-<% if fixture_replacement == :factory_girl -%>
+<% 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
@@ -39,6 +40,7 @@ feature '<%= human_name %> resets a password' do
     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

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

@@ -0,0 +1,38 @@
+require 'rails_helper'
+
+RSpec.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/{specs → devise}/templates/resource_signs_out_spec.rb.tt

@@ -1,8 +1,8 @@
 require 'rails_helper'
 
-feature '<%= human_name %> signs out' do
+RSpec.feature '<%= human_name %> signs out' do
   scenario '<%= singular_name %> signed in' do
-<% if fixture_replacement == :factory_girl -%>
+<% if fixture_replacement == :factory_bot -%>
     <%= singular_name %> = create :<%= singular_name %>
 <% elsif fixture_replacement == :fabrication -%>
     <%= singular_name %> = Fabricate :<%= singular_name %>
@@ -10,8 +10,12 @@ feature '<%= human_name %> signs out' do
 
     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/{specs → devise}/templates/resource_signs_up_spec.rb.tt

@@ -1,6 +1,6 @@
 require 'rails_helper'
 
-feature '<%= human_name %> signs up' do
+RSpec.feature '<%= human_name %> signs up' do
   scenario 'with valid data' do
     visit new_<%= singular_name %>_registration_path
 
@@ -10,6 +10,8 @@ feature '<%= human_name %> signs up' do
     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
@@ -19,5 +21,6 @@ feature '<%= human_name %> signs up' do
 
     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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise-specs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors:
 - Andrii Ponomarov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2021-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -16,65 +16,78 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.8'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
 description: 
 email: andrii.ponomarov@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
+- ".github/workflows/build.yml"
 - ".gitignore"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
+- cucumber.yml
 - 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
+- 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/ponosoft/devise-specs
 licenses:
 - MIT
 metadata: {}
@@ -86,15 +99,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Generates the Devise acceptance tests.

data/.codeclimate.yml

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

data/.travis.yml

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

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

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

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

@@ -1,13 +0,0 @@
-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_signs_in_spec.rb.tt

@@ -1,27 +0,0 @@
-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