link_header 0.0.2 → 0.0.3

data/History.txt

@@ -1,3 +1,7 @@
+== 0.0.3 2009-07-24
+
+* FFC-compliant parsing and formatting; add example.rb
+
 == 0.0.2 2009-07-23
 
 * Fix installation instructions

data/Manifest.txt

@@ -4,6 +4,7 @@ Manifest.txt
 PostInstall.txt
 README.rdoc
 Rakefile
+example.rb
 lib/link_header.rb
 script/console
 script/destroy

data/example.rb

@@ -0,0 +1,36 @@
+require "link_header"
+require "pp"
+
+#
+# Create a LinkHeader with Link objects
+#
+link_header = LinkHeader.new([
+  LinkHeader::Link.new("http://example.com/foo", [["rel", "self"]]),
+  LinkHeader::Link.new("http://example.com/",    [["rel", "up"]])])
+
+puts link_header.to_s
+#=> <http://example.com/foo>; rel="self", <http://example.com/>; rel="up"
+
+link_header.links.map do |link|
+  puts "href #{link.href.inspect}, attr_pairs #{link.attr_pairs.inspect}, attrs #{link.attrs.inspect}"
+end
+#=> href "http://example.com/foo", attr_pairs [["rel", "self"]], attrs {"rel"=>"self"}
+#   href "http://example.com/", attr_pairs [["rel", "up"]], attrs {"rel"=>"up"}
+
+#
+# Create a LinkHeader from raw (JSON-friendly) data
+#
+puts LinkHeader.new([
+  ["http://example.com/foo", [["rel", "self"]]],
+  ["http://example.com/",    [["rel", "up"]]]]).to_s
+#=> <http://example.com/foo>; rel="self", <http://example.com/>; rel="up"
+
+#
+# Parse a link header into a LinkHeader object then produce its raw data representation
+#
+pp LinkHeader.parse('<http://example.com/foo>; rel="self", <http://example.com/>; rel = "up"').to_a
+#=> [["http://example.com/foo", [["rel", "self"]]],
+#    ["http://example.com/", [["rel", "up"]]]]
+
+
+

data/lib/link_header.rb

@@ -1,7 +1,7 @@
 require "strscan"
 
 class LinkHeader
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
   
   # an array of Link objects
   attr_reader :links
@@ -27,9 +27,15 @@ class LinkHeader
     links.join(', ')
   end
   
-  HREF   = / *<([^>]*)> *;? */
-  TOKEN  = /([a-zA-Z0-9_\-]+)/
-  QUOTED = /"([^"]*)"/
+  #
+  # Regexes for link header parsing.  TOKEN and QUOTED in particular should conform to RFC2616.
+  #
+  # Acknowledgement: The QUOTED regexp is based on
+  # http://stackoverflow.com/questions/249791/regexp-for-quoted-string-with-escaping-quotes/249937#249937
+  #
+  HREF   = / *< *([^>]*) *> *;? */                  # note: no attempt to check URI validity
+  TOKEN  = /([^()<>@,;:\"\[\]?={}\s]+)/             # non-empty sequence of non-separator characters
+  QUOTED = /"((?:[^"\\]|\\.)*)"/                    # double-quoted strings with backslash-escaped double quotes
   ATTR   = /#{TOKEN} *= *(#{TOKEN}|#{QUOTED}) */
   SEMI   = /; */
   COMMA  = /, */
@@ -46,7 +52,8 @@ class LinkHeader
       href = scanner[1]
       attrs = []
       while scanner.scan(ATTR)
-        attrs.push([scanner[1], scanner[3] || scanner[4]])
+        attr_name, token, quoted = scanner[1], scanner[3], scanner[4].gsub(/\\"/, '"')
+        attrs.push([attr_name, token || quoted])
         break unless scanner.scan(SEMI)
       end
       links.push(Link.new(href, attrs))
@@ -98,7 +105,7 @@ class LinkHeader
     # Convert to string representation as per the link header spec
     #
     def to_s
-      (["<#{href}>"] + attr_pairs.map{|k, v| "#{k}=\"#{v}\""}).join('; ')
+      (["<#{href}>"] + attr_pairs.map{|k, v| "#{k}=\"#{v.gsub(/"/, '\"')}\""}).join('; ')
     end
   end
 end

data/test/test_link_header.rb

@@ -1,9 +1,9 @@
 require "test/unit"
 
 LINK_HEADER_S_A = [
-  %Q(<http://example.com/>; rel="up"; meta="bar"),
-  %Q(<http://example.com/foo>; rel="self"),
-  %Q(<http://example.com/>)
+  '<http://example.com/>; rel="up"; meta="bar"',
+  '<http://example.com/foo>; rel="self"',
+  '<http://example.com/>'
 ]
 LINK_HEADER_S = LINK_HEADER_S_A.join(', ')
 
@@ -49,4 +49,16 @@ class TestLinkHeader < Test::Unit::TestCase
   def test_link_header_to_s
     assert_equal(LINK_HEADER_S, LinkHeader.new(LINK_HEADER_A).to_s)
   end
+  
+  def test_parse_href
+    assert_equal("any old stuff!", LinkHeader.parse('<any old stuff!>').links[0].href)
+  end
+
+  def test_parse_attribute
+    assert_equal(['a-token', 'escaped "'], LinkHeader.parse('<any old stuff!> ;a-token="escaped \""').links[0].attr_pairs[0])
+  end
+
+  def test_format_attribute
+    assert_equal('<any old stuff!>; a-token="escaped \""', LinkHeader.new([['any old stuff!', [['a-token', 'escaped "']]]]).to_s)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: link_header
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Mike Burrows
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-23 00:00:00 +02:00
+date: 2009-07-24 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,7 @@ files:
 - PostInstall.txt
 - README.rdoc
 - Rakefile
+- example.rb
 - lib/link_header.rb
 - script/console
 - script/destroy