RubyGems - mime - Versions diffs - 0.2.0 → 0.3.0 - Mend

mime 0.2.0 → 0.3.0

Files changed (17) hide show

data/README.rdoc +41 -10
data/lib/mime.rb +6 -1
data/lib/mime/content_formats/text_flowed.rb +119 -0
data/lib/mime/content_types.rb +5 -4
data/lib/mime/discrete_media_factory.rb +13 -15
data/lib/mime/discrete_media_type.rb +27 -28
data/lib/mime/header_container.rb +1 -3
data/lib/mime/headers/mime.rb +10 -10
data/lib/mime/media_type.rb +8 -2
data/test/scaffold/multipart_form_data_mixed.msg +0 -0
data/test/scaffold/multipart_form_data_text.msg +1 -1
data/test/scaffold/multipart_mixed_inline_and_attachment.msg +0 -0
data/test/scaffold/plain_text_email.msg +1 -1
data/test/scaffold/text.msg +1 -1
data/test/test_mime.rb +18 -19
data/test/test_text_flowed.rb +130 -0
metadata +5 -2

data/README.rdoc CHANGED Viewed

@@ -12,6 +12,7 @@ multipart/form-data transactions.
 * MIME::CompositeMediaType for a description of composite media types
 * MIME::DiscreteMediaType for a description of discrete media types
 * MIME::DiscreteMediaFactory for easy programming of discrete media types
+* MIME::ContentFormats for ways to encode/decode discrete media types
 == Media Type Inheritance Heirarchy
@@ -92,6 +93,7 @@ bodies.
 <em>First things first!</em>
   require 'mime'
+  include MIME   # allow ommision of "MIME::" namespace in examples below
 === Instantiate a DiscreteMediaType object
@@ -103,7 +105,7 @@ file and determine the MIME type for you.
   file = '/tmp/data.xml'
-  text_media = TextMedia.new(File.read(file), 'text/xml')}  # media class
+  text_media = TextMedia.new(File.read(file), 'xml')}       # media class
   text_media = DiscreteMediaFactory.create(file)            # media factory
 Discrete media objects can then be embedded in MIME messages as we will see in
@@ -121,14 +123,14 @@ SMTP client.
   msg.subject = 'This is important'       # add subject
   msg.headers.add('Priority', 'urgent')   # add custom header
-  msg.body = TextMedia.new('hello, world!')
+  msg.body = TextMedia.new('hello, world!', 'plain', 'charset' => 'us-ascii')
   #
   # The following two snippets are equivalent to the previous line.
   #
   #   msg.body = "\r\nhello, world!"
   #   msg.header.add('Content-Type', 'text/plain; charset=us-ascii')
   #
-  #   --OR-- (notice the header must come first, followed by CRLFx2)
+  #   --OR-- (notice the header must come first, followed by two CRLFs)
   #
   #   msg.body = "Content-Type: text/plain; charset=us-ascii\r\n\r\nhello, world!"
@@ -164,13 +166,13 @@ The multipart/alternative content type allows for multiple, alternatively
 formatted versions of the same content, such as plain text and HTML. Clients are
 then responsible for choosing the most suitable version for display.
-  text_msg = TextMedia.new(<<TEXT_DATA, 'text/plain')
+  text_msg = TextMedia.new(<<TEXT_DATA, 'plain')
   **Hello, world!**
   Ruby is cool!
   TEXT_DATA
-  html_msg = TextMedia.new(<<HTML_DATA, 'text/html')
+  html_msg = TextMedia.new(<<HTML_DATA, 'html')
   <html>
   <body>
     <h1>Hello, world!</h1>
@@ -197,7 +199,7 @@ Notice the _img_ tag _src_.
   image = DiscreteMediaFactory.create('/tmp/ruby.png')
   image.content_transfer_encoding = 'binary'
-  html_msg = TextMedia.new(<<EOF, 'text/html; charset=iso-8859-1')
+  html_msg = TextMedia.new(<<EOF, 'html', 'charset' => 'iso-8859-1')
   <html>
   <body>
     <h1>Ruby Image</h1>
@@ -233,7 +235,7 @@ HTTP server. It contains a single text input and a file input.
   portrait_filename = '/tmp/joe_portrait.jpg'
   portrait_field = open(portrait_filename) do |f|
-    ImageMedia.new(f.read, 'image/jpeg')  # explicit content type
+    ImageMedia.new(f.read, 'jpeg')        # explicit content type
   end
   portrait_field.content_transfer_encoding = 'binary'
@@ -249,7 +251,7 @@ HTTP server. It contains a single text input and a file input.
 === HTML form with file upload via DiscreteMediaFactory
 The outcome of this example is identical to the previous one. The only semantic
-difference is that the DiscreteMediaFactory class is used to instantiate the
+difference is that the DiscreteMediaFactory module is used to instantiate the
 image object.
   name_field = TextMedia.new('Joe Blow')
@@ -264,6 +266,28 @@ image object.
   form_data.to_s
+=== Avoid "embarrassing line wraps" using flowed format for text/plain
+Text/Plain is usually displayed as preformatted text, often in a fixed font.
+That is, the characters start at the left margin of the display window, and
+advance to the right until a CRLF sequence is seen, at which point a new line
+is started, again at the left margin. When a line length exceeds the display
+window, some clients will wrap the line, while others invoke a horizontal
+scroll bar. The result: embarrassing line wraps.
+Flowed format allows the sender to express to the receiver which lines can be
+considered a logical paragraph, and thus flowed (wrapped and joined) as
+appropriate.
+  long_paragraph =
+    "This is a continuous fixed-line-length paragraph that is longer than " +
+    "80 characters and will be soft line wrapped after the word '80'.\n\n"
+  flowed_txt = ContentFormats::TextFlowed.encode(long_paragraph * 2)
+  flowed_msg = TextMedia.new(flowed_txt, 'plain', 'format' => 'flowed')
+  flowed_msg.to_s # neatly formatted text compatible with large to small screens
 == More Examples
 For many more examples, check the test class MIMETest.
@@ -276,13 +300,20 @@ Documentation :: http://ecentryx.com/gems/mime
 == History
-1. 2008-11-05, v0.1:   First public release
-2. 2013-11-17, v0.2.0: Update for Ruby 1.9.3
+1. 2008-11-05, v0.1
+   * First public release.
+2. 2013-12-18, v0.2.0
+   * Update for Ruby 1.9.3.
    * Update Rakefile test, package, and rdoc tasks.
    * Change test suite from Test::Unit to Minitest.
    * Cleanup existing and add new tests cases.
    * Clarify code comments and README examples.
    * Fix content type detection.
+3. 2014-02-28, v0.3.0
+   * Simplify API of DiscreteMediaType subclasses.
+   * Disallow Content-Type changes after instantiating DiscreteMediaType.
+   * Add flowed format support for text/plain (RFC 2646).
 == License

data/lib/mime.rb CHANGED Viewed

@@ -18,7 +18,11 @@
 #
 module MIME
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
+  module ContentFormats
+    MAX_SMTP_LINE = 997
+  end
 end
@@ -30,3 +34,4 @@ require 'mime/discrete_media_type'
 require 'mime/composite_media_type'
 require 'mime/message'
 require 'mime/discrete_media_factory'
+require 'mime/content_formats/text_flowed'

data/lib/mime/content_formats/text_flowed.rb ADDED Viewed

@@ -0,0 +1,119 @@
+module MIME::ContentFormats
+  #
+  # Minimal implementation of RFC 2646: The Text/Plain Format Parameter
+  #
+  # https://www.ietf.org/rfc/rfc2646.txt
+  #
+  # == Excerpts from RFC
+  #
+  # This memo proposes a new parameter to be used with Text/Plain, and, in the
+  # presence of this parameter, the use of trailing whitespace to indicate
+  # flowed lines.  This results in an encoding which appears as normal
+  # Text/Plain in older implementations, since it is in fact normal
+  # Text/Plain.
+  #
+  # Each paragraph is displayed, starting at the left margin (or paragraph
+  # indent), and continuing to the right until a word is encountered which
+  # does not fit in the remaining display width. This word is displayed at the
+  # left margin of the next line. This continues until the paragraph ends (a
+  # CRLF is seen).
+  #
+  # == MIME format parameter to the text/plain media type
+  #
+  #   Name:  Format
+  #   Value: Fixed, Flowed
+  #   Example: Content-Type: text/plain; charset=iso-8859-1; format=flowed
+  #
+  #--
+  # == TODO
+  # - Implement RFC 3676, which obsoletes RFC 2646.
+  # - Usenet signature convention (section 4.3)
+  # - Space-Stuffing (section 4.4)
+  # - Quoting (section 4.5)
+  # - Perhaps this should be subsumed into the MIME project.
+  #
+  module TextFlowed
+    MAX_FLOWED_LINE = 79
+    #
+    # Encode plain +text+ into flowed format, reducing long lines to +max+
+    # characters or less using soft line breaks (i.e., SPACE+CRLF).
+    #
+    # The default +max+ line length is 79 characters. According to the RFC, 66
+    # and 72 characters is also common.
+    #
+    # The features of RFC 2646, such as line quoting and space-stuffing,
+    # are not implemented.
+    #
+    def self.encode(text, max = MAX_FLOWED_LINE)
+      if max > 79
+        raise ArgumentError, 'flowed lines must be 79 characters or less'
+      end
+      out = []
+      text.split(/\r\n|\n/).each do |paragraph|
+        # tab use is discouraged
+        # http://tools.ietf.org/html/rfc822#section-3.4.2
+        paragraph.gsub!(/\t/, ' '*4)
+        # trim spaces before hard break
+        # http://tools.ietf.org/html/rfc2646#section-4.1
+        paragraph.rstrip!
+        if paragraph.length <= max
+          out << paragraph
+        else # flow text
+          line = ''
+          word = ''
+          paragraph.each_char do |char|
+            if char == ' '
+              # Omit spaces after soft break to prevent stuffing on next line.
+              next if word.empty? && (line.size == 0 || line.size == max)
+              if (line.size + word.size) < max
+                line << word + char
+              else # soft break situation
+                unless line.empty?
+                  out << line.dup
+                  line.clear
+                end
+                if word.size < max
+                  line << word + char
+                else
+                  word.scan(/.{1,#{MAX_SMTP_LINE}}/) {|s| out << s }
+                end
+              end
+              word.clear
+            else  # accumulate non-space characters in buffer
+              word += char
+            end
+          end
+          # flush buffers in an orderly fashion
+          if ! word.empty?
+            if (line.size + word.size) <= max
+              out << line + word
+            else
+              out << line unless line.empty?
+              word.scan(/.{1,#{MAX_SMTP_LINE}}/) {|s| out << s }
+            end
+          elsif ! line.empty?
+            out << line
+          end
+        end
+      end
+      out.join("\r\n")
+    end
+    #
+    # Decode flowed plain +text+.
+    #
+    def self.decode(text)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/mime/content_types.rb CHANGED Viewed

@@ -86,11 +86,12 @@ module MIME
     #
     def file_type file
       filename = file.respond_to?(:path) ? file.path : file
-      extension = File.extname(filename)[1..-1] # array index removes period
-      typ_exts = CONTENT_TYPES.find {|type, extentions| extentions.include? extension}
-      typ_exts ? typ_exts.first : typ_exts      # returns +type+ from above or nil
+      extension = File.extname(filename)[1..-1] # remove leading period
+      type, _ = CONTENT_TYPES.find do |content_type, extentions|
+        extentions.include? extension
+      end
+      type
     end
   end
 end

data/lib/mime/discrete_media_factory.rb CHANGED Viewed

@@ -1,9 +1,9 @@
 module MIME
   #
-  # Class object used only for initializing derived DiscreteMediaType objects.
+  # Module used only for initializing derived DiscreteMediaType objects.
   #
-  class DiscreteMediaFactory
+  module DiscreteMediaFactory
     class << self
@@ -42,13 +42,18 @@ module MIME
           fname = file
         end
+        type, subtype = ctype.to_s.split('/')
+        if type.to_s.empty? || subtype.to_s.empty?
+          raise UnknownContentError, "invalid content type: #{ctype}"
+        end
         media_obj =
-          case ctype.to_s[/^(\w+)\//, 1]
-          when 'application'; ApplicationMedia.new(cntnt, ctype)
-          when 'audio'      ; AudioMedia.new(cntnt, ctype)
-          when 'image'      ; ImageMedia.new(cntnt, ctype)
-          when 'text'       ; TextMedia.new(cntnt, ctype)
-          when 'video'      ; VideoMedia.new(cntnt, ctype)
+          case type
+          when 'application'; ApplicationMedia.new(cntnt, subtype)
+          when 'audio'      ; AudioMedia.new(cntnt, subtype)
+          when 'image'      ; ImageMedia.new(cntnt, subtype)
+          when 'text'       ; TextMedia.new(cntnt, subtype)
+          when 'video'      ; VideoMedia.new(cntnt, subtype)
           else raise UnknownContentError, "invalid content type: #{ctype}"
           end
@@ -56,13 +61,6 @@ module MIME
         media_obj.path = fname
         media_obj
       end
     end
-    def initialize
-      AbstractClassError.no_instantiation self, DiscreteMediaFactory
-    end
   end
 end

data/lib/mime/discrete_media_type.rb CHANGED Viewed

@@ -8,12 +8,10 @@ module MIME
   # This class is abstract.
   #
   class DiscreteMediaType < MediaType
-    def initialize body, content_type = 'application/octet-stream'
+    def initialize(body, media_subtype, content_params)
       AbstractClassError.no_instantiation(self, DiscreteMediaType)
-      super
+      super(body, "#{@media_type}/#{media_subtype}", content_params)
     end
   end
   #
@@ -24,56 +22,57 @@ module MIME
   # ApplicationMedia is the catch all class. If your content cannot be
   # identified as another DiscreteMediaType, then it is application media.
   #
-  # See DiscreteMediaType.new for initialization parameters.
-  #
   class ApplicationMedia < DiscreteMediaType
+    def initialize(body, subtype = 'octet-stream', params = {})
+      @media_type = 'application'
+      super
+    end
   end
   #
-  # AudioMedia is intended for discrete audio content. The content subtype
-  # indicates the specific audio format.
-  #
-  # See DiscreteMediaType.new for initialization parameters.
+  # AudioMedia is intended for discrete audio content. The +subtype+ indicates
+  # the specific audio format, such as *mpeg* or *midi*.
   #
   class AudioMedia < DiscreteMediaType
+    def initialize(body, subtype = 'basic', params = {})
+      @media_type = 'audio'
+      super
+    end
   end
   #
-  # ImageMedia is intented for discrete image content. The content subtype
-  # indicates the specific image format.
-  #
-  # See DiscreteMediaType.new for initialization parameters.
+  # ImageMedia is intented for discrete image content. The +subtype+ indicates
+  # the specific image format, such as *jpeg* or *gif*.
   #
   class ImageMedia < DiscreteMediaType
+    def initialize(body, subtype = 'jpeg', params = {})
+      @media_type = 'image'
+      super
+    end
   end
   #
-  # TextMedia is intended for content which is principally textual in form.
+  # TextMedia is intended for content which is principally textual in form. The
+  # +subtype+ indicates the specific text type, such as *plain* or *html*.
   #
   class TextMedia < DiscreteMediaType
-    #
-    # Return a new TextMedia object containing +body+ with the content type of
-    # +content_type+.
-    #
-    # To specify the character set of +body+, a _charset_ parameter may be
-    # appended to +content_type+ using a semi-colon delimiter.
-    #
-    def initialize body, content_type = 'text/plain; charset=us-ascii'
+    def initialize(body, subtype = 'plain', params = {})
+      @media_type = 'text'
       super
     end
   end
   #
-  # VideoMedia is intended for discrete video content. The content subtype
+  # VideoMedia is intended for discrete video content. The content +subtype+
   # indicates the specific video format. The RFC describes video media as
   # content that contains a time-varying-picture image, possibly with color and
   # coordinated sound.
   #
-  # See DiscreteMediaType.new for initialization parameters.
-  #
   class VideoMedia < DiscreteMediaType
+    def initialize(body, subtype = 'mpeg', params = {})
+      @media_type = 'video'
+      super
+    end
   end
 end

data/lib/mime/header_container.rb CHANGED Viewed

@@ -17,9 +17,7 @@ module MIME
     # RFC 2822 CRLF line separator.
     #
     def to_s
-      @headers.collect do |name, value|
-        "#{name}: #{value}"
-      end.join("\r\n")
+      @headers.to_a.map {|kv| kv.join(": ")}.join("\r\n")
     end
     #

data/lib/mime/headers/mime.rb CHANGED Viewed

@@ -59,6 +59,16 @@ module MIME
         headers.add('Content-Transfer-Encoding', encoding)
       end
+      #
+      # Currently only version 1.0 exists.
+      #
+      def mime_version= version
+        @mime_version = version
+        headers.add('MIME-Version', version)
+      end
+      protected
       #
       # Specifies the media type and subtype of the content. +type+ will have
       # the form <em>media-type/subtype</em>.
@@ -75,16 +85,6 @@ module MIME
         headers.add('Content-Type', type)
       end
-      #
-      # Currently only version 1.0 exists.
-      #
-      def mime_version= version
-        @mime_version = version
-        headers.add('MIME-Version', version)
-      end
-      protected
       #
       # +type+ is the disposition type of either "inline" or "attachment".
       # +params+ is a Hash with zero or more of the following keys:

data/lib/mime/media_type.rb CHANGED Viewed

@@ -15,13 +15,19 @@ module MIME
     attr_accessor :body
     protected :body, :body=
-    def initialize body, content_type
+    def initialize body, content_type, content_params = {}
       AbstractClassError.no_instantiation(self, MediaType)
       @headers = HeaderContainer.new
       @body = body
       self.content_id = unique_id
-      self.content_type = content_type
+      self.content_type =
+        if content_params.empty?
+          content_type
+        else
+          params = content_params.to_a.map {|kv| kv.join('=')}.join('; ')
+          "#{content_type}; #{params}"
+        end
     end
     #

data/test/scaffold/multipart_form_data_mixed.msg CHANGED Viewed

Binary file

data/test/scaffold/multipart_form_data_text.msg CHANGED Viewed

@@ -38,7 +38,7 @@ Content-Disposition: form-data; name="htm"
 --Boundary_88135231713600.3996846921776409
 Content-ID: <88135231725400.11623307734175536>
-Content-Type: text/plain; charset=us-ascii
+Content-Type: text/plain
 Content-Disposition: form-data; name="txt"
 text body

data/test/scaffold/multipart_mixed_inline_and_attachment.msg CHANGED Viewed

Binary file

data/test/scaffold/plain_text_email.msg CHANGED Viewed

@@ -6,6 +6,6 @@ Cc: boss@example.com <Head Honcho>
 From: jane@example.com
 Subject: This is an important email
 Content-ID: <102975158103800.7998663631497803>
-Content-Type: text/plain; charset=us-ascii
+Content-Type: text/plain
 Hello, world!

data/test/scaffold/text.msg CHANGED Viewed

@@ -2,6 +2,6 @@ Date: Wed, 29 Oct 2008 14:55:34 -0700
 Message-ID: <357114433@1021851988>
 MIME-Version: 1.0 (Ruby MIME v0.1.0)
 Content-ID: <10218519780.0838656876757202>
-Content-Type: text/plain; charset=us-ascii
+Content-Type: text/plain
 a plain text message

data/test/test_mime.rb CHANGED Viewed

@@ -26,7 +26,7 @@ class MIMETest < Minitest::Test
   end
   def test_make_audio_message
-    audio_media = MIME::AudioMedia.new(BINARY_DATA, 'audio/midi')
+    audio_media = MIME::AudioMedia.new(BINARY_DATA, 'midi')
     audio_media.content_transfer_encoding = 'binary'
     assert_equal_mime_msg 'audio.msg', MIME::Message.new(audio_media)
   end
@@ -40,7 +40,6 @@ class MIMETest < Minitest::Test
   def test_make_image_message
     image = IO.read(sd('image.jpg'))
     image_media = MIME::ImageMedia.new(image)
-    image_media.content_type = 'image/jpeg'
     image_media.content_transfer_encoding = 'binary'
     assert_equal_mime_msg 'image.msg', MIME::Message.new(image_media)
   end
@@ -52,7 +51,6 @@ class MIMETest < Minitest::Test
   def test_make_video_message
     video_media = MIME::VideoMedia.new(BINARY_DATA)
-    video_media.content_type = 'video/mpeg'
     video_media.content_transfer_encoding = 'binary'
     assert_equal_mime_msg 'video.msg', MIME::Message.new(video_media)
   end
@@ -80,8 +78,8 @@ class MIMETest < Minitest::Test
     xml_data = IO.read(sd('data.xml'))
     txt = MIME::TextMedia.new(txt_data)
-    htm = MIME::TextMedia.new(htm_data, 'text/html')
-    xml = MIME::TextMedia.new(xml_data, 'text/xml')
+    htm = MIME::TextMedia.new(htm_data, 'html')
+    xml = MIME::TextMedia.new(xml_data, 'xml')
     form = MIME::MultipartMedia::FormData.new
     form.add_entity txt, 'txt'
@@ -95,13 +93,13 @@ class MIMETest < Minitest::Test
     img2_filename = 'ruby.png'
     img1_data = IO.read(sd(img1_filename))
     img2_data = IO.read(sd(img2_filename))
-    img1 = MIME::ImageMedia.new(img1_data, 'image/jpeg')
-    img2 = MIME::ImageMedia.new(img2_data, 'image/png')
+    img1 = MIME::ImageMedia.new(img1_data, 'jpeg')
+    img2 = MIME::ImageMedia.new(img2_data, 'png')
     img1.content_transfer_encoding = '8bit'
     img2.content_transfer_encoding = '8bit'
     desc_data = 'This is plain text description of images.'
-    desc = MIME::TextMedia.new(desc_data)
+    desc = MIME::TextMedia.new(desc_data, 'plain', 'charset' => 'us-ascii')
     form = MIME::MultipartMedia::FormData.new
     form.add_entity desc, 'description'
@@ -130,11 +128,8 @@ class MIMETest < Minitest::Test
   def test_multipart_alternative_message
     txt_data = "*Header*\nmessage"
     htm_data = "<html><body><h1>Header</h1><p>message</p></body></html>"
-    txt_msg = MIME::TextMedia.new(txt_data)
-    htm_msg = MIME::TextMedia.new(htm_data)
-    txt_msg.content_type = ('text/enhanced; charset=us-ascii')
-    htm_msg.content_type = ('text/html; charset=iso-8859-1')
+    txt_msg = MIME::TextMedia.new(txt_data, 'enhanced', 'charset' => 'us-ascii')
+    htm_msg = MIME::TextMedia.new(htm_data, 'html', 'charset' => 'iso-8859-1')
     msg = MIME::MultipartMedia::Alternative.new
     msg.add_entity htm_msg
@@ -146,7 +141,7 @@ class MIMETest < Minitest::Test
     img = MIME::DiscreteMediaFactory.create(sd('ruby.png'))
     img.content_transfer_encoding = 'binary'
-    html_msg = MIME::TextMedia.new(<<EOF, 'text/html; charset=iso-8859-1')
+    html_msg = MIME::TextMedia.new(<<EOF, 'html', 'charset' => 'iso-8859-1')
 <html>
 <body>
   <h1>HTML multipart/alternative message</h1>
@@ -158,7 +153,7 @@ class MIMETest < Minitest::Test
 EOF
     html_msg.content_transfer_encoding = '7bit'
-    text_msg = MIME::TextMedia.new(<<EOF)
+    text_msg = MIME::TextMedia.new(<<EOF, 'plain', 'charset' => 'us-ascii')
 *HTML multipart/alternative message*
 txt before pix
 <cool ruby image>
@@ -181,7 +176,7 @@ EOF
     open(sd('image.jpg')) do |img_file|
       img_data = img_file.read
-      img_msg = MIME::ImageMedia.new(img_data, 'image/jpeg')
+      img_msg = MIME::ImageMedia.new(img_data, 'jpeg')
       msg.attach_entity(img_msg, 'filename' => img_file.path)
     end
@@ -205,7 +200,7 @@ EOF
     img = MIME::DiscreteMediaFactory.create(sd('/ruby.png'))
     img.content_transfer_encoding = 'binary'
-    html_msg = MIME::TextMedia.new(<<EOF, 'text/html; charset=iso-8859-1')
+    html_msg = MIME::TextMedia.new(<<EOF, 'html; charset=iso-8859-1')
 <html>
 <body>
   <h1>HTML multipart/related message</h1>
@@ -294,8 +289,8 @@ EOF
   def test_no_instantiation_of_abstract_classes
     e = MIME::AbstractClassError
-    assert_raises(e) {MIME::MediaType.new(nil, nil)}
-    assert_raises(e) {MIME::DiscreteMediaType.new(nil)}
+    assert_raises(e) {MIME::MediaType.new(nil, nil, nil)}
+    assert_raises(e) {MIME::DiscreteMediaType.new(nil, nil, nil)}
     assert_raises(e) {MIME::CompositeMediaType.new(nil)}
     assert_raises(e) {MIME::MultipartMedia.new(nil)}
   end
@@ -352,6 +347,7 @@ EOF
   def test_discrete_media_factory_with_specified_invalid_conent_type
     invalid_ctype1 = 'application-x/pdf'
     invalid_ctype2 = 'application'
+    invalid_ctype3 = ''
     valid_ctype    = 'application/pdf'
     pdf = sd('book.pdf')
@@ -361,6 +357,9 @@ EOF
     assert_raises(MIME::UnknownContentError) {
       MIME::DiscreteMediaFactory.create(pdf, invalid_ctype2)
     }
+    assert_raises(MIME::UnknownContentError) {
+      MIME::DiscreteMediaFactory.create(pdf, invalid_ctype3)
+    }
     assert MIME::DiscreteMediaFactory.create(pdf, valid_ctype)
   end

data/test/test_text_flowed.rb ADDED Viewed

@@ -0,0 +1,130 @@
+gem 'minitest'  # minitest in 1.9 stdlib is crufty
+require 'minitest/autorun'
+require 'mime'
+class TextFlowedTest < Minitest::Test
+  include MIME::ContentFormats
+  def test_single_word_will_not_break_regardless_of_line_length
+    txt = "1234567890"
+    assert_equal txt, TextFlowed.encode(txt, 9)   # <
+    assert_equal txt, TextFlowed.encode(txt, 10)  # =
+    assert_equal txt, TextFlowed.encode(txt, 11)  # >
+  end
+  def test_max_line_length_around_first_word
+    txt       = "1234567890 A"
+    expected1 = "1234567890\r\nA"
+    expected2 = "1234567890 \r\nA"
+    assert_equal expected1, TextFlowed.encode(txt, 9)   # <
+    assert_equal expected1, TextFlowed.encode(txt, 10)  # =
+    assert_equal expected2, TextFlowed.encode(txt, 11)  # >
+  end
+  def test_words_with_variable_spacing
+    txt       = "123  456   789"
+    expected1 = "123  \r\n456   \r\n789"
+    expected2 = "123  456 \r\n789"
+    expected3 = "123  456  \r\n789"
+    expected4 = "123  456   \r\n789"
+    expected5 = txt
+    assert_equal expected1, TextFlowed.encode(txt, 8)
+    assert_equal expected2, TextFlowed.encode(txt, 9)
+    assert_equal expected3, TextFlowed.encode(txt, 10)
+    assert_equal expected4, TextFlowed.encode(txt, 11)
+    assert_equal expected4, TextFlowed.encode(txt, 12)
+    assert_equal expected4, TextFlowed.encode(txt, 13)
+    assert_equal expected5, TextFlowed.encode(txt, 14)
+    assert_equal expected5, TextFlowed.encode(txt, 15)
+  end
+  def test_paragraphs_with_variable_lengths
+    txt       = "123 456 789\n\none two three\n\nEND"
+    expected1 = "123 \r\n456 \r\n789\r\n\r\none \r\ntwo \r\nthree\r\n\r\nEND"
+    expected2 = "123 456 \r\n789\r\n\r\none two \r\nthree\r\n\r\nEND"
+    expected3 = "123 456 789\r\n\r\none two \r\nthree\r\n\r\nEND"
+    expected4 = "123 456 789\r\n\r\none two three\r\n\r\nEND"
+    assert_equal expected1, TextFlowed.encode(txt, 4)
+    assert_equal expected2, TextFlowed.encode(txt, 10)
+    assert_equal expected3, TextFlowed.encode(txt, 11)
+    assert_equal expected3, TextFlowed.encode(txt, 12)
+    assert_equal expected4, TextFlowed.encode(txt, 13)
+    assert_equal expected4, TextFlowed.encode(txt, 14)
+    assert_equal expected4, TextFlowed.encode(txt, txt.length)
+    assert_equal expected4, TextFlowed.encode(txt, txt.length+1)
+  end
+  def test_trailing_newlines_removed
+    txt = "123 456 789\r\nabc def ghi"
+    assert_equal txt, TextFlowed.encode(txt+"\n", 11)
+    assert_equal txt, TextFlowed.encode(txt+"\r\n", 11)
+  end
+  def test_tab_expansion
+    txt      = "123\t456"
+    expected1 = "123\r\n456"
+    expected2 = "123 \r\n456"
+    expected3 = "123  \r\n456"
+    expected4 = "123   \r\n456"
+    expected5 = "123    \r\n456"
+    expected6 = "123    456"
+    assert_equal expected1, TextFlowed.encode(txt, 2)
+    assert_equal expected1, TextFlowed.encode(txt, 3)
+    assert_equal expected2, TextFlowed.encode(txt, 4)
+    assert_equal expected3, TextFlowed.encode(txt, 5)
+    assert_equal expected4, TextFlowed.encode(txt, 6)
+    assert_equal expected5, TextFlowed.encode(txt, 7)
+    assert_equal expected5, TextFlowed.encode(txt, 8)
+    assert_equal expected5, TextFlowed.encode(txt, 9)
+    assert_equal expected6, TextFlowed.encode(txt, 10)
+  end
+  def test_spacing_after_hard_line_break
+    txt = "123\r\n\r\n  abc"
+    exp = "123\r\n\r\nabc"
+    assert_equal exp, TextFlowed.encode(txt, 4) # remove SP if line > max
+    assert_equal txt, TextFlowed.encode(txt, 5) # preserve SP if line == max
+    assert_equal txt, TextFlowed.encode(txt, 6) # preserve SP if line < max
+  end
+  def test_trim_spaces_before_hard_line_breaks
+    txt1     = "123 \r\n\r\n456"
+    txt2     = "123 \r\n\r\n456 "
+    expected = "123\r\n\r\n456"
+    assert_equal expected, TextFlowed.encode(txt1, 3)
+    assert_equal expected, TextFlowed.encode(txt1, 4)
+    assert_equal expected, TextFlowed.encode(txt1, 5)
+    assert_equal expected, TextFlowed.encode(txt2, 3)
+    assert_equal expected, TextFlowed.encode(txt2, 4)
+    assert_equal expected, TextFlowed.encode(txt2, 5)
+  end
+  def test_trim_trailing_spaces
+    txt      = "123 456 "
+    expected = "123 \r\n456"
+    assert_equal expected, TextFlowed.encode(txt, 4)
+  end
+  def test_rfc_79_character_max_flowed_line_length
+    TextFlowed.encode('123', 79) # no error
+    assert_raises(ArgumentError) { TextFlowed.encode('123', 80) }
+  end
+  def test_rfc_max_smtp_line_length_boundary
+    long_word = 'x' * MIME::ContentFormats::MAX_SMTP_LINE
+    txt1      = long_word
+    txt2      = 'x'  + long_word
+    txt3      = 'x ' + long_word
+    txt4      = 'x ' + long_word + ' x'
+    expected1 = long_word
+    expected2 = long_word + "\r\nx"
+    expected3 = "x \r\n" + long_word
+    expected4 = "x \r\n" + long_word + "\r\nx"
+    assert_equal expected1, TextFlowed.encode(txt1)
+    assert_equal expected2, TextFlowed.encode(txt2)
+    assert_equal expected3, TextFlowed.encode(txt3)
+    assert_equal expected4, TextFlowed.encode(txt4)
+  end
+end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mime
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-12-18 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies: []
 description: ! 'A library for building RFC compliant Multipurpose Internet Mail Extensions
@@ -39,6 +39,7 @@ files:
 - lib/mime/composite_media_type.rb
 - lib/mime/discrete_media_type.rb
 - lib/mime/message.rb
+- lib/mime/content_formats/text_flowed.rb
 - lib/mime.rb
 - test/scaffold/application.msg
 - test/scaffold/unknown.yyy
@@ -65,6 +66,7 @@ files:
 - test/scaffold/data.htm
 - test/test_mime.rb-try
 - test/test_mime.rb
+- test/test_text_flowed.rb
 homepage: http://ecentryx.com/gems/mime
 licenses:
 - ISC
@@ -92,3 +94,4 @@ specification_version: 3
 summary: Multipurpose Internet Mail Extensions (MIME) Library
 test_files:
 - test/test_mime.rb
+- test/test_text_flowed.rb