plog 0.2.4

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+kazu.test
+objects

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kazuyoshi Tlacaelel
+
+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 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/README.rdoc

@@ -0,0 +1,148 @@
+= Plog
+
+Ruby on Rails production log statistics generator.
+
+by Kazuyoshi Tlacaelel.
+
+    $ plog my_directory_with_production_logs/
+    $ ls plog/
+    objects     statistics.txt
+
+
+== Copyright
+
+Copyright (c) 2009 Kazuyoshi Tlacaelel. See LICENSE for details.
+
+== Comming soon!
+
+comming soon to a terminal near you!
+
+  * sorting:
+  * more statistics
+    (hits, number of hits per response type like 200, 302 etc)
+
+May be... but don't expect any of these to become a reality
+I love programming and tons of ideas flow in my head with posibilities
+but I do not have the time! :(
+
+  * Different export drivers?
+    (should be another plugin)
+
+  * cli options abstracted into classes so they can be aggregated with ease
+    (this might be cool)
+
+  * google charts integration
+    (is too much for this api)
+    (may be as a different plugin)
+
+== Dependancies:
+
+  * FileUtils
+  * MD5
+  * File
+  * Dir
+  * URI
+  * rubygems 1.3.3
+
+== Features:
+
+Compiles statistics in a easy to read manner
+
+
+    Hits      Time      Avg-Time  DbTime    Avg-DB    View      Avg-View  Url
+    93        18057     0.194     5775      0.062     10437     0.112     /users/[0-9]
+    12        277       0.023     193       0.016     0         0         /user_themes/update
+    1         290       0.29      107       0.107     175       0.175     /posts
+    3         99        0.033     57        0.019     0         0         /comments
+    82        11922     0.145     5969      0.072     4979      0.06      /user/[0-9]/comments
+    1868      1301006   0.696     623246    0.333     491474    0.263     /user/[0-9]/posts?
+    1         72        0.072     39        0.039     0         0         /confirm_destroy_account/[0-9]?
+    797       971882    1.219     414829    0.52      423130    0.53      /user/[0-9]/articles/friends?
+    122       20830     0.17      7081      0.058     10291     0.084     /user/[0-9]/topics?
+
+== Improvized twicks:
+
+You can improvize some quick sorting using the command line like:
+
+    cat plog/statistics.txt | head -n1 > some_file.txt
+    cat plog/statistics.txt | sort -nr >> some_file.txt
+
+This will create a new file with sorted results by hits for you!
+
+    Hits      Time      Avg-Time  DbTime    Avg-DB    View      Avg-View  Url
+    1868      1301006   0.696     623246    0.333     491474    0.263     /user/[0-9]/posts?
+    797       971882    1.219     414829    0.52      423130    0.53      /user/[0-9]/articles/friends?
+    122       20830     0.17      7081      0.058     10291     0.084     /user/[0-9]/topics?
+    93        18057     0.194     5775      0.062     10437     0.112     /users/[0-9]
+    82        11922     0.145     5969      0.072     4979      0.06      /user/[0-9]/comments
+    12        277       0.023     193       0.016     0         0         /user_themes/update
+    3         99        0.033     57        0.019     0         0         /comments
+    1         72        0.072     39        0.039     0         0         /confirm_destroy_account/[0-9]?
+    1         290       0.29      107       0.107     175       0.175     /posts
+
+== Installation
+
+    $ gem sources -a http://gems.github.com
+    $ gem install ktlacaelel-plog
+
+== Known bugs:
+  none, so far..
+
+== License:
+  MIT. See the "LICENSE" file for details.
+
+== Participate
+
+* Send me a brief message
+* Fork the project.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Make your feature addition or bug fix.
+* 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.
+
+== Output:
+
+All output is packed in a plog directory, from wherever you run
+the "plog" executable.
+
+Inside this directory you'll find a directory called objects.
+wich contains many small files called "object-files"
+this files contain all the parsed statistics of you log files.
+
+The information is scattered and can be reused for future compilations
+meaning that new compilations data will merge with the existing one.
+
+all data in these "object-files" is read and summarized into a
+statistics.txt file found inside of the plog directory.
+
+== Tests:
+
+  * 70% tested, with shoulda
+  * all core areas of the api are tested, and tests pass!
+  * only the cli part of the api has no tests, but will be implemented soon
+
+== Usage:
+
+The "plog" ( production log ) executable receives one option.
+This must be a directory containing one or more production logs.
+Only logs in the first level will be parsed.
+Recursive reading is not allowed
+
+    $ plog directory_with_logs/
+
+== Works on:
+
+  * OSX Darwin utopia.local 9.8.0 Darwin Kernel Version 9.8.0: Wed Jul 15 16:55:01 PDT 2009; root:xnu-1228.15.4~1/RELEASE_I386 i386
+  * UBUNTU Linux utopia.local 2.6.28-11-server #42-Ubuntu SMP Fri Apr 17 02:45:36 UTC 2009 x86_64 GNU/Linux
+
+  * OSX ruby 1.8.6 (2008-08-11 patchlevel 287) [universal-darwin9.0]
+  * UBUNTU ruby 1.8.7 (2009-06-12 patchlevel 174) [x86_64-linux]
+
+  * rubygems 1.3.4
+  * rubygems 1.3.3
+
+== The end.
+

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "plog"
+    gem.summary = %Q{Plog - Ruby on Rails production log statistic generator. by Kazuyoshi Tlacaelel}
+    gem.description = %Q{Plog - Ruby on Rails production log statistic generator. by Kazuyoshi Tlacaelel}
+    gem.email = "kazu.dev@gmail.com"
+    gem.homepage = "http://github.com/ktlacaelel/plog"
+    gem.authors = ["Kazuyoshi Tlacaelel"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "plog #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/bin/plog

@@ -0,0 +1,22 @@
+#!/home/jognote/ruby/bin/ruby
+
+require 'rubygems'
+require 'plog'
+
+banner = '
+ERROR!
+  No logs given, I have nothing to do!
+
+HELP?
+  The "plog" ( production log ) executable receives one option.
+  This must be a directory containing one or more production logs.
+  Only logs in the first level will be parsed.
+  Recursive reading is not allowed
+
+USAGE:
+  $ plog directory_with_logs/
+
+'
+
+abort banner if ARGV.size != 1
+Plog::Cli.new(ARGV[0], 'plog').run!

data/lib/cli.rb

@@ -0,0 +1,119 @@
+module Plog
+
+  class Cli
+
+    attr_reader :source_directory, :log_files
+
+    STATS_FILE = 'statistics.txt'
+
+    # ==========================================================================
+    # CLIENT INTERFACE
+    # ==========================================================================
+
+    def initialize(source_directory, target_directory)
+      @log_files = []
+      @source_directory = source_directory
+      @target_directory = target_directory
+      check_directory_consistency!
+      preload_log_files!
+    end
+
+    def run!
+      stdout count_of_logs_banner(@log_files.size)
+      stdout notice_banner
+      create_object_files
+      destroy_old_log_file
+      append_headers_to_log_file
+      parse_object_files
+    end
+
+    # ==========================================================================
+    # INTERNAL INTERFACE
+    # ==========================================================================
+
+    protected
+
+    def trim(string)
+      return '' unless string.is_a? String
+      string.gsub(/^\s+/, '').gsub(/\s+$/, '')
+    end
+
+    def create_object_files
+      @log_files.each do |log_file|
+        stdout parsing_log_file_banner(log_file.name)
+        log_file.parse_completed_lines!
+      end
+    end
+
+    def parse_object_files
+      Dir.glob(object_file_pattern).each do |object_file|
+        file = File.new(statistic_file_path, 'a+')
+        file.puts trim(ObjectFile.new(object_file).export)
+        file.close
+      end
+    end
+
+    def object_file_pattern
+      File.join(@target_directory, 'objects') + '/*'
+    end
+
+    def statistic_file_path
+      File.join(@target_directory, STATS_FILE)
+    end
+
+    def destroy_old_log_file
+      FileUtils.touch statistic_file_path
+      FileUtils.rm statistic_file_path
+    end
+
+    def append_headers_to_log_file
+      file = File.new(statistic_file_path, 'a+')
+      file.puts trim(ObjectFile.formated_headers)
+      file.close
+    end
+
+    def check_directory_consistency!
+      abort directory_not_found_banner unless File.exist? @source_directory
+    end
+
+    def preload_log_files!
+      Dir.glob(File.join(@source_directory, '*.log')).each do |log_file|
+        @log_files << LogFile.new(log_file, @target_directory)
+        stdout loading_log_file_banner(log_file)
+      end
+    end
+
+    def stdout(string)
+      puts ' ---> ' + string
+    end
+
+    # ==========================================================================
+    # BANNERS
+    # ==========================================================================
+
+    def notice_banner
+      'Parsing logs...
+      This may take a long-while, go get yourself a coffee!
+      While I hanlde this stuff for you.
+      '
+    end
+
+    def count_of_logs_banner(size)
+      'Count of loaded logs : %s ' % size
+    end
+
+    def parsing_log_file_banner(file)
+      'Parsing log located at : %s ' % file
+    end
+
+    def loading_log_file_banner(file)
+      'Initializing log file: %s' % file
+    end
+
+    def directory_not_found_banner
+      'No such dir: %s' % @source_directory
+    end
+
+  end
+
+end

data/lib/completed_line.rb

@@ -0,0 +1,109 @@
+module Plog
+
+  class CompletedLine
+
+    TOTAL_TIME_REGEX = /^(Completed in )(\d+)ms/         # \2
+    VIEW_TIME_REGEX = /([^\(]+)([^V]+)(View: )(\d+)(.*)/ # \4
+    DB_TIME_REGEX = /([^\(]+)([^D]+)(DB: )(\d+)(.*)/     # \4
+    URL_REGEX = /([^\[]+)(\[)([^\]]+)(.*)/
+    STATUS_REGEX = /(\s)(\d+)(\s)(\w+)(\s)(\[)(.*)/      # \2, \4
+    COMPLETED_TIME_REGEX = /^Completed/
+
+    def self.url
+      URL.new(@url)
+    end
+
+    def self.valid?
+      completed_line?
+    end
+
+    def self.completed_line?
+      return false unless @line.is_a? String
+      return false unless COMPLETED_TIME_REGEX =~ @line
+      return false unless DB_TIME_REGEX =~ @line
+      return false if @line.size < 10
+      true
+    end
+
+    def self.read!(string_line)
+      @line = string_line
+      validate
+    end
+
+    def self.db_time
+      @db_time
+    end
+
+    def self.view_time
+      @view_time
+    end
+
+    def self.total_time
+      @total_time
+    end
+
+    def self.status_string
+      @status_string
+    end
+
+    def self.status_number
+      @status_number
+    end
+
+    def self.to_csv
+      [total_time, view_time, db_time, url.simplify].join(',')
+    end
+
+    def self.merge(view, db)
+      @view_time += view.to_i
+      @db_time += db.to_i
+      @total_time = (@view_time + @db_time)
+    end
+
+    protected
+
+    def self.validate
+      return unless completed_line?
+      fragmentize!
+      extract_time!
+      extract_url!
+    end
+
+    def self.fragmentize!
+      @first_fragment, @second_fragment = @line.split('|')
+    end
+
+    def self.extract_time!
+      @total_time = extract_total_time
+      @view_time = extract_view_time
+      @db_time = extract_db_time
+      @status_number, @status_string = extract_status_number_and_string
+      nil
+    end
+
+    def self.extract_total_time
+      return 0 unless TOTAL_TIME_REGEX =~ @first_fragment
+      @first_fragment.gsub(TOTAL_TIME_REGEX, '\2').to_i
+    end
+
+    def self.extract_db_time
+      return 0 unless DB_TIME_REGEX =~ @first_fragment
+      @first_fragment.gsub(DB_TIME_REGEX, '\4').to_i
+    end
+
+    def self.extract_view_time
+      return 0 unless VIEW_TIME_REGEX =~ @first_fragment
+      @first_fragment.gsub(VIEW_TIME_REGEX, '\4').to_i
+    end
+
+    def self.extract_status_number_and_string
+      @second_fragment.gsub(STATUS_REGEX, '\2,\4').split(',')
+    end
+
+    def self.extract_url!
+      @url = @second_fragment.gsub(URL_REGEX, '\3')
+    end
+
+  end
+
+end

data/lib/log_file.rb

@@ -0,0 +1,52 @@
+module Plog
+
+  class LogFile < File
+
+    attr_accessor :name
+
+    def initialize(file, dump_dir)
+      @dump_dir = dump_dir
+      check_dump_dir_consistency!
+      super(file, 'r')
+      @name = file
+    end
+
+    def check_dump_dir_consistency!
+      unless File.exist? objects_recipient_path
+        FileUtils.mkdir_p objects_recipient_path
+      end
+    end
+
+    def validate(file)
+      abort 'File not found: ' + file.inspect unless File.exist? file
+    end
+
+    def parse_completed_lines!
+      each_line do |line|
+        CompletedLine.read! line
+        parse_completed_line if CompletedLine.valid?
+      end
+    end
+
+    def parse_completed_line
+      of = ObjectFile.new(object_path, 'w+')
+      of.simplified_url = CompletedLine.url.simplify
+      of.append_total_time CompletedLine.total_time
+      of.append_db_time CompletedLine.db_time
+      of.append_view_time CompletedLine.view_time
+      of.append_hits 1
+      of.save_changes!
+      of.close
+    end
+
+    def object_path
+      File.join(objects_recipient_path, CompletedLine.url.hashify)
+    end
+
+    def objects_recipient_path
+      @objects_recipient_path ||= File.join(@dump_dir, 'objects')
+    end
+
+  end
+
+end

data/lib/object_file.rb

@@ -0,0 +1,165 @@
+module Plog
+
+  class ObjectFile < File
+
+    DEFAULT_VALUES = {
+      :@total_hits => 0,
+      :@total_time => 0,
+      :@view_time => 0,
+      :@db_time => 0,
+      :@simplified_url => 'default'
+    }
+
+    KEY_ORDER = [
+      :@total_hits,
+      :@total_time,
+      :@view_time,
+      :@db_time,
+      :@simplified_url
+    ]
+
+    attr_accessor :simplified_url
+    attr_reader :view_time, :total_time, :db_time, :total_hits
+
+    def initialize(*args)
+      raw_data(args.first)
+      super(*args)
+      setup!
+    end
+
+    def setup!
+      unpack_default_values if ObjectFile.zero? path
+      load_changes!
+    end
+
+    def unpack_default_values
+      DEFAULT_VALUES.each do |k, v|
+        instance_variable_set k, v
+      end
+    end
+
+    def append_view_time(value)
+      @view_time += value.to_i
+    end
+
+    def append_db_time(value)
+      @db_time += value.to_i
+    end
+
+    def append_total_time(value)
+      @total_time += value
+    end
+
+    def append_hits(value)
+      @total_hits += value
+    end
+
+    def save_changes!
+      puts serialize_changes
+    end
+
+    def serialize_changes
+      KEY_ORDER.collect { |key| instance_variable_get key }.join(',')
+    end
+
+    def load_changes!
+      return if @raw_data == ''
+      @total_hits, @total_time, @view_time, @db_time, @simplified_url = @raw_data.split(',')
+      intify!
+    end
+
+    def intify!
+      @total_hits = @total_hits.to_i
+      @total_time = @total_time.to_i
+      @db_time = @db_time.to_i
+      @view_time = @view_time.to_i
+    end
+
+    def raw_data(some_string)
+      if File.exist? some_string
+        @raw_data = File.new(some_string).read
+      else
+        @raw_data = ''
+      end
+    end
+
+    def export_settings
+      [
+        [@total_hits, [:left, 10]],
+        [total_time_in_secs, [:left, 10]],
+        [avg_total_time, [:left, 10]],
+        [db_time_in_secs, [:left, 10]],
+        [avg_db_time, [:left, 10]],
+        [view_time_in_secs, [:left, 10]],
+        [avg_view_time, [:left, 10]],
+        [simplified_url, [:left, 40]],
+      ]
+    end
+
+    def self.export_header_settings
+      [
+        ['Hits', [:left, 10]],
+        ['Time', [:left, 10]],
+        ['Avg-Time', [:left, 10]],
+        ['DbTime', [:left, 10]],
+        ['Avg-DB', [:left, 10]],
+        ['View', [:left, 10]],
+        ['Avg-View', [:left, 10]],
+        ['Url', [:left, 40]],
+      ]
+    end
+
+    def self.formated_headers
+      export_header_settings.collect do |value, setting|
+        if setting.first == :left
+          value.to_s.ljust(setting[1])
+        else
+          value.to_s.rjust(setting[1])
+        end
+      end.join('') + "\n"
+    end
+
+    def export_headers
+      export_header_settings.collect { |header| header.ljust(20) }.join('')
+    end
+
+    def export
+      export_settings.collect do |value, setting|
+        if setting.first == :left
+          value.to_s.ljust(setting[1])
+        else
+          value.to_s.rjust(setting[1])
+        end
+      end.join('')
+    end
+
+    def avg_total_time
+      return 0 if @total_time == 0
+      (@total_time / @total_hits / 1000.0)
+    end
+
+    def avg_view_time
+      return 0 if @view_time == 0
+      (@view_time / @total_hits / 1000.0)
+    end
+
+    def avg_db_time
+      return 0 if @db_time == 0
+      (@db_time / @total_hits / 1000.0)
+    end
+
+    def total_time_in_secs
+      @total_time / 1000.0
+    end
+
+    def db_time_in_secs
+      @db_time / 1000.0
+    end
+
+    def view_time_in_secs
+      @view_time / 1000.0
+    end
+
+  end
+
+end

data/lib/plog.rb

@@ -0,0 +1,13 @@
+
+# required external libraries
+require 'fileutils'
+require 'md5'
+require 'uri'
+
+# required internal libraries
+require 'cli'
+require 'completed_line'
+require 'log_file'
+require 'object_file'
+require 'url'
+

data/lib/url.rb

@@ -0,0 +1,36 @@
+module Plog
+
+  class URL
+
+    def initialize(url)
+      @url = url
+      @obj = URI.parse URI.escape(url)
+    end
+
+    def to_s
+      @url
+    end
+
+    def simplify
+      simplify_url = @url.dup
+      simplifiers.each { |k, v| simplify_url.gsub!(k, v) if k =~ simplify_url }
+      simplify_url
+    end
+
+    def hashify
+      ::MD5.hexdigest simplify
+    end
+
+    protected
+
+    def simplifiers
+      {
+        /\?.*/ => '?',
+        /\d+/ => '[0-9]',
+        /http:..[^\/]+/ => ''
+      }
+    end
+
+  end
+
+end

data/plog.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{plog}
+  s.version = "0.2.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kazuyoshi Tlacaelel"]
+  s.date = %q{2009-09-09}
+  s.default_executable = %q{plog}
+  s.description = %q{Plog - Ruby on Rails production log statistic generator. by Kazuyoshi Tlacaelel}
+  s.email = %q{kazu.dev@gmail.com}
+  s.executables = ["plog"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/plog",
+     "lib/cli.rb",
+     "lib/completed_line.rb",
+     "lib/log_file.rb",
+     "lib/object_file.rb",
+     "lib/plog.rb",
+     "lib/url.rb",
+     "plog.gemspec",
+     "test/completed_line_test.rb",
+     "test/data/example.log",
+     "test/log_file_test.rb",
+     "test/object_file_test.rb",
+     "test/plog_test.rb",
+     "test/test_helper.rb",
+     "test/url_test.rb"
+  ]
+  s.homepage = %q{http://github.com/ktlacaelel/plog}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Plog - Ruby on Rails production log statistic generator. by Kazuyoshi Tlacaelel}
+  s.test_files = [
+    "test/completed_line_test.rb",
+     "test/log_file_test.rb",
+     "test/object_file_test.rb",
+     "test/plog_test.rb",
+     "test/test_helper.rb",
+     "test/url_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/test/completed_line_test.rb

@@ -0,0 +1,156 @@
+require 'test_helper'
+
+class CompletedLineTest < Test::Unit::TestCase
+
+  def setup
+    @valid_first_fragment = 'Completed in 5ms (View: 4, DB: 1) '
+    @valid_line = 'Completed in 5ms (View: 4, DB: 1) | 200 OK [http://www.example.com/users/12972]'
+    @valid_line_no_view = 'Completed in 5ms (DB: 5) | 200 OK [http://www.example.com/users/12972]'
+    @valid_second_fragment = ' 200 OK [http://www.example.com/users/12972]'
+
+    @valid_db_time = 1
+    @valid_view_time = 4
+    @valid_total_time = 5
+
+    @valid_db_time_no_view = 5
+    @valid_view_time_no_view = 0
+    @valid_total_time_no_view = 5
+
+    @valid_csv_line = '5,4,1,/users/[0-9]'
+    @valid_status_string = 'OK'
+    @valid_status_number = '200'
+  end
+
+  # ============================================================================
+  # READ
+  # ============================================================================
+
+  should 'read a valid completed line (standard)' do
+    Plog::CompletedLine.read! @valid_line
+    assert_equal @valid_view_time, Plog::CompletedLine.view_time
+    assert_equal @valid_db_time, Plog::CompletedLine.db_time
+    assert_equal @valid_total_time, Plog::CompletedLine.total_time
+  end
+
+  should 'read valid completed line (without view time)' do
+    Plog::CompletedLine.read! @valid_line_no_view
+    assert_equal 5, Plog::CompletedLine.total_time
+    assert_equal 0, Plog::CompletedLine.view_time
+    assert_equal 5, Plog::CompletedLine.db_time
+  end
+
+  # ============================================================================
+  # RECALCULATION
+  # ============================================================================
+
+  should 'recalculate acurately!' do
+    Plog::CompletedLine.read! @valid_line
+    Plog::CompletedLine.merge(1, 1)
+    assert_equal (@valid_view_time + 1), Plog::CompletedLine.view_time
+    assert_equal (@valid_db_time + 1), Plog::CompletedLine.db_time
+    assert_equal (@valid_total_time + 2), Plog::CompletedLine.total_time
+  end
+
+  # ============================================================================
+  # FRAGMENTATION
+  # ============================================================================
+
+  should 'fragmentize correctly' do
+    Plog::CompletedLine.read! @valid_line
+    first, second = Plog::CompletedLine.fragmentize!
+    assert_equal @valid_first_fragment, first
+    assert_equal @valid_second_fragment, second
+  end
+
+  # ============================================================================
+  # TIME RETRIVAL ( when view & db are *both* present )
+  # ============================================================================
+
+  should 'retrive correct total time (view + db)' do
+    Plog::CompletedLine.read! @valid_line
+    assert_equal @valid_total_time, Plog::CompletedLine.total_time
+  end
+
+  should 'retrive correct view time (view + db)' do
+    Plog::CompletedLine.read! @valid_line
+    assert_equal @valid_view_time, Plog::CompletedLine.view_time
+  end
+
+  should 'retrive correct db time (view + db)' do
+    Plog::CompletedLine.read! @valid_line
+    assert_equal @valid_db_time, Plog::CompletedLine.db_time
+  end
+
+  # ============================================================================
+  # TIME RETRIVAL ( when only db time is present )
+  # ============================================================================
+
+  should 'retrive correct total time (only db)' do
+    Plog::CompletedLine.read! @valid_line_no_view
+    assert_equal @valid_total_time_no_view, Plog::CompletedLine.total_time
+  end
+
+  should 'retrive correct view time (only db)' do
+    Plog::CompletedLine.read! @valid_line_no_view
+    assert_equal @valid_view_time_no_view, Plog::CompletedLine.view_time
+  end
+
+  should 'retrive correct db time (only db)' do
+    Plog::CompletedLine.read! @valid_line_no_view
+    assert_equal @valid_db_time_no_view, Plog::CompletedLine.db_time
+  end
+
+  # ============================================================================
+  # CSV COMPILATION
+  # ============================================================================
+
+  should 'export to csv' do
+    Plog::CompletedLine.read! @valid_line
+    assert_equal @valid_csv_line, Plog::CompletedLine.to_csv
+  end
+
+  # ============================================================================
+  # COMPLETED LINE DETECTION
+  # ============================================================================
+
+  should 'ignore *NON* completed lines' do
+    Plog::CompletedLine.read! 'completed'
+    assert_equal false, Plog::CompletedLine.completed_line?
+
+    Plog::CompletedLine.read! 'Completed'
+    assert_equal false, Plog::CompletedLine.completed_line?
+
+    Plog::CompletedLine.read! 'Completed Completed  Completed Completed'
+    assert_equal false, Plog::CompletedLine.completed_line?
+
+    Plog::CompletedLine.read! 'aalsdjflasdjflsa dflksjdflkasjdf lfCompleted'
+    assert_equal false, Plog::CompletedLine.completed_line?
+
+    Plog::CompletedLine.read! nil
+    assert_equal false, Plog::CompletedLine.completed_line?
+
+    Plog::CompletedLine.read! false
+    assert_equal false, Plog::CompletedLine.completed_line?
+
+    Plog::CompletedLine.read! 0
+    assert_equal false, Plog::CompletedLine.completed_line?
+
+    Plog::CompletedLine.read!  ''
+    assert_equal false, Plog::CompletedLine.completed_line?
+  end
+
+  # ============================================================================
+  # STATUS EXTRACTION
+  # ============================================================================
+
+  should 'extract status string' do
+    Plog::CompletedLine.read! @valid_line
+    assert_equal @valid_status_string, Plog::CompletedLine.status_string
+  end
+
+  should 'extract status number' do
+    Plog::CompletedLine.read! @valid_line
+    assert_equal @valid_status_number, Plog::CompletedLine.status_number
+  end
+
+end

data/test/data/example.log

@@ -0,0 +1,10 @@
+Completed in 7ms (View: 4, DB: 3) | 200 OK [http://www.example.com/users/12972]
+Completed in 7ms (View: 4, DB: 3) | 200 OK [http://www.example.com/users/12972]
+Completed in 7ms (View: 4, DB: 3) | 200 OK [http://www.example.com/users/12972]
+Completed in 7ms (View: 4, DB: 3) | 200 OK [http://www.example.com/users/12972]
+Completed in 7ms (View: 4, DB: 3) | 200 OK [http://www.example.com/users/12972]
+Completed in 7ms (View: 4, DB: 3) | 200 OK [http://www.example.com/users/12972]
+Completed in 7ms (View: 4, DB: 3) | 200 OK [http://www.example.com/users/12972]
+Completed in 7ms (View: 4, DB: 3) | 200 OK [http://www.example.com/users/12972]
+Completed in 7ms (View: 4, DB: 3) | 200 OK [http://www.example.com/users/12972]
+Completed in 7ms (View: 4, DB: 3) | 200 OK [http://www.example.com/users/12972]

data/test/log_file_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class LogFileTest < Test::Unit::TestCase
+
+  def setup
+    @log_file = 'test/data/example.log'
+    @dump_dir = 'plog'
+    @file = Plog::LogFile.new(@log_file, @dump_dir)
+    @object_hash = 'a1e0e00d04e82bdf0f1ac151de03591c'
+    @subdir = 'plog/objects'
+    @object_path =  @subdir + '/' + @object_hash
+    @final_csv_result = '10,70,40,30,/users/[0-9]'
+    @default_object_path = 'plog/objects/2a5565416b0c92c6c5081342322bf945'
+  end
+
+  def teardown
+    @file.close
+  end
+
+  should 'generate an appropriate object_path' do
+    assert_equal @default_object_path, @file.object_path
+    assert_equal @subdir, @file.objects_recipient_path
+  end
+
+  def whipe_out_objects_dir
+    Dir.glob('./plog/objects/*').each do |file|
+      FileUtils.rm_r(file, :force => true)
+    end
+    FileUtils.rmdir './plog/objects'
+  end
+
+  should 'parse data appropriately' do
+    whipe_out_objects_dir
+    @file = Plog::LogFile.new(@log_file, @dump_dir)
+    @file.parse_completed_lines!
+    assert_equal @final_csv_result, File.new(@object_path).read.chomp
+  end
+
+end

data/test/object_file_test.rb

@@ -0,0 +1,115 @@
+require 'test_helper'
+
+class ObjectFileTest < Test::Unit::TestCase
+
+  def setup
+    @testing_filename = 'kazu.test'
+    @file = Plog::ObjectFile.new(@testing_filename, 'w+')
+    @default_serialized_data = '0,0,0,0,default'
+
+    @changed_hits = 1
+    @changed_total_time = 2
+    @changed_view_time = 3
+    @changed_db_time = 4
+    @changed_simplified_url = 'http://example.com'
+    @changed_serialized_data = '1,2,3,4,http://example.com'
+    @changed_serialized_data_twice = '2,4,6,8,http://example.com'
+
+    @export_data = '1         0.002     0.002     0.004     0.004     0.003     0.003     http://example.com                      '
+  end
+
+  def teardown
+    @file.close unless @skip_close
+  end
+
+  should 'load default values on initialization' do
+    assert_equal 'default', @file.simplified_url
+    assert_equal 0, @file.view_time
+    assert_equal 0, @file.db_time
+    assert_equal 0, @file.total_time
+    assert_equal 0, @file.total_hits
+  end
+
+  should 'serialize changes correctly' do
+    assert_equal @default_serialized_data, @file.serialize_changes
+  end
+
+  # ============================================================================
+  # DATA APPENDING
+  # ============================================================================
+
+  should 'increment view time correctly' do
+    @file.append_view_time 500
+    assert_equal 500, @file.view_time
+    @file.append_view_time 500
+    assert_equal 1000, @file.view_time
+  end
+
+  should 'increment db time correctly' do
+    @file.append_db_time 500
+    assert_equal 500, @file.db_time
+    @file.append_db_time 500
+    assert_equal 1000, @file.db_time
+  end
+
+  should 'increment total time correctly' do
+    @file.append_total_time 500
+    assert_equal 500, @file.total_time
+    @file.append_total_time 500
+    assert_equal 1000, @file.total_time
+  end
+
+  should 'increment hits count correctly' do
+    @file.append_hits 500
+    assert_equal 500, @file.total_hits
+    @file.append_hits 500
+    assert_equal 1000, @file.total_hits
+  end
+
+  # ============================================================================
+  # DATA STORAGE
+  # ============================================================================
+
+  should 'store default data correctly if nothing is given' do
+    @file.save_changes!
+    @file.close
+    @skip_close = true
+    stored_data = File.new(@testing_filename).read.chomp
+    assert_equal @default_serialized_data, stored_data
+  end
+
+  def alter_data
+    @file.append_hits @changed_hits
+    @file.append_db_time @changed_db_time
+    @file.append_view_time @changed_view_time
+    @file.append_total_time @changed_total_time
+    @file.simplified_url = @changed_simplified_url
+  end
+
+  # ============================================================================
+  # DATA LOADING
+  # ============================================================================
+
+  should 'store altered data & retrive correctly' do
+    alter_data
+    @file.save_changes!
+    @file.close
+    @skip_close = true
+
+    @file = Plog::ObjectFile.new(@testing_filename, 'w+')
+    assert_equal @changed_total_time, @file.total_time, 'total'
+    assert_equal @changed_view_time, @file.view_time, 'view'
+    assert_equal @changed_db_time, @file.db_time, 'db'
+    assert_equal @changed_hits, @file.total_hits, 'hits'
+  end
+
+  # ============================================================================
+  # DATA EXPORTS
+  # ============================================================================
+
+  should 'export data correctly' do
+    alter_data
+    assert_equal @export_data, @file.export
+  end
+
+end

data/test/plog_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class PlogTest < Test::Unit::TestCase
+
+  should 'do notin' do
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'plog'
+
+class Test::Unit::TestCase
+end

data/test/url_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class URLTest < Test::Unit::TestCase
+
+  def setup
+    @valid_line = 'Completed in 5ms (View: 4, DB: 1) | 200 OK [http://www.example.com/users/12972]'
+    @valid_url = 'http://www.example.com/users/12972'
+    @url = Plog::URL.new(@valid_url)
+  end
+
+  should 'return a valid url object when instantiated' do
+    assert_equal @valid_url, @url.to_s
+  end
+
+  should 'simplify correctly' do
+    assert_equal '/users/[0-9]', @url.simplify
+  end
+
+  should 'simplify removing arguments' do
+    @url = Plog::URL.new('http://www.example.com/users/1234?key1=val1&key2=val2')
+    assert_equal '/users/[0-9]?', @url.simplify
+  end
+
+  should 'hashify correctly' do
+    assert_equal '2a5565416b0c92c6c5081342322bf945', @url.hashify
+  end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: plog
+version: !ruby/object:Gem::Version 
+  version: 0.2.4
+platform: ruby
+authors: 
+- Kazuyoshi Tlacaelel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-09 00:00:00 +09:00
+default_executable: plog
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Plog - Ruby on Rails production log statistic generator. by Kazuyoshi Tlacaelel
+email: kazu.dev@gmail.com
+executables: 
+- plog
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/plog
+- lib/cli.rb
+- lib/completed_line.rb
+- lib/log_file.rb
+- lib/object_file.rb
+- lib/plog.rb
+- lib/url.rb
+- plog.gemspec
+- test/completed_line_test.rb
+- test/data/example.log
+- test/log_file_test.rb
+- test/object_file_test.rb
+- test/plog_test.rb
+- test/test_helper.rb
+- test/url_test.rb
+has_rdoc: true
+homepage: http://github.com/ktlacaelel/plog
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Plog - Ruby on Rails production log statistic generator. by Kazuyoshi Tlacaelel
+test_files: 
+- test/completed_line_test.rb
+- test/log_file_test.rb
+- test/object_file_test.rb
+- test/plog_test.rb
+- test/test_helper.rb
+- test/url_test.rb