smart-meta 0.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jeffrey Chupp
+
+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,76 @@
+= SmartMeta
+
+SmartMeta is a simple plugin to allow you to set titles, descriptions, and keywords easily on pages.  You just need to define your controller and action pairs in your translation files and SmartMeta will handle the rest.  It can make use of your instance variables, helper methods, and even go through relationships to access relevant variables for interpolations.
+
+It isn't the most exciting thing ever, but I've found myself using this pattern enough that extracting it seems like it will save me time in the future.
+
+There are likely other plugins that do the same thing (and possibly better).  If you know of another one that works in a similar manner but is arguably better, message me on github and let me know.
+
+== Installation
+
+Install as a Rails plugin:
+
+  ./script/plugin install git://github.com/semanticart/smart-meta.git
+
+== Usage Overview
+
+Once you've installed, to get rolling you only have to do two things:
+
+1)  Fill out your translation files with titles, descriptions, and keywords (as you wish)
+
+2)  Use smart_title, smart_description, and smart_keywords where you want SmartMeta to work (probably in your application layout).
+
+
+=== Example
+
+Fill out your translation files in #{RAILS_ROOT}/config/locales/ like the following example:
+
+  en:
+    users:
+      show:
+        title: "{{@user.name}} has {{@user.hair.color}} hair"
+        description: "{{@user.name}}'s page on my site"
+        keywords: "user, {{@user.name}}, {{page_keywords}}, etc. etc."
+
+
+Here I've defined that my Users controller's #show method should have a title based off of the user's name and hair color.  When I call the smart_title method, it will look for an instance variable named @user and pass it name to populate the first argument and the look to the user's hair for the color to populate the second argument.
+
+The keywords makes use of page_keywords which is a method we'll define in either our ApplicationHelper or our UsersHelper.
+
+=== Failover
+
+This isn't a catch-all solution so I recommend implementing it something like this in your application layout:
+
+  <title><%= yield(:html_title) || smart_title || t('default.title') %></title>
+
+  <meta name="description" content="<%= yield(:meta_description) || smart_description || t('default.description') %>" />
+
+  <meta name="keywords" content="<%= yield(:meta_keywords) || smart_keywords || t('default.keywords') %>" />
+
+
+Here I'm telling the layout that if I've defined a :html_title via content_for elsewhere, use that.  Otherwise use the smart_title.  If both of those return nil available (for instance if we're on an action we haven't defined a title for), then use the site's default title.
+
+You'll need to specify your own default title in your translations.  Example:
+
+  en:
+    default:
+      title: "Some rad title for my site"
+
+
+For completeness sake, here's an example of using content_for to set the title in a view:
+
+  <% content_for(:html_title, "Some title to be used instead of smart_title and default title") %>
+
+=== Other uses
+
+You can use this plugin to handle things other than titles, descriptions, or keywords.  Simply call smart_meta_for and pass what you want.  To access "users.show.robots" you just need to define
+
+  en:
+    users:
+      show:
+        robots: "NOINDEX"
+
+and then call smart_meta_for(:robots) in your view/layout/etc.
+
+
+Copyright (c) 2010 Jeffrey Chupp, released under the MIT license

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "smart-meta"
+    gem.summary = %Q{smart-meta}
+    gem.description = %Q{A plugin for simplifying view titles, descriptions, and keywords}
+    gem.email = "vad4msiu@gmail.com"
+    gem.homepage = "http://github.com/vad4msiu/smart-meta.git"
+    gem.authors = ["Sirupsen"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install   jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/init.rb

@@ -0,0 +1 @@
+ApplicationHelper.send(:include, SmartMeta)

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/smart_meta.rb

@@ -0,0 +1,47 @@
+module SmartMeta
+  def smart_meta_for(kind)
+    key = [params[:controller], params[:action], kind].compact.join('.')
+    if (title_template = translation_for(key))
+      needed_args = title_template.scan(/\{\{(.*?)\}\}/).flatten
+      args = needed_args.inject({}) do |hash, arg|
+        hash[arg.to_sym] = value_from_arg(arg)
+        hash
+      end
+      I18n.t(key, args)
+    end
+  end
+
+  def smart_description
+    smart_meta_for(:description)
+  end
+
+  def smart_keywords
+    smart_meta_for(:keywords)
+  end
+
+  def smart_title
+    smart_meta_for(:title)
+  end
+
+  private
+
+  def translation_for(key)
+    key.present? && I18n.backend.send(:lookup, I18n.locale || I18n.default_locale, key)
+  end
+
+  def value_from_arg(arg)
+    parts = arg.split('.')
+    # see if we're dealing with an instance variable
+    if parts[0].starts_with?('@')
+      ret = instance_variable_get(parts.shift)
+    else
+      ret = send(parts.shift)
+    end
+
+    # send the rest of our messages
+    parts.each do |part|
+      ret = ret.send(part)
+    end
+    ret
+  end
+end

data/spec/languages/en.yml

@@ -0,0 +1,4 @@
+en:
+  users:
+    show:
+      title: "{{@name}} has {{@color}} eyes"

data/spec/languages/koolaid.yml

@@ -0,0 +1,4 @@
+koolaid:
+  users:
+    show:
+      title: "OH YEAH!!!! {{@name}} has {{@color}} eyes... OH YEAH!!!!"

data/spec/smart_meta_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe SmartMeta do
+  include SmartMeta
+
+  before(:all) do
+    ['en', 'koolaid'].each do |lang|
+      I18n.load_path << File.expand_path(File.join(File.dirname(__FILE__), "languages/#{lang}.yml"))
+    end
+  end
+
+  describe 'smart_meta_for' do
+    it 'can handle instance variables' do
+      @name = "Jeff"
+      @color = "blue"
+
+      stub!(:params).and_return(:action => "show", :controller => "users")
+      smart_meta_for(:title).should == "Jeff has blue eyes"
+    end
+
+    it 'can handle using other accessible methods' do
+      def an_animal
+        "panda"
+      end
+
+      stub!(:params).and_return(:action => "show", :controller => "animals")
+      I18n.backend.stub!(:lookup, "animals.show.title").and_return("The {{an_animal.pluralize}} are cute!")
+
+      smart_meta_for(:title).should == "The pandas are cute!"
+    end
+
+    it "works with multiple locales" do
+      @name = "Jeff"
+      @color = "blue"
+
+      stub!(:params).and_return(:action => "show", :controller => "users")
+
+      I18n.locale = :koolaid
+      smart_meta_for(:title).should == "OH YEAH!!!! Jeff has blue eyes... OH YEAH!!!!"
+
+      I18n.locale = :en
+      smart_meta_for(:title).should == "Jeff has blue eyes"
+    end
+
+    it "can send multiple messages to an object" do
+      @controller = "dinosaurs"
+      mock_dino = mock(:name => "Grizzly-T-Rex")
+      @dinosaurs = [mock_dino, mock]
+
+      stub!(:params).and_return(:action => "index", :controller => "dinosaurs")
+      I18n.backend.stub!(:lookup, "dinosaurs.index.title").and_return("{{@dinosaurs.first.name}} is the scariest of all the {{@controller}}!")
+
+      smart_meta_for(:title).should == "Grizzly-T-Rex is the scariest of all the dinosaurs!"
+    end
+
+    it 'returns nil if it cannot match the translation' do
+      stub!(:params).and_return(:action => "something", :controller => "something else")
+      smart_meta_for(:title).should be_nil
+    end
+  end
+
+  [:title, :keywords, :description].each do |kind|
+    describe "smart_#{kind}" do
+      it "calls smart_meta_for with :#{kind}" do
+        should_receive(:smart_meta_for).with(kind)
+
+        self.send(:"smart_#{kind}")
+      end
+    end
+  end
+
+  it 'allows you to use custom kinds' do
+    stub!(:params).and_return(:action => "index", :controller => "dinosaurs")
+    should_receive(:translation_for).with('dinosaurs.index.robots')
+    smart_meta_for("robots")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "../lib/smart_meta.rb"))
+require 'rubygems'
+require 'spec'
+require 'active_support'

data/tasks/smart_titles_tasks.rake

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

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: smart-meta
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Sirupsen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-22 00:00:00 +04:00
+default_executable: 
+dependencies: []
+
+description: A plugin for simplifying view titles, descriptions, and keywords
+email: vad4msiu@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/smart_meta.rb
+- spec/languages/en.yml
+- spec/languages/koolaid.yml
+- spec/smart_meta_spec.rb
+- spec/spec_helper.rb
+- tasks/smart_titles_tasks.rake
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/vad4msiu/smart-meta.git
+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: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: smart-meta
+test_files: []
+