canonical_dude 1.0.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+# RubyMine
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in canonical_dude.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Rudolf Schmidt
+
+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.rdoc

@@ -0,0 +1,96 @@
+= canonical_dude
+
+canonical_dude ist a small helper for Rails applications to make use of the Canonical URL Tag. Use it to set your
+preferred version of a URL.
+
+== Installation
+== The Gem Version
+  # for system wide usage
+  gem install 'canonical_dude'
+  
+  # or just in your Gemfile
+  gem 'canonical_dude'
+
+=== The Plugin Version
+  script/plugin install http://github.com/rudionrails/canonical_dude.git
+
+
+== Usage
+canonical_dude is really easy to use. You only need to put the following into your HTML head:
+  <%= canonical_link_tag %>
+
+This is it, you'll now see the canonical URL tag for your current page, because by default, canonical_dude will use the
+request.url. Probably, this will not quite be what you are looking for since you want to define your canonical url by
+yourself. Not a problem. You also have a controller method available to custom define your canonical URL with some
+extra whiz-bang!
+
+Let's assume you have a Products model. Given we are in the ProductsController, you can specify the canonical in the
+following way (taking the #show action as example):
+
+
+  def show
+    @product = Product.find ( params[:id] )
+    canonical_url @product
+  end
+
+This is simply defining the canonical tag via the :url_for method provided by Rails, so if you have your products
+resource defined in routes.rb, then you're good to go. Also, the following examples result in exactly the same
+canonical URL as shown above:
+
+  # wrapped into url_for
+  canonical_url url_for(@product)
+
+  # giving a hash
+  canonical_url :action => "show", :id => @product.id
+
+Now you might ask yourself: When it's _just_ using url_for, why do I need this gem altogether? Well, canonical_dude
+gives you some freedom in defining your canonical urls by checking for special methods. Taking the above example again
+with a standard rasource approach, you'll have the following URL to the products detail page: /products/:id.
+Also, you have :product_path and :product_url defined as route helpers. Now if there's another product class defined
+called AwesomeProduct ( which inherits from Product but obviously does extra cool stuff ;-), you might have another
+URL for that, too. Sometimes, you have even more of those cases with all different kinds of URLs.
+
+Being a good SEO Dude you can, of course, always exactly specify `canonical_url product_url(@product)`. Or you could
+have it always in one place and just use `canonical_url @product` in all those controllers. All you need now is a helper
+which could look like so:
+
+  module CanonicalHelper
+
+    # alias the AwesomeProduct's canonical url to our initial product url without affecting the awesome_product_url
+    alias_method :canonical_awesome_product_url, :product_url
+
+  end
+
+
+You can define the following helper methods for any class and canonical_dude will attempt to look for those:
+  def canonical_product_url
+    # ...
+  end
+
+  def canonical_product_path
+    # ...
+  end
+
+  # and as the _grand_ fallback
+  def canonical_url
+    # ...
+  end
+
+
+If you have none of those methods defined, canonical_dude will, fallback again to whatevery :url_for gives you.
+Also worth noting is, that, if you defined any custom canonical_* method which returns nil, canonical_dude will not
+render the canonical_link_tag.
+
+Last but not least, you can control when to show your canonical_link_tag with the canonical_url? helper method:
+
+   # in your HTML head of layouts/application.html.erb
+   <%= canonical_link_tag if canonical_url? %>
+
+
+canonical_url? will return true if you have explicitly defined :canonical_url in your controller. If not, it returns
+false. So if you only want a canonical tag on specific placed, you have a basic method for it.
+
+
+== Copyright
+
+Copyright (c) 2011 Rudolf Schmidt See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/canonical_dude.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "canonical_dude/version"
+
+Gem::Specification.new do |s|
+  s.name        = "canonical_dude"
+  s.version     = CanonicalDude::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Rudolf Schmidt"]
+  
+  s.homepage    = "http://github.com/rudionrails/canonical_dude"
+  s.summary     = %q{Easy canonical URL generation}
+  s.description = %q{canonical_dude is a Rails plugin to easily set your preferred version of a URL via the canonical tag}
+
+  s.rubyforge_project = "canonical_dude"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec', '~> 2.5.0'
+end

data/init.rb

@@ -0,0 +1,6 @@
+require 'canonical_dude'
+
+if defined?( Rails )
+  ActionController::Base.send :include, CanonicalDude::ControllerMethods
+  ActionView::Base.send :include, CanonicalDude::HelperMethods
+end

data/lib/canonical_dude/controller_methods.rb

@@ -0,0 +1,7 @@
+module CanonicalDude::ControllerMethods
+
+  def canonical_url( url_for_options = {} )
+    self.instance_variable_set( "@_canonical_url_for_options", url_for_options )
+  end
+
+end

data/lib/canonical_dude/helper_methods.rb

@@ -0,0 +1,38 @@
+module CanonicalDude::HelperMethods
+
+  # tag to include within your HTML header, e.g.:
+  #   <%= canonical_link_tag %>
+  def canonical_link_tag( url_for_options = nil )
+    url = canonical_url_from( url_for_options || @_canonical_url_for_options || request.url )
+    tag( :link, :rel => 'canonical', :href => url ) if url # custom url methods may sometimes return nil --R
+  end
+
+  # returns true if canonical_url has been explicitly set
+  def canonical_url?
+    !!@_canonical_url_for_options
+  end
+
+
+  private
+
+  def canonical_url_from( url_for_options )
+    case url_for_options
+      when Hash then url_for( url_for_options )
+      when String then url_for_options
+      else
+        # could be an AR instance, so let's try some custom methods
+        # will turn a User instance into 'user'
+        canonical_method_name = url_for_options.class.name.downcase.gsub( '::', '_' )
+
+        custom_canonical_method_name = [
+          "canonical_#{canonical_method_name}_url",
+          "canonical_#{canonical_method_name}_path",
+          "canonical_url_for"
+        ].find { |m| respond_to? m }
+
+        return url_for( url_for_options ) unless custom_canonical_method_name
+        send( custom_canonical_method_name, url_for_options )
+    end
+  end
+
+end

data/lib/canonical_dude/version.rb

@@ -0,0 +1,3 @@
+module CanonicalDude
+  VERSION = "1.0.0"
+end

data/lib/canonical_dude.rb

@@ -0,0 +1,6 @@
+module CanonicalDude
+
+  autoload :ControllerMethods, File.dirname(__FILE__) + '/canonical_dude/controller_methods'
+  autoload :HelperMethods, File.dirname(__FILE__) + '/canonical_dude/helper_methods'
+
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: canonical_dude
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Rudolf Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-28 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id001
+description: canonical_dude is a Rails plugin to easily set your preferred version of a URL via the canonical tag
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- canonical_dude.gemspec
+- init.rb
+- lib/canonical_dude.rb
+- lib/canonical_dude/controller_methods.rb
+- lib/canonical_dude/helper_methods.rb
+- lib/canonical_dude/version.rb
+has_rdoc: true
+homepage: http://github.com/rudionrails/canonical_dude
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: canonical_dude
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Easy canonical URL generation
+test_files: []
+