ktlacaelel-plog 0.0.3 → 0.1.0

data/README.rdoc

@@ -1,13 +1,27 @@
-= plog
+= Plog
+
+Ruby on Rails *Production-Log* statistics generator.
+by Kazuyoshi Tlacaelel.
+
+== Usage:
+
+    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/
 
-Description goes here.
 
 == Note on Patches/Pull Requests
- 
+
+* Send me a brief message
 * 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.
+* 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)
@@ -16,3 +30,5 @@ Description goes here.
 == Copyright
 
 Copyright (c) 2009 Kazuyoshi Tlacaelel. See LICENSE for details.
+
+The end.

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.1.0

data/bin/plog

@@ -19,4 +19,4 @@ USAGE:
 '
 
 abort banner if ARGV.size != 1
-Plog::Cli.new(ARGV[0]).run!
+Plog::Cli.new(ARGV[0], 'plog').run!

data/lib/cli.rb

@@ -2,19 +2,20 @@ module Plog
 
   class Cli
 
-    attr_reader :directory, :log_files
+    attr_reader :source_directory, :log_files
 
-    LOG_FILE = 'log_statistics.txt'
+    LOG_FILE = 'statistics.txt'
 
     # ==========================================================================
     # CLIENT INTERFACE
     # ==========================================================================
 
-    def initialize(directory)
-      @directory = directory
+    def initialize(source_directory, target_directory)
       @log_files = []
-      validate!
-      load_log_files!
+      @source_directory = source_directory
+      @target_directory = target_directory
+      check_directory_consistency!
+      preload_log_files!
     end
 
     def run!
@@ -45,37 +46,46 @@ module Plog
     end
 
     def parse_object_files
-      Dir.glob('objects/*').each do |object_file|
-        file = File.new(LOG_FILE, 'a+')
+      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, LOG_FILE)
+    end
+
     def destroy_old_log_file
-      FileUtils.touch LOG_FILE
-      FileUtils.rm LOG_FILE
+      FileUtils.touch statistic_file_path
+      FileUtils.rm statistic_file_path
     end
 
     def append_headers_to_log_file
-      file = File.new(LOG_FILE, 'a+')
+      file = File.new(statistic_file_path, 'a+')
       file.puts trim(ObjectFile.formated_headers)
       file.close
     end
 
-    def validate!
-      abort directory_not_found_banner unless File.exist? @directory
+    def check_directory_consistency!
+      abort directory_not_found_banner unless File.exist? @source_directory
     end
 
-    def load_log_files!
-      Dir.glob(File.join(@directory, '*.log')).each do |log_file|
-        @log_files << LogFile.new(log_file)
+    def preload_log_files!
+      Dir.glob(File.join(@source_directory, '*.log')).each do |log_file|
+        puts @target_directory
+        @log_files << LogFile.new(log_file, @target_directory)
         stdout loading_log_file_banner(log_file)
       end
     end
 
     def stdout(string)
-      puts ' ** ' + string
+      puts ' ---> ' + string
     end
 
     # ==========================================================================
@@ -83,10 +93,8 @@ module Plog
     # ==========================================================================
 
     def notice_banner
-      '
-      NOTICE:
-
-      Parsing logs, this may take a logn-while go get yourself a coffe!
+      'Parsing logs...
+      This may take a long-while, go get yourself a coffee!
       While I hanlde this stuff for you.
       '
     end
@@ -104,7 +112,7 @@ module Plog
     end
 
     def directory_not_found_banner
-      'No such dir: %s' % @directory
+      'No such dir: %s' % @source_directory
     end
 
   end

data/lib/completed_line.rb

@@ -97,7 +97,6 @@ module Plog
     end
 
     def self.extract_status_number_and_string
-      return 0 unless STATUS_REGEX =~ @second_fragment
       @second_fragment.gsub(STATUS_REGEX, '\2,\4').split(',')
     end
 

data/lib/log_file.rb

@@ -2,18 +2,21 @@ module Plog
 
   class LogFile < File
 
-    DUMP_DIR = 'objects'
-
     attr_accessor :name
 
-    def initialize(file)
-      unless File.exist? DUMP_DIR
-        Dir.mkdir DUMP_DIR
-      end
+    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
@@ -21,12 +24,11 @@ module Plog
     def parse_completed_lines!
       each_line do |line|
         CompletedLine.read! line
-        parse_completed_line
+        parse_completed_line if CompletedLine.valid?
       end
     end
 
     def parse_completed_line
-      return unless CompletedLine.valid?
       of = ObjectFile.new(object_path, 'w+')
       of.simplified_url = CompletedLine.url.simplify
       of.append_total_time CompletedLine.total_time
@@ -38,7 +40,11 @@ module Plog
     end
 
     def object_path
-      File.join(DUMP_DIR, CompletedLine.url.hashify)
+      File.join(objects_recipient_path, CompletedLine.url.hashify)
+    end
+
+    def objects_recipient_path
+      @objects_recipient_path ||= File.join(@dump_dir, 'objects')
     end
 
   end

data/plog.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{plog}
-  s.version = "0.0.3"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kazuyoshi Tlacaelel"]

data/test/log_file_test.rb

@@ -4,11 +4,13 @@ class LogFileTest < Test::Unit::TestCase
 
   def setup
     @log_file = 'test/data/example.log'
-    @file = Plog::LogFile.new(@log_file)
+    @dump_dir = 'plog'
+    @file = Plog::LogFile.new(@log_file, @dump_dir)
     @object_hash = 'a1e0e00d04e82bdf0f1ac151de03591c'
-    @object_path = 'objects/' + @object_hash
+    @subdir = 'plog/objects'
+    @object_path =  @subdir + '/' + @object_hash
     @final_csv_result = '10,70,40,30,/users/[0-9]'
-    @default_object_path = 'objects/2a5565416b0c92c6c5081342322bf945'
+    @default_object_path = 'plog/objects/2a5565416b0c92c6c5081342322bf945'
   end
 
   def teardown
@@ -17,18 +19,19 @@ class LogFileTest < Test::Unit::TestCase
 
   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('./objects/*').each do |file|
+    Dir.glob('./plog/objects/*').each do |file|
       FileUtils.rm_r(file, :force => true)
     end
-    FileUtils.rmdir './objects'
+    FileUtils.rmdir './plog/objects'
   end
 
   should 'parse data appropriately' do
     whipe_out_objects_dir
-    @file = Plog::LogFile.new(@log_file)
+    @file = Plog::LogFile.new(@log_file, @dump_dir)
     @file.parse_completed_lines!
     assert_equal @final_csv_result, File.new(@object_path).read.chomp
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ktlacaelel-plog
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kazuyoshi Tlacaelel
@@ -55,7 +55,6 @@ files:
 - test/url_test.rb
 has_rdoc: false
 homepage: http://github.com/ktlacaelel/plog
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -76,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: Plog - Ruby on Rails production log statistic generator. by Kazuyoshi Tlacaelel