seo_fuel 0.0.4 → 0.0.6

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## version 0.0.5
+- copy locale files to config folder upon installation
+- the button is now included in the same view helper as the dialog. Only use `<%= edit_seo_dialog %>` now

data/README.md

@@ -1,5 +1,8 @@
 # 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. 
+
+_This gem is still in early development. Described features work, but some features are still lacking. I'll be updating the documentation as I go along. Feel free to fork this project and improve on it._
+
+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')
 
@@ -42,17 +45,21 @@ Replace the title, description and keywords tags for these methods:
     
 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 %>
     
 ### Setting default values
-By default, all titles are blank. If a title is blank, the one specified in `seo_fuel_settings.yml` should be used (NOT YET IMPLEMENTED). Per template, you can specify a default value by adding a line of code to your view template:
+By default, all titles are blank. If a title is blank, the one specified in `seo_fuel_settings.yml` should be used (NOT YET IMPLEMENTED). Per template, you can specify a default value by adding a line of code to your view template. This value takes precedence over the default title.
+The 'in browser' added SEO settings take precedence over all default values. 
 
     <% default_title("Site Name | #{@article.title}") %>
 
 
+### I18n
+This gem is fully I18n adjustable. Just edit the locale file, placed in the config directory of your Rails app.
+
 ## TODO
 This gem is in early development, there are still some things to do:
+- add authentication layer
 - add options for open_graph
 - add documentation
 - include testing

data/app/controllers/seo_tags_controller.rb

@@ -1,7 +1,9 @@
 class SeoTagsController < ApplicationController
 
+  # POST
+  # creates the seo tags for given path (params[:seo_tag][:path])
   def create
-    @tag = SeoTag.find_or_create_by_path(params[:path])
+    @tag = SeoTag.find_or_create_by_path(params[:seo_tag][:path])
     @tag.update_attributes(params[:seo_tag])
     respond_to do |format|
       format.js
@@ -9,6 +11,8 @@ class SeoTagsController < ApplicationController
     end
   end
   
+  # PUT
+  # updates the seo tags for given path (params[:seo_tag][:path])
   def update
     @tag = SeoTag.find_or_create_by_path(params[:seo_tag][:path])
     @tag.update_attributes(params[:seo_tag])
@@ -17,5 +21,5 @@ class SeoTagsController < ApplicationController
       format.html {redirect_to params[:path]}
     end
   end
-  
+    
 end

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

@@ -1,3 +1,4 @@
+<%= link_to I18n.t('seo.button_text'), "#", class: "seo_fuel", id: "edit_seo_btn" unless SeoFuel::VERSION > "0.0.5" %>
 <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 %>
@@ -13,5 +14,4 @@
     <%= link_to I18n.t('seo.cancel'), "#", id: "cancel_seo_btn"%>
     <%= f.submit I18n.t('seo.save')%> 
   <% end %>
-  
 </div>

data/lib/generators/seo_fuel_generator.rb

@@ -10,6 +10,7 @@ class SeoFuelGenerator < Rails::Generators::Base
   def install
     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"
   end
@@ -25,6 +26,10 @@ class SeoFuelGenerator < Rails::Generators::Base
   def copy_options_file
     copy_file File.join(config_path, 'seo_fuel_settings.yml'), config_destination
   end
+  
+  def copy_language_file
+    copy_file File.join(locales_path, 'en.seo_fuel.yml'), language_file_destination
+  end
 
   def copy_javascript
     copy_file File.join(javascript_path, 'seo_fuel.js'), js_destination
@@ -33,6 +38,10 @@ class SeoFuelGenerator < Rails::Generators::Base
   def config_path
     File.join(%w(.. .. .. config))
   end
+  
+  def locales_path
+    File.join(%w(.. .. .. config locales))
+  end
 
   def javascripts_path
     File.join(%w(.. .. .. vendor assets javascripts))
@@ -50,5 +59,8 @@ class SeoFuelGenerator < Rails::Generators::Base
     'config/seo_fuel_settings.yml'
   end
 
+  def language_file_destination
+    'config/locales/en.seo_fuel.yml'
+  end
 
 end

data/lib/seo_fuel/version.rb

@@ -1,3 +1,3 @@
 module SeoFuel
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/lib/seo_fuel/view_helper.rb

@@ -1,17 +1,22 @@
 module SeoFuel
   # Contains methods to use in views and helpers.
-  #
   
   module ViewHelper
     
+    # used in version < 0.0.4
     def edit_seo_button(text=I18n.t('seo.button_text'), klass="")
       link_to text, "#", class: "seo_fuel #{klass}", id: "edit_seo_btn"
     end
     
+    # set your default title in any view template, by 
+    # simply calling `default_title(your_title_here)`
+    # this title takes precedence over the default title set
+    # in your config file, but not over the one set 'in browser'
     def default_title(title)
       @default_title = title.force_encoding('utf-8')
     end
     
+    # determines wich title to show
     def title_to_show
       if current_page && current_page.title.present?
         current_page.title
@@ -22,22 +27,32 @@ module SeoFuel
       end
     end
     
+    # render the dialog box and edit button by calling
+    # `edit_seo_dialog` in the templates that should have this
+    # form. Usually this should be on every page, so this helper
+    # methods is mostly used on the bottom of the application.html,
+    # just above the closing `<body>` tag.
     def edit_seo_dialog
       render :partial => "seo_tags/seo_options"
     end
     
+    # returns the current SeoTag object
+    # this instance contains all the SEO options
     def current_page
       SeoTag.find_by_path(request.path)
     end
     
+    # renders the `title_to_show` inside a `<title>` tag.
     def show_title
       render :partial => "seo_tags/title"
     end
 
+    # renders the description inside a `<meta>` tag.
     def show_description
       render :partial => "seo_tags/description"
     end
 
+    # renders the keywords inside a `<meta>` tag.
     def show_keywords
       render :partial => "seo_tags/keywords"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seo_fuel
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-10 00:00:00.000000000 Z
+date: 2012-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -36,6 +36,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -48,8 +49,8 @@ files:
 - 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/locales/en.seo_fuel.yml
+- config/locales/nl.seo_fuel.yml
 - config/routes.rb
 - config/seo_fuel_settings.yml
 - lib/generators/seo_fuel_generator.rb