metanol 0.0.2 → 0.0.3

data/README.md

@@ -58,6 +58,14 @@ There are three methods for setting values for 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
 
+This plugin also gives you the ability to set the TITLE tag: `meta :title, "Page title"` renders into `<title>Page title</title>`.
+
+There are some filters which you can set for methods above:
+* `html` - to get rid of HTML tags in a value (i.e. `meta :title, "Page title", :html`)
+* `overspaces` - to get rid of too many spaces, leave only one space between words
+* `whitespaces` - to get rid of whitespaces in a value (i.e. `meta({title: "Page title", description: 'Page description'}, :html, :whitespaces)`)
+* `clean` - apply `html`, `overspaces` and `whitespaces` filters for a value
+
 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

data/lib/metanol/engine_controller.rb

@@ -31,23 +31,26 @@ module Metanol
 
       def add_meta_tag(type, *args)
         if args[0].is_a? Hash
+          filters = args[1..-1]
           args[0].each do |name, value|
-            add_meta_by_type type, name, value
+            add_meta_by_type type, name, value, filters
           end
-        elsif args.length == 2
+        else
           name = args[0].to_sym
-          value = args[1].to_sym
-          add_meta_by_type type, name, value
+          value = args[1]
+          filters = args[2..-1]
+          add_meta_by_type type, name, value, filters
         end
       end
 
-      def add_meta_by_type(type, name, value)
+      def add_meta_by_type(type, name, value, filters=[])
         data = meta_data(name)[type]
         key = data[:key]
         if metanol_options.key? key
           metanol_options[key].value = value
+          metanol_options[key].filters = filters
         else
-          metanol_options[key] = data[:type].new(name, value)
+          metanol_options[key] = data[:type].new(name, value, filters)
         end
       end
 

data/lib/metanol/meta/base.rb

@@ -4,21 +4,72 @@ module Metanol::Meta
     attr_reader :name
     attr_accessor :value
 
-    def initialize(name, value)
+    SUPPORTED_FILTERS = [:html, :overspaces, :whitespaces, :clean]
+
+    def initialize(name, value, filters=[])
       raise NameError.new "The meta tag '#{name}' isn't supported.", name unless valid?(name)
       @name = name
       @value = value
+      self.filters = filters
+    end
+
+    def filters=(value)
+      @filters = validate_filters(value)
     end
 
     def render
       raise StandardError.new "Please override this method in a child class"
     end
 
+    def self.filter_html(text)
+      text = text.gsub(/\<br\/?\>/, ' ')
+      text.gsub(/\<\/?\w+\/?\>/, '')
+    end
+
+    def self.filter_overspaces(text)
+      text.gsub(/[\ ]{2,}/, ' ')
+    end
+
+    def self.filter_whitespaces(text)
+      text.gsub(/\s/, ' ')
+    end
+
     protected
 
     def valid?(name)
       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
+
+    private
+
+    def validate_filters(filters=[])
+      result = []
+      raise StandardError.new("The filters parameter must be an Array.") unless filters.is_a?(Array)
+      begin
+        filters.each do |filter|
+          filter_value = filter.to_sym
+          StandardError.new("Only #{SUPPORTED_FILTERS.join(', ')} filters are supported.") unless SUPPORTED_FILTERS.include? filter_value
+          result << filter_value
+        end
+      rescue NoMethodError
+        raise StandardError.new("The filters parameter must includes only string or symbol values.")
+      end
+      result
+    end
+
   end
 
 end

data/lib/metanol/meta/main.rb

@@ -2,7 +2,8 @@ module Metanol::Meta
 
   class Main < Base
     def render
-      "<meta name=\"#{@name}\" content=\"#{@value}\" />"
+      return "<title>#{filtered_value}</title>" if @name == :title
+      "<meta name=\"#{@name}\" content=\"#{filtered_value}\" />"
     end
   end
 

data/lib/metanol/meta/open_graph.rb

@@ -1,21 +1,13 @@
 module Metanol::Meta
 
   class OpenGraph < Base
-    SUPPORT_TAGS = [:title, :description, :url, :type, :locale, :site_name, :image]
-
     def render
-      "<meta property=\"og:#{@name}\" content=\"#{@value}\" />"
+      "<meta property=\"og:#{@name}\" content=\"#{filtered_value}\" />"
     end
 
     def self.render_current_url(url)
       "<meta property=\"og:url\" content=\"#{url}\" />"
     end
-
-    protected
-
-    def valid?(name)
-      SUPPORT_TAGS.include? name.to_sym
-    end
   end
 
 end

data/lib/metanol/meta/webmaster.rb

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

data/lib/metanol/version.rb

@@ -1,3 +1,3 @@
 module Metanol
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/controllers/tests_controller_spec.rb

@@ -20,7 +20,7 @@ describe TestsController do
 
     it { response.should_not have_selector('meta[content="OpenGraph Title"]', property: 'og:title') }
     it { response.should_not have_selector('meta[content="OpenGraph Description"]', property: 'og:description') }
-    it { response.should have_selector('meta[content="Users List"]', name: 'title') }
+    it { response.should have_selector('title', content: 'Users List') }
     it { response.should have_selector('meta[content="Description for a users list"]', name: 'description') }
   end
 
@@ -40,7 +40,7 @@ describe TestsController do
 
     it { response.should have_selector('meta[content="OpenGraph Title"]', property: 'og:title') }
     it { response.should have_selector('meta[content="OpenGraph Description"]', property: 'og:description') }
-    it { response.should_not have_selector('meta[content="Users List"]', name: 'title') }
+    it { response.should_not have_selector('title', content: 'Users List') }
     it { response.should_not have_selector('meta[content="Description for a users list"]', name: 'description') }
   end
 
@@ -60,7 +60,7 @@ describe TestsController do
 
     it { response.should have_selector('meta[content="OpenGraph Title"]', property: 'og:title') }
     it { response.should have_selector('meta[content="OpenGraph Description"]', property: 'og:description') }
-    it { response.should have_selector('meta[content="Users List"]', name: 'title') }
+    it { response.should have_selector('title', content: 'Users List') }
     it { response.should have_selector('meta[content="Description for a users list"]', name: 'description') }
   end
 
@@ -68,7 +68,7 @@ describe TestsController do
     controller do
       def index
         meta :title, "Users List"
-        og_meta fake: "OpenGraph Description"
+        wm_meta fake: "Fake value"
         render :inline => <<-ERB
           <%= metanol_tags %>
         ERB
@@ -78,4 +78,79 @@ describe TestsController do
     it { expect { get :index }.to raise_error(NameError, "The meta tag 'fake' isn't supported.") }
   end
 
+  context "filter whitespaces" do
+    controller do
+      def index
+        meta :description, "Description \t\nfor \ta \tusers \r\nlist", :whitespaces
+        render :inline => <<-ERB
+          <%= metanol_main_tags %>
+        ERB
+      end
+    end
+
+    before { get :index }
+
+    it('success') { response.should have_selector('meta[content="Description   for  a  users   list"]', name: 'description') }
+  end
+
+  context "filter HTML tags" do
+    controller do
+      def index
+        meta({description: "<div>Description <br/>for <b>a users</b> <br>list</div>", keywords: "key,word"}, :html)
+        render :inline => <<-ERB
+          <%= metanol_main_tags %>
+        ERB
+      end
+    end
+
+    before { get :index }
+
+    it('success') { response.should have_selector('meta[content="Description  for a users  list"]', name: 'description') }
+  end
+
+  context "filter HTML tags and whitespaces" do
+    controller do
+      def index
+        meta(:description, "<div>\tDescription \r\n<br/>for \t<b>a users</b> \r\n<br>list</div>", :html, :whitespaces)
+        render :inline => <<-ERB
+          <%= metanol_main_tags %>
+        ERB
+      end
+    end
+
+    before { get :index }
+
+    it('success') { response.should have_selector('meta[content=" Description    for  a users    list"]', name: 'description') }
+  end
+
+  context "filter spaces - leave only 1 space between words" do
+    controller do
+      def index
+        meta :description, "Description   for    a users     list", :overspaces
+        render :inline => <<-ERB
+          <%= metanol_main_tags %>
+        ERB
+      end
+    end
+
+    before { get :index }
+
+    it('success') { response.should have_selector('meta[content="Description for a users list"]', name: 'description') }
+  end
+
+  context "clean up a value from whitespaces, html tags etc (run all filters)" do
+    controller do
+      def index
+        meta(:description, "<div>\tDescription \r\n<br/>for \t<b>a users</b> \r\n<br>list</div>", :clean)
+        render :inline => <<-ERB
+          <%= metanol_main_tags %>
+        ERB
+      end
+    end
+
+    before { get :index }
+
+    it { response.should have_selector('meta[content=" Description for a users list"]', name: 'description') }
+  end
+
 end

data/spec/support/application.rb

@@ -1,4 +1,3 @@
-#require 'rails/all'
 require 'action_controller/railtie'
 require 'action_view/railtie'
 require 'active_record'
@@ -24,9 +23,8 @@ class ApplicationController < ActionController::Base; end
 
 class ParentController < ApplicationController
   wm_meta :alexa,   'alexa code'
-  wm_meta :bing,    'bing code'
-  wm_meta :google,  'google code'
   wm_meta :yandex,  'yandex code'
+  wm_meta bing: 'bing code', google: 'google code'
 end
 
 class HomeController < ParentController

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metanol
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-17 00:00:00.000000000 Z
+date: 2013-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails