format_restricter_rails 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ca2285843d46c5a220e41cba9c3e2f6525673419fd56725bf73f0a47903b00d
-  data.tar.gz: bcc6effe401644288a276f094848f4f6b3d42344bc40331b56a2370759d67d22
+  metadata.gz: 6ca7a5e7621022398ed3af0f98bb6375174575f0b888dc3e75ddd0118dc1eb08
+  data.tar.gz: dac6c986e76898705343be2f1cdf9e7a49aaf227a768bba4e7a990c4df8c93bf
 SHA512:
-  metadata.gz: f92844641950808df8a4610fc8d33107d8fff41cff294cc4f25dd6818d90dca958994a511964aeb4d1124f6a569acca3087a10fdfeb33ab01aca1f5fc8c2cfae
-  data.tar.gz: b761130830261eee4035ceb719c6e6ab290681733d622f306726ea6d1567ab97392a21eede080873b5a14f559fb1d1b35975b82e279a8ec6702cfa710869a043
+  metadata.gz: cba1e18bd0e076c41ac097492ce25984d928d5de01f0acb9a793e6b153cb90249cca623e0dae0f039186ac5b29a608e1389749d3c221c2269b47888ea460e802
+  data.tar.gz: 129c753977245c149537b3df2b9e0b01bf557da22efecbfc3f9476d8dabb7c41b94f9a3f9cca1b6efc656fcf4a9240405b2309debf0e4b2df56383d787dd06ed

data/.github/pull_request_template.md

@@ -0,0 +1,3 @@
+<!-- Replace XYZ with the related GitHub issue number -->
+
+Closes #XYZ

data/.github/workflows/check_pull_request.yml

@@ -0,0 +1,54 @@
+# This workflow will download prebuilt Ruby versions, install dependencies and run checks against Pull Requests.
+
+name: Check Pull Request
+on:
+  pull_request:
+    branches: [ master ]
+env:
+  # The pull request can have less than, or equal to, this number of rubocop issues and pass.
+  RUBOCOP_ISSUE_THRESHOLD: 5
+jobs:
+  rspec:
+    name: Run RSpec
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.2', '3.3']
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Execute rspec command
+        run: bin/start_rspec
+  rubocop:
+    name: Run Rubocop
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.1']
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Execute rubo command
+        run: bundle exec rubo
+      - name: Evaluate rubo threshold
+        run: |
+          count=$(cat rubocop/total-violations-count.txt)
+          if [[ "$count" -gt $RUBOCOP_ISSUE_THRESHOLD ]]; then
+              echo "Failure: Found $count RuboCop issue(s). It must have $RUBOCOP_ISSUE_THRESHOLD or less. \
+          Run 'rubo' and resolve the issues listed in rubocop/style-issues.html"
+              exit 1
+          else
+              echo "Success: Found $count RuboCop issue(s), which is less than the limit of $RUBOCOP_ISSUE_THRESHOLD"
+          fi

data/.rubocop.yml

@@ -1,6 +1,6 @@
 # DO NOT MODIFY THIS FILE unless you want to deviate from the rubocop_plus ruleset.
 
-# This file defines the settings used by rubocop when it runs.  You would normally add your customizations directly to this
+# This file defines the settings used by rubocop when it runs. You would normally add your customizations directly to this
 # file, but this file has been pre configured to read settings out of the rubocop_plus gem instead.
 
 # Tell rubocop to load its settings from the rubocop_plus gem.
@@ -10,5 +10,5 @@ inherit_gem:
 Rails:
   Enabled: true
 
-# Place custom settings below this comment.  All customizations will OVERRIDE rubocop_plus rules.  rubocop_plus & rubocop
-# do not attempt to merge these settings with their defaults.  Long term changes should be ported to the rubocop_plus gem.
+# Place custom settings below this comment. All customizations will OVERRIDE rubocop_plus rules. rubocop_plus & rubocop
+# do not attempt to merge these settings with their defaults. Long term changes should be ported to the rubocop_plus gem.

data/CHANGELOG.md

@@ -1,26 +1,43 @@
-# CHANGELOG
-
-## 1.3.0 (Feb 18, 2018)
-
-1. Use the rspec_starter gem for running rspec.  (Issue #20)
-1. Execute `head :not_acceptable` when an unsupported format is requested. (Issue #22)
-1. Handle requests that don't specify a format.  (Issue #24)
-
-## 1.2.0 (Jan 18, 2018)
-
-1. Use the `to_prepare` hook to simplify the implementation. (Issue #14)
-1. Add the rubocop_plus gem and cleanup internal code.  (Issue #16)
-
-## 1.1.0 (Jan 08, 2018)
-
-1. Add automated tests.  (Issue #4)
-1. Configure travis CI to use cached versions of gems.  (Issue #8)
-1. Correct rubocop issues.  (Issue #11)
-
-## 1.0.1 (May 11, 2016)
-
-1. Fix formats not being blocked when when `only:` or `except:` are not specified (Issue #1)
-
-## 1.0.0 (May 11, 2016)
-
-1. Initial Release
+# CHANGELOG
+
+Issues are tracked at https://github.com/roberts1000/format_restricter_rails/issues. Issues marked as **(Internal)** only affect development.
+
+## 1.4.0 (Jun 03, 2024)
+
+1. [#30](../../issues/30): Add links to issues in the `CHANGELOG.md`. **(Internal)**
+1. [#32](../../issues/32): Update development gems. **(Internal)**
+1. [#36](../../issues/36): Fix RuboCop issues. **(Internal)**
+1. [#38](../../issues/38): Use `puma` `~> 5.4'`. **(Internal)**
+1. [#47](../../issues/47): Add GitHub action workflow to check Pull Requests. **(Internal)**
+1. [#50](../../issues/50): Set `required_ruby_version` to `>= 3.1.0`.
+1. [#54](../../issues/54): Make Rails 6.1 the min supported version.
+1. [#59](../../issues/59): Use `rspec_starter` `~> 2.0`. **(Internal)**
+1. [#65](../../issues/65): Add Ruby 3.1 support.
+1. [#68](../../issues/68): Add Ruby 3.2 support.
+1. [#70](../../issues/70): Add Ruby 3.3 support.
+1. [#74](../../issues/74): Add pull request template. **(Internal)**
+
+## 1.3.0 (Feb 18, 2018)
+
+1. [#20](../../issues/20): Use the rspec_starter gem for running rspec.
+1. [#22](../../issues/22): Execute `head :not_acceptable` when an unsupported format is requested.
+1. [#24](../../issues/24): Handle requests that don't specify a format.
+
+## 1.2.0 (Jan 18, 2018)
+
+1. [#14](../../issues/14): Use `to_prepare` to simplify the implementation.
+1. [#16](../../issues/16): Add `rubocop_plus` and cleanup code. **(Internal)**
+
+## 1.1.0 (Jan 08, 2018)
+
+1. [#4](../../issues/4): Add automated tests. **(Internal)**
+1. [#8](../../issues/8): Configure travis CI to use cached versions of gems. **(Internal)**
+1. [#11](../../issues/11): Correct rubocop issues. **(Internal)**
+
+## 1.0.1 (May 11, 2016)
+
+1. [#1](../../issues/1): Fix formats not being blocked when when `only:` or `except:` are not specified.
+
+## 1.0.0 (May 11, 2016)
+
+1. Initial Release

data/Gemfile

@@ -4,12 +4,21 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'rspec_starter', "~> 1.1", require: false
-  gem 'rubocop_plus', "~> 1.0", require: false
+  gem 'rspec_starter', "~> 2.0", require: false
+  gem 'rubocop_plus', "~> 2.0", require: false
 end
 
 group :development, :test do
   gem 'bootsnap', require: false
-  gem 'puma', '~> 3.7'
-  gem "sqlite3", "~> 1.3.11"
+  gem 'bundler', '~> 2.0'
+  gem 'pry', '~> 0.14.2'
+  gem 'puma', '~> 6.4.1'
+  gem 'rake', '~> 13.0'
+  gem 'sass-rails', '~> 5.0'
+  gem "sqlite3", '~> 1.7.0'
+end
+
+group :test do
+  gem 'rspec-rails', '~> 6.1.0'
+  gem 'rails', '~> 6.1.0'
 end

data/LICENSE.md

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2016 Roberts
+Copyright (c) 2021 roberts1000
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,22 +1,29 @@
 # format_restricter_rails
 
-This gem provides a simple way to block your Rails controller actions from processing unsupported formats.  Without this, you'll eventually start seeing the following errors on your production site:
+`format_restricter_rails` provides a simple way to block Ruby on Rails controller actions from processing unsupported formats. If you've seen the following type of errors on your production site, `format_restricter_rails` can help:
 
-````
+```ruby
 ActionView::MissingTemplate (Missing template tasks/index, application/index with {:locale=>[:en], :formats=>[:json], :variants=>[], :handlers=>[:erb, :builder, :raw, :ruby, :coffee, :jbuilder]}
-````
+```
 
-Why are you getting these errors?  Because you designed your snazzy controller action to only process html requests and someone decided to send it a .json request.  Rails happily obliged, processed the action and failed when it couldn't find a corresponding json template to render.
+Why do these errors occur? If it's not a bug in the app code, it's usually because a person, or a bot, is sending requests to your app in a format you didn't anticipate. 
 
-When this happens, you may start defining `respond_to` calls in your actions.  Once you realize that's going to explode your code base, you'll probably try to call `respond_to :html` at the top of your controller class in hopes that it will help.  Sadly, it won't; and that's where this gem comes in.  It provides a single controller class method called `restrict_formats_to` that does exactly what you want.  When unallowed formats are requested, the controller will halt execution and return **HTTP Error 406 Not acceptable**.
+When this happens, you could start defining `respond_to` calls in your actions to handle the new formats. Once you realize that's going to explode your code base, you might try to call `respond_to :html`, at the top of your controller class, in hopes that it will help. Sadly, it won't. That's where format_restricter_rails comes in. It provides a single controller class method called `restrict_formats_to` that does exactly what you want. When unallowed formats are requested, the controller halts execution and returns **HTTP Error 406 Not acceptable**.
 
 ## Versioning Scheme
 
-This gem uses [semver](http:/semver.org).
+Releases are versioned using [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html) with the following caveats:
+
+1. Support for a Ruby version, that reaches EOL, is removed in a major or minor release.
+1. Support for a Ruby on Rails version, that reaches EOL, is removed in a major or minor release.
 
-## Supported Rails Versions
+## Supported Ruby Versions
 
-Rails 4+.
+Ruby 3.1+
+
+## Supported Ruby on Rails Versions
+
+Rails 6.1+
 
 ## Installation
 
@@ -85,9 +92,4 @@ end
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/corlewsolutions/format_restricter_rails.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+Bug reports and pull requests are welcome on the format_restricter_rails [issues](https://github.com/roberts1000/format_restricter_rails/issues) page.

data/Rakefile

@@ -4,7 +4,7 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
 load 'rails/tasks/engine.rake'
 load 'rails/tasks/statistics.rake'
 Bundler::GemHelper.install_tasks
@@ -15,7 +15,8 @@ RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
 
-task :console do
+desc "Start a console with pry."
+task console: :environment do
   exec "pry -r format_restricter_rails -I ./lib"
   # exec "irb -r format_restricter_rails -I ./lib"
 end

data/bin/rails

@@ -2,12 +2,12 @@
 # This command will automatically be run when you run "rails" with Rails gems
 # installed from the root of your application.
 
-ENGINE_ROOT = File.expand_path('../..', __FILE__)
-ENGINE_PATH = File.expand_path('../../lib/format_restricter_rails/engine', __FILE__)
-APP_PATH = File.expand_path('../../spec/dummy/config/application', __FILE__)
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/format_restricter_rails/engine', __dir__)
+APP_PATH = File.expand_path('../spec/dummy/config/application', __dir__)
 
 # Set up gems listed in the Gemfile.
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
 
 require 'rails/all'

data/bin/start_rspec

@@ -12,11 +12,27 @@ require "bundler/setup"
 require "rspec_starter"
 
 # The path to the application's root folder.
-APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+APP_ROOT = Pathname.new File.expand_path('..', __dir__)
 
-# Run commands in the context of the application's root folder.
-Dir.chdir APP_ROOT do
-  # Arguments passed to 'start' define the steps needed to cleanly run RSpec.
-  # Command line options may change execution on a per-run basis.
-  RspecStarter.start(prepare_db: true, remove_tmp: true, allow_xvfb: true)
+# Create a custom task. For more information about custom tasks, see
+# https://github.com/roberts1000/rspec_starter. Once defined, add
+# 'task :my_custom_task' to the start block to execute.
+#
+# class MyCustomTask < RspecStarterTask
+#   # Specify a message to show users when the task executes.
+#   def starting_message
+#     "Executing My Custom Task"
+#   end
+#
+#   # Execute task code.
+#   def execute
+#   end
+# end
+
+# Tasks are run from the top down.
+RspecStarter.start do
+  task :verify_display_server
+  task :remove_tmp_folder, remove_dummy_tmp: true
+  task :rebuild_rails_app_database
+  task :start_rspec
 end

data/format_restricter_rails.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'format_restricter_rails/version'
 
@@ -10,19 +10,14 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "A Rails Engine that prevents Rails controllers from processing undesired formats."
   spec.description   = "A Rails Engine that restricts the formats that your Rails controller actions are allowed to process."
-  spec.homepage      = "https://github.com/corlewsolutions/format_restricter_rails"
+  spec.homepage      = "https://github.com/roberts1000/format_restricter_rails"
   spec.license       = "MIT"
 
   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.required_ruby_version = '>= 3.1.0'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "pry", "~> 0.11.3"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec-rails", "~> 3.7.2"
-  spec.add_development_dependency "sass-rails", "~> 5.0"
-
-  spec.add_dependency "rails", ">= 4"
+  spec.add_dependency "rails", ">= 6.1"
 end

data/lib/format_restricter_rails/version.rb

@@ -1,3 +1,3 @@
 module FormatRestricterRails
-  VERSION = "1.3.0".freeze
+  VERSION = "1.4.0".freeze
 end

data/lib/format_restricter_rails.rb

@@ -7,9 +7,9 @@ require "format_restricter_rails/railtie"
 # Setup pry for development when running "rake console". Guard against load
 # errors in production (since pry is only loaded as a DEVELOPMENT dependency
 # in the .gemspec)
-# rubocop:disable Lint/HandleExceptions
+# rubocop:disable Lint/SuppressedException
 begin
   require "pry"
 rescue LoadError
 end
-# rubocop:enable Lint/HandleExceptions
+# rubocop:enable Lint/SuppressedException

metadata

@@ -1,99 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: format_restricter_rails
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - roberts1000
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-19 00:00:00.000000000 Z
+date: 2024-06-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.11.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.11.3
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.7.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.7.2
-- !ruby/object:Gem::Dependency
-  name: sass-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '6.1'
 description: A Rails Engine that restricts the formats that your Rails controller
   actions are allowed to process.
 email:
@@ -102,10 +32,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/pull_request_template.md"
+- ".github/workflows/check_pull_request.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.md
@@ -122,7 +53,7 @@ files:
 - lib/format_restricter_rails/includes.rb
 - lib/format_restricter_rails/railtie.rb
 - lib/format_restricter_rails/version.rb
-homepage: https://github.com/corlewsolutions/format_restricter_rails
+homepage: https://github.com/roberts1000/format_restricter_rails
 licenses:
 - MIT
 metadata: {}
@@ -134,15 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: A Rails Engine that prevents Rails controllers from processing undesired

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.4.3
-before_install: gem install bundler -v 1.16.1