canonical-rails 0.2.5 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dec5645d51ed0ad35587260417f914f20d4ec3b4a10a082e29aa6a824b5f4a6
-  data.tar.gz: 1d6bf6bd72105ab1790b1afb4383b27048f49aae8efaab50f5ef2fa4c07ef90e
+  metadata.gz: a81685e6294e15e30d48ca8ce1bc15fcba1da4d58ccf16abe967b973e923310f
+  data.tar.gz: a9a783ecf48e8bd9824be40f5ac229cb121681aa30ed2859d48e34f47adbb534
 SHA512:
-  metadata.gz: 33a696b21575481f8c2a1d8303200f9ab576605f02c7fa65ef43a02febce9937b0843a2c6b5fcb20ddc9a19f17e63784462aabd9805c12d883d489dd7eb52b38
-  data.tar.gz: 96884877d1a604b141d492477ab3bca7feb78c934961c6d03f10a4f31742aa271c9b9832893cb742edfd0ec5552d6fae8a5e3eecb243822646f89edde8b91740
+  metadata.gz: a91cb09a01bac779d159729212b21f12ff1349e2416a7defd810e53304f3be666cdb89bbaf1b95813b7ef29c01d080aa5a09647d751a8d08a617ea3e05c23bef
+  data.tar.gz: 0ea17f484eb95061b76f6845e56c81a240132512ddd719d11b2735bf80892f556525782acf09f2d8346c7886213f3176d7399833e437adf667e042abd6e29518

data/app/helpers/canonical_rails/tag_helper.rb

@@ -4,6 +4,15 @@ module CanonicalRails
       request.params.key?('action') && CanonicalRails.sym_collection_actions.include?(request.params['action'].to_sym)
     end
 
+    # Leave force_trailing_slash as nil to get the original behavior of trailing_slash_if_needed
+    def trailing_slash_config(force_trailing_slash = nil)
+      if force_trailing_slash
+        "/"
+      elsif force_trailing_slash.nil?
+        trailing_slash_if_needed
+      end
+    end
+
     def trailing_slash_if_needed
       "/" if trailing_slash_needed?
     end
@@ -26,18 +35,18 @@ module CanonicalRails
       (CanonicalRails.port || request.port).to_i
     end
 
-    def canonical_href(host = canonical_host, port = canonical_port)
+    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_if_needed}#{whitelisted_query_string}".downcase
+      raw "#{canonical_protocol}#{host}#{port}#{path_without_html_extension}#{trailing_slash_config(force_trailing_slash)}#{allowed_query_string}"
     end
 
-    def canonical_path
-      raw "#{path_without_html_extension}#{trailing_slash_if_needed}#{whitelisted_query_string}"
+    def canonical_path(force_trailing_slash = nil)
+      raw "#{path_without_html_extension}#{trailing_slash_config(force_trailing_slash)}#{allowed_query_string}"
     end
 
-    def canonical_tag(host = canonical_host, port = canonical_port)
-      canonical_url = canonical_href(host, port)
+    def canonical_tag(host = canonical_host, port = canonical_port, force_trailing_slash = nil)
+      canonical_url = canonical_href(host, port, force_trailing_slash)
       capture do
         if CanonicalRails.opengraph_url
           concat tag(:meta, property: 'og:url', content: canonical_url)
@@ -46,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}
@@ -64,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.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/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.5"
+  VERSION = "0.2.11"
 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.5
+  version: 0.2.11
 platform: ruby
 authors:
 - Denis Ivanov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-21 00:00:00.000000000 Z
+date: 2020-12-15 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
@@ -45,19 +45,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: sprockets
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +101,7 @@ 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
@@ -109,7 +110,7 @@ files:
 homepage: https://github.com/jumph4x/canonical-rails
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,9 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Simple and configurable Rails canonical ref tag helper
 test_files: []