pidgin2adium 3.1.0 → 3.1.1

data/ChangeLog

@@ -1,3 +1,10 @@
+=== 3.1.1 / 2010-08-13
+* Moved BasicParser and its subclasses into parsers/ subdir
+  - You can now do "require 'pidgin2adium/parsers/all'",
+    though the old "require 'pidgin2adium/log_parser" will still work
+* Moved Message and its subclasses into messages/ subdir
+  - You can now do "require 'pidgin2adium/messages/all'",
+    though the old "require 'pidgin2adium/message" will still work
 === 3.1.0 / 2010-08-13
 * Compatible with Ruby 1.9!
   - removed dependency on "parsedate" library, which 1.9 doesn't have

data/VERSION

@@ -1 +1 @@
-3.1.0
+3.1.1

data/lib/pidgin2adium/log_file.rb

@@ -14,6 +14,7 @@ module Pidgin2Adium
   # StatusMessage::	 status
   class LogFile
     include Pidgin2Adium
+    include Enumerable
     def initialize(chat_lines, service, user_SN, partner_SN, adium_chat_time_start)
       @chat_lines = chat_lines
       @user_SN = user_SN

data/lib/pidgin2adium/log_parser.rb

@@ -1,3 +1,2 @@
-require 'pidgin2adium/basic_parser'
-require 'pidgin2adium/text_log_parser'
-require 'pidgin2adium/html_log_parser'
+# For backwards compatibility with Pidgin2Adium < 3.1.1
+require 'pidgin2adium/parsers/all'

data/lib/pidgin2adium/message.rb

@@ -1,97 +1,2 @@
-# The Message class and its subclasses, each used for holding one line of a
-# chat.
-
-module Pidgin2Adium
-  # A holding object for each line of the chat. It is subclassed as
-  # appropriate (eg AutoReplyMessage). Each subclass (but not Message
-  # itself) has its own to_s which prints out its information in a format
-  # appropriate for putting in an Adium log file.
-  # Subclasses: XMLMessage, AutoReplyMessage, StatusMessage, Event.
-  class Message
-    def initialize(sender, time, buddy_alias)
-      # The sender's screen name
-      @sender = sender
-      # The time the message was sent, in Adium format (e.g.
-      # "2008-10-05T22:26:20-0800")
-      @time = time
-      # The receiver's alias (NOT screen name)
-      @buddy_alias = buddy_alias
-    end
-    attr_accessor :sender, :time, :buddy_alias
-  end
-
-  # Basic message with body text (as opposed to pure status messages, which
-  # have no body).
-  class XMLMessage < Message
-    def initialize(sender, time, buddy_alias, body)
-      super(sender, time, buddy_alias)
-      @body = body
-      @styled_body = '<div><span style="font-family: Helvetica; font-size: 12pt;">%s</span></div>' % @body
-      normalize_body!()
-    end
-    attr_accessor :body
-
-    def to_s
-      return sprintf('<message sender="%s" time="%s" alias="%s">%s</message>' << "\n",
-                     @sender, @time, @buddy_alias, @styled_body)
-    end
-
-    # Balances mismatched tags, normalizes body style, and fixes actions
-    # so they are in Adium style (Pidgin uses "***Buddy waves at you", Adium uses
-    # "*Buddy waves at you*").
-    def normalize_body!
-      normalize_body_entities!()
-      # Fix mismatched tags. Yes, it's faster to do it per-message
-      # than all at once.
-      @body = Pidgin2Adium.balance_tags_c(@body)
-      if @buddy_alias[0,3] == '***'
-        # "***<alias>" is what pidgin sets as the alias for a /me action
-        @buddy_alias.slice!(0,3)
-        @body = '*' << @body << '*'
-      end
-    end
-
-    # Escapes entities.
-    def normalize_body_entities!
-      # Convert '&' to '&amp;' only if it's not followed by an entity.
-      @body.gsub!(/&(?!lt|gt|amp|quot|apos)/, '&amp;')
-    end
-  end # END XMLMessage class
-
-  # An auto reply message.
-  class AutoReplyMessage < XMLMessage
-    def to_s
-      return sprintf('<message sender="%s" time="%s" auto="true" alias="%s">%s</message>' << "\n",
-                     @sender, @time, @buddy_alias, @styled_body)
-    end
-  end # END AutoReplyMessage class
-
-  # A message saying e.g. "Blahblah has gone away."
-  class StatusMessage < Message
-    def initialize(sender, time, buddy_alias, status)
-      super(sender, time, buddy_alias)
-      @status = status
-    end
-    attr_accessor :status
-
-    def to_s
-      return sprintf('<status type="%s" sender="%s" time="%s" alias="%s"/>' << "\n", @status, @sender, @time, @buddy_alias)
-    end
-  end # END StatusMessage class
-
-  # Pidgin does not have Events, but Adium does. Pidgin mostly uses system
-  # messages to display what Adium calls events. These include sending a file,
-  # starting a Direct IM connection, or an error in chat.
-  class Event < XMLMessage
-    def initialize(sender, time, buddy_alias, body, event_type)
-      super(sender, time, buddy_alias, body)
-      @event_type = event_type
-    end
-    attr_accessor :event_type
-
-    def to_s
-      return sprintf('<event type="%s" sender="%s" time="%s" alias="%s">%s</event>',
-                     @event_type, @sender, @time, @buddy_alias, @styled_body)
-    end
-  end # END Event class
-end
+# For backwards compatibility with Pidgin2Adium < 3.1.1
+require 'pidgin2adium/message/all'

data/lib/pidgin2adium/messages/all.rb

@@ -0,0 +1,5 @@
+require 'pidgin2adium/messages/message.rb'
+require 'pidgin2adium/messages/xml_message.rb'
+require 'pidgin2adium/messages/auto_reply_message.rb'
+require 'pidgin2adium/messages/event.rb'
+require 'pidgin2adium/messages/status_message.rb'

data/lib/pidgin2adium/messages/auto_reply_message.rb

@@ -0,0 +1,11 @@
+# The Message class's subclasses, each used for holding one line of a chat.
+
+module Pidgin2Adium
+  # An auto reply message.
+  class AutoReplyMessage < XMLMessage
+    def to_s
+      return sprintf('<message sender="%s" time="%s" auto="true" alias="%s">%s</message>' << "\n",
+                     @sender, @time, @buddy_alias, @styled_body)
+    end
+  end
+end

data/lib/pidgin2adium/messages/event.rb

@@ -0,0 +1,17 @@
+module Pidgin2Adium
+  # Pidgin does not have Events, but Adium does. Pidgin mostly uses system
+  # messages to display what Adium calls events. These include sending a file,
+  # starting a Direct IM connection, or an error in chat.
+  class Event < XMLMessage
+    def initialize(sender, time, buddy_alias, body, event_type)
+      super(sender, time, buddy_alias, body)
+      @event_type = event_type
+    end
+    attr_accessor :event_type
+
+    def to_s
+      return sprintf('<event type="%s" sender="%s" time="%s" alias="%s">%s</event>',
+                     @event_type, @sender, @time, @buddy_alias, @styled_body)
+    end
+  end
+end

data/lib/pidgin2adium/messages/message.rb

@@ -0,0 +1,22 @@
+# The Message class and its subclasses, each used for holding one line of a
+# chat.
+
+module Pidgin2Adium
+  # A holding object for each line of the chat. It is subclassed as
+  # appropriate (eg AutoReplyMessage). Each subclass (but not Message
+  # itself) has its own to_s which prints out its information in a format
+  # appropriate for putting in an Adium log file.
+  # Subclasses: XMLMessage, AutoReplyMessage, StatusMessage, Event.
+  class Message
+    def initialize(sender, time, buddy_alias)
+      # The sender's screen name
+      @sender = sender
+      # The time the message was sent, in Adium format (e.g.
+      # "2008-10-05T22:26:20-0800")
+      @time = time
+      # The receiver's alias (NOT screen name)
+      @buddy_alias = buddy_alias
+    end
+    attr_accessor :sender, :time, :buddy_alias
+  end
+end

data/lib/pidgin2adium/messages/status_message.rb

@@ -0,0 +1,17 @@
+# The Message class's subclasses, each used for holding one line of a chat.
+
+module Pidgin2Adium
+  # A message saying e.g. "Blahblah has gone away."
+  class StatusMessage < Message
+    def initialize(sender, time, buddy_alias, status)
+      super(sender, time, buddy_alias)
+      @status = status
+    end
+    attr_accessor :status
+
+    def to_s
+      return sprintf('<status type="%s" sender="%s" time="%s" alias="%s"/>' << "\n",
+                     @status, @sender, @time, @buddy_alias)
+    end
+  end
+end

data/lib/pidgin2adium/messages/xml_message.rb

@@ -0,0 +1,40 @@
+module Pidgin2Adium
+  # Basic message with body text (as opposed to pure status messages, which
+  # have no body).
+  class XMLMessage < Message
+    def initialize(sender, time, buddy_alias, body)
+      super(sender, time, buddy_alias)
+      @body = body
+      @styled_body = '<div><span style="font-family: Helvetica; font-size: 12pt;">%s</span></div>' % @body
+      normalize_body!()
+    end
+    attr_accessor :body
+
+    def to_s
+      return sprintf('<message sender="%s" time="%s" alias="%s">%s</message>' << "\n",
+                     @sender, @time, @buddy_alias, @styled_body)
+    end
+
+    # Balances mismatched tags, normalizes body style, and fixes actions
+    # so they are in Adium style (Pidgin uses "***Buddy waves at you", Adium uses
+    # "*Buddy waves at you*").
+    def normalize_body!
+      normalize_body_entities!()
+      # Fix mismatched tags. Yes, it's faster to do it per-message
+      # than all at once.
+      @body = Pidgin2Adium.balance_tags_c(@body)
+      if @buddy_alias[0,3] == '***'
+        # "***<alias>" is what pidgin sets as the alias for a /me action
+        @buddy_alias.slice!(0,3)
+        @body = '*' << @body << '*'
+      end
+    end
+
+    # Escapes all entities in @body except for "&lt;", "&gt;", "&amp;", "&quot;",
+    # and "&apos;".
+    def normalize_body_entities!
+      # Convert '&' to '&amp;' only if it's not followed by an entity.
+      @body.gsub!(/&(?!lt|gt|amp|quot|apos)/, '&amp;')
+    end
+  end
+end

data/lib/pidgin2adium/parsers/all.rb

@@ -0,0 +1,3 @@
+require 'pidgin2adium/parsers/basic_parser.rb'
+require 'pidgin2adium/parsers/text_log_parser.rb'
+require 'pidgin2adium/parsers/html_log_parser.rb'

data/lib/pidgin2adium/{basic_parser.rb → parsers/basic_parser.rb}

@@ -10,7 +10,7 @@ require 'date'
 require 'time'
 
 require 'pidgin2adium/log_file'
-require 'pidgin2adium/message'
+require 'pidgin2adium/messages/all'
 
 module Pidgin2Adium
   # Empty class. Raise'd by LogParser if the first line of a log is not
@@ -182,8 +182,7 @@ module Pidgin2Adium
       if tz_match and tz_match[1]
         tz_offset = tz_match[1]
       else
-        # "-0500" (3d rather than 2d to allow for "+")
-        tz_offset = sprintf('%+03d00', Time.zone_offset(Time.now.zone) / 3600)
+        tz_offset = Pidgin2Adium::DEFAULT_TZ_OFFSET
       end
       return tz_offset
     end

data/lib/pidgin2adium.rb

@@ -4,7 +4,8 @@
 # them in the Adium log directory.
 
 require 'fileutils'
-require 'pidgin2adium/log_parser'
+require 'time'
+require 'pidgin2adium/parsers/all'
 
 module Pidgin2Adium
   # Returned by LogFile.write_out if the output logfile already exists.
@@ -13,6 +14,8 @@ module Pidgin2Adium
   # These files/directories show up in Dir.entries()
   BAD_DIRS = %w{. .. .DS_Store Thumbs.db .system}
   VERSION = "3.1.0"
+  # "-0500" (3d rather than 2d to allow for "+")
+  DEFAULT_TZ_OFFSET = sprintf('%+03d00', Time.zone_offset(Time.now.zone) / 3600)
   # For displaying after we finish converting
   @@oops_messages = []
   @@error_messages = []

data/pidgin2adium.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pidgin2adium}
-  s.version = "3.1.0"
+  s.version = "3.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gabe Berke-Williams"]
@@ -36,14 +36,20 @@ Gem::Specification.new do |s|
      "ext/balance_tags_c/balance_tags_c.c",
      "ext/balance_tags_c/extconf.rb",
      "lib/pidgin2adium.rb",
-     "lib/pidgin2adium/balance_tags.rb",
-     "lib/pidgin2adium/basic_parser.rb",
-     "lib/pidgin2adium/html_log_parser.rb",
      "lib/pidgin2adium/log_converter.rb",
      "lib/pidgin2adium/log_file.rb",
      "lib/pidgin2adium/log_parser.rb",
      "lib/pidgin2adium/message.rb",
-     "lib/pidgin2adium/text_log_parser.rb",
+     "lib/pidgin2adium/messages/all.rb",
+     "lib/pidgin2adium/messages/auto_reply_message.rb",
+     "lib/pidgin2adium/messages/event.rb",
+     "lib/pidgin2adium/messages/message.rb",
+     "lib/pidgin2adium/messages/status_message.rb",
+     "lib/pidgin2adium/messages/xml_message.rb",
+     "lib/pidgin2adium/parsers/all.rb",
+     "lib/pidgin2adium/parsers/basic_parser.rb",
+     "lib/pidgin2adium/parsers/html_log_parser.rb",
+     "lib/pidgin2adium/parsers/text_log_parser.rb",
      "pidgin2adium.gemspec",
      "spec/balance_tags_c_extn_spec.rb",
      "spec/basic_parser_spec.rb",

data/spec/log_file_spec.rb

@@ -14,30 +14,21 @@ describe "LogFile" do
              "2010-08-10T22:55:17-0500",
              "2010-08-10T22:55:22-0500"]
 
-    @messages = [
-      Pidgin2Adium::XMLMessage.new(@user_SN,
-                                   @start_time,
-                                   @user_alias,
-                                   "Hello!"),
-      Pidgin2Adium::StatusMessage.new(@partner_SN,
-                                      times[1],
-                                      @partner_alias,
-                                      "Matz has gone away"),
-      Pidgin2Adium::Event.new(@user_SN,
-                              times[2],
-                              @user_alias,
-                              "gabebw logged in.",
-                              'online'),
-      Pidgin2Adium::AutoReplyMessage.new(@partner_SN,
-                                         times[3],
-                                         @partner_alias,
-                                         "This is an away message")
-    ]
-    @logfile = Pidgin2Adium::LogFile.new(@messages,
-                                         'aim',
-                                         @user_SN,
-                                         @partner_SN,
-                                         @start_time)
+    message_1 = Pidgin2Adium::XMLMessage.new(@user_SN, @start_time,
+                                             @user_alias, "Hello!")
+    message_2 = Pidgin2Adium::StatusMessage.new(@partner_SN, times[1],
+                                                @partner_alias, "Matz has gone away")
+
+    message_3 = Pidgin2Adium::Event.new(@user_SN, times[2], @user_alias,
+                                        "gabebw logged in.", 'online')
+
+    message_4 = Pidgin2Adium::AutoReplyMessage.new(@partner_SN, times[3],
+                                                   @partner_alias,
+                                                   "This is an away message")
+
+    @messages = [message_1, message_2, message_3, message_4]
+    @logfile = Pidgin2Adium::LogFile.new(@messages, 'aim', @user_SN,
+                                         @partner_SN, @start_time)
   end
 
   describe "attributes" do
@@ -69,12 +60,17 @@ describe "LogFile" do
     end
   end
 
-  describe "#each" do
-    it "should yield the messages" do
-      n = 0
-      @logfile.each do |x|
-        x.should == @messages[n]
-        n += 1
+
+  describe "enumerable methods" do
+    it "should include Enumerable" do
+      Pidgin2Adium::LogFile.included_modules.include?(Enumerable).should be_true
+    end
+
+    describe "#each_with_index" do
+      it "should yield the correct messages" do
+        @logfile.each_with_index do |msg, n|
+          msg.should == @messages[n]
+        end
       end
     end
   end

data/spec/spec_helper.rb

@@ -16,7 +16,6 @@ prefork_block = lambda do
   $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'ext', 'balance_tags_c'))
 
   require 'pidgin2adium'
-  require 'faker'
   require 'time' # for Time.zone_offset
 
   rspec_configure_block = lambda do |config|

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 3
   - 1
-  - 0
-  version: 3.1.0
+  - 1
+  version: 3.1.1
 platform: ruby
 authors: 
 - Gabe Berke-Williams
@@ -86,14 +86,20 @@ files:
 - ext/balance_tags_c/balance_tags_c.c
 - ext/balance_tags_c/extconf.rb
 - lib/pidgin2adium.rb
-- lib/pidgin2adium/balance_tags.rb
-- lib/pidgin2adium/basic_parser.rb
-- lib/pidgin2adium/html_log_parser.rb
 - lib/pidgin2adium/log_converter.rb
 - lib/pidgin2adium/log_file.rb
 - lib/pidgin2adium/log_parser.rb
 - lib/pidgin2adium/message.rb
-- lib/pidgin2adium/text_log_parser.rb
+- lib/pidgin2adium/messages/all.rb
+- lib/pidgin2adium/messages/auto_reply_message.rb
+- lib/pidgin2adium/messages/event.rb
+- lib/pidgin2adium/messages/message.rb
+- lib/pidgin2adium/messages/status_message.rb
+- lib/pidgin2adium/messages/xml_message.rb
+- lib/pidgin2adium/parsers/all.rb
+- lib/pidgin2adium/parsers/basic_parser.rb
+- lib/pidgin2adium/parsers/html_log_parser.rb
+- lib/pidgin2adium/parsers/text_log_parser.rb
 - pidgin2adium.gemspec
 - spec/balance_tags_c_extn_spec.rb
 - spec/basic_parser_spec.rb

data/lib/pidgin2adium/balance_tags.rb

@@ -1,118 +0,0 @@
-module Pidgin2Adium
-  # Balances tags of string using a modified stack. Returns a balanced
-  # string, but also affects the text passed into it!
-  # Use text = balance_tags(text).
-
-  # From Wordpress's formatting.php; rewritten in Ruby by Gabe
-  # Berke-Williams, 2009.
-  # Author:: Leonard Lin <leonard@acm.org>
-  # License:: GPL v2.0
-  # Copyright:: November 4, 2001
-  def Pidgin2Adium.balance_tags( text )
-    tagstack = []
-    stacksize = 0
-    tagqueue = ''
-    newtext = ''
-    single_tags = %w{br hr img input meta} # Known single-entity/self-closing tags
-    #nestable_tags = %w{blockquote div span} # Tags that can be immediately nested within themselves
-    nestable_tags = %w{blockquote div span font} # Tags that can be immediately nested within themselves
-    # 1: tagname, with possible leading "/"
-    # 2: attributes
-    tag_regex = /<(\/?\w*)\s*([^>]*)>/
-
-    # WP bug fix for comments - in case you REALLY meant to type '< !--'
-    text.gsub!('< !--', '<    !--')
-
-    # WP bug fix for LOVE <3 (and other situations with '<' before a number)
-    text.gsub!(/<([0-9]{1})/, '&lt;\1')
-
-    while ( pos = (text =~ tag_regex) )
-      newtext << tagqueue
-      tag = $1.downcase
-      attributes = $2
-      matchlen = $~[0].size
-
-      # clear the shifter
-      tagqueue = ''
-      # Pop or Push
-      if (tag[0,1] == "/") # End Tag
-        tag.slice!(0,1)
-        # if too many closing tags
-        if(stacksize <= 0)
-          tag = ''
-          #or close to be safe: tag = '/' << tag
-        elsif (tagstack[stacksize - 1] == tag) # found closing tag
-          # if stacktop value == tag close value then pop
-          tag = '</' << tag << '>' # Close Tag
-          # Pop
-          tagstack.pop
-          stacksize -= 1
-        else # closing tag not at top, search for it
-          (stacksize-1).downto(0) do |j|
-            if (tagstack[j] == tag)
-              # add tag to tagqueue
-              ss = stacksize - 1
-              ss.downto(j) do |k|
-                tagqueue << '</' << tagstack.pop << '>'
-                stacksize -= 1
-              end
-              break
-            end
-          end
-          tag = ''
-        end
-      else
-        # Begin Tag
-
-        # Tag Cleaning
-        if( (attributes[-1,1] == '/') || (tag == '') )
-          # If: self-closing or '', don't do anything.
-        elsif ( single_tags.include?(tag) )
-          # ElseIf: it's a known single-entity tag but it doesn't close itself, do so
-          attributes << '/'
-        else
-          # Push the tag onto the stack
-          # If the top of the stack is the same as the tag we want to push, close previous tag
-          if ((stacksize > 0) &&
-              ! nestable_tags.include?(tag) &&
-              (tagstack[stacksize - 1] == tag))
-            tagqueue = '</' << tagstack.pop << '>'
-            stacksize -= 1
-          end
-          tagstack.push(tag)
-          stacksize += 1
-        end
-
-        # Attributes
-        if(attributes != '')
-          attributes = ' ' << attributes
-        end
-        tag = '<' << tag << attributes << '>'
-        #If already queuing a close tag, then put this tag on, too
-        if (tagqueue)
-          tagqueue << tag
-          tag = ''
-        end
-      end
-      newtext << text[0,pos] << tag
-      text = text[pos+matchlen, text.length - (pos+matchlen)]
-    end
-
-    # Clear Tag Queue
-    newtext << tagqueue
-
-    # Add Remaining text
-    newtext << text
-
-    # Empty Stack
-    tagstack.reverse_each do |t|
-      newtext << '</' << t << '>' # Add remaining tags to close
-    end
-
-    # WP fix for the bug with HTML comments
-    newtext.gsub!("< !--", "<!--")
-    newtext.gsub!("<    !--", "< !--")
-
-    return newtext
-  end
-end