tophat 1.1.0 → 1.2.0

data/lib/tophat.rb

@@ -1,12 +1,19 @@
 require 'action_view'
-require 'tophat/version'
-require 'tophat/core_extensions'
 require 'tophat/title'
 require 'tophat/meta'
 require 'tophat/stylesheet'
+require 'tophat/robots'
 
-Hash.send :include, TopHat::HashOnly unless Hash.instance_methods.include?("only")
+module TopHat
+  autoload :TitleHelper,      'tophat/title'
+  autoload :MetaHelper,       'tophat/meta'
+  autoload :StylesheetHelper, 'tophat/stylesheet'
+  autoload :RobotsHelper,     'tophat/robots'
+  autoload :OpenGraphHelper,  'tophat/opengraph'
+end
 
 ActionView::Base.send :include, TopHat::TitleHelper
 ActionView::Base.send :include, TopHat::MetaHelper
 ActionView::Base.send :include, TopHat::StylesheetHelper
+ActionView::Base.send :include, TopHat::RobotsHelper
+ActionView::Base.send :include, TopHat::OpenGraphHelper

data/lib/tophat/meta.rb

@@ -1,16 +1,6 @@
 module TopHat
   module MetaHelper
 
-    def meta_tag(options={})
-      # tag :meta, :name => options[:name], :content => options[:content]    
-      if options[:content] && (options[:name] || options[:http_equiv])
-        t = "<meta "
-        t << "name=\"#{options[:name]}\"" if options[:name]
-        t << "http-equiv=\"#{options[:http_equiv]}\"" if options[:http_equiv]
-        t << " content=\"#{options[:content]}\" />" 
-      end
-    end
-
     # page descriptions
     # <meta name="description" content="Description goes here." />
     def description(options=nil)
@@ -28,7 +18,7 @@ module TopHat
           options.merge!(:content => @tophat_description) 
         end
 
-        meta_tag(options) if options[:content]
+        tag(:meta, options) if options[:content]
       end    
     end
 
@@ -56,7 +46,7 @@ module TopHat
         display_keywords += default_keywords if options.delete(:merge_default) == true
 
         options.merge!(:content => display_keywords.uniq.join(', '))
-        meta_tag(options) if display_keywords.any?
+        tag(:meta, options) if display_keywords.any?
       end    
     end
   end

data/lib/tophat/opengraph.rb

@@ -0,0 +1,75 @@
+module TopHat
+  module OpenGraphHelper
+
+    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|
+          output << tag(:meta, :property => "og:#{key}", :content => value)
+          output << '\n' if @graph_data.size > 1
+        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
+      end
+      if block_given?
+        @tophat_open_graph_generator = OpenGraphGenerator.new(@tophat_open_graph_defaults)
+        yield(@tophat_open_graph_generator)
+      else
+        @tophat_open_graph_generator ||= OpenGraphGenerator.new
+        @tophat_open_graph_generator.merge(@tophat_open_graph_defaults)
+        output = ""
+        output << @tophat_open_graph_generator.app_id
+        output << @tophat_open_graph_generator.admins
+        output << @tophat_open_graph_generator.render_graph_data if @tophat_open_graph_generator.has_graph_data?
+        output
+      end
+    end
+    
+  end
+end
+                

data/lib/tophat/robots.rb

@@ -0,0 +1,19 @@
+module TopHat
+  module RobotsHelper
+
+    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
+    end
+    
+  end
+end

data/lib/tophat/stylesheet.rb

@@ -66,6 +66,7 @@ module TopHat
     def browser_conditional(browser, version = nil, operator = nil, &block)
       unless operator.blank?
         operator = operator.to_s
+        operator = '!' if operator == 'not'
         operator << " " unless operator == '!'
       end
       

data/lib/tophat/version.rb

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

data/test/test_opengraph.rb

@@ -0,0 +1,88 @@
+require 'helper'
+
+class TopHatOpenGraphTestCase < Test::Unit::TestCase
+
+  context "when using the open graph helpers" do
+    
+    setup do
+      @template = ActionView::Base.new
+    end
+    
+    context "site admins when configured" do
+    
+      context "as a string" do
+      
+        should "generate a site admin tag" do
+          @template.opengraph(:admins => '123,124')
+          assert_equal @template.opengraph, '<meta content="123,124" property="fb:admins" />\n'
+        end
+      
+      end
+    
+      context "as an array" do
+
+        should "generate a site admin tag" do
+          @template.opengraph(:admins => [123, 124])
+          assert_equal @template.opengraph, '<meta content="123,124" property="fb:admins" />\n'
+        end
+        
+      end
+      
+    end
+    
+    context "app_id when configured" do
+      
+      should "generate an app_id meta tag" do
+        @template.opengraph(:app_id => 'MyApp')
+        assert_equal @template.opengraph, '<meta content="MyApp" property="fb:app_id" />\n'
+      end
+      
+    end
+    
+    context "additional open graph properties" do
+      
+      should "generate tags" do
+        @template.opengraph do |graph|
+          graph.title 'The Great Gatsby'
+        end
+        assert_equal @template.opengraph, '<meta content="The Great Gatsby" property="og:title" />'
+      end
+      
+      should "allow use of the tag 'type'" do
+        @template.opengraph do |graph|
+          graph.type 'sports_team'
+        end
+        assert_equal @template.opengraph, '<meta content="sports_team" property="og:type" />'
+      end
+      
+      should "support multiple tags" do
+        @template.opengraph do |graph|
+          graph.title 'Austin Powers: International Man of Mystery'
+          graph.type 'movie'
+        end
+        assert_equal @template.opengraph, '<meta content="movie" property="og:type" />\n<meta content="Austin Powers: International Man of Mystery" property="og:title" />\n'
+      end
+      
+    end
+    
+    context "combined usage" do
+      should "generate all tags" do
+        @template.opengraph(:app_id => 'MyApp', :admins => [123, 1234]) do |graph|
+          graph.title 'Rain Man'
+          graph.type 'movie'
+        end
+        assert_equal @template.opengraph, '<meta content="MyApp" property="fb:app_id" />\n<meta content="123,1234" property="fb:admins" />\n<meta content="movie" property="og:type" />\n<meta content="Rain Man" property="og:title" />\n'
+      end
+      
+      should "generate all tags - alternative usage" do
+        @template.opengraph do |graph|
+          graph.title 'Rain Man'
+          graph.type 'movie'
+        end
+        assert_equal @template.opengraph(:app_id => 'MyApp', :admins => [123, 1234]), '<meta content="MyApp" property="fb:app_id" />\n<meta content="123,1234" property="fb:admins" />\n<meta content="movie" property="og:type" />\n<meta content="Rain Man" property="og:title" />\n'
+      end
+    end
+    
+  end
+  
+end

data/test/test_robots.rb

@@ -0,0 +1,54 @@
+require 'helper'
+
+class TopHatRobotsTestCase < Test::Unit::TestCase
+  
+  context "using the meta helper" do
+   
+    setup do
+      @template = ActionView::Base.new
+    end
+   
+    context "robots" do
+      
+      context "nofollow" do
+        
+        should "default to all robots" do
+          assert_equal @template.nofollow, "<meta content=\"nofollow\" name=\"robots\" />"
+        end
+        
+        should "use a descriptor if one is provided" do
+          assert_equal @template.nofollow('googlebot'), "<meta content=\"nofollow\" name=\"googlebot\" />"
+        end
+        
+      end
+      
+      context "noindex" do
+        
+        should "default to all robots" do
+          assert_equal @template.noindex, "<meta content=\"noindex\" name=\"robots\" />"
+        end
+        
+        should "use a descriptor if one is provided" do
+          assert_equal @template.noindex('googlebot'), "<meta content=\"noindex\" name=\"googlebot\" />"
+        end
+        
+      end
+      
+      context "canonical" do
+        
+        should "not render when not passed a path" do
+          assert_nil @template.canonical
+        end
+        
+        should "render a tag when passed a path" do
+          assert_equal @template.canonical('http://mysite.com/somepath/'), "<link href=\"http://mysite.com/somepath/\" rel=\"canonical\" />"
+        end
+        
+      end
+      
+    end
+
+    
+  end
+  
+end

data/test/test_tophat_meta.rb

@@ -21,7 +21,7 @@ class TopHatMetaTestCase < Test::Unit::TestCase
         end
         
         should "use default keywords if keywords is empty" do
-          assert_equal @template.keywords(:default => @keywords), "<meta name=\"keywords\" content=\"#{@keywords.join(', ')}\" />"
+          assert_equal @template.keywords(:default => @keywords), "<meta content=\"#{@keywords.join(', ')}\" name=\"keywords\" />"
         end
         
       end
@@ -37,7 +37,7 @@ class TopHatMetaTestCase < Test::Unit::TestCase
         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}\" />"
+          assert_equal @template.keywords(:default => @keywords), "<meta content=\"#{@keywords}\" name=\"keywords\" />"
         end
         
       end
@@ -48,7 +48,7 @@ class TopHatMetaTestCase < Test::Unit::TestCase
       
       should "merge default tags with page tags, when merge_default is set to true" do
         @template.keywords("Stu, Pete")
-        assert_equal @template.keywords(:default => "John, Paul, George, Ringo", :merge_default => true), "<meta name=\"keywords\" content=\"Stu, Pete, John, Paul, George, Ringo\" />"
+        assert_equal @template.keywords(:default => "John, Paul, George, Ringo", :merge_default => true), "<meta content=\"Stu, Pete, John, Paul, George, Ringo\" name=\"keywords\" />"
       end
       
     end
@@ -62,7 +62,7 @@ class TopHatMetaTestCase < Test::Unit::TestCase
  
       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}\" />"
+        assert_equal @template.description(:default => desc), "<meta content=\"#{desc}\" name=\"description\" />"
       end
 
       should "not return a tag if no default is configured and no description is defined" do
@@ -71,20 +71,6 @@ class TopHatMetaTestCase < Test::Unit::TestCase
 
     end
     
-    context "meta" do
-      
-      should "render properly" do
-        assert_equal @template.meta_tag(:name => 'viewport', :content => 'width=device-width'), "<meta name=\"viewport\" content=\"width=device-width\" />"
-        assert_equal @template.meta_tag(:name => 'robots', :content => 'all'), "<meta name=\"robots\" content=\"all\" />"
-        assert_equal @template.meta_tag(:http_equiv => 'Content-Language', :content => 'en-us'), "<meta http-equiv=\"Content-Language\" content=\"en-us\" />"
-      end
-      
-      should "not render when no arguments are passed" do
-        assert_nil @template.meta_tag
-      end
-      
-    end
-    
   end
   
 end

data/test/test_tophat_stylesheets.rb

@@ -55,6 +55,16 @@ class TopHatStylesheetTestCase < Test::Unit::TestCase
         }, "<!--[if gte IE 5.5]>\n<link href=\"/stylesheets/ie.css\" media=\"screen\" rel=\"stylesheet\" type=\"text/css\" />\n<![endif]-->"
       end
       
+      should "render defined IE conditional with ! operator" do
+        assert_equal @template.ie_5_conditional(:not) { 
+          @template.stylesheet_link_tag(@stylesheet) 
+        }, "<!--[if !IE 5]>\n<link href=\"/stylesheets/ie.css\" media=\"screen\" rel=\"stylesheet\" type=\"text/css\" />\n<![endif]-->"
+        
+        assert_equal @template.ie_5_5_conditional(:not) { 
+          @template.stylesheet_link_tag(@stylesheet) 
+        }, "<!--[if !IE 5.5]>\n<link href=\"/stylesheets/ie.css\" media=\"screen\" rel=\"stylesheet\" type=\"text/css\" />\n<![endif]-->"
+      end
+      
       should "render defined IE conditional with less than operator" do
         assert_equal @template.ie_5_conditional(:lt) { 
           @template.stylesheet_link_tag(@stylesheet) 

data/tophat.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tophat}
-  s.version = "1.1.0"
+  s.version = "1.2.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-04}
+  s.date = %q{2010-08-29}
   s.description = %q{simple view helpers for your layouts}
   s.email = %q{steve.agalloco@gmail.com}
   s.extra_rdoc_files = [
@@ -23,13 +23,16 @@ Gem::Specification.new do |s|
      "README.textile",
      "Rakefile",
      "lib/tophat.rb",
-     "lib/tophat/core_extensions.rb",
      "lib/tophat/meta.rb",
+     "lib/tophat/opengraph.rb",
+     "lib/tophat/robots.rb",
      "lib/tophat/stylesheet.rb",
      "lib/tophat/title.rb",
      "lib/tophat/version.rb",
      "rails/init.rb",
      "test/helper.rb",
+     "test/test_opengraph.rb",
+     "test/test_robots.rb",
      "test/test_tophat.rb",
      "test/test_tophat_meta.rb",
      "test/test_tophat_stylesheets.rb",
@@ -39,10 +42,12 @@ Gem::Specification.new do |s|
   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.rubygems_version = %q{1.3.7}
   s.summary = %q{simple view helpers for your layouts}
   s.test_files = [
     "test/helper.rb",
+     "test/test_opengraph.rb",
+     "test/test_robots.rb",
      "test/test_tophat.rb",
      "test/test_tophat_meta.rb",
      "test/test_tophat_stylesheets.rb",
@@ -53,7 +58,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<actionpack>, [">= 2.3.5"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
     else

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tophat
 version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Steve Agalloco
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-04 00:00:00 -04:00
+date: 2010-08-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionpack
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 9
         segments: 
         - 2
         - 3
@@ -35,9 +38,11 @@ dependencies:
   name: shoulda
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -59,13 +64,16 @@ files:
 - README.textile
 - Rakefile
 - lib/tophat.rb
-- lib/tophat/core_extensions.rb
 - lib/tophat/meta.rb
+- lib/tophat/opengraph.rb
+- lib/tophat/robots.rb
 - lib/tophat/stylesheet.rb
 - lib/tophat/title.rb
 - lib/tophat/version.rb
 - rails/init.rb
 - test/helper.rb
+- test/test_opengraph.rb
+- test/test_robots.rb
 - test/test_tophat.rb
 - test/test_tophat_meta.rb
 - test/test_tophat_stylesheets.rb
@@ -81,28 +89,34 @@ 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.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: simple view helpers for your layouts
 test_files: 
 - test/helper.rb
+- test/test_opengraph.rb
+- test/test_robots.rb
 - test/test_tophat.rb
 - test/test_tophat_meta.rb
 - test/test_tophat_stylesheets.rb

data/lib/tophat/core_extensions.rb

@@ -1,13 +0,0 @@
-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