seo_fuel 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+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 seo-fuel.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Henk Meijer
+
+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,55 @@
+# SEO Fuel: easily gas up search engines
+SEO Fuel is a super easy way to manage SEO tags in your Rails App. It doesn't require any adjustments to existing models or controllers. 
+
+SEO Fuel works by adding a form with SEO settings (title, description, etc.) to every single page of your app. This form is hidden, but pops up when you hit the button. The SEO settings aren't linked to a page by foreign keys, but rather by path ('/articles/1-article-title')
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'seo_fuel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seo_fuel
+
+## Usage
+After installation, run these commands:
+
+    $ rails generate seo_fuel
+    $ bundle exec rake db:migrate
+
+this will generate a database migration to add a SeoTag table, it will also update your routes and add the .yml file for configuration.
+
+Add these lines to your assets manifest files
+
+    # in appcliation.css
+    *= require seo_fuel
+  
+    # in appcliation.js
+    //= require seo_fuel
+    
+### Implementation in views
+Replace the title, description and keywords tags for these methods:
+
+    <%= show_title %>
+    <%= show_description %>
+    <%= show_keywords %>
+    
+Display the edit button and the form on every page, by including these commands on the bottom of your application.html.erb (just above the closing body tag)
+
+    <%= edit_seo_button %>
+    <%= edit_seo_dialog %>
+    
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/app/controllers/seo_tags_controller.rb

@@ -0,0 +1,21 @@
+class SeoTagsController < ApplicationController
+
+  def create
+    @tag = SeoTag.find_or_create_by_path(params[:path])
+    @tag.update_attributes(params[:seo_tag])
+    respond_to do |format|
+      format.js
+      format.html {redirect_to params[:path]}
+    end
+  end
+  
+  def update
+    @tag = SeoTag.find_or_create_by_path(params[:path])
+    @tag.update_attributes(params[:seo_tag])
+    respond_to do |format|
+      format.js
+      format.html {redirect_to params[:path]}
+    end
+  end
+  
+end

data/app/models/seo_tag.rb

@@ -0,0 +1,12 @@
+class SeoTag < ActiveRecord::Base
+  attr_accessible :title, :description, :keywords, :canonical, :open_graph, :path, :use_project_title
+  serialize :open_graph
+  
+  def show_title
+    title
+  end
+  
+  def exists?
+    !new_record?
+  end
+end

data/app/views/seo_tags/_description.html.erb

@@ -0,0 +1 @@
+<meta name="description" content="<%= current_page.description %>">

data/app/views/seo_tags/_keywords.html.erb

@@ -0,0 +1 @@
+<meta name="keywords" content="<%= current_page.keywords %>">

data/app/views/seo_tags/_seo_options.html.erb

@@ -0,0 +1,17 @@
+<div id="edit_seo_dialog" class="seo_fuel" style="display: none;">
+  <%= form_for SeoTag.find_or_initialize_by_path(request.path), remote: true, html: {class: "seo_form"} do |f|%>
+    <%= f.hidden_field :path %>
+    <%= f.label :title, "#{I18n.t('seo.form.title')}".html_safe %>
+    <%= f.text_field :title %>
+    <div class="spacer"></div>
+    <%= f.label :description, "#{I18n.t('seo.form.description')}".html_safe %>
+    <%= f.text_area :description, rows: 3 %>
+    <div class="spacer"></div>
+    <%= f.label :keywords, "#{I18n.t('seo.form.keywords')}".html_safe %>
+    <%= f.text_area :keywords, rows: 3 %>
+    <div class="spacer"></div>
+    <%= link_to I18n.t('seo.cancel'), "#", id: "cancel_seo_btn"%>
+    <%= f.submit I18n.t('seo.save')%> 
+  <% end %>
+  
+</div>

data/app/views/seo_tags/_title.html.erb

@@ -0,0 +1 @@
+<title><%= current_page.title %></title>

data/app/views/seo_tags/create.js.erb

@@ -0,0 +1 @@
+hideSeoForm();

data/app/views/seo_tags/update.js.erb

@@ -0,0 +1,2 @@
+hideSeoForm();
+$('title').text('<%= @tag.show_title %>');

data/config/locales/en.yml

@@ -0,0 +1,2 @@
+en:
+  

data/config/locales/nl.yml

@@ -0,0 +1,11 @@
+nl:
+  seo:
+    button_text: "Bewerk SEO opties"
+    cancel: "Annuleer"
+    save: "Opslaan"
+    form:
+      title: "Title tag"
+      title_tip: "De tekst die als titel van de pagina wordt ingesteld. Is te zien boven in je browserscherm."
+      description: "Description tag"
+      description_tip: "Omschrijf waar deze pagina over gaat. Deze tekst wordt vaak getoond in Google."
+      keywords: Keywords

data/config/seo_fuel_settings.yml

@@ -0,0 +1,4 @@
+SEO_FUEL_SETTINGS: 
+  seperator: |
+  default_title: "Your Website Name"
+  default_description: Give a discription of your website

data/lib/generators/seo_fuel_generator.rb

@@ -0,0 +1,54 @@
+require 'rails/generators/active_record/migration'
+
+class SeoFuelGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  extend ActiveRecord::Generators::Migration
+
+  desc "Put the JavaScript and migration in place"
+  source_root File.join(File.dirname(__FILE__), "templates")
+
+  def install
+    copy_javascript if needs_js_copied?
+    copy_options_file
+    route("resources :seo_tags")
+    migration_template "migration.rb", "db/migrate/create_seo_fuel.rb"
+  end
+
+  private
+
+  def gsub_file(relative_destination, regexp, *args, &block)
+    path = destination_path(relative_destination)
+    content = File.read(path).gsub(regexp, *args, &block)
+    File.open(path, 'wb') { |file| file.write(content) }
+  end
+
+  def copy_options_file
+    copy_file File.join(config_path, 'seo_fuel_settings.yml'), config_destination
+  end
+
+  def copy_javascript
+    copy_file File.join(javascript_path, 'seo_fuel.js'), js_destination
+  end
+
+  def config_path
+    File.join(%w(.. .. .. config))
+  end
+
+  def javascripts_path
+    File.join(%w(.. .. .. vendor assets javascripts))
+  end
+
+  def needs_js_copied?
+    ::Rails.version < '3.1' || !::Rails.application.config.assets.enabled
+  end
+
+  def js_destination
+    'public/javascripts/seo_fuel.js'
+  end
+
+  def config_destination
+    'config/seo_fuel_settings.yml'
+  end
+
+
+end

data/lib/generators/templates/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Copies the migration file into the application.
+
+Example:
+    rails generate seo_fuel
+
+    This will create:
+        db/migrate/create_seo_fuel.rb

data/lib/generators/templates/migration.rb

@@ -0,0 +1,20 @@
+class CreateSeoFuel < ActiveRecord::Migration
+  def self.up
+    create_table :seo_tags do |t|
+      t.string :title
+      t.string :description
+      t.text :keywords
+      t.string :canonical
+      t.text :open_graph
+      t.string :path
+      t.boolean :use_project_title
+      t.timestamps
+    end
+        
+    add_index :seo_tags, :path
+  end
+
+  def self.down
+    drop_table :seo_tags
+  end
+end

data/lib/seo_fuel.rb

@@ -0,0 +1,16 @@
+require 'action_controller'
+require 'action_view'
+
+module SeoFuel
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end
+
+require 'seo_fuel/version'
+require 'seo_fuel/view_helper'
+require 'seo_fuel/controller_helper'
+
+ActionView::Base.send :include, SeoFuel::ViewHelper
+ActionController::Base.send :include, SeoFuel::ControllerHelper

data/lib/seo_fuel/controller_helper.rb

@@ -0,0 +1,48 @@
+module SeoFuel
+  # Contains methods to use in controllers.
+  #
+  # You can define several instance variables to set meta tags:
+  #   @page_title = 'Member Login'
+  #   @page_description = 'Member login page.'
+  #   @page_keywords = 'Site, Login, Members'
+  #
+  # Also you can use {InstanceMethods#set_meta_tags} method, that have the same parameters
+  # as {ViewHelper#set_meta_tags}.
+  #
+  module ControllerHelper
+    def self.included(base)
+      base.send :include, InstanceMethods
+      base.alias_method_chain :render, :meta_tags
+    end
+
+    module InstanceMethods
+      # Processes the <tt>@page_title</tt>, <tt>@page_keywords</tt>, and
+      # <tt>@page_description</tt> instance variables and calls +render+.
+      def render_with_meta_tags(*args, &block)
+        meta_tags = {}
+        meta_tags[:title]       = @page_title       if @page_title
+        meta_tags[:keywords]    = @page_keywords    if @page_keywords
+        meta_tags[:description] = @page_description if @page_description
+        set_meta_tags(meta_tags)
+
+        render_without_meta_tags(*args, &block)
+      end
+
+      # Set meta tags for the page.
+      #
+      # See <tt>MetaTags.set_meta_tags</tt> for details.
+      def set_meta_tags(meta_tags)
+        meta_tags ||= {}
+        meta_tags[:open_graph] = meta_tags.delete(:og) if meta_tags.key?(:og)
+        self.meta_tags.deep_merge!(meta_tags || {})
+      end
+      protected :set_meta_tags
+
+      # Get meta tags for the page.
+      def meta_tags
+        @meta_tags ||= {}
+      end
+      protected :meta_tags
+    end
+  end
+end

data/lib/seo_fuel/version.rb

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

data/lib/seo_fuel/view_helper.rb

@@ -0,0 +1,32 @@
+module SeoFuel
+  # Contains methods to use in views and helpers.
+  #
+  
+  module ViewHelper
+    
+    def edit_seo_button(text=I18n.t('seo.button_text'), klass="")
+      link_to text, "#", class: "seo_fuel #{klass}", id: "edit_seo_btn"
+    end
+    
+    def edit_seo_dialog
+      render :partial => "seo_tags/seo_options"
+    end
+    
+    def current_page
+      SeoTag.find_by_path(request.path)
+    end
+    
+    def show_title
+      render :partial => "seo_tags/title"
+    end
+
+    def show_description
+      render :partial => "seo_tags/description"
+    end
+
+    def show_keywords
+      render :partial => "seo_tags/keywords"
+    end
+    
+  end
+end

data/seo_fuel.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/seo_fuel/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Henk Meijer"]
+  gem.email         = ["meijerhenk@gmail.com"]
+  gem.description   = ["Customize the SEO options for every single page of your rails app. Each url has its own SEO options."]
+  gem.summary       = ["Add exstensive SEO options to every page on your website."]
+  gem.homepage      = "https://github.com/henkm/seo_fuel"
+
+  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.add_development_dependency "rake"
+  
+  gem.name          = "seo_fuel"
+  gem.require_paths = ["lib"]
+  gem.version       = SeoFuel::VERSION
+end

data/vendor/assets/javascripts/seo_fuel.js

@@ -0,0 +1,16 @@
+$(document).ready(function() {
+  $('#edit_seo_btn').bind('click', function() {
+    $('#edit_seo_btn').slideUp();
+    $('#edit_seo_dialog').slideDown();
+  });
+  
+  $('#cancel_seo_btn, #save_seo_tag').bind('click', function() {
+    hideSeoForm();
+  });
+  
+});
+
+function hideSeoForm(){
+  $('#edit_seo_dialog').slideUp();
+  $('#edit_seo_btn').slideDown();
+}

data/vendor/assets/stylesheets/seo_fuel.css

@@ -0,0 +1,93 @@
+.seo_fuel {
+  font-family: arial;
+}
+
+#edit_seo_btn {
+  text-align: center;
+  position: fixed;
+  top: -5px;
+  left: 50%;
+  margin-left: -75px;
+  width: 150px;
+  background: #fff;
+  border: 1px solid #dedede;
+  padding-bottom: 4px;
+  padding-top: 10px;
+  background-image: linear-gradient(bottom, rgb(166,166,166) 6%, rgb(217,217,217) 56%);
+  background-image: -o-linear-gradient(bottom, rgb(166,166,166) 6%, rgb(217,217,217) 56%);
+  background-image: -moz-linear-gradient(bottom, rgb(166,166,166) 6%, rgb(217,217,217) 56%);
+  background-image: -webkit-linear-gradient(bottom, rgb(166,166,166) 6%, rgb(217,217,217) 56%);
+  background-image: -ms-linear-gradient(bottom, rgb(166,166,166) 6%, rgb(217,217,217) 56%);
+
+  background-image: -webkit-gradient(
+  	linear,
+  	left bottom,
+  	left top,
+  	color-stop(0.06, rgb(166,166,166)),
+  	color-stop(0.56, rgb(217,217,217))
+  );
+  -webkit-border-radius: 3px;
+  -moz-border-radius: 3px;
+  border-radius: 3px;
+  -webkit-box-shadow: 0px 0px 2px 2px #dedede;
+  box-shadow: 0px 0px 2px 2px #dedede;
+  
+  border: 1px solid #aaa;
+  
+  font-family: arial;
+  text-decoration: none;
+  color: #fff;
+  
+  text-shadow: 1px 1px 0px #333;
+  filter: dropshadow(color=#333, offx=1, offy=1);
+}
+
+#edit_seo_dialog {
+
+  width: 800px;
+  background: #fff;
+  position: fixed;
+  top: -3px;
+  left: 50%;
+  padding: 5px;
+  padding-top: 15px;
+  margin-left: -400px;
+  border: 1px solid #dedede;
+  -webkit-border-radius: 3px;
+  -moz-border-radius: 3px;
+  border-radius: 3px;
+  -webkit-box-shadow: 0px 0px 2px 2px #dedede;
+  box-shadow: 0px 0px 2px 2px #dedede;
+ 
+  
+  opacity:0.8;
+  filter:alpha(opacity=80); /* For IE8 and earlier */ 
+}
+
+.spacer{clear:both; height:1px;}
+
+.seo_form label {
+  float: left;
+  width: 150px;
+  text-align: right;
+  margin-right: 15px;
+}
+
+.seo_form input, .seo_form textarea {
+  float: left;
+  clear: right;
+  width: 600px;
+  max-width: 600px;
+  border: 1px solid #dedede;
+  padding: 5px;
+  size: 18px;
+}
+.seo_form input[type=submit] {
+  float: right;
+  width: 150px;
+}
+#cancel_seo_btn {
+  float: left;
+  text-decoration: none;
+  color: #333;
+}

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: seo_fuel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Henk Meijer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! '["Customize the SEO options for every single page of your rails app.
+  Each url has its own SEO options."]'
+email:
+- meijerhenk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/seo_tags_controller.rb
+- app/models/seo_tag.rb
+- app/views/seo_tags/_description.html.erb
+- app/views/seo_tags/_keywords.html.erb
+- app/views/seo_tags/_seo_options.html.erb
+- app/views/seo_tags/_title.html.erb
+- app/views/seo_tags/create.js.erb
+- app/views/seo_tags/update.js.erb
+- config/locales/en.yml
+- config/locales/nl.yml
+- config/routes.rb
+- config/seo_fuel_settings.yml
+- lib/generators/seo_fuel_generator.rb
+- lib/generators/templates/USAGE
+- lib/generators/templates/migration.rb
+- lib/seo_fuel.rb
+- lib/seo_fuel/controller_helper.rb
+- lib/seo_fuel/version.rb
+- lib/seo_fuel/view_helper.rb
+- seo_fuel.gemspec
+- vendor/assets/javascripts/seo_fuel.js
+- vendor/assets/stylesheets/seo_fuel.css
+homepage: https://github.com/henkm/seo_fuel
+licenses: []
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ! '["Add exstensive SEO options to every page on your website."]'
+test_files: []
+has_rdoc: