RubyGems - seo_rails_helpers - Versions diffs - 0.1.0 - Mend

seo_rails_helpers 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

checksums.yaml +7 -0
data/.gitignore +10 -0
data/.rspec +2 -0
data/.travis.yml +3 -0
data/CHANGELOG.md +3 -0
data/Gemfile +4 -0
data/LICENSE.txt +21 -0
data/README.md +72 -0
data/Rakefile +1 -0
data/bin/console +14 -0
data/bin/setup +7 -0
data/lib/seo_rails_helpers/helpers/seo_page_title_helper.rb +23 -0
data/lib/seo_rails_helpers/railtie.rb +9 -0
data/lib/seo_rails_helpers/version.rb +3 -0
data/lib/seo_rails_helpers.rb +6 -0
data/seo_rails_helpers.gemspec +25 -0
metadata +101 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e00c828025913363293db9eab7e239621ae2d2c7
+  data.tar.gz: b4b0cd7735af4cfb4c27e5a4e46b7e055e508cf5
+SHA512:
+  metadata.gz: 8db37a200d19a826aa5536be6c6a0eec843c88b3e21ad12660420b8f665c68106072dd64d01a0b803d841d00065523149dd07bcbee0bfccc64ba8eb8eba9c5b1
+  data.tar.gz: 54fb4cfe7473baaec172ea9a46d48e8d54ed757cff727e4b1796973b94338be9f2152f9ac7422e49e7d898904678b10fcd7f192cbf488073ae3e12c88483119d

data/.gitignore ADDED Viewed

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/log/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ --format documentation
2	+ --color

data/.travis.yml ADDED Viewed

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,3 @@
+## 0.1.0 (2015-07-16)
+- Initial release

data/Gemfile ADDED Viewed

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

data/LICENSE.txt ADDED Viewed

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2015 Dmitriy Tarasov
+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 ADDED Viewed

@@ -0,0 +1,72 @@
+# SEO Rails Helpers
+Collection of view helpers to improve search engine optimization of Ruby on Rails application.
+## Installation
+Add this line to your Rails application's Gemfile:
+```ruby
+gem 'seo_rails_helpers'
+```
+And then execute `bundle` command to install.
+## Usage
+### 1. seo_page_title
+This helper will produce SEO friendly page title. It assumes you are using either `content_for` or `provide` helper in your page view to store page title.
+Include `seo_page_title` in the `<head>` section of your layout
+ERB example:
+```erb
+<head>
+  <%= seo_page_title %>
+  <%# other elements %>
+</head>
+```
+Haml example:
+```haml
+%head
+  seo_page_title
+  -# other elements
+```
+This will create HTML title element:
+```html
+<title>Page Title | Base Title</title>
+```
+Exact format of title element will vary based on user-specific options.
+#### seo_page_title options
+| Name | Description | Default
+| ----------- | ------------------------|-----------
+| ```:page_title```| Identifier for stored page title. Specify symbol representing identifier in your ```provide``` or ```content_for``` method. | ```:title```
+| ```:separator``` | Character that separates `:page_title` and `:base_title` | \|
+| ```:base_title```| Base title, like your brand or app name. In case `:page_title` is missing or empty the title will consist of `:base_title` only.  | Your Rails application name
+#### example seo_page_title usage
+```ruby
+provide(:page_title, 'Example Page')
+```
+```ruby
+seo_page_title(page_title: :page_title,
+               separator: '>',
+               base_title: 'Example Site')
+```
+Will produce following title element:
+```html
+<title>Example Page &gt; Example Site</title>
+```
+## Contributing
+Fork the project and submit a pull request.

data/Rakefile ADDED Viewed

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

data/bin/console ADDED Viewed

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'seo_rails_helpers'
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+require 'irb'
+IRB.start

data/bin/setup ADDED Viewed

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+bundle install
+# Do any other automated setup that you need to do here

data/lib/seo_rails_helpers/helpers/seo_page_title_helper.rb ADDED Viewed

@@ -0,0 +1,23 @@
+module SeoRailsHelpers
+  module SeoPageTitleHelper
+    # Produces html title element
+    def seo_page_title(options = {})
+      page_title = content_for(options[:page_title] || :title)
+      separator  = options[:separator] || '|'
+      base_title = options[:base_title] || default_base_title
+      if page_title.present?
+        content_tag(:title, page_title + ' ' + separator + ' ' + base_title)
+      else
+        content_tag(:title, base_title)
+      end
+    end
+    private
+      # Returns Rails application name as default base title
+      def default_base_title
+        Rails.application.class.to_s.split('::').first
+      end
+  end
+end

data/lib/seo_rails_helpers/railtie.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module SeoRailsHelpers
+  class Railtie < Rails::Railtie
+    initializer 'seo_page_title.helper' do
+      ActiveSupport.on_load :action_view do
+        include SeoRailsHelpers::SeoPageTitleHelper
+      end
+    end
+  end
+end

data/lib/seo_rails_helpers/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module SeoRailsHelpers
+  VERSION = '0.1.0'
+end

data/lib/seo_rails_helpers.rb ADDED Viewed

@@ -0,0 +1,6 @@
+require 'seo_rails_helpers/version'
+require 'seo_rails_helpers/helpers/seo_page_title_helper'
+require 'seo_rails_helpers/railtie' if defined? Rails
+module SeoRailsHelpers
+end

data/seo_rails_helpers.gemspec ADDED Viewed

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seo_rails_helpers/version'
+Gem::Specification.new do |spec|
+  spec.name          = 'seo_rails_helpers'
+  spec.version       = SeoRailsHelpers::VERSION
+  spec.authors       = ['Dmitriy Tarasov']
+  spec.email         = ['info@rubysamurai.com']
+  spec.summary       = 'Rails view helpers for search engine optimization (SEO)'
+  spec.description   = 'Rails view helpers for search engine optimization (SEO)'
+  spec.homepage      = 'https://github.com/rubysamurai/seo_rails_helpers'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.3'
+end

metadata ADDED Viewed

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: seo_rails_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitriy Tarasov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2015-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Rails view helpers for search engine optimization (SEO)
+email:
+- info@rubysamurai.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/seo_rails_helpers.rb
+- lib/seo_rails_helpers/helpers/seo_page_title_helper.rb
+- lib/seo_rails_helpers/railtie.rb
+- lib/seo_rails_helpers/version.rb
+- seo_rails_helpers.gemspec
+homepage: https://github.com/rubysamurai/seo_rails_helpers
+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.4.7
+signing_key:
+specification_version: 4
+summary: Rails view helpers for search engine optimization (SEO)
+test_files: []