file_series 0.2.0 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/file_series.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "file_series"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Dean"]
-  s.date = "2012-07-19"
+  s.date = "2012-10-26"
   s.description = "Automatically start writing to a new file every X seconds without any locking or file moving/renaming."
   s.email = "alex@crackpot.org"
   s.extra_rdoc_files = [

data/lib/file_series.rb

@@ -1,3 +1,5 @@
+require 'time'
+
 # Writes to this logger will be directed to new files at a configurable frequency.
 #
 #  => logger = FileSeries.new('.', :prefix=>'test', :rotate_every=>60)
@@ -17,84 +19,84 @@
 #
 
 class FileSeries
-	DEFAULT_DIR = '.'
-	DEFAULT_PREFIX = 'log'
-	DEFAULT_FREQ = 60
-	DEFAULT_SEPARATOR = "\n"
+  DEFAULT_DIR = '.'
+  DEFAULT_PREFIX = 'log'
+  DEFAULT_FREQ = 60
+  DEFAULT_SEPARATOR = "\n"
 
-	attr_accessor :separator
-	attr_accessor :dir
-	attr_accessor :file
-	attr_accessor :current_ts
+  attr_accessor :separator
+  attr_accessor :dir
+  attr_accessor :file
+  attr_accessor :current_ts
 
-	def initialize(options={})
-		@dir = options[:dir] || DEFAULT_DIR
-		@file = nil
-		@current_ts = nil
-		@filename_prefix = options[:prefix] || DEFAULT_PREFIX
-		@rotate_freq = options[:rotate_every] || DEFAULT_FREQ #seconds
-		@binary_mode = options[:binary]
-		@separator = options[:separator] || DEFAULT_SEPARATOR
-	end
+  def initialize(options={})
+    @dir = options[:dir] || DEFAULT_DIR
+    @file = nil
+    @current_ts = nil
+    @filename_prefix = options[:prefix] || DEFAULT_PREFIX
+    @rotate_freq = options[:rotate_every] || DEFAULT_FREQ #seconds
+    @binary_mode = options[:binary]
+    @separator = options[:separator] || DEFAULT_SEPARATOR
+  end
 
-	# write something to the current log file.
-	def write(message)
-		log_file.write(message.to_s + @separator)
-	end
+  # write something to the current log file.
+  def write(message)
+    log_file.write(message.to_s + @separator)
+  end
 
-	# return a File object for the current log file.
-	def log_file
-		ts = this_period
+  # return a File object for the current log file.
+  def log_file
+    ts = this_period
 
-		# if we're in a new time period, start writing to new file.
-		if (! file) || (ts != current_ts)
-			rotate(ts)
-		end
+    # if we're in a new time period, start writing to new file.
+    if (! file) || (ts != current_ts)
+      rotate(ts)
+    end
 
-		file
-	end
+    file
+  end
 
-	# compute the current time period.
-	def this_period
-		t = Time.now.to_i
-		t - (t % @rotate_freq)
-	end
+  # compute the current time period.
+  def this_period
+    t = Time.now.to_i
+    t - (t % @rotate_freq)
+  end
 
-	# close current file handle and open a new one for a new logging period.
-	# ts defaults to the current time period.
-	def rotate(ts=nil)
-		ts ||= this_period
-		@file.close if @file
-		@file = File.open(filename(ts), "a#{'b' if @binary_mode}")
-		@current_ts = ts
-	end
+  # close current file handle and open a new one for a new logging period.
+  # ts defaults to the current time period.
+  def rotate(ts=nil)
+    ts ||= this_period
+    @file.close if @file
+    @file = File.open(filename(ts), "a#{'b' if @binary_mode}")
+    @current_ts = ts
+  end
 
-	# return a string filename for the logfile for the supplied timestamp.
-	# defaults to current time period.
-	def filename(ts=nil)
-		ts ||= this_period
-		File.join(@dir, "#{@filename_prefix}-#{ts}-#{@rotate_freq}.log")
-	end
+  # return a string filename for the logfile for the supplied timestamp.
+  # defaults to current time period.
+  def filename(ts=nil)
+    ts ||= this_period
+    File.join(@dir, "#{@filename_prefix}-#{Time.at(ts).utc.strftime('%Y%m%d-%H%M%SZ')}-#{@rotate_freq}.log")
+  end
 
-	# get all files which match our pattern which are not current.
-	# (safe for consumption. no longer being written to.)
-	def complete_files
-		current_file = filename
+  # get all files which match our pattern which are not current.
+  # (safe for consumption. no longer being written to.)
+  def complete_files
+    current_file = filename
 
-		Dir.glob(
-			File.join(@dir, "#{@filename_prefix}-*-#{@rotate_freq}.log")
-		).select do |name|
-			name != current_file
-		end
-	end
+    Dir.glob(
+      File.join(@dir, "#{@filename_prefix}-*-#{@rotate_freq}.log")
+    ).select do |name|
+      name != current_file
+    end
+  end
 
-	# enumerate over all the writes in a series, across all files.
-	def each
-		complete_files.sort.each do |file|
-			File.open(file,"r#{'b' if @binary_mode}").each_line(@separator) do |raw|
-				yield raw
-			end
-		end
-	end
+  # enumerate over all the writes in a series, across all files.
+  def each
+    complete_files.sort.each do |file|
+      File.open(file,"r#{'b' if @binary_mode}").each_line(@separator) do |raw|
+        yield raw
+      end
+    end
+  end
 
 end

data/spec/file_series_spec.rb

@@ -1,181 +1,182 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'time'
 require 'timecop'
 
 def test_dir
-	'/tmp/file_series_tests'
+  '/tmp/file_series_tests'
 end
 
 describe "FileSeries" do
 
-	before(:all) do
-		`mkdir -p #{test_dir}`
-	end
-	after(:all) do
-		`rm -Rf #{test_dir}`
-	end
-	before(:each) do
-		`rm -f #{test_dir}/*`
-	end
-
-	it "should write to a new file if we are in a new time period" do
-
-		Timecop.freeze(Time.at(100))
-		fs = FileSeries.new(:dir=>test_dir, :rotate_every => 10)
-		fs.write('foo')
-
-		name = File.join(test_dir,'log-100-10.log')
-		File.exist?(name).should == true
-		fs.file.flush
-		IO.read(name).should == "foo\n"
-
-		Timecop.freeze(Time.at(115))
-		fs.write('foo again')
-
-		name = File.join(test_dir,'log-110-10.log')
-		File.exist?(name).should == true
-		fs.file.flush
-		IO.read(name).should == "foo again\n"
-
-	end
-
-	it "should support binary file writing" do
-		# TODO: need to come up with some sequence which can't be written in non-binary mode.
-		# Trying to write a Marshal'd version of
-		# https://github.com/tedconf/videometrics/blob/83ad528b013ce591ac2500d7317e0904270356f9/spec/controllers/imports_controller_spec.rb#L92
-		# in non-binary mode fails with
-		#   Failure/Error: post :record_event, :event => @event
+  before(:all) do
+    `mkdir -p #{test_dir}`
+  end
+  after(:all) do
+    `rm -Rf #{test_dir}`
+  end
+  before(:each) do
+    `rm -f #{test_dir}/*`
+  end
+
+  it "should write to a new file if we are in a new time period" do
+
+    Timecop.freeze(Time.parse('1970-01-01 00:01:00Z'))
+    fs = FileSeries.new(:dir=>test_dir, :rotate_every => 10)
+    fs.write('foo')
+
+    name = File.join(test_dir,'log-19700101-000100Z-10.log')
+    File.exist?(name).should eq true
+    fs.file.flush
+    IO.read(name).should eq "foo\n"
+
+    Timecop.freeze(Time.parse('1970-01-01 00:01:15Z'))
+    fs.write('foo again')
+
+    name = File.join(test_dir,'log-19700101-000110Z-10.log')
+    File.exist?(name).should eq true
+    fs.file.flush
+    IO.read(name).should == "foo again\n"
+
+  end
+
+  it "should support binary file writing" do
+    # TODO: need to come up with some sequence which can't be written in non-binary mode.
+    # Trying to write a Marshal'd version of
+    # https://github.com/tedconf/videometrics/blob/83ad528b013ce591ac2500d7317e0904270356f9/spec/controllers/imports_controller_spec.rb#L92
+    # in non-binary mode fails with
+    #   Failure/Error: post :record_event, :event => @event
     #   Encoding::UndefinedConversionError:
     #   "\x87" from ASCII-8BIT to UTF-8
     # Writing in binary mode works fine. How to reproduce that more simply for a test?
-	end
-
-	describe "#write" do
-		it "should call log_file.write with message and separator" do
-			fs = FileSeries.new(:separator=>'...')
-
-			fs.should_receive(:log_file) {
-				d = double('log_file')
-				d.should_receive(:write).with("foo...")
-				d
-			}
-
-			fs.write('foo')
-		end
-	end
-
-	describe "#log_file" do
-		it "should call rotate if no file is open" do
-			fs = FileSeries.new
-			fs.should_receive(:rotate)
-			fs.log_file
-		end
-	end
-
-	describe "#this_period" do
-		it "should floor timestamp to the beginning of the current period" do
-			fs = FileSeries.new( :rotate_every=>20 )
-			now = Time.now.to_i
-
-			fs.this_period.should == (now - (now%20))
-		end
-	end
-
-	describe "#filename" do
-		it "should accept a timestamp argument" do
-			fs = FileSeries.new( :dir=>'/tmp', :prefix=>'test', :rotate_every=>60)
-			fs.filename(1234).should == "/tmp/test-1234-60.log"
-		end
-
-		it "should use this_period when no timestamp is supplied" do
-			fs = FileSeries.new( :dir=>'/tmp', :prefix=>'test', :rotate_every=>3600)
-			fs.should_receive(:this_period) {4321}
-			fs.filename.should == "/tmp/test-4321-3600.log"
-		end
-	end
-
-	describe "#complete_files" do
-		it "should find files in our series which are not in use" do
-			list = [
-				'/tmp/prefix-100-10.log',
-				'/tmp/prefix-110-10.log',
-				'/tmp/prefix-120-10.log',
-				'/tmp/prefix-130-10.log',
-			]
-
-			Dir.should_receive(:glob).with('/tmp/prefix-*-10.log') {list}
-
-			Timecop.freeze(Time.at(136)) do
-				fs = FileSeries.new(:dir=>'/tmp', :prefix=>'prefix', :rotate_every=>10)
-				fs.complete_files.should == (list - ['/tmp/prefix-130-10.log'])
-			end
-		end
-	end
-
-	describe "#each" do
-		it "should enumerate all lines in all files in a series" do
-			fs = FileSeries.new(:dir=>test_dir, :rotate_every=>60, :prefix=>'events')
-
-			# write 3 files with consecutive integers.
-			Timecop.freeze(100) do
-				(0..9).each do |i|
-					fs.write i
-				end
-			end
-			Timecop.freeze(160) do
-				(10..19).each do |i|
-					fs.write i
-				end
-			end
-			Timecop.freeze(220) do
-				(20..29).each do |i|
-					fs.write i
-				end
-			end
-			fs.file.flush
-
-			out = []
-			fs.each do |line|
-				out << line
-			end
-
-			out.should == (0..29).to_a.map {|i| i.to_s+"\n" }
-		end
-
-		it "should enumerate all entries in a binary file series" do
-			fs = FileSeries.new(
-				:binary=>true,
-				:separator=>'!~!~!',
-				:dir=>test_dir,
-				:prefix=>'bin',
-				:rotate_every=>60
-			)
-
-			Timecop.freeze(100) do
-				(0..9).each do |i|
-					fs.write Marshal.dump(i)
-				end
-			end
-			Timecop.freeze(160) do
-				(10..19).each do |i|
-					fs.write Marshal.dump(i)
-				end
-			end
-			Timecop.freeze(220) do
-				(20..29).each do |i|
-					fs.write Marshal.dump(i)
-				end
-			end
-			fs.file.flush
-
-			out = []
-			fs.each do |line|
-				out << Marshal.load(line)
-			end
-
-			# note that we don't get the separator, and they're Fixnum not String
-			out.should == (0..29).to_a.map {|i| i }
-
-		end
-	end
+  end
+
+  describe "#write" do
+    it "should call log_file.write with message and separator" do
+      fs = FileSeries.new(:separator=>'...')
+
+      fs.should_receive(:log_file) {
+        d = double('log_file')
+        d.should_receive(:write).with("foo...")
+        d
+      }
+
+      fs.write('foo')
+    end
+  end
+
+  describe "#log_file" do
+    it "should call rotate if no file is open" do
+      fs = FileSeries.new
+      fs.should_receive(:rotate)
+      fs.log_file
+    end
+  end
+
+  describe "#this_period" do
+    it "should floor timestamp to the beginning of the current period" do
+      fs = FileSeries.new( :rotate_every=>20 )
+      now = Time.now.to_i
+
+      fs.this_period.should == (now - (now%20))
+    end
+  end
+
+  describe "#filename" do
+    it "should accept a timestamp argument" do
+      fs = FileSeries.new( :dir=>'/tmp', :prefix=>'test', :rotate_every=>60)
+      fs.filename(Time.parse('1970-01-01 00:20:34Z').to_i).should eq "/tmp/test-19700101-002034Z-60.log"
+    end
+
+    it "should use this_period when no timestamp is supplied" do
+      fs = FileSeries.new( :dir=>'/tmp', :prefix=>'test', :rotate_every=>3600)
+      fs.should_receive(:this_period) { Time.parse('1970-01-01 00:20:00Z').to_i }
+      fs.filename.should == "/tmp/test-19700101-002000Z-3600.log"
+    end
+  end
+
+  describe "#complete_files" do
+    it "should find files in our series which are not in use" do
+      list = [
+        '/tmp/prefix-19700101-000200Z-60.log',
+        '/tmp/prefix-19700101-000300Z-60.log',
+        '/tmp/prefix-19700101-000400Z-60.log',
+        '/tmp/prefix-19700101-000500Z-60.log',
+      ]
+
+      Dir.should_receive(:glob).with('/tmp/prefix-*-60.log') {list}
+
+      Timecop.freeze(Time.parse('1970-01-01 00:05:05Z')) do
+        fs = FileSeries.new(:dir=>'/tmp', :prefix=>'prefix', :rotate_every=>60)
+        fs.complete_files.should == (list - ['/tmp/prefix-19700101-000500Z-60.log'])
+      end
+    end
+  end
+
+  describe "#each" do
+    it "should enumerate all lines in all files in a series" do
+      fs = FileSeries.new(:dir=>test_dir, :rotate_every=>60, :prefix=>'events')
+
+      # write 3 files with consecutive integers.
+      Timecop.freeze(Time.parse('1970-01-01 01:00:00')) do
+        (0..9).each do |i|
+          fs.write i
+        end
+      end
+      Timecop.freeze(Time.parse('1970-01-01 01:01:00')) do
+        (10..19).each do |i|
+          fs.write i
+        end
+      end
+      Timecop.freeze(Time.parse('1970-01-01 01:02:00')) do
+        (20..29).each do |i|
+          fs.write i
+        end
+      end
+      fs.file.flush
+
+      out = []
+      fs.each do |line|
+        out << line
+      end
+
+      out.should == (0..29).to_a.map {|i| i.to_s+"\n" }
+    end
+
+    it "should enumerate all entries in a binary file series" do
+      fs = FileSeries.new(
+        :binary=>true,
+        :separator=>'!~!~!',
+        :dir=>test_dir,
+        :prefix=>'bin',
+        :rotate_every=>60
+      )
+
+      Timecop.freeze(Time.parse('1970-01-01 01:00:00')) do
+        (0..9).each do |i|
+          fs.write Marshal.dump(i)
+        end
+      end
+      Timecop.freeze(Time.parse('1970-01-01 01:01:00')) do
+        (10..19).each do |i|
+          fs.write Marshal.dump(i)
+        end
+      end
+      Timecop.freeze(Time.parse('1970-01-01 01:02:00')) do
+        (20..29).each do |i|
+          fs.write Marshal.dump(i)
+        end
+      end
+      fs.file.flush
+
+      out = []
+      fs.each do |line|
+        out << Marshal.load(line)
+      end
+
+      # note that we don't get the separator, and they're Fixnum not String
+      out.should == (0..29).to_a.map {|i| i }
+
+    end
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: file_series
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-19 00:00:00.000000000 Z
+date: 2012-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: autotest-standalone
@@ -176,7 +176,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2322774718501649979
+      hash: 2396804050019200525
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: