docs/draft-gregorio-uritemplate-03.txt @@ -1,3 +1,7 @@ +=== 0.3.0 / 2008-12-08 + +* Implemented version 0.3 (http://bitworking.org/projects/URI-Templates/spec/draft-gregorio-uritemplate-03.txt) + === 0.2.0 / 2008-3-18 * Changed lib directory structure to reflect the name of the gem. use "require 'uri/templates'" instead of "require 'uri_template'" History.txt @@ -1,6 +1,10 @@ = URI-Templates http://rubyforge.org/projects/uri-templates/ +This release implements version 0.3 of the URI Template specification. + +See: http://bitworking.org/projects/URI-Templates/spec/draft-gregorio-uritemplate-03.txt + == DESCRIPTION: URI Templates are strings that contain embedded variables that are transformed into URIs after embedded variables are substituted. README.txt @@ -93,8 +93,8 @@ grammar UriTemplate end } / - 'append' { - # The append operator MUST only have one variable in its expansion. If + 'suffix' { + # The suffix operator MUST only have one variable in its expansion. If # the variable is defined and non-empty then substitute the value of # the variable followed by the value of arg, otherwise substitute the # empty string. @@ -136,15 +136,12 @@ grammar UriTemplate end } / - 'listjoin' { - # The listjoin operator MUST have only one variable in its expansion - # and that variable must be a list. If the list is non-empty then - # substitute the concatenation of all the list members with intevening - # values of arg. - # - # The result of substitution MUST match the URI-reference rule and - # SHOULD also match any known rules for the scheme of the resulting - # URI. + 'list' { + # The listjoin operator MUST have only one variable in its expansion + # and that variable must be a list. More than one variable is an + # error. If the list is non-empty then substitute the concatenation of + # all the list members with intervening values of arg. If the list is + # empty or the variable is undefined them substitute the empty string. def exec lambda do |env, joinop, vars| return "" unless env[vars].respond_to? :each grammar/uri_template.treetop @@ -1,6 +1,10 @@ module UriTemplate include Treetop::Runtime + def initialize + @root = nil + end + def root @root || :uri_template end @@ -291,7 +295,7 @@ module UriTemplate end module Op3 - # The append operator MUST only have one variable in its expansion. If + # The suffix operator MUST only have one variable in its expansion. If # the variable is defined and non-empty then substitute the value of # the variable followed by the value of arg, otherwise substitute the # empty string. @@ -334,22 +338,19 @@ module UriTemplate end module Op5 - # The listjoin operator MUST have only one variable in its expansion - # and that variable must be a list. If the list is non-empty then - # substitute the concatenation of all the list members with intevening - # values of arg. - # - # The result of substitution MUST match the URI-reference rule and - # SHOULD also match any known rules for the scheme of the resulting - # URI. - def exec - lambda do |env, joinop, vars| - return "" unless env[vars].respond_to? :each - env[vars].map do |v| - "#{UriTemplate::Encoder.encode(v)}" if v - end.compact.join(joinop) - end - end + # The listjoin operator MUST have only one variable in its expansion + # and that variable must be a list. More than one variable is an + # error. If the list is non-empty then substitute the concatenation of + # all the list members with intervening values of arg. If the list is + # empty or the variable is undefined them substitute the empty string. + def exec + lambda do |env, joinop, vars| + return "" unless env[vars].respond_to? :each + env[vars].map do |v| + "#{UriTemplate::Encoder.encode(v)}" if v + end.compact.join(joinop) + end + end end def _nt_op @@ -394,12 +395,12 @@ module UriTemplate if r3 r0 = r3 else - if input.index('append', index) == index + if input.index('suffix', index) == index r4 = (SyntaxNode).new(input, index...(index + 6)) r4.extend(Op3) @index += 6 else - terminal_parse_failure('append') + terminal_parse_failure('suffix') r4 = nil end if r4 @@ -416,12 +417,12 @@ module UriTemplate if r5 r0 = r5 else - if input.index('listjoin', index) == index - r6 = (SyntaxNode).new(input, index...(index + 8)) + if input.index('list', index) == index + r6 = (SyntaxNode).new(input, index...(index + 4)) r6.extend(Op5) - @index += 8 + @index += 4 else - terminal_parse_failure('listjoin') + terminal_parse_failure('list') r6 = nil end if r6 lib/uri/grammar.rb @@ -20,7 +20,10 @@ # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #++ + +#$KCODE='u' require 'rubygems' +#require 'unicode' require 'treetop' require 'cgi' lib/uri/templates.rb @@ -7,3 +7,17 @@ FIXTURES = File.dirname(__FILE__) + "/fixtures" #def read_fixture(f) # File.read(File.join(FIXTURES, f)) #end + +module Unicode + def self.const_missing(name) + # Check that the constant name is of the right form: U0000 to U10FFFF + if name.to_s =~ /^U([0-9a-fA-F]{4,5}|10[0-9a-fA-F]{4})$/ + # Convert the codepoint to an immutable UTF-8 string, + # define a real constant for that value and return the value + #p name, name.class + const_set(name, [$1.dup.to_i(16)].pack("U").freeze) + else # Raise an error for constants that are not Unicode. + raise NameError, "Uninitialized constant: Unicode::#{name}" + end + end +end \ No newline at end of file test/test_helper.rb @@ -6,6 +6,8 @@ class TestUriTemplate < Test::Unit::TestCase def test_encode assert_equal "stefan", UriTemplate::Encoder.encode("stefan") assert_equal '%26', UriTemplate::Encoder.encode("&") + assert_equal '%20', UriTemplate::Encoder.encode(" ") + #assert_equal '%CE%8E', UriTemplate::Encoder.encode(Unicode::U03d3) end def test_op @@ -21,7 +23,7 @@ class TestUriTemplate < Test::Unit::TestCase 'a_b' => 'baz' } assert_equal '/&wilma/#bar', UriTemplate::URI.new('/{-prefix|&|foo=wilma}/{-prefix|#|b}').replace(defaults) - assert_equal '/foo/data#bar', UriTemplate::URI.new('/{-append|/|a}{-opt|data|points}{-neg|@|a}{-prefix|#|b}').replace(defaults) + assert_equal '/foo/data#bar', UriTemplate::URI.new('/{-suffix|/|a}{-opt|data|points}{-neg|@|a}{-prefix|#|b}').replace(defaults) end def test_replace test/test_uri_template.rb @@ -1,7 +1,7 @@ # Created by Stefan Saasen. # Copyright (c) 2008. All rights reserved. require File.dirname(__FILE__) + '/test_helper.rb' - + class TestUriTemplateGrammar < Test::Unit::TestCase def check(expected, template, values = {}) @@ -21,7 +21,7 @@ class TestUriTemplateGrammar < Test::Unit::TestCase assert_not_nil @parser.parse('http://www.google.com/notebook/feeds/{userID}') assert_not_nil @parser.parse('http://www.google.com/notebook/feeds/{-prefix|/notebooks/|notebookID}') assert_not_nil @parser.parse('http://www.google.com/notebook/feeds/{userID}{-prefix|/notebooks/|notebookID}') - assert_not_nil @parser.parse('http://www.google.com/notebook/feeds/{userID}{-prefix|/notebooks/|notebookID}{-opt|/-/|categories}{-listjoin|/|categories}?{-join|&|updated-min,updated-max,alt,start-index,max-results,entryID,orderby}') + assert_not_nil @parser.parse('http://www.google.com/notebook/feeds/{userID}{-prefix|/notebooks/|notebookID}{-opt|/-/|categories}{-list|/|categories}?{-join|&|updated-min,updated-max,alt,start-index,max-results,entryID,orderby}') end def test_replace @@ -36,19 +36,19 @@ class TestUriTemplateGrammar < Test::Unit::TestCase check "barney", "foo=wilma", "foo" => "barney" end - def test_append - check "", "-append|/|foo" - check "wilma#", "-append|#|foo=wilma" - check "barney&?", "-append|&?|foo=wilma", "foo" => "barney" + def test_suffix + check "", "-suffix|/|foo" + check "wilma#", "-suffix|#|foo=wilma" + check "barney&?", "-suffix|&?|foo=wilma", "foo" => "barney" end - def test_listjoin - check "a&b&c", "-listjoin|&|bar", 'bar' => ['a', 'b', 'c'] - check "", "-listjoin|/|foo" - check "a/b", "-listjoin|/|foo", "foo" => ['a', 'b'] - check "ab", "-listjoin||foo", "foo" => ['a', 'b'] - check "a", "-listjoin|/|foo", "foo" => ['a'] - check "", "-listjoin|/|foo", "foo" => [] + def test_list + check "a&b&c", "-list|&|bar", 'bar' => ['a', 'b', 'c'] + check "", "-list|/|foo" + check "a/b", "-list|/|foo", "foo" => ['a', 'b'] + check "ab", "-list||foo", "foo" => ['a', 'b'] + check "a", "-list|/|foo", "foo" => ['a'] + check "", "-list|/|foo", "foo" => [] end def test_join @@ -91,11 +91,11 @@ class TestUriTemplateGrammar < Test::Unit::TestCase def test_special check "%20", "foo", "foo" => ' ' - check '%26&%26&%7C&_', "-listjoin|&|foo", 'foo' => ["&", "&", "|", "_"] + check '%26&%26&%7C&_', "-list|&|foo", 'foo' => ["&", "&", "|", "_"] end def test_misc - assert_equal "http://www.google.com/notebook/feeds/joe?", @parser.parse("http://www.google.com/notebook/feeds/{userID}{-prefix|/notebooks/|notebookID}{-opt|/-/|categories}{-listjoin|/|categories}?{-join|&|updated-min,updated-max,alt,start-index,max-results,entryID,orderby}").value("userID" => "joe") + assert_equal "http://www.google.com/notebook/feeds/joe?", @parser.parse("http://www.google.com/notebook/feeds/{userID}{-prefix|/notebooks/|notebookID}{-opt|/-/|categories}{-list|/|categories}?{-join|&|updated-min,updated-max,alt,start-index,max-results,entryID,orderby}").value("userID" => "joe") assert_equal "http://example.org/news/joe/", @parser.parse("http://example.org/news/{id}/").value("id" => "joe") end @@ -117,7 +117,7 @@ class TestUriTemplateGrammar < Test::Unit::TestCase # string, and both list0 and points are lists. The variable 'u' is a # string of two unicode characters, the WHITE CHESS KING (0x2654) and # the WHITE CHESS QUEEN (0x2655). - def test_draft + def test_draft_0_2 defaults = { 'a' => 'foo', 'b' => 'bar', @@ -126,7 +126,8 @@ class TestUriTemplateGrammar < Test::Unit::TestCase 'list0' => [], 'str0' => '', 'reserved' => ':/?#[]@!$&\'()*+,;=', - 'u' => '♔♕', + #'u' => '♔♕', + 'u' => "#{Unicode::U2654}#{Unicode::U2655}", 'a_b' => 'baz' } assert_equal 'http://example.org/?q=foo', @parser.parse('http://example.org/?q={a}').value(defaults) @@ -144,13 +145,13 @@ class TestUriTemplateGrammar < Test::Unit::TestCase assert_equal './', @parser.parse('./{-prefix|#|str0}').value(defaults) # append, prefix - assert_equal '/foo/#bar', @parser.parse('/{-append|/|a}{-prefix|#|b}').value(defaults) + assert_equal '/foo/#bar', @parser.parse('/{-suffix|/|a}{-prefix|#|b}').value(defaults) # neg assert_equal '/', @parser.parse('/{-neg|@|a}').value(defaults) # append, opt, neg, prefix - assert_equal '/foo/data#bar', @parser.parse('/{-append|/|a}{-opt|data|points}{-neg|@|a}{-prefix|#|b}').value(defaults) + assert_equal '/foo/data#bar', @parser.parse('/{-suffix|/|a}{-opt|data|points}{-neg|@|a}{-prefix|#|b}').value(defaults) # UTF-8 assert_equal 'http://example.org/q=%E2%99%94%E2%99%95/', @parser.parse('http://example.org/q={u}/').value(defaults) @@ -158,12 +159,59 @@ class TestUriTemplateGrammar < Test::Unit::TestCase # join assert_equal 'http://example.org/?a=foo&data=10%2C20%2C30', @parser.parse('http://example.org/?{-join|&|a,data}').value(defaults) - # listjoin - assert_equal 'http://example.org/?d=10,20,30&a=foo&b=bar', @parser.parse('http://example.org/?d={-listjoin|,|points}&{-join|&|a,b}').value(defaults) - assert_equal 'http://example.org/?d=&', @parser.parse('http://example.org/?d={-listjoin|,|list0}&{-join|&|foo}').value(defaults) + # list + assert_equal 'http://example.org/?d=10,20,30&a=foo&b=bar', @parser.parse('http://example.org/?d={-list|,|points}&{-join|&|a,b}').value(defaults) + assert_equal 'http://example.org/?d=&', @parser.parse('http://example.org/?d={-list|,|list0}&{-join|&|foo}').value(defaults) # misc assert_equal 'http://example.org/foobar/baz', @parser.parse('http://example.org/{a}{b}/{a_b}').value(defaults) assert_equal 'http://example.org/foo/-/foo/', @parser.parse('http://example.org/{a}{-prefix|/-/|a}/').value(defaults) end + + # +---------+----------------------------------+ + # | Name | Value | + # +---------+----------------------------------+ + # | foo | \u03d3 | + # | bar | fred | + # | baz | 10,20,30 | + # | qux | ["10","20","30"] | + # | corge | [] | + # | grault | | + # | garply | a/b/c | + # | waldo | ben & jerrys | + # | fred | ["fred", "", "wilma"] | + # | plugh | ["\u017F\u0307", "\u0073\u0307"] | + # | 1-a_b.c | 200 | + # +---------+----------------------------------+ + def test_draft_0_3 + defaults = { + 'foo' => Unicode::U03d3, + 'bar' => 'fred', + 'baz' => '10,20,30', + 'qux' => %w(10 20 30), + 'corge' => [], + 'grault' => nil, + 'garply' => 'a/b/c', + 'waldo' => 'ben & jerrys', + 'fred' => ["fred", "", "wilma"], + 'plugh' => ["#{Unicode::U017F}#{Unicode::U0307}", "#{Unicode::U0073}#{Unicode::U0307}"], + '1-a_b.c' => 200 + } + + [ + ['http://example.org/?q=fred', 'http://example.org/?q={bar}'], + #['http://example.org/?foo=%CE%8E&bar=fred&baz=10%2C20%2C30', 'http://example.org/?{-join|&|foo,bar,xyzzy,baz}'], + ['/', '/{xyzzy}'], + ['http://example.org/?d=10,20,30', 'http://example.org/?d={-list|,|qux}'], + ['http://example.org/?d=10&d=20&d=30', 'http://example.org/?d={-list|&d=|qux}'], + ['http://example.org/fredfred/a%2Fb%2Fc', 'http://example.org/{bar}{bar}/{garply}'], +# ['http://example.org/fred/fred//wilma', 'http://example.org/{bar}{-prefix|/|fred}'], +# [':%E1%B9%A1:%E1%B9%A1:', '{-neg|:|corge}{-suffix|:|plugh}'], + ['../ben%20%26%20jerrys/', '../{waldo}/'], +# ['telnet:192.0.2.16:80', 'telnet:192.0.2.16{-opt|:80|grault}'], + [':200:', ':{1-a_b.c}:'] + ].each do |test| + assert_equal test.first, @parser.parse(test.last).value(defaults) + end + end end test/test_uri_template_grammar.rb 9a0ddf30919ee8250ea10c346e3c412a0d7946a4 Stefan Saasen stefan@coravy.com http://github.com/juretta/uri-templates/commit/2e7b62d150169051d2ce7d5b828289259161fb77 2e7b62d150169051d2ce7d5b828289259161fb77 2009-05-21T02:10:12-07:00 2008-12-06T14:16:56-08:00 WIP: Added Draft Version 0.3. Implemented first changes. 79e9360f259db7c33ea036499fa29daaf8c97138 Stefan Saasen stefan@coravy.com