rack-seo 0.0.1

data/spec/rack-seo_spec.rb

@@ -0,0 +1,107 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+describe "RackSeo" do
+  before do
+    @rack_seo = Rack::RackSeo::Base.new Apps.complex, :public => Fixtures.path
+    @env = Rack::MockRequest.env_for '/'
+  end
+
+  context "has sensible defaults" do
+    context "for a page with a #content div" do
+      before do
+        @example_page = Fixtures.complex
+        @orig_meta_title_text = @example_page.title_content
+        @orig_meta_description_text = @example_page.description_content
+        @orig_meta_keywords_text = @example_page.keywords_content
+        @orig_h1_text = @example_page.css('h1').text
+        @rack_seo.execute! @example_page
+      end
+
+      it "pulls the h1 tag into the meta title by default" do
+        @example_page.title_content.should == @orig_h1_text
+        @example_page.title_content.should_not ==  @orig_meta_title_text
+      end
+
+      it "summarises the description based on the text in #content if it exists" do
+        @example_page.description_content.should_not == @orig_meta_description_text
+        @example_page.description_content.should_not == ""
+        @example_page.description_content.should_not be_nil
+      end
+
+      it "summarises the keywords based on the text in #content if it exists" do
+        @example_page.keywords_content.should_not == @orig_meta_keywords_text
+        @example_page.keywords_content.should_not == ""
+        @example_page.keywords_content.should_not be_nil
+      end
+    end
+
+    context "for a page without #content div" do
+      before do
+        @example_page = Fixtures.simple
+        @orig_meta_description_text = @example_page.description_content
+        @orig_meta_keywords_text = @example_page.keywords_content
+        @rack_seo.execute! @example_page
+      end
+      it "summarises the description based on the text in the page if #content does not exist" do
+        @example_page.description_content.should_not == @orig_meta_description_text
+        @example_page.description_content.should_not == ""
+        @example_page.description_content.should_not be_nil
+      end
+
+      it "summarises the keywords based on the text in the page if #content does not exist" do
+        @example_page.keywords_content.should_not == @orig_meta_keywords_text
+        @example_page.keywords_content.should_not == ""
+        @example_page.keywords_content.should_not be_nil
+      end
+    end
+
+  end
+
+  context "validate output" do
+    before do
+      @example_page = Fixtures.complex
+      @rack_seo.execute! @example_page
+    end
+
+    it "should have a head tag that is the first child of the root node" do
+      @example_page.root.children.first.should == @example_page.at('head')
+    end
+    it "should have a title that is less that 65 chars and 15 words" do
+      title = @example_page.title_tag
+      title.text.length.should be <= 65
+      title.text.split(/\b/).length.should be > 1
+      title.text.split(/\b/).length.should be <= 15
+    end
+    it "should have a meta description with content that is less than 150 chars and 30 words" do
+      description = @example_page.description_content
+      description.split(/\b/).length.should be > 1
+      pending("A better text summarizer with more control over length")
+      description.split(/\b/).length.should be <= 100
+      description.length.should be <= 150 
+      description.split(/\b/).length.should be <= 30 
+    end
+    it "has a title that is readable (no line breaks or leading/trailing spaces)" do
+      title = @example_page.title_tag
+      title.text.should_not match(/\A\s/)
+      title.text.should_not match(/\n+/)
+      title.text.should_not match(/\s\s+/)
+      title.text.should_not match(/\t+/)
+      title.text.should_not match(/\s\Z/)
+    end
+    it "has a readable meta_description (no line breaks or leading/trailing spaces)" do
+      meta_description = @example_page.description_content
+      meta_description.should_not match(/\A\s/)
+      meta_description.should_not match(/\n+/)
+      meta_description.should_not match(/\s\s+/)
+      meta_description.should_not match(/\t+/)
+      meta_description.should_not match(/\s\Z/)
+    end
+    it "should have meta keywords with content that is a lowercase, comma separated list, without leading/trailing commas" do
+      keywords = @example_page.keywords_content
+      keywords.should match /[a-z,]+/
+      keywords.should_not match /\A,/
+      keywords.should_not match /,\Z/
+      keywords.split(/,/).length.should be > 1 
+    end
+  end
+
+end

data/spec/sample_configs/custom_paths.yml

@@ -0,0 +1,16 @@
+--- 
+default: 
+  title_format: "{{h1}} - Custom Path Test"
+  meta_description_selector: "#content"
+  meta_keywords_selector: "#banner"
+custom:
+  -
+    matcher: '/test-path'
+    title_format: "Test one - {{h2}}"
+    meta_description_selector: "#sidebar"
+    meta_keywords_selector: "#banner"
+  -
+    matcher: !ruby/regexp '/\/test-regex-.*/'
+    title_format: "Test regex - {{h2}}"
+    meta_description_selector: "#sidebar"
+    meta_keywords_selector: "#banner"

data/spec/sample_configs/happy.yml

@@ -0,0 +1,5 @@
+--- 
+default: 
+  title_format: "{{h1}} - Happy happy"
+  meta_description_selector: "#sidebar"
+  meta_keywords_selector: "#banner"

data/spec/sample_configs/sad.yml

@@ -0,0 +1,5 @@
+--- 
+default: 
+  title_format: "{{nonsenseSelector$%^&}} - Happy happy"
+  meta_description_selector: "badSelector^&*("
+  meta_keywords_selector: "@£$%worseSelector@£$%^&"

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'pry'
+require 'rspec'
+require 'rack/test'
+require 'fileutils'
+require 'tmpdir'
+require 'ostruct'
+require 'rack-seo'
+
+def fixture name
+  File.read(File.join(Fixtures.path, name))
+end
+
+module Apps
+  class << self
+    def complex
+      lambda { |env| [200, { 'Content-Type' => 'text/html' }, [fixture('complex.html')]] }
+    end
+
+    def simple
+      lambda { |env| [200, { 'Content-Type' => 'text/html' }, [fixture('simple.html')]] }
+    end
+
+    def plain_text
+      lambda { |env| [200, { 'Content-Type' => 'text/plain' }, ['plain texto']] }
+    end
+  end
+end
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  include Rack::Test::Methods
+  config.before :each do
+    Fixtures = OpenStruct.new unless defined?(Fixtures)
+    Fixtures.path = File.join(File.dirname(__FILE__), 'fixtures')
+    Fixtures.complex = Rack::RackSeo::Document.new(fixture('complex.html'))
+    Fixtures.complex_copy = Rack::RackSeo::Document.new(fixture('complex.html'))
+    Fixtures.simple = Rack::RackSeo::Document.new(fixture('simple.html'))
+    Fixtures.simple_copy = Rack::RackSeo::Document.new(fixture('simple.html'))
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: rack-seo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Xavier Riley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2156361000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156361000
+- !ruby/object:Gem::Dependency
+  name: summarize
+  requirement: &2156359840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156359840
+description: Lets you extract sensible default content for meta tags using the markup
+  from that page.
+email:
+- xavriley@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/rack_seo.default.yml
+- generators/rack_seo.sample.yml
+- lib/rack-seo.rb
+- lib/rack-seo/base.rb
+- lib/rack-seo/dispatcher.rb
+- lib/rack-seo/document.rb
+- lib/rack-seo/sanitize.rb
+- lib/rack-seo/summarizer.rb
+- lib/rack-seo/title_formatter.rb
+- lib/rack-seo/version.rb
+- lib/tasks/setup.rake
+- rack-seo.gemspec
+- spec/configuration_spec.rb
+- spec/fixtures/complex.html
+- spec/fixtures/simple.html
+- spec/rack-seo_spec.rb
+- spec/sample_configs/custom_paths.yml
+- spec/sample_configs/happy.yml
+- spec/sample_configs/sad.yml
+- spec/spec_helper.rb
+homepage: http://github.com/xavriley/rack-seo
+licenses:
+- MIT
+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.10
+signing_key: 
+specification_version: 3
+summary: Generate and manage meta tags on the fly using Rack Middleware
+test_files:
+- spec/configuration_spec.rb
+- spec/fixtures/complex.html
+- spec/fixtures/simple.html
+- spec/rack-seo_spec.rb
+- spec/sample_configs/custom_paths.yml
+- spec/sample_configs/happy.yml
+- spec/sample_configs/sad.yml
+- spec/spec_helper.rb