canonical-rails 0.1.2 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 869cd13978490822f6915a4ed4398e349334ac17
-  data.tar.gz: ebc920d8a0f5f77d607530235d186d562b308f8a
+SHA256:
+  metadata.gz: 0ab1e0b7b6f0b2ab95ac94692939a74ade7bd8a2cb744bec7c6762ae04a1dfe7
+  data.tar.gz: 8091321b37d368601c5242496bade7282fc2e7a31a4d7ee547cddae8eaa116a6
 SHA512:
-  metadata.gz: e56c138eb35043f5f220e03f4ce4844b123fc9bdc9e088e8c44f2d02a08dd166f3e4ec9c92ba70fff0365bf1b1c74ed6f2a45c13c481fe4567af4a42900b08e0
-  data.tar.gz: aa031e2f97df4104e9f20224416725be5e55d042f32e69010068f221dc2be9f52dbf7cafe5b8c5712bf2c109a12d3acb4c650a1c7eee4c05df0dd160b15b8d7a
+  metadata.gz: 6015361191325a29ea441f6150277126ba216c59ac40f09954b6b178b497b84216e6783505dafab8b479d4264949836a98d6175101fd275d18b3c941ff7e8022
+  data.tar.gz: a6bf895a0626fb7dfd47e4bc88c19e2bd90d8671b42c95d5f0878a7578104e9b40af35662806abc442f53d4a2a54e7afea8baa7eca89a5f9e753ee16d8221e33

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:
@@ -15,7 +14,7 @@ Take a look at this blog post that can guide you through the idea and the setup:
 
 ## Challenge
 
-I've seen a lot of folks do more harm by neglecting canonicalization altogether than by applying to narrowly and conservatively, so here is an attempt to let people start modestly without spending too much time on it and whitelist parameters as they need to.
+I've seen a lot of folks do more harm by neglecting canonicalization altogether than by applying too narrowly and conservatively, so here is an attempt to let people start modestly without spending too much time on it and whitelist parameters as they need to.
 
 ## Install
 

data/app/helpers/canonical_rails/tag_helper.rb

@@ -1,14 +1,25 @@
 module CanonicalRails
   module TagHelper
     def trailing_slash_needed?
-      CanonicalRails.sym_collection_actions.include? request.params['action'].to_sym
+      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
+      return '' if request.path == '/'
+
       request.path.sub(/\.html$/, '')
     end
 
@@ -24,20 +35,32 @@ 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_html_extension}#{trailing_slash_config(force_trailing_slash)}#{whitelisted_query_string}"
+    end
+
+    def canonical_path(force_trailing_slash = nil)
+      raw "#{path_without_html_extension}#{trailing_slash_config(force_trailing_slash)}#{whitelisted_query_string}"
     end
 
-    def canonical_tag(host = canonical_host, port = canonical_port)
-      tag(:link, href: canonical_href(host, port), rel: :canonical)
+    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)
+        end
+        concat tag(:link, href: canonical_url, rel: :canonical)
+      end
     end
 
     def whitelisted_params
-      params.select do |key, value|
+      selected_params = params.select do |key, value|
         value.present? && CanonicalRails.sym_whitelisted_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
@@ -51,7 +74,15 @@ module CanonicalRails
       # Rack 1.6.0 has it
       # https://github.com/rack/rack/blob/65a7104b6b3e9ecd8f33c63a478ab9a33a103507/test/spec_utils.rb#L251
 
-      "?" + Rack::Utils.build_nested_query(Hash[whitelisted_params.map { |k, v| v.is_a?(Numeric) ? [k, v.to_s] : [k, v] }]) if whitelisted_params.present?
+      wl_params = whitelisted_params
+
+      "?" + Rack::Utils.build_nested_query(convert_numeric_params(wl_params)) if wl_params.present?
+    end
+
+    private
+
+    def convert_numeric_params(params_hash)
+      Hash[params_hash.map { |k, v| v.is_a?(Numeric) ? [k, v.to_s] : [k, v] }]
     end
   end
 end

data/lib/canonical-rails.rb

@@ -26,6 +26,9 @@ module CanonicalRails
   mattr_accessor :whitelisted_parameters
   @@whitelisted_parameters = []
 
+  mattr_accessor :opengraph_url
+  @@opengraph_url = false
+
   def self.sym_collection_actions
     @@sym_collection_actions ||= self.collection_actions.map(&:to_sym)
   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.1.2"
+  VERSION = "0.2.9"
 end

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

@@ -1,13 +1,13 @@
-# Do yourself a favor and set these up right when you install the engine. 
+# Do yourself a favor and set these up right when you install the engine.
 
 CanonicalRails.setup do |config|
 
   # Force the protocol. If you do not specify, the protocol will be based on the incoming request's protocol.
 
   config.protocol#= 'https://'
-  
+
   # This is the main host, not just the TLD, omit slashes and protocol. If you have more than one, pick the one you want to rank in search results.
-  
+
   config.host# = 'www.mywebstore.com'
   config.port# = '3000'
 
@@ -16,12 +16,14 @@ CanonicalRails.setup do |config|
   # otherwise we have to assume semantics of an instance of a resource type, a member view - implying a :show get route
   #
   # Acts as a whitelist for routes to have trailing slashes
-  
+
   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
-  
+
   config.whitelisted_parameters# = []
-  
+
+  # Output a matching OpenGraph URL meta tag (og:url) with the canonical URL, as recommended by Facebook et al
+  config.opengraph_url#= true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canonical-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.9
 platform: ruby
 authors:
 - Denis Ivanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2020-08-20 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: '5.1'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
 - !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
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Simple and configurable Rails canonical ref tag helper