site_meta 0.2.0

data/History.txt

@@ -0,0 +1,5 @@
+== 0.2
+ * Added documentation
+ * meta_keywords now allows multiple arguments, strips spaces
+== 0.1
+First public release of helpers

data/README.rdoc

@@ -0,0 +1,71 @@
+= site_meta
+
+* http://bragi.github.com/site_meta
+
+== DESCRIPTION:
+
+Provides helpers for easy adding of html meta information to Rails applications.
+
+== FEATURES:
+
+* Easily add default description and keywords meta tags.
+* Customize meta tags on per-view basis
+* Add head title tag with breadcrubms
+* Add page title
+
+== PROBLEMS:
+
+Use lighthouse to report problems/feature requests:
+
+* http://bragi.lighthouseapp.com/projects/23211-site_meta
+
+== SYNOPSIS:
+
+In your layout (haml assumed):
+
+  %head
+    = meta_description("Default meta description")
+    = meta_keywords("some, default, keywords")
+    = head_title("Site name")
+  %body
+    %h1= page_title("Default page title")
+
+In your view:
+
+  - set_meta_description(h(@item.description))
+  - set_meta_keywords(h(@item.tags.join(",")))
+  - set_head_title([h(@item.title), "Showing item"])
+  - set_page_title(h(@item.title))
+
+== INSTALL:
+
+* sudo gem install bragi-site_meta
+* Add following line to your config/environment.rb
+    Rails::Initializer.run do |config| 
+      config.gem 'bragi-site_meta'
+    end
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Lukasz Piestrzeniewicz
+
+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/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__)+'/rails/init.rb'

data/lib/site_meta.rb

@@ -0,0 +1,204 @@
+# Provides helpers for easily adding metadata to your views and layouts.
+#
+# In your layout use helpers +head_title+, +meta_description+, +meta_keywords+
+# with optional defaults. In each view you can override the defaults using
+# helpers +set_head_title+, +set_meta_description+, +set_meta_keywords+.
+#
+# == Providing description meta
+#
+# In your layout use +meta_description+ in head section of HTML with optional
+# default description:
+#
+#   %head
+#     = meta_description("Site_meta is the easiest way to provide metadata in your Rails application")
+#
+# In each view you can override default setting using +set_meta_description+.
+# In view app/views/pages/show.html.haml
+#
+#   - set_meta_description(h(@page.description))
+#
+# == Providing keywords meta
+#
+# In your layout use +meta_keywords+ in head section of HTML with optional
+# list of default keywords:
+#
+#   %head
+#     = meta_keywords("rails,gem,plugin,ruby,meta,metadata,html")
+#
+# In each view you can override or add keywords using +set_meta_keywords+.
+# In view app/views/pages/show.html.haml
+#
+#   - set_meta_keywords(h(@page.tags.join(",")))
+#
+# which will add keywords to the default set or
+#
+#   - set_meta_keywords("pricing,information", :replace)
+#
+# to replace the whole list.
+#
+# == Providing title
+#
+# In your layout use +head_title+ in head section and provide last element of
+# breadcrumb trail (usually site name)
+#
+#   %head
+#     = head_title("Site_meta")
+#
+# In each view you provide title using +set_head_title+, where you can provide
+# more elements of breadcrumbs. In view app/views/pages/show.html.haml
+#
+#   - set_head_title(h(@page.title))
+#
+# or in app/views/pages/edit.html.haml
+#
+#   - set_head_title("Editing #{h(@page.title)}", "Pages")
+#
+# This will result in title set to:
+#
+#   "Page title - Site_meta"
+#
+# in first case and:
+#
+#   "Editing Page title - Pages - Site_meta"
+#
+# in second case
+#
+# == Providing title in HTML
+#
+# Title that is presented in the body part of HTML doesn't need the
+# breadcrumbs and may differ from the title presented in HTML head part.
+# Use +page_title+ helper in your layout:
+#
+#   %body
+#     %h1= page_title
+#
+# In each view set the page title using +set_page_title+ helper. In view
+# app/views/pages/show.html.haml:
+#
+#   - set_page_title(h(@page.title))
+#
+# == Providing head and page title at the same time
+#
+# In most situations (like in case of show.html.haml mentioned above) you want
+# to have the same title used as a page title and as a beginning of the
+# breadcrumb trail. In that case use +set_head_and_page_title+ helper.
+# In view app/views/pages/show.html.haml
+#
+#   - set_head_and_page_title(h(@page.title), "Pages")
+#
+# This will set page title to first element and set proper trail in head.
+#
+# == Providing encoding
+#
+# To provide encoding information use +meta_content_type+ in your layout use
+#
+#   %head
+#     = meta_content_type
+#
+# This will provide utf-8 charset by default.
+module SiteMeta
+  VERSION = '0.2.0'
+
+  # Returns meta tag with appropriate encoding specified. +type+ may be any
+  # string, it's inserted verbatim. Popular encodings include "utf-8",
+  # "iso-8859-1" and others.
+  def meta_content_type(type=:utf)
+    type = "utf-8" if type == :utf
+    meta_tag("Content-Type", "text/html; charset=#{type}", "http-equiv")
+  end
+
+  # Returns string with title tag to use in html head. It uses +default_title+
+  # unless you provide breadcrumb elements using +set_head_title+ or
+  # +set_head_and_page_title+. Elements of title (with +default_title+
+  # being the last one) are joined using +separator+.
+  def head_title(default_title, separator=" - ")
+    title = [@head_title, default_title].flatten.compact.join(separator)
+    title_tag(title)
+  end
+
+  # Returns description meta tag with +default_description+ to use in html
+  # head. You can override it on per-view base using +set_meta_description+.
+  # Returns nil when +default_description+ is nil and you did not provide one
+  # using +set_meta_description+.
+  def meta_description(default_description=nil)
+    description = @meta_description || default_description
+    if description
+      meta_tag(:description, description)
+    end
+  end
+
+  # Returns keywords meta tag with +default_keywords+ to use in html head.
+  # You can override keywords on per-view base using +set_meta_keywords+.
+  # Optional +default_keywords+ may be a comma separated string or array of
+  # strings. Returns nil when +default_keywords+ is nil and none additional
+  # keywords were provided through +set_meta_keywords+.
+  def meta_keywords(default_keywords=[])
+    merge_mode = @meta_keywords_merge_mode || :merge
+    meta_keywords = split_keywords(@meta_keywords)
+    keywords = if merge_mode == :merge
+      default_keywords = split_keywords(default_keywords)
+      (meta_keywords + default_keywords).uniq
+    else
+      meta_keywords
+    end
+
+    unless keywords.empty?
+      meta_tag(:keywords, keywords.join(","))
+    end
+  end
+
+  # Returns page title set using +set_page_title+
+  def page_title
+    @page_title
+  end
+
+  # Sets head title breadcrumbs trail
+  def set_head_title(*title)
+    @head_title = title.flatten
+  end
+
+  # Sets head title breadcrumbs trail and page title to the leftmost element.
+  def set_head_and_page_title(*title)
+    title = [title].flatten.compact
+    set_head_title title
+    set_page_title title.first
+  end
+
+  # Sets page title to use with +page_title+
+  def set_page_title(title)
+    @page_title = title
+  end
+
+  # Sets meta +description+ to use with +meta_description+.
+  def set_meta_description(description)
+    @meta_description = description
+  end
+
+  # Sets +keywords+ to use with +meta_keywords+. Optional +merge_mode+ may be
+  # set to either :merge (default) or :replace. In the second mode provided
+  # keywords are not merged with defaults when output using +meta_keywords+.
+  def set_meta_keywords(keywords, merge_mode=:merge)
+    raise(ArgumentError, "Allowed merge modes are only :replace, :merge") unless [:replace,:merge].include?(merge_mode)
+    @meta_keywords = keywords
+    @meta_keywords_merge_mode = merge_mode
+  end
+
+  def split_keywords(keywords) #:nodoc:
+    return [] unless keywords
+    keywords = keywords.split(",") if keywords.is_a? String
+    keywords.flatten.map {|k| k.strip}
+  end
+
+  def meta_tag(name, content, key='name') #:nodoc:
+    if defined?(ActionView::Base)
+      tag 'meta', key => name, :content => content
+    else
+      "<meta #{key}=\"#{name}\" content=\"#{content}\" />"
+    end
+  end
+
+  def title_tag(content) #:nodoc:
+    "<title>#{content}</title>"
+  end
+
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+ActionView::Base.class_eval do
+  include SiteMeta
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: site_meta
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Lukasz Piestrzeniewicz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Provides helpers for easy adding of html meta information to Rails applications.
+email: 
+- bragi@ragnarson.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.rdoc
+files: 
+- History.txt
+- init.rb
+- lib/site_meta.rb
+- rails/init.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/bragi/site_meta
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: site_meta
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Provides helpers for easy adding of html meta information to Rails applications.
+test_files: []
+