metanol 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/
+log/

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in metanol.gemspec
+gemspec
+
+group :test do
+  gem 'rspec', "~> 2.14.0", require: nil
+  gem 'rspec-rails', "~> 2.14.0", require: nil
+  gem 'sqlite3', '>= 0'
+  gem 'webrat', '>= 0'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eugene Kondratyuk
+
+MIT License
+
+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.md

@@ -0,0 +1,73 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'metanol'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metanol
+
+## Usage
+
+There are two ways to set meta tags. The first one is a setting values for meta tags in a controller:
+    
+```ruby
+class HomeController < ApplicationController
+  og_meta :type,    'website'
+  og_meta :locale,  'uk_UA'
+
+  wm_meta :alexa,   'alexa code'
+  wm_meta :bing,    'bing code'
+  wm_meta :google,  'google code'
+  wm_meta :yandex,  'yandex code'
+
+  def new
+    render :inline => <<-ERB
+      <%= metanol_wm_tags %>
+    ERB
+  end
+end
+```
+
+The second one is a setting values for meta tags in a controller's action:  
+
+```ruby
+class TestsController < ApplicationController
+  def index
+    meta :title, "Users List"
+    meta :description, "Description for a users list"
+    og_meta title: "OpenGraph Title", description: "OpenGraph Description"
+    render :inline => <<-ERB
+      <%= metanol_main_tags %>
+    ERB
+  end
+end
+```
+
+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
+
+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_main_tags` - renders other meta tags, such as keywords, description, etc.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/metanol.rb

@@ -0,0 +1,8 @@
+require 'metanol/version'
+
+require 'rails'
+
+require 'metanol/helpers'
+require 'metanol/engine_controller'
+require 'metanol/railtie'
+require 'metanol/engine'

data/lib/metanol/engine.rb

@@ -0,0 +1,4 @@
+module Metanol
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/metanol/engine_controller.rb

@@ -0,0 +1,81 @@
+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
+
+  # Engine's controller which has all methods for storing and processing meta tag's data
+  module EngineController
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def metanol_options
+        @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
+
+      private
+
+      def add_meta_tag(type, *args)
+        if args[0].is_a? Hash
+          args[0].each do |name, value|
+            add_meta_by_type type, name, value
+          end
+        elsif args.length == 2
+          name = args[0].to_sym
+          value = args[1].to_sym
+          add_meta_by_type type, name, value
+        end
+      end
+
+      def add_meta_by_type(type, name, value)
+        data = meta_data(name)[type]
+        key = data[:key]
+        if metanol_options.key? key
+          metanol_options[key].value = value
+        else
+          metanol_options[key] = data[:type].new(name, value)
+        end
+      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 }
+        }
+      end
+    end
+
+    def meta(*args)
+      self.class.meta(*args)
+    end
+
+    def og_meta(*args)
+      self.class.og_meta(*args)
+    end
+
+    def wm_meta(*args)
+      self.class.wm_meta(*args)
+    end
+
+    def metanol_options
+      self.class.metanol_options
+    end
+
+  end
+
+end

data/lib/metanol/helpers.rb

@@ -0,0 +1,46 @@
+module Metanol
+  module Helpers
+
+    # Render all meta tags
+    def metanol_tags
+      result = metanol_main_tags
+      result << metanol_og_tags
+      result << metanol_wm_tags
+      result
+    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
+    end
+
+    # Render Webmaster verification tags
+    def metanol_wm_tags
+      metanol_render_tags ::Metanol::Meta::Webmaster
+    end
+
+    # Render main tags, such as keywords, description, etc.
+    def metanol_main_tags
+      metanol_render_tags ::Metanol::Meta::Main
+    end
+
+    # Return a current URL
+    def current_url
+      request.original_url
+    end
+
+    private
+
+    def metanol_render_tags(type)
+      result = ""
+      self.controller.metanol_options.each_value do |value|
+        next unless value.is_a? type
+        result << value.render
+      end
+      result.html_safe
+    end
+
+  end
+end

data/lib/metanol/meta/base.rb

@@ -0,0 +1,24 @@
+module Metanol::Meta
+
+  class Base
+    attr_reader :name
+    attr_accessor :value
+
+    def initialize(name, value)
+      raise NameError.new "The meta tag '#{name}' isn't supported.", name unless valid?(name)
+      @name = name
+      @value = value
+    end
+
+    def render
+      raise StandardError.new "Please override this method in a child class"
+    end
+
+    protected
+
+    def valid?(name)
+      true
+    end
+  end
+
+end

data/lib/metanol/meta/main.rb

@@ -0,0 +1,9 @@
+module Metanol::Meta
+
+  class Main < Base
+    def render
+      "<meta name=\"#{@name}\" content=\"#{@value}\" />"
+    end
+  end
+
+end

data/lib/metanol/meta/open_graph.rb

@@ -0,0 +1,21 @@
+module Metanol::Meta
+
+  class OpenGraph < Base
+    SUPPORT_TAGS = [:title, :description, :url, :type, :locale, :site_name, :image]
+
+    def render
+      "<meta property=\"og:#{@name}\" content=\"#{@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

@@ -0,0 +1,22 @@
+module Metanol::Meta
+  class Webmaster < Base
+
+    SUPPORT_TAGS = {
+        yandex: 'yandex-verification',
+        google: 'google-site-verification',
+        bing: 'msvalidate.01',
+        alexa: 'alexaVerifyID'
+    }
+
+    def render
+      "<meta name=\"#{SUPPORT_TAGS[@name]}\" content=\"#{@value}\" />"
+    end
+
+    protected
+
+    def valid?(name)
+      !SUPPORT_TAGS[name.to_sym].nil?
+    end
+
+  end
+end

data/lib/metanol/railtie.rb

@@ -0,0 +1,8 @@
+module Metanol
+  class Railtie < ::Rails::Railtie #:nodoc:
+    initializer 'metanolize' do |app|
+      ::ActionView::Base.send :include, Metanol::Helpers
+      ::ActionController::Base.send :include, Metanol::EngineController
+    end
+  end
+end

data/lib/metanol/version.rb

@@ -0,0 +1,3 @@
+module Metanol
+  VERSION = "0.0.1"
+end

data/metanol.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metanol/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "metanol"
+  gem.version       = Metanol::VERSION
+  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.homepage      = "https://github.com/ekondr/metanol"
+
+  gem.rubyforge_project = 'metanol'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.licenses = ['MIT']
+
+  gem.add_dependency "rails", "~> 3.2"
+end

data/spec/controllers/home_controller_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe HomeController do
+  context "render meta tags with some global ones" do
+
+    context "all meta tags" do
+      before { get :index }
+
+      it { response.should have_selector("meta[content=\"#{url_for(controller: :home, action: :index, host: 'test.host')}\"]", property: 'og:url') }
+      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="website"]', property: 'og:type') }
+      it { response.should have_selector('meta[content="uk_UA"]', property: 'og:locale') }
+      it { response.should have_selector('meta[content="bing code"]', name: 'msvalidate.01') }
+      it { response.should have_selector('meta[content="alexa code"]', name: 'alexaVerifyID') }
+      it { response.should have_selector('meta[content="google code"]', name: 'google-site-verification') }
+      it { response.should have_selector('meta[content="yandex code"]', name: 'yandex-verification') }
+    end
+
+    context "only WebMaster's meta tags" do
+      before { get :new }
+
+      it { response.should_not have_selector('meta[content="website"]', property: 'og:type') }
+      it { response.should_not have_selector('meta[content="uk_UA"]', property: 'og:locale') }
+      it { response.should have_selector('meta[content="bing code"]', name: 'msvalidate.01') }
+      it { response.should have_selector('meta[content="alexa code"]', name: 'alexaVerifyID') }
+      it { response.should have_selector('meta[content="google code"]', name: 'google-site-verification') }
+      it { response.should have_selector('meta[content="yandex code"]', name: 'yandex-verification') }
+    end
+
+  end
+end

data/spec/controllers/tests_controller_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+class TestsController < ApplicationController; end
+
+describe TestsController do
+
+  context "render only main meta tags" do
+    controller do
+      def index
+        meta :title, "Users List"
+        meta :description, "Description for a users list"
+        og_meta title: "OpenGraph Title", description: "OpenGraph Description"
+        render :inline => <<-ERB
+          <%= metanol_main_tags %>
+        ERB
+      end
+    end
+
+    before { get :index }
+
+    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('meta[content="Description for a users list"]', name: 'description') }
+  end
+
+  context "render only open graph meta tags" do
+    controller do
+      def index
+        meta :title, "Users List"
+        meta :description, "Description for a users list"
+        og_meta title: "OpenGraph Title", description: "OpenGraph Description"
+        render :inline => <<-ERB
+          <%= metanol_og_tags %>
+        ERB
+      end
+    end
+
+    before { get :index }
+
+    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('meta[content="Description for a users list"]', name: 'description') }
+  end
+
+  context "render all meta tags" do
+    controller do
+      def index
+        meta :title, "Users List"
+        meta :description, "Description for a users list"
+        og_meta title: "OpenGraph Title", description: "OpenGraph Description"
+        render :inline => <<-ERB
+          <%= metanol_tags %>
+        ERB
+      end
+    end
+
+    before { get :index }
+
+    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('meta[content="Description for a users list"]', name: 'description') }
+  end
+
+  context "raise exception for unsupported metas" do
+    controller do
+      def index
+        meta :title, "Users List"
+        og_meta fake: "OpenGraph Description"
+        render :inline => <<-ERB
+          <%= metanol_tags %>
+        ERB
+      end
+    end
+
+    it { expect { get :index }.to raise_error(NameError, "The meta tag 'fake' isn't supported.") }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rails'
+require 'rspec/autorun'
+require 'metanol'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+require 'rspec/rails'
+
+RSpec.configure do |config|
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+
+  config.include Rails.application.routes.url_helpers
+end

data/spec/support/application.rb

@@ -0,0 +1,48 @@
+#require 'rails/all'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'active_record'
+
+ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database => ':memory:'}}
+ActiveRecord::Base.establish_connection('test')
+
+app = Class.new(Rails::Application)
+app.config.secret_token = "f974ebb750a8e200c85f7a749d589fa2"
+app.config.session_store :cookie_store, :key => "_myapp_session"
+app.config.active_support.deprecation = :log
+app.config.eager_load = false
+app.config.root = File.dirname(__FILE__)
+Rails.backtrace_cleaner.remove_silencers!
+app.initialize!
+
+app.routes.draw do
+  resources :tests
+  resources :home
+end
+
+class ApplicationController < ActionController::Base; end
+
+class HomeController < ApplicationController
+  og_meta :type,    'website'
+  og_meta :locale,  'uk_UA'
+
+  wm_meta :alexa,   'alexa code'
+  wm_meta :bing,    'bing code'
+  wm_meta :google,  'google code'
+  wm_meta :yandex,  'yandex code'
+
+  def new
+    render :inline => <<-ERB
+      <%= metanol_wm_tags %>
+    ERB
+  end
+
+  def index
+    og_meta title: "OpenGraph Title", description: "OpenGraph Description"
+    render :inline => <<-ERB
+      <%= metanol_tags %>
+    ERB
+  end
+end
+
+Object.const_set(:ApplicationHelper, Module.new)

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: metanol
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eugene Kondratyuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        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
+email:
+- ekondr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/metanol.rb
+- lib/metanol/engine.rb
+- lib/metanol/engine_controller.rb
+- lib/metanol/helpers.rb
+- lib/metanol/meta/base.rb
+- lib/metanol/meta/main.rb
+- lib/metanol/meta/open_graph.rb
+- lib/metanol/meta/webmaster.rb
+- lib/metanol/railtie.rb
+- lib/metanol/version.rb
+- metanol.gemspec
+- spec/controllers/home_controller_spec.rb
+- spec/controllers/tests_controller_spec.rb
+- spec/spec_helper.rb
+- spec/support/application.rb
+homepage: https://github.com/ekondr/metanol
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: metanol
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+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
+- spec/spec_helper.rb
+- spec/support/application.rb