ultra7 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f62703e25a0ab003dc3357a058cd477a2e06f641
-  data.tar.gz: 3f23a8005cd49ed42b90e6332b6eaee95840b733
+  metadata.gz: c5a3e1cae83da627a5d3d9e1ad0147e6f7521ca1
+  data.tar.gz: fa0a08df7b4028b3835725858e131244f25aea28
 SHA512:
-  metadata.gz: 4bb714b90e0515d702ff2323d4d7f36512fe8b31f85b5d52b61f569958476d41354909d5cb637f2481a2dbbf4ffd70432c2e760c63ceb2ed6eadfdd9ba035fd2
-  data.tar.gz: 791973fca61789c8ad943c828e9174228a4c463fa2e6b4caee4d87e60808e8667fd595566017fe42c9530b40276601b76337e673be6a57fe3616b98511710f9b
+  metadata.gz: 132176393aa4a6a2bc42bd744e4fdf73205af9b99d200b48980c07619631b4cc69a4078e9c849a452e139882a6dd46d5387febafaab1d815dc7a1bfe70f76525
+  data.tar.gz: 761e5694be3f35cc2cb368a0b9bcddb44564bfc6843f6b3e43bbbed8e800b8d2bc192fe7f1118e01068dfb3cfb17b3ac3fbcd9823bde5e7d9b9e3504e6b69220

data/CHANGELOG

@@ -1,5 +1,12 @@
 ## CHANGELOG
 
+- __2014/12/17__: 0.5.0 release.
+    - Enhanced handling for multi-line string input.
+	- Minor documentation edits for clarity.
+
+- __2014/12/14__: 0.4.0 release.
+    - Very minor documentation corrections.
+
 - __2014/12/14__: 0.3.0 release.
     - Slight enhancement to MIME encoded-word handling. 
 

data/README.md

@@ -3,8 +3,8 @@ A UTF-7 MIME header decoder, plain and simple.
 
 ## What is Ultra7?
 
-* Ultra7 is a UTF-7 decoder for MIME message header names and values, per the MIME [encoded word syntax of RFC-2047](http://tools.ietf.org/html/rfc2047),
-* It is almost unlike [`Net::IMAP.decode_utf7`](http://ruby-doc.org/stdlib-2.0.0/libdoc/net/imap/rdoc/Net/IMAP.html#method-c-decode_utf7), which is meant for decoding mailbox names. 
+* Ultra7 is a UTF-7 decoder for MIME message headers, per the [MIME encoded word syntax of RFC-2047](http://tools.ietf.org/html/rfc2047).
+* It is almost, but not quite, *completely unlike [`Net::IMAP.decode_utf7`](http://ruby-doc.org/stdlib-2.0.0/libdoc/net/imap/rdoc/Net/IMAP.html#method-c-decode_utf7)*, which is meant for decoding *mailbox names*. Ultra7 only does MIME message headers.
 * `Ultra7::MIME` is also a mixin, so you can conveniently combine it in another class by using
 `include`.
 * Read the [API documentation](http://www.rubydoc.info/gems/ultra7).
@@ -33,12 +33,12 @@ A UTF-7 MIME header decoder, plain and simple.
         puts Ultra7::MIME.decode_utf7('1 +- 1 = 2')
         => "1 + 1 = 2"
     
-        # Decode a UTF-7 encoded string, returning string with default encoding
+        # Decodes UTF-7, returning string with default encoding
         puts Ultra7::MIME.decode_utf7('Hello, +ZeVnLIqe-')
         => "Hello, 日本語"
-   
-        # Decode a MIME encoded word, returning the decoded value
-        # as a string with explicit UTF-8 encoding
+    
+        # Decodes an actual Subject MIME header in UTF-7,
+        # returning string with explicit UTF-8 encoding
         subject = '=?unicode-1-1-utf-7?Q?+vDCy7A-  +wMHQ3A-  +xUy5vA-(+wuTTKA-)?='
         Ultra7::MIME.decode_utf7(subject, encoding: 'UTF-8')
         => "배달  상태  알림(실패)"
@@ -74,4 +74,4 @@ A UTF-7 MIME header decoder, plain and simple.
 Please see the {file:CHANGELOG} for this gem's release history.
 
 ## Copyright
-Copyright © 2014-2015, Brooke M. Fujita. All rights reserved. Please see the {file:LICENSE} file for further details.
+Copyright © 2014-2015, Brooke M. Fujita. All rights reserved. Please see the {file:LICENSE} file for further details.

data/lib/ultra7/mime.rb

@@ -8,22 +8,21 @@ module Ultra7
       base.extend(ClassMethods)
     end
 
-    # Returns the decoded value for the given
-    # UTF-7 encoded `text`. If the optional
-    # `encoding` value is not specified, in the `options`
+    # Parse the given UTF-7 encoded-word text
+    # and return the corresponding decoded value.
+    #
+    # If the `:encoding` name is not specified in the `options`
     # hash, then the resulting string will use the default
     # `Encoding.default_external` encoding.
     #
-    # @param [String] text UTF-7 string or MIME encoded word
+    # @param [String] text UTF-7 encoded-word text
     # @param [Hash] options
-    # @option options [String] :encoding the encoding for the decoded value 
-    # @return [String] decoded value, using either 
-    #   `Encoding.default_external` or the given `:encoding`
-    # @raise [ArgumentError] if the encoding passed in is not UTF-7,
-    #   or if the encoding for the decoded value is not valid
-    def self.decode_utf7(text, options={encoding: nil}) 
+    # @return [String] UTF-7 decoded value
+    # @raise [ArgumentError] if text other than UTF-7 is passed in,
+    #   or the named `:encoding` cannot be found
+    def self.decode_utf7(text, options={encoding: nil})
       # only deal with UTF-7 encoding
-      text.scan(/=\?(.*)\?[q]\?/i).each {
+      text.scan(/=\?(.*)\?[q]\?/im).each {
         e = $1
         if e and !(e=~/utf\-7/i)
           raise ArgumentError.new("Cannot decode #{e} as UTF-7!")
@@ -32,13 +31,13 @@ module Ultra7
 
       # remove any opening charset and Q-encoding start/end markers
       # for MIME encoded words
-      text = text.gsub(/\?=/, '').gsub(/=\?[^?]*utf\-7\?[q]\?/i, '')
+      text = text.gsub(/\?=/m, '').gsub(/=\?[^?]*utf\-7\?[q]\?/im, '')
 
       enc = options[:encoding].nil? \
         ? Encoding.default_external \
         : Encoding.find(options[:encoding])
       
-      return text.gsub(/\+(.*?)-/n) {
+      return text.gsub(/\+(.*?)-/mn) {
         if $1.empty?
           "+"
         else

data/lib/ultra7/version.rb

@@ -7,7 +7,7 @@
 # It may be used as a mixin.
 module Ultra7
   # Version string for this Rubygem.
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end
 
 # Copyright (c) 2014-2015, Brooke M. Fujita.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultra7
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Brooke M. Fujita
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-14 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies: []
 description: |
   ultra7 decodes UTF-7 in the context of MIME headers (c.f. https://tools.ietf.org/html/rfc2152).
@@ -17,7 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".yardopts"
+- .yardopts
 - CHANGELOG
 - LICENSE
 - README.md
@@ -34,17 +34,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: A UTF-7 MIME header decoder, plain and simple.