metanol 0.0.4 → 0.0.5

data/README.md

@@ -1,12 +1,12 @@
 # Metanol
 
-This is a meta tags plugin which helps to manage meta tags in your Rails application. It supports some OpenGraph meta tags, Webmaster's meta tags (such as Google, Bing, Yandex, Alexa verification meta tags) and other standard HTML meta tags (such as a description). It can be used by Rails 3.2+ applications.
+This is a meta tags plugin which helps to manage meta tags in your Rails application. It supports some OpenGraph meta tags, Webmaster's meta tags (such as Google, Bing, Yandex, Alexa verification meta tags), MicroData meta tags and other standard HTML meta tags (such as a description). It can be used by Rails 3.2+ applications.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'metanol', '~> 0.0.4'
+    gem 'metanol', '~> 0.0.5'
 
 And then execute:
 
@@ -59,6 +59,7 @@ There are three methods for setting values for meta tags:
 * `meta(meta_name, value) or meta({meta_name: value, meta_name2: value2, ...})` - sets a value(s) for common meta tags
 * `og_meta` - sets a value(s) for OpenGraph's meta tags
 * `wm_meta` - sets a value(s) for Webmaster verification's meta tags
+* `md_meta` - sets a value(s) for MicroData meta tags
 
 This plugin also gives you the ability to set the TITLE tag: `meta :title, "Page title"` renders into `<title>Page title</title>`.
 
@@ -70,8 +71,9 @@ There are some filters which you can set for methods above:
 
 There are some methods for getting a meta's value:
 * `get_meta(name)` - returns a value of a specified HTML meta tag
-* `get_og_meta(name)` - returns a value of a specified OpenGraph meta tags
-* `get_wm_meta(name)` - returns a value of a specified Webmaster meta tags
+* `get_og_meta(name)` - returns a value of a specified OpenGraph meta tag
+* `get_wm_meta(name)` - returns a value of a specified Webmaster meta tag
+* `get_md_meta(name)` - returns a value of a specified MicroData meta tag
 
 ### Helpers
 
@@ -79,6 +81,7 @@ Here is the helper's methods for rendering meta tags:
 * `metanol_tags` - renders all meta tags (Webmaster, OpenGraph and other)
 * `metanol_og_tags` - renders only OpenGraph's meta tags
 * `metanol_wm_tags` - renders Webmaster verification tags
+* `metanol_md_tags` - renders MicroData tags (which has itemprop as a meta's key)
 * `metanol_main_tags` - renders other meta tags, such as keywords, description, etc.
 
 Also the plugin provides some helper's methods for getting a meta's value: `get_meta(name)`, `get_og_meta(name)`, `get_wm_meta(name)`.

data/lib/metanol.rb

@@ -2,6 +2,13 @@ require 'metanol/version'
 
 require 'rails'
 
+require 'metanol/meta/base'
+require 'metanol/meta/main'
+require 'metanol/meta/open_graph'
+require 'metanol/meta/webmaster'
+require 'metanol/meta/micro_data'
+
+require 'metanol/support'
 require 'metanol/helpers'
 require 'metanol/engine_controller'
 require 'metanol/railtie'

data/lib/metanol/engine_controller.rb

@@ -1,7 +1,3 @@
-require File.join(File.dirname(__FILE__), 'meta/base')
-require File.join(File.dirname(__FILE__), 'meta/main')
-require File.join(File.dirname(__FILE__), 'meta/open_graph')
-require File.join(File.dirname(__FILE__), 'meta/webmaster')
 require 'active_support/dependencies'
 
 module Metanol
@@ -15,28 +11,16 @@ module Metanol
         @@metanol_options ||= {}
       end
 
-      def meta(*args)
-        add_meta_tag(:main, *args)
-      end
-
-      def og_meta(*args)
-        add_meta_tag(:og, *args)
-      end
-
-      def wm_meta(*args)
-        add_meta_tag(:wm, *args)
-      end
-
-      def get_meta(name)
-        get_meta_by_type(:main, name)
-      end
-
-      def get_og_meta(name)
-        get_meta_by_type(:og, name)
-      end
+      SUPPORT_GROUPS.keys.each do |method|
+        method_name = "#{method == :main ? '' : "#{method}_"}meta"
+        define_method method_name do |*args|
+          add_meta_tag(method, *args)
+        end
 
-      def get_wm_meta(name)
-        get_meta_by_type(:wm, name)
+        get_method_name = "get_#{method_name}"
+        define_method get_method_name do |name|
+          get_meta_by_type(method, name)
+        end
       end
 
       private
@@ -56,59 +40,43 @@ module Metanol
       end
 
       def add_meta_by_type(type, name, value, filters=[])
-        data = meta_data(name)[type]
-        key = data[:key]
+        meta_class = SUPPORT_GROUPS[type]
+        key = get_meta_key(type, name)
         if metanol_options.key? key
           metanol_options[key].value = value
           metanol_options[key].filters = filters
         else
-          metanol_options[key] = data[:type].new(name, value, filters)
+          metanol_options[key] = meta_class.new(name, value, filters)
         end
       end
 
       def get_meta_by_type(type, name)
-        data = meta_data(name)[type]
-        key = data[:key]
+        key = get_meta_key(type, name)
         metanol_options.key?(key) ? metanol_options[key].value : nil
       end
 
-      def meta_data(name)
-        {
-            main: { key: name, type: Meta::Main },
-            og: { key: "og:#{name}", type: Meta::OpenGraph },
-            wm: { key: "wm:#{name}", type: Meta::Webmaster }
-        }
+      def get_meta_key(type, name)
+        "#{type}:#{name}"
       end
-    end
 
-    def meta(*args)
-      self.class.meta(*args)
     end
 
-    def og_meta(*args)
-      self.class.og_meta(*args)
-    end
+    SUPPORT_GROUPS.keys.each do |method|
+      method_name = "#{method == :main ? '' : "#{method}_"}meta"
+      define_method method_name do |*args|
+        self.class.send(method_name, *args)
+      end
 
-    def wm_meta(*args)
-      self.class.wm_meta(*args)
+      get_method_name = "get_#{method_name}"
+      define_method get_method_name do |name|
+        self.class.send(get_method_name, name)
+      end
     end
 
     def metanol_options
       self.class.metanol_options
     end
 
-    def get_meta(name)
-      self.class.get_meta name
-    end
-
-    def get_og_meta(name)
-      self.class.get_og_meta name
-    end
-
-    def get_wm_meta(name)
-      self.class.get_wm_meta name
-    end
-
   end
 
 end

data/lib/metanol/helpers.rb

@@ -3,27 +3,32 @@ module Metanol
 
     # Render all meta tags
     def metanol_tags
-      result = metanol_main_tags
-      result << metanol_og_tags
-      result << metanol_wm_tags
-      result
+      result = ''
+      SUPPORT_GROUPS.keys.each do |type|
+        result << send("metanol_#{type}_tags")
+      end
+      result.html_safe
     end
 
     # Render OpenGraph meta tags
     def metanol_og_tags
       result = metanol_render_tags ::Metanol::Meta::OpenGraph
-      result << ::Metanol::Meta::OpenGraph.render_current_url(current_url).html_safe
-      result
+      result << ::Metanol::Meta::OpenGraph.render_current_url(current_url)
+      result.html_safe
     end
 
-    # Render Webmaster verification tags
-    def metanol_wm_tags
-      metanol_render_tags ::Metanol::Meta::Webmaster
-    end
+    SUPPORT_GROUPS.keys.each do |method|
+      get_method_name = "get_#{method == :main ? '' : "#{method}_"}meta"
+      define_method get_method_name do |name|
+        self.controller.send(get_method_name, name)
+      end
 
-    # Render main tags, such as keywords, description, etc.
-    def metanol_main_tags
-      metanol_render_tags ::Metanol::Meta::Main
+      next if method == :og
+      method_name = "metanol_#{method}_tags"
+      class_type = SUPPORT_GROUPS[method]
+      define_method method_name do
+        metanol_render_tags(class_type).html_safe
+      end
     end
 
     # Return a current URL
@@ -31,18 +36,6 @@ module Metanol
       request.original_url
     end
 
-    def get_meta(name)
-      self.controller.get_meta(name)
-    end
-
-    def get_og_meta(name)
-      self.controller.get_og_meta(name)
-    end
-
-    def get_wm_meta(name)
-      self.controller.get_wm_meta(name)
-    end
-
     private
 
     def metanol_render_tags(type)
@@ -51,7 +44,7 @@ module Metanol
         next unless value.is_a? type
         result << value.render
       end
-      result.html_safe
+      result
     end
 
   end

data/lib/metanol/meta/base.rb

@@ -1,8 +1,7 @@
 module Metanol::Meta
 
   class Base
-    attr_reader :name
-    attr_accessor :value
+    attr_writer :value
 
     SUPPORTED_FILTERS = [:html, :overspaces, :whitespaces, :clean]
 
@@ -18,7 +17,21 @@ module Metanol::Meta
     end
 
     def render
-      raise StandardError.new "Please override this method in a child class"
+      result = self.value
+      !result.blank? ? "<meta #{self.attr_name}=\"#{self.name}\" #{self.attr_value}=\"#{result}\" />" : ''
+    end
+
+    def name
+      @name
+    end
+
+    def value
+      result = @value
+      return result unless filters?
+      result = self.class.filter_html(result) if @filters.include?(:html) || @filters.include?(:clean)
+      result = self.class.filter_whitespaces(result) if @filters.include?(:whitespaces) || @filters.include?(:clean)
+      result = self.class.filter_overspaces(result) if @filters.include?(:overspaces) || @filters.include?(:clean)
+      result
     end
 
     def self.filter_html(text)
@@ -40,19 +53,18 @@ module Metanol::Meta
       true
     end
 
-    def filtered_value
-      result = @value
-      return result unless filters?
-      result = self.class.filter_html(result) if @filters.include?(:html) || @filters.include?(:clean)
-      result = self.class.filter_whitespaces(result) if @filters.include?(:whitespaces) || @filters.include?(:clean)
-      result = self.class.filter_overspaces(result) if @filters.include?(:overspaces) || @filters.include?(:clean)
-      result
-    end
-
     def filters?
       @filters && !@filters.empty?
     end
 
+    def attr_name
+      'name'
+    end
+
+    def attr_value
+      'content'
+    end
+
     private
 
     def validate_filters(filters=[])

data/lib/metanol/meta/main.rb

@@ -2,8 +2,9 @@ module Metanol::Meta
 
   class Main < Base
     def render
-      return "<title>#{filtered_value}</title>" if @name == :title
-      "<meta name=\"#{@name}\" content=\"#{filtered_value}\" />"
+      result = self.value
+      return (!result.blank? ? "<title>#{result}</title>": '') if @name == :title
+      super
     end
   end
 

data/lib/metanol/meta/micro_data.rb

@@ -0,0 +1,13 @@
+module Metanol::Meta
+
+  class MicroData < Base
+
+    protected
+
+    def attr_name
+      'itemprop'
+    end
+
+  end
+
+end

data/lib/metanol/meta/open_graph.rb

@@ -1,13 +1,21 @@
 module Metanol::Meta
 
   class OpenGraph < Base
-    def render
-      "<meta property=\"og:#{@name}\" content=\"#{filtered_value}\" />"
-    end
 
     def self.render_current_url(url)
-      "<meta property=\"og:url\" content=\"#{url}\" />"
+      !url.blank? ? "<meta property=\"og:url\" content=\"#{url}\" />" : ''
+    end
+
+    def name
+      "og:#{@name}"
     end
+
+    protected
+
+    def attr_name
+      'property'
+    end
+
   end
 
 end

data/lib/metanol/meta/webmaster.rb

@@ -8,8 +8,8 @@ module Metanol::Meta
         alexa: 'alexaVerifyID'
     }
 
-    def render
-      "<meta name=\"#{SUPPORT_TAGS[@name]}\" content=\"#{filtered_value}\" />"
+    def name
+      SUPPORT_TAGS[@name]
     end
 
     protected

data/lib/metanol/support.rb

@@ -0,0 +1,8 @@
+module Metanol
+  SUPPORT_GROUPS = {
+      main: Meta::Main,
+      og: Meta::OpenGraph,
+      wm: Meta::Webmaster,
+      md: Meta::MicroData
+  }
+end

data/lib/metanol/version.rb

@@ -1,3 +1,3 @@
 module Metanol
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/metanol.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |gem|
   gem.platform        = Gem::Platform::RUBY
   gem.authors       = ["Eugene Kondratyuk"]
   gem.email         = ["ekondr@gmail.com"]
-  gem.description   = %q{This is a meta tags plugin which helps to manage meta tags in your Rails application. It supports some OpenGraph meta tags, Webmaster's meta tags (such as Google, Bing, Yandex, Alexa verification meta tags) and other standard HTML meta tags (such as a description). It can be used by Rails 3.2+ applications}
-  gem.summary       = %q{A meta tags engine plugin for Rails 3.2+ applications}
+  gem.description   = %q{This is a meta tags plugin which helps to manage meta tags in your Rails application. It supports some OpenGraph meta tags, Webmaster's meta tags (such as Google, Bing, Yandex, Alexa verification meta tags), MicroData meta tags and other standard HTML meta tags (such as a description). It can be used by Rails 3.2+ applications.}
+  gem.summary       = %q{A <META> tags engine plugin for Rails 3.2+ applications}
   gem.homepage      = "https://github.com/ekondr/metanol"
 
   gem.rubyforge_project = 'metanol'

data/spec/controllers/tests_controller_spec.rb

@@ -50,6 +50,7 @@ describe TestsController do
         meta :title, "Users List"
         meta :description, "Description for a users list"
         og_meta title: "OpenGraph Title", description: "OpenGraph Description"
+        md_meta description: "MicroData Description"
         render :inline => <<-ERB
           <%= metanol_tags %>
         ERB
@@ -62,6 +63,7 @@ describe TestsController do
     it { response.should have_selector('meta[content="OpenGraph Description"]', property: 'og:description') }
     it { response.should have_selector('title', content: 'Users List') }
     it { response.should have_selector('meta[content="Description for a users list"]', name: 'description') }
+    it { response.should have_selector('meta[content="MicroData Description"]', itemprop: 'description') }
   end
 
   context "raise exception for unsupported metas" do
@@ -156,19 +158,22 @@ describe TestsController do
   context "returns meta values in a controller and in a view" do
     controller do
       def index
-        meta :title,    'Users List'
-        wm_meta :alexa, 'alexa code'
-        og_meta title:  'OpenGraph Title'
+        meta :title,          'Users List'
+        wm_meta :alexa,       'alexa code'
+        og_meta title:        'OpenGraph Title'
+        md_meta description:  'MicroData Desc'
 
         @meta = get_meta :title
         @wm_meta = get_wm_meta :alexa
         @og_meta = get_og_meta :title
+        @md_meta = get_md_meta :description
         @og_no_meta = get_og_meta :bad_meta_name
 
         render :inline => <<-ERB
           <span>Main meta is <%= get_meta :title %></span>
           <span>OpenGraph meta is <%= get_og_meta :title %></span>
           <span>Webmaster meta is <%= get_wm_meta :alexa %></span>
+          <span>MicroData meta is <%= get_md_meta :description %></span>
         ERB
       end
     end
@@ -178,9 +183,11 @@ describe TestsController do
     it { response.should have_selector('span', content: 'Main meta is Users List') }
     it { response.should have_selector('span', content: 'OpenGraph meta is OpenGraph Title') }
     it { response.should have_selector('span', content: 'Webmaster meta is alexa code') }
+    it { response.should have_selector('span', content: 'MicroData meta is MicroData Desc') }
     it { assigns(:meta).should == 'Users List' }
     it { assigns(:wm_meta).should == 'alexa code' }
     it { assigns(:og_meta).should == 'OpenGraph Title' }
+    it { assigns(:md_meta).should == 'MicroData Desc' }
     it { assigns(:og_no_meta).should == nil }
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metanol
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -29,8 +29,8 @@ dependencies:
         version: '3.2'
 description: This is a meta tags plugin which helps to manage meta tags in your Rails
   application. It supports some OpenGraph meta tags, Webmaster's meta tags (such as
-  Google, Bing, Yandex, Alexa verification meta tags) and other standard HTML meta
-  tags (such as a description). It can be used by Rails 3.2+ applications
+  Google, Bing, Yandex, Alexa verification meta tags), MicroData meta tags and other
+  standard HTML meta tags (such as a description). It can be used by Rails 3.2+ applications.
 email:
 - ekondr@gmail.com
 executables: []
@@ -48,9 +48,11 @@ files:
 - lib/metanol/helpers.rb
 - lib/metanol/meta/base.rb
 - lib/metanol/meta/main.rb
+- lib/metanol/meta/micro_data.rb
 - lib/metanol/meta/open_graph.rb
 - lib/metanol/meta/webmaster.rb
 - lib/metanol/railtie.rb
+- lib/metanol/support.rb
 - lib/metanol/version.rb
 - metanol.gemspec
 - spec/controllers/home_controller_spec.rb
@@ -81,7 +83,7 @@ rubyforge_project: metanol
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: A meta tags engine plugin for Rails 3.2+ applications
+summary: A <META> tags engine plugin for Rails 3.2+ applications
 test_files:
 - spec/controllers/home_controller_spec.rb
 - spec/controllers/tests_controller_spec.rb