log_parser 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0266c27679963d92c477416724cc2f4d6c6c31e
-  data.tar.gz: de90fce1a04226daed8bec5569f1ed346404affc
+  metadata.gz: fb1f9e6441835510f872d57775b0a110af39da64
+  data.tar.gz: f66ab92bb2d953afd409289012f6ab55996f8192
 SHA512:
-  metadata.gz: 4017645035ace98a41365b214824fb574f43f8046e1b2bd7720da9b904294fea8db2ba54ea8ab8f9478e1ea627b55c94612ef23c42d5e4fcc6fac709fa4ae434
-  data.tar.gz: d20d3857914ae340fb92e4bbf8d1c09120cb761a2ac2d17bf0286fe8905317c26e2270e11a6036bbfbdd74fc5812a15cb2fe460dfae797c8b88f901427fb2072
+  metadata.gz: 28f051e09df01a61e4030debadd7ccdff952a3e7e5db684f9edb92d0fd8959c96d8d9ca4daa7bb56905ffa0c1156d65ae1e61b76fd34a43afea918f378cbc4aa
+  data.tar.gz: 66e4fab78c195b9f1fe2622b1059e0ddc1da9b78f6d8dec9fce3b678cb1a30697fcf2f5ed2516550e720d372b76d99c11aabf65bfb028d26a4164524a6e6c164

data/Rakefile

@@ -1,2 +1,9 @@
 require "bundler/gem_tasks"
+require 'rake'
+require 'rake/testtask'
 
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+end

data/lib/log_parser/client.rb

@@ -0,0 +1,157 @@
+module LogParser
+  class Client
+    #
+    # = Class
+    #
+    # Filter lines from the log file by chaining methods together:
+    #
+    #   log = LogParser::Client.new('open_table.log')
+    #   log.errors.by_message('authentication failed').since(1.day.ago)
+    #   #=> ["[2014-11-13T23:12:14-07:00] ERROR [page_id 95239] Authentication failed with token ..."]
+    #
+
+    LINE_PATTERN = %r{
+                    \[(\d+-\d+-\d+T\d+:\d+:\d+-\d+:\d+)\] # timestamp
+                    (\s(\w+):)?                           # type of message (ERROR, WARNING, INFO)
+                    (\s\[(.+)\])?                         # prefix (introduced by log.rb)
+                    \s(.+)$                               # message body
+                  }x
+
+    attr_reader :file
+    attr_writer :lines
+
+    #
+    # @param [String|Pathname] log name of the file in 'log' directory or a Pathname object
+    # @param [Hash] options optional parameters
+    # @option :line_items is an array of LineItem objects
+    # @option :pattern a custom pattern to use for matching lines
+    #
+    def initialize(log = '', options = {})
+      @file = log.is_a?(String) ? LogParser.path_for(log) : log
+      @lines = options.fetch :line_items, []
+      @pattern = options.fetch :pattern, LINE_PATTERN
+    end
+
+    #
+    # Chainable
+    #
+
+    def errors
+      by_type('ERROR')
+    end
+
+    def warnings
+      by_type('WARNING')
+    end
+
+    def infos
+      by_type('INFO')
+    end
+
+    def since(timestamp)
+      chain do |items|
+        for line in lines
+          items << line if DateTime.parse(line.timestamp) > timestamp
+        end
+      end
+    end
+
+    def by_message(text)
+      chain do |items|
+        for line in lines
+          items << line if line.message =~ Regexp.new(text, Regexp::IGNORECASE)
+        end
+      end
+    end
+
+    def by_prefix(name)
+      chain do |items|
+        for line in lines
+          items << line if line.prefix == name
+        end
+      end
+    end
+
+    def by_type(name)
+      chain do |items|
+        for line in lines
+          items << line if line.type == name
+        end
+      end
+    end
+
+    #
+    # Non-chainable Helpers
+    #
+
+    def prefixes
+      items = Set.new
+      lines.each { |line| items << line.prefix }
+      items.to_a.compact
+    end
+
+    def uniq
+      lines.uniq(&:full_message)
+    end
+
+    def timestamps
+      lines.map(&:timestamp)
+    end
+
+    def messages
+      lines.map(&:message)
+    end
+
+    def strings
+      lines.map(&:to_s)
+    end
+
+    def count
+      lines.count
+    end
+
+    def sort
+      lines.sort
+    end
+
+    #
+    # Default overrides
+    #
+
+    def to_s
+      Array(@lines).map(&:to_s).to_s
+    end
+
+    alias inspect to_s
+
+    #
+    # Private
+    #
+
+    def scan
+      line_items = []
+      File.open(file) do |f|
+        line = nil
+        begin
+          line = f.gets
+          line_items << LineItem.new($1, $3, $5, $6) if line =~ @pattern
+        end while line
+      end
+      line_items
+    end
+
+    def chain
+      items = []
+      yield items
+      self.class.new(file, line_items: items)
+    end
+
+    def lines
+      @lines = scan if @lines.nil? || @lines.empty?
+      @lines
+    end
+
+    alias to_a lines
+  end
+
+end

data/lib/log_parser/line_item.rb

@@ -0,0 +1,19 @@
+module LogParser
+  class LineItem < Struct.new(:timestamp, :type, :prefix, :message)
+    def to_s
+      s = "[#{timestamp}] "
+      s << "#{type}: " if type
+      s << "[#{prefix}] " if prefix
+      s << "#{message}"
+      s
+    end
+
+    def full_message
+      prefix ? "[#{prefix}] #{message}" : message
+    end
+
+    def <=>(other)
+      timestamp <=> other.timestamp
+    end
+  end
+end

data/lib/log_parser/version.rb

@@ -1,3 +1,3 @@
-class LogParser
-  VERSION = '0.0.1'.freeze
+module LogParser
+  VERSION = '0.1.0'.freeze
 end

data/lib/log_parser.rb

@@ -1,158 +1,13 @@
-require "log_parser/version"
+require 'log_parser/version'
+require 'log_parser/line_item'
+require 'log_parser/client'
 
-class LogParser
-  #
-  # = Class
-  #
-  # Filter lines from the log file by chaining methods together:
-  #
-  #   log = LogParser.new('open_table.log')
-  #   log.errors.by_message('authentication failed').since(1.day.ago)
-  #   #=> ["[2014-11-13T23:12:14-07:00] ERROR [page_id 95239] Authentication failed with token ..."]
-  #
-
-  LINE_PATTERN = %r{
-                    \[(\d+-\d+-\d+T\d+:\d+:\d+-\d+:\d+)\] # timestamp
-                    (\s(\w+):)?                           # type of message (ERROR, WARNING, INFO)
-                    (\s\[(.+)\])?                         # prefix (introduced by log.rb)
-                    \s(.+)$                               # message body
-                  }x
-
-  attr_reader :file_path
-  attr_writer :lines
-
-  # @param log [String|Pathname] The file name in the log directory or a pathname to a log file
-  # @param line_items [Array] (optional) An array of LineItems
-  def initialize(log = '', line_items = [])
-    @file_path = log.is_a?(String) ? Rails.root.join('log', log) : log
-    @lines = line_items
-  end
-
-  #
-  # Chainable
-  #
-
-  def errors
-    by_type('ERROR')
-  end
-
-  def warnings
-    by_type('WARNING')
-  end
-
-  def infos
-    by_type('INFO')
-  end
-
-  def by_message(text)
-    chain do |items|
-      for line in lines
-        items << line if line.message =~ Regexp.new(text, Regexp::IGNORECASE)
-      end
-    end
-  end
-
-  def since(timestamp)
-    chain do |items|
-      for line in lines
-        items << line if DateTime.parse(line.timestamp) > timestamp
-      end
-    end
-  end
-
-  def by_prefix(name)
-    chain do |items|
-      for line in lines
-        items << line if line.prefix == name
-      end
-    end
-  end
-
-  def by_type(name)
-    chain do |items|
-      for line in lines
-        items << line if line.type == name
-      end
-    end
-  end
-
-  #
-  # Helpers
-  #
-
-  def prefixes
-    items = Set.new
-    lines.each { |line| items << line.prefix }
-    items.to_a.compact
-  end
-
-  def timestamps
-    lines.map(&:timestamp)
-  end
-
-  def messages
-    lines.map(&:message)
-  end
-
-  def strings
-    lines.map(&:to_s)
-  end
-
-  def count
-    lines.count
-  end
-
-  def uniq
-    lines.uniq { |line| line.full_message }
-  end
-
-  def to_s
-    Array(@lines).map(&:to_s).to_s
+module LogParser
+  def self.root
+    File.expand_path('../..', __FILE__)
   end
 
-  alias inspect to_s
-
-  #
-  # Private
-  #
-
-  def scan
-    line_items = []
-    File.open(file_path) do |f|
-      while line = f.gets
-        line_items << LineItem.new($1, $3, $5, $6) if line =~ LINE_PATTERN
-      end
-    end
-    line_items
-  end
-
-  def chain
-    items = []
-    yield items
-    self.class.new(file_path, items)
-  end
-
-  def lines
-    @lines.presence || scan
-  end
-
-  alias to_a lines
-
-  class LineItem < Struct.new(:timestamp, :type, :prefix, :message)
-    def to_s
-      s = "[#{timestamp}] "
-      s << "#{type}: " if type
-      s << "[#{prefix}] " if prefix
-      s << "#{message}"
-      s
-    end
-
-    def full_message
-      prefix ? "[#{prefix}] #{message}" : message
-    end
-
-    def <=>(other)
-      timestamp <=> other.timestamp
-    end
+  def self.path_for(file)
+    Pathname.new(File.join(root, 'log', file))
   end
 end

data/test/log_parser/client_test.rb

@@ -0,0 +1,13 @@
+require 'pathname'
+require 'minitest/autorun'
+require 'log_parser'
+
+class LogParser::ClientTest < MiniTest::Unit::TestCase
+
+  def test_initialize_with_string
+    @log = LogParser::Client.new('production.log')
+    assert_kind_of Pathname, @log.file_path
+    assert_equal '/log', @log.file_path.to_s
+  end
+
+end

data/test/log_parser/line_item_test.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+require 'log_parser/line_item'
+
+class LineItemTest < MiniTest::Unit::TestCase
+
+  def test_full_message
+    assert_equal '', ''
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2014-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -51,8 +51,12 @@ files:
 - README.md
 - Rakefile
 - lib/log_parser.rb
+- lib/log_parser/client.rb
+- lib/log_parser/line_item.rb
 - lib/log_parser/version.rb
 - log_parser.gemspec
+- test/log_parser/client_test.rb
+- test/log_parser/line_item_test.rb
 homepage: https://github.com/ridiculous
 licenses:
 - MIT
@@ -77,4 +81,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Easily search log files
-test_files: []
+test_files:
+- test/log_parser/client_test.rb
+- test/log_parser/line_item_test.rb