lib/uri/mailto.rb in rubysl-uri-1.0.0 vs lib/uri/mailto.rb in rubysl-uri-2.0.0

@@ -1,12 +1,13 @@
-#
 # = uri/mailto.rb
 #
 # Author:: Akira Yamada <[e-mail]>
 # License:: You can redistribute it and/or modify it under the same term as Ruby.
-# Revision:: $Id: mailto.rb 11747 2007-02-15 02:41:45Z knu $
+# Revision:: $Id$
 #
+# See URI for general documentation
+#
 
 require 'uri/generic'
 
 module URI
 
@@ -14,12 +15,14 @@
   # RFC2368, The mailto URL scheme
   #
   class MailTo < Generic
     include REGEXP
 
+    # A Default port of nil for URI::MailTo
     DEFAULT_PORT = nil
 
+    # An Array of the available components for URI::MailTo
     COMPONENT = [ :scheme, :to, :headers ].freeze
 
     # :stopdoc:
     #  "hname" and "hvalue" are encodings of an RFC 822 header name and
     #  value, respectively. As with "to", all URL reserved characters must
@@ -36,11 +39,11 @@
 
     # hname      =  *urlc
     # hvalue     =  *urlc
     # header     =  hname "=" hvalue
     HEADER_PATTERN = "(?:[^?=&]*=[^?=&]*)".freeze
-    HEADER_REGEXP  = Regexp.new(HEADER_PATTERN, 'N').freeze
+    HEADER_REGEXP  = Regexp.new(HEADER_PATTERN).freeze
     # headers    =  "?" header *( "&" header )
     # to         =  #mailbox
     # mailtoURL  =  "mailto:" [ to ] [ headers ]
     MAILBOX_PATTERN = "(?:#{PATTERN::ESCAPED}|[^(),%?=&])".freeze
     MAILTO_REGEXP = Regexp.new(" # :nodoc:
@@ -53,11 +56,11 @@
       (?:
         \\#
         (#{PATTERN::FRAGMENT})                        (?# 3: fragment)
       )?
       \\z
-    ", Regexp::EXTENDED, 'N').freeze
+    ", Regexp::EXTENDED).freeze
     # :startdoc:
 
     #
     # == Description
     #
@@ -66,24 +69,24 @@
     # Components can be provided as an Array or Hash. If an Array is used,
     # the components must be supplied as [to, headers].
     #
     # If a Hash is used, the keys are the component names preceded by colons.
     #
-    # The headers can be supplied as a pre-encoded string, such as 
+    # The headers can be supplied as a pre-encoded string, such as
     # "subject=subscribe&cc=address", or as an Array of Arrays like
     # [['subject', 'subscribe'], ['cc', 'address']]
     #
     # Examples:
-    # 
+    #
     #    require 'uri'
-    #    
+    #
     #    m1 = URI::MailTo.build(['[e-mail]', 'subject=Ruby'])
     #    puts m1.to_s  ->  mailto:[e-mail]?subject=Ruby
-    #    
+    #
     #    m2 = URI::MailTo.build(['[e-mail]', [['Subject', 'Ruby'], ['Cc', '[e-mail]']]])
     #    puts m2.to_s  ->  mailto:[e-mail]?Subject=Ruby&Cc=[e-mail]
-    #    
+    #
     #    m3 = URI::MailTo.build({:to => '[e-mail]', :headers => [['subject', 'subscribe']]})
     #    puts m3.to_s  ->  mailto:[e-mail]?subject=subscribe
     #
     def self.build(args)
       tmp = Util::make_components_hash(self, args)
@@ -98,11 +101,11 @@
         tmp[:opaque] << '?'
 
         if tmp[:headers].kind_of?(Array)
           tmp[:opaque] << tmp[:headers].collect { |x|
             if x.kind_of?(Array)
-              x[0] + '=' + x[1..-1].to_s
+              x[0] + '=' + x[1..-1].join
             else
               x.to_s
             end
           }.join('&')
 
@@ -133,11 +136,11 @@
 
       @to = nil
       @headers = []
 
       if MAILTO_REGEXP =~ @opaque
-         if arg[-1]
+        if arg[-1]
           self.to = $1
           self.headers = $2
         else
           set_to($1)
           set_headers($2)
@@ -153,71 +156,82 @@
     attr_reader :to
 
     # E-mail headers set by the URL, as an Array of Arrays
     attr_reader :headers
 
+    # check the to +v+ component against either
+    # * URI::Parser Regexp for :OPAQUE
+    # * MAILBOX_PATTERN
     def check_to(v)
       return true unless v
       return true if v.size == 0
 
-      if OPAQUE !~ v || /\A#{MAILBOX_PATTERN}*\z/o !~ v
+      if parser.regexp[:OPAQUE] !~ v || /\A#{MAILBOX_PATTERN}*\z/o !~ v
         raise InvalidComponentError,
           "bad component(expected opaque component): #{v}"
       end
 
       return true
     end
     private :check_to
 
+    # private setter for to +v+
     def set_to(v)
       @to = v
     end
     protected :set_to
 
+    # setter for to +v+
     def to=(v)
       check_to(v)
       set_to(v)
       v
     end
 
+    # check the headers +v+ component against either
+    # * URI::Parser Regexp for :OPAQUE
+    # * HEADER_PATTERN
     def check_headers(v)
       return true unless v
       return true if v.size == 0
 
-      if OPAQUE !~ v || 
+      if parser.regexp[:OPAQUE] !~ v ||
           /\A(#{HEADER_PATTERN}(?:\&#{HEADER_PATTERN})*)\z/o !~ v
         raise InvalidComponentError,
           "bad component(expected opaque component): #{v}"
       end
 
       return true
     end
     private :check_headers
 
+    # private setter for headers +v+
     def set_headers(v)
       @headers = []
       if v
         v.scan(HEADER_REGEXP) do |x|
           @headers << x.split(/=/o, 2)
         end
       end
     end
     protected :set_headers
 
+    # setter for headers +v+
     def headers=(v)
       check_headers(v)
       set_headers(v)
       v
     end
 
+    # Constructs String from URI
     def to_s
-      @scheme + ':' + 
-        if @to 
+      @scheme + ':' +
+        if @to
           @to
         else
           ''
-        end + 
+        end +
         if @headers.size > 0
           '?' + @headers.collect{|x| x.join('=')}.join('&')
         else
           ''
         end +
@@ -225,11 +239,11 @@
           '#' + @fragment
         else
           ''
         end
     end
-    
+
     # Returns the RFC822 e-mail text equivalent of the URL, as a String.
     #
     # Example:
     #
     #   require 'uri'
@@ -237,21 +251,21 @@
     #   uri = URI.parse("mailto:[e-mail]?Subject=subscribe&cc=myaddr")
     #   uri.to_mailtext
     #   # => "To: [e-mail]\nSubject: subscribe\nCc: myaddr\n\n\n"
     #
     def to_mailtext
-      to = URI::unescape(@to)
+      to = parser.unescape(@to)
       head = ''
       body = ''
       @headers.each do |x|
         case x[0]
         when 'body'
-          body = URI::unescape(x[1])
+          body = parser.unescape(x[1])
         when 'to'
-          to << ', ' + URI::unescape(x[1])
+          to << ', ' + parser.unescape(x[1])
         else
-          head << URI::unescape(x[0]).capitalize + ': ' +
-            URI::unescape(x[1])  + "\n"
+          head << parser.unescape(x[0]).capitalize + ': ' +
+            parser.unescape(x[1])  + "\n"
         end
       end
 
       return "To: #{to}
 #{head}