zhulei-canonical-rails 0.1.1 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ea38f0bd5a67f2ca610c99b990452e8da1a8bad
-  data.tar.gz: 56bb0136aa7d06c1c572b26baa6da834d5206bdc
+  metadata.gz: acc681c37ea0f9af61bec19afb7deda532ea20c4
+  data.tar.gz: de43c2f57a89718d3700a810c6a1b6bd7110121c
 SHA512:
-  metadata.gz: 72e1da0fdb9f99484681049da83ae17b91fbd21e3b280b36d3c9fb7bcea2bdb7a944f622c4c9f5f963913872e4bfbb34e62f9f7fb1fc303572ebc7c0f81151af
-  data.tar.gz: 701cc5f2859f2756d50e72a125b43dbfb1b016c40b10738b7a69790b680fa833c5f15ff7921413b05c339cc5bb8ed3ef4ffbcc5420942862f367d3b2da05fa4d
+  metadata.gz: e684c3090e13c3240032fe2b6bc3c278f6a2fe781a1339b29fc1cb082ff1fb127543e2fbb4fae6e6f6c7113385e8414c3671cc5d1b46135593549043f5bd2ca4
+  data.tar.gz: 8711add62a7b3bdfe6e0bd1580b368bd21ab425718b582cc90b67497a31c3e9b32af82a95acc55ac74791bc58e9972160ed30b1add62f7f4d3225dce01a14a3e

data/README.md

@@ -1,4 +1,4 @@
-ZhuleiCanonicalRails
+CanonicalRails
 ==============
 [![Build Status](https://travis-ci.org/jumph4x/canonical-rails.svg?branch=master)](https://travis-ci.org/jumph4x/canonical-rails)
 

data/Rakefile

@@ -14,7 +14,7 @@ end
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ZhuleiCanonicalRails'
+  rdoc.title    = 'CanonicalRails'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')

data/app/helpers/canonical_rails/tag_helper.rb

@@ -1,77 +1,77 @@
-module ZhuleiCanonicalRails
-  module TagHelper
-    def trailing_slash_needed?
-      request.params.key?('action') && ZhuleiCanonicalRails.sym_collection_actions.include?(request.params['action'].to_sym)
-    end
-
-    def trailing_slash_if_needed
-      "/" if trailing_slash_needed? && request.path != '/'
-    end
-
-    def path_without_html_extension
-      request.path.sub(/\.html$/, '')
-    end
-
-    def canonical_protocol
-      ZhuleiCanonicalRails.protocol || request.protocol
-    end
-
-    def canonical_host
-      ZhuleiCanonicalRails.host || request.host
-    end
-
-    def canonical_port
-      (ZhuleiCanonicalRails.port || request.port).to_i
-    end
-
-    def canonical_href(host = canonical_host, port = canonical_port)
-      default_ports = { 'https://' => 443, 'http://' => 80 }
-      port = port.present? && port.to_i != default_ports[canonical_protocol] ? ":#{port}" : ''
-      raw "#{canonical_protocol}#{host}#{path_without_html_extension}#{whitelisted_query_string}"
-    end
-    
-    def canonical_path
-      raw "#{path_without_html_extension}#{trailing_slash_if_needed}#{whitelisted_query_string}"
-    end
-
-    def canonical_tag(host = canonical_host, port = canonical_port)
-      canonical_url = canonical_href(host, port)
-      capture do
-        if ZhuleiCanonicalRails.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
-      selected_params = params.select do |key, value|
-        value.present? && ZhuleiCanonicalRails.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
-      # Rack 1.4.5 fails to handle params that are not strings
-      # So if
-      #     my_hash = { "a" => 1, "b" => 2}
-      # Rack::Utils.build_nested_query(my_hash) would return
-      #     "a&b"
-      # Rack 1.4.5 did not have a test case for this scenario
-      # 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?
-    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
+module CanonicalRails
+  module TagHelper
+    def trailing_slash_needed?
+      request.params.key?('action') && CanonicalRails.sym_collection_actions.include?(request.params['action'].to_sym)
+    end
+
+    def trailing_slash_if_needed
+      "/" if trailing_slash_needed? && request.path != '/'
+    end
+
+    def path_without_html_extension
+      request.path.sub(/\.html$/, '')
+    end
+
+    def canonical_protocol
+      CanonicalRails.protocol || request.protocol
+    end
+
+    def canonical_host
+      CanonicalRails.host || request.host
+    end
+
+    def canonical_port
+      (CanonicalRails.port || request.port).to_i
+    end
+
+    def canonical_href(host = canonical_host, port = canonical_port)
+      default_ports = { 'https://' => 443, 'http://' => 80 }
+      port = port.present? && port.to_i != default_ports[canonical_protocol] ? ":#{port}" : ''
+      raw "#{canonical_protocol}#{host}#{path_without_html_extension}#{whitelisted_query_string}"
+    end
+    
+    def canonical_path
+      raw "#{path_without_html_extension}#{trailing_slash_if_needed}#{whitelisted_query_string}"
+    end
+
+    def canonical_tag(host = canonical_host, port = canonical_port)
+      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
+      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
+      # Rack 1.4.5 fails to handle params that are not strings
+      # So if
+      #     my_hash = { "a" => 1, "b" => 2}
+      # Rack::Utils.build_nested_query(my_hash) would return
+      #     "a&b"
+      # Rack 1.4.5 did not have a test case for this scenario
+      # 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?
+    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/engine.rb

@@ -1,8 +1,8 @@
-module ZhuleiCanonicalRails
+module CanonicalRails
   class Engine < ::Rails::Engine
     
     initializer 'canonical_rails.add_helpers' do |app|
-      ActionView::Base.send :include, ZhuleiCanonicalRails::TagHelper
+      ActionView::Base.send :include, CanonicalRails::TagHelper
     end
   
   end

data/lib/canonical-rails/version.rb

@@ -1,3 +1,3 @@
-module ZhuleiCanonicalRails
-  VERSION = "0.1.1"
+module CanonicalRails
+  VERSION = "0.2.4"
 end

data/lib/canonical-rails.rb

@@ -1,8 +1,8 @@
 require "canonical-rails/engine"
 
-module ZhuleiCanonicalRails
+module CanonicalRails
 
-  # Default way to setup ZhuleiCanonicalRails. Run `rails g canonical_rails:install` to create
+  # Default way to setup CanonicalRails. Run `rails g canonical_rails:install` to create
   # a fresh initializer with all configuration values.
   #
   # the config\setup concept politely observed at and borrowed from Devise: https://github.com/plataformatec/devise/blob/master/lib/devise.rb

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

@@ -1,4 +1,4 @@
-module ZhuleiCanonicalRails
+module CanonicalRails
   class InstallGenerator < Rails::Generators::Base
 
     def self.source_paths

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

@@ -1,6 +1,6 @@
 # Do yourself a favor and set these up right when you install the engine.
 
-ZhuleiCanonicalRails.setup do |config|
+CanonicalRails.setup do |config|
 
   # Force the protocol. If you do not specify, the protocol will be based on the incoming request's protocol.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zhulei-canonical-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.4
 platform: ruby
 authors:
-- Zhu Lei
+- Denis Ivanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2018-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -86,10 +86,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This gem is based on canonical-rails by Denis Ivanov,I only delete the
-  port in the url and delete the lower-case method in the code.
+description: 'Configurable, but assumes a conservative strategy by default with a
+  goal to solve many search engine index problems: multiple hostnames, inbound links
+  with arbitrary parameters, trailing slashes. '
 email:
-- zhuleichina@qq.com
+- visible@jumph4x.net
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -124,9 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: canonical-rails by Denis Ivanov,delete the port in the url and delete the
-  lower-case method in the code
+summary: Simple and configurable Rails canonical ref tag helper
 test_files: []