canonical-rails 0.2.1 → 0.2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 493140cf6a89545c33141ea88e762de816853cdc
-  data.tar.gz: 15ea886c64d6a83d6bf4149c88ce324fa95e1c8b
+SHA256:
+  metadata.gz: cf9e6c0398f9b204f9cdcdf73d2ea3607fddc75fad061f8a6057b5c83c5b3fb8
+  data.tar.gz: 07d0d5b92eb285da22f61e13cec4203af2abac3453e5e8370bcd2eba0de03aa1
 SHA512:
-  metadata.gz: 65dee720050ac6ed7574a3cd7ed40da9f32fa4f21af0b8953f8ab9d87bce86279289055ac5ba77b4d967b324ea13df4346b546e26676e55c7faacfa95718b743
-  data.tar.gz: a85c78bc01e5b9f3f7d0099c61cfffa3a0f8d27fea49feea40c0ca631d3eedc2560adcb99125925b691cff7f274fba7e8b039f439961a32772ba148635835fed
+  metadata.gz: '018c55179322a1807e0b7bde285b38d0927345bcf74774a79efb829d05bac226c6743757f2c73b9ded0a9ee5230073850e74126a0e3a1ad55e3f9b7a9a6513bd'
+  data.tar.gz: 0620d371b5fc2cb139afed5550f3635f5ffecb735e0979681f3239676c54b57bd7f3197fdaa2ba12f51fcd484893a1ceb7f3fba620061c03f9afb04f34a86837

data/README.md

@@ -1,6 +1,5 @@
 CanonicalRails
 ==============
-[![Dependency Status](https://gemnasium.com/jumph4x/canonical-rails.png)](https://gemnasium.com/jumph4x/canonical-rails)
 [![Build Status](https://travis-ci.org/jumph4x/canonical-rails.svg?branch=master)](https://travis-ci.org/jumph4x/canonical-rails)
 
 A number of articles exist explaining the issue concisely and at length:
@@ -37,5 +36,4 @@ your HTML views:
 
 ## Cred
 
-A project by [Downshift Labs](http://downshiftlabs.com), Ruby on Rails,
-Performance tuning and Spree Commerce projects.
+Originally developed for [FCP Euro - High Quality European Car Parts](https://www.fcpeuro.com).

data/app/helpers/canonical_rails/tag_helper.rb

@@ -4,12 +4,23 @@ 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? && request.path != '/'
+      "/" if trailing_slash_needed?
     end
 
-    def path_without_html_extension
-      request.path.sub(/\.html$/, '')
+    def path_without_extension
+      return '' if request.path == '/'
+
+      request.path.sub(/\.\w{3,4}$/, '')
     end
 
     def canonical_protocol
@@ -24,14 +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}"
+      raw "#{canonical_protocol}#{host}#{port}#{path_without_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_path(force_trailing_slash = nil)
+      raw "#{path_without_extension}#{trailing_slash_config(force_trailing_slash)}#{allowed_query_string}"
+    end
+
+    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)
@@ -40,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}
@@ -58,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.1"
+  VERSION = "0.2.15"
 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,25 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: canonical-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.15
 platform: ruby
 authors:
 - Denis Ivanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.1'
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,25 +27,31 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.1'
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7.1'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -64,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 4.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -101,13 +107,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 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Simple and configurable Rails canonical ref tag helper