pidgin2adium 3.3.0 → 4.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a19269fc564ee7b96212824080a049dcc6fe3b8
+  data.tar.gz: 5314c9de5efe136193a156a71cd09ce65cccd72b
+SHA512:
+  metadata.gz: 60269903641f9776950be83fa2fa99a0cf72c09d5826f30eaf0bc5c94e79678d5e8485d1a1bb450b53e93a1c18d8ff014be0e2863c164b2183f1a96e0f5d6cdd
+  data.tar.gz: 3c52742c8416ca06cc4d2695c0e78b3c648e0bc43441bebe82b072e91dfb304e7c520d5fe5cce37c2821ba5bbc99da1300c83c4a4636810a18bc9da6b55437dd

data/.gitignore

@@ -17,13 +17,12 @@ tmtags
 coverage
 rdoc
 pkg
+tags
 
 ## PROJECT::SPECIFIC
 .bundle
-ext/balance_tags_c/Makefile
-ext/balance_tags_c/balance_tags_c.bundle
-ext/balance_tags_c/balance_tags_c.o
 .rvmrc
 spec/output-dir
 spec/nonexistent_output_dir
 Gemfile.lock
+tmp

data/.rspec

@@ -1 +1,2 @@
 --color
+-r spec_helper

data/.simplecov

@@ -0,0 +1,5 @@
+if ENV["COVERAGE"]
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end

data/.travis.yml

@@ -0,0 +1,12 @@
+rvm:
+  - 2.1.2
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+branches:
+  only:
+    - master
+notifications:
+  email:
+    - false

data/Gemfile

@@ -1,3 +1,8 @@
-source :rubygems
+source "https://rubygems.org"
 
 gemspec
+
+gem "pipio", github: "gabebw/pipio"
+# Use FakeFS from GitHub so that this commit is available:
+# https://github.com/defunkt/fakefs/commit/41e2e46446dfacb07135a82e24858b5e06220ec9
+gem "fakefs", github: "defunkt/fakefs", require: false

data/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2009 Gabe Berke-Williams
+The MIT License (MIT)
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Copyright (c) 2013 Gabriel Berke-Williams
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/NEWS.md

@@ -0,0 +1,89 @@
+### HEAD (unreleased)
+
+* Massive refactoring
+* Chat times respect time zones instead of assuming inputs are UTC
+* Remove C extension
+* Test against Travis
+
+### 3.3.0 / 2011-10-16
+* Pidgin2Adium depended on itself for some reason. Now it doesn't.
+
+### 3.2.3 / 2010-11-08
+* Be more liberal in what Pidgin2Adium accepts when parsing the date and
+  getting basic time info for the first line. Thanks to Matthew Jakubowski for
+  helping me fix this bug.
+
+### 3.2.2 / 2010-11-08
+* Use DateTime#strftime to get dates in xmlschema format. DateTime#xmlschema
+  doesn't exist in Ruby 1.8, and Ruby 1.9 has DateTime#iso8601, not
+  DateTime#xmlschema. Just use strftime. Thanks to Matthew Jakubowski for
+  pointing this bug out.
+
+### 3.2.1 / 2010-11-08
+* Use straight `DateTime.parse` when possible, and only fall back on hacky
+  `Date._strptime` when we have to.
+
+### 3.2.0 / 2010-10-12
+* Last release broke 1.8 compatibility due to use of strptime. 1.8 and 1.9
+  both work in 3.2.0.
+* Moved Pidgin2Adium::VERSION to its own file
+
+### 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
+* `log_parser.rb` has been split into separate files (1 per class, more or less)
+  - `require pidgin2adium/log_parser` will still pull in all of the split-up
+    classes
+* `balance_tags_c` extension really does work now
+* Cleans up more junk from Pidgin logfiles when parsing
+* Bugfixes and more graceful handling of error states
+* Fully tested (except bin/pidgin2adium, which remains tricky)
+
+### 3.0.1 / 2010-08-07
+Bugfix release.
+
+* `balance_tags_c.c`: Use `rb_eval_string` instead of `rb_reg_regcomp` to avoid
+  segfaults (commit #733ce88b0836256e14f0, fixes #27811)
+
+Non-user-facing stuff:
+
+* Switched to Jeweler, RSpec, and Bundler
+* Rakefile now doesn't choke if Hanna gem isn't installed
+
+### 3.0.0 / 2010-01-31
+* `lbalance_tags.rb` is now a C extension (`Pidgin2Adium.balance_tags_c`)
+  - the pure-ruby mixin `balance_tags` (without the trailing `_c`) is gone
+* Better handling of command-line arguments
+* Format time zones offsets correctly (e.g. "+0500", not "+-0500")
+* Write Yahoo! and Jabber logs to correct directories (#27710)
+* Better matching of regexes against time strings
+* Better documentation
+
+### 2.0.2 / 2009-12-18
+* Much better documentation (more of it, and higher quality too!)
+* Allow user-provided output dir at commandline
+* Cleaner error messages
+* require 'time' for `Time.zone_offset` (fixes bug)
+* Gracefully handle lack of timezone info
+* Gracefully handle nonexistent output dir
+* Gracefully handle parsing errors
+* Print error messages during *and* after batch converting so they're actually seen
+
+### 2.0.1 / 2009-12-06
+* Fix timestamps so they show up in Adium chat log viewer
+
+### 2.0.0 / 2009-11-24
+* Added documentation, available at http://pidgin2adium.rubyforge.org/rdoc/
+* Added public interface for scripting purposes
+* Removed -o and -l options. Now gem automatically outputs to Adium log dir with no intermediate folder.
+
+### 1.0.0 / 2009-09-27
+* Birthday!

data/README.md

@@ -0,0 +1,60 @@
+# pidgin2adium [![Build Status](https://secure.travis-ci.org/gabebw/pidgin2adium.png)](http://travis-ci.org/gabebw/pidgin2adium) [![Code Climate](https://codeclimate.com/github/gabebw/pidgin2adium.png)](https://codeclimate.com/github/gabebw/pidgin2adium)
+
+Convert [Pidgin](http://pidgin.im/) (formerly gaim) logs to the
+[Adium](http://adium.im/) format. This is a command-line wrapper around the
+[Pipio] log-parsing library.
+
+[Pipio]: https://github.com/gabebw/pipio
+
+## Install
+
+    gem install pidgin2adium
+
+## Quick Start
+
+Let's say you have some logs in `~/pidgin-logs`, and your aliases are "Gabe
+B-W", "Gabe", and "Gabe Berke-Williams". Then you should run this:
+
+    pidgin2adium --in ~/pidgin-logs --aliases "Gabe B-W,Gabe,Gabe Berke-Williams"
+
+## OK, what's with the aliases?
+
+Pidgin2adium needs a comma-separated list of your aliases to work. Aliases make
+it so that you show up in chats as (for example) `Me` instead of as
+`best_screen_name_ever_018845`.
+
+Pidgin then uses aliases in the log file instead of the actual screen name,
+which makes it impossible to match "Me" to your actual screen name.  Therefore
+Pidgin2adium needs to know which aliases belong to you so it can map them to the
+correct screen name.
+
+If Pidgin2adium encounters an alias that you did not list, it assumes that it
+belongs to the person to whom you are chatting.
+
+You do not need to provide your screenname in the alias list.
+
+## Testing
+
+To get a coverage report, run `rake` with the `COVERAGE` environment variable
+set:
+
+    COVERAGE=1 rake
+
+## THANKS
+
+With thanks to Li Ma, whose [blog post](http://li-ma.blogspot.com/2008/10/pidgin-log-file-to-adium-log-converter.html)
+helped tremendously.
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2009-2014 Gabe Berke-Williams. See LICENSE for details.

data/Rakefile

@@ -1,31 +1,13 @@
 require 'bundler'
+require 'bundler/setup'
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.rspec_opts = %w{-Ilib -Ispec}
-  spec.pattern = 'spec/**/*_spec.rb'
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.rspec_opts = %w{-Ilib -Ispec}
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => "extconf:compile"
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = Pidgin2Adium::VERSION
+RSpec::Core::RakeTask.new(:spec)
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "pidgin2adium #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+task :coverage do
+  system "COVERAGE=1 rake ; open coverage/index.html"
 end
 
-Dir['tasks/**/*.rake'].each { |t| load t }
+task default: :spec

data/bin/pidgin2adium

@@ -1,109 +1,38 @@
-#!/usr/bin/ruby -w
+#!/usr/bin/env ruby
 
-=begin
-Author: Gabe Berke-Williams, 2008
-Usage:
-This is the shell script, which is a wrapper around Pidgin2Adium::LogConverter.
-Call it like so:
-<tt>pidgin2adium -i ~/in_logs/ -a "me,my_pidgin_alias,other_pidgin_alias"</tt>
-For <tt>-a/--aliases</tt>, there is no need to use spaces or capitalization,
-since spaces will be stripped out and the aliases will be lowercased anyway.
-Aliases doesn't have to include screennames, either, since these are
-automatically recognized.
-=end
-
-require 'pidgin2adium/log_converter'
-require 'optparse'
-
-version = <<EOL
-Pidgin2Adium, version #{Pidgin2Adium::VERSION}
-Written by Gabe Berke-Williams (gbw@rubyforge.org)
-EOL
+require "pidgin2adium"
+require "optparse"
 
 options = {}
 
-oparser = OptionParser.new do |opts|
-  opts.banner = "Usage: #{File.basename($0)} [options]"
-  opts.on('-i', '--in=IN_DIR', String, 'Directory where pidgin logs are stored') do |i|
-    options[:in] = i
-  end
-
-  opts.on('-a alias1,alias2', "--aliases alias1,alias2",
-          "A comma-separated list of your alias(es)",
-          "so this script knows which person in a chat",
-          "is you. Whitespace and case do not matter.") do |aliases|
-    options[:aliases] = aliases
-  end
-
-  opts.on('-o', '--out OUT_DIR',
-          'The top-level directory under which to',
-          'store the logs (each in its own folder',
-          'by screen name).',
-          "Defaults  to: #{Pidgin2Adium::ADIUM_LOG_DIR}") do |out|
-    options[:output_dir] = out
-  end
+parser = OptionParser.new do |parser|
+  parser.banner = "Usage: #{File.basename($0)} -i PIDGIN_LOG_DIR"
 
-  opts.on('-f', '--force', 'If this is set, then logs in the Adium log',
-          'folder that have the same name as converted',
-          'logs will be overwritten.') do |f|
-    options[:force] = f
+  parser.on('-i', '--in IN_DIR', 'Directory where pidgin logs are stored') do |in_directory|
+    options[:in_directory] = in_directory
   end
 
-  opts.on('-c', '--continue', "Continue converting after hitting unparseable lines. Will print the problem lines and log at the end.") do |c|
-    options[:force_conversion] = c
+  parser.on('-a', '--aliases "gabebw,Gabe B-W"', "Your aliases from Pidgin") do |aliases|
+    options[:aliases] = aliases.split(",")
   end
 
-  opts.on("-v", "--version", "Show version information") do
-    puts version
+  parser.on("-v", "--version", "Show version information") do
+    puts "Pidgin2Adium, version #{Pidgin2Adium::VERSION}"
     exit
   end
 
-  opts.on_tail("-h", "--help", "Show this message") do
-    puts version
-    puts opts
+  parser.on_tail("-h", "--help", "Show this message") do
+    puts parser
     exit
   end
 end
 
-begin
-  oparser.parse!
-rescue => bang
-  if bang.class == OptionParser::MissingArgument
-    # No argument provided for a switch that requires an argument.
-    puts '"%s" requires an argument.' % bang.args[0]
-    exit 1
-  elsif bang.class == OptionParser::InvalidOption
-    # Provided a switch that we don't handle.
-    puts '"%s" is not a valid switch.' % bang.args[0]
-  elsif bang.class == OptionParser::NeedlessArgument
-    # Raised when argument provided for a switch that doesn't take an argument.
-    puts bang.message
-  end
-end
-
-need_opts = false
-required_opts = [[:i, :in], [:a, :aliases]]
-
-required_opts.each do |short, long|
-  if options.has_key?(long)
-    next
-  else
-    need_opts = true
-    puts "Required option -#{short}/--#{long} missing."
-  end
-end
+parser.parse!
 
-if need_opts
-  puts oparser.to_s
+if options[:in_directory] && options[:aliases]
+  runner = Pidgin2Adium::Runner.new(options[:in_directory], option[:aliases])
+  runner.run
+else
+  STDERR.puts "Please provide -i/--in argument and -a/--aliases. Run with --help for more information"
   exit 1
 end
-
-extra_opts = {:overwrite => options[:force]}
-
-extra_opts[:output_dir] = options[:output_dir]
-extra_opts[:force_conversion] = options[:force_conversion]
-
-log_converter = Pidgin2Adium::LogConverter.new(options[:in],
-                                               options[:aliases],
-                                               extra_opts)
-log_converter.start

data/lib/pidgin2adium.rb

@@ -1,137 +1,5 @@
-# Author: Gabe Berke-Williams, 2008
-#
-# A ruby program to convert Pidgin log files to Adium log files, then place
-# them in the Adium log directory.
-
-require 'fileutils'
-require 'time'
+require 'pipio'
 require 'pidgin2adium/version'
-require 'pidgin2adium/parsers/all'
-
-module Pidgin2Adium
-  # Returned by LogFile.write_out if the output logfile already exists.
-  FILE_EXISTS = 42
-  ADIUM_LOG_DIR = File.expand_path('~/Library/Application Support/Adium 2.0/Users/Default/Logs/') << '/'
-  # These files/directories show up in Dir.entries()
-  BAD_DIRS = %w{. .. .DS_Store Thumbs.db .system}
-  # For displaying after we finish converting
-  @@oops_messages = []
-  @@error_messages = []
-
-  def log_msg(str) #:nodoc:
-    puts str.to_s
-  end
-
-  def oops(str) #:nodoc:
-    @@oops_messages << str
-    warn("Oops: #{str}")
-  end
-
-  def error(str) #:nodoc:
-    @@error_messages << str
-    warn("Error: #{str}")
-  end
-
-  #######################
-  #So that we can use log_msg when calling delete_search_indexes() by itself
-  module_function :log_msg, :oops, :error
-  #######################
-
-  # Parses the provided log.
-  # Returns a LogFile instance or false if an error occurred.
-  def parse(logfile_path, my_aliases, force_conversion)
-    logfile_path = File.expand_path(logfile_path)
-    ext = File.extname(logfile_path).sub('.', '').downcase
-
-    if(ext == "html" || ext == "htm")
-      parser_class = HtmlLogParser
-    elsif(ext == "txt")
-      parser_class = TextLogParser
-    else
-      error("Doing nothing, logfile is not a text or html file. Path: #{logfile_path}.")
-      return false
-    end
-
-    parser = parser_class.new(logfile_path, my_aliases, force_conversion)
-    return parser.parse()
-  end
-
-  # Parses the provided log and writes out the log in Adium format.
-  # Returns:
-  #  * true if it successfully converted and wrote out the log,
-  #  * false if an error occurred, or
-  #  * Pidgin2Adium::FILE_EXISTS if file already exists AND
-  #    opts[:overwrite] = false.
-  #
-  # You can add options using the _opts_ hash, which can have the following
-  # keys, all of which are optional:
-  # * *overwrite*: If true, then overwrite even if log is found.
-  #	Defaults to false.
-  # * *output_dir*: The top-level dir to put the logs in.
-  #   Logs under output_dir are still each in their own folders, etc.
-  #   Defaults to Pidgin2Adium::ADIUM_LOG_DIR
-  def parse_and_generate(logfile_path, my_aliases, opts = {})
-    opts = {} unless opts.is_a?(Hash)
-    overwrite = !!opts[:overwrite]
-    force_conversion = opts[:force_conversion]
-
-    if opts.key?(:output_dir)
-      output_dir = opts[:output_dir]
-    else
-      output_dir = ADIUM_LOG_DIR
-    end
-
-    unless File.directory?(output_dir)
-      puts "Output log directory (#{output_dir}) does not exist or is not a directory."
-      begin
-        FileUtils.mkdir_p(output_dir)
-      rescue Errno::EACCES
-        puts "Permission denied, could not create output directory (#{output_dir})"
-        return false
-      end
-    end
-
-    logfile_obj = parse(logfile_path, my_aliases, force_conversion)
-    return false if logfile_obj == false
-    dest_file_path = logfile_obj.write_out(overwrite, output_dir)
-    if dest_file_path == false
-      error("Successfully parsed file, but failed to write it out. Path: #{logfile_path}.")
-      return false
-    elsif dest_file_path == FILE_EXISTS
-      log_msg("File already exists.")
-      return FILE_EXISTS
-    else
-      log_msg("Output to: #{dest_file_path}")
-      return true
-    end
-  end
-
-  # Newly-converted logs are viewable in the Adium Chat Transcript
-  # Viewer, but are not indexed, so a search of the logs doesn't give
-  # results from the converted logs. To fix this, we delete the cached log
-  # indexes, which forces Adium to re-index.
-  #
-  # Note: This function is run by LogConverter after converting all of its
-  # files.  LogFile.write_out intentionally does _not_ run it in order to
-  # allow for batch-processing of files. Thus, you will probably want to run
-  # Pidgin2Adium.delete_search_indexes after running LogFile.write_out in
-  # your own scripts.
-  def delete_search_indexes()
-    log_msg "Deleting log search indexes in order to force re-indexing of imported logs..."
-    dirty_file = File.expand_path("~/Library/Caches/Adium/Default/DirtyLogs.plist")
-    log_index_file = File.expand_path("~/Library/Caches/Adium/Default/Logs.index")
-    [dirty_file, log_index_file].each do |f|
-      if File.exist?(f)
-        if File.writable?(f)
-          File.delete(f)
-        else
-          error("File exists but is not writable. Please delete it yourself: #{f}")
-        end
-      end
-    end
-    log_msg "...done."
-    log_msg "When you next start the Adium Chat Transcript Viewer, it will re-index the logs, which may take a while."
-  end
-
-  module_function :parse, :parse_and_generate, :delete_search_indexes
-end
+require 'pidgin2adium/file_finder'
+require 'pidgin2adium/runner'
+require 'pidgin2adium/adium_chat_file_creator'