search-engine-optimization 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 258c5ac5446d779f00fc9b110f26fe5cd1ad5739ac57314ef9610a060db5d992
+  data.tar.gz: 6dfa24867ab4001e699e063a8a13f7c52631be4eeb30d18b3372c5a00dfd038d
+SHA512:
+  metadata.gz: b534e2972e55e06c1efc3d1f3475380d242d767ec115cd8c7a19cdfd8e46b885f117c154c84d5c45ee30e4c1e7b996d561561b1031cfa80c0d2ec9f29e1fa149
+  data.tar.gz: 775feca341c3c1298ea8b70c4b0f977f526381c0e195662a5b6224471941a29207e19d73225c055740a5c98427e0258b120579eb83a2f389ca4b890d60627e78

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 1.0.0 - 2018/01/27
+
+* initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jonas Hübotter
+
+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,118 @@
+# Search Engine Optimization
+
+[![Gem Version](https://badge.fury.io/rb/search-engine-optimization.svg)](https://badge.fury.io/rb/search-engine-optimization) <img src="https://travis-ci.org/jonhue/search-engine-optimization.svg?branch=master" />
+
+Advanced SEO for Rails apps with schema tags.
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#philosophy)
+    * [Meta tags](#meta-tags)
+    * [Schemas](#schemas)
+* [To Do](#to-do)
+* [Contributing](#contributing)
+    * [Contributors](#contributors)
+    * [Semantic versioning](#semantic-versioning)
+* [License](#license)
+
+---
+
+## Installation
+
+Search Engine Optimization works with Rails 5 onwards. You can add it to your `Gemfile` with:
+
+```ruby
+gem 'search-engine-optimization'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install search-engine-optimization
+
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'search-engine-optimization', github: 'jonhue/search-engine-optimization'
+```
+
+---
+
+## Usage
+
+### Meta tags
+
+Use [metamagic](https://github.com/lassebunk/metamagic) to add titles and descriptions to your views.
+
+### Schemas
+
+Search Engine Optimization assists you in creating schema tags that will enhance SERPs and click rates.
+
+Use the `seo/schema` component:
+
+```haml
+= component 'seo/schema', type: :article, options
+```
+
+Here is a list of available types:
+
+* [`:aggregate_rating`](components/schemas/aggregate_rating.md)
+* [`:article`](components/schemas/article.md)
+* [`:organization`](components/schemas/organization.md)
+* [`:person`](components/schemas/person.md)
+
+---
+
+## To Do
+
+[Here](https://github.com/jonhue/search-engine-optimization/projects/1) is the full list of current projects.
+
+To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/search-engine-optimization/issues/new).
+
+---
+
+## Contributing
+
+We hope that you will consider contributing to Search Engine Optimization. Please read this short overview for some information about how to get started:
+
+[Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
+
+### Contributors
+
+Give the people some :heart: who are working on this project. See them all at:
+
+https://github.com/jonhue/search-engine-optimization/graphs/contributors
+
+### Semantic Versioning
+
+Search Engine Optimization follows Semantic Versioning 2.0 as defined at http://semver.org.
+
+## License
+
+MIT License
+
+Copyright (c) 2018 Jonas Hübotter
+
+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/app/views/mozaic/seo/_schema.html.erb

@@ -0,0 +1,6 @@
+<script type="application/ld+json">
+{
+    "@context" : "http://schema.org",
+    <%= component "seo/schema/#{options[:type].underscore}", options %>
+}
+</script>

data/app/views/mozaic/seo/schema/_aggregate_rating.html.erb

@@ -0,0 +1,3 @@
+"@type" : "AggregateRating"
+
+<%= component 'seo/schema/properties/ratingValue', rating_value: options[:rating_value] %>

data/app/views/mozaic/seo/schema/_article.html.erb

@@ -0,0 +1,11 @@
+"@type" : "Article",
+"aggregateRating" : { <%= component 'seo/schema/aggregate_rating', options[:aggregate_rating] %> },
+"author" : { <%= component 'seo/schema/person', options[:author] %> },
+"publisher" : { <%= component 'seo/schema/organization', options[:publisher] %> }
+
+<%= component 'seo/schema/properties/articleBody', article_body: options[:article_body] %>
+<%= component 'seo/schema/properties/articleSection', article_section: options[:article_section] %>
+<%= component 'seo/schema/properties/datePublished', date_published: options[:date_published] %>
+<%= component 'seo/schema/properties/image', image: options[:image] %>
+<%= component 'seo/schema/properties/name', name: options[:name] %>
+<%= component 'seo/schema/properties/url', url: options[:url] %>

data/app/views/mozaic/seo/schema/_organization.html.erb

@@ -0,0 +1,3 @@
+"@type" : "Organization"
+
+<%= component 'seo/schema/properties/name', name: options[:name] %>

data/app/views/mozaic/seo/schema/_person.html.erb

@@ -0,0 +1,3 @@
+"@type" : "Person"
+
+<%= component 'seo/schema/properties/name', name: options[:name] %>

data/app/views/mozaic/seo/schema/properties/_articleBody.html.erb

@@ -0,0 +1 @@
+, "articleBody": "<%= options[:article_body] %>"

data/app/views/mozaic/seo/schema/properties/_articleSection.html.erb

@@ -0,0 +1 @@
+, "articleSection": "<%= options[:article_section] %>"

data/app/views/mozaic/seo/schema/properties/_datePublished.html.erb

@@ -0,0 +1 @@
+, "datePublished": "<%= options[:date_published] %>"

data/app/views/mozaic/seo/schema/properties/_image.html.erb

@@ -0,0 +1 @@
+, "image": "<%= options[:image] %>"

data/app/views/mozaic/seo/schema/properties/_name.html.erb

@@ -0,0 +1 @@
+, "name": "<%= options[:name] %>"

data/app/views/mozaic/seo/schema/properties/_ratingValue.html.erb

@@ -0,0 +1 @@
+, "ratingValue": "<%= options[:rating_value] %>"

data/app/views/mozaic/seo/schema/properties/_url.html.erb

@@ -0,0 +1 @@
+, "url": "<%= options[:url] %>"

data/lib/search-engine-optimization.rb

@@ -0,0 +1,8 @@
+require 'search_engine_optimization/version'
+
+module SearchEngineOptimization
+
+    require 'search_engine_optimization/engine'
+    require 'search_engine_optimization/railtie'
+
+end

data/lib/search_engine_optimization/engine.rb

@@ -0,0 +1,6 @@
+require 'rails/railtie'
+
+module SearchEngineOptimization
+    class Engine < ::Rails::Engine
+    end
+end

data/lib/search_engine_optimization/railtie.rb

@@ -0,0 +1,49 @@
+require 'mozaic'
+require 'rails/railtie'
+
+module SearchEngineOptimization
+    class Railtie < Rails::Railtie
+
+        include ActionView::Helpers::AssetUrlHelper
+
+        initializer 'search-engine-optimization.mozaic' do
+            Mozaic.configure do |config|
+
+                config.define_component 'seo/schema' do |options|
+                    false if options[:type].nil?
+                end
+
+                config.define_component 'seo/schema/aggregate_rating'
+                config.define_component 'seo/schema/article'
+                config.define_component 'seo/schema/organization'
+                config.define_component 'seo/schema/person'
+
+                config.define_component 'seo/schema/properties/articleBody' do |options|
+                    false if options[:article_body].nil?
+                end
+                config.define_component 'seo/schema/properties/articleSection' do |options|
+                    false if options[:article_section].nil?
+                end
+                config.define_component 'seo/schema/properties/datePublished' do |options|
+                    options[:date_published] = options[:date_published]&.iso8601
+                    false if options[:date_published].nil?
+                end
+                config.define_component 'seo/schema/properties/image' do |options|
+                    options[:image] = image_url options[:image] unless options[:image].nil? || options[:image].include?('http')
+                    false if options[:image].nil?
+                end
+                config.define_component 'seo/schema/properties/name' do |options|
+                    false if options[:name].nil?
+                end
+                config.define_component 'seo/schema/properties/ratingValue' do |options|
+                    false if options[:rating_value].nil?
+                end
+                config.define_component 'seo/schema/properties/url' do |options|
+                    false if options[:url].nil?
+                end
+
+            end
+        end
+
+    end
+end

data/lib/search_engine_optimization/version.rb

@@ -0,0 +1,5 @@
+module SearchEngineOptimization
+
+    VERSION = '1.0.0'
+
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: search-engine-optimization
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonas Hübotter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mozaic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: Advanced SEO for Rails apps with schema tags.
+email: me@jonhue.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- app/views/mozaic/seo/_schema.html.erb
+- app/views/mozaic/seo/schema/_aggregate_rating.html.erb
+- app/views/mozaic/seo/schema/_article.html.erb
+- app/views/mozaic/seo/schema/_organization.html.erb
+- app/views/mozaic/seo/schema/_person.html.erb
+- app/views/mozaic/seo/schema/properties/_articleBody.html.erb
+- app/views/mozaic/seo/schema/properties/_articleSection.html.erb
+- app/views/mozaic/seo/schema/properties/_datePublished.html.erb
+- app/views/mozaic/seo/schema/properties/_image.html.erb
+- app/views/mozaic/seo/schema/properties/_name.html.erb
+- app/views/mozaic/seo/schema/properties/_ratingValue.html.erb
+- app/views/mozaic/seo/schema/properties/_url.html.erb
+- lib/search-engine-optimization.rb
+- lib/search_engine_optimization/engine.rb
+- lib/search_engine_optimization/railtie.rb
+- lib/search_engine_optimization/version.rb
+homepage: https://github.com/jonhue/search-engine-optimization
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Advanced SEO for Rails apps
+test_files: []