uri-component 0.0.3 → 0.0.4

data/lib/uri/component.rb

@@ -1,10 +1,21 @@
+## = uri/component.rb
+##
+## Ruby URI::Component module
+##
+## Author:: SATOH Fumiyasu
+## Copyright:: (c) 2007-2011 SATOH Fumiyasu @ OSS Technology, Corp.
+## License:: You can redistribute it and/or modify it under the same term as Ruby.
+##
+
 require "uri/component/userinfo"
 require "uri/component/path"
 require "uri/component/query"
 
-module URI
+module URI #:nodoc:
   ## Handle URI components as an object
   module Component
+    ## == Description
+    ##
     ## Add the following instance methods to the class +klass+:
     ##
     ## userinfo_component::
@@ -15,7 +26,7 @@ module URI
     ## query_component::
     ##   Returns the query component of the URI as URI::Component::Query object.
     ##
-    ## Usage:
+    ## == Example
     ##
     ##   require "uri"
     ##   require "uri/component"

data/lib/uri/component/path.rb

@@ -7,14 +7,14 @@
 
 require 'uri'
 
-module URI
+module URI #:nodoc:
   module Component
     ## Handle a path component in an URI as an object
     class Path
       #:stopdoc:
-      ## Same as URI::UNSAFE, plus ';' (separator for path nodes)
+      ## Same as URI::UNSAFE, plus '/' (separator for path nodes)
       ## and '?' (separator for path and query)
-      RE_UNSAFE = /
+      RE_NODE_UNSAFE = /
         [^#{URI::REGEXP::PATTERN::UNRESERVED}#{URI::REGEXP::PATTERN::RESERVED}]|
         [\/?]
       /x
@@ -41,18 +41,22 @@ module URI
 	end
       end
 
-      def escape(v)
-        return URI.escape(v, RE_UNSAFE)
+      def escape_node(v)
+        return URI.escape(v, RE_NODE_UNSAFE)
       end
 
       def to_uri
 	return '' if @nodes.empty?
 	return '/' + @nodes.map do |node|
-	  self.escape(node)
+	  self.escape_node(node)
 	end.join('/')
       end
       alias to_s to_uri
 
+      def [](*index)
+        return @nodes[*index]
+      end
+
       def nodes
 	return @nodes
       end
@@ -80,7 +84,7 @@ module URI
       end
     end
 
-    module PathMixin
+    module PathMixin #:nodoc:
       def initialize_copy(uri)
 	if (path = uri.instance_variable_get('@path_component'))
 	  @path_component = path.dup

data/lib/uri/component/query.rb

@@ -8,59 +8,87 @@
 require 'uri'
 require 'cgi'
 
-module URI
+module URI #:nodoc:
   module Component
-    class QueryParamsHash < Hash #:nodoc:
-      def convert_key(key)
+    ## Handle query parameters for the URI as a hash
+    ##
+    ## == Example
+    ##
+    ##   require "uri/component/query"
+    ##
+    ##   query = URI::Component::Query.new('foo=123&bar=x+y&bar=%40example')
+    ##   params = query.params
+    ##   #=> #<URI::Component::QueryParamsHash: {"foo"=>["123"], "bar"=>["x y", "@example"]}>
+    ##
+    ##   p params['foo']
+    ##   #=> ["123"]
+    ##   p params[:foo]
+    ##   #=> ["123"]
+    ##   p params.values(:foo)
+    ##   #=> ["123"]
+    ##   p params.value(:foo)
+    ##   #=> "123"
+    ##
+    ##   p params['bar']
+    ##   #=> ["x y", "@example"]
+    ##   p params[:bar]
+    ##   #=> ["x y", "@example"]
+    ##   p params.values(:bar)
+    ##   #=> ["x y", "@example"]
+    ##   p params.value(:bar)
+    ##   #=> "x y"
+    ##
+    ##   params[:foo] = [1, 2, 3]
+    ##   #=> [1, 2, 3]
+    ##   params[:bar] = 'baz@baz.example.jp'
+    ##   #=> ["baz@baz.example.jp"]
+    ##   p query.to_uri
+    ##   #=> "foo=1&foo=2&foo=3&bar=baz%40example.jp"
+    class QueryParamsHash < Hash
+      def convert_key(key) #:nodoc:
         return key.kind_of?(String) ? key : key.to_s
       end
-      def [](key)
+      def [](key) #:nodoc:
         super(self.convert_key(key))
       end
-      def fetch(key, default = nil)
+      def fetch(key, default = nil) #:nodoc:
         super(self.convert_key(key), default)
       end
 
-      def values(key = nil)
-        return key ? self[key] : super
-      end
-
-      def values=(key, values)
-        self[key] = values
+      ## Returns an array of values from the hash for the given key.
+      def values(key)
+        return self[key]
       end
 
+      ## Returns a value from the hash for the given key.
       def value(key)
         return self[key][0]
       end
 
-      def value=(key, value)
-        self[key] = value
-      end
-
-      def values_at(*keys)
+      def values_at(*keys) #:nodoc:
         super(*keys.map {|key| self.convert_key(key)})
       end
 
-      def []=(key, values)
+      def []=(key, values) #:nodoc:
         values = [values] unless values.kind_of?(Array)
         super(self.convert_key(key), values)
       end
-      def store(key, values)
+      def store(key, values) #:nodoc:
         self[key] = values
       end
 
-      def delete(key)
+      def delete(key) #:nodoc:
         super(self.convert_key(key))
       end
 
-      def has_key?(key)
+      def has_key?(key) #:nodoc:
         super(self.convert_key(key))
       end
       alias :include? :has_key?
       alias :key? :has_key?
       alias :member? :has_key?
 
-      def merge(hash)
+      def merge(hash) #:nodoc:
         hash_new = self.class.new
         hash.each do |key, value|
           hash_new[key] = value
@@ -68,7 +96,7 @@ module URI
         return hash_new
       end
 
-      def merge!(hash)
+      def merge!(hash) #:nodoc:
         hash.each do |key, value|
           self[key] = value
         end
@@ -76,7 +104,7 @@ module URI
       end
       alias :update :merge!
 
-      def replace(hash)
+      def replace(hash) #:nodoc:
         self.clear
         hash.each do |key, value|
           self[key] = value
@@ -91,6 +119,8 @@ module URI
       RE_COMPONENT = /^#{URI::REGEXP::PATTERN::QUERY}?$/
       #:startdoc:
 
+      DEFAULT_PARAM_SEPARATOR = '&'
+
       def self.mixin(klass) #:nodoc:
 	QueryMixin.__send__(:append_features, klass)
 	QueryMixin.__send__(:included, klass)
@@ -105,7 +135,7 @@ module URI
 	@params.default_proc = Proc.new {|hash, key|
 	  hash[key] = [] unless hash.key?(key)
 	}
-	@param_separator = '&'
+	@param_separator = DEFAULT_PARAM_SEPARATOR
 
 	query_str.split(/[&;]/).each do |param|
 	  next if param.empty?
@@ -117,6 +147,11 @@ module URI
 	end
       end
 
+      def [](key)
+	return @params[key]
+      end
+
+      ## Returns query parameters as an URI::Component::QueryParamsHash object
       def params
 	return @params
       end
@@ -144,7 +179,7 @@ module URI
       alias to_s to_uri
     end
 
-    module QueryMixin
+    module QueryMixin #:nodoc:
       def initialize_copy(uri)
 	if (query = uri.instance_variable_get('@query_component'))
 	  @query_component = query.dup

data/lib/uri/component/userinfo.rb

@@ -7,18 +7,18 @@
 
 require 'uri'
 
-module URI
+module URI #:nodoc:
   module Component
     ## Handle an userinfo component in an URI as an object
     class UserInfo
       #:stopdoc:
-      RE_UNSAFE = /[^#{URI::REGEXP::PATTERN::UNRESERVED}]/
+      RE_ELEMENT_UNSAFE = /[^#{URI::REGEXP::PATTERN::UNRESERVED}]/
       ## Same as URI::USERINFO, except ';' and ':'
-      RE_PART = /(?:
+      RE_ELEMENT = /(?:
         [#{URI::REGEXP::PATTERN::UNRESERVED}&=+$,]|
         #{URI::REGEXP::PATTERN::ESCAPED})*
       /x
-      RE_COMPONENT = /^(?:(#{RE_PART});)?(#{RE_PART})(?::(#{RE_PART}))?$/
+      RE_COMPONENT = /^(?:(#{RE_ELEMENT});)?(#{RE_ELEMENT})(?::(#{RE_ELEMENT}))?$/
       #:startdoc:
 
       def self.mixin(klass) #:nodoc:
@@ -26,8 +26,8 @@ module URI
 	UserInfoMixin.__send__(:included, klass)
       end
 
-      def escape(v)
-	return URI.escape(v, RE_UNSAFE)
+      def escape_element(v)
+	return URI.escape(v, RE_ELEMENT_UNSAFE)
       end
 
       def initialize(info_str=nil)
@@ -80,15 +80,15 @@ module URI
 	return nil unless @user
 
 	info_str = ''
-	info_str += self.escape(@domain) + ';' if @domain
-	info_str += @user ? self.escape(@user) : '';
-	info_str += ':' + self.escape(@password) if @password
+	info_str += self.escape_element(@domain) + ';' if @domain
+	info_str += @user ? self.escape_element(@user) : '';
+	info_str += ':' + self.escape_element(@password) if @password
 	return info_str
       end
       alias to_s to_uri
     end
 
-    module UserInfoMixin
+    module UserInfoMixin #:nodoc:
       def initialize_copy(uri)
 	if (userinfo = uri.instance_variable_get('@userinfo_component'))
 	  @userinfo_component = userinfo.dup
@@ -113,8 +113,8 @@ module URI
 	return nil unless user
 
 	domain = @userinfo_component.domain
-	user_uri = domain ? @userinfo_component.escape(domain) + ';' : ''
-	user_uri += @userinfo_component.escape(user)
+	user_uri = domain ? @userinfo_component.escape_element(domain) + ';' : ''
+	user_uri += @userinfo_component.escape_element(user)
 	return user_uri
       end
 
@@ -130,7 +130,7 @@ module URI
 
       def password
 	pass = @userinfo_component.password
-	return pass ? @userinfo_component.escape(pass) : nil
+	return pass ? @userinfo_component.escape_element(pass) : nil
       end
 
       def password=(pass_uri)

data/lib/uri/component/version.rb

@@ -1,6 +1,6 @@
-module URI
+module URI #:nodoc:
   module Component
-    VERSION = "0.0.3" ## :nodoc:
+    VERSION = "0.0.4" ## :nodoc:
   end
 end
 

data/test/test_component_path.rb

@@ -6,7 +6,7 @@ UCP = URI::Component::Path
 module URI
 module Component
 
-class TestPathClass < Test::Unit::TestCase
+class PathTest < Test::Unit::TestCase
   def setup
   end
 
@@ -36,6 +36,9 @@ class TestPathClass < Test::Unit::TestCase
     assert_equal(p_uri, p.to_uri)
     assert_equal(2, p.nodes.size)
     assert_equal('foo', p.nodes[0])
+    assert_equal('foo', p[0])
+    assert_empty(p.nodes[1])
+    assert_empty(p[1])
 
     p_uri = '/123%20abc'
     p = UCP.new(p_uri)

data/test/test_component_query.rb

@@ -6,7 +6,7 @@ UCQ = URI::Component::Query
 module URI
 module Component
 
-class TestQueryClass < Test::Unit::TestCase
+class QueryTest < Test::Unit::TestCase
   def setup
   end
 

data/test/test_component_userinfo.rb

@@ -6,7 +6,7 @@ UCUI = URI::Component::UserInfo
 module URI
 module Component
 
-class TestUserInfoClass < Test::Unit::TestCase
+class UserInfoTest < Test::Unit::TestCase
   def setup
   end
 

data/uri-compoment.gemspec

@@ -11,8 +11,6 @@ Gem::Specification.new do |s|
   s.summary     = %q{URI::Component::* classes}
   s.description = %q{Handle URI components as an object}
 
-  s.rubyforge_project = "uri-component"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uri-component
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-05 00:00:00.000000000 Z
+date: 2011-11-10 00:00:00.000000000 Z
 dependencies: []
 description: Handle URI components as an object
 email:
@@ -48,7 +48,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: uri-component
+rubyforge_project: 
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3