history_file 0.1.0 → 0.2.0

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - jruby-19mode
+  - rbx-19mode
+script: bundle exec rspec spec

data/CHANGELOG.markdown

@@ -0,0 +1,9 @@
+0.2.0 (2012-11-21)
+-----------------
+- prefixes can be sub directories via HistoryFile.mode = :subdir
+- travis ci mode (and jruby support)
+
+0.1.0 (2012-11-20)
+-----------------
+
+Initial release

data/Gemfile

@@ -12,6 +12,7 @@ group :development do
   gem "jeweler", "~> 1.8.4"
   gem "simplecov", ">= 0"
 end
+
 group :development, :test do
   gem 'webmock'
   gem 'rspec'
@@ -20,6 +21,9 @@ group :development, :test do
   gem 'guard-rspec'
   gem 'guard-bundler'
   gem 'guard-yard'
-  gem 'guard-spork'
   gem 'rb-fsevent'
 end
+
+platform :ruby do
+  gem 'redcarpet'
+end

data/Gemfile.lock

@@ -5,12 +5,9 @@ GEM
       i18n (~> 0.6)
       multi_json (~> 1.0)
     addressable (2.3.2)
-    childprocess (0.3.6)
-      ffi (~> 1.0, >= 1.0.6)
     coderay (1.0.8)
     crack (0.3.1)
     diff-lcs (1.1.3)
-    ffi (1.1.5)
     git (1.2.5)
     guard (1.5.4)
       listen (>= 0.4.2)
@@ -23,11 +20,6 @@ GEM
     guard-rspec (2.1.1)
       guard (>= 1.1)
       rspec (~> 2.11)
-    guard-spork (1.2.3)
-      childprocess (>= 0.2.3)
-      guard (>= 1.1)
-      spork (>= 0.8.4)
-      sys-proctable
     guard-yard (2.0.1)
       guard (>= 1.1.0)
       yard (>= 0.7.0)
@@ -50,6 +42,7 @@ GEM
     rb-fsevent (0.9.2)
     rdoc (3.12)
       json (~> 1.4)
+    redcarpet (2.2.2)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
       rspec-expectations (~> 2.12.0)
@@ -69,8 +62,6 @@ GEM
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
     slop (3.3.3)
-    spork (0.9.2)
-    sys-proctable (0.9.2)
     terminal-notifier (1.4.2)
     thor (0.16.0)
     webmock (1.9.0)
@@ -86,11 +77,11 @@ DEPENDENCIES
   guard
   guard-bundler
   guard-rspec
-  guard-spork
   guard-yard
   jeweler (~> 1.8.4)
   rb-fsevent
   rdoc (~> 3.12)
+  redcarpet
   rspec
   shoulda
   simplecov

data/Guardfile

@@ -26,17 +26,17 @@ guard 'rspec', :version => 2 do
 end
 
 
-guard 'spork', :cucumber_env => { 'RAILS_ENV' => 'test' }, :rspec_env => { 'RAILS_ENV' => 'test' } do
-  watch('config/application.rb')
-  watch('config/environment.rb')
-  watch('config/environments/test.rb')
-  watch(%r{^config/initializers/.+\.rb$})
-  watch('Gemfile')
-  watch('Gemfile.lock')
-  watch('spec/spec_helper.rb') { :rspec }
-  watch('test/test_helper.rb') { :test_unit }
-  watch(%r{features/support/}) { :cucumber }
-end
+# guard 'spork', :cucumber_env => { 'RAILS_ENV' => 'test' }, :rspec_env => { 'RAILS_ENV' => 'test' } do
+#   watch('config/application.rb')
+#   watch('config/environment.rb')
+#   watch('config/environments/test.rb')
+#   watch(%r{^config/initializers/.+\.rb$})
+#   watch('Gemfile')
+#   watch('Gemfile.lock')
+#   watch('spec/spec_helper.rb') { :rspec }
+#   watch('test/test_helper.rb') { :test_unit }
+#   watch(%r{features/support/}) { :cucumber }
+# end
 
 guard 'yard', port: 8808, stdout: '/dev/null' do
   watch(%r{app/.+\.rb})

data/README.markdown

@@ -0,0 +1,99 @@
+HistoryFile
+===========
+
+Behaves like a `File` class and does some convenience stuff
+around a `HistoryFile::FileDelegator` instance. It lets you 
+version files by dates. A date prefix is added to the file
+name.
+
+If you want to write a file to store data from yesterday, 
+you could write:
+
+```ruby
+> f = HistoryFile[1.day.ago].new("/tmp/foo.txt", "w")
+=> #<File:/tmp/2012.11.02-foo.txt>
+```
+
+The returned `HistoryFile::FileDelegator` object supports all
+methods that File has, but adds a date prefix to those methods
+that revolve around a single file (reading, writing, etc.)
+
+If a file for a given date is not available, `HistoryFile` falls
+back to the freshest file that is older than the given date.
+
+```ruby
+> f = HistoryFile[3.days.ago].new("test.txt", "w")
+=> #<File:./2012.11.12-test.txt>
+> f.write("I am old")
+=> 8
+> f.close
+=> nil
+> HistoryFile[Date.today].read("test.txt")
+=> "I am old"
+> HistoryFile[10.days.ago].read("test.txt")
+Errno::ENOENT: No such file or directory - ./2012.11.05-test.txt
+```
+It does this for every method where a prefix is added and when
+an `Errno::ENOENT` is thrown.
+
+Methods that patch all arguments with a date prefix
+---------------------------------------------------
+You can pass an arbitrary amount of arguments to these methods,
+but all of them are file names. So we'll go ahead and prefix all
+of them:
+
+- `delete`
+- `unlink`
+- `safe_unlink`
+
+Methods that patch nothing and just delegate to File
+----------------------------------------------------
+These are mostly methods that are either not `HistoryFile` specific
+(i.e. `File.join` to join components with the OS dependant path 
+separator) or where one can't dumbly prefix filenames. 
+
+- `absolute_path`
+- `basename`
+- `catname`
+- `chmod`
+- `chown`
+- `compare`
+- `copy`
+- `directory?`
+- `dirname`
+- `expand_path`
+- `extname`
+- `fnmatch`
+- `fnmatch?`
+- `identical?`
+- `install`
+- `join`
+- `lchown`
+- `link`
+- `makedirs`
+- `move`
+- `path`
+- `realdirpath`
+- `realpath`
+- `rename`
+- `split`
+- `umask`
+- `utime`
+
+Methods that add a prefix to the filename
+-----------------------------------------
+All methods not mentioned in the previous two sections
+
+Methods that automatically create a sub directory
+-------------------------------------------------
+If you set `HistoryFile.mode = :subdir` and you call one of the
+following methods, Historyfile will create a sub directory for the given
+date if it does not exist already
+
+- `new`
+- `open`
+
+Tests
+-----
+We use simplecov and it reports 100% coverage.
+[![Build Status](https://secure.travis-ci.org/moviepilot/history_file.png?branch=master)](https://travis-ci.org/moviepilot/history_file)

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/history_file.gemspec

@@ -5,25 +5,27 @@
 
 Gem::Specification.new do |s|
   s.name = "history_file"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jannis Hermanns"]
-  s.date = "2012-11-16"
+  s.date = "2012-11-21"
   s.description = "A File like class that supports versioning by date and has a fallback to older files"
   s.email = "jannis@moviepilot.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.markdown"
   ]
   s.files = [
     ".document",
     ".rvmrc",
+    ".travis.yml",
+    "CHANGELOG.markdown",
     "Gemfile",
     "Gemfile.lock",
     "Guardfile",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.markdown",
     "Rakefile",
     "VERSION",
     "history_file.gemspec",
@@ -43,6 +45,7 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<redcarpet>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
@@ -55,9 +58,9 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<guard-rspec>, [">= 0"])
       s.add_development_dependency(%q<guard-bundler>, [">= 0"])
       s.add_development_dependency(%q<guard-yard>, [">= 0"])
-      s.add_development_dependency(%q<guard-spork>, [">= 0"])
       s.add_development_dependency(%q<rb-fsevent>, [">= 0"])
     else
+      s.add_dependency(%q<redcarpet>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, [">= 0"])
@@ -70,10 +73,10 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<guard-rspec>, [">= 0"])
       s.add_dependency(%q<guard-bundler>, [">= 0"])
       s.add_dependency(%q<guard-yard>, [">= 0"])
-      s.add_dependency(%q<guard-spork>, [">= 0"])
       s.add_dependency(%q<rb-fsevent>, [">= 0"])
     end
   else
+    s.add_dependency(%q<redcarpet>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, [">= 0"])
@@ -86,7 +89,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<guard-rspec>, [">= 0"])
     s.add_dependency(%q<guard-bundler>, [">= 0"])
     s.add_dependency(%q<guard-yard>, [">= 0"])
-    s.add_dependency(%q<guard-spork>, [">= 0"])
     s.add_dependency(%q<rb-fsevent>, [">= 0"])
   end
 end

data/lib/history_file/file_delegator.rb

@@ -1,7 +1,7 @@
 module HistoryFile
-  # This class delegates all method calls to the {File} class.
+  # This class delegates all method calls to the `File` class.
   # The generic methods that don't revolve around one specific
-  # file, {File.join} for example, are just passed on. These
+  # file, `File.join` for example, are just passed on. These
   # methods are defined in
   # {HistoryFile::FileDelegator::EXCLUDED_METHODS}.
   #
@@ -16,7 +16,7 @@ module HistoryFile
   #     > puts fd.read("/path/to/my_file.txt")
   #     => hello there
   #
-  # This will pass on your block to {File.open}, but with a
+  # This will pass on your block to `File.open`, but with a
   # prefixed the filename. So what's really called is:
   #
   #     File.open("/path/to/some_prefix-my_file.txt")
@@ -65,15 +65,21 @@ module HistoryFile
       :safe_unlink
     ]
 
+    POTENTIALLY_FILE_CREATING_METHODS = [
+      :new,
+      :open
+    ]
+
     # @param prefix [String] The prefix for all methods that revolve around
     #   filenames
-    # @param fallback_glob [String] If you want to fall back to an alphabetically
-    #   smaller file on Errno::ENOENT, you can supply a fallback glob here. It
-    #   will be used with {Dir.glob} to find all candidates (so this should match
+    # @param fallback_glob [Hash] If you want to fall back to an alphabetically
+    #   smaller file on Errno::ENOENT, you can supply a :fallback_glob here. It
+    #   will be used with `Dir.glob` to find all candidates (so this should match
     #   all prefixes)
-    def initialize(prefix, fallback_glob = nil)
-      @prefix = prefix
-      @fallback_glob = fallback_glob
+    def initialize(opts)
+      @prefix = opts[:prefix] or raise ArgumentError,":prefix needed"
+      @fallback_glob = opts[:fallback_glob]
+      @subdir = opts[:use_subdirs]
     end
 
     # Either
@@ -95,7 +101,11 @@ module HistoryFile
     def prefixed_filename(f)
       dir  = File.dirname(f.to_s)
       file = File.basename(f.to_s)
-      File.join(dir, "#{@prefix}-#{file}")
+      if @subdir
+        File.join(dir, @prefix, file)
+      else
+        File.join(dir, "#{@prefix}-#{file}")
+      end
     end
 
     private
@@ -116,6 +126,7 @@ module HistoryFile
     def delegate_with_patched_filename(method, *args, &block)
       filename = args.slice!(0,1).first
       pf = prefixed_filename(filename)
+      create_prefix_subdir(method, pf)
       begin
         File.send(method, pf, *args, &block)
       rescue Errno::ENOENT => e
@@ -124,6 +135,16 @@ module HistoryFile
       end
     end
 
+    # We just assume that #new and #open are used to create files and create
+    # sub directories for prefixes when in prefix mode.
+    def create_prefix_subdir(method, filename)
+      return unless @subdir
+      return unless POTENTIALLY_FILE_CREATING_METHODS.include?(method)
+      dir = File.dirname(filename.to_s)
+      return if Dir.exists?(dir)
+      Dir.mkdir(dir)
+    end
+
     # Treats all arguments of the methods as files and prepends the 
     # history prefix
     def delegate_with_patched_filenames(method, *args, &block)

data/lib/history_file/history_file.rb

@@ -1,4 +1,4 @@
-# Behaves like a {File} class and does some convenience stuff
+# Behaves like a `File` class and does some convenience stuff
 # around a {HistoryFile::FileDelegator} instance. It all
 # revolves about defining a time offset. If however, you want
 # to access different versions of a file, use it like this:
@@ -27,10 +27,19 @@
 #
 module HistoryFile
 
+  def self.mode=(mode)
+    return @mode = :filename if mode.to_sym == :filename
+    return @mode = :subdir   if mode.to_sym == :subdir
+    raise ArgumentError, "Mode must be :filename or :subdir"
+  end
+
   def self.[](offset)
     validate_offset(offset)
+    use_subdirs = @mode == :subdir
     fallback_glob = "[0-9][0-9][0-9][0-9].[0-9][0-9].[0-9][0-9]-"
-    FileDelegator.new(prefix(offset), fallback_glob)
+    FileDelegator.new(prefix: prefix(offset),
+                      fallback_glob: fallback_glob,
+                      use_subdirs: use_subdirs)
   end
 
   private

data/spec/history_file/history_file_spec.rb

@@ -3,41 +3,81 @@ require 'date'
 
 describe HistoryFile::FileDelegator do
 
-  let(:fd){ HistoryFile::FileDelegator.new("some_prefix") }
+  context "prefixing the filename" do
+    let(:fd){ HistoryFile::FileDelegator.new(prefix: "some_prefix") }
 
-  after(:all) do
-    File.unlink("some_prefix-rspec_tmp_test.txt") rescue nil
-  end
+    after(:all) do
+      File.unlink("some_prefix-rspec_tmp_test.txt") rescue nil
+    end
 
-  it "delegates generic methods to File directly" do
-    File.should_receive(:split).with("/some/path")
-    fd.split("/some/path")
-  end
+    before(:each) do
+      HistoryFile.mode = :filename
+    end
 
-  it "delegates bulk methods with all parameters prefixed" do
-    offset = Date.parse("1983-04-03")
-    File.should_receive(:unlink).with("./1983.04.03-file1", "./1983.04.03-file2")
-    HistoryFile[offset].unlink("file1", "file2")
-  end
+    it "raises an exception if a :prefix is missing" do
+      expect{
+        HistoryFile::FileDelegator.new({})
+      }.to raise_error(ArgumentError, ":prefix needed")
+    end
+
+    it "raises an exception if you try to set an invalid mode" do
+      expect{
+        HistoryFile.mode = :made_up
+      }.to raise_error(ArgumentError, "Mode must be :filename or :subdir")
+    end
+
+
+    it "delegates generic methods to File directly" do
+      File.should_receive(:split).with("/some/path")
+      fd.split("/some/path")
+    end
+
+    it "delegates bulk methods with all parameters prefixed" do
+      offset = Date.parse("1983-04-03")
+      File.should_receive(:unlink).with("./1983.04.03-file1", "./1983.04.03-file2")
+      HistoryFile[offset].unlink("file1", "file2")
+    end
+
+    it "instanciating new File instances works as expected" do
+      f = fd.new("rspec_tmp_test.txt", "w")
+      f.write("works")
+      f.close
+      File.read("some_prefix-rspec_tmp_test.txt").should == "works"
+    end
 
-  it "instanciating new File instances works as expected" do
-    f = fd.new("rspec_tmp_test.txt", "w")
-    f.write("works")
-    f.close
-    File.read("some_prefix-rspec_tmp_test.txt").should == "works"
+    it "writing into a file using a block works as expected" do
+      fd.open("rspec_tmp_test.txt", "w") do |file|
+        file.write("works")
+      end
+      File.read("some_prefix-rspec_tmp_test.txt").should == "works"
+    end
   end
 
-  it "writing into a file using a block works as expected" do
-    fd.open("rspec_tmp_test.txt", "w") do |file|
-      file.write("works")
+  context "prefixing with sub directories" do
+    let(:sdfd){ HistoryFile::FileDelegator.new(prefix: "some_prefix", use_subdirs: true) }
+
+    it "creates the right filename with a directory as a prefix" do
+      sdfd.prefixed_filename('test').should == "./some_prefix/test"
     end
-    File.read("some_prefix-rspec_tmp_test.txt").should == "works"
+
+    it "attempts to create a directory" do
+      Dir.should_receive(:mkdir).with("./some_prefix")
+      File.should_receive(:open).with("./some_prefix/foo")
+      sdfd.open("foo") do |io|
+        io.write "don't"
+      end
+    end
+
   end
 end
 
 describe HistoryFile do
 
   context "writing and reading files" do
+    before(:each) do
+      HistoryFile.mode = :filename
+    end
+
     it "uses a correct prefix" do
       offset = Date.parse("1979-12-22")
       HistoryFile[offset].open("rspec_tmp_test.txt", "w") do |file|
@@ -54,33 +94,39 @@ describe HistoryFile do
     end
   end
 
-  context "falling back to older files" do
-    before(:all) do
-      [1,2,3,6,7].each do |i|
-        date = DateTime.now - i
-        HistoryFile[date].open("ht.txt", "w") do |file|
-          file.write "Day #{i}"
+  # We run these tests twice
+  [:subdir, :filename].each do |mode|
+
+    HistoryFile.mode = mode
+    context "falling back to older files in #{mode} mode" do
+      before(:all) do
+        [1,2,3,6,7].each do |i|
+          date = DateTime.now - i
+          HistoryFile[date].open("ht.txt", "w") do |file|
+            file.write "Day #{i} #{mode}"
+          end
         end
       end
-    end
 
-    after(:all) do
-      [1,2,3,6,7].each do |i|
-        date = DateTime.now - i
-        HistoryFile[date].unlink("ht.txt")
+      after(:all) do
+        [1,2,3,6,7].each do |i|
+          date = DateTime.now - i
+          HistoryFile[date].unlink("ht.txt")
+        end
+        Dir.unlink("some_prefix") rescue nil
       end
-    end
 
-    it "to yesterday's file" do
-      date = DateTime.now - 4
-      HistoryFile[date].read("ht.txt").should == "Day 6"
-    end
+      it "to yesterday's file" do
+        date = DateTime.now - 4
+        HistoryFile[date].read("ht.txt").should == "Day 6 #{mode}"
+      end
 
-    it "to an error if nothing older exists" do
-      expect{
-        date = DateTime.now - 8
-        HistoryFile[date].read("ht.txt")
-      }.to raise_error(Errno::ENOENT)
+      it "to an error if nothing older exists" do
+        expect{
+          date = DateTime.now - 8
+          HistoryFile[date].read("ht.txt")
+        }.to raise_error(Errno::ENOENT)
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,56 +1,46 @@
 require 'rubygems'
-require 'spork'
 require 'simplecov'
 SimpleCov.start
 require 'bundler'
 Bundler.require
 
-Spork.prefork do
-  # Loading more in this block will cause your tests to run faster. However,
-  # if you change any configuration or code from libraries loaded here, you'll
-  # need to restart spork for it take effect.
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+# require File.expand_path("../../config/environment", __FILE__)
+#require 'capybara/poltergeist'
 
-  # This file is copied to spec/ when you run 'rails generate rspec:install'
-  ENV["RAILS_ENV"] ||= 'test'
-  # require File.expand_path("../../config/environment", __FILE__)
-  #require 'capybara/poltergeist'
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.expand_path("../../spec/support/**/*.rb", __FILE__)].each {|f| require f}
 
-  # Requires supporting ruby files with custom matchers and macros, etc,
-  # in spec/support/ and its subdirectories.
-  Dir[File.expand_path("../../spec/support/**/*.rb", __FILE__)].each {|f| require f}
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
 
-  RSpec.configure do |config|
-    # == Mock Framework
-    #
-    # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
-    #
-    # config.mock_with :mocha
-    # config.mock_with :flexmock
-    # config.mock_with :rr
-    config.mock_with :rspec
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
 
-    # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-
-  end
-
-  module TestResponseExtensions
-    def json_body
-      JSON.parse(self.body)
-    end
+end
 
-    def unauthorized?
-      code.to_i == 401
-    end
+module TestResponseExtensions
+  def json_body
+    JSON.parse(self.body)
   end
 
-  def expect_id_and_return(id, ret_val)
-    lambda { |id| id.to_s.should == id.to_s; ret_val }
+  def unauthorized?
+    code.to_i == 401
   end
+end
 
+def expect_id_and_return(id, ret_val)
+  lambda { |id| id.to_s.should == id.to_s; ret_val }
 end
 
+
 require File.expand_path("../../lib/history_file/", __FILE__)
 
-# Spork.each_run do
-#   FactoryGirl.reload
-# end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: history_file
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-16 00:00:00.000000000 Z
+date: 2012-11-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -203,22 +219,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-spork
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
@@ -242,15 +242,17 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 files:
 - .document
 - .rvmrc
+- .travis.yml
+- CHANGELOG.markdown
 - Gemfile
 - Gemfile.lock
 - Guardfile
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - history_file.gemspec
@@ -274,7 +276,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3192868008292833198
+      hash: -4078239623642015702
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/README.rdoc

@@ -1,32 +0,0 @@
-HistoryFile
-===========
-
-Behaves like a {File} class and does some convenience stuff
-around a {HistoryFile::FileDelegator} instance. It all
-revolves about defining a time offset. If however, you want
-to access different versions of a file, use it like this:
-
-```ruby
-    > f = HistoryFile[1.day.ago].new("/tmp/foo.txt", "w")
-    => #<File:/tmp/2012.11.02-foo.txt>
-```
-
-The returned {HistoryFile::FileDelegator} object supports all
-methods that File has, but adds a date prefix to those methods
-that revolve around a single file (reading, writing, etc.)
-
-If a file for a given date is not available, {HistoryFile} falls
-back to the freshest file that is older than the given date.
-
-```ruby
-    > f = HistoryFile[3.days.ago].new("test.txt", "w")
-    => #<File:./2012.11.12-test.txt>
-    > f.write("I am old")
-    => 8
-    > f.close
-    => nil
-    > HistoryFile[Date.today].read("test.txt")
-    => "I am old"
-    > HistoryFile[10.days.ago].read("test.txt")
-    Errno::ENOENT: No such file or directory - ./2012.11.05-test.txt
-```