logfile_interval 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4eb614cbe0e43877376ccae43e38b666c3b58270
-  data.tar.gz: 723459738582e7da66b6d53e0f5ce43965576a6c
+  metadata.gz: 704912eefe0f7a801ed450cf303e2fa9ef7fe4d1
+  data.tar.gz: 08108c223fd1d1cbf1069963289a360d5691b302
 SHA512:
-  metadata.gz: 4d799b181c1d65abaa35910b49c4efa85a31aefc44d009c0ee3c6966979206cec31acd09ffb1cbd97544ec74798a872d7906f43b57758a51e910e1f499935b8b
-  data.tar.gz: 21a2d6737ac8d3e92ed6b40dbba0f18d424ecddfac1678c9c067fafb7ea7db1e1fcde234a5fe66cc09c3d1da1077acc14a354ce0eef42bdaed2fbb6e1b16d3ce
+  metadata.gz: 318f6ca2c18baf0d3155051d37d1de8a406d8b631bba9ffe50067e31230369178992bd089808899ba96e476f9a76b2373b14feb41eb31717446bee3e36bfe24a
+  data.tar.gz: 88d9243b530a0bf9dbff4ec81dadefe05bce00c14d8e61841c04e6f096be7960b398ed37719ffa61421dff21c91f5c101bb9d6a10129f6743d955fff881d8ccc

data/.gitignore

@@ -6,6 +6,7 @@
 .kateproject
 InstalledFiles
 _yardoc
+Gemfile.lock
 coverage
 doc/
 lib/bundler/man

data/.travis.yml

@@ -2,5 +2,5 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.2
 script: bundle exec rspec spec

data/lib/logfile_interval/interval.rb

@@ -6,7 +6,6 @@ module LogfileInterval
     class OutOfRange < StandardError; end
 
     def initialize(end_time, length, parser_columns)
-      raise ArgumentError, 'end_time must be round' unless (end_time.to_i % length.to_i == 0)
       @end_time   = end_time
       @start_time = end_time - length
       @length     = length
@@ -21,7 +20,10 @@ module LogfileInterval
     end
 
     def to_hash
-      @aggregators.to_hash
+      h = @aggregators.to_hash
+      h[:start_time] = self.start_time
+      h[:end_time] = self.end_time
+      h
     end
 
     def add_record(record)

data/lib/logfile_interval/interval_builder/ascending.rb

@@ -3,7 +3,7 @@ module LogfileInterval
     module Ascending
       def create_first_interval
         first_record = parsed_lines_enum.first
-        interval_end_time = upper_boundary_time(first_record.time)
+        interval_end_time = end_boundary_time(first_record.time)
         Interval.new(interval_end_time, length, parser_columns)
       end
 

data/lib/logfile_interval/interval_builder/descending.rb

@@ -2,7 +2,7 @@ module LogfileInterval
   class IntervalBuilder
     module Descending
       def create_first_interval
-        interval_end_time = lower_boundary_time(Time.now)
+        interval_end_time = start_boundary_time(Time.now)
         Interval.new(interval_end_time, length, parser_columns)
       end
 

data/lib/logfile_interval/interval_builder.rb

@@ -5,11 +5,19 @@ module LogfileInterval
   class IntervalBuilder
     attr_reader :parsed_lines_enum, :parser_columns, :length
 
-    def initialize(parsed_lines_enum, parser_columns, length)
+    def initialize(parsed_lines_enum, parser_columns, length, options = {})
       @parsed_lines_enum = parsed_lines_enum
       @parser_columns    = parser_columns
       @length            = length
 
+      raise ArgumentError if options.include?(:boundary_offset) && options.include?(:offset_by_start_time)
+
+      @boundary_offset      = options.fetch(:boundary_offset, 0)
+      offset_by_start_time  = options.fetch(:offset_by_start_time, nil)
+      if offset_by_start_time
+        @boundary_offset = offset_by_start_time.to_i % length
+      end
+
       case order
       when :asc  then self.extend Ascending
       when :desc then self.extend Descending
@@ -37,18 +45,18 @@ module LogfileInterval
       each_interval.first
     end
 
-    private
-
-    def lower_boundary_time(t)
-      secs = (t.to_i / length.to_i) * length.to_i
+    def start_boundary_time(t)
+      secs = ((t.to_i - @boundary_offset) / length.to_i) * length.to_i + @boundary_offset
       Time.at(secs)
     end
 
-    def upper_boundary_time(t)
-      secs = (t.to_i / length.to_i + 1) * length.to_i
+    def end_boundary_time(t)
+      secs = ((t.to_i - @boundary_offset)/ length.to_i + 1) * length.to_i + @boundary_offset
       Time.at(secs)
     end
 
+    private
+
     def order
       return @order if @order
       num_lines = 0

data/lib/logfile_interval/logfile_set.rb

@@ -4,10 +4,11 @@ module LogfileInterval
 
     ORDER_VALID_VALUES = [ :asc, :desc ]
 
-    def initialize(filenames, parser, order = :desc)
+    def initialize(filenames, parser, order = :desc, &file_time_finder_block)
       @parser    = parser
       @filenames = filenames
       @order    = order
+      @file_time_finder_block = file_time_finder_block if block_given?
 
       raise ArgumentError, "invalid order value: #{@order}" unless ORDER_VALID_VALUES.include?(@order.to_sym)
     end
@@ -56,8 +57,13 @@ module LogfileInterval
 
     def time_for_files(filenames)
       filenames.inject({}) do |h, filename|
-        file = Logfile.new(filename, parser)
-        h[filename] = file.first_timestamp
+        if @file_time_finder_block
+          t = @file_time_finder_block.call(filename)
+        else
+          file = Logfile.new(filename, parser)
+          t = file.first_timestamp
+        end
+        h[filename] = t
         h
       end
     end

data/lib/logfile_interval/version.rb

@@ -1,3 +1,3 @@
 module LogfileInterval
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/logfile_interval.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "debugger", [">= 0"]
+  spec.add_development_dependency "byebug", [">= 0"] if RUBY_VERSION >= '2.0.0'
   spec.add_development_dependency "rspec", ["~> 2.14.0"]
   spec.add_development_dependency "rake"
   spec.add_development_dependency "simplecov"

data/spec/lib/interval_builder_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+
 require File.join(File.dirname(__FILE__), '..', 'support/lib/timing_log')
 
 module LogfileInterval
@@ -37,6 +38,55 @@ module LogfileInterval
       end
     end
 
+    describe :boundary_offset do
+      it 'returns the start of the interval on a round boundary' do
+        set = LogfileSet.new(@logfiles, ParsedLine::TimingLog)
+        builder = IntervalBuilder.new(set, ParsedLine::TimingLog, 60)
+        expect(builder.start_boundary_time(Time.new(2013,12,01,16,0,1))).to eql(Time.new(2013,12,01,16,0,0))
+      end
+
+      it 'first interval is aligned on round boundary' do
+        Time.stub(:now).and_return(Time.new(2013,12,01,16,0,1,'-08:00'))
+        set = LogfileSet.new(@logfiles, ParsedLine::TimingLog)
+        builder = IntervalBuilder.new(set, ParsedLine::TimingLog, 3600)
+        builder.first_interval.start_time.should == Time.new(2013,12,01,15,0,0,'-08:00')
+      end
+
+      context 'with offset' do
+        it 'returns the start of the interval on an offset boundary' do
+          set = LogfileSet.new(@logfiles, ParsedLine::TimingLog)
+          builder = IntervalBuilder.new(set, ParsedLine::TimingLog, 60, boundary_offset: 5)
+          expect(builder.start_boundary_time(Time.new(2013,12,01,16,0,1))).to eql(Time.new(2013,12,01,15,59,05))
+        end
+
+        it 'first interval is aligned on round boundary' do
+          Time.stub(:now).and_return(Time.new(2013,12,01,17,1,1,'-08:00'))
+          set = LogfileSet.new(@logfiles, ParsedLine::TimingLog)
+          builder = IntervalBuilder.new(set, ParsedLine::TimingLog, 3600, boundary_offset: 300)
+          builder.first_interval.start_time.should == Time.new(2013,12,01,15,05,0,'-08:00')
+          builder = IntervalBuilder.new(set, ParsedLine::TimingLog, 3600, boundary_offset: 60)
+          builder.first_interval.start_time.should == Time.new(2013,12,01,16,01,0,'-08:00')
+        end
+      end
+    end
+
+    describe :offset_by_start_time do
+      it 'returns the start of the interval on an offset boundary' do
+        set = LogfileSet.new(@logfiles, ParsedLine::TimingLog)
+        builder = IntervalBuilder.new(set, ParsedLine::TimingLog, 60, offset_by_start_time: Time.new(2013,12,01,15,59,05))
+        expect(builder.start_boundary_time(Time.new(2013,12,01,16,0,1))).to eql(Time.new(2013,12,01,15,59,05))
+      end
+
+      it 'first interval is aligned on round boundary' do
+        Time.stub(:now).and_return(Time.new(2013,12,01,17,1,1,'-08:00'))
+        set = LogfileSet.new(@logfiles, ParsedLine::TimingLog)
+        builder = IntervalBuilder.new(set, ParsedLine::TimingLog, 3600, offset_by_start_time: Time.new(2013,12,01,16,05,0))
+        builder.first_interval.start_time.should == Time.new(2013,12,01,15,05,0,'-08:00')
+        builder = IntervalBuilder.new(set, ParsedLine::TimingLog, 3600, offset_by_start_time: Time.new(2013,12,01,15,01,0))
+        builder.first_interval.start_time.should == Time.new(2013,12,01,16,01,0,'-08:00')
+      end
+    end
+
     describe :each_interval do
       context 'without a block' do
         it 'returns an enumerator' do

data/spec/lib/interval_spec.rb

@@ -33,6 +33,14 @@ module LogfileInterval
         hinterval.keys.should include(:ip, :total_time, :action, :num_bytes, :rss)
       end
 
+      it 'has start_time and end_time keys' do
+        record   = ParsedLine::TimingLog.create_record('1385942400, 192.168.0.5, posts#index, 100, 2000, 53.0')
+        interval = Interval.new(@end_time, @length, ParsedLine::TimingLog.columns)
+        interval.add_record(record)
+        hinterval = interval.to_hash
+        hinterval.keys.should include(:start_time, :end_time)
+      end
+
       it 'with no data, should have keys with 0 values' do
         interval = Interval.new(@end_time, @length, ParsedLine::TimingLog.columns)
         hinterval = interval.to_hash

data/spec/lib/logfile_set_spec.rb

@@ -13,10 +13,6 @@ module LogfileInterval
       @last_line  = '12.24.48.96 - - [23/Jun/2013:16:49:00 -0800] "GET /package/core/raring/universe/proposed/bash HTTP/1.1" 200 4555 "-" "Bing)"'
     end
 
-    it 'ordered_filenames should return the most recent file first' do
-      @set.ordered_filenames.should == @logfiles.reverse
-    end
-
     describe :each_line do
       it 'should enumerate each line in file backwards' do
         lines = []
@@ -82,5 +78,22 @@ module LogfileInterval
         end
       end
     end
+
+    describe :ordered_filenames do
+      it 'returns the most recent file first' do
+        @set.ordered_filenames.should == @logfiles.reverse
+      end
+
+      context 'with file_time_finder_block' do
+        it 'sorts the files in the order described in the block' do
+          set = LogfileSet.new(@logfiles, ParsedLine::AccessLog) do |filename|
+            filename.match /(?<num>\d+$)/ do |matchdata|
+              matchdata[:num].to_i
+            end
+          end
+          set.ordered_filenames.should == @logfiles
+        end
+      end
+    end
   end
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: logfile_interval
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Philippe Le Rohellec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
+date: 2014-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Logfile parser and aggregator
@@ -89,10 +89,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -150,17 +149,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Aggregate logfile data into intervals

data/Gemfile.lock

@@ -1,43 +0,0 @@
-PATH
-  remote: .
-  specs:
-    logfile_interval (2.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    columnize (0.3.6)
-    debugger (1.6.5)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.3.1)
-    debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.3.1)
-    diff-lcs (1.2.5)
-    docile (1.1.1)
-    multi_json (1.8.2)
-    rake (10.1.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.4)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
-    simplecov (0.8.2)
-      docile (~> 1.1.0)
-      multi_json
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.3)
-  debugger
-  logfile_interval!
-  rake
-  rspec (~> 2.14.0)
-  simplecov