RubyGems - tophat - Versions diffs - 1.0.0 - Mend

tophat 1.0.0

Files changed (17) hide show

data/.document +5 -0
data/.gitignore +21 -0
data/LICENSE +20 -0
data/README.textile +108 -0
data/Rakefile +59 -0
data/lib/tophat.rb +10 -0
data/lib/tophat/core_extensions.rb +13 -0
data/lib/tophat/meta.rb +60 -0
data/lib/tophat/title.rb +88 -0
data/lib/tophat/version.rb +3 -0
data/rails/init.rb +1 -0
data/test/helper.rb +8 -0
data/test/test_tophat.rb +34 -0
data/test/test_tophat_meta.rb +71 -0
data/test/test_tophat_title.rb +98 -0
data/tophat.gemspec +65 -0
metadata +106 -0

data/.document ADDED

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

data/.gitignore ADDED

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+## TEXTMATE
+*.tmproj
+tmtags
+## EMACS
+*~
+\#*
+.\#*
+## VIM
+*.swp
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+## PROJECT::SPECIFIC

data/LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Steve Agalloco
+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.textile ADDED

@@ -0,0 +1,108 @@
+h1. TopHat
+TopHat is a set of view helpers to keep your layouts and views DRY.
+h2. Layout Usage
+You'll want to add the relevant TopHat helpers to your layouts:
+<pre>
+<head>
+  <%= title :site => "My website" %>
+  <%= keywords "Some default, keywords, that can be overridden" %>
+  <%= description "A description" %>
+</head>
+</pre>
+h2. View Usage
+To set the page title, use the title method to each of your views:
+<pre>
+<% title "My page title" %>
+</pre>
+When rendered, the page title will be included in your view.
+<pre>
+<head>
+  <title>My website | My page title</title>
+</head>
+</pre>
+h2. Usage Options
+Use these options to customize the title format:
+* :prefix (text between site name and separator)
+* :separator (text used to separate website name from page title)
+* :suffix (text between separator and page title)
+* :lowercase (when true, the page name will be lowercase)
+* :reverse (when true, the page and site names will be reversed)
+* :default (default title to use when title is blank)
+And here are a few examples to give you ideas.
+<pre>
+<%= title :separator => "&mdash;" %>
+<%= title :prefix => false, :separator => ":" %>
+<%= title :lowercase => true %>
+<%= title :reverse => true, :prefix => false %>
+<%= title :default => "The ultimate site for Rails" %>
+</pre>
+These options can be set as defaults for your layout, or when setting the title in your views, you can override any of the default settings by passing an optional hash
+<pre>
+<% title "My page title", :lowercase => true, :separator => "~" %>
+</pre>
+h2. Meta Tag Usage
+TopHat also works with keywords and descriptions.  In your view, simply declare the keywords and description.
+<pre>
+<% description('You say goodbye, I say hello.') %>
+<% keywords('John, Paul, George, Ringo') %>
+</pre>
+Keywords can also be passed as an array:
+<pre>
+<% keywords(%w{ John Paul George Ringo }) %>
+</pre>
+Then in your layout, add the keyword and description helpers:
+<pre>
+<%= keywords %>
+<%= description %>
+</pre>
+which will output the meta-tag:
+<pre>
+<meta name="keywords" content="John, Paul, George, Ringo" />
+<meta name="description" content="You say goodbye, I say hello." />
+</pre>
+keywords and descriptions can also take a default in the layout:
+<pre>
+<%= keywords :default => 'default keywords if none are passed' %>
+<%= description :default => 'default description if none is passed' %>
+</pre>
+h2. Note on Patches/Pull Requests
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+h2. Copyright
+Copyright (c) 2010 Steve Agalloco. See LICENSE for details.

data/Rakefile ADDED

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+$LOAD_PATH.unshift 'lib/'
+require 'tophat/version'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tophat"
+    gem.summary = %Q{simple view helpers for your layouts}
+    gem.description = %Q{simple view helpers for your layouts}
+    gem.email = "steve.agalloco@gmail.com"
+    gem.homepage = "http://github.com/spagalloco/tophat"
+    gem.authors = ["Steve Agalloco"]
+    gem.add_dependency "actionpack", ">= 2.3.5"
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.version = TopHat::VERSION
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+task :test => :check_dependencies
+task :default => :test
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = TopHat::VERSION
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tophat #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/tophat.rb ADDED

@@ -0,0 +1,10 @@
+require 'action_view'
+require 'tophat/version'
+require 'tophat/core_extensions'
+require 'tophat/title'
+require 'tophat/meta'
+Hash.send :include, TopHat::HashOnly unless Hash.instance_methods.include?("only")
+ActionView::Base.send :include, TopHat::TitleHelpers
+ActionView::Base.send :include, TopHat::MetaHelpers

data/lib/tophat/core_extensions.rb ADDED

@@ -0,0 +1,13 @@
+module TopHat
+  module HashOnly
+    # Returns a new hash with only the given keys.
+    def only(*keys)
+      reject {|key, value| !keys.include?(key) }
+    end
+    # Replaces the hash without only the given keys.
+    def only!(*keys)
+      replace(only(*keys))
+    end
+  end
+end

data/lib/tophat/meta.rb ADDED

@@ -0,0 +1,60 @@
+module TopHat
+  module MetaHelpers
+    def meta_tag(options)
+      # tag :meta, :name => options[:name], :content => options[:content]
+      "<meta name=\"#{options[:name]}\" content=\"#{options[:content]}\" />"
+    end
+    # page descriptions
+    # <meta name="description" content="Description goes here." />
+    def description(options=nil)
+      if options.is_a? String
+        @tophat_description = options
+      else
+        options ||= {}
+        options.merge!(:name => 'description')
+        if @tophat_description.blank?
+          options.merge!(:content => options.delete(:default))
+        else
+          options.merge!(:content => @tophat_description)
+        end
+        meta_tag(options) if options[:content]
+      end
+    end
+    # keywords
+    # <meta name="keywords" content="Keywords go here." />
+    def keywords(options=nil)
+      if options.is_a?(String)
+        @tophat_keywords = options
+      elsif options.is_a?(Array)
+        @tophat_keywods = options.join(', ')
+      else
+        options ||= {}
+        options.merge!(:name => 'keywords')
+        if @tophat_keywords.blank?
+          keywords = options.delete(:default)
+          if keywords && keywords.is_a?(Array)
+            keywords = keywords.join(', ')
+          end
+          options.merge!(:content => keywords)
+        else
+          options.merge!(:content => @tophat_keywords)
+        end
+        meta_tag(options) if options[:content]
+      end
+    end
+  end
+end

data/lib/tophat/title.rb ADDED

@@ -0,0 +1,88 @@
+module TopHat
+  module TitleHelpers
+    def title(title, options={})
+      if title.is_a? String
+        save_title(title, options)
+      else
+        display_title(title)
+      end
+    end
+    def save_title(title, options)
+      @tophat_title = title.gsub(/<\/?[^>]*>/, '')
+      @tophat_title_options = options
+      title
+    end
+    def display_title(options)
+      options = options.merge(@tophat_title_options) unless @tophat_title_options.nil? || @tophat_title_options.empty?
+      # Prefix (leading space)
+      if options[:prefix]
+        prefix = options[:prefix]
+      elsif options[:prefix] == false
+        prefix = ''
+      else
+        prefix = ' '
+      end
+      # Separator
+      unless options[:separator].blank?
+        separator = options[:separator]
+      else
+        separator = '|'
+      end
+      # Suffix (trailing space)
+      if options[:suffix]
+        suffix = options[:suffix]
+      elsif options[:suffix] == false
+        suffix = ''
+      else
+        suffix = ' '
+      end
+      site_name = options[:site]
+      # Lowercase title?
+      if options[:lowercase] == true
+        @tophat_title.downcase! unless @tophat_title.blank?
+        site_name.downcase! unless site_name.blank?
+      end
+      # Default page title
+      if @tophat_title.blank? && options[:default]
+        @tophat_title = options[:default]
+        @tophat_title_defaulted = true
+      end
+      # figure out reversing
+      if options[:reverse] == true
+        if @tophat_title_defaulted
+          @tophat_reserve = options[:reverse_on_default] != false
+        else
+          @tophat_reverse = true
+        end
+      else
+        @tophat_reverse = false
+      end
+      # Set website/page order
+      unless @tophat_title.blank?
+        if @tophat_reverse == true
+          # Reverse order => "Page : Website"
+          return content_tag(:title, @tophat_title + prefix + separator + suffix + site_name)
+        else
+          # Standard order => "Website : Page"
+          return content_tag(:title, site_name + prefix + separator + suffix + @tophat_title)
+        end
+      end
+      # If title is blank, return only website name
+      content_tag :title, site_name if options[:site]
+    end
+    alias t title
+  end
+end

data/lib/tophat/version.rb ADDED

@@ -0,0 +1,3 @@
+module TopHat
+  VERSION = '1.0.0'
+end

data/rails/init.rb ADDED

	@@ -0,0 +1 @@
1	+ require 'tophat'

data/test/helper.rb ADDED

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'test/unit'
+require 'action_view'
+require 'shoulda'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tophat'

data/test/test_tophat.rb ADDED

@@ -0,0 +1,34 @@
+require 'helper'
+class TopHatPluginTestCase < Test::Unit::TestCase
+  context "loading the TopHat plugin" do
+    setup do
+      @template = ActionView::Base.new
+    end
+    should "be mixed into ActionView::Base" do
+      assert ActionView::Base.included_modules.include?(TopHat::TitleHelpers)
+      assert ActionView::Base.included_modules.include?(TopHat::MetaHelpers)
+    end
+    should "respond to 'title' helper" do
+      assert @template.respond_to?(:title)
+    end
+    should "respond to 'title' helper alias" do
+      assert @template.respond_to?(:t)
+    end
+    should "respond to 'description' helper" do
+      assert @template.respond_to?(:description)
+    end
+    should "respond to 'keywords' helper" do
+      assert @template.respond_to?(:keywords)
+    end
+  end
+end

data/test/test_tophat_meta.rb ADDED

@@ -0,0 +1,71 @@
+require 'helper'
+class TopHatMetaTestCase < Test::Unit::TestCase
+  context "using the meta helpers" do
+    setup do
+      @template = ActionView::Base.new
+    end
+    context "keywords" do
+      context "defined as an array" do
+        setup do
+          @keywords = %w{ John Paul George Ringo }
+        end
+        should "save keywords" do
+          assert_equal @template.keywords(@keywords), @keywords.join(', ')
+        end
+        should "use default keywords if keywords is empty" do
+          assert_equal @template.keywords(:default => @keywords), "<meta name=\"keywords\" content=\"#{@keywords.join(', ')}\" />"
+        end
+      end
+      context "defined as a string" do
+        setup do
+          @keywords = "John, Paul, George, Ringo"
+        end
+        should "save keywords" do
+          assert_equal @template.keywords(@keywords), @keywords
+        end
+        should "use default keywords passed as a string if keywords is empty" do
+          assert_equal @template.keywords(:default => @keywords), "<meta name=\"keywords\" content=\"#{@keywords}\" />"
+        end
+      end
+      should "not return a tag if no default is configured and no keywords are defined" do
+        assert_nil @template.keywords
+      end
+    end
+    context "descriptions" do
+      should "save the description" do
+        desc = "Cinderella story. Outta nowhere. A former greenskeeper, now, about to become the Masters champion."
+        assert_equal @template.description(desc), desc
+      end
+      should "use the default description if no description is defined" do
+        desc = "A flute without holes, is not a flute. A donut without a hole, is a Danish."
+        assert_equal @template.description(:default => desc), "<meta name=\"description\" content=\"#{desc}\" />"
+      end
+      should "not return a tag if no default is configured and no description is defined" do
+        assert_nil @template.description
+      end
+    end
+  end
+end

data/test/test_tophat_title.rb ADDED

@@ -0,0 +1,98 @@
+require 'helper'
+class TopHatTitleTestCase < Test::Unit::TestCase
+  context "when using the title helpers" do
+    setup do
+      @template = ActionView::Base.new
+    end
+    context "saving a title" do
+      should "save the title" do
+        assert_equal @template.title('Kind of Blue'), 'Kind of Blue'
+      end
+    end
+    context "displaying a title" do
+      should "use the website name if title is empty" do
+        assert_equal @template.title(:site => "Miles Davis"), "<title>Miles Davis</title>"
+      end
+      should "use website before page by default" do
+        save_basic_title
+        assert_equal @template.title(:site => "Miles Davis"), "<title>Miles Davis | Kind of Blue</title>"
+      end
+      should "only use markup in titles in the view" do
+        assert_equal save_basic_title("<b>Kind of Blue</b>"), "<b>Kind of Blue</b>"
+        assert_equal @template.title(:site => "Miles Davis"), "<title>Miles Davis | Kind of Blue</title>"
+      end
+      should "use page before website if :reverse" do
+        save_basic_title
+        assert_equal @template.title(:site => "Miles Davis", :reverse => true), "<title>Kind of Blue | Miles Davis</title>"
+      end
+      should "use website before page if :reverse and :reverse_on_default" do
+        assert_equal @template.title(:site => "John Coltrane", :default => "My Favorite Things", :reverse => true, :reverse_on_default => false), "<title>John Coltrane | My Favorite Things</title>"
+      end
+      should "be lowercase if :lowercase" do
+        save_basic_title
+        assert_equal @template.title(:site => "Miles Davis", :lowercase => true), "<title>miles davis | kind of blue</title>"
+      end
+      should "use custom separator if :separator" do
+        save_basic_title
+        assert_equal @template.title(:site => "Miles Davis", :separator => "-"), "<title>Miles Davis - Kind of Blue</title>"
+        assert_equal @template.title(:site => "Miles Davis", :separator => ":"), "<title>Miles Davis : Kind of Blue</title>"
+        assert_equal @template.title(:site => "Miles Davis", :separator => "&mdash;"), "<title>Miles Davis &mdash; Kind of Blue</title>"
+      end
+      should "use custom prefix and suffix if available" do
+        save_basic_title
+        assert_equal @template.title(:site => "Miles Davis", :prefix => " |", :suffix => "| "), "<title>Miles Davis ||| Kind of Blue</title>"
+      end
+      should "collapse prefix if false" do
+        save_basic_title
+        assert_equal @template.title(:site => "Miles Davis", :prefix => false, :separator => ":"), "<title>Miles Davis: Kind of Blue</title>"
+      end
+      should "collapse suffix if false" do
+        save_basic_title
+        assert_equal @template.title(:site => "Miles Davis", :suffix => false, :separator => "~"), "<title>Miles Davis ~Kind of Blue</title>"
+      end
+      should "use all custom options if available" do
+        save_basic_title
+        custom_options = { :site => "Miles Davis", :prefix => " ", :suffix => " ", :separator => "-", :lowercase => true, :reverse => true }
+        assert_equal @template.title(custom_options), "<title>kind of blue - miles davis</title>"
+      end
+      should "use default one if title is not present or blank" do
+        save_basic_title("")
+        assert_equal @template.title(:site => "Miles Davis", :default => "Round About Midnight"), "<title>Miles Davis | Round About Midnight</title>"
+      end
+      should "allow custom options per title" do
+        save_custom_title
+        assert_equal @template.title(:site => "Freddie Freeloader"), "<title>Kind of Blue | Freddie Freeloader</title>"
+      end
+    end
+  end
+  def save_basic_title(title='Kind of Blue')
+    @template.title(title)
+  end
+  def save_custom_title(title='Kind of Blue')
+    @template.title(title, { :reverse => true })
+  end
+end

data/tophat.gemspec ADDED

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{tophat}
+  s.version = "1.0.0"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Steve Agalloco"]
+  s.date = %q{2010-05-01}
+  s.description = %q{simple view helpers for your layouts}
+  s.email = %q{steve.agalloco@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "lib/tophat.rb",
+     "lib/tophat/core_extensions.rb",
+     "lib/tophat/meta.rb",
+     "lib/tophat/title.rb",
+     "lib/tophat/version.rb",
+     "rails/init.rb",
+     "test/helper.rb",
+     "test/test_tophat.rb",
+     "test/test_tophat_meta.rb",
+     "test/test_tophat_title.rb",
+     "tophat.gemspec"
+  ]
+  s.homepage = %q{http://github.com/spagalloco/tophat}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{simple view helpers for your layouts}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_tophat.rb",
+     "test/test_tophat_meta.rb",
+     "test/test_tophat_title.rb"
+  ]
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<actionpack>, [">= 2.3.5"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<actionpack>, [">= 2.3.5"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<actionpack>, [">= 2.3.5"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end

metadata ADDED

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: tophat
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors:
+- Steve Agalloco
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-05-01 00:00:00 -04:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: simple view helpers for your layouts
+email: steve.agalloco@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.textile
+files:
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- lib/tophat.rb
+- lib/tophat/core_extensions.rb
+- lib/tophat/meta.rb
+- lib/tophat/title.rb
+- lib/tophat/version.rb
+- rails/init.rb
+- test/helper.rb
+- test/test_tophat.rb
+- test/test_tophat_meta.rb
+- test/test_tophat_title.rb
+- tophat.gemspec
+has_rdoc: true
+homepage: http://github.com/spagalloco/tophat
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.6
+signing_key:
+specification_version: 3
+summary: simple view helpers for your layouts
+test_files:
+- test/helper.rb
+- test/test_tophat.rb
+- test/test_tophat_meta.rb
+- test/test_tophat_title.rb