meta-tags-helpers 0.1.4 → 0.1.7

data/README.md

@@ -1,8 +1,8 @@
-# meta-tags-helpers
+# Rails meta tags helpers
 
-## Rails meta tags helpers
+## Seo and future-proof meta tags for Rails
 
-Seo and future-proof meta-tags for Rails, with good customizable defaults that also provide support for open-graph and csrf: all your meta tags in a single call.
+The `meta-tags-helpers` gem consists of a set of helpers to setup and render html meta tags in a simple way. It has good customizable defaults that also come with built-in support for open-graph and csrf: all your meta tags in a single call.
 
 ### Install
 
@@ -12,6 +12,15 @@ gem 'meta-tags-helpers'
 
 ### Examples
 
+You could use the default meta tags (see below) inserting the following snippet of `erb` code in your layout. 
+
+``` erb
+<%= meta_tags %>
+```
+
+if you don't like the defaults you can override them passing other values as a parameter to the `meta_tags` helper.
+
+
 ``` erb
 <%= meta_tags(
     :title => "MyBlog - This is a Blog",
@@ -24,11 +33,9 @@ gem 'meta-tags-helpers'
 %>
 ```
 
-or using defaults with setters (see below) just:
+You can further override these values in your controller, views and partials using the `set_meta` method (see below).
 
-``` erb
-<%= meta_tags %>
-```
+**NOTE:** You can set namespaced keys (eg. `og:type`) either as key-value pairs (eg. `:"og:type" => "..."`) or as nested hashes (eg. `:og => {:type => "..."}`), both of the syntaxes would address the same meta tag.
 
 ### What it generates? 
 
@@ -52,9 +59,31 @@ The first example above will produce the following html:
 
 **NOTE:** namespaced meta (eg. `og:title`) are supposed to be RDF properties and so they are marked using a `property` attribute.
 
-### Setting meta tags from controller/partials/other views
+### Setting and overriding meta tags from controller/partials/other views
+
+You can set any meta tag from controller, partials or views via the `set_meta` method:
 
-You can customize some of defautls (see below) through handy helpers within controllers or views:
+``` rhtml
+<!-- application.html.erb: the global settings -->
+<%= meta_tags :og => { :type => "website" } %>
+```
+
+Override it in a controller:
+
+``` rb
+def show
+   set_meta "og:type"   => "article"
+end
+```
+In a view:
+
+``` rhtml
+  <% set_meta "og:type" => "article" %>
+```
+
+**NOTE:** `set_meta(:og => { :type => "article" })` is exactly the same of `set_meta(:"og:type" => "article")` so they will both override the current/default `og:type` meta tag.
+
+You can also customize and read some of defautls (see below) through handy helpers within controllers or views:
 
 ``` rb
 meta_title(value = nil)
@@ -69,24 +98,23 @@ meta_type(value = nil)
 This is the default options hash:
 
 ``` rb
-default = {
-  :charset => "utf-8", 
+default   = {
+  :charset           => "utf-8", 
   :"X-UA-Compatible" => "IE=edge,chrome=1", 
-  :viewport => "width=device-width",
-  :title => meta_title,
-  :description => meta_description,
-  :og => { 
-    :url => "#{request.url}", 
-    :type => meta_type || "article",
-    :title => opts[:title] || meta_title,
-    :description => opts[:description] || meta_description,
-    :image => (opts[:og] && opts[:og][:image]) || meta_image
-  },
-  :"csrf-param" => request_forgery_protection_token,
-  :"csrf-token" => form_authenticity_token
+  :viewport          => "width=device-width",
+  :"og:url"          => "#{request.url}", 
+  :"og:type"         => "article",
+  :"og:title"        => opts[:title],
+  :"og:description"  => opts[:description],
+  :"og:image"        => opts[:"og:image"],
+  :"csrf-param"      => request_forgery_protection_token,
+  :"csrf-token"      => form_authenticity_token
 }
+
 ```
 
+**NOTE:** You should supply at least the `title` and the `description`, using `set_meta` or directly as `meta_tags` argument.
+
 ---
 
 Copyright (c) 2012 mcasimir

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.7

data/lib/meta_tags_helpers.rb

@@ -22,44 +22,26 @@
 
 
 module MetaTagsHelpers
-
   module ActionViewExtension
     
-    def meta_tags(*args)
-      opts = args.extract_options!
-      default = {
-        :charset => "utf-8", 
+    def meta_tags(opts = {})
+ 
+      opts = normalize_meta_hash(opts)
+
+      default   = {
+        :charset           => "utf-8", 
         :"X-UA-Compatible" => "IE=edge,chrome=1", 
-        :viewport => "width=device-width",
-        :title => meta_title,
-        :description => meta_description,
-        :og => { 
-          :url => "#{request.url}", 
-          :type => meta_type || "article",
-          :title => opts[:title] || meta_title,
-          :description => opts[:description] || meta_description,
-          :image => (opts[:og] && opts[:og][:image]) || meta_image
-        },
-        :"csrf-param" => request_forgery_protection_token,
-        :"csrf-token" => form_authenticity_token
-      }
-        
-      meta_hash = default.deep_merge(opts)
-        
-      # separates namespaced keys
-      namespaces = meta_hash.select { |k,v| v.is_a?(Hash) }
-        
-      # delete nil/false/namespaced keys
-      meta_hash.delete_if { |k,v| v.blank? || v == false || v.is_a?(Hash)}
-        
-      namespaces.each { |ns, namespaced|
-        namespaced.delete_if { |k,v|
-          v.blank? || v == false || v.is_a?(Hash)
-        }
-        namespaced.each {|k,v|
-          meta_hash[:"#{ns}:#{k}"] = v 
-        }
+        :viewport          => "width=device-width",
+        :"og:url"          => "#{request.url}", 
+        :"og:type"         => "article",
+        :"og:title"        => opts[:title],
+        :"og:description"  => opts[:description],
+        :"og:image"        => opts[:"og:image"],
+        :"csrf-param"      => request_forgery_protection_token,
+        :"csrf-token"      => form_authenticity_token
       }
+      
+      meta_hash = default.deep_merge(opts).deep_merge(@_meta_tags_hash || {})
         
       html = ""
       html << "<title>#{h(meta_hash.delete(:title)) }</title>\n"
@@ -73,44 +55,78 @@ module MetaTagsHelpers
       html.html_safe
     end
     
-  end
+  end #~ ActionViewExtension
   
   module ActionControllerExtension
     extend ActiveSupport::Concern
     included do
-      helper_method :meta_title, :meta_description, :meta_image, :meta_type
+      helper_method :set_meta, :meta_title, :meta_description, :meta_image, :meta_type, :normalize_meta_hash
+    end
+    
+    def _meta_tags_hash
+      @_meta_tags_hash ||= {}
+    end
+  
+    def set_meta(options)
+      _meta_tags_hash.deep_merge(normalize_meta_hash(options))
     end
   
-    def meta_title(*args)
-      if title = args.first
-        @meta_title = title
-      else
-        @meta_title
+    def meta_title(val = nil)
+      if val
+        @_meta_title = val
+        set_meta(:title => val)
       end
+      
+      @_meta_title
     end
       
-    def meta_description(*args)
-      if desc = args.first
-        @meta_description = desc
-      else
-        @meta_description
+    def meta_description(val = nil)
+      if val
+        @_meta_description = val
+        set_meta(:description => val)
       end
+      @_meta_description
     end
       
-    def meta_image(*args)
-      if img = args.first
-        @meta_image = img
-      else
-        @meta_image
+    def meta_image(val = nil)
+      if val
+        @_meta_image = val
+        set_meta(:og => { :image => val })
       end
+      @_meta_image
     end
 
-    def meta_type(*args)
-      if t = args.first
-        @meta_type = t
-      else
-        @meta_type
+    def meta_type(val = nil)
+      if val
+        @_meta_type = val
+        set_meta(:og => { :type  => val })
       end
+      @_meta_type
+    end
+    
+    protected
+    
+    def normalize_meta_hash(hash)
+      
+      meta_hash = hash.dup
+      
+      # separates namespaced keys
+      namespaces = meta_hash.select { |k,v| v.is_a?(Hash) }
+        
+      # delete nil/false/namespaced keys
+      meta_hash.delete_if { |k,v| v.blank? || v == false || v.is_a?(Hash)}
+        
+      namespaces.each { |ns, namespaced|
+        namespaced.delete_if { |k,v|
+          v.blank? || v == false || v.is_a?(Hash)
+        }
+        namespaced.each {|k,v|
+          meta_hash[:"#{ns}:#{k}"] = v 
+        }
+      }
+      
+      meta_hash
+      
     end
     
   end

data/meta-tags-helpers.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "meta-tags-helpers"
-  s.version = "0.1.4"
+  s.version = "0.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["mcasimir"]
-  s.date = "2013-01-18"
+  s.date = "2013-06-01"
   s.description = "Rails meta tags helpers"
   s.email = "maurizio.cas@gmail.com"
   s.extra_rdoc_files = [
@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/mcasimir/kaminari-bootstrap"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.25"
   s.summary = "Rails meta tags helpers"
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: meta-tags-helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-18 00:00:00.000000000 Z
+date: 2013-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -89,7 +89,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3024929928964013503
+      hash: 2398148642369134804
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Rails meta tags helpers