addressable 2.1.2 → 2.2.0

data/CHANGELOG

@@ -1,88 +1,92 @@
+=== Addressable 2.2.0
+- added site methods
+- improved documentation
+
 === Addressable 2.1.2
-  * added HTTP request URI methods
-  * better handling of Windows file paths
-  * validation_deferred boolean replaced with defer_validation block
-  * normalization of percent-encoded paths should now be correct
-  * fixed issue with constructing URIs with relative paths
-  * fixed warnings
+- added HTTP request URI methods
+- better handling of Windows file paths
+- validation_deferred boolean replaced with defer_validation block
+- normalization of percent-encoded paths should now be correct
+- fixed issue with constructing URIs with relative paths
+- fixed warnings
 
 === Addressable 2.1.1
-  * more type checking changes
-  * fixed issue with unicode normalization
-  * added method to find template defaults
-  * symbolic keys are now allowed in template mappings
-  * numeric values and symbolic values are now allowed in template mappings
+- more type checking changes
+- fixed issue with unicode normalization
+- added method to find template defaults
+- symbolic keys are now allowed in template mappings
+- numeric values and symbolic values are now allowed in template mappings
 
 === Addressable 2.1.0
-  * refactored URI template support out into its own class
-  * removed extract method due to being useless and unreliable
-  * removed Addressable::URI.expand_template
-  * removed Addressable::URI#extract_mapping
-  * added partial template expansion
-  * fixed minor bugs in the parse and heuristic_parse methods
-  * fixed incompatibility with Ruby 1.9.1
-  * fixed bottleneck in Addressable::URI#hash and Addressable::URI#to_s
-  * fixed unicode normalization exception
-  * updated query_values methods to better handle subscript notation
-  * worked around issue with freezing URIs
-  * improved specs
+- refactored URI template support out into its own class
+- removed extract method due to being useless and unreliable
+- removed Addressable::URI.expand_template
+- removed Addressable::URI#extract_mapping
+- added partial template expansion
+- fixed minor bugs in the parse and heuristic_parse methods
+- fixed incompatibility with Ruby 1.9.1
+- fixed bottleneck in Addressable::URI#hash and Addressable::URI#to_s
+- fixed unicode normalization exception
+- updated query_values methods to better handle subscript notation
+- worked around issue with freezing URIs
+- improved specs
 
 === Addressable 2.0.2
-  * fixed issue with URI template expansion
-  * fixed issue with percent escaping characters 0-15
+- fixed issue with URI template expansion
+- fixed issue with percent escaping characters 0-15
 
 === Addressable 2.0.1
-  * fixed issue with query string assignment
-  * fixed issue with improperly encoded components
+- fixed issue with query string assignment
+- fixed issue with improperly encoded components
 
 === Addressable 2.0.0
-  * the initialize method now takes an options hash as its only parameter
-  * added query_values method to URI class
-  * completely replaced IDNA implementation with pure Ruby
-  * renamed Addressable::ADDRESSABLE_VERSION to Addressable::VERSION
-  * completely reworked the Rakefile
-  * changed the behavior of the port method significantly
-  * Addressable::URI.encode_segment, Addressable::URI.unencode_segment renamed
-  * documentation is now in YARD format
-  * more rigorous type checking
-  * to_str method implemented, implicit conversion to Strings now allowed
-  * Addressable::URI#omit method added, Addressable::URI#merge method replaced
-  * updated URI Template code to match v 03 of the draft spec
-  * added a bunch of new specifications
+- the initialize method now takes an options hash as its only parameter
+- added query_values method to URI class
+- completely replaced IDNA implementation with pure Ruby
+- renamed Addressable::ADDRESSABLE_VERSION to Addressable::VERSION
+- completely reworked the Rakefile
+- changed the behavior of the port method significantly
+- Addressable::URI.encode_segment, Addressable::URI.unencode_segment renamed
+- documentation is now in YARD format
+- more rigorous type checking
+- to_str method implemented, implicit conversion to Strings now allowed
+- Addressable::URI#omit method added, Addressable::URI#merge method replaced
+- updated URI Template code to match v 03 of the draft spec
+- added a bunch of new specifications
 
 === Addressable 1.0.4
-  * switched to using RSpec's pending system for specs that rely on IDN
-  * fixed issue with creating URIs with paths that are not prefixed with '/'
+- switched to using RSpec's pending system for specs that rely on IDN
+- fixed issue with creating URIs with paths that are not prefixed with '/'
 
 === Addressable 1.0.3
-  * implemented a hash method
+- implemented a hash method
 
 === Addressable 1.0.2
-  * fixed minor bug with the extract_mapping method
+- fixed minor bug with the extract_mapping method
 
 === Addressable 1.0.1
-  * fixed minor bug with the extract_mapping method
+- fixed minor bug with the extract_mapping method
 
 === Addressable 1.0.0
-  * heuristic parse method added
-  * parsing is slightly more strict
-  * replaced to_h with to_hash
-  * fixed routing methods
-  * improved specifications
-  * improved heckle rake task
-  * no surviving heckle mutations
+- heuristic parse method added
+- parsing is slightly more strict
+- replaced to_h with to_hash
+- fixed routing methods
+- improved specifications
+- improved heckle rake task
+- no surviving heckle mutations
 
 === Addressable 0.1.2
-  * improved normalization
-  * fixed bug in joining algorithm
-  * updated specifications
+- improved normalization
+- fixed bug in joining algorithm
+- updated specifications
   
 === Addressable 0.1.1
-  * updated documentation
-  * added URI Template variable extraction
+- updated documentation
+- added URI Template variable extraction
   
 === Addressable 0.1.0
-  * initial release
-  * implementation based on RFC 3986, 3987
-  * support for IRIs via libidn
-  * support for the URI Template draft spec
+- initial release
+- implementation based on RFC 3986, 3987
+- support for IRIs via libidn
+- support for the URI Template draft spec

data/LICENSE

@@ -1,4 +1,4 @@
-Addressable, Copyright (c) 2006-2008 Bob Aman
+Addressable, Copyright (c) 2006-2010 Bob Aman
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README

@@ -1,10 +1,20 @@
+== About
+
+Homepage::  Addressable[http://addressable.rubyforge.org/]
+Authors::   Bob Aman (mailto:bob@sporkmonger.com)
+Copyright:: Copyright 2010 Bob Aman
+License::   MIT
+
 Addressable is a replacement for the URI implementation that is part of
 Ruby's standard library. It more closely conforms to the relevant RFCs and
 adds support for IRIs and URI templates.  Additionally, it provides extensive
 support for URI templates.
 
-Example usage:
- 
+== Classes
+- {Addressable::URI}
+- {Addressable::Template}
+
+== Example usage
   require "addressable/uri"
 
   uri = Addressable::URI.parse("http://example.com/path/to/resource/")

data/Rakefile

@@ -27,38 +27,6 @@ Ruby's standard library. It more closely conforms to the relevant RFCs and
 adds support for IRIs and URI templates.
 TEXT
 
-desc "generates .gemspec file"
-task :gemspec do
-  spec = Gem::Specification.new do |p|
-    p.name = 'addressable'
-    p.version = PKG_VERSION
-
-    p.summary = PKG_SUMMARY
-    p.description = PKG_DESCRIPTION
-
-    p.author = 'Bob Aman'
-    p.email  = 'bob@sporkmonger.com'
-    p.homepage = 'http://github.com/mislav/addressable'
-    p.rubyforge_project = nil
-
-    p.files = FileList['Rakefile', '{bin,lib,tasks,spec}/**/*', 'README*', 'LICENSE*', 'CHANGELOG*'] & `git ls-files`.split
-
-    p.executables = Dir['bin/*'].map { |f| File.basename(f) }
-
-    p.has_rdoc = true
-  end
-  
-  spec_string = spec.to_ruby
-  
-  begin
-    Thread.new { eval("$SAFE = 3\n#{spec_string}", binding) }.join 
-  rescue
-    abort "unsafe gemspec: #{$!}"
-  else
-    File.open("#{spec.name}.gemspec", 'w') { |file| file.write spec_string }
-  end
-end
-
 PKG_FILES = FileList[
     "lib/**/*", "spec/**/*", "vendor/**/*",
     "tasks/**/*", "website/**/*",

data/lib/addressable/template.rb

@@ -1,6 +1,6 @@
 # encoding:utf-8
 #--
-# Addressable, Copyright (c) 2006-2008 Bob Aman
+# Addressable, Copyright (c) 2006-2010 Bob Aman
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/addressable/uri.rb

@@ -1,6 +1,6 @@
 # encoding:utf-8
 #--
-# Addressable, Copyright (c) 2006-2008 Bob Aman
+# Addressable, Copyright (c) 2006-2010 Bob Aman
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -58,9 +58,9 @@ module Addressable
     # Returns a URI object based on the parsed string.
     #
     # @param [String, Addressable::URI, #to_str] uri
-    #   The URI string to parse. 
-    # No parsing is performed if the object is already an
-    # <tt>Addressable::URI</tt>.
+    #   The URI string to parse.
+    #   No parsing is performed if the object is already an
+    #   <code>Addressable::URI</code>.
     #
     # @return [Addressable::URI] The parsed URI.
     def self.parse(uri)
@@ -130,11 +130,11 @@ module Addressable
     #
     # @param [String, Addressable::URI, #to_str] uri
     #   The URI string to parse.
-    # No parsing is performed if the object is already an
-    # <tt>Addressable::URI</tt>.
+    #   No parsing is performed if the object is already an
+    #   <code>Addressable::URI</code>.
     # @param [Hash] hints
-    #   A <tt>Hash</tt> of hints to the heuristic parser. 
-    # Defaults to <tt>{:scheme => "http"}</tt>.
+    #   A <code>Hash</code> of hints to the heuristic parser.
+    #   Defaults to <code>{:scheme => "http"}</code>.
     #
     # @return [Addressable::URI] The parsed URI.
     def self.heuristic_parse(uri, hints={})
@@ -183,13 +183,13 @@ module Addressable
     # Converts a path to a file scheme URI. If the path supplied is
     # relative, it will be returned as a relative URI. If the path supplied
     # is actually a non-file URI, it will parse the URI as if it had been
-    # parsed with <tt>Addressable::URI.parse</tt>. Handles all of the
+    # parsed with <code>Addressable::URI.parse</code>. Handles all of the
     # various Microsoft-specific formats for specifying paths.
     #
     # @param [String, Addressable::URI, #to_str] path
-    #
-    # Typically a <tt>String</tt> path to a file or directory, but will return
-    # a sensible return value if an absolute URI is supplied instead.
+    #   Typically a <code>String</code> path to a file or directory, but
+    #   will return a sensible return value if an absolute URI is supplied
+    #   instead.
     #
     # @return [Addressable::URI]
     #   The parsed file scheme URI or the original URI if some other URI
@@ -279,17 +279,17 @@ module Addressable
     # @param [String, #to_str] component The URI component to encode.
     #
     # @param [String, Regexp] character_class
-    #
-    # The characters which are not percent encoded. If a <tt>String</tt> is
-    # passed, the <tt>String</tt> must be formatted as a regular expression
-    # character class. (Do not include the surrounding square brackets.)  For
-    # example, <tt>"b-zB-Z0-9"</tt> would cause everything but the letters 'b'
-    # through 'z' and the numbers '0' through '9' to be percent encoded. If a
-    # <tt>Regexp</tt> is passed, the value <tt>/[^b-zB-Z0-9]/</tt> would have
-    # the same effect. A set of useful <tt>String</tt> values may be found in
-    # the <tt>Addressable::URI::CharacterClasses</tt> module. The default
-    # value is the reserved plus unreserved character classes specified in <a
-    # href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>.
+    #   The characters which are not percent encoded. If a <code>String</code>
+    #   is passed, the <code>String</code> must be formatted as a regular
+    #   expression character class. (Do not include the surrounding square
+    #   brackets.)  For example, <code>"b-zB-Z0-9"</code> would cause
+    #   everything but the letters 'b' through 'z' and the numbers '0' through
+    #  '9' to be percent encoded. If a <code>Regexp</code> is passed, the
+    #   value <code>/[^b-zB-Z0-9]/</code> would have the same effect. A set of
+    #   useful <code>String</code> values may be found in the
+    #   <code>Addressable::URI::CharacterClasses</code> module. The default
+    #   value is the reserved plus unreserved character classes specified in
+    #   <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>.
     #
     # @return [String] The encoded component.
     #
@@ -334,21 +334,21 @@ module Addressable
     ##
     # Unencodes any percent encoded characters within a URI component.
     # This method may be used for unencoding either components or full URIs,
-    # however, it is recommended to use the <tt>unencode_component</tt> alias
-    # when unencoding components.
+    # however, it is recommended to use the <code>unencode_component</code>
+    # alias when unencoding components.
     #
     # @param [String, Addressable::URI, #to_str] uri
     #   The URI or component to unencode.
     #
     # @param [Class] returning
     #   The type of object to return.
-    # This value may only be set to <tt>String</tt> or
-    # <tt>Addressable::URI</tt>. All other values are invalid. Defaults to
-    # <tt>String</tt>.
+    #   This value may only be set to <code>String</code> or
+    #   <code>Addressable::URI</code>. All other values are invalid. Defaults
+    #   to <code>String</code>.
     #
     # @return [String, Addressable::URI]
     #   The unencoded component or URI.
-    # The return type is determined by the <tt>returning</tt> parameter.
+    #   The return type is determined by the <code>returning</code> parameter.
     def self.unencode(uri, returning=String)
       return nil if uri.nil?
       if !uri.respond_to?(:to_str)
@@ -383,17 +383,17 @@ module Addressable
     # @param [String, #to_str] component The URI component to encode.
     #
     # @param [String, Regexp] character_class
-    #
-    # The characters which are not percent encoded. If a <tt>String</tt> is
-    # passed, the <tt>String</tt> must be formatted as a regular expression
-    # character class. (Do not include the surrounding square brackets.)  For
-    # example, <tt>"b-zB-Z0-9"</tt> would cause everything but the letters 'b'
-    # through 'z' and the numbers '0' through '9' to be percent encoded. If a
-    # <tt>Regexp</tt> is passed, the value <tt>/[^b-zB-Z0-9]/</tt> would have
-    # the same effect. A set of useful <tt>String</tt> values may be found in
-    # the <tt>Addressable::URI::CharacterClasses</tt> module. The default
-    # value is the reserved plus unreserved character classes specified in <a
-    # href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>.
+    #   The characters which are not percent encoded. If a <code>String</code>
+    #   is passed, the <code>String</code> must be formatted as a regular
+    #   expression character class. (Do not include the surrounding square
+    #   brackets.)  For example, <code>"b-zB-Z0-9"</code> would cause
+    #   everything but the letters 'b' through 'z' and the numbers '0' through
+    #  '9' to be percent encoded. If a <code>Regexp</code> is passed, the
+    #   value <code>/[^b-zB-Z0-9]/</code> would have the same effect. A set of
+    #   useful <code>String</code> values may be found in the
+    #   <code>Addressable::URI::CharacterClasses</code> module. The default
+    #   value is the reserved plus unreserved character classes specified in
+    #   <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>.
     #
     # @return [String] The normalized component.
     #
@@ -449,13 +449,13 @@ module Addressable
     #
     # @param [Class] returning
     #   The type of object to return.
-    # This value may only be set to <tt>String</tt> or
-    # <tt>Addressable::URI</tt>. All other values are invalid. Defaults to
-    # <tt>String</tt>.
+    #   This value may only be set to <code>String</code> or
+    #   <code>Addressable::URI</code>. All other values are invalid. Defaults
+    #   to <code>String</code>.
     #
     # @return [String, Addressable::URI]
     #   The encoded URI.
-    # The return type is determined by the <tt>returning</tt> parameter.
+    #   The return type is determined by the <code>returning</code> parameter.
     def self.encode(uri, returning=String)
       return nil if uri.nil?
       if !uri.respond_to?(:to_str)
@@ -499,13 +499,13 @@ module Addressable
     #
     # @param [Class] returning
     #   The type of object to return.
-    # This value may only be set to <tt>String</tt> or
-    # <tt>Addressable::URI</tt>. All other values are invalid. Defaults to
-    # <tt>String</tt>.
+    #   This value may only be set to <code>String</code> or
+    #   <code>Addressable::URI</code>. All other values are invalid. Defaults
+    #   to <code>String</code>.
     #
     # @return [String, Addressable::URI]
-    #   The encoded URI. 
-    # The return type is determined by the <tt>returning</tt> parameter.
+    #   The encoded URI.
+    #   The return type is determined by the <code>returning</code> parameter.
     def self.normalized_encode(uri, returning=String)
       if !uri.respond_to?(:to_str)
         raise TypeError, "Can't convert #{uri.class} into String."
@@ -649,13 +649,19 @@ module Addressable
 
       if new_scheme && !new_scheme.respond_to?(:to_str)
         raise TypeError, "Can't convert #{new_scheme.class} into String."
+      elsif new_scheme
+        new_scheme = new_scheme.to_str
+      end
+      if new_scheme && new_scheme !~ /[a-z][a-z0-9\.\+\-]*/i
+        raise InvalidURIError, "Invalid scheme format."
       end
-      @scheme = new_scheme ? new_scheme.to_str : nil
+      @scheme = new_scheme
       @scheme = nil if @scheme.to_s.strip == ""
 
       # Reset dependant values
       @normalized_scheme = nil
       @uri_string = nil
+      @hash = nil
 
       # Ensure we haven't created an invalid URI
       validate()
@@ -716,6 +722,7 @@ module Addressable
       @authority = nil
       @normalized_user = nil
       @uri_string = nil
+      @hash = nil
 
       # Ensure we haven't created an invalid URI
       validate()
@@ -777,6 +784,7 @@ module Addressable
       @authority = nil
       @normalized_password = nil
       @uri_string = nil
+      @hash = nil
 
       # Ensure we haven't created an invalid URI
       validate()
@@ -846,6 +854,7 @@ module Addressable
       # Reset dependant values
       @authority = nil
       @uri_string = nil
+      @hash = nil
 
       # Ensure we haven't created an invalid URI
       validate()
@@ -901,6 +910,7 @@ module Addressable
       @authority = nil
       @normalized_host = nil
       @uri_string = nil
+      @hash = nil
 
       # Ensure we haven't created an invalid URI
       validate()
@@ -986,6 +996,7 @@ module Addressable
       @userinfo = nil
       @normalized_userinfo = nil
       @uri_string = nil
+      @hash = nil
 
       # Ensure we haven't created an invalid URI
       validate()
@@ -993,7 +1004,7 @@ module Addressable
 
     # Returns an array of known ip-based schemes. These schemes typically
     # use a similar URI form:
-    # //<user>:<password>@<host>:<port>/<url-path>
+    # <code>//<user>:<password>@<host>:<port>/<url-path></code>
     def self.ip_based_schemes
       return self.port_mapping.keys
     end
@@ -1067,6 +1078,7 @@ module Addressable
       @inferred_port = nil
       @normalized_port = nil
       @uri_string = nil
+      @hash = nil
 
       # Ensure we haven't created an invalid URI
       validate()
@@ -1092,6 +1104,76 @@ module Addressable
       end)
     end
 
+    ##
+    # The combination of components that represent a site.
+    # Combines the scheme, user, password, host, and port components.
+    # Primarily useful for HTTP and HTTPS.
+    #
+    # For example, <code>"http://example.com/path?query"</code> would have a
+    # <code>site</code> value of <code>"http://example.com"</code>.
+    #
+    # @return [String] The components that identify a site.
+    def site
+      @site ||= (begin
+        if self.scheme || self.authority
+          site_string = ""
+          site_string << "#{self.scheme}:" if self.scheme != nil
+          site_string << "//#{self.authority}" if self.authority != nil
+          site_string
+        else
+          nil
+        end
+      end)
+    end
+
+    ##
+    # The normalized combination of components that represent a site.
+    # Combines the scheme, user, password, host, and port components.
+    # Primarily useful for HTTP and HTTPS.
+    #
+    # For example, <code>"http://example.com/path?query"</code> would have a
+    # <code>site</code> value of <code>"http://example.com"</code>.
+    #
+    # @return [String] The normalized components that identify a site.
+    def normalized_site
+      @site ||= (begin
+        if self.normalized_scheme || self.normalized_authority
+          site_string = ""
+          if self.normalized_scheme != nil
+            site_string << "#{self.normalized_scheme}:"
+          end
+          if self.normalized_authority != nil
+            site_string << "//#{self.normalized_authority}"
+          end
+          site_string
+        else
+          nil
+        end
+      end)
+    end
+
+    ##
+    # Sets the site value for this URI.
+    #
+    # @param [String, #to_str] new_site The new site value.
+    def site=(new_site)
+      if new_site
+        if !new_site.respond_to?(:to_str)
+          raise TypeError, "Can't convert #{new_site.class} into String."
+        end
+        new_site = new_site.to_str
+        # These two regular expressions derived from the primary parsing
+        # expression
+        self.scheme = new_site[/^(?:([^:\/?#]+):)?(?:\/\/(?:[^\/?#]*))?$/, 1]
+        self.authority = new_site[
+          /^(?:(?:[^:\/?#]+):)?(?:\/\/([^\/?#]*))?$/, 1
+        ]
+      else
+        self.scheme = nil
+        self.authority = nil
+      end
+    end
+
     ##
     # The path component for this URI.
     #
@@ -1148,6 +1230,7 @@ module Addressable
       # Reset dependant values
       @normalized_path = nil
       @uri_string = nil
+      @hash = nil
     end
 
     ##
@@ -1210,15 +1293,16 @@ module Addressable
       # Reset dependant values
       @normalized_query = nil
       @uri_string = nil
+      @hash = nil
     end
 
     ##
     # Converts the query component to a Hash value.
     #
     # @option [Symbol] notation
-    #   May be one of <tt>:flat</tt>, <tt>:dot</tt>, or <tt>:subscript</tt>.
-    # The <tt>:dot</tt> notation is not supported for assignment. Default
-    # value is <tt>:subscript</tt>.
+    #   May be one of <code>:flat</code>, <code>:dot</code>, or
+    #   <code>:subscript</code>. The <code>:dot</code> notation is not
+    #   supported for assignment. Default value is <code>:subscript</code>.
     #
     # @return [Hash] The query string parsed as a Hash object.
     #
@@ -1266,8 +1350,8 @@ module Addressable
       end
       return nil if self.query == nil
       return ((self.query.split("&").map do |pair|
-        pair.split("=")
-      end).inject({}) do |accumulator, (key, value)|
+        pair.split("=", -1) if pair && pair != ""
+      end).compact.inject({}) do |accumulator, (key, value)|
         value = true if value.nil?
         key = self.class.unencode_component(key)
         if value != true
@@ -1309,15 +1393,25 @@ module Addressable
     ##
     # Sets the query component for this URI from a Hash object.
     # This method produces a query string using the :subscript notation.
+    # An empty Hash will result in a nil query.
     #
     # @param [Hash, #to_hash] new_query_values The new query values.
     def query_values=(new_query_values)
       # Check for frozenness
       raise TypeError, "Can't modify frozen URI." if self.frozen?
+      if new_query_values == nil
+        self.query = nil
+        return nil
+      end
       if !new_query_values.respond_to?(:to_hash)
         raise TypeError, "Can't convert #{new_query_values.class} into Hash."
       end
       new_query_values = new_query_values.to_hash
+      new_query_values = new_query_values.map do |key, value|
+        key = key.to_s if key.kind_of?(Symbol)
+        [key, value]
+      end
+      new_query_values.sort! # Useful default for OAuth and caching
 
       # Algorithm shamelessly stolen from Julien Genestoux, slightly modified
       buffer = ""
@@ -1351,11 +1445,7 @@ module Addressable
           end
         end
       end
-      @query = buffer.chop
-
-      # Reset dependant values
-      @normalized_query = nil
-      @uri_string = nil
+      self.query = buffer.chop
     end
 
     ##
@@ -1393,6 +1483,7 @@ module Addressable
 
       # Reset dependant values
       @uri_string = nil
+      @hash = nil
     end
 
     ##
@@ -1436,6 +1527,7 @@ module Addressable
       # Reset dependant values
       @normalized_fragment = nil
       @uri_string = nil
+      @hash = nil
 
       # Ensure we haven't created an invalid URI
       validate()
@@ -1445,8 +1537,8 @@ module Addressable
     # Determines if the scheme indicates an IP-based protocol.
     #
     # @return [TrueClass, FalseClass]
-    # <tt>true</tt> if the scheme indicates an IP-based protocol.
-    # <tt>false</tt> otherwise.
+    #   <code>true</code> if the scheme indicates an IP-based protocol.
+    #   <code>false</code> otherwise.
     def ip_based?
       if self.scheme
         return self.class.ip_based_schemes.include?(
@@ -1459,7 +1551,8 @@ module Addressable
     # Determines if the URI is relative.
     #
     # @return [TrueClass, FalseClass]
-    # <tt>true</tt> if the URI is relative. <tt>false</tt> otherwise.
+    #   <code>true</code> if the URI is relative. <code>false</code>
+    #   otherwise.
     def relative?
       return self.scheme.nil?
     end
@@ -1468,7 +1561,8 @@ module Addressable
     # Determines if the URI is absolute.
     #
     # @return [TrueClass, FalseClass]
-    # <tt>true</tt> if the URI is absolute. <tt>false</tt> otherwise.
+    #   <code>true</code> if the URI is absolute. <code>false</code>
+    #   otherwise.
     def absolute?
       return !relative?
     end
@@ -1575,7 +1669,7 @@ module Addressable
     alias_method :+, :join
 
     ##
-    # Destructive form of <tt>join</tt>.
+    # Destructive form of <code>join</code>.
     #
     # @param [String, Addressable::URI, #to_str] The URI to join with.
     #
@@ -1587,10 +1681,10 @@ module Addressable
     end
 
     ##
-    # Merges a URI with a <tt>Hash</tt> of components.
-    # This method has different behavior from <tt>join</tt>. Any components
-    # present in the <tt>hash</tt> parameter will override the original
-    # components. The path component is not treated specially.
+    # Merges a URI with a <code>Hash</code> of components.
+    # This method has different behavior from <code>join</code>. Any
+    # components present in the <code>hash</code> parameter will override the
+    # original components. The path component is not treated specially.
     #
     # @param [Hash, Addressable::URI, #to_hash] The components to merge with.
     #
@@ -1655,7 +1749,7 @@ module Addressable
     end
 
     ##
-    # Destructive form of <tt>merge</tt>.
+    # Destructive form of <code>merge</code>.
     #
     # @param [Hash, Addressable::URI, #to_hash] The components to merge with.
     #
@@ -1669,7 +1763,7 @@ module Addressable
     ##
     # Returns the shortest normalized relative form of this URI that uses the
     # supplied URI as a base for resolution. Returns an absolute URI if
-    # necessary. This is effectively the opposite of <tt>route_to</tt>.
+    # necessary. This is effectively the opposite of <code>route_to</code>.
     #
     # @param [String, Addressable::URI, #to_str] uri The URI to route from.
     #
@@ -1727,7 +1821,7 @@ module Addressable
     ##
     # Returns the shortest normalized relative form of the supplied URI that
     # uses this URI as a base for resolution. Returns an absolute URI if
-    # necessary. This is effectively the opposite of <tt>route_from</tt>.
+    # necessary. This is effectively the opposite of <code>route_from</code>.
     #
     # @param [String, Addressable::URI, #to_str] uri The URI to route to.
     #
@@ -1791,14 +1885,15 @@ module Addressable
     end
 
     ##
-    # Returns <tt>true</tt> if the URI objects are equal. This method
+    # Returns <code>true</code> if the URI objects are equal. This method
     # normalizes both URIs before doing the comparison, and allows comparison
-    # against <tt>Strings</tt>.
+    # against <code>Strings</code>.
     #
     # @param [Object] uri The URI to compare.
     #
     # @return [TrueClass, FalseClass]
-    #   <tt>true</tt> if the URIs are equivalent, <tt>false</tt> otherwise.
+    #   <code>true</code> if the URIs are equivalent, <code>false</code>
+    #   otherwise.
     def ===(uri)
       if uri.respond_to?(:normalize)
         uri_string = uri.normalize.to_s
@@ -1813,26 +1908,28 @@ module Addressable
     end
 
     ##
-    # Returns <tt>true</tt> if the URI objects are equal. This method
+    # Returns <code>true</code> if the URI objects are equal. This method
     # normalizes both URIs before doing the comparison.
     #
     # @param [Object] uri The URI to compare.
     #
     # @return [TrueClass, FalseClass]
-    #   <tt>true</tt> if the URIs are equivalent, <tt>false</tt> otherwise.
+    #   <code>true</code> if the URIs are equivalent, <code>false</code>
+    #   otherwise.
     def ==(uri)
       return false unless uri.kind_of?(self.class)
       return self.normalize.to_s == uri.normalize.to_s
     end
 
     ##
-    # Returns <tt>true</tt> if the URI objects are equal. This method
+    # Returns <code>true</code> if the URI objects are equal. This method
     # does NOT normalize either URI before doing the comparison.
     #
     # @param [Object] uri The URI to compare.
     #
     # @return [TrueClass, FalseClass]
-    #   <tt>true</tt> if the URIs are equivalent, <tt>false</tt> otherwise.
+    #   <code>true</code> if the URIs are equivalent, <code>false</code>
+    #   otherwise.
     def eql?(uri)
       return false unless uri.kind_of?(self.class)
       return self.to_s == uri.to_s
@@ -1882,7 +1979,7 @@ module Addressable
     # Determines if the URI is frozen.
     #
     # @return [TrueClass, FalseClass]
-    #   True if the URI is frozen, false otherwise.
+    #   <code>true</code> if the URI is frozen, <code>false</code> otherwise.
     def frozen?
       self.to_s.frozen?
     end
@@ -1931,9 +2028,9 @@ module Addressable
     end
 
     ##
-    # Converts the URI to a <tt>String</tt>.
+    # Converts the URI to a <code>String</code>.
     #
-    # @return [String] The URI's <tt>String</tt> representation.
+    # @return [String] The URI's <code>String</code> representation.
     def to_s
       @uri_string ||= (begin
         uri_string = ""
@@ -1950,13 +2047,13 @@ module Addressable
     end
 
     ##
-    # URI's are glorified <tt>Strings</tt>. Allow implicit conversion.
+    # URI's are glorified <code>Strings</code>. Allow implicit conversion.
     alias_method :to_str, :to_s
 
     ##
     # Returns a Hash of the URI components.
     #
-    # @return [Hash] The URI as a <tt>Hash</tt> of components.
+    # @return [Hash] The URI as a <code>Hash</code> of components.
     def to_hash
       return {
         :scheme => self.scheme,
@@ -1971,9 +2068,9 @@ module Addressable
     end
 
     ##
-    # Returns a <tt>String</tt> representation of the URI object's state.
+    # Returns a <code>String</code> representation of the URI object's state.
     #
-    # @return [String] The URI object's state, as a <tt>String</tt>.
+    # @return [String] The URI object's state, as a <code>String</code>.
     def inspect
       sprintf("#<%s:%#0x URI:%s>", self.class.to_s, self.object_id, self.to_s)
     end
@@ -2055,9 +2152,9 @@ module Addressable
     # Replaces the internal state of self with the specified URI's state.
     # Used in destructive operations to avoid massive code repetition.
     #
-    # @param [Addressable::URI] uri The URI to replace <tt>self</tt> with.
+    # @param [Addressable::URI] uri The URI to replace <code>self</code> with.
     #
-    # @return [Addressable::URI] <tt>self</tt>.
+    # @return [Addressable::URI] <code>self</code>.
     def replace_self(uri)
       # Reset dependant values
       instance_variables.each do |var|