seo_fuel 0.1.0 → 0.1.1

data/README.md

@@ -44,20 +44,14 @@ Add these lines to your assets manifest files
     //= require seo_fuel
     
 ### Implementation in views
-Replace the title, description and keywords tags for these methods:
+Replace the title, description and keywords tags for this method:
 
-    <%= show_title %>
-    <%= show_description %>
-    <%= show_keywords %>
+    <%= show_meta_tags %>
     
 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_dialog %>
     
-or, if you wish to only let signed in users be able to see the form (using devse in this example):
-
-    <%= edit_seo_dialog if admin_signed_in? %>
-    
 ### Setting default values
 By default, all meta tags are blank. If a tag is blank, the one specified in `seo_fuel_settings.yml` will be used. Per template, you can specify a default value by adding a few lines of code to your view template. These values take precedence over the default values.
 The 'in browser' added SEO settings take precedence over all default values. 
@@ -69,6 +63,14 @@ The 'in browser' added SEO settings take precedence over all default values.
 ### I18n
 This gem is fully I18n adjustable. Just edit the locale file, placed in the locales directory of your Rails app.
 
+
+## Authentication
+Not all users are allowed to edit SEO settings, obviously. To only let specific users see the SEO form, you can simply use your own restrictions when rendering the form. If only admin users are supposed to see the form (when using Devise), use this:
+
+    <%= edit_seo_dialog if admin_signed_in? %>
+    
+Authentication for the Controller layer is added through the key in a hidden field in the form. This random key is set in the `seo_fuel_settings.yml` configuration file. Only when this key matches, the record will be saved. If this form is only visible for signed in admins, they are the only ones that can submit POST requests with the proper key.
+
 ## TODO
 This gem is in early development, there are still some things to do:
 - add options for open_graph

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

@@ -0,0 +1,8 @@
+<title><%= title_to_show %></title>
+<meta name="description" content="<%= description_to_show %>">
+<% if keywords_to_show -%>
+<meta name="keywords" content="<%= keywords_to_show %>">
+<% end -%>
+<% if canonical.present? -%>
+<link rel="canonical" href="<%= canonical %>" />
+<% end -%>

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

@@ -8,11 +8,23 @@
     <div class="spacer"></div>
     <%= f.label :description, "#{I18n.t('seo.form.description')}".html_safe %>
     <%= f.text_area :description, rows: 3, placeholder: @default_description %>
+
     <div class="spacer"></div>
+
+    <%= link_to I18n.t('seo.more_options'), "#", id: 'more-options-btn'%>
+    
+    <div style="display: none;" id="more-options">
     <%= f.label :keywords, "#{I18n.t('seo.form.keywords')}".html_safe %>
     <%= f.text_area :keywords, rows: 3, placeholder: @default_keywords %>
     <div class="spacer"></div>
-    <%= link_to I18n.t('seo.cancel'), "#", id: "cancel_seo_btn"%>
-    <%= f.submit I18n.t('seo.save')%> 
+    <%= f.label :canonical, "#{I18n.t('seo.form.canonical')}".html_safe %>
+    <%= f.text_field :canonical, placeholder: I18n.t('seo.form.canonical_placeholder') %>
+    </div>
+    <div class="spacer"></div>
+    <div id="seo_buttons">
+      <span id="cancel_seo_btn"><%= link_to I18n.t('seo.cancel'), "#" %> of</span>
+      
+      <%= f.submit I18n.t('seo.save')%> 
+    </div>
   <% end %>
 </div>

data/config/locales/en.seo_fuel.yml

@@ -1,11 +1,14 @@
 en:
   seo:
-    button_text: "Edit SEO options"
-    cancel: "Cancel"
-    save: "Save"
+    button_text: Edit SEO options
+    cancel: Cancel
+    save: Save
+    more_options: More options
     form:
-      title: "Title tag"
+      title: "Title"
       title_tip: ""
-      description: "Description tag"
+      description: "Description"
       description_tip: ""
-      keywords: Keywords
+      keywords: Keywords
+      canonical: Canonical
+      canonical_placeholder: "URL of canoncial page, if applicable"

data/config/locales/nl.seo_fuel.yml

@@ -1,11 +1,14 @@
 nl:
   seo:
-    button_text: "Bewerk SEO opties"
-    cancel: "Annuleer"
-    save: "Opslaan"
+    button_text: Bewerk SEO opties
+    cancel: Annuleer
+    save: Opslaan
+    more_options: Meer opties
     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
+      keywords: Keywords
+      canonical: Canonical
+      canonical_placeholder: "URL van canoncial pagina, indien van toepassing"

data/config/templates/seo_fuel_settings.yml.erb

@@ -0,0 +1,6 @@
+SEO_FUEL_SETTINGS: 
+  seperator: |
+  default_title: "Your Website Name"
+  default_description: Give a discription of your website
+  default_keywords: "enter, your, keywords, here"
+  key: "<%= (0...50).map{ ('a'..'z').to_a[rand(26)] }.join %>" # used for authentication in the controller

data/lib/generators/seo_fuel_generator.rb

@@ -11,14 +11,14 @@ class SeoFuelGenerator < Rails::Generators::Base
     copy_javascript if needs_js_copied?
     copy_options_file
     copy_language_file
-    # route("resources :seo_tags")
-    # migration_template "migration.rb", "db/migrate/create_seo_fuel.rb"
+    route("resources :seo_tags")
+    migration_template "migration.rb", "db/migrate/create_seo_fuel.rb"
   end
 
   private
 
 
-  def template(from, to)
+  def render_erb_template(from, to)
     erb = File.read(File.expand_path("../../../config/templates/#{from}", __FILE__))
     yml = ERB.new(erb).result(binding)
     File.open(to, 'w') {|f| f.write(yml) }
@@ -32,7 +32,7 @@ class SeoFuelGenerator < Rails::Generators::Base
   end
 
   def copy_options_file
-    template "seo_fuel_settings.yml.erb", config_destination
+    render_erb_template "seo_fuel_settings.yml.erb", config_destination
     # copy_file File.join(config_path, 'seo_fuel_settings.yml'), config_destination
   end
   

data/lib/generators/templates/migration.rb

@@ -8,6 +8,8 @@ class CreateSeoFuel < ActiveRecord::Migration
       t.text :open_graph
       t.string :path
       t.boolean :use_project_title
+      t.boolean :noindex
+      t.boolean :nofollow
       t.timestamps
     end
         

data/lib/seo_fuel/railtie.rb

@@ -0,0 +1,8 @@
+module SeoFuel
+  class Railtie < Rails::Railtie
+    initializer "Include your code in the controller" do
+      ActiveSupport.on_load(:action_controller) do
+        include SeoFuel
+      end
+    end
+end

data/lib/seo_fuel/version.rb

@@ -1,3 +1,3 @@
 module SeoFuel
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/seo_fuel/view_helper.rb

@@ -73,6 +73,12 @@ module SeoFuel
         default_settings_from_config_file['SEO_FUEL_SETTINGS']['default_title']
       end
     end
+
+    # renders canonical
+    def canonical
+      current_page.canonical if current_page
+    end
+
     
     # render the dialog box and edit button by calling
     # `edit_seo_dialog` in the templates that should have this
@@ -100,8 +106,8 @@ module SeoFuel
     end
 
     # renders the keywords inside a `<meta>` tag.
-    def show_keywords
-      render :partial => "seo_tags/keywords"
+    def show_meta_tags
+      render :partial => "seo_tags/meta_tags"
     end
     
   end

data/vendor/assets/javascripts/seo_fuel.js

@@ -7,6 +7,10 @@ $(document).ready(function() {
   $('#cancel_seo_btn, #save_seo_tag').bind('click', function() {
     hideSeoForm();
   });
+
+  $('#more-options-btn').bind('click', function() {
+    $('#more-options').toggle();
+  });
   
 });
 

data/vendor/assets/stylesheets/seo_fuel.css

@@ -71,7 +71,9 @@
   float: left;
   width: 150px;
   text-align: right;
-  margin-right: 15px;
+  margin-right: 12px;
+  font-size: 12px;
+  margin-top: 4px;
 }
 
 .seo_form input, .seo_form textarea {
@@ -84,15 +86,14 @@
   size: 18px;
 }
 .seo_form input[type=submit] {
-  float: right;
   width: 150px;
-  margin-right: 20px;
   background: #eee;
   -webkit-border-radius: 3px;
   -moz-border-radius: 3px;
   border-radius: 3px;
   text-shadow: 1px 1px 0px #dedede;
   filter: dropshadow(color=#dedede, offx=1, offy=1);
+  float: left;
 }
 
 .seo_form input[type=submit]:hover {
@@ -107,4 +108,23 @@
   float: left;
   text-decoration: none;
   color: #333;
+  font-size: 12px;
+  margin-right: 10px;
+  margin-top: 5px;
+}
+#cancel_seo_btn a {
+  text-decoration: none;
+  color: #333;
+}
+
+#more-options-btn{
+  font-size: 12px;
+  margin-left: 160px;
+  text-decoration: none;
+  color: #333;
+}
+
+#seo_buttons {
+  float: right;
+  font-size: 12px;
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seo_fuel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-11 00:00:00.000000000 Z
+date: 2012-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,7 +44,7 @@ files:
 - 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/_meta_tags.html.erb
 - app/views/seo_tags/_seo_options.html.erb
 - app/views/seo_tags/_title.html.erb
 - app/views/seo_tags/create.js.erb
@@ -52,13 +52,16 @@ files:
 - config/locales/en.seo_fuel.yml
 - config/locales/nl.seo_fuel.yml
 - config/routes.rb
+- config/templates/seo_fuel_settings.yml.erb
+- lib/generators/USAGE
 - 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/railtie.rb
 - lib/seo_fuel/version.rb
 - lib/seo_fuel/view_helper.rb
+- lib/seo_fuel_example.png
 - seo_fuel.gemspec
 - vendor/assets/javascripts/seo_fuel.js
 - vendor/assets/stylesheets/seo_fuel.css

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

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