sinatra-seo 0.0.1 → 0.2.0

data/README.markdown

@@ -1,5 +1,5 @@
 # Sinatra SEO
-This is a [Sinatra Extension][1] that renders for browser and AJAX calls any page or sub-pages located under the directory defined as *:views* and the layout file defined as *:layout* (if there is any) inside your [Sinatra][2] application.
+This is a [Sinatra Extension][1] that integrates basic SEO functionality into your [Sinatra][2] application.
 
 ### Installation
 In order to install this gem, you just need to install the gem from your command line like this:
@@ -11,8 +11,10 @@ You should take into account that this library have the following dependencies:
 * [sinatra][2]
 
 ### Usage
-... description goes here...
-  
+This library requires you to define the basic SEO information such as the title, the description and the keywords for every page of your site on a separate file.
+
+...some more description out here... 
+
 ### Contributions
 Everybody is welcome to contribute to this project by commenting the source code, suggesting modifications or new ideas, reporting bugs, writing some documentation and, of course, you're also welcome to contribute with patches as well!
 

data/Rakefile

@@ -34,7 +34,7 @@ namespace :deployment do
   
   desc "Deployment on Gemcutter."
   task :gemcutter => [:clean, :package] do
-    sh "#{GEM_COMMAND} push pkg/*.gem"
+    sh 'gem push pkg/*.gem'
   end
 end
 

data/lib/sinatra/seo.rb

@@ -1,7 +1,33 @@
 require 'sinatra/base'
+require 'yaml'
+require 'ostruct'
+
+class OpenStruct
+  def new_ostruct_member(name)
+    name = name.to_sym
+    
+    unless self.respond_to?(name)
+      class << self; self; end.class_eval do
+        define_method(name) {@table[name].is_a?(Hash) ? OpenStruct.new(@table[name]) : @table[name]}
+      end
+    end
+  end
+end
 
 module Sinatra
   module Seo
-    # ...
+    module Helpers
+      def seo
+        @seo ||= OpenStruct.new(YAML.load_file(app.seo_file))
+      end
+    end
+    
+    def self.registered(app)
+      app.helpers Seo::Helpers
+      
+      app.set :seo_file, nil
+    end
   end
+  
+  register Seo
 end

data/spec/seo_spec.rb

@@ -2,8 +2,60 @@ require 'spec_helper'
 
 describe Sinatra::Seo do
   include Rack::Test::Methods
+  include Sinatra::Seo::Helpers
   
   def app
     Sinatra::Application
   end
+  
+  context "when initialized" do
+    before :all do
+      set :seo_file, nil
+    end
+    
+    it "then the :seo_file option should be null." do
+      app.seo_file.should be_nil
+    end
+    
+    it "then the seo helper method should release an error." do
+      lambda{seo}.should raise_error(TypeError)
+    end
+  end
+  
+  context "when defined an existent SEO file" do
+    before :all do
+      File.open('./test.seo', 'w'){|file| file.write(YAML::dump(DATA))}
+      
+      set :seo_file, './test.seo'
+    end
+    
+    it "then the :seo_file option should contain the path to the SEO file." do
+      File.exist?('./test.seo').should be_true
+      File.extname(app.seo_file).should == '.seo'
+      
+      app.seo_file.should_not be_nil
+      app.seo_file.should be_an_instance_of(String)
+      app.seo_file.should == './test.seo'
+    end
+    
+    it "then the seo helper method should include every page (with :title, :description and :keywords as sub-attributes) as a read-only attribute." do
+      YAML.load_file('./test.seo').keys.each do |page|
+        seo.methods.include?(page).should be_true
+        seo.methods.include?(:"#{page}=").should be_false
+        
+        eval("seo.#{page}").should be_an_instance_of(OpenStruct)
+        
+        [:title, :description, :keywords].each do |attribute|
+          eval("seo.#{page}.methods").include?(attribute).should be_true
+          eval("seo.#{page}.methods").include?(:"#{attribute}=").should be_false
+          eval("seo.#{page}.#{attribute}").should be_an_instance_of(String)
+          eval("seo.#{page}.#{attribute}").should == DATA[page][attribute]
+        end
+      end
+    end
+    
+    after :all do
+      File.delete './test.seo'
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -2,4 +2,9 @@ require 'sinatra'
 require 'rack/test'
 require File.join(Dir.pwd, %w{lib sinatra seo})
 
-set :environment, :test
+set :environment, :test
+enable :raise_errors
+
+DATA = {:test1 => {:title => 'Title1', :description => 'Description1', :keywords => 'Keywords1'}, 
+        :test2 => {:title => 'Title2', :description => 'Description2', :keywords => 'Keywords2'}, 
+        :test3 => {:title => 'Title3', :description => 'Description3', :keywords => 'Keywords3'}}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-seo
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Julio Javier Cicchelli
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-10 00:00:00 +01:00
+date: 2010-03-12 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency