zhulei-canonical-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b83aa32a3a10f89db41e84721bfbb81b4e638f1
+  data.tar.gz: a440ae9681fb7b8fbd542a68d25ae75c28a7188d
+SHA512:
+  metadata.gz: 067de9bc663b4ab9d7859b32efd7c4e2ec13138131c58b458659fb6539992910b61b4c309762d0de360089d7eefdfc624ab8ada20db387c04922c5d2933da042
+  data.tar.gz: b0b953000493e858924dff3b800433615e969a8ff5725b1355a311973e560dc3fe5e7a3d3ac1844bcaac353394b5bdf43438a9dd3c78562ea8973968016f7c89

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+ZhuleiCanonicalRails
+==============
+[![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:
+
+ *   [Google Webmaster Blog Page About Specifying Canonical](http://googlewebmastercentral.blogspot.com/2009/02/specify-your-canonical.html)
+ *   [Google Support About rel="canonical"](http://support.google.com/webmasters/bin/answer.py?hl=en&answer=139394)
+ *   [Google Support About Canonicalization](http://support.google.com/webmasters/bin/answer.py?hl=en&answer=139066)
+
+## Guide
+
+Take a look at this blog post that can guide you through the idea and the setup: [Easily add canonical URLs to your Rails app](http://blog.planetargon.com/entries/2014/4/4/easily-add-canonical-urls-to-your-rails-app)
+
+## Challenge
+
+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
+
+    gem 'canonical-rails', github: 'jumph4x/canonical-rails'
+
+## Usage
+
+First, generate the config
+
+    rails g canonical_rails:install
+
+Then find it in config/initializers/ as canonical_rails.rb
+
+Finally, include the canonical_tag helper inside the `head` portion of
+your HTML views:
+```ruby
+  <%= canonical_tag -%>
+```
+
+## Cred
+
+A project by [Downshift Labs](http://downshiftlabs.com), Ruby on Rails,
+Performance tuning and Spree Commerce projects.

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ZhuleiCanonicalRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/app/helpers/canonical_rails/tag_helper.rb

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

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  
+end

data/lib/canonical-rails/engine.rb

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

data/lib/canonical-rails/version.rb

@@ -0,0 +1,3 @@
+module ZhuleiCanonicalRails
+  VERSION = "0.1.0"
+end

data/lib/canonical-rails.rb

@@ -0,0 +1,39 @@
+require "canonical-rails/engine"
+
+module ZhuleiCanonicalRails
+
+  # Default way to setup ZhuleiCanonicalRails. 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
+
+  def self.setup
+    yield self
+  end
+
+  mattr_accessor :host
+  @@host = nil
+
+  mattr_accessor :port
+  @@port = nil
+
+  mattr_accessor :protocol
+  @@protocol = nil
+
+  mattr_accessor :collection_actions
+  @@collection_actions = [:index]
+
+  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
+
+  def self.sym_whitelisted_parameters
+    @@sym_whitelisted_parameters ||= self.whitelisted_parameters.map(&:to_sym)
+  end
+end

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

@@ -0,0 +1,17 @@
+module ZhuleiCanonicalRails
+  class InstallGenerator < Rails::Generators::Base
+
+    def self.source_paths
+      paths = []
+      paths << File.expand_path('../templates', "../../#{__FILE__}")
+      paths << File.expand_path('../templates', "../#{__FILE__}")
+      paths << File.expand_path('../templates', __FILE__)
+      paths.flatten
+    end
+
+    def add_files
+      template 'canonical_rails.rb', 'config/initializers/canonical_rails.rb'
+    end
+
+  end
+end

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

@@ -0,0 +1,29 @@
+# Do yourself a favor and set these up right when you install the engine.
+
+ZhuleiCanonicalRails.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'
+
+  # http://en.wikipedia.org/wiki/URL_normalization
+  # Trailing slash represents semantics of a directory, ie a collection view - implying an :index get route;
+  # 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

data/lib/tasks/canonical-rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :canonical-rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: zhulei-canonical-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zhu Lei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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.
+email:
+- zhuleichina@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/helpers/canonical_rails/tag_helper.rb
+- config/routes.rb
+- lib/canonical-rails.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/zhuleichina/canonical-rails
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Simple and configurable Rails canonical ref tag helper
+test_files: []