runoff 0.2.0 → 0.3.0

data/lib/runoff/file_writer.rb

@@ -1,132 +1,53 @@
-require 'zip/zip'
-
-module Runoff
-  # Public: Methods used for writing to files.
-  module FileWriter
-    # Public: Saves a single chat message to a file.
-    #
-    # chat_record - a Hash containing data about a single chat message.
-    # output_directory - A String with the path to the directory, wher the file will be saved.
-    #
-    # Examples
-    #
-    #   save_to_file record, '/home/username/skype_backup'
-    def save_to_file(chat_record, output_directory)
-      filename = "#{output_directory}/#{parse_chatname chat_record[:chatname]}.txt"
-
-      Dir.mkdir(output_directory) unless File.exists?(output_directory)
-      File.open(filename, 'a') do |file|
-        file.puts build_entry(chat_record)
-      end
-
-      filename
-    rescue StandardError
-      puts 'An error occured while saving a file'
-    end
-
-    # Public: Creates a String with one entry from the chat.
-    #
-    # chat_record - a Hash containing data about a single chat message.
-    #
-    # Examples
-    #
-    #   build_entry { timestamp: 213213232, from_dispname: 'aidzis', body_xml: 'This is text.' }
-    #   # => [2013-04-13 14:23:57] aidzis: This is text.
-    #
-    # Returns a String with a chat entry.
-    def build_entry(chat_record)
-      datetime = Time.at chat_record[:timestamp]
-      output_record = "[#{datetime.strftime "%Y-%m-%d %H:%M:%S"}] "
-      output_record << "#{chat_record[:from_dispname]}: #{parse_body_xml chat_record[:body_xml]}"
-
-      output_record
-    end
-
-    # Public: Converts chatname from database to a valid file name.
-    #
-    # raw_chatname - A String with a chatname read from the database.
-    #
-    # Examples
-    #
-    #   parse_chatname '#someone/$someone_else;521357125362'
-    #   # => someone-someone_else.txt
-    #
-    # Returns a String with a valid file name.
-    def parse_chatname(raw_chatname)
-      match = raw_chatname.match(/#(.+)\/\$(.+);|#(.+)\/\$/)
-      first_part, second_part, third_part = match.captures
-      chatname = "#{first_part}-#{second_part}-#{third_part}"
-
-      trim_dashes chatname
-    end
-
-    # Public: Removes extra characters from the end of a chatname.
-    #
-    # raw_chatname - A String with a chatname read from the database
-    #
-    # Examples
-    #
-    #   partly_parse_chatname '#someone/$someone_else;521357125362'
-    #   # => #someone/$someone_else;
-    #
-    # Returns a String with a chatname without extra characters at the end.
-    def partly_parse_chatname(raw_chatname)
-      match = raw_chatname.match(/(#.+\/\$.+;)|(#.+\/\$)/)
-      first_group, second_group = match.captures
-
-      first_group || second_group
-    end
-
-    # Public: Removes unnecessary dashes from the begining and the end of the string.
-    #
-    # string - A String possibly containing dashes at the beggining or the end
-    #
-    # Examples
-    #
-    #   str = '--example-'
-    #   trim_dashes str
-    #   # => example
-    #
-    # Returns a string without leading and ending dashes.
-    def trim_dashes(string)
-      clean_string = string.gsub(/^-+/, '')
-      clean_string.gsub(/-+$/, '')
-    end
-
-    # Public: Remove Skype emotion tags.
-    #
-    # text - String containing XML data
-    #
-    # Examples
-    #
-    #   parse_body_xml "Some text <ss type="laugh">:D</ss>"
-    #   # => "Some text :D"
-    #
-    # Returns the duplicated String.
-    def parse_body_xml(text)
-      clean_text = text.gsub(/<ss type=".+">/, '')
-      clean_text.gsub(/<\/ss>/, '')
-    end
-
-    # Public: Compresses all the exported files into a Zip archive.
-    #
-    # output_directory - A String with the path to the directory, wher the file will be saved.
-    #
-    # Examples
-    #
-    #   archive '/home/username/skype-backup'
-    def archive(output_directory)
-      timestamp = Time.now.strftime "%Y%m%d%H%M%S"
-
-      Zip::ZipFile.open "#{output_directory}-#{timestamp}.zip", Zip::ZipFile::CREATE do |zipfile|
-        Dir.entries(output_directory).each do |file|
-          if File.file?("#{output_directory}/#{file}")
-            zipfile.add file, "#{output_directory}/#{file}"
-          end
-        end
-      end
-
-      FileUtils.rm_rf output_directory
-    end
-  end
-end
+require 'zip/zip'
+require 'fileutils'
+
+module Runoff
+  # Public: Methods used for writing to files.
+  class FileWriter
+    # Public: Initialize a FileWriter object.
+    #
+    # format - An object containing necessary methods for data formating.
+    def initialize(format)
+      @format = format
+    end
+    # Public: Saves a single chat message to a file.
+    #
+    # record - a Hash containing data about a single chat message.
+    # output_directory - A String with the path to the directory, wher the file will be saved.
+    #
+    # Examples
+    #
+    #   save_to_file record, '/home/username/skype_backup'
+    def save_to_file(record, output_directory)
+      filename = "#{output_directory}/#{@format.get_filename(record)}"
+
+      Dir.mkdir(output_directory) unless File.exists?(output_directory)
+      File.open(filename, 'a') do |file|
+        file.puts @format.build_entry(record)
+      end
+
+      filename
+    end
+
+    # Public: Compresses all the exported files into a Zip archive.
+    #
+    # output_directory - A String with the path to the directory, wher the file will be saved.
+    #
+    # Examples
+    #
+    #   archive '/home/username/skype-backup'
+    def self.archive(output_directory)
+      timestamp = Time.now.strftime "%Y%m%d%H%M%S"
+
+      Zip::ZipFile.open "#{output_directory}-#{timestamp}.zip", Zip::ZipFile::CREATE do |zipfile|
+        Dir.entries(output_directory).each do |file|
+          if File.file?("#{output_directory}/#{file}")
+            zipfile.add file, "#{output_directory}/#{file}"
+          end
+        end
+      end
+
+      FileUtils.rm_rf output_directory
+    end
+  end
+end

data/lib/runoff/location.rb

@@ -1,61 +1,40 @@
-module Runoff
-
-  # Public: Contains class methods for finding out the appropriate file paths.
-  #
-  # Examples
-  #
-  #   Location::default_skype_data_location skype_username
-  #   # => /home/user/.Skype/skype_username/main.db
-  class Location
-
-    # Public: Composes the default Skype database location depending on the operating system.
-    #
-    # skype_username - A String that contains a username of the Skype account,
-    #                  which database we want to access.
-    #
-    # Examples
-    #
-    #   On Linux:
-    #   default_skype_data_location skype_username
-    #   # => /home/user/.Skype/skype_username/mai.db
-    #
-    #   On Windows:
-    #   default_skype_data_location skype_username
-    #   # =>  /Users/user/AppData/Roaming/Skype/skype_username/main.db
-    #
-    # Returns a String that contains the path to the Skype database file.
-    def self.default_skype_data_location(skype_username)
-      if RbConfig::CONFIG['host_os'] =~ /mingw/
-        location = "#{ENV['APPDATA']}\\Skype\\#{skype_username}\\main.db"
-
-        location.gsub!(/\\/, '/')
-        location.gsub(/^[a-zA-Z]:/, '')
-      elsif RbConfig::CONFIG['host_os'] =~ /linux/
-        "#{ENV['HOME']}/.Skype/#{skype_username}/main.db"
-      else
-        "#{ENV['HOME']}/Library/Application Support/Skype/#{skype_username}/main.db"
-      end
-    end
-
-    # Public: Clarifies the path to the user's home directory depending on the operating system
-    #
-    # Examples
-    #
-    #   On Linux:
-    #   home_path
-    #   # => /home/user
-    #
-    #   On Windows:
-    #   home_path
-    #   # => C:\Users\user
-    #
-    # Returns a String that contains the path to the user's home directory.
-    def self.home_path
-      if RbConfig::CONFIG['host_os'] =~ /mingw/
-        ENV['USERPROFILE']
-      else
-        ENV['HOME']
-      end
-    end
-  end
+module Runoff
+
+  # Public: Contains class methods for finding out the appropriate file paths.
+  #
+  # Examples
+  #
+  #   Location::default_skype_data_location skype_username
+  #   # => /home/user/.Skype/skype_username/main.db
+  class Location
+
+    # Public: Composes the default Skype database location depending on the operating system.
+    #
+    # skype_username - A String that contains a username of the Skype account,
+    #                  which database we want to access.
+    #
+    # Examples
+    #
+    #   On Linux:
+    #   default_skype_data_location skype_username
+    #   # => /home/user/.Skype/skype_username/mai.db
+    #
+    #   On Windows:
+    #   default_skype_data_location skype_username
+    #   # =>  /Users/user/AppData/Roaming/Skype/skype_username/main.db
+    #
+    # Returns a String that contains the path to the Skype database file.
+    def self.default_skype_data_location(skype_username)
+      if RbConfig::CONFIG['host_os'] =~ /mingw/
+        location = "#{ENV['APPDATA']}\\Skype\\#{skype_username}\\main.db"
+
+        location.gsub!(/\\/, '/')
+        location.gsub(/^[a-zA-Z]:/, '')
+      elsif RbConfig::CONFIG['host_os'] =~ /linux/
+        "#{ENV['HOME']}/.Skype/#{skype_username}/main.db"
+      else
+        "#{ENV['HOME']}/Library/Application Support/Skype/#{skype_username}/main.db"
+      end
+    end
+  end
 end

data/lib/runoff/skype_data_format.rb

@@ -0,0 +1,104 @@
+module Runoff
+  # Public: Deals with Skype specific formats.
+  class SkypeDataFormat
+    #Public: Builds an appropriate filename.
+    #
+    # chat_record - A Hash containing necessary data.
+    #
+    # Examples
+    #
+    #   get_filename { chatname: 'demo-chat' }
+    #   # => demo-chat.txt
+    #
+    # Retruns a filename as a String.
+    def get_filename(chat_record)
+      "#{parse_chatname chat_record[:chatname]}.txt"
+    end
+
+    # Public: Creates a String with one entry from the chat.
+    #
+    # chat_record - a Hash containing data about a single chat message.
+    #
+    # Examples
+    #
+    #   build_entry { timestamp: 213213232, from_dispname: 'aidzis', body_xml: 'This is text.' }
+    #   # => [2013-04-13 14:23:57] aidzis: This is text.
+    #
+    # Returns a String with a chat entry.
+    def build_entry(chat_record)
+      datetime = Time.at chat_record[:timestamp]
+      output_record = "[#{datetime.strftime "%Y-%m-%d %H:%M:%S"}] "
+      output_record << "#{chat_record[:from_dispname]}: #{parse_body_xml chat_record[:body_xml]}"
+
+      output_record
+    rescue StandardError
+    end
+
+    # Public: Converts chatname from database to a valid file name.
+    #
+    # raw_chatname - A String with a chatname read from the database.
+    #
+    # Examples
+    #
+    #   parse_chatname '#someone/$someone_else;521357125362'
+    #   # => someone-someone_else.txt
+    #
+    # Returns a String with a valid file name.
+    def parse_chatname(raw_chatname)
+      match = raw_chatname.match(/#(.+)\/\$(.+);|#(.+)\/\$/)
+      first_part, second_part, third_part = match.captures
+      chatname = "#{first_part}-#{second_part}-#{third_part}"
+
+      trim_dashes chatname
+    end
+
+    # Public: Removes extra characters from the end of a chatname.
+    #
+    # raw_chatname - A String with a chatname read from the database
+    #
+    # Examples
+    #
+    #   partly_parse_chatname '#someone/$someone_else;521357125362'
+    #   # => #someone/$someone_else;
+    #
+    # Returns a String with a chatname without extra characters at the end.
+    def partly_parse_chatname(raw_chatname)
+      match = raw_chatname.match(/(#.+\/\$.+;)|(#.+\/\$)/)
+      first_group, second_group = match.captures
+
+      first_group || second_group
+    end
+
+    private
+    # Internal: Remove Skype emotion tags.
+    #
+    # text - String containing XML data
+    #
+    # Examples
+    #
+    #   parse_body_xml "Some text <ss type="laugh">:D</ss>"
+    #   # => "Some text :D"
+    #
+    # Returns the duplicated String.
+    def parse_body_xml(text)
+      clean_text = text.gsub(/<ss type=".+">/, '')
+      clean_text.gsub(/<\/ss>/, '')
+    end
+
+    # Internal: Removes unnecessary dashes from the begining and the end of the string.
+    #
+    # string - A String possibly containing dashes at the beggining or the end
+    #
+    # Examples
+    #
+    #   str = '--example-'
+    #   trim_dashes str
+    #   # => example
+    #
+    # Returns a string without leading and ending dashes.
+    def trim_dashes(string)
+      clean_string = string.gsub(/^-+/, '')
+      clean_string.gsub(/-+$/, '')
+    end
+  end
+end

data/lib/runoff/version.rb

@@ -1,3 +1,3 @@
-module Runoff
-  VERSION = '0.2.0'
+module Runoff
+  VERSION = '0.3.0'
 end

data/lib/runoff.rb

@@ -1,7 +1,10 @@
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-
-require "runoff/version"
-require "runoff/location"
-require "runoff/file_writer"
-require "runoff/composition"
-require "runoff/source"
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require "runoff/version"
+require "runoff/location"
+require "runoff/skype_data_format"
+require "runoff/file_writer"
+require "runoff/composition"
+require "runoff/commands/command"
+require "runoff/commands/all"
+require "runoff/commands/chat"

data/runoff.gemspec

@@ -1,26 +1,26 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'runoff/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "runoff"
-  gem.version       = Runoff::VERSION
-  gem.authors       = ["Aigars Dzerviniks"]
-  gem.email         = ["dzerviniks.aigars@outlook.com"]
-  gem.description   = %q{runoff provides functionality to export all the Skype chat history or only specified chats from the Skype SQLite database file to text files}
-  gem.summary       = %q{Tool to export Skype chat history from the SQLite database to text files}
-  gem.homepage      = 'https://github.com/aidzis/runoff'
-  gem.license       = 'MIT'
-
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-
-  gem.add_dependency 'thor'
-  gem.add_dependency 'sqlite3'
-  gem.add_dependency 'sequel'
-  gem.add_dependency 'rubyzip'
-end
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'runoff/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "runoff"
+  gem.version       = Runoff::VERSION
+  gem.authors       = ["Aigars Dzerviniks"]
+  gem.email         = ["dzerviniks.aigars@outlook.com"]
+  gem.description   = %q{runoff provides functionality to export all the Skype chat history or only specified chats from the Skype SQLite database file to text files}
+  gem.summary       = %q{Tool to export Skype chat history from the SQLite database to text files}
+  gem.homepage      = 'https://github.com/aidzis/runoff'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'commander'
+  gem.add_dependency 'sequel'
+  gem.add_dependency 'rubyzip'
+  gem.add_dependency 'sqlite3'
+end

data/test/all_test.rb

@@ -0,0 +1,25 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'runoff'
+
+describe Runoff::Commands::All do
+  it 'must output an error message if no username or --from option is provided' do
+    ->{ Runoff::Commands::All.process []  }.must_output "You must specify a username or a --from option\n"
+  end
+
+  it 'must output result of the command' do
+    ->{ Runoff::Commands::All.process [], {
+      from: 'test/test_db.sqlite', destination: 'test/tmp' }
+    }.must_output "Finished: 2 files were exported\n"
+  end
+
+  it 'must put exported files into an archive' do
+    capture_io { Runoff::Commands::All.process [], { from: 'test/test_db.sqlite', destination: 'test/tmp' } }
+
+    Dir["test/*.zip"].length.must_equal 1
+
+    Dir.glob('test/*.zip').each do |archive|
+      File.delete archive
+    end
+  end
+end

data/test/chat_test.rb

@@ -0,0 +1,9 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'runoff'
+
+describe Runoff::Commands::Chat do
+  it 'must output an error message if no username or --from option is provided' do
+    ->{ Runoff::Commands::Chat.process []  }.must_output "You must specify a username or a --from option\n"
+  end
+end

data/test/command_test.rb

@@ -0,0 +1,29 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'runoff'
+
+describe Runoff::Commands::Command do
+  it 'must create a Composition object based on the Skype username or a specific path' do
+    Runoff::Commands::Command.send(:get_composition, nil, 'test/test_db.sqlite').must_be_instance_of Runoff::Composition
+  end
+
+  it 'must return a default destination path if no optional path is specified' do
+    Runoff::Commands::Command.send(:get_destination, nil).must_equal "#{ENV['HOME']}/skype-backup"
+  end
+
+  it 'must return a custom path if an optional path variable is specified' do
+    path = Runoff::Commands::Command.send(:get_destination, 'test/test_db.sqlite')
+    path.must_equal 'test/test_db.sqlite'
+  end
+
+  it 'must output correct message based on the exported items count' do
+    ->{ Runoff::Commands::Command.send(:print_result, 1) }.must_output "Finished: 1 file was exported\n"
+    ->{ Runoff::Commands::Command.send(:print_result, 2) }.must_output "Finished: 2 files were exported\n"
+  end
+
+  it 'must output a list of available chatnames' do
+    chatnames = ['first-chatname', 'second-chatname']
+
+    ->{ Runoff::Commands::Command.send(:list_chatnames, chatnames) }.must_output "[0] first-chatname\n[1] second-chatname\n\n"
+  end
+end

data/test/{runoff_composition_test.rb → composition_test.rb}

@@ -1,56 +1,53 @@
-require 'minitest/spec'
-require 'minitest/autorun'
-require 'runoff'
-
-describe Runoff::Composition do
-  before { @composition = Runoff::Composition.new 'test/test_db.sqlite' }
-
-  it "must raise an IOError if the file that is passed to the constructor doesn't exist" do
-    ->{ composition = Runoff::Composition.new 'not_existing.db' }.must_raise IOError
-  end
-
-  it 'must have a getter method for exported filenames' do
-    @composition.must_respond_to :exported_filenames
-  end
-
-  it 'must return parsed chatnames together with partly parsed chatnames' do
-    chatnames, raw_chatnames = @composition.get_chatnames
-
-    chatnames.must_equal ['something-more', 'something-else']
-    raw_chatnames.must_equal ['#something/$more;', '#something/$else;']
-  end
-
-  it 'must have a save_to_file method' do
-    @composition.must_respond_to :save_to_file
-  end
-
-  it 'must return a count of the exported filenames' do
-    file_count = @composition.send(
-      :run_export,
-      [{
-        chatname: '#test/$one;7687623',
-        timestamp: 123123213,
-        from_dispname: 'Aidzis',
-        body_xml: ''
-      }],
-      'test/tmp'
-    )
-
-    file_count.must_equal 1
-    FileUtils.rm_rf 'test/tmp/.'
-  end
-
-  it 'must return a count of the exported filenames when called for all chats' do
-    file_count = @composition.export 'test/tmp'
-
-    file_count.must_equal 2
-    FileUtils.rm_rf 'test/tmp/.'
-  end
-
-  it 'must return a count of the exported filenames when called for specific chats' do
-    file_count = @composition.export_chats ['#something/$more;', '#something/$else;'], 'test/tmp'
-
-    file_count.must_equal 2
-    FileUtils.rm_rf 'test/tmp/.'
-  end
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'runoff'
+require 'fileutils'
+
+describe Runoff::Composition do
+  before { @composition = Runoff::Composition.new 'test/test_db.sqlite' }
+
+  it "must raise an IOError if the file that is passed to the constructor doesn't exist" do
+    ->{ composition = Runoff::Composition.new 'not_existing.db' }.must_raise IOError
+  end
+
+  it 'must have a getter method for exported filenames' do
+    @composition.must_respond_to :exported_filenames
+  end
+
+  it 'must return parsed chatnames together with partly parsed chatnames' do
+    chatnames, raw_chatnames = @composition.get_chatnames
+
+    chatnames.must_equal ['something-more', 'something-else']
+    raw_chatnames.must_equal ['#something/$more;', '#something/$else;']
+  end
+
+  it 'must return a count of the exported filenames' do
+    file_count = @composition.send(
+      :run_export,
+      [{
+        chatname: '#test/$one;7687623',
+        timestamp: 123123213,
+        from_dispname: 'Aidzis',
+        body_xml: ''
+      }],
+      'test/tmp'
+    )
+
+    file_count.must_equal 1
+    FileUtils.rm_rf 'test/tmp'
+  end
+
+  it 'must return a count of the exported filenames when called for all chats' do
+    file_count = @composition.export 'test/tmp'
+
+    file_count.must_equal 2
+    FileUtils.rm_rf 'test/tmp'
+  end
+
+  it 'must return a count of the exported filenames when called for specific chats' do
+    file_count = @composition.export_chats ['#something/$more;', '#something/$else;'], 'test/tmp'
+
+    file_count.must_equal 2
+    FileUtils.rm_rf 'test/tmp'
+  end
 end