file_series 0.1.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "timecop", "0.3.5"
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    timecop (0.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  timecop (= 0.3.5)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Alex Dean
+
+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,37 @@
+= file_series
+
+FileSeries is a Ruby library for writing to a group of files.
+
+Writes will be directed to new files at a configurable frequency.
+
+    => logger = FileSeries.new('.', :prefix=>'test', :rotate_every=>60)
+    => logger.write("some message\n")
+
+This will create a file like 'test-1342477810-60.log'. A new file will be
+created every 60 seconds. You don't need to do anything except keep calling
+logger.write().
+
+Files are created as needed, so you won't end up with lots of 0-length files.
+If you do see a recent 0-length file, it's probably due to your OS buffering
+writes to the file.
+
+Other configuration options:
+
+     :binary - boolean. If true, log files are opened in binary mode. (Useful for Marshal.dump)
+     :separator - string. Appended to each write. Defaults to \n. Use something else in :binary mode.
+
+== Contributing to file_series
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 TED Conferences. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "file_series"
+  gem.homepage = "http://github.com/tedconf/file_series"
+  gem.license = "MIT"
+  gem.summary = "Write to a series of time-based files."
+  gem.description = "Automatically start writing to a new file every X seconds without any locking or file moving/renaming."
+  gem.email = "alex@crackpot.org"
+  gem.authors = ["Alex Dean"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "file_series #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/file_series.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "file_series"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alex Dean"]
+  s.date = "2012-07-18"
+  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 = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "file_series.gemspec",
+    "lib/file_series.rb",
+    "spec/file_series_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/tedconf/file_series"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Write to a series of time-based files."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<timecop>, ["= 0.3.5"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<timecop>, ["= 0.3.5"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<timecop>, ["= 0.3.5"])
+  end
+end
+

data/lib/file_series.rb

@@ -0,0 +1,91 @@
+# Writes to this logger will be directed to new files at a configurable frequency.
+#
+#  => logger = FileSeries.new('.', :prefix=>'test', :rotate_every=>60)
+#  => logger.write("some message\n")
+#
+# This will create a file like 'test-1342477810-60.log'. A new file will be
+# created every 60 seconds. You don't need to do anything except keep calling
+# logger.write().
+#
+# Files are created as needed, so you won't end up with lots of 0-length files.
+# If you do see a recent 0-length file, it's probably due to your OS buffering
+# writes to the file.
+#
+# Other configuration options:
+#   :binary - boolean. If true, log files are opened in binary mode. (Useful for Marshal.dump)
+#   :separator - string. Appended to each write. Defaults to \n. Use something else in :binary mode.
+#
+
+class FileSeries
+	DEFAULT_DIR = '.'
+	DEFAULT_PREFIX = 'log'
+	DEFAULT_FREQ = 60
+	DEFAULT_SEPARATOR = "\n"
+
+	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_writes = options[:binary]
+		@separator = options[:separator] || DEFAULT_SEPARATOR
+	end
+
+	# write something to the current log file.
+	def write(message)
+		log_file.write(message + @separator)
+	end
+
+	# 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
+
+		file
+	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_writes}")
+		@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
+
+	# 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
+
+end

data/spec/file_series_spec.rb

@@ -0,0 +1,103 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'timecop'
+
+def test_dir
+	'/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
+
+	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
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'file_series'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: file_series
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Dean
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+description: Automatically start writing to a new file every X seconds without any
+  locking or file moving/renaming.
+email: alex@crackpot.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- file_series.gemspec
+- lib/file_series.rb
+- spec/file_series_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/tedconf/file_series
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3623692300417860031
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Write to a series of time-based files.
+test_files: []