RubyGems - tophat - Versions diffs - 1.2.0 → 1.3.0 - Mend

tophat 1.2.0 → 1.3.0

Files changed (31) hide show

data/.gitignore +3 -21
data/.rspec +3 -0
data/Gemfile +2 -0
data/LICENSE +1 -1
data/README.md +100 -0
data/Rakefile +18 -58
data/lib/tophat/meta.rb +16 -25
data/lib/tophat/opengraph.rb +11 -12
data/lib/tophat/robots.rb +4 -6
data/lib/tophat/stylesheet.rb +32 -28
data/lib/tophat/title.rb +64 -68
data/lib/tophat/version.rb +1 -1
data/lib/tophat.rb +0 -4
data/spec/spec_helper.rb +43 -0
data/spec/tophat/meta_helper_spec.rb +64 -0
data/spec/tophat/opengraph_helper_spec.rb +71 -0
data/spec/tophat/robots_helper_spec.rb +39 -0
data/spec/tophat/stylesheet_helper_spec.rb +148 -0
data/spec/tophat/title_helper_spec.rb +96 -0
data/spec/tophat_spec.rb +73 -0
data/tophat.gemspec +23 -65
metadata +108 -49
data/README.textile +0 -123
data/rails/init.rb +0 -1
data/test/helper.rb +0 -9
data/test/test_opengraph.rb +0 -88
data/test/test_robots.rb +0 -54
data/test/test_tophat.rb +0 -55
data/test/test_tophat_meta.rb +0 -76
data/test/test_tophat_stylesheets.rb +0 -119
data/test/test_tophat_title.rb +0 -103

data/.gitignore CHANGED Viewed

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

data/.rspec ADDED Viewed

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/Gemfile ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ source "http://rubygems.org"
2	+ gemspec

data/LICENSE CHANGED Viewed

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Steve Agalloco
+Copyright (c) 2011 Steve Agalloco
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md ADDED Viewed

@@ -0,0 +1,100 @@
+TopHat
+======
+TopHat is a set of view helpers to keep your layouts and views DRY.
+Layout Usage
+------------
+You'll want to add the relevant TopHat helpers to your layouts:
+    <head>
+      <%= title :site => "My website" %>
+      <%= keywords :default => "Some default, keywords, that can be overridden" %>
+      <%= description :default => "A description" %>
+    </head>
+View Usage
+----------
+To set the page title, use the title method to each of your views:
+    <% title "My page title" %>
+When rendered, the page title will be included in your view.
+    <head>
+      <title>My website | My page title</title>
+    </head>
+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.
+    <%= title :separator => "|" %>
+    <%= title :prefix => false, :separator => ":" %>
+    <%= title :lowercase => true %>
+    <%= title :reverse => true, :prefix => false %>
+    <%= title :default => "The ultimate site for Rails" %>
+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
+    <% title "My page title", :lowercase => true, :separator => "~" %>
+Meta Tag Usage
+--------------
+TopHat also works with keywords and descriptions.  In your view, simply declare the keywords and description.
+    <% description('You say goodbye, I say hello.') %>
+    <% keywords('John, Paul, George, Ringo') %>
+Keywords can also be passed as an array:
+    <% keywords(%w{ John Paul George Ringo }) %>
+Then in your layout, add the keyword and description helpers:
+    <%= keywords %>
+    <%= description %>
+which will output the meta-tags:
+    <meta name="keywords" content="John, Paul, George, Ringo" />
+    <meta name="description" content="You say goodbye, I say hello." />
+keywords and descriptions can also take a default in the layout:
+    <%= keywords :default => 'Yoko, Linda' %>
+    <%= description :default => 'default description if none is passed' %>
+want to merge your default tags with those in your view? just pass merge_default => true
+    <%= keywords :default => 'Yoko, Linda', :merge_default => true %>
+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.
+Copyright
+---------
+Copyright (c) 2011 Steve Agalloco. See LICENSE for details.

data/Rakefile CHANGED Viewed

@@ -1,59 +1,19 @@
-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
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['lib/**/*.rb']
+    task.options = [
+      '--protected',
+      '--output-dir', 'doc/yard',
+      '--markup', 'markdown',
+    ]
   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
+end

data/lib/tophat/meta.rb CHANGED Viewed

@@ -3,51 +3,42 @@ module TopHat
     # page descriptions
     # <meta name="description" content="Description goes here." />
-    def description(options=nil)
+    def description(options={})
       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
+      else
+        options[:name] = 'description'
+        options[:content] = @tophat_description || options.delete(:default)
         tag(:meta, options) if options[:content]
-      end
+      end
     end
     # keywords
     # <meta name="keywords" content="Keywords go here." />
-    def keywords(options=nil)
+    def keywords(options={})
       if options.is_a?(String)
         @tophat_keywords = options
       elsif options.is_a?(Array)
-        @tophat_keywods = options.join(', ')
-      else
-        options ||= {}
-        options.merge!(:name => 'keywords')
+        @tophat_keywords = options.join(', ')
+      else
+        options[:name] = 'keywords'
         default_keywords = options.delete(:default) || []
         display_keywords = @tophat_keywords.blank? ? default_keywords : @tophat_keywords
         # normalize the keywords
-        default_keywords = default_keywords.is_a?(String) ? default_keywords.split(', ') : default_keywords
-        display_keywords = display_keywords.is_a?(String) ? display_keywords.split(', ') : display_keywords
+        default_keywords = default_keywords.is_a?(String) ? default_keywords.split(',') : default_keywords
+        display_keywords = display_keywords.is_a?(String) ? display_keywords.split(',') : display_keywords
         # merge keyword arrays if merge is set to true
         display_keywords += default_keywords if options.delete(:merge_default) == true
-        options.merge!(:content => display_keywords.uniq.join(', '))
+        options.merge!(:content => display_keywords.uniq.join(', ').squeeze(' '))
         tag(:meta, options) if display_keywords.any?
-      end
+      end
     end
   end
 end

data/lib/tophat/opengraph.rb CHANGED Viewed

@@ -3,30 +3,30 @@ module TopHat
     class OpenGraphGenerator
       include ActionView::Helpers
       def initialize(options={})
         @app_id = options.delete(:app_id) if options && options.has_key?(:app_id)
         @admins = options.delete(:admins) if options && options.has_key?(:admins)
         @graph_data = {}
       end
       def merge(options={})
         @app_id = options.delete(:app_id) if options && options.has_key?(:app_id)
         @admins = options.delete(:admins) if options && options.has_key?(:admins)
       end
       def app_id
         output = @app_id ? tag(:meta, :property => 'fb:app_id', :content => @app_id) : ""
         output << '\n' unless output.blank?
         output
       end
       def admins
         output = @admins ? tag(:meta, :property => 'fb:admins', :content => [*@admins].join(',')) : ""
         output << '\n' unless output.blank?
         output
       end
       def render_graph_data
         output = ""
         @graph_data.each_pair do |key, value|
@@ -35,23 +35,23 @@ module TopHat
         end
         output
       end
       def type(t)
         @graph_data ||= {}
         @graph_data[:type] = t
       end
       def has_graph_data?
         @graph_data
       end
       def method_missing(method, *args, &block) #:nodoc
         @graph_data ||= {}
         @graph_data[method] = args.shift
       end
     end
     def opengraph(options=nil, &block)
       if options.kind_of? Hash
         @tophat_open_graph_defaults = options
@@ -69,7 +69,6 @@ module TopHat
         output
       end
     end
   end
 end

data/lib/tophat/robots.rb CHANGED Viewed

@@ -4,16 +4,14 @@ module TopHat
     def noindex(descriptor='robots')
       tag(:meta, :name => descriptor, :content => 'noindex')
     end
     def nofollow(descriptor='robots')
       tag(:meta, :name => descriptor, :content => 'nofollow')
     end
     def canonical(path=nil)
-      if path
-        tag(:link, :rel => 'canonical', :href => path)
-      end
+      tag(:link, :rel => 'canonical', :href => path) if path
     end
   end
 end

data/lib/tophat/stylesheet.rb CHANGED Viewed

@@ -4,7 +4,7 @@ module TopHat
     def ie_5_conditional(operator = nil, &block)
       ie_conditional(5, operator, &block)
     end
     def ie_5_5_conditional(operator = nil, &block)
       ie_conditional(5.5, operator, &block)
     end
@@ -12,70 +12,74 @@ module TopHat
     def ie_6_conditional(operator = nil, &block)
       ie_conditional(6, operator, &block)
     end
     def ie_7_conditional(operator = nil, &block)
       ie_conditional(7, operator, &block)
     end
     def ie_8_conditional(operator = nil, &block)
       ie_conditional(8, operator, &block)
     end
+    def ie_9_conditional(operator = nil, &block)
+      ie_conditional(9, operator, &block)
+    end
     def ie_conditional(version = nil, operator = nil, &block)
       browser_conditional('IE', version, operator, &block)
     end
     def gecko_conditional(operator = nil, &block)
       browser_conditional('Gecko', nil, operator, &block)
     end
     def webkit_conditional(operator = nil, &block)
       browser_conditional('Webkit', nil, operator, &block)
     end
     def mobile_safari_conditional(operator = nil, &block)
       browser_conditional('SafMob', nil, operator, &block)
     end
     def opera_conditional(operator = nil, &block)
       browser_conditional('Opera', nil, operator, &block)
     end
     def ie_mac_conditional(operator = nil, &block)
       browser_conditional('IEMac', nil, operator, &block)
     end
     def konqueror_conditional(operator = nil, &block)
       browser_conditional('Konq', nil, operator, &block)
     end
     def ie_mobile_conditional(operator = nil, &block)
       browser_conditional('IEmob', nil, operator, &block)
     end
     def psp_conditional(operator = nil, &block)
       browser_conditional('PSP', nil, operator, &block)
     end
     def net_front_conditional(operator = nil, &block)
       browser_conditional('NetF', nil, operator, &block)
     end
     private
-    def browser_conditional(browser, version = nil, operator = nil, &block)
-      unless operator.blank?
-        operator = operator.to_s
-        operator = '!' if operator == 'not'
-        operator << " " unless operator == '!'
+      def browser_conditional(browser, version = nil, operator = nil, &block)
+        unless operator.blank?
+          operator = operator.to_s
+          operator = '!' if operator == 'not'
+          operator << " " unless operator == '!'
+        end
+        browser_version = version.blank? ? "" : " #{version}"
+        output = "<!--[if #{operator}#{browser}#{browser_version}]>\n"
+        output << yield if block_given?
+        output << "\n<![endif]-->"
       end
-      browser_version = version.blank? ? "" : " #{version}"
-      output = "<!--[if #{operator}#{browser}#{browser_version}]>\n"
-      output << yield if block_given?
-      output << "\n<![endif]-->"
-    end
   end
 end

data/lib/tophat/title.rb CHANGED Viewed

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

data/lib/tophat/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module TopHat
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/lib/tophat.rb CHANGED Viewed

@@ -1,8 +1,4 @@
 require 'action_view'
-require 'tophat/title'
-require 'tophat/meta'
-require 'tophat/stylesheet'
-require 'tophat/robots'
 module TopHat
   autoload :TitleHelper,      'tophat/title'