sinatra-seo 0.2.3 → 0.3.0

data/README.markdown

@@ -22,7 +22,13 @@ This library requires you to define the basic SEO information such as the title,
         description: my About description goes here.
         keywords: keyword4, keyword5, keyword6
         
-Please note that we are naming each page as named in your *views/* directory. The three attributes you're required to fill (**title**, **description** and **keywords**) should be strings.
+Please note that we are naming each page as named in your *views/* directory. The three attributes you're required to fill (**title**, **description** and **keywords**) should be strings and these attributes also should have a maximum of characters or words as detailed below:
+
+* the attribute **Title** should have a maximum of 60 characters.
+* the attribute **Description** should have a maximum of 160 characters.
+* the attribute **Keywords** should contain a maximum of 15 words.
+
+Even tough this limitation usually spark a discussion among SEO specialists, I've decided to use the minimum number in order to make sure all the data you define for your pages is parsed by the search engines.
 
 Now, as any other existing extension, there are two possible use cases in order to hook up your *site.seo* file to your application. If you follow the **Classic** approach, then you just need to require this extension in your *app.rb* file and then set the SEO file this extension should parse.
 

data/lib/sinatra/seo.rb

@@ -6,6 +6,13 @@ class OpenStruct
   def new_ostruct_member(name)
     name = name.to_sym
     
+    @table[name] = case name
+      when :title then @table[name][0, 60]
+      when :description then @table[name][0, 160]
+      when :keywords then @table[name].split(" ")[0, 15].join(" ")
+      else @table[name]
+    end
+    
     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]}

data/spec/seo_spec.rb

@@ -29,33 +29,63 @@ describe Sinatra::Seo do
       set :seo_file, './test.seo'
     end
     
-    it "then the :seo_file option should contain the path to the SEO file." do
-      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 defined :seo_file should exist and have the '.seo' extension." do
-      File.exist?('./test.seo').should be_true
-      File.extname(app.seo_file).should == '.seo'
+    context "then the :seo_file" do
+      it "should contain the path to the SEO file." do
+        app.seo_file.should_not be_nil
+        app.seo_file.should be_an_instance_of(String)
+        app.seo_file.should == './test.seo'
+      end
+
+      it "should exist and have the '.seo' extension." do
+        File.exist?('./test.seo').should be_true
+        File.extname(app.seo_file).should == '.seo'
+      end
     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]
+    context "then the seo helper method" do
+      it "should include every page with its sub-attributes as a read-only attributes." 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)
+            
+            case attribute
+              when :title 
+                eval("seo.#{page}.#{attribute}").should == DATA[page][attribute][0, 60]
+              when :description
+                eval("seo.#{page}.#{attribute}").should == DATA[page][attribute][0, 160]
+              else 
+                eval("seo.#{page}.#{attribute}").should == DATA[page][attribute].split(" ")[0, 15].join(" ")
+            end
+          end
+        end
+      end
+      
+      it "should allow a maximum of 60 characters for the Title sub-attribute." do
+        seo.instance_variable_get(:@table).keys.each do |page|
+          eval("seo.#{page}.title").size.should <= 60
+        end
+      end
+      
+      it "should allow a maximum of 160 characters for the Description aub-attribute." do
+        seo.instance_variable_get(:@table).keys.each do |page|
+          eval("seo.#{page}.description").size.should <= 160
+        end
+      end
+      
+      it "should allow a maximum of 15 words for the Keywords aub-attribute." do
+        seo.instance_variable_get(:@table).keys.each do |page|
+          eval("seo.#{page}.keywords").split(" ").size.should <= 15
         end
       end
     end
-    
+
     after :all do
       File.delete './test.seo'
     end

data/spec/spec_helper.rb

@@ -5,6 +5,13 @@ require File.join(Dir.pwd, %w{lib sinatra seo})
 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'}}
+DATA = {:test1 => { :title => lambda{word = ""; 50.times{word += "t"}; word}.call, 
+                    :description => lambda{word = ""; 150.times{word += "d"}; word}.call, 
+                    :keywords => lambda{word = ""; 10.times{word += "k, "}; word}.call }, 
+        :test2 => { :title => lambda{word = ""; 60.times{word += "t"}; word}.call, 
+                    :description => lambda{word = ""; 160.times{word += "d"}; word}.call, 
+                    :keywords => lambda{word = ""; 15.times{word += "k, "}; word}.call }, 
+        :test3 => { :title => lambda{word = ""; 70.times{word += "t"}; word}.call, 
+                    :description => lambda{word = ""; 170.times{word += "d"}; word}.call, 
+                    :keywords => lambda{word = ""; 20.times{word += "k, "}; word}.call }}
+                    

metadata

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