jefferies_tube 1.7.9 → 1.7.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 871cc47167080e2ec82b5783a0f78bf2e3db9d66ffba35e3315bd66560225bf1
-  data.tar.gz: dd2bd0f2ca231feea95bd7bc75017a0442b21887f535b227c455e22609006827
+  metadata.gz: 85da8f5337be37125ab8ce2ba7ff5fdf960eff58478efdca35bab6bce17f3e51
+  data.tar.gz: c191c067e03789bf1da42aa0d9c765b67bf74d98ff1355d026d8083e768b9b67
 SHA512:
-  metadata.gz: 067bc30d790bb14ad3c91eb18710e1aa20ba75276426a9ea4e2d2babfba313caae6f1571fbd7753c6a01a5f5f59dce8793ffcdbff7304e58ac69bc4627d992f7
-  data.tar.gz: ccd1b5de8c012e557d30dbfef2891c33abc82de11f5e60a03999683b372b734748962cdfad4f3c5498f78010d8e5372bb68507cf202164c56a786dede7cc0d87
+  metadata.gz: 39227a9802d25099fecb25a2c26d2d34ebbaa9241686ac57df25ef96c607165e43e2facec4f1686fab631fe8196a9d12b971fe98e2c7519abdd1a580d10d5d9c
+  data.tar.gz: 276e73eba4df29de5cae4412aa044b00b7a581b0e7705de91de985752b21d8b7102e36a7406ff7e7d6f4d4be0e7c3a758bfee77a3db8dd724d0ec04f3908628e

data/CHANGELOG.md

@@ -6,6 +6,13 @@ This project attempts to follow [semantic versioning](https://semver.org/)
 
 ## Unreleased
 
+## 1.7.10
+  * Bugfix: fix `ArgumentError` raised by `ErrorsController` on every rendered error page under Rails 8. `_layout`'s arity changed across Rails versions, so build its arguments from the method's actual parameters instead of hardcoding a count (supports Rails 6.1–8+).
+  * Declare a minimum `rails` dependency of `>= 6.1.7.9`.
+  * Remove dead code: the Rails 3 `before_filter` branch, the unused `html_layout` and `additional_information` methods, and a pre-Rails-6 `prompt_name` fallback.
+  * Remove 404 with referrer rollbar warning
+  * Fix JSON format 404
+
 ## 1.7.9
   * Configure NewRelic to ignore invalid request errors caught by InvaildRequestHandler middleware
 

data/app/controllers/jefferies_tube/errors_controller.rb

@@ -1,22 +1,11 @@
 class JefferiesTube::ErrorsController < ApplicationController
-  if Rails.version.start_with? "3"
-    before_filter :disable_pundit
-    skip_before_filter :verify_authenticity_token
-  else
-    before_action :disable_pundit
-    skip_before_action :verify_authenticity_token
-  end
+  before_action :disable_pundit
+  skip_before_action :verify_authenticity_token
 
   def render_404
-    log_404
     render_error_page 404
   end
 
-  def additional_information
-    # TODO not implemented yet
-    render text: "Thanks!", layout: has_app_layout?
-  end
-
   private
   def render_error_page(code)
     request.format = :html unless [:html, :json, :xml].include? request.format.to_sym
@@ -32,12 +21,6 @@ class JefferiesTube::ErrorsController < ApplicationController
     end
   end
 
-  def log_404
-    if defined?(Rollbar) && request.referrer.present?
-      Rollbar.warn("Got 404 with referrer", referrer: request.referrer, current_path: request.path)
-    end
-  end
-
   def disable_pundit
     if defined?(Pundit)
       skip_authorization
@@ -45,20 +28,15 @@ class JefferiesTube::ErrorsController < ApplicationController
   end
 
   def has_app_layout?
-    if Gem::Version.new(Rails.version) >= Gem::Version.new("5")
-      !!self.send(:_layout, [request.format.to_sym])
-    else
-      # boolean based on if there is a default layout for the current mime type
-      !!self.send(:_layout)
-    end
+    !!resolve_layout([request.format.to_sym])
   end
 
-  def html_layout
-    if Gem::Version.new(Rails.version) >= Gem::Version.new("5")
-      self.send(:_layout, ["html"]).virtual_path
-    else
-      # boolean based on if there is a default layout for the current mime type
-      "application"
-    end
+  def resolve_layout(formats)
+    args = JefferiesTube::LayoutArgs.for(
+      self.method(:_layout).parameters,
+      lookup_context: lookup_context,
+      formats: formats
+    )
+    self.send(:_layout, *args)
   end
 end

data/app/views/errors/404.json

@@ -0,0 +1,4 @@
+{
+  "error": "Page not Found",
+  "status": 404
+}

data/jefferies_tube.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", '~> 13.0.6'
   spec.add_development_dependency "rspec", '~> 3.0'
 
+  spec.add_dependency 'rails', '>= 6.1.7.9'
   spec.add_dependency "bundler-audit", "~> 0.9"
   spec.add_dependency "pry", '~> 0.13'
   spec.add_dependency 'rubocop', '~> 1.26'

data/lib/jefferies_tube/layout_args.rb

@@ -0,0 +1,26 @@
+module JefferiesTube
+  # Builds the positional argument list for ActionView's private `_layout`
+  # method, whose signature has changed across Rails versions:
+  #
+  #   * 6.1–7.x:  _layout(formats, keys)
+  #   * 8.0+:     _layout(lookup_context, formats, keys)
+  #
+  # Rather than hardcode a count (which breaks on every version we did not
+  # anticipate), map the method's actual parameter names to the values we
+  # have. Unknown parameter names fall back to `formats` so a future
+  # signature change still receives the formats it expects.
+  module LayoutArgs
+    KNOWN = %i[lookup_context formats keys].freeze
+
+    # @param parameters [Array] the result of `method(:_layout).parameters`
+    # @param lookup_context the controller's lookup_context
+    # @param formats [Array] e.g. [:html]
+    # @return [Array] positional args to splat into `_layout`
+    def self.for(parameters, lookup_context:, formats:)
+      available = { lookup_context: lookup_context, formats: formats, keys: [] }
+      parameters.map do |_type, name|
+        available.fetch(name, formats)
+      end
+    end
+  end
+end

data/lib/jefferies_tube/version.rb

@@ -1,7 +1,7 @@
 require 'open-uri'
 
 module JefferiesTube
-  VERSION = "1.7.9"
+  VERSION = "1.7.10"
 
   def self.latest_rubygems_version
     JSON.parse(URI.parse("https://rubygems.org/api/v1/versions/jefferies_tube/latest.json").read)["version"]

data/lib/jefferies_tube.rb

@@ -1,4 +1,5 @@
 require 'jefferies_tube/version'
+require 'jefferies_tube/layout_args'
 require 'jefferies_tube/engine' if defined?(Rails)
 
 module JefferiesTube
@@ -21,12 +22,7 @@ module JefferiesTube
     def initialize
       if defined?(Rails)
         @environment = ::Rails.env.downcase || nil
-        @prompt_name =
-          if ::Rails::VERSION::MAJOR >= 6
-            ::Rails.application.class.module_parent_name || nil
-          else
-            ::Rails.application.class.parent_name || nil
-          end
+        @prompt_name = ::Rails.application.class.module_parent_name || nil
       else
         @environment = "development"
         @prompt_name = "JefferiesTube"

data/spec/layout_args_spec.rb

@@ -0,0 +1,43 @@
+require_relative '../lib/jefferies_tube/layout_args'
+
+RSpec.describe JefferiesTube::LayoutArgs do
+  let(:lookup_context) { Object.new }
+  let(:formats) { [:html] }
+
+  def build(parameters)
+    described_class.for(parameters, lookup_context: lookup_context, formats: formats)
+  end
+
+  context "Rails 8+ signature: _layout(lookup_context, formats, keys)" do
+    let(:parameters) { [[:req, :lookup_context], [:req, :formats], [:req, :keys]] }
+
+    it "returns three args in declared order" do
+      expect(build(parameters)).to eq([lookup_context, formats, []])
+    end
+  end
+
+  context "Rails 5.1–7 signature: _layout(formats, keys)" do
+    let(:parameters) { [[:req, :formats], [:req, :keys]] }
+
+    it "returns formats and keys, without lookup_context" do
+      expect(build(parameters)).to eq([formats, []])
+    end
+  end
+
+  context "unknown parameter name" do
+    let(:parameters) { [[:req, :something_new]] }
+
+    it "falls back to formats so the call still receives a sensible value" do
+      expect(build(parameters)).to eq([formats])
+    end
+  end
+
+  it "matches the number of arguments to the method's arity" do
+    [
+      [[:req, :lookup_context], [:req, :formats], [:req, :keys]],
+      [[:req, :formats], [:req, :keys]]
+    ].each do |params|
+      expect(build(params).size).to eq(params.size)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jefferies_tube
 version: !ruby/object:Gem::Version
-  version: 1.7.9
+  version: 1.7.10
 platform: ruby
 authors:
 - Brian Samson
@@ -79,6 +79,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.7.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.7.9
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +185,7 @@ files:
 - app/helpers/jefferies_tube/application_helper.rb
 - app/views/errors/404.html.erb
 - app/views/errors/404.html.haml
-- app/views/errors/404.json.jbuilder
+- app/views/errors/404.json
 - app/views/errors/404.xml
 - app/views/errors/500.haml
 - app/views/errors/500.html.erb
@@ -199,6 +213,7 @@ files:
 - lib/jefferies_tube/database_backup_adapter.rb
 - lib/jefferies_tube/engine.rb
 - lib/jefferies_tube/invalid_request_handler.rb
+- lib/jefferies_tube/layout_args.rb
 - lib/jefferies_tube/postgresql_backup_adapter.rb
 - lib/jefferies_tube/rack/maintenance.rb
 - lib/jefferies_tube/railtie.rb
@@ -207,6 +222,7 @@ files:
 - lib/tasks/db.rake
 - spec/configuration_spec.rb
 - spec/database_backup_spec.rb
+- spec/layout_args_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/tenforwardconsulting/jefferies_tube/
 licenses:
@@ -226,10 +242,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.8
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Ten Forward Consulting useful tools.
 test_files:
 - spec/configuration_spec.rb
 - spec/database_backup_spec.rb
+- spec/layout_args_spec.rb
 - spec/spec_helper.rb

data/app/views/errors/404.json.jbuilder

@@ -1,2 +0,0 @@
-json.error "Page not Found"
-json.status 404