fun_with_files 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,9 +1,47 @@
 = fun_with_files
 
-Description goes here.
+FunWith::Files adds a bit of whimsy to your file manipulations, if that's what you're looking for.
+
+To the code!
+
+    require 'fun_with_files'
+    
+    include FunWith::Files
+    
+    class Project; end
+    
+    RootPath.rootify( Project, "/home/user/path/to/project" )
+    
+    Project.root  # => <FunWith::Files::FilePath:/home/user/path/to/project>
+    Project.root("hello", "subdir") # => <FunWith::Files::FilePath:/home/user/path/to/project/hello/subdir>
+    
+    home = FilePath.home
+    music = FilePath.home( "Music" )
+    
+    music.touch_dir( "sinead_o_connor" ) do |dir|
+      dir.touch_dir( "sean_nos_nua" ) do |subdir|
+        subdir.touch( "03-lord_franklin.mp3" )
+      end
+      
+      dir.touch_dir( "theology" ) do |subdir|
+        subdir.touch( "05-darker_than_blue.mp3" )
+      end
+    end
+    
+    mp3s = music.glob( "**/*.mp3" ) # => [<FunWith::Files::FilePath:/home/user/Music/sinead_o_connor/sean_nos_nua/03-lord_franklin.mp3>,
+                            # <FunWith::Files::FilePath:/home/user/Music/sinead_o_connor/theology/05-darker_than_blue.mp3>]
+    mp3s.last.write( Hypothetical::MP3::Source.new.read )
+    
+    # whole buchcha other goodies, yet to be documented.
+    
+    
+    
+
 
 == Contributing to fun_with_files
- 
+
+Boilerplate from Jeweler, but seems to make sense.
+
 * 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.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/files/file_path.rb

@@ -187,7 +187,7 @@ module FunWith
           self.glob( "**", "*" ).length == 0
         end
       end
-      
+            
       # Does not return a filepath
       def basename_no_ext
         self.basename.to_s.split(".")[0..-2].join(".")
@@ -239,28 +239,97 @@ module FunWith
       # in an argument, but it should always be the same value for
       # a given set of files.
       SUCC_DIGIT_COUNT = 6
-      def succ( digit_count = SUCC_DIGIT_COUNT )
-        chunks = basename.to_s.split(".")
-        if chunks.length == 1  # not being counted, no file extension.
-          chunks.push( "0" * digit_count )
+      def succ( opts = { digit_count: SUCC_DIGIT_COUNT, timestamp: false } )
+        if opts[:timestamp]
+          timestamp = Time.now.strftime("%Y%m%d%H%M%S%L")
+          digit_count = timestamp.length
+        else
+          timestamp = false
+          digit_count = opts[:digit_count]
+        end
+        
+        chunks = self.basename.to_s.split(".")
+        # not yet sequence stamped, no file extension.
+        if chunks.length == 1
+          if timestamp
+            chunks.push( timestamp )
+          else
+            chunks.push( "0" * digit_count )
+          end
+        # sequence stamp before file extension
         elsif match_data = chunks[-2].match( /^(\d{#{digit_count}})$/ )
-          i = match_data[1].to_i + 1
-          chunks[-2] = sprintf("%0#{digit_count}i", i)
-        elsif  match_data = chunks[-1].match( /^(\d{#{digit_count}})$/ )
-          i = match_data[1].to_i + 1
-          chunks[-1] = sprintf("%0#{digit_count}i", i)
-        else  # not being counted, has file extension
-          chunks = [chunks[0..-2], ("0" * digit_count), chunks[-1]].flatten
+          if timestamp
+            chunks[-2] = timestamp
+          else
+            i = match_data[1].to_i + 1
+            chunks[-2] = sprintf("%0#{digit_count}i", i)
+          end
+        # try to match sequence stamp to end of filename
+        elsif match_data = chunks[-1].match( /^(\d{#{digit_count}})$/ )
+          if timestamp
+            chunks[-1] = timestamp
+          else
+            i = match_data[1].to_i + 1
+            chunks[-1] = sprintf("%0#{digit_count}i", i)
+          end
+        # not yet sequence_stamped, has file extension
+        else
+          chunks = [chunks[0..-2], (timestamp ? timestamp : "0" * digit_count), chunks[-1]].flatten
         end
 
         self.up.join( chunks.join(".") )
       end
-    end
     
-    # TODO: succession : enumerates a sequence of files that get passed
-    # to a block in order.
     
-    # TODO: succ_last : find the last existing file of the given sequence.
-    # TODO: succ_next : find the first free file of the given sequence
+      # TODO: succession : enumerates a sequence of files that get passed
+      # to a block in order.
+      def succession( opts = { digit_count: SUCC_DIGIT_COUNT, timestamp: false } )
+        if opts[:timestamp]
+          timestamp = Time.now.strftime("%Y%m%d%H%M%S%L")
+          digit_count = timestamp.length
+        else
+          timestamp = false
+          digit_count = opts[:digit_count]
+        end
+      
+        chunks = self.basename.to_s.split(".")
+        glob_stamp_matcher = '[0-9]' * digit_count
+        
+        # unstamped filename, no extension
+        if chunks.length == 1
+          original = chunks.first
+          stamped = [original, glob_stamp_matcher].join(".")
+        # stamped filename, no extension
+        elsif chunks[-1].match( /^\d{#{digit_count}}$/ )
+          original = chunks[0..-2].join(".")
+          stamped = [original, glob_stamp_matcher].join(".")
+        # stamped filename, has extension
+        elsif chunks[-2].match( /^\d{#{digit_count}}$/ )
+          original = [chunks[0..-3], chunks.last].flatten.join(".")
+          stamped = [chunks[0..-3], glob_stamp_matcher, chunks.last].join(".")
+        # unstamped filename, has extension
+        else
+          original = chunks.join(".")
+          stamped = [ chunks[0..-2], glob_stamp_matcher, chunks[-1] ].flatten.join(".")
+        end
+      
+        [self.dirname.glob(original), self.dirname.glob(stamped)].flatten
+      end
+
+
+    
+      # TODO: succ_last : find the last existing file of the given sequence.
+      # TODO: succ_next : find the first free file of the given sequence
+    
+    
+      # File manipulation
+      def rename( filename )
+      
+      end
+    
+      def rename_all( pattern, gsubbed )
+      
+      end
+    end
   end
 end

data/test/test_file_path.rb

@@ -79,5 +79,66 @@ class TestFilePath < Test::Unit::TestCase
     end
   end
   
-  
+  context "test sequence" do
+    setup do
+      @tmp_dir = FunWith::Files.root( 'test', 'tmp' )
+    end
+    
+    teardown do
+      `rm -rf #{@tmp_dir.join('*')}`
+    end
+    
+    should "sequence files nicely" do
+      seqfile = @tmp_dir.join("sequence.txt")
+      
+      10.times do |i|
+        seqfile.write( i.to_s )
+        seqfile = seqfile.succ
+      end
+      
+      assert @tmp_dir.join("sequence.txt").exist?
+      assert @tmp_dir.join("sequence.000000.txt").exist?
+      assert @tmp_dir.join("sequence.000008.txt").exist?
+      
+      assert_equal "0", @tmp_dir.join("sequence.txt").read
+      assert_equal "9", @tmp_dir.join("sequence.000008.txt").read
+    end
+    
+    should "sequence files with custom stamp length" do
+      seqfile = @tmp_dir.join("sequence.txt")
+      
+      10.times do |i|
+        seqfile.write( i.to_s )
+        seqfile = seqfile.succ( digit_count: 4 )
+      end
+      
+      assert @tmp_dir.join("sequence.txt").exist?
+      assert @tmp_dir.join("sequence.0000.txt").exist?
+      assert @tmp_dir.join("sequence.0008.txt").exist?
+      
+      assert_equal "0", @tmp_dir.join("sequence.txt").read
+      assert_equal "9", @tmp_dir.join("sequence.0008.txt").read
+    end
+    
+    should "sequence files with datestamps" do
+      seqfile = @tmp_dir.join("sequence.txt")
+      
+      10.times do |i|
+        seqfile.write( i.to_s )
+        seqfile = seqfile.succ( timestamp: true )
+        sleep(0.002)
+      end
+      
+      files = seqfile.succession( timestamp: true )
+      assert files.length == 10
+      
+      files.each_with_index do |file, i|
+        assert file.exist?
+        assert_equal i.to_s, file.read
+      end
+      
+      file_name_strings = files.map(&:to_s)
+      assert_equal file_name_strings[1..-1], file_name_strings[1..-1].sort
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fun_with_files
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2013-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -138,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2333632354630146614
+      hash: -4306784684161945434
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: