mediatype_directory 0.0.4 → 0.0.5

data/README.markdown

@@ -27,7 +27,8 @@ Create a new MediatypeDirectory object, passing in all your configuration option
     config[:from]       = '~/path/to/top-level-dir/where/your/files/are'
     config[:to]         = '~/path/to/dir/where/you/want/to/create/links'
     config[:linktype]   = 'hard'    # default: 'soft'
-    config[:test_mode]  = true      # (or 'true') default: false     In test_mode, no directories or files are actually created
+    config[:test_mode]  = true      # (or 'true', default: false)   In test_mode, no directories or files are actually created and no old links are removed
+    config[:remove_old_links]  = true   # (or 'true', default: false)  If true, all existing links in the link directory are deleted before creating new links
 
     MediatypeDirectory.new(config).create_directory
 
@@ -37,7 +38,7 @@ config[:from] has aliases config[:source] & config[:directory_tree]. You can als
 
 config[:to] has aliases config[:target] & config[:mediatype_dirname]. You can also call "md.target =", "md.to = " or "md.mediatype_dirname ="
 
-It's safe to re-run this program as many times as you want. If a link already exists, it will be skipped. But if a new file is found that matches the criteria, a new link will be added.
+It's safe to re-run this program as many times as you want. If a link already exists, it will be skipped (unless you set :remove_old_links = true). But if a new file is found that matches the criteria, a new link will be added.
 
 If the original content of a hard link changes, the hard link will continue referring to the original version. You can delete the hard link (which should remove the old version from your system) and regenerate a new hardlink, which should point to the new version.
 

data/lib/mediatype_directory/mediatype_directory.rb

@@ -29,8 +29,8 @@ class MediatypeDirectory
                            '.divx','.dvdmedia','.f4v','.fbr','.flv','.hdmov',
                            '.imovieproj','.m2p','.m4v','.mod','.moi','.mov',
                            '.mp4','.mpeg','.mpg','.mts','.ogm','.ogv','.ogx',
-                           '.rm','.rmvb','.scm','.srt','.swf','.vob','.vro',
-                           '.wmv','.xvid','.yuv']
+                           '.rm','.rmvb','.scm','.srt','.vob','.vro','.wmv',
+                           '.xvid','.yuv']
 
   AUDIO_FILE_EXTENSIONS = ['.aa','.aa3','.acd','.acm','.aif','.amr','.ape',
                            '.at3','.caf','.dcf','.dss','.emp','.emx','.flac',
@@ -40,7 +40,7 @@ class MediatypeDirectory
                            '.wav','.wma']
 
   attr_accessor :extensions, :linktype
-  attr_reader :mediatype_dirname, :directory_tree, :test_mode
+  attr_reader :mediatype_dirname, :directory_tree, :test_mode, :mediatype_files, :remove_old_links
 
   class InvalidDirname < StandardError
   end
@@ -51,10 +51,12 @@ class MediatypeDirectory
     self.directory_tree     = config[:directory_tree] || config[:source] || config[:from]
     self.linktype           = config[:linktype] || 'soft'
     self.test_mode          = config[:test_mode] || false
+    self.remove_old_links   = config[:remove_old_links] || false
   end
 
   def create_directory
     check_directories
+    delete_old_links if remove_old_links
     create_links
   end
 
@@ -80,6 +82,10 @@ class MediatypeDirectory
     @test_mode = (val == true || val == 'true')
   end
 
+  def remove_old_links=(val)
+    @remove_old_links = (val == true || val == 'true')
+  end
+
   alias_method :what, :extensions
   alias_method :what=, :extensions=
   alias_method :source, :directory_tree
@@ -99,7 +105,7 @@ class MediatypeDirectory
 
   def create_links
     @mediatype_files = get_all_mediatype_files
-    #puts "Found these files: " + @mediatype_files.to_s
+    #puts "Found these files: " + mediatype_files.to_s
     mediatype_files_to_links
   end
 
@@ -107,44 +113,51 @@ class MediatypeDirectory
   # matching one of the file extensions
   def get_all_mediatype_files
     puts "Searching for files in #{directory_tree}"
-    Dir.chdir(directory_tree)
-    mediatype_files = []
+    # Rewrote to use absolute search paths because FakeFS chokes on Dir.chdir
+    matching_files = []
     @extensions.each do |ex|
-      search_for = File.join("**", '*' + ex)        # example: "**/*.pdf"
-      mediatype_files.concat(Dir.glob(search_for))
+      search_for = File.join(directory_tree, "**", '*' + ex)        # example: "/home/xavier/Tech/Docs/**/*.pdf"
+      matching_files.concat(Dir.glob(search_for))
     end
-    puts "Found these files: " + mediatype_files.to_s
-    convert_to_pathnames(mediatype_files).delete_if { |mf| mf.dirname.to_s == @mediatype_dirname }
+    #puts "Found these files: " + matching_files.to_s
+    convert_to_pathnames(matching_files).delete_if { |file| file.dirname.to_s == mediatype_dirname.to_s }
   end
 
-  def convert_to_pathnames(filenames)
-    filenames.map { |mf| Pathname.new(mf).realdirpath }
+  def convert_to_pathnames(path_string_array)
+    path_string_array.map { |path_string| Pathname.new(path_string) }
   end
 
   def mediatype_files_to_links
-    Dir.chdir(mediatype_dirname) unless test_mode
-    @mediatype_files.each do |pathname|
+    mediatype_files.each do |pathname|
       mediatype_file_to_link pathname
     end
   end
 
+  # In test_mode with delete_old_links, we want to pretend the links
+  # have been deleted, even though we're not actually deleting them
+  def pretend_links_do_not_exist
+    test_mode && remove_old_links
+  end
+
   def mediatype_file_to_link(pathname)
     puts "Attempting to create link for #{pathname.to_s}"
     link = source_pathname_to_target_pathname(pathname)
-    if File.exists?(link.to_s)
+    if File.exists?(link.to_s)  && !pretend_links_do_not_exist
       puts "WARNING: #{link.to_s} already exists"
     else
       puts "Creating #{link.to_s}"
-      (hardlinks? ? FileUtils.ln(pathname.to_s, link.to_s) : FileUtils.ln_s(pathname.to_s, link.to_s)) unless test_mode
+      # Switched from File.link to FileUtils.ln because FakeFS doesn't know FileUtils.ln but knows File.link
+      (hardlinks? ? File.link(pathname.to_s, link.to_s) : FileUtils.ln_s(pathname.to_s, link.to_s)) unless test_mode
     end
   end
 
   def source_pathname_to_target_pathname(source_pathname)
-    Pathname.new(mediatype_dirname) + source_pathname.basename
+    #Pathname.new(mediatype_dirname) + source_pathname.basename
+    mediatype_dirname + source_pathname.basename
   end
 
   def nil_or_convert_dirname(dirname)
-    (dirname.nil? || dirname == '') ? nil : convert_dirname(dirname)
+    (dirname.nil? || dirname == '') ? nil : convert_to_pathname(expand_path(dirname))
   end
 
   def check_directories
@@ -154,7 +167,7 @@ class MediatypeDirectory
 
   def create_missing_directories
     [mediatype_dirname, directory_tree].each do|dn|
-      make_dirname(dn)
+      make_dirname(dn.to_s)
     end
   end
 
@@ -164,21 +177,43 @@ class MediatypeDirectory
     end
   end
 
-  def make_dirname(dn)
-    unless File.directory? dn
-      puts "Creating directory #{dn}"
-      FileUtils.mkdir_p(dn) unless test_mode
+  def make_dirname(dn_string)
+    unless File.directory? dn_string
+      puts "Creating directory #{dn_string}"
+      FileUtils.mkdir_p(dn_string) unless test_mode
     end
   end
 
   # Ideally, should use a regexp that matches valid directories
   # For now, a simple sanity check
   def validate_dirname(dirname)
-    raise MediatypeDirectory::InvalidDirname, "#{dirname} is not a valid directory name" if dirname.match(/\s/) || !dirname.match(/^\//)
+    if !dirname.to_s.match(/^\//)
+      raise MediatypeDirectory::InvalidDirname, "#{dirname.to_s} is not a valid directory name"
+    end
+  end
+
+  def expand_path(path)
+    File.expand_path(path)
   end
 
-  def convert_dirname(dirname)
-    File.expand_path(dirname)
+  def convert_to_pathname(path)
+    Pathname.new(path)
+  end
+
+  def delete_old_links
+    old_links.each do |ol|
+      puts "Deleting file #{ol}"
+      File.unlink(ol) unless test_mode
+    end
+  end
+
+  def old_links
+    old_links = []
+    @extensions.each do |ex|
+      search_for = File.join(mediatype_dirname, "**", '*' + ex)        # example: "/home/xavier/Tech/Docs/**/*.pdf"
+      old_links.concat(Dir.glob(search_for))
+    end
+    old_links
   end
 
 end

data/lib/mediatype_directory/version.rb

@@ -1,3 +1,3 @@
 module MediatypeDirectory
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/mediatype_directory_spec.rb

@@ -1,6 +1,5 @@
 require "spec_helper"
 require_relative '../lib/mediatype_directory/mediatype_directory'
-#require 'fakefs'
 
 # Overriding FakeFS' File.expand_path
 # because it delegates to the same class
@@ -11,6 +10,8 @@ module FakeFS
       args[0].gsub(/~/,'/home/xavier')
     end
   end
+  # Started overriding FileUtils.ln because FakeFS doesn't know about it
+  # Instead switched to using File.link, which FakeFS knows about
 end
 
 # Overriding File.expand_path
@@ -50,12 +51,10 @@ describe MediatypeDirectory do
     specify { Dir.exists?('/home/xavier/Tech2/JQuery') }
     specify { Dir.pwd == '/home/xavier/Tech2' }
     it "should find files using Dir.glob" do
-      pending "This test fails because FakeFS is broken"
-      # https://github.com/defunkt/fakefs/issues/142
-      # https://github.com/defunkt/fakefs/issues/121
-      Dir.chdir("/home/xavier/Tech2")
-      Dir.getwd.should == "/home/xavier/Tech2"
-      Dir.glob(File.join("**","*.pdf")).should_not == []
+      Dir.glob(File.join("/home/xavier/Tech2","**","*.pdf")).should == 
+           ["/home/xavier/Tech2/JQuery/jquery.pdf", 
+            "/home/xavier/Tech2/Ruby/TESTING/ruby_testing.pdf",
+            "/home/xavier/Tech2/Ruby/ruby.pdf"]
     end
   end
 
@@ -70,7 +69,7 @@ describe MediatypeDirectory do
 
       before { subject.mediatype_dirname = tilde_pdf_dir }
 
-      its(:mediatype_dirname) { should == File.expand_path(tilde_pdf_dir) }
+      its(:mediatype_dirname) { should == Pathname.new(File.expand_path(tilde_pdf_dir)) }
 
     end
 
@@ -78,7 +77,7 @@ describe MediatypeDirectory do
 
       before { subject.directory_tree = tilde_dir_tree }
 
-      its(:directory_tree) { should == File.expand_path(tilde_dir_tree) }
+      its(:directory_tree) { should == Pathname.new(File.expand_path(tilde_dir_tree)) }
 
     end
 
@@ -99,7 +98,7 @@ describe MediatypeDirectory do
     let(:config) { { mediatype_dirname: tilde_pdf_dir } }
   
     it { should be_true }
-    its(:mediatype_dirname) { should == File.expand_path(tilde_pdf_dir) }
+    its(:mediatype_dirname) { should == Pathname.new(File.expand_path(tilde_pdf_dir)) }
 
   end
 
@@ -117,8 +116,8 @@ describe MediatypeDirectory do
     let(:config) { { target: tilde_pdf_dir, source: tilde_dir_tree } }
   
     it { should be_true }
-    its(:mediatype_dirname) { should == File.expand_path(tilde_pdf_dir) }
-    its(:directory_tree) { should == File.expand_path(tilde_dir_tree) }
+    its(:mediatype_dirname) { should == Pathname.new(File.expand_path(tilde_pdf_dir)) }
+    its(:directory_tree) { should == Pathname.new(File.expand_path(tilde_dir_tree)) }
 
   end
 
@@ -127,8 +126,8 @@ describe MediatypeDirectory do
     let(:config) { { to: tilde_pdf_dir, from: tilde_dir_tree } }
   
     it { should be_true }
-    its(:mediatype_dirname) { should == File.expand_path(tilde_pdf_dir) }
-    its(:directory_tree) { should == File.expand_path(tilde_dir_tree) }
+    its(:mediatype_dirname) { should == Pathname.new(File.expand_path(tilde_pdf_dir)) }
+    its(:directory_tree) { should == Pathname.new(File.expand_path(tilde_dir_tree)) }
 
   end
 
@@ -155,7 +154,7 @@ describe MediatypeDirectory do
     let(:config) { { directory_tree: tilde_dir_tree } }
   
     it { should be_true }
-    its(:directory_tree) { should == File.expand_path(tilde_dir_tree) }
+    its(:directory_tree) { should == Pathname.new(File.expand_path(tilde_dir_tree)) }
 
   end
 
@@ -201,18 +200,38 @@ describe MediatypeDirectory do
         end
 
         it "should create the correct files" do
-          pending "This test fails because FakeFS is broken"
           subject.create_directory
           Dir.exists?('/home/xavier/Tech3/Docs/Ruby').should be_true
-          Dir.chdir('/home/xavier/Tech3/Docs/Ruby')
-          Dir.getwd.should == '/home/xavier/Tech3/Docs/Ruby'
-          Dir.glob(File.join("**","*.pdf")).should_not == []
+          Dir.glob(File.join("/home/xavier/Tech3","**","*.pdf")).should == 
+              ["/home/xavier/Tech3/Docs/Ruby/ruby.pdf",
+               "/home/xavier/Tech3/Docs/Ruby/ruby_testing.pdf"]
           File.exists?('/home/xavier/Tech3/Docs/Ruby/ruby_testing.pdf').should be_true
           File.exists?('/home/xavier/Tech3/Docs/Ruby/ruby.pdf').should be_true
           File.exists?('/home/xavier/Tech3/Docs/jquery.pdf').should be_false
           File.exists?('/home/xavier/Tech3/Docs/xml.xml').should be_false
         end
 
+        context "with remove_old_links = true" do
+        
+          before do
+            FileUtils.mkdir_p('/home/xavier/Tech3/Docs/Ruby')
+            FileUtils.touch('/home/xavier/Tech3/Docs/Ruby/ruby_testing.pdf')
+            FileUtils.touch('/home/xavier/Tech3/Docs/Ruby/ruby.pdf')
+            File.exists?('/home/xavier/Tech3/Docs/Ruby/ruby_testing.pdf').should be_true
+            File.exists?('/home/xavier/Tech3/Docs/Ruby/ruby.pdf').should be_true
+            subject.remove_old_links = true
+          end
+
+          it "should remove old links" do
+            subject.should_receive(:check_directories)
+            subject.should_receive(:create_links)
+            subject.create_directory
+            File.exists?('/home/xavier/Tech3/Docs/Ruby/ruby_testing.pdf').should be_false
+            File.exists?('/home/xavier/Tech3/Docs/Ruby/ruby.pdf').should be_false
+          end
+
+        end
+
       end
 
       context "with test_mode = true" do
@@ -224,22 +243,65 @@ describe MediatypeDirectory do
           Dir.exists?(xavier_docs_ruby).should be_false
         end
 
-        it "should create the correct files" do
-          pending "This test fails because FakeFS is broken"
+        it "should not create any files" do
           subject.create_directory
           Dir.exists?('/home/xavier/Tech3/Docs/Ruby').should be_false
-          Dir.glob(File.join("**","*.pdf")).should_not == []
+          Dir.glob(File.join("/home/xavier/Tech3/Docs/Ruby","**","*.pdf")).should == []
           File.exists?('/home/xavier/Tech3/Docs/Ruby/ruby_testing.pdf').should be_false
           File.exists?('/home/xavier/Tech3/Docs/Ruby/ruby.pdf').should be_false
         end
 
+        context "with remove_old_links = true" do
+        
+          before do
+            FileUtils.mkdir_p('/home/xavier/Tech3/Docs/Ruby')
+            FileUtils.touch('/home/xavier/Tech3/Docs/Ruby/ruby_testing.pdf')
+            FileUtils.touch('/home/xavier/Tech3/Docs/Ruby/ruby.pdf')
+            File.exists?('/home/xavier/Tech3/Docs/Ruby/ruby_testing.pdf').should be_true
+            File.exists?('/home/xavier/Tech3/Docs/Ruby/ruby.pdf').should be_true
+            subject.remove_old_links = true
+          end
+
+          it "should not remove old links" do
+            subject.should_receive(:check_directories)
+            subject.should_receive(:create_links)
+            subject.create_directory
+            File.exists?('/home/xavier/Tech3/Docs/Ruby/ruby_testing.pdf').should be_true
+            File.exists?('/home/xavier/Tech3/Docs/Ruby/ruby.pdf').should be_true
+          end
+
+        end
+
+      end
+
+    end
+
+    context "when mediatype_dirname & directory_tree are valid" do
+
+      let(:config) { { mediatype_dirname: '/home/xavier/Tech3',
+                       directory_tree: '/home/xavier/Tech2' } }
+ 
+      it "throws InvalidDirname error" do
+        expect { subject.create_directory }.to_not raise_error(MediatypeDirectory::InvalidDirname)
       end
 
     end
 
     context "when invalid mediatype_dirname" do
 
-      let(:config) { { mediatype_dirname: '~/techfiles/ /pd fs' } }
+      let(:config) { { mediatype_dirname: 'not/valid/xavier/Tech3',
+                       directory_tree: '/home/xavier/Tech2' } }
+ 
+      it "throws InvalidDirname error" do
+        expect { subject.create_directory }.to raise_error(MediatypeDirectory::InvalidDirname)
+      end
+
+    end
+
+    context "when invalid directory_tree" do
+
+      let(:config) { { mediatype_dirname: '/home/xavier/Tech3',
+                       directory_tree: 'totally/invalid/xavier/Tech2' } }
  
       it "throws InvalidDirname error" do
         expect { subject.create_directory }.to raise_error(MediatypeDirectory::InvalidDirname)

metadata

@@ -2,14 +2,14 @@
 name: mediatype_directory
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - James Lavin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-08-29 00:00:00.000000000 Z
+date: 2012-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec