link_header 0.0.4 → 0.0.5

data/History.txt

@@ -1,3 +1,11 @@
+== 0.0.5 2009-07-30
+
+* Add #to_html methods
+
+== 0.0.4 2009-07-27
+
+* Add LinkHeader#find_link
+
 == 0.0.3 2009-07-24
 
 * RFC-compliant parsing and formatting; add example.rb

data/README.rdoc

@@ -1,10 +1,10 @@
 = link_header README
 
-Parse and format HTTP link headers as described in the draft spec http://tools.ietf.org/id/draft-nottingham-http-link-header-06.txt
+Parse and format HTTP link headers as described in the draft spec http://tools.ietf.org/id/draft-nottingham-http-link-header-06.txt, also the equivalent HTML link elements.
 
 == Description
 
-Converts conforming link headers to and from text, LinkHeader objects and corresponding (JSON-friendly) Array representations.
+Converts conforming link headers to and from text, LinkHeader objects and corresponding (JSON-friendly) Array representations, also HTML link elements.
 
 == Installation
 

data/lib/link_header.rb

@@ -6,7 +6,7 @@ require "strscan"
 #
 class LinkHeader
   # rubygem version
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
   
   # An array of Link objects
   attr_reader :links
@@ -99,6 +99,9 @@ class LinkHeader
     new(links)
   end
   
+  #
+  # Find a member link that has the given attributes
+  #
   def find_link(*attr_pairs)
     links.detect do |link|
       !attr_pairs.detect do |pair|
@@ -106,6 +109,13 @@ class LinkHeader
       end
     end 
   end
+  
+  #
+  # Render as a list of HTML link elements
+  #
+  def to_html(separator="\n")
+    links.map{|link| link.to_html}.join(separator)
+  end
 
   #
   # Represents a link - an href and a list of attributes (key value pairs)
@@ -173,7 +183,6 @@ class LinkHeader
     # Convert to string representation as per the link header spec.  This includes backspace-escaping doublequote characters in
     # quoted attribute values.
     #
-    #
     # Convert to string representation as per the link header spec
     #
     #   LinkHeader::Link.new(["http://example.com/foo", [["rel", "self"]]]).to_s
@@ -182,5 +191,14 @@ class LinkHeader
     def to_s
       (["<#{href}>"] + attr_pairs.map{|k, v| "#{k}=\"#{v.gsub(/"/, '\"')}\""}).join('; ')
     end
+    
+    #
+    # Bonus!  Render as an HTML link element
+    #
+    #   LinkHeader::Link.new(["http://example.com/foo", [["rel", "self"]]]).to_html
+    #   #=> '<link href="http://example.com/foo" rel="self">'
+    def to_html
+      ([%Q(<link href="#{href}")] + attr_pairs.map{|k, v| "#{k}=\"#{v.gsub(/"/, '\"')}\""}).join(' ')
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: link_header
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Mike Burrows
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-27 00:00:00 +01:00
+date: 2009-07-30 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.3.2
     version: 
-description: Converts conforming link headers to and from text, LinkHeader objects and corresponding (JSON-friendly) Array representations.
+description: Converts conforming link headers to and from text, LinkHeader objects and corresponding (JSON-friendly) Array representations, also HTML link elements.
 email: 
 - mjb@asplake.co.uk
 executables: []
@@ -85,7 +85,7 @@ rubyforge_project: link-header
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Converts conforming link headers to and from text, LinkHeader objects and corresponding (JSON-friendly) Array representations.
+summary: Converts conforming link headers to and from text, LinkHeader objects and corresponding (JSON-friendly) Array representations, also HTML link elements.
 test_files: 
 - test/test_helper.rb
 - test/test_link_header.rb