meta_tags_simple_builder 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 950fa43cfbbd0d45632ae46f14584ea680e86e3a
+  data.tar.gz: fb069df511360abd24d1adf826c8e45b7e69f81b
+SHA512:
+  metadata.gz: e20772cc6bd8694d6512d061baa809e63fb82d8ba5261ff9d0e39bf196c7acae6848cad4ec6335a47d36938c1cf040712c9253df78c048b3966c9b9f14fb39e4
+  data.tar.gz: c573a37b16772bceb001b95d805fe00af64dcdd8857ad0d84c1c9e5448f708135c558bf26d16cd2e902423aa718aa5ed2cffcf1249791d7205a07cc97f3c9b72

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in meta_tags_simple_builder.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Marat Khusnetdinov
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Marat Khusnetdinov
+
+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,128 @@
+# MetaTagsSimpleBuilder
+
+Gem allow you to simply create seo friendly custom meta tags, blocks of meta tags. 
+
+## Dependency
+
+    rails >= 4.0.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'meta_tags_simple_builder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install meta_tags_simple_builder
+
+## Usage for stand alone meta, link tags
+
+### Title
+   
+    <%= title_meta_tag('MetaTagsSimpleBuilder gem page.')%>
+    # <title>MetaTagsSimpleBuilder gem page.</title>
+   
+Use title for layout helper if you want to set title for application from view and caption view name:
+
+    # application.html
+    
+    <%= title_meta_tag(yield(:title))%>
+    # <title>Title for application from view.html</title>
+    
+    # views.html
+    
+    <h1>
+      <%= title_for_layout('Title for application from view.html')%>
+    </h1>
+    # <h1>Title for application from view.html</h1>
+    
+### Charset
+
+    <%= charset_meta_tag('utf-16')%>
+    # <meta charset="utf-16" />
+    
+### Http equiv data
+
+    <%= http_equiv_meta_tag('X-UA-Compatible', 'IE=Edge')%>
+    # <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
+
+### Author
+
+    <%= author_meta_tag('Marat Khusnetdinov')%>
+    # <meta content="Marat Khusnetdinov" name="author" />
+    
+### Keywords
+
+    <%= keywords_meta_tag(['gem', 'rails'])%>
+    <%= keywords_meta_tag('gem, rails')%>
+    # <meta content="gem, rails" name="keywords" />
+    
+### Description
+
+    <%= description_meta_tag('Gem for simply creating meta tags, blocks of meta tags')%>
+    # <meta content="Gem for simply creating meta tags, blocks of meta tags" name="description" />')
+
+### Viewport
+    
+    <%= viewport_meta_tag('width=1')
+    # <meta content="width=1" name="viewport" />'
+    
+    <%= viewport_meta_tag(['width=1', 'scale=1'])
+    # <meta content="width=1, scale=1" name="viewport" />'
+
+### Customs meta tag, robots, nofollow examples
+
+This helper helps you to set meta tag with custom name:
+
+    <%= meta_tag_for :robots, 'noindex'>
+    # <meta content="noindex" name="robots" />
+    
+Use custom meta tags if you want more flexibility:
+
+    <%= custom_meta_tag_for(:custom_property, 'cutstom content', custom_options: 'custom content for options')%>
+    # <meta custom-property="cutstom content" custom-options="custom content for options" />
+    
+Notice: "_" underscore in attributes simbol names will be rendered to "-" dash
+
+### Links
+
+    <%= link_tag_for :canonical, url: 'http://github.com', type: 'web')%>
+    # <link rel="canonical" url="http://github.com" type="web" />')
+
+## Usage for meta, link tags blocks
+
+Blocks helpers are used than you need render collection meta tags. It takes a hash, which you can create in controller.rb:
+
+    # somewhere in controller we create and want to render this:
+    @meta = { title: 'Page title', charset: 'utf-16', author: 'John Doe', namespace: { title: 'content', attr_name: :property} }
+    
+    # application.html
+    
+    <%= meta_tags_block_for(@meta)%>
+    # <title>Page title</title>
+    # <meta charset="utf-16" />
+    # <meta content="John Doe" name="author" />
+    # <meta content="content" property="namespace:title" />
+    
+Notice: If you pass a pair key: :value with value as hash, key: will be the namespace of name attribute. For change 'name' attribute pass options :attr_name. 
+
+Links block have options:
+
+    @links = { prev: { href: 'http://github.com/prev', type: 'web' }, next: { href: 'http://github.com/next'} }
+    
+    <%= link_tags_block_for(@links)%>
+    # <link href="http://github.com/prev" rel="prev" type="web" />
+    # <link href="http://github.com/next" rel="next" />
+    
+## 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/meta_tags_simple_builder.rb

@@ -0,0 +1,7 @@
+require 'meta_tags_simple_builder/version'
+require 'meta_tags_simple_builder/view_helper'
+
+module MetaTagsSimpleBuilder
+end
+
+require 'meta_tags_simple_builder/railtie' if defined?(Rails)

data/lib/meta_tags_simple_builder/railtie.rb

@@ -0,0 +1,11 @@
+require 'meta_tags_simple_builder/view_helper'
+
+module MetaTagsSimpleBuilder
+
+  class Railtie < Rails::Railtie
+
+    initializer 'meta_tags_simple_builder.view_helper' do
+      ActionView::Base.send :include, ViewHelper
+    end
+  end
+end

data/lib/meta_tags_simple_builder/version.rb

@@ -0,0 +1,3 @@
+module MetaTagsSimpleBuilder
+  VERSION = "0.1.2"
+end

data/lib/meta_tags_simple_builder/view_helper.rb

@@ -0,0 +1,119 @@
+module MetaTagsSimpleBuilder
+
+  module ViewHelper
+
+    include ActionView::Helpers   
+
+    def title_for_layout(title)
+      content_for :title, title
+      title
+    end
+
+    def title_meta_tag(title)
+      content_tag :title, title
+    end
+
+    def charset_meta_tag(charset)
+      meta_tag charset: charset
+    end
+
+    def http_equiv_meta_tag(name, content)
+      meta_tag http_equiv: name, content: content
+    end
+
+    def author_meta_tag(content)
+      meta_tag_for :author, content
+    end
+
+    def keywords_meta_tag(content)
+      meta_tag_for :keywords, normalized(content)
+    end
+
+    def description_meta_tag(content)
+      meta_tag_for :description, content
+    end
+
+    def viewport_meta_tag(content)
+      meta_tag_for :viewport, normalized(content)
+    end
+
+    def meta_tag_for(name, content)
+      meta_tag name: name, content: content
+    end
+
+    def custom_meta_tag_for(name, content, options = {})
+      options[name] = content
+      meta_tag options
+    end
+
+    def meta_tags_block_for(options = {})
+      return unless options.is_a?(Hash)
+      tags = []
+      tags << title_meta_tag(options.delete :title) if options.has_key?(:title)
+      tags << charset_meta_tag(options.delete :charset) if options.has_key?(:charset)
+      if options.has_key?(:http_equiv)
+        http_equiv = options.delete :http_equiv
+        tags << http_equiv_meta_tag(http_equiv[:name], http_equiv[:content])
+      end
+      options.each_pair do |k, v|
+        if v.is_a?(Hash)
+          attr_name = v.has_key?(:attr_name) ? v.delete(:attr_name) : :property
+          tags.concat(plane_option k, v, attr_name)
+        else
+          tags << meta_tag_for(k.to_s.dasherize, v)
+        end
+      end
+      render_html_for tags
+    end
+
+    def link_tag_for(name, options = {})
+      options[:rel] = name
+      link_tag options
+    end
+
+    def link_tags_block_for(options = {})
+      return unless options.is_a?(Hash)
+      tags = []
+      options.each_pair { |k, v| tags << link_tag_for(k, v) }
+      render_html_for tags
+    end
+
+
+    private
+
+    def meta_tag(options = nil, escape = true)
+      "<meta#{tag_options(options, escape) if options} />".html_safe
+    end
+
+    def link_tag(options = {})
+      tag :link, options
+    end
+
+    def tag_options(options, escape = true)
+      return if options.blank?
+      attrs = []
+      options.each_pair { |k, v| attrs << tag_option(k.to_s.dasherize, v, escape) if v }
+      " #{attrs.sort * ' '}".html_safe unless attrs.empty?
+    end
+
+    def plane_option(key, val, attr_name)
+      tags = []
+      if val.is_a?(Hash)
+        val.each_pair { |k, v| tags.concat plane_option("#{key}:#{k}", v, attr_name) }
+      else
+        tags << meta_tag(attr_name => "#{key}", content: val)
+      end
+      tags
+    end
+
+    def normalized(content)
+      content = content.join(', ') if content.is_a?(Array)
+      content
+    end
+
+    def render_html_for(array_of_tags)
+      tags = array_of_tags.join('')
+      tags.respond_to?(:html_safe) ? tags.html_safe : tags
+    end
+  end
+end

data/meta_tags_simple_builder.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'meta_tags_simple_builder/version'
+
+Gem::Specification.new do |s|
+  s.name          = "meta_tags_simple_builder"
+  s.version       = MetaTagsSimpleBuilder::VERSION
+  s.authors       = ["Marat Khusnetdinov"]
+  s.email         = ["marat@khusnetdinov.ru"]
+  s.description   = %q{Gem allow you to simply create custom meta tags, blocks of seo friendly meta tags.}
+  s.summary       = %q{MetaTagsSimpleBuilder gem}
+  s.homepage      = ""
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rails", ">= 4.0.0"
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'bundler/setup'
+require 'action_view'
+require 'meta_tags_simple_builder'

data/spec/view_helper_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+class TestViewHelper
+  include MetaTagsSimpleBuilder::ViewHelper 
+end
+
+describe TestViewHelper do
+
+  let (:view_helper) { TestViewHelper.new }
+
+  describe 'title meta tag' do
+    it 'return title' do
+      expect(view_helper.title_meta_tag 'MetaTagSimpleBuilder').to eq('<title>MetaTagSimpleBuilder</title>')
+    end
+  end
+
+  describe 'charset meta tag' do
+    it 'return charset' do
+      expect(view_helper.charset_meta_tag 'utf-1024').to eq('<meta charset="utf-1024" />')
+    end
+  end
+
+  describe 'http equiv meta tag' do
+    it 'return http equiv' do
+      expect(view_helper.http_equiv_meta_tag 'X-UA', 'chrome=1').to eq('<meta content="chrome=1" http-equiv="X-UA" />')
+    end
+  end
+
+  describe 'author meta tag' do
+    it 'return author' do
+      expect(view_helper.author_meta_tag 'Marat Khusnetdinov').to eq('<meta content="Marat Khusnetdinov" name="author" />')
+    end
+  end
+
+  describe 'keyword meta tag' do
+    it 'string: return keywords from array' do
+      expect(view_helper.keywords_meta_tag ['gem','rails']).to eq('<meta content="gem, rails" name="keywords" />')
+    end
+
+    it 'array: return keywords' do
+      expect(view_helper.keywords_meta_tag 'gem rails').to eq('<meta content="gem rails" name="keywords" />')
+    end
+  end
+
+  describe 'description meta nag' do
+    it 'return description' do
+      expect(view_helper.description_meta_tag 'Gem creating meta tags').to eq('<meta content="Gem creating meta tags" name="description" />')
+    end
+  end
+
+  describe 'viewport meta tag' do
+    it 'return settings from array' do
+      expect(view_helper.viewport_meta_tag ['width=1', 'scale=1']).to eq('<meta content="width=1, scale=1" name="viewport" />')
+    end
+
+    it 'return settings' do
+      expect(view_helper.viewport_meta_tag 'width=1').to eq('<meta content="width=1" name="viewport" />')
+    end
+  end
+
+  describe 'meta tag for exist settings' do
+    it 'return meta tag with name attribute' do
+      expect(view_helper.meta_tag_for 'name', 'content').to eq('<meta content="content" name="name" />')
+    end
+  end
+
+  describe 'custom meta tag' do
+    it 'returns custom meta tag' do
+      expect(view_helper.custom_meta_tag_for :itemprop, 'content', http: 'www.com').to eq('<meta http="www.com" itemprop="content" />')
+    end
+  end
+
+  describe 'meta tags block for @variable' do
+    meta = { http_equiv: {name: 'X-UA', content: 'chrome=1'},
+             og: {type: 'First level', sub:{ type: 'Second'},
+                  attr_name: :itemprop}}
+
+    it 'return block of meta tags' do
+      expect(view_helper.meta_tags_block_for meta).to eq('<meta content="chrome=1" http-equiv="X-UA" /><meta content="First level" itemprop="og:type" /><meta content="Second" itemprop="og:sub:type" />')
+    end
+  end
+
+  describe 'link tag' do
+    it 'returns link tag' do
+      expect(view_helper.link_tag_for 'can', url: 'www', type: 'web').to eq('<link rel="can" type="web" url="www" />')
+    end
+  end
+
+  describe 'link tags block for @variable' do
+    link = {prev: {href: 'prev.com', type: 'link',
+                   custom_field: 'custom-content'},
+            can: {href: 'www'}}
+
+    it 'return link tags block for @variable' do
+      expect(view_helper.link_tags_block_for link).to eq('<link custom-field="custom-content" href="prev.com" rel="prev" type="link" /><link href="www" rel="can" />')
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: meta_tags_simple_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Marat Khusnetdinov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem allow you to simply create custom meta tags, blocks of seo friendly
+  meta tags.
+email:
+- marat@khusnetdinov.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/meta_tags_simple_builder.rb
+- lib/meta_tags_simple_builder/railtie.rb
+- lib/meta_tags_simple_builder/version.rb
+- lib/meta_tags_simple_builder/view_helper.rb
+- meta_tags_simple_builder.gemspec
+- spec/spec_helper.rb
+- spec/view_helper_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: MetaTagsSimpleBuilder gem
+test_files:
+- spec/spec_helper.rb
+- spec/view_helper_spec.rb