Merge pull request #233 from n-rodriguez/wip/cleanup

Modernize gem

Author: andi

.github/workflows/ci.yml

@@ -0,0 +1,84 @@
+---
+name: CI
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+  schedule:
+    - cron: '0 4 1 * *'
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0'
+
+      - name: Bundler
+        run: bundle install
+
+      - name: Rubocop
+        run: bin/rubocop
+
+  rspec:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '4.0'
+          - '3.4'
+          - '3.3'
+          - '3.2'
+          - '3.1'
+          - '3.0'
+        rails:
+          - rails_8.1
+          - rails_8.0
+          - rails_7.2
+          - rails_7.1
+          - rails_7.0
+          - rails_6.1
+
+        exclude:
+          - ruby: '3.0'
+            rails: 'rails_7.2'
+          - ruby: '3.0'
+            rails: 'rails_8.0'
+          - ruby: '3.0'
+            rails: 'rails_8.1'
+
+          - ruby: '3.1'
+            rails: 'rails_8.0'
+          - ruby: '3.1'
+            rails: 'rails_8.1'
+
+    env:
+      # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.rails }}.gemfile
+      # Check for frozen strings
+      RUBYOPT: "--enable=frozen-string-literal --debug=frozen-string-literal"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: RSpec
+        run: bin/rspec

.rspec

@@ -1,3 +1,2 @@
---color
---format=documentation
 --require spec_helper
+--warnings

.rubocop.yml

@@ -0,0 +1,49 @@
+---
+plugins:
+  - rubocop-capybara
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+inherit_from:
+  - .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: true
+  TargetRubyVersion: 3.0
+  Exclude:
+    - bin/*
+    - gemfiles/*
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/simple-navigation.rb
+
+###########
+# METRICS #
+###########
+
+Metrics/ClassLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/MethodLength:
+  Exclude:
+    - spec/**/*
+
+#########
+# RSPEC #
+#########
+
+RSpec/NestedGroups:
+  Max: 6
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 8

.rubocop_todo.yml

@@ -0,0 +1,39 @@
+---
+
+Layout/LineLength:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+#########
+# RSPEC #
+#########
+
+RSpec/SubjectStub:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/IndexedLet:
+  Enabled: false
+
+############
+# CAPYBARA #
+############
+
+Capybara/NegationMatcher:
+  Enabled: false

.travis.yml

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# To update files in gemfiles/ directory:
+# rm gemfiles/*
+# bin/appraisal generate
+
+# To run tests:
+# bin/appraisal rails_8.1 bundle install
+# bin/appraisal rails_8.1 rake
+# bin/appraisal rails_8.1 rspec
+
+appraise 'rails_6.1' do
+  gem 'railties', '~> 6.1.0'
+  gem 'rspec-rails'
+  gem 'concurrent-ruby', '1.3.4'
+
+  # Fix:
+  # warning: drb was loaded from the standard library, but is not part of the default gems starting from Ruby 3.4.0.
+  # You can add drb to your Gemfile or gemspec to silence this warning.
+  install_if '-> { Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.4.0") }' do
+    gem 'base64'
+    gem 'bigdecimal'
+    gem 'drb'
+    gem 'mutex_m'
+  end
+
+  install_if '-> { Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("4.0.0") }' do
+    gem 'benchmark'
+  end
+end
+
+appraise 'rails_7.0' do
+  gem 'railties', '~> 7.0.0'
+  gem 'rspec-rails'
+end
+
+appraise 'rails_7.1' do
+  gem 'railties', '~> 7.1.0'
+  gem 'rspec-rails'
+end
+
+appraise 'rails_7.2' do
+  gem 'railties', '~> 7.2.0'
+  gem 'rspec-rails'
+end
+
+appraise 'rails_8.0' do
+  gem 'railties', '~> 8.0.0'
+  gem 'rspec-rails'
+end
+
+appraise 'rails_8.1' do
+  gem 'railties', '~> 8.1.0'
+  gem 'rspec-rails'
+end

Appraisals

@@ -1,3 +1,24 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
+
+# Dev libs
+gem 'appraisal', git: 'https://github.com/thoughtbot/appraisal.git'
+gem 'capybara'
+gem 'memfs', git: 'https://github.com/simonc/memfs.git'
+gem 'rake'
+gem 'rdoc'
+gem 'rspec'
+gem 'simplecov'
+gem 'tzinfo'
+gem 'warning'
+
+# Dev tools / linter
+gem 'guard-rspec',         require: false
+gem 'rubocop',             require: false
+gem 'rubocop-capybara',    require: false
+gem 'rubocop-performance', require: false
+gem 'rubocop-rake',        require: false
+gem 'rubocop-rspec',       require: false

Gemfile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 guard :rspec, all_after_pass: true, failed_mode: :none do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{^spec/fake_app/.+\.rb$}) { 'spec/integration' }
 
-  watch('spec/spec_helper.rb')  { 'spec' }
+  watch('spec/spec_helper.rb') { 'spec' }
 end

Guardfile

@@ -31,30 +31,19 @@ Fork, fix, then send a Pull Request.
 
 To run the test suite locally against all supported frameworks:
 
-    % bundle install
-    % rake spec:all
+```sh
+bundle install
+bin/appraisal bundle install
+bin/appraisal rspec
+bin/appraisal rspec ./spec/requests/users_spec.rb
+```
 
 To target the test suite against one framework:
 
-    % rake spec:rails-4-2-stable
-
-You can find a list of supported spec tasks by running rake -T. You may also find it useful to run a specific test for a specific framework. To do so, you'll have to first make sure you have bundled everything for that configuration, then you can run the specific test:
-
-% BUNDLE_GEMFILE='gemfiles/rails-4-2-stable.gemfile' bundle install -j 4
-% BUNDLE_GEMFILE='gemfiles/rails-4-2-stable.gemfile' bundle exec rspec ./spec/requests/users_spec.rb
-
-### Rake and Bundler
-
-If you use a shell plugin (like oh-my-zsh:bundler) that auto-prefixes commands with `bundle exec` using the `rake` command will fail.
-
-Get the original command with `type -a rake`:
-
-    % type -a rake
-    rake is an alias for bundled_rake
-    rake is /Users/username/.rubies/ruby-2.2.3/bin/rake
-    rake is /usr/bin/rake
-
-In this situation `/Users/username/.rubies/ruby-2.2.3/bin/rake` is the command you should use.
+```sh
+bin/appraisal rails_8.1 rspec
+bin/appraisal rails_8.1 rspec ./spec/requests/users_spec.rb
+```
 
 ## License
 

README.md

@@ -1,37 +1,12 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+# frozen_string_literal: true
 
-require 'rspec/core'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-
 require 'rdoc/task'
 
 RSpec::Core::RakeTask.new(:spec)
-
 task default: 'spec'
 
-namespace :spec do
-  mappers = %w[
-    rails-3-2-stable
-    rails-4-1-stable
-    rails-4-2-stable
-    rails-5-2-stable
-    rails-6-0-stable
-    rails-6-1-stable
-  ]
-
-  mappers.each do |gemfile|
-    desc "Run Tests against #{gemfile}"
-    task gemfile do
-      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle -j 4 --quiet"
-      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake -t spec"
-    end
-  end
-
-  desc 'Run Tests against all ORMs'
-  task all: mappers
-end
-
 RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'SimpleNavigation'