headshop 0.2.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rvmrc

@@ -0,0 +1 @@
+rvm ree@headshop

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'bundler', '~> 1.0.0'
+  gem 'jeweler', '~> 1.5.2'
+  gem 'mocha'
+  gem 'providence'
+  gem 'rails'
+  gem 'rspec-rails'
+  gem 'rcov'
+end

data/Gemfile.lock

@@ -0,0 +1,105 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.7)
+      actionpack (= 3.0.7)
+      mail (~> 2.2.15)
+    actionpack (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+    activesupport (3.0.7)
+    arel (2.0.9)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    growl (1.0.3)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mocha (0.9.12)
+    polyglot (0.3.1)
+    providence (0.1.2)
+      growl
+      rb-fsevent
+      watchr
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.7)
+      actionmailer (= 3.0.7)
+      actionpack (= 3.0.7)
+      activerecord (= 3.0.7)
+      activeresource (= 3.0.7)
+      activesupport (= 3.0.7)
+      bundler (~> 1.0)
+      railties (= 3.0.7)
+    railties (3.0.7)
+      actionpack (= 3.0.7)
+      activesupport (= 3.0.7)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rb-fsevent (0.4.0)
+    rcov (0.9.9)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.2)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    rspec-rails (2.5.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.5.0)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.27)
+    watchr (0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  mocha
+  providence
+  rails
+  rcov
+  rspec-rails

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2010 Chuck Collins
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,40 @@
+Headshop
+==========
+
+Meta tag management to DRY up your views and SEO the crap out of your site.
+
+Contributing to providence
+--------------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2011 Chuck Collins
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "headshop"
+  gem.homepage = "http://github.com/ccollins/headshop"
+  gem.license = "MIT"
+  gem.summary = "Meta tag management to DRY up your views and SEO the crap out of your site."
+  gem.description = "Manage meta tags through an external yml file.  Easy configuration.  Takes ugly boilerplate away from your app."
+  gem.email = "chuck.collins@gmail.com"
+  gem.authors = ["Chuck Collins"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "headshop #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/lib/headshop/meta_tag_helper.rb

@@ -0,0 +1,27 @@
+module Headshop::MetaTagHelper
+  def meta_tag
+    write_meta_data(get_meta_data_for(controller_name, action_name))
+  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')
+      Headshop.meta_data['default_meta']
+    end
+  end
+  
+  def apply_base_tag(key, meta_data)
+    if Headshop.meta_data.has_key?('base_meta') && Headshop.meta_data['base_meta'].has_key?(key)
+      "#{Headshop.meta_data['base_meta'][key]} #{meta_data}"
+    else
+      meta_data
+    end
+  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
+  end
+end

data/lib/headshop.rb

@@ -0,0 +1,27 @@
+require 'action_view'
+require 'yaml'
+
+module Headshop
+  mattr_accessor :config_file, :meta_data
+  
+  def self.config_file= config_file
+    @@config_file = config_file
+    read_config_file @@config_file
+  end
+  
+  def self.read_config_file config_file
+    self.meta_data = YAML.load_file(config_file)
+  end
+  
+  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/spec/headshop.yml

@@ -0,0 +1,21 @@
+base_meta:
+  description: base | 
+  keywords: base, 
+  title: base |
+  
+default_meta:
+  description: 'default_description'
+  keywords: 'default_keywords'
+  title: 'default_title'
+  
+controller:
+  action:
+    description: 'action_description'
+    keywords: 'action_keywords'
+    title: 'action_title'
+  
+tester:
+  default_meta:
+    description: 'tester_description'
+    keywords: 'tester_keywords'
+    title: 'tester_title'

data/spec/headshop_no_default_no_base.yml

@@ -0,0 +1,11 @@
+controller:
+  action:
+    description: 'action_description'
+    keywords: 'action_keywords'
+    title: 'action_title'
+  
+tester:
+  default_meta:
+    description: 'tester_description'
+    keywords: 'tester_keywords'
+    title: 'tester_title'

data/spec/lib/headshop/meta_tag_helper_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Headshop::MetaTagHelper do
+  before(:each) do
+    Headshop.setup do |config|
+      config.config_file = File.join(File.dirname(__FILE__), '..', '..', 'headshop.yml')
+    end
+      
+    Class.send(:include, Headshop::MetaTagHelper)
+  end
+  
+  it { Class.should respond_to(:meta_tag) }
+  
+  context "#apply_base_tag" do
+    it "should prepend the base tag" do
+      Headshop.meta_data['base_meta'] = {'test' => 'base |'}
+      Class.apply_base_tag('test', "default_test").should == "base | default_test"
+    end
+    
+    it "should return the tag if no base match found" do
+      Class.apply_base_tag('test', "default_test").should == "default_test"
+    end
+  end
+  
+  context "#meta_tag" do
+    before(:each) do
+      Class.stub!(:controller_name).and_return('controller')
+      Class.stub!(:action_name).and_return('action')
+    end
+    
+    it "should call for and write the meta data" do
+      Class.should_receive(:get_meta_data_for).with('controller', 'action').and_return('yippe')
+      Class.should_receive(:write_meta_data).with('yippe')
+      Class.meta_tag
+    end
+    
+    it "should write the meta data for controller/action with no base/default" do
+      Headshop.setup do |config|
+        config.config_file = File.join(File.dirname(__FILE__), '..', '..', 'headshop_no_default_no_base.yml')
+      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
+    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
+    end
+  end
+  
+  context "#get_meta_data_for" do
+    it "should return default data when a controller and action arent found" do
+      Class.get_meta_data_for('no_controller', 'no_action').should == {"title"=>"default_title", "description"=>"default_description", "keywords"=>"default_keywords"}
+    end
+    
+    it "should return default data when a controller isnt found" do
+      Class.get_meta_data_for('no_controller', 'action').should == {"title"=>"default_title", "description"=>"default_description", "keywords"=>"default_keywords"}
+    end
+    
+    it "should return meta data for a controller and action" do
+      Class.get_meta_data_for('controller', 'action').should == {"title"=>"action_title", "description"=>"action_description", "keywords"=>"action_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')
+      end
+      
+      Class.get_meta_data_for('no_controller', 'no_action').should be_nil
+    end
+  end
+  
+  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
+    end
+  end
+end

data/spec/lib/headshop_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Headshop do
+  let(:config_file) { 'headshop.yml' }
+  
+  it { should respond_to(:setup) }
+  it { should respond_to(:config_file=) }
+  it { should respond_to(:config_file) }
+  it { should respond_to(:meta_data) }
+  
+  context "#config_file=" do
+    before(:each) do
+      Headshop.should_receive(:read_config_file).and_return('')
+    end
+    
+    it "should set the file path and read it in" do
+      Headshop.setup do |config|
+        config.config_file = 'shamalamadingdong'
+      end
+      Headshop.config_file.should == 'shamalamadingdong'
+    end
+  end
+  
+  context "#read_config_file" do
+    it "should read and parse the yaml file" do
+      YAML.should_receive(:load_file).with(config_file).and_return({:test => 'test'})
+      Headshop.read_config_file(config_file)
+      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

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'rspec'
+require "action_controller/railtie"
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+
+require File.join(File.dirname(__FILE__), "..", "lib", "headshop")

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification 
+name: headshop
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Chuck Collins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: mocha
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: providence
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rails
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rspec-rails
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rcov
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+description: Manage meta tags through an external yml file.  Easy configuration.  Takes ugly boilerplate away from your app.
+email: chuck.collins@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- .document
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- 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
+has_rdoc: true
+homepage: http://github.com/ccollins/headshop
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Meta tag management to DRY up your views and SEO the crap out of your site.
+test_files: 
+- spec/lib/headshop/meta_tag_helper_spec.rb
+- spec/lib/headshop_spec.rb
+- spec/spec_helper.rb