filebydate 0.0.1

data/CHANGELOG

@@ -0,0 +1 @@
+0.0.1 Initial Version

data/README

@@ -0,0 +1,44 @@
+README for filebydate
+=====================
+
+This gem is a small set of libraries and bin scripts to help organize
+files by the date they were created.  This is a nice, simple system to
+organize certain types of data, like digital pictures (which was the
+original motivation to create this library), using a combination of these
+scripts and the built-in UI of the Mac/Win/Linux OS.
+
+Features
+	* FileByDate class with rename() method
+	* renwdate script (added to path) to run from the command line (common case)
+	* Rename works by prepending last modification date to the filename
+		e.g. renwdate *
+		with myimg.img in the directory
+		renames the file to something like "2006-06-14 110554 myimg.png"
+	* Preserves the last modification date of the file
+	* Safe to run twice/many times on the same directory, won't prepend twice
+		
+You may want to organize your files into a directory structure like
+		2006
+			2006-08
+			2006-06
+				2006-06-14 110554 myimg.png
+To keep a clean, date-oriented structure
+
+Details:
+
+renwdate takes a wildcard as input, reads the date on each file, and
+prepends that date into the file name (if the filename doesn't already
+have a YYYY-MM-DD in it).  The purpose is to allow files (usually image
+files) to be tagged with their creation date in the filename itself, so
+that the creation date isn't lost when the file is further renamed (beyond
+the date characters) or manipulated (such as rotating it or fixing red eye).
+The filename is also used by some on-line photo printing services to print
+the description of the picture, and this makes sure the date is part of
+that string.
+
+In general, it can be useful in any sort of filing system where you want 
+the files primarily organized by date, and have that date quite visible 
+and persistent for each file.
+
+Originally written in Perl Bernie Thompson Jan 2001 for organizing my own
+image libraries (over 10K photos of the kids and such)

data/Rakefile

@@ -0,0 +1,86 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'filebydate', 'version')
+
+AUTHOR = "Bernie Thompson"
+EMAIL = "bernie@leancode.com"
+DESCRIPTION = "Filedate is a set of libraries and scripts for organizing files (e.g. digital photos) by date using the capabilities of the filesystem and OS"
+RUBYFORGE_PROJECT = "filebydate"
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+BIN_FILES = %w( renwdate )
+
+
+NAME = "filebydate"
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = ENV['VERSION'] || (Filebydate::VERSION::STRING + (REV ? ".#{REV}" : ""))
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "filebydate documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+desc "Packages up filebydate gem."
+task :default => [:test]
+task :package => [:clean]
+
+Rake::TestTask.new("test") { |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+}
+
+spec =
+    Gem::Specification.new do |s|
+        s.name = NAME
+        s.version = VERS
+        s.platform = Gem::Platform::RUBY
+        s.has_rdoc = true
+        s.extra_rdoc_files = ["README", "CHANGELOG"]
+        s.rdoc_options += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
+        s.summary = DESCRIPTION
+        s.description = DESCRIPTION
+        s.author = AUTHOR
+        s.email = EMAIL
+        s.homepage = HOMEPATH
+        s.rubyforge_project = RUBYFORGE_PROJECT
+        s.require_path = "lib"
+        s.autorequire = "filebydate"
+
+        #s.add_dependency('activesupport', '>=1.3.1')
+        #s.required_ruby_version = '>= 1.8.2'
+        
+        s.bindir = "bin"     
+        s.executables = BIN_FILES   
+
+        s.files = %w(README CHANGELOG Rakefile) +
+          Dir.glob("{bin,doc,test,lib,templates,generator,extras,website,script}/**/*") + 
+          Dir.glob("ext/**/*.{h,c,rb}") +
+          Dir.glob("examples/**/*.rb") +
+          Dir.glob("tools/*.rb")
+        
+        # s.extensions = FileList["ext/**/extconf.rb"].to_a
+    end
+
+Rake::GemPackageTask.new(spec) do |p|
+    p.need_tar = true
+    p.gem_spec = spec
+end
+
+task :install do
+  name = "#{NAME}-#{VERS}.gem"
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{name}}
+end
+
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{NAME}}
+end

data/bin/renwdate

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby -w
+require File.dirname(__FILE__) + "/../lib/filebydate.rb"
+
+bname = File.basename(__FILE__)
+
+if ARGV.length == 0
+  puts "\n"
+  puts bname + " -- REName With DATE"
+  puts "\nRenames files, prepending their last modification time into the filename."
+  puts "Makes for a simple way of organizing files (such as digital pictures)"
+  puts "by date using just this utility and built-in OS functionality."
+  puts "\n"
+  puts "Examples: "
+  puts "    " + bname + " " + File.join("somedirectory", "*.jpg")
+  puts "    " + bname + " *"
+  puts "\n"
+else 
+  FileByDate::rename(ARGV)
+end

data/lib/filebydate/version.rb

@@ -0,0 +1,9 @@
+module Filebydate #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/filebydate.rb

@@ -0,0 +1,86 @@
+Dir[File.join(File.dirname(__FILE__), 'filebydate/**/*.rb')].sort.each { |lib| require lib }
+
+# This module provides functionality for organizing files by date
+#--
+# Copyright (c) 2006 Bernie Thompson, Leancode, LLC.
+# MIT license
+module FileByDate
+  
+  EXCLUDE_PATTERN = /\d\d\d\d-\d\d-\d\d/
+  RENAME_PATTERN = "%04d-%02d-%02d %02d%02d%02d %s"
+  
+  # Given an array of filespecs (filenames or wildcards),
+  # this method will rename those files to prepend the 
+  # last modification date into the filename.
+  #   * Directories are skipped
+  #   * Files already having a prepended date are skipped
+  # The function returns an array with the newly renamed filenames
+  # There are not yet any valid options
+  def self.rename(paths, options = {})
+    renamed_list = []
+    
+    paths.each do |path|
+      
+      if File.basename(path).match(/\*|\?/)
+        # We were passed a wildcard (e.g. Windows), so expand it
+        # On unix, we'll never get a wildcard because the shell will do the expansion
+        rename(Dir.glob(path), options)
+      elsif not File.directory?(path)
+        renamed_list << rename_file(path, options)
+      end
+    end
+    
+    return renamed_list
+  end
+  
+  private
+  
+  # Renames a single file to prepend a date, starting with year, month, day, hour, min, sec
+  def self.rename_file(file, options = {})
+    
+    newfile = nil
+    
+    # matches a date ANYWHERE in the filename.  So if you want to prepend something
+    # to a file that's already been converted, it won't fight with you and prepend another date.
+    if not (file.match( EXCLUDE_PATTERN ))
+      atime = File.atime(file)
+      mtime = File.mtime(file)
+      
+      # figure out new basename+ext, based on modification time of the file
+      newfile = sprintf(RENAME_PATTERN, 
+        mtime.year,mtime.month,mtime.day,
+        mtime.hour, mtime.min, mtime.sec, File.basename(file))
+      newfile = File.join(File.dirname(file), newfile)
+      
+      # output each of the files converted
+      puts newfile + "\n"
+      
+      # rename the file
+      File.rename(file, newfile)
+      
+      # set the modification time back to the original, before renaming
+      File.utime(atime, mtime)
+    end
+    
+    return newfile
+  end
+end
+
+# original 'filedate' Perl script written to organize image files
+# 
+# use File::Basename;
+# 
+# @files= <$ARGV[0]>;
+# 
+# foreach $oldname (@files)
+# {
+#         if ($oldname =~ m/\d\d\d\d-\d\d-\d\d/) { next; }
+# 	($readtime, $writetime) = (stat($oldname))[8,9];
+#         ($name, $dir, $ext) = fileparse($oldname,'\..*');
+#         ($sec, $min, $hour, $day, $month, $year, $junk) = (localtime($writetime));
+#         $year += 1900; $month += 1;
+#         $newname = sprintf("%s%04d-%02d-%02d %02d%02d%02d %s%s%s", $dir, $year, $month, $day, $hour, $min, $sec, $name, $ext);
+#         print "$newname\n";
+# 	rename $oldname, $newname;
+# 	utime($readtime, $writetime, $newname);
+# }

data/test/data/2008-03-20 norename.txt

@@ -0,0 +1 @@
+Test data

data/test/data/Alpha.txt

@@ -0,0 +1 @@
+Test data

data/test/data/data/2008-03-20 norename.txt

@@ -0,0 +1 @@
+Test data

data/test/data/data/Alpha.txt

@@ -0,0 +1 @@
+Test data

data/test/data/data/subdir/Epsilon

@@ -0,0 +1 @@
+Test data

data/test/data/subdir/Epsilon

@@ -0,0 +1 @@
+Test data

data/test/filebydate_test.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require "tempfile"
+require "fileutils"
+
+class FilebydateTest < Test::Unit::TestCase
+
+  @testfile = ""
+  @testpath = ""
+  @binpath = "" 
+  
+  #
+  # We keep some test data in subversion (alternately, we could create it fresh here)
+  # and copy it to a temp directory to run the filebydate tests against
+  # Test::Unit makes sure this is done before each test, 
+  # giving us the same clean test data to start with each time
+  #
+  def setup
+    f = Tempfile.new("FileDateTest")
+    @testfile = f.path
+    @testpath = File.join(File.dirname(@testfile), "data")
+    @binpath = File.join(File.dirname(__FILE__), '..', 'bin')
+
+    f.write("This is a test file")
+    f.close
+    if File.exists?(@testpath)
+      FileUtils::rm_r(@testpath)
+    end
+    FileUtils::cp_r(File.join(File.dirname(__FILE__), 'data'), @testpath)
+  end
+  
+  def test_single_file_renamed
+    FileByDate::rename(@testfile)
+    assert(!File.exists?(@testfile))
+  end
+  
+  def test_wildcard_files_renamed
+    assert(File.exists?(File.join(@testpath, "Delta")))
+    FileByDate::rename([File.join(@testpath, '*')])
+    assert(!File.exists?(File.join(@testpath, "Delta")))
+  end
+  
+  def test_mtime_preserved
+    file = File.join(@testpath, "Delta")
+    time = File.mtime(file)
+    newlist = FileByDate::rename([file])
+    assert_equal(time, File.mtime(newlist[0]))
+  end
+  
+  def test_bin_script_dir
+    assert(File.exists?(File.join(@testpath, "Alpha.txt")))
+    assert(File.exists?(File.join(@testpath, "Delta")))
+    system(@binpath + '/renwdate ' + File.join(@testpath, '*.txt'))
+    assert(!File.exists?(File.join(@testpath, "Alpha.txt")))
+    assert(File.exists?(File.join(@testpath, "Delta")))
+  end
+  
+  def test_bin_script_wildcard
+    assert(File.exists?(File.join(@testpath, "Delta")))
+    assert(File.exists?(File.join(@testpath, 'subdir', 'Epsilon')))
+    system(@binpath + '/renwdate ' + File.join(@testpath,'*'))
+    
+    assert(!File.exists?(File.join(@testpath, "Delta")))
+    # Without recurse option, files in subdirectory should not be renamed
+    assert(File.exists?(File.join(@testpath, 'subdir', 'Epsilon')))
+  end
+  
+  def test_no_double_rename
+    assert(File.exists?(File.join(@testpath, "2008-03-20 norename.txt")))
+    FileByDate::rename([File.join(@testpath, '*')])
+    assert(File.exists?(File.join(@testpath, "2008-03-20 norename.txt")))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/filebydate'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: filebydate
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2006-11-06 00:00:00 -08:00
+summary: Filedate is a set of libraries and scripts for organizing files (e.g. digital photos) by date using the capabilities of the filesystem and OS
+require_paths: 
+- lib
+email: bernie@leancode.com
+homepage: http://filebydate.rubyforge.org
+rubyforge_project: filebydate
+description: Filedate is a set of libraries and scripts for organizing files (e.g. digital photos) by date using the capabilities of the filesystem and OS
+autorequire: filebydate
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Bernie Thompson
+files: 
+- README
+- CHANGELOG
+- Rakefile
+- bin/renwdate
+- test/data
+- test/filebydate_test.rb
+- test/test_helper.rb
+- test/data/2008-03-20 norename.txt
+- test/data/Alpha.txt
+- test/data/data
+- test/data/Delta
+- test/data/subdir
+- test/data/data/2008-03-20 norename.txt
+- test/data/data/Alpha.txt
+- test/data/data/Delta
+- test/data/data/subdir
+- test/data/data/subdir/Epsilon
+- test/data/subdir/Epsilon
+- lib/filebydate
+- lib/filebydate.rb
+- lib/filebydate/version.rb
+test_files: []
+
+rdoc_options: 
+- --quiet
+- --title
+- filebydate documentation
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README
+- --inline-source
+- --exclude
+- ^(examples|extras)/
+extra_rdoc_files: 
+- README
+- CHANGELOG
+executables: 
+- renwdate
+extensions: []
+
+requirements: []
+
+dependencies: []
+