canonical-rails 0.2.8 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccf0cfb2c475521e6fab106de4ef2e322a1cf4d87038495d5564563a15acd373
-  data.tar.gz: 0b11fbf7641ac94bbc1a74de4c15cc3d0e56ebc39720b027ad4a9d69f2c8e206
+  metadata.gz: dbd95b88c676963a8e3e32f71bee1abaef98ae9ba8c5e6bcd1cdaa674c92bee3
+  data.tar.gz: b098e19fb2ff260ae8deea915dea4362e080fdd57daec93283996004a9a64c27
 SHA512:
-  metadata.gz: 7b774522cf2cb5dced126ddc7d78cf918fef84f6e7144526b9be4d041fa845923a04ace457671d4ba22014eabe6f24a4fcae9f876070a14252353a6590b74743
-  data.tar.gz: 764aa02083b5346fa21aae3691b055286efd19a2a587853e5a58e8cc3dfe748594306e8bc6da8f3995ce8f8bbfa808d622550b4672f83e145689c00f56f59324
+  metadata.gz: d8e682df7cba371eb035e13bbf0a384da0131ec2ffb915723e740748ef18ed7ae5b81f33ebfaecdcdcf0a090f5f0e88f7b8cec063a3d8cdfdfa9040452e9a9de
+  data.tar.gz: 419d3438d3d35d5c80da8bdf29b1a0070dae5ca49e18aeb192e1f9c79586922f10af3750bab860fe021ad269dc36036a0fade14b2541dd6668dd182c162bb9fe

data/app/helpers/canonical_rails/tag_helper.rb

@@ -20,7 +20,7 @@ module CanonicalRails
     def path_without_html_extension
       return '' if request.path == '/'
 
-      request.path.sub(/\.html$/, '')
+      request.path.sub(/\.html?$/, '')
     end
 
     def canonical_protocol
@@ -38,11 +38,11 @@ module CanonicalRails
     def canonical_href(host = canonical_host, port = canonical_port, force_trailing_slash = nil)
       default_ports = { 'https://' => 443, 'http://' => 80 }
       port = port.present? && port.to_i != default_ports[canonical_protocol] ? ":#{port}" : ''
-      raw "#{canonical_protocol}#{host}#{port}#{path_without_html_extension}#{trailing_slash_config(force_trailing_slash)}#{whitelisted_query_string}"
+      raw "#{canonical_protocol}#{host}#{port}#{path_without_html_extension}#{trailing_slash_config(force_trailing_slash)}#{allowed_query_string}"
     end
 
     def canonical_path(force_trailing_slash = nil)
-      raw "#{path_without_html_extension}#{trailing_slash_config(force_trailing_slash)}#{whitelisted_query_string}"
+      raw "#{path_without_html_extension}#{trailing_slash_config(force_trailing_slash)}#{allowed_query_string}"
     end
 
     def canonical_tag(host = canonical_host, port = canonical_port, force_trailing_slash = nil)
@@ -55,15 +55,15 @@ module CanonicalRails
       end
     end
 
-    def whitelisted_params
+    def allowed_params
       selected_params = params.select do |key, value|
-        value.present? && CanonicalRails.sym_whitelisted_parameters.include?(key.to_sym)
+        value.present? && CanonicalRails.sym_allowed_parameters.include?(key.to_sym)
       end
 
       selected_params.respond_to?(:to_unsafe_h) ? selected_params.to_unsafe_h : selected_params.to_h
     end
 
-    def whitelisted_query_string
+    def allowed_query_string
       # Rack 1.4.5 fails to handle params that are not strings
       # So if
       #     my_hash = { "a" => 1, "b" => 2}
@@ -73,10 +73,8 @@ module CanonicalRails
       # https://github.com/rack/rack/blob/9939d40a5e23dcb058751d1029b794aa2f551900/test/spec_utils.rb#L222
       # Rack 1.6.0 has it
       # https://github.com/rack/rack/blob/65a7104b6b3e9ecd8f33c63a478ab9a33a103507/test/spec_utils.rb#L251
-
-      wl_params = whitelisted_params
-
-      "?" + Rack::Utils.build_nested_query(convert_numeric_params(wl_params)) if wl_params.present?
+      parameters = allowed_params
+      "?" + Rack::Utils.build_nested_query(convert_numeric_params(parameters)) if parameters.present?
     end
 
     private

data/lib/canonical-rails/deprecation.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'active_support/deprecation'
+
+module CanonicalRails
+  Deprecation = ActiveSupport::Deprecation.new('1.0', 'CanonicalRails')
+end

data/lib/canonical-rails/engine.rb

@@ -1,9 +1,11 @@
+require_relative '../../app/helpers/canonical_rails/tag_helper'
+
 module CanonicalRails
   class Engine < ::Rails::Engine
-    
+
     initializer 'canonical_rails.add_helpers' do |app|
       ActionView::Base.send :include, CanonicalRails::TagHelper
     end
-  
+
   end
 end

data/lib/canonical-rails/version.rb

@@ -1,3 +1,3 @@
 module CanonicalRails
-  VERSION = "0.2.8"
+  VERSION = "0.2.12"
 end

data/lib/canonical-rails.rb

@@ -1,4 +1,5 @@
 require "canonical-rails/engine"
+require "canonical-rails/deprecation"
 
 module CanonicalRails
 
@@ -23,9 +24,13 @@ module CanonicalRails
   mattr_accessor :collection_actions
   @@collection_actions = [:index]
 
+  # @deprecated: use config.allowed_parameters instead
   mattr_accessor :whitelisted_parameters
   @@whitelisted_parameters = []
 
+  mattr_accessor :allowed_parameters
+  @@allowed_parameters = []
+
   mattr_accessor :opengraph_url
   @@opengraph_url = false
 
@@ -33,7 +38,12 @@ module CanonicalRails
     @@sym_collection_actions ||= self.collection_actions.map(&:to_sym)
   end
 
-  def self.sym_whitelisted_parameters
-    @@sym_whitelisted_parameters ||= self.whitelisted_parameters.map(&:to_sym)
+  def self.sym_allowed_parameters
+    @@sym_allowed_parameters ||= if self.whitelisted_parameters.empty?
+      self.allowed_parameters.map(&:to_sym)
+    else
+      CanonicalRails::Deprecation.warn('config.whitelisted_parameters is deprecated, please use config.allowed_parameters instead.')
+      self.whitelisted_parameters.map(&:to_sym)
+    end
   end
 end

data/lib/generators/canonical_rails/install/templates/canonical_rails.rb

@@ -20,9 +20,9 @@ CanonicalRails.setup do |config|
   config.collection_actions# = [:index]
 
   # Parameter spamming can cause index dilution by creating seemingly different URLs with identical or near-identical content.
-  # Unless whitelisted, these parameters will be omitted
+  # Unless allowed, these parameters will be omitted
 
-  config.whitelisted_parameters# = []
+  config.allowed_parameters# = []
 
   # Output a matching OpenGraph URL meta tag (og:url) with the canonical URL, as recommended by Facebook et al
   config.opengraph_url#= true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canonical-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.12
 platform: ruby
 authors:
 - Denis Ivanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -101,13 +101,15 @@ files:
 - app/helpers/canonical_rails/tag_helper.rb
 - config/routes.rb
 - lib/canonical-rails.rb
+- lib/canonical-rails/deprecation.rb
 - lib/canonical-rails/engine.rb
 - lib/canonical-rails/version.rb
 - lib/generators/canonical_rails/install/install_generator.rb
 - lib/generators/canonical_rails/install/templates/canonical_rails.rb
 - lib/tasks/canonical-rails_tasks.rake
 homepage: https://github.com/jumph4x/canonical-rails
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -124,8 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Simple and configurable Rails canonical ref tag helper