headshop 0.2.1 → 0.3.1

data/README.markdown

@@ -3,6 +3,58 @@ Headshop
 
 Meta tag management to DRY up your views and SEO the crap out of your site.
 
+Installation
+------------
+
+To get started with headshop add it to your gemfile:
+
+    gem 'headshop'
+    
+Usage
+-----
+
+Headshop relies on a yml file to determine the meta tags to display.  Create an initializer file (config/intializers/headshop.rb) and tell headshop where your yml file is located.
+
+    Headshop.setup do |config|
+      config.config_file = File.join(Rails.root, 'config', 'headshop.yml')
+    end
+    
+Headshop will search the yml file with the controller name/action name to find the correct tags.  To populate the meta tags for the index action on the landing controller:
+
+    landing:
+      index:
+        title: Landing Page
+        description: Landing Page
+        keywords: landing, page
+        
+Headshop will also look for default meta tags if they are defined.  If headshop cannot locate the tags for a controller/action pair, the default tags will be displayed.
+
+    default_meta:
+      title: Default Page
+      description: Default Page
+      keywords: default, page
+      
+You can also apply base tags to each matching tag:
+
+    base_meta:
+      title: Headshop |
+      description: Headshop |
+      keywords: headshop
+      
+This will output (given the default_meta above):
+
+    <title>Headshop | Default Page</title>
+    <meta name='title' content='Headshop | Default Page' />
+    <meta name='description' content='Headshop | Default Page' />
+    <meta name='keywords' content='headshop, default, page' />
+    
+Meta tags aren't limited to title, description and keywords.  Headshop will apply any meta tag found in the yml file to your view.
+
+Display the meta tag in your view with the meta_tag helper:
+
+    = meta_tag
+
+
 Contributing to providence
 --------------------------
  

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.1

data/headshop.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{headshop}
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chuck Collins"]
+  s.date = %q{2011-05-13}
+  s.description = %q{Manage meta tags through an external yml file.  Easy configuration.  Takes ugly boilerplate away from your app.}
+  s.email = %q{chuck.collins@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "headshop.gemspec",
+    "lib/headshop.rb",
+    "lib/headshop/meta_tag_helper.rb",
+    "spec/headshop.yml",
+    "spec/headshop_no_default_no_base.yml",
+    "spec/lib/headshop/meta_tag_helper_spec.rb",
+    "spec/lib/headshop_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ccollins/headshop}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Meta tag management to DRY up your views and SEO the crap out of your site.}
+  s.test_files = [
+    "spec/lib/headshop/meta_tag_helper_spec.rb",
+    "spec/lib/headshop_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<providence>, [">= 0"])
+      s.add_development_dependency(%q<rails>, [">= 0"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<providence>, [">= 0"])
+      s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<providence>, [">= 0"])
+    s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<rspec-rails>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/headshop.rb

@@ -16,12 +16,7 @@ module Headshop
   def self.setup
      yield self
   end
-  
-  def self.has_meta_data_for?(controller, action)
-    self.meta_data.has_key?(controller) && self.meta_data[controller].has_key?(action)
-  end
 end
 
 require 'headshop/meta_tag_helper'
-
 ActionView::Base.send :include, Headshop::MetaTagHelper

data/lib/headshop/meta_tag_helper.rb

@@ -1,12 +1,29 @@
+require 'action_view'
+
 module Headshop::MetaTagHelper
+  include ActionView::Helpers::TagHelper
+  
   def meta_tag
-    write_meta_data(get_meta_data_for(controller_name, action_name))
+    write_meta_data(get_meta_data_for(controller_path, action_name))
+  end
+  
+  def find_meta_data_for(controller, action)    
+    controller_path = controller.split('/')
+    md = Headshop.meta_data
+    has_controller_meta_data = true
+    
+    controller_path.each do |key|
+      has_controller_meta_data = has_controller_meta_data & md.has_key?(key)
+      md = md[key] if has_controller_meta_data
+    end
+
+    md[action] if has_controller_meta_data && md.has_key?(action)
   end
   
   def get_meta_data_for(controller, action)
-    if Headshop.has_meta_data_for?(controller, action) 
-      Headshop.meta_data[controller][action] 
-    elsif Headshop.meta_data.has_key?('default_meta')
+    if meta_data = find_meta_data_for(controller, action)
+      meta_data
+    else
       Headshop.meta_data['default_meta']
     end
   end
@@ -20,8 +37,8 @@ module Headshop::MetaTagHelper
   end
   
   def write_meta_data meta_data
-    result = meta_data.reduce('') { |memo, obj| memo += "<meta name='#{obj[0]}' content='#{apply_base_tag(obj[0], obj[1])}' />\n" }
-    result += "<title>#{apply_base_tag('title', meta_data['title'])}</title>\n" if meta_data.has_key?('title')
-    result.respond_to?(:html_safe) ? result.html_safe : result
+    display_meta = meta_data.collect { |meta| tag(:meta, {:name => meta[0], :content => apply_base_tag(meta[0], meta[1])}, false, false) }
+    display_meta.push(content_tag(:title, apply_base_tag('title', meta_data['title']), nil, false)) if meta_data.has_key?('title')
+    display_meta.join("\n").html_safe
   end
 end

data/spec/headshop.yml

@@ -13,7 +13,29 @@ controller:
     description: 'action_description'
     keywords: 'action_keywords'
     title: 'action_title'
+    
+namespace:
+  controller:
+    action:
+      description: 'namespace_description'
+      keywords: 'namespace_keywords'
+      title: 'namespace_title'
   
+n:
+  a:
+    m:
+      e:
+        s:
+          p:
+            a:
+              c:
+                e:
+                  controller:
+                    action:
+                      description: 'namespace_description'
+                      keywords: 'namespace_keywords'
+                      title: 'namespace_title'
+                      
 tester:
   default_meta:
     description: 'tester_description'

data/spec/lib/headshop/meta_tag_helper_spec.rb

@@ -24,7 +24,7 @@ describe Headshop::MetaTagHelper do
   
   context "#meta_tag" do
     before(:each) do
-      Class.stub!(:controller_name).and_return('controller')
+      Class.stub!(:controller_path).and_return('controller')
       Class.stub!(:action_name).and_return('action')
     end
     
@@ -40,18 +40,18 @@ describe Headshop::MetaTagHelper do
       end
     
       meta_data = Class.meta_tag
-      /<title>action_title<\/title>\n/.should =~ meta_data
-      /<meta name='title' content='action_title' \/>\n/.should =~ meta_data
-      /<meta name='description' content='action_description' \/>\n/.should =~ meta_data
-      /<meta name='keywords' content='action_keywords' \/>\n/.should =~ meta_data
+      /<title>action_title<\/title>/.should =~ meta_data
+      /<meta content="action_title" name="title" \/>/.should =~ meta_data
+      /<meta content="action_description" name="description" \/>/.should =~ meta_data
+      /<meta content="action_keywords" name="keywords" \/>/.should =~ meta_data
     end
     
     it "should write the meta data for controller/action" do
       meta_data = Class.meta_tag
-      /<title>base | action_title<\/title>\n/.should =~ meta_data
-      /<meta name='title' content='base | action_title' \/>\n/.should =~ meta_data
-      /<meta name='description' content='base | action_description' \/>\n/.should =~ meta_data
-      /<meta name='keywords' content='base, action_keywords' \/>\n/.should =~ meta_data
+      /<title>base | action_title<\/title>/.should =~ meta_data
+      /<meta content="base | action_title" name="title" \/>/.should =~ meta_data
+      /<meta content="base | action_description" name="description" \/>/.should =~ meta_data
+      /<meta content="base, action_keywords" name="keywords" \/>/.should =~ meta_data
     end
   end
   
@@ -68,6 +68,10 @@ describe Headshop::MetaTagHelper do
       Class.get_meta_data_for('controller', 'action').should == {"title"=>"action_title", "description"=>"action_description", "keywords"=>"action_keywords"}
     end
     
+    it "should return meta data for a namespaced controller and action" do
+      Class.get_meta_data_for('n/a/m/e/s/p/a/c/e/controller', 'action').should == {"title"=>"namespace_title", "description"=>"namespace_description", "keywords"=>"namespace_keywords"}
+    end
+    
     it "should return nil when a controller and action arent found and no default set" do
       Headshop.setup do |config|
         config.config_file = File.join(File.dirname(__FILE__), '..', '..', 'headshop_no_default_no_base.yml')
@@ -80,7 +84,39 @@ describe Headshop::MetaTagHelper do
   context "#write_meta_data" do
     it "should write meta data for anything" do
       meta_data = Class.write_meta_data({:yousocrazy => :tester})
-      /<meta name='yousocrazy' content='tester' \/>\n/.should =~ meta_data
+      /<meta content="tester" name="yousocrazy" \/>/.should =~ meta_data
+    end
+  end
+  
+  context "#find_meta_data_for" do
+    before(:all) do
+      Headshop.setup do |config|
+        config.config_file = File.join(File.dirname(__FILE__), '..', '..', 'headshop.yml')
+      end
+    end
+  
+    it "should return nil if no meta data" do
+      Class.find_meta_data_for('noway', 'noway').should be_nil
+    end
+    
+    it "should return true if the controller/action key are found" do
+      Class.find_meta_data_for('controller', 'action').should == {"title"=>"action_title", "description"=>"action_description", "keywords"=>"action_keywords"}
+    end
+    
+    it "should return true for a namespaced controller" do
+      Class.find_meta_data_for('namespace/controller', 'action').should == {"title"=>"namespace_title", "description"=>"namespace_description", "keywords"=>"namespace_keywords"}
+    end
+    
+    it "should return nil for a namespaced controller that is not found" do
+      Class.find_meta_data_for('noway/controller', 'action').should be_nil
+    end
+    
+    it "should be able to deeply nest a controller" do
+      Class.find_meta_data_for('n/a/m/e/s/p/a/c/e/controller', 'action').should == {"title"=>"namespace_title", "description"=>"namespace_description", "keywords"=>"namespace_keywords"}
+    end
+    
+    it "should be able to deeply nest a controller and return nil" do
+      Class.find_meta_data_for('s/h/a/m/a/l/a/m/a/d/i/n/g/o/n/g/controller', 'action').should be_nil
     end
   end
 end

data/spec/lib/headshop_spec.rb

@@ -28,20 +28,4 @@ describe Headshop do
       Headshop.meta_data.should == {:test => 'test'}
     end
   end
-  
-  context "#has_meta_data_for?" do
-    before(:all) do
-      Headshop.setup do |config|
-        config.config_file = File.join(File.dirname(__FILE__), '..', 'headshop.yml')
-      end
-    end
-  
-    it "should return false if no meta data" do
-      Headshop.has_meta_data_for?('noway', 'noway').should be_false
-    end
-    
-    it "should return true if the controller/action key are found" do
-      Headshop.has_meta_data_for?('controller', 'action').should be_true
-    end
-  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: headshop
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 17
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 1
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Chuck Collins
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-10 00:00:00 -05:00
+date: 2011-05-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -138,6 +138,7 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
+- headshop.gemspec
 - lib/headshop.rb
 - lib/headshop/meta_tag_helper.rb
 - spec/headshop.yml