sequential_file 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e61c7c5b4f4c0cbfb6097b0110a843ddd6a4e4d1
+  data.tar.gz: 80ea9b4d801cdbf48db74c9e4224c4e2998b136a
+SHA512:
+  metadata.gz: a8937ecceba9d2ac7b78c8e128b128eef2598e38ddd81a7a30ce5680a9cf9cf0aa05fb14268a0308db2dac8a82050a22af69f9970a2d2c2a5259f90223d4963d
+  data.tar.gz: be2b9618b48c2482f57eb0dafa2b3c19bb2a1743c074a3d226605bb49072028a20c337ca1e64e62a105ef2f3a57bf5c6fc7071466f4626a668a50e84fcfa92c7

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - ruby-head

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+Version 0.0.1 - FEB.26.2014
+* Initial Release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sequential_file.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Peter Boling
+
+MIT License
+
+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.md

@@ -0,0 +1,143 @@
+# sequential_file
+
+Sequential File makes determination of which file to process (read or write) easy!
+
+| Project                 |  Sequential File   |
+|------------------------ | ----------------- |
+| gem name                |  sequential_file   |
+| license                 |  MIT              |
+| moldiness               |  [![Maintainer Status](http://stillmaintained.com/pboling/sequential_file.png)](http://stillmaintained.com/pboling/sequential_file) |
+| version                 |  [![Gem Version](https://badge.fury.io/rb/sequential_file.png)](http://badge.fury.io/rb/sequential_file) |
+| dependencies            |  [![Dependency Status](https://gemnasium.com/pboling/sequential_file.png)](https://gemnasium.com/pboling/sequential_file) |
+| code quality            |  [![Code Climate](https://codeclimate.com/github/pboling/sequential_file.png)](https://codeclimate.com/github/pboling/sequential_file) |
+| continuous integration  |  [![Build Status](https://secure.travis-ci.org/pboling/sequential_file.png?branch=master)](https://travis-ci.org/pboling/sequential_file) |
+| test coverage           |  [![Coverage Status](https://coveralls.io/repos/pboling/sequential_file/badge.png)](https://coveralls.io/r/pboling/sequential_file) |
+| homepage                |  [https://github.com/pboling/sequential_file][homepage] |
+| documentation           |  [http://rdoc.info/github/pboling/sequential_file/frames][documentation] |
+| author                  |  [Peter Boling](https://coderbits.com/pboling) |
+| Spread ~♡ⓛⓞⓥⓔ♡~      |  [![Endorse Me](https://api.coderwall.com/pboling/endorsecount.png)](http://coderwall.com/pboling) |
+
+## Summary
+
+It allows you to create files that are named sequentially *and* intelligently.
+
+Files will have four primary parts in their filenames:
+
+1. First part, which will be useful for list files in the shell.
+2. Second part is a date stamp, which will be useful in not having unwanted junk in our globs.
+3. Third part makes it easy to find the counter
+4. Fourth part is the counter
+
+## Compatibility
+
+Tested with Ruby 2.0.0+.  Due to the use of Ruby's 'prepend' initialization feature, will not work with anything older.
+
+There are no dependencies, gem or otherwise, this is a pure Ruby library, and will work with any sort of File-type class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sequential_file'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequential_file
+
+## Usage
+
+If you have your own File-like class then you may just need to use the SequentialFile::Namer by including it.
+
+```
+class MyFileLikeThing
+    include SequentialFile::Namer
+end
+```
+
+This gem ships with a reference implementation of a File-wrapper class that uses the Namer to determine which file to process.
+
+Have a look at `lib/sequential_file/base.rb` or require it and play with it:
+
+```
+require 'sequential_file/base'
+
+file = SequentialFile::Base.new({
+                           directory_path: '/tmp',
+                           name: 'access_log.FileBase.csv',
+                           process_date: Date.today
+                         })
+
+file.write('this is new text')          # => write ensures that the file is open for writing, but you have to remember to close!
+file.close
+file.write('this is after close text')
+file.read =~ /this is after close text/ # => integer representation of the position in the file where the text match starts
+file.close
+```
+
+Also, see the specs.
+
+## Contributors
+
+See the [Network View](https://github.com/pboling/sequential_file/network) and the [CHANGELOG](https://github.com/pboling/sequential_file/blob/master/CHANGELOG.md)
+
+## How you can help!
+
+Take a look at the `reek` and `roodi` lists. These are the files names `REEK` and `ROODI` in the root of the gem.
+
+Currently they are clean, and we like to keep them that way!  Once you complete a change, run the tests:
+
+```
+bundle exec rake spec
+```
+
+If the tests pass refresh the `reek` and `roodi` lists and make sure things have not gotten worse:
+
+```
+bundle exec rake reek > REEK
+bundle exec rake reek > ROODI
+```
+
+Follow the instructions for "Contributing" below.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver].
+Violations of this scheme should be reported as bugs. Specifically,
+if a minor or patch version is released that breaks backward
+compatibility, a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will
+only be introduced with new major versions.
+
+As a result of this policy, you can (and should) specify a
+dependency on this gem using the [Pessimistic Version Constraint][pvc] with two digits of precision.
+
+For example:
+
+    spec.add_dependency 'sequential_file', '~> 1.0.8'
+
+## Legal
+
+* MIT License - See LICENSE file in this project
+* Copyright (c) 2014 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
+
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+[railsbling]: http://www.railsbling.com
+[peterboling]: http://www.peterboling.com
+[documentation]: http://rdoc.info/github/pboling/sequential_file/frames
+[homepage]: https://github.com/pboling/sequential_file
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/pboling/sequential_file/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

data/REEK

@@ -0,0 +1,2 @@
+
+0 total warnings

data/ROODI

@@ -0,0 +1,5 @@
+
+Running Roodi checks
+
+Checked 9 files
+Found 0 errors.

data/Rakefile

@@ -0,0 +1,33 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec
+
+require File.expand_path('../lib/sequential_file/version', __FILE__)
+require 'rdoc'
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "SequentialFile #{SequentialFile::VERSION}"
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/sequential_file.rb

@@ -0,0 +1,10 @@
+require "sequential_file/version"
+require "sequential_file/namer"
+
+# SequentialFile::Base is not loaded by default, because it is a reference implementation, and third party libs may not need or want it.
+# It can be used by adding the following to any third party lib:
+#require "sequential_file/base"
+
+module SequentialFile
+  # Just a namespace here...
+end

data/lib/sequential_file/base.rb

@@ -0,0 +1,109 @@
+require 'date'
+
+module SequentialFile
+  # This is a reference implementation of a File-wrapper class that uses the Namer to determine which file to process
+  class Base
+
+    include SequentialFile::Namer
+
+    attr_accessor :complete_path                # the complete path to the file
+    attr_accessor :read_position                # the byte position in the file where read stopped and monitor will begin.
+    attr_accessor :file, :permission_style
+    attr_accessor :buffer_size, :buffer_limit, :buffer_position, :verbose
+
+    def initialize(options = {}, &block)
+      yield if block_given?
+      @complete_path ||= File.join(self.directory_path, self.name)
+      @buffer_limit = options[:buffer_limit] || 200 # bytes
+      @buffer_size = 0
+      @permission_style = options[:permission_style] || File::RDWR|File::CREAT
+      @verbose = !!options[:verbose]
+    end
+
+    def info_string
+      "PERM: #{@permission_style}\n\tPATH: #{@complete_path}"
+    end
+
+    def file_handle
+      # autoclose: false => Keep the file descriptor open until we want to close it.
+      File.new(@complete_path, @permission_style, {autoclose: false})
+      self.file ||= File.new(@complete_path, @permission_style, {autoclose: false})
+    end
+
+    def num_lines
+      file_handle.seek(0, IO::SEEK_SET)
+      file_handle.readlines.size
+    end
+
+    # Need to remember to close file with self.close after done using the file descriptor
+    def write(msg)
+      prep_write
+      puts "#-------> @[ #{@file_handle.pos} ] B[ #{@buffer_size} ] in #{@complete_path} <---------#\n#{msg}" if verbose
+      add_to_buffer(msg)
+      flush_if_buffer_full
+    end
+
+    def flush_if_buffer_full
+      if buffer_size >= buffer_limit
+        file_handle.flush
+        @buffer_size = 0
+      end
+    end
+
+    # Read file from beginning to end, recording position when done
+    # Need to remember to close file with self.close after done using the file descriptor
+    def read &block
+      prep_read
+      data = block_given? ?
+        file_handle.each {|line| yield line } :
+        file_handle.read
+      @read_position = file_handle.pos
+      data
+    end
+
+    def close
+      file_handle.close
+      # Set the file to nil, so it will be reopened when needed.
+      self.file = nil
+    end
+
+    def clear
+      file_handle.truncate 0
+      # Set the file to nil, so it will be reopened when needed.
+      close
+    end
+
+    def delete
+      if file
+        close # just in case
+        File.delete(complete_path)
+      end
+    end
+
+    protected
+    def prep_write
+      file_handle.flock(File::LOCK_EX) # an exclusive lock on the file.
+      file_handle.seek(0, IO::SEEK_END)
+    end
+    def prep_read
+      file_handle.flock(File::LOCK_SH) # a shared lock on the file.
+      file_handle.seek(0, IO::SEEK_SET)
+    end
+    def add_to_buffer(msg)
+      @buffer_size += msg.length
+      file_handle.write(msg)
+    end
+  end
+end
+
+# Read file from #position where read stopped and continue to monitor for additional lines added
+# Need to remember to close file with self.close after done using the file descriptor
+# WARNING: this is an infinite loop, so know how you will stop it before you start it.
+#def monitor &block
+#  f = File.open(self.complete_path,"r")
+#  f.seek(self.read_position, IO::SEEK_SET)
+#  while true do
+#    select([f])   # Kernel#select
+#    yield f.gets  # a line
+#  end
+#end

data/lib/sequential_file/counter_finder.rb

@@ -0,0 +1,30 @@
+module SequentialFile
+
+  # This class takes a filename and an extension, and finds the counter (Integer) part of the file name
+  class CounterFinder
+    NUMBER_REGEX = /\d*/
+
+    # determines the counter value of the filename passed in.
+    # params:
+    #   filename - string, complete filename
+    #   extension - string, the part of the filename that is the extension (e.g. .log or .csv)
+    def initialize(filename, extension)
+      @filename = File.basename(filename, extension)
+      @length = @filename.length
+      @index_of_extension_separator = @filename.rindex('.')
+    end
+
+    def has_extension_separator?
+      !!@index_of_extension_separator
+    end
+
+    # returns:
+    #   an integer representation of the counter
+    def counter
+      has_extension_separator? ?
+        @filename[@index_of_extension_separator + 1,@length][NUMBER_REGEX].to_i :
+        0
+    end
+  end
+
+end

data/lib/sequential_file/namer.rb

@@ -0,0 +1,107 @@
+require 'sequential_file/counter_finder'
+
+module SequentialFile
+  module Namer
+
+    module Initializer
+      def initialize(options = {})
+        super do
+          name = options[:name]
+          name ?
+            derive_name_parts_from_name(name) :
+            set_name_parts(options[:filename_first_part], options[:filename_third_part], options[:file_extension])
+          @directory_path = options[:directory_path]
+          @process_date = options[:process_date] || Date.today
+          if options[:append]
+            @last_filename_counter = self.last_used_counter
+          else
+            @last_filename_counter = self.get_next_available_counter
+          end
+          @name = self.determine_name
+        end
+      end
+    end
+
+    # :directory_path -         directory path where file will be located
+    # :name -                   complete intelligent *and* sequential filename
+    # :process_date -           date stamp of invocation, used as part of filename
+    # :filename_first_part -    first part of filename,   separated from third part by the chronometer
+    # :filename_third_part -    third part of filename,  separated from first  part by the chronometer
+    # :last_filename_counter -  the last-used file counter;  prevent files from stepping on each other.
+    # :file_extension -         the file extension
+    def self.included(klass)
+      klass.send :prepend, Initializer
+      klass.send :attr_accessor, :directory_path, :name, :process_date, :filename_first_part, :filename_third_part, :last_filename_counter, :file_extension
+    end
+
+    protected
+    def set_name_parts(first_part, third_part, name_extension)
+      @filename_first_part = first_part
+      @filename_third_part = third_part
+      @file_extension = name_extension
+    end
+
+    def derive_name_parts_from_name(name_option)
+      parts = name_option.split('.')
+      raise ArgumentError, ":name must have three parts separated by dots ('.') in order to be a valid option for #{self.class.name}" unless parts.length == 3
+      set_name_parts(parts[0], parts[1], '.' << parts[2])
+    end
+
+    def globular_file_parts
+      chrono = get_chronometer
+      with_dot = chrono.empty? ? '' : ".#{chrono}"
+      "#{@filename_first_part}#{with_dot}.#{@filename_third_part}"
+    end
+
+    def determine_name
+      "#{globular_file_parts}.#{@last_filename_counter}#{@file_extension}"
+    end
+
+    def get_chronometer
+      @process_date.respond_to?(:strftime) ?
+        @process_date.strftime("%Y%m%d") :
+        @process_date.to_s
+    end
+
+    # determines the last used file counter value
+    # returns:
+    #   an integer representation of the counter
+    def last_used_counter
+      directory_glob.inject(0) do |high_value, file|
+        counter = get_counter_for_file(file)
+        ((high_value <=> counter) == 1) ? high_value : counter
+      end
+    end
+
+    # determines the counter value for the next bump file to create
+    # returns:
+    #   an integer representation of the next counter to use
+    def get_next_available_counter
+      if @last_filename_counter
+        @last_filename_counter + 1
+      else
+        last_used_counter + 1
+      end
+    end
+
+    # determines the counter value of the filename passed in.
+    # params:
+    #   none
+    # returns:
+    #   an array of file names in the directory matching the glob
+    def directory_glob
+      glob = File.join(directory_path, "#{globular_file_parts}.*")
+      Dir.glob(glob)
+    end
+
+    # determines the counter value of the filename passed in.
+    # params:
+    #   filename - string, complete filename
+    # returns:
+    #   an integer representation of the counter
+    def get_counter_for_file(filename)
+      CounterFinder.new(filename, @file_extension).counter
+    end
+
+  end
+end

data/lib/sequential_file/version.rb

@@ -0,0 +1,3 @@
+module SequentialFile
+  VERSION = "0.0.1"
+end

data/sequential_file.gemspec

@@ -0,0 +1,63 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequential_file/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sequential_file"
+  spec.version       = SequentialFile::VERSION
+  spec.authors       = ["Peter Boling"]
+  spec.email         = ["peter.boling@gmail.com"]
+  spec.description   = %q{Create Files Named Sequentially Intelligently}
+  spec.summary       = %q{Create Files Named Sequentially Intelligently}
+  spec.homepage      = "http://railsbling.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  ############################
+  # RUNTIME DEPENDENCIES     #
+  ############################
+  #
+  # NONE!
+
+  ############################
+  # DEVELOPMENT DEPENDENCIES #
+  ############################
+
+  # Gem dependency manager
+  spec.add_development_dependency(%q<bundler>, ["~> 1.5.3"])
+
+  # The ruby workhorse command line tool.
+  spec.add_development_dependency(%q<rake>, ["~> 10.1.1"])
+
+  # For a test suite.
+  # https://github.com/rspec/rspec
+  spec.add_development_dependency(%q<rspec>, ["~> 2.14"])
+
+  # Give the test suite super powers (and less verbosity).
+  # https://github.com/rspec/rspec
+  spec.add_development_dependency(%q<shoulda>, ["~> 3.5.0"])
+  spec.add_development_dependency(%q<shoulda-matchers>, ["~> 1.5.6"])
+
+  # For detecting code smells.
+  # https://github.com/troessner/reek
+  spec.add_development_dependency(%q<reek>, ["~> 1.3.6"])
+
+  # For detecting more code smells.
+  # https://github.com/roodi/roodi
+  spec.add_development_dependency(%q<roodi>, ["~> 3.3.1"])
+
+  # For code coverage
+  spec.add_development_dependency "coveralls"
+
+  # Useful to work with relative paths to file, and to derive absolute paths
+  spec.add_dependency(%q<rbx-require-relative>, ["~> 0.0.9"])
+
+  # For autotest-like sweetness
+  spec.add_dependency(%q<guard-rspec>, ["~> 2.4.0"])
+
+end

data/spec/lib/sequential_file/base_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'shared_examples_for_files'
+require 'sequential_file/base'
+
+describe SequentialFile::Base do
+  FILE_BASE_TEST_PATH = File.join(GEM_ROOT, 'spec/tmp')
+  describe "#initialize" do
+    context "process date as empty string" do
+      let(:file){ SequentialFile::Base.new({
+                                       directory_path: FILE_BASE_TEST_PATH,
+                                       name: 'access_log.FileBase.tsv',
+                                       process_date: ''
+                                     }) }
+      subject { file }
+      after(:each) do
+        subject.delete
+      end
+      it_behaves_like "a SequentialFile::Base"
+
+      it('- class') { subject.class.should == SequentialFile::Base }
+      it('- complete_filename') { subject.name.should == 'access_log.FileBase.1.tsv' }
+      it('- complete_path') { subject.complete_path.should == File.join(subject.directory_path, 'access_log.FileBase.1.tsv') }
+    end
+
+    context "process date as nil" do
+      let(:file){ SequentialFile::Base.new({
+                                             directory_path: FILE_BASE_TEST_PATH,
+                                             name: 'access_log.FileBase.tsv',
+                                             process_date: nil
+                                           }) }
+      subject { file }
+      after(:each) do
+        subject.delete
+      end
+      it_behaves_like "a SequentialFile::Base"
+
+      it('- class') { subject.class.should == SequentialFile::Base }
+      it('- complete_filename') { subject.name.should == "access_log.#{Date.today.strftime("%Y%m%d")}.FileBase.1.tsv" }
+      it('- complete_path') { subject.complete_path.should == File.join(subject.directory_path, "access_log.#{Date.today.strftime("%Y%m%d")}.FileBase.1.tsv") }
+    end
+
+    context "process date as word" do
+      let(:file){ SequentialFile::Base.new({
+                                             directory_path: FILE_BASE_TEST_PATH,
+                                             name: 'access_log.FileBase.tsv',
+                                             process_date: 'today'
+                                           }) }
+      subject { file }
+      after(:each) do
+        subject.delete
+      end
+      it_behaves_like "a SequentialFile::Base"
+
+      it('- class') { subject.class.should == SequentialFile::Base }
+      it('- complete_filename') { subject.name.should == 'access_log.today.FileBase.1.tsv' }
+      it('- complete_path') { subject.complete_path.should == File.join(subject.directory_path, 'access_log.today.FileBase.1.tsv') }
+    end
+  end
+
+end

data/spec/lib/sequential_file/counter_finder_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe SequentialFile::CounterFinder::NUMBER_REGEX do
+  it('- should be a Regexp') { SequentialFile::CounterFinder::NUMBER_REGEX.should be_a(Regexp)}
+  it('- should match numbers') { ('asdf5' =~ SequentialFile::CounterFinder::NUMBER_REGEX.should) == 4}
+end
+
+describe SequentialFile::CounterFinder do
+
+  describe "#initialize" do
+    let(:counter_finder){ SequentialFile::CounterFinder.new('access_log.FileBase.1.tsv', '.tsv') }
+    subject { counter_finder }
+    it('- class') { subject.class.should == SequentialFile::CounterFinder }
+  end
+
+  context "with counter" do
+    let(:counter_finder){ SequentialFile::CounterFinder.new('access_log.FileBase.1.tsv', '.tsv') }
+    subject { counter_finder }
+    it('- has_extension_separator?') { subject.has_extension_separator?.should == true }
+    it('- counter') { subject.counter.should == 1 }
+  end
+
+  context "without counter" do
+    let(:counter_finder){ SequentialFile::CounterFinder.new('access_log.FileBase.tsv', '.tsv') }
+    subject { counter_finder }
+    it('- has_extension_separator?') { subject.has_extension_separator?.should == true }
+    it('- counter') { subject.counter.should == 0 }
+  end
+
+  context "with large counter" do
+    let(:counter_finder){ SequentialFile::CounterFinder.new('access_log.FileBase.10234856.tsv', '.tsv') }
+    subject { counter_finder }
+    it('- has_extension_separator?') { subject.has_extension_separator?.should == true }
+    it('- counter') { subject.counter.should == 10234856 }
+  end
+
+end

data/spec/lib/sequential_file/namer_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+require 'shared_examples_for_files'
+require 'sequential_file/base'
+
+class BumpFileB < SequentialFile::Base
+  include SequentialFile
+end
+
+class BumpFile < BumpFileB
+  def initialize(options = {})
+    options[:file_extension] = '.json'
+    super options
+  end
+end
+
+describe BumpFile do
+  NAMER_TEST_PATH = File.join(GEM_ROOT, 'spec/tmp')
+  describe "as a file" do
+    let(:file){ BumpFile.new({ directory_path: NAMER_TEST_PATH, process_date: Date.new(2014,2,14) }) }
+    subject { file }
+    after(:each) do
+      subject.delete
+    end
+    it_behaves_like "a SequentialFile::Base"
+  end
+  describe "#initialize" do
+    context "basic options" do
+      before(:each) do
+        @bump_file = BumpFile.new({ directory_path: NAMER_TEST_PATH, process_date: Date.new(2014,2,14) })
+      end
+      it('- class') { @bump_file.class.should == BumpFile }
+      it('- name') { @bump_file.name.should == '.20140214..1.json' }
+      it('- complete_path') { @bump_file.complete_path.should == File.join(@bump_file.directory_path, '.20140214..1.json') }
+    end
+    context "realistic options" do
+      before(:each) do
+        @bump_file = BumpFile.new({
+                                     directory_path: NAMER_TEST_PATH,
+                                     filename_first_part: 'asdf',
+                                     filename_third_part: 'qwer',
+                                     process_date: Date.new(2014,2,14)
+                                   })
+      end
+      it('- filename_counter') { @bump_file.last_filename_counter.should == 1 }
+      it('- name') { @bump_file.name.should == 'asdf.20140214.qwer.1.json' }
+      it('- complete_path') { @bump_file.complete_path.should == File.join(@bump_file.directory_path, 'asdf.20140214.qwer.1.json') }
+    end
+    context "name option" do
+      before(:each) do
+        @bump_file = BumpFile.new({
+                                     directory_path: NAMER_TEST_PATH,
+                                     name: 'abra.cadabra.log',
+                                     process_date: Date.new(2014,3,14)
+                                   })
+      end
+      it('- filename_counter') { @bump_file.last_filename_counter.should == 1 }
+      it('- name') { @bump_file.name.should == 'abra.20140314.cadabra.1.log' }
+      it('- complete_path') { @bump_file.complete_path.should == File.join(@bump_file.directory_path, 'abra.20140314.cadabra.1.log') }
+    end
+    context "append" do
+      before(:each) do
+        @bump_file = BumpFile.new({
+                                       directory_path: NAMER_TEST_PATH,
+                                       name: 'abra.cadabra.log',
+                                       process_date: Date.new(2014,3,14),
+                                       append: true
+                                     })
+      end
+      it('- filename_counter') { @bump_file.last_filename_counter.should == 0 }
+      it('- name') { @bump_file.name.should == 'abra.20140314.cadabra.0.log' }
+      it('- complete_path') { @bump_file.complete_path.should == File.join(@bump_file.directory_path, 'abra.20140314.cadabra.0.log') }
+    end
+    context "pre-existing file on counter #42" do
+      before(:each) do
+        @bump_file = BumpFile.new({
+                                     directory_path: File.join(GEM_ROOT,'spec/test_data'),
+                                     filename_first_part: 'asdf',
+                                     filename_third_part: 'qwer',
+                                     process_date: Date.new(2014,2,14)
+                                   })
+      end
+      it('- last_filename_counter') { @bump_file.last_filename_counter.should == 43 }
+      it('- name') { @bump_file.name.should == 'asdf.20140214.qwer.43.json' }
+      it('- complete_path') { @bump_file.complete_path.should == File.join(GEM_ROOT,'spec/test_data', 'asdf.20140214.qwer.43.json') }
+    end
+  end
+  describe "#write" do
+    context "data to a file" do
+      before(:each) do
+        @bump_file = BumpFile.new({
+                                     directory_path: File.join(GEM_ROOT,'spec/scratch'),
+                                     filename_first_part: 'asdf',
+                                     filename_third_part: 'qwer',
+                                     process_date: Date.new(2014,2,14)
+                                   })
+      end
+      after(:each) do
+        @bump_file.delete
+      end
+      it('- no exception') { lambda { @bump_file.write('This is bogus') }.should_not raise_exception }
+      it('- can read what was written') {
+        @bump_file.write('This is bogus')
+        # Because of the random seeding of test order this spec may run before the one above
+        # So "This is bogus" may be printed once or twice.
+        @bump_file.read.should =~ /This is bogus/
+      }
+    end
+  end
+end

data/spec/shared_examples_for_files.rb

@@ -0,0 +1,44 @@
+shared_examples "a SequentialFile::Base" do
+
+  describe "ancestry" do
+    it('- class') { subject.is_a?( SequentialFile::Base ).should == true }
+  end
+
+  describe "#write" do
+    context "data to a file" do
+      it('- should succeed') {
+        lambda { subject.write('this is text') }.should_not raise_exception
+      }
+      it('- should be readable') {
+        subject.write('this is text')
+        subject.read.should =~ /this is text/
+      }
+    end
+    context "after close" do
+      it('- should write') {
+        subject.write('this is text')
+        subject.close
+        lambda { subject.write('this is text') }.should_not raise_exception
+      }
+      it('- should be readable') {
+        subject.write('this is new text')
+        subject.close
+        subject.write('this is after close text')
+        subject.read.should =~ /this is after close text/
+      }
+    end
+  end
+
+  describe "#read" do
+    context "data from a file" do
+      it('- without block') { lambda { subject.read {} }.should_not raise_exception }
+      it('- with block') { lambda { subject.read { |line| puts line } }.should_not raise_exception }
+      it('- advances position') {
+        subject.write('this is text')
+        subject.read
+        subject.read_position.should be == 12
+      }
+    end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--colour
+--format
+specdoc
+--loadby
+mtime
+--reverse
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'require_relative' # loads rbx-require-relative gem
+
+# For code coverage, must be required before all application / gem / library code.
+unless ENV['NOCOVER']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+require 'sequential_file'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+GEM_ROOT = RequireRelative.abs_file.split("spec/spec_helper.rb")[0]

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: sequential_file
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Boling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: roodi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: rbx-require-relative
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+description: Create Files Named Sequentially Intelligently
+email:
+- peter.boling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- REEK
+- ROODI
+- Rakefile
+- lib/sequential_file.rb
+- lib/sequential_file/base.rb
+- lib/sequential_file/counter_finder.rb
+- lib/sequential_file/namer.rb
+- lib/sequential_file/version.rb
+- sequential_file.gemspec
+- spec/lib/sequential_file/base_spec.rb
+- spec/lib/sequential_file/counter_finder_spec.rb
+- spec/lib/sequential_file/namer_spec.rb
+- spec/scratch/.gitkeep
+- spec/shared_examples_for_files.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/test_data/asdf.20140214.qwer.42.json
+homepage: http://railsbling.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Create Files Named Sequentially Intelligently
+test_files:
+- spec/lib/sequential_file/base_spec.rb
+- spec/lib/sequential_file/counter_finder_spec.rb
+- spec/lib/sequential_file/namer_spec.rb
+- spec/scratch/.gitkeep
+- spec/shared_examples_for_files.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/test_data/asdf.20140214.qwer.42.json