canonical-rails 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 869cd13978490822f6915a4ed4398e349334ac17
-  data.tar.gz: ebc920d8a0f5f77d607530235d186d562b308f8a
+  metadata.gz: 2e409d478f171870d36aa17c3ed45dca798c1e50
+  data.tar.gz: 28dca62d2cf3a8bec0134f22a2298a353f95e437
 SHA512:
-  metadata.gz: e56c138eb35043f5f220e03f4ce4844b123fc9bdc9e088e8c44f2d02a08dd166f3e4ec9c92ba70fff0365bf1b1c74ed6f2a45c13c481fe4567af4a42900b08e0
-  data.tar.gz: aa031e2f97df4104e9f20224416725be5e55d042f32e69010068f221dc2be9f52dbf7cafe5b8c5712bf2c109a12d3acb4c650a1c7eee4c05df0dd160b15b8d7a
+  metadata.gz: 971e25f120889a6fc7f294c51925e1fcb9106414df5b0bc19b3cc7432c8c55610335acb1cd912b420e29517f1f2a342d1e072cca87cd6889e59f169ff762993b
+  data.tar.gz: bbe5092d65dfa2828d81f19221dfef185a8d2c58fa593131c398383aaad0e870b382036a802b51721877f53541d638c7450e627006d4fff217a8342686937330

data/README.md

@@ -15,7 +15,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

@@ -31,13 +31,21 @@ module CanonicalRails
     end
 
     def canonical_tag(host = canonical_host, port = canonical_port)
-      tag(:link, href: canonical_href(host, port), rel: :canonical)
+      canonical_url = canonical_href(host, port)
+      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 +59,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/version.rb

@@ -1,3 +1,3 @@
 module CanonicalRails
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 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.0
 platform: ruby
 authors:
 - Denis Ivanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-05-04 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: '5.2'
   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: '5.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   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.6.10
 signing_key: 
 specification_version: 4
 summary: Simple and configurable Rails canonical ref tag helper