mediatype_directory 0.0.3 → 0.0.4

data/README.markdown

@@ -23,26 +23,34 @@ Create a new MediatypeDirectory object, passing in all your configuration option
     require 'mediatype_directory'
 
     config = {}
-    config[:extensions]         = ['.flv','.mov','.mpg','.mp4']
-    config[:mediatype_dirname]  = '~/path/to/dir/where/you/want/to/create/links'
-    config[:directory_tree]     = '~/path/to/top-level-dir/you/want/to/create/mediatype-directory/for'
-    config[:linktype]           = 'hard'  # default: 'soft'
-    config[:test_mode]          = true    # default: false  In test_mode, no directories or files are actually created
+    config[:what]       = '.pdf'    # OR an array like ['.htm','.html','.shtml'] OR or a special string, 'audio' or 'video'
+    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
 
     MediatypeDirectory.new(config).create_directory
 
-It's safe to re-run the 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.
+config[:what] has an alias, config[:extensions]. You can also call "md.extensions = " or "md.what = "
+
+config[:from] has aliases config[:source] & config[:directory_tree]. You can also call "md.source =", "md.from = " or "md.directory_tree ="
+
+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.
+
+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.
 
 ## EXAMPLE
 
     require 'mediatype_directory'
 
     md = MediatypeDirectory.new({
-          extensions: [".flv",".mov",".mpg",'.mp4'],   # List of file extensions for which you wish to generate links
-          directory_tree: '/home/jimmy/Tech/Ruby',     # Where to look for existing files
-          mediatype_dirname: '~/Tech/Docs2/Videos',    # Where to store links to existing files
-          linktype: 'hard',                            # Create hard links, not soft links (a.k.a. symbolic links)
-          test_mode: true                              # Show what would happen without actually creating directories or files
+          what: [".flv",".mov",".mpg",'.mp4'],        # List of file extensions for which you wish to generate links
+          from: '/home/jimmy/Tech/Ruby',              # Where to look for existing files
+          to: '~/Tech/Docs2/Videos',                  # Where to store links to existing files
+          linktype: 'hard',                           # Create hard links, not soft links (a.k.a. symbolic links)
+          test_mode: true                             # Show what would happen without actually creating directories or files
         })
 
     md.create_directory

data/lib/mediatype_directory/mediatype_directory.rb

@@ -25,14 +25,28 @@ require 'pathname'
 #
 class MediatypeDirectory
 
-  attr_accessor :extensions, :linktype, :test_mode
-  attr_reader :mediatype_dirname, :directory_tree
+  VIDEO_FILE_EXTENSIONS = ['.3g2','.3gp','.asf','.asx','.avi','.bsf','.dat',
+                           '.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']
+
+  AUDIO_FILE_EXTENSIONS = ['.aa','.aa3','.acd','.acm','.aif','.amr','.ape',
+                           '.at3','.caf','.dcf','.dss','.emp','.emx','.flac',
+                           '.gpx','.iff','.kpl','.m3u','.m3u8','.m4a','.m4b',
+                           '.m4p','.mid','.midi','.mod','.mp3','.mpa','.mpga',
+                           '.oga','.ogg','.omf','.pcast','.ra','.ram','.snd',
+                           '.wav','.wma']
+
+  attr_accessor :extensions, :linktype
+  attr_reader :mediatype_dirname, :directory_tree, :test_mode
 
   class InvalidDirname < StandardError
   end
 
   def initialize(config)
-    self.extensions         = config[:extensions]
+    self.extensions         = config[:extensions] || config[:what]
     self.mediatype_dirname  = config[:mediatype_dirname] || config[:target] || config[:to]
     self.directory_tree     = config[:directory_tree] || config[:source] || config[:from]
     self.linktype           = config[:linktype] || 'soft'
@@ -52,6 +66,22 @@ class MediatypeDirectory
     @directory_tree = nil_or_convert_dirname(dirname)
   end
 
+  def extensions=(exts)
+    @extensions = if exts =~ /video/i
+                    VIDEO_FILE_EXTENSIONS
+                  elsif exts =~ /audio/i
+                    AUDIO_FILE_EXTENSIONS
+                  else
+                    Array(exts)
+                  end
+  end
+
+  def test_mode=(val)
+    @test_mode = (val == true || val == 'true')
+  end
+
+  alias_method :what, :extensions
+  alias_method :what=, :extensions=
   alias_method :source, :directory_tree
   alias_method :from, :directory_tree
   alias_method :source=, :directory_tree=

data/lib/mediatype_directory/version.rb

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

data/spec/mediatype_directory_spec.rb

@@ -36,7 +36,10 @@ describe MediatypeDirectory do
     FileUtils.mkdir_p('/home/xavier/Tech2/JQuery')
     FileUtils.mkdir_p('/home/xavier/Tech2/XML')
     FileUtils.touch('/home/xavier/Tech2/Ruby/ruby.pdf')
+    FileUtils.touch('/home/xavier/Tech2/Ruby/ruby.flv')
     FileUtils.touch('/home/xavier/Tech2/Ruby/TESTING/ruby_testing.pdf')
+    FileUtils.touch('/home/xavier/Tech2/Ruby/TESTING/testing.mp3')
+    FileUtils.touch('/home/xavier/Tech2/Ruby/TESTING/testing.mp4')
     FileUtils.touch('/home/xavier/Tech2/JQuery/jquery.pdf')
     FileUtils.touch('/home/xavier/Tech2/XML/xml.xml')
     Dir.chdir('/home/xavier/Tech2')
@@ -96,11 +99,54 @@ describe MediatypeDirectory do
     let(:config) { { mediatype_dirname: tilde_pdf_dir } }
   
     it { should be_true }
-    
-    #it "should set mediatype_dirname correctly" do
-    specify { subject.mediatype_dirname.should == File.expand_path(tilde_pdf_dir) }
-    #its(:mediatype_dirname) { should == File.expand_path(tilde_pdf_dir) }
-    #end
+    its(:mediatype_dirname) { should == File.expand_path(tilde_pdf_dir) }
+
+  end
+
+  context "when config sets test_mode as string 'true'" do
+
+    let(:config) { { to: tilde_pdf_dir, from: tilde_dir_tree, test_mode: 'true' } }
+  
+    it { should be_true }
+    its(:test_mode) { should be_true }
+
+  end
+
+  context "when config sets :source and :target" 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) }
+
+  end
+
+  context "when config sets :from and :to" 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) }
+
+  end
+
+  context "when config sets :what to 'ViDeO'" do
+
+    let(:config) { { to: tilde_pdf_dir, from: tilde_dir_tree, what: 'ViDeO' } }
+  
+    it { should be_true }
+    its(:extensions) { should include('.flv','.mov','.mp4','.ogv','.rm') }
+
+  end
+
+  context "when config sets :what to 'AuDiO'" do
+
+    let(:config) { { to: tilde_pdf_dir, from: tilde_dir_tree, what: 'AuDiO' } }
+  
+    it { should be_true }
+    its(:extensions) { should include('.dss','.flac','.mp3','.ogg','.ra') }
 
   end
 
@@ -132,7 +178,6 @@ describe MediatypeDirectory do
 
       it "should call :check directories and :create_links" do
         subject.should_receive(:check_directories)
-        Dir.should_receive(:chdir)
         subject.should_receive(:create_links)
         subject.create_directory
       end
@@ -148,22 +193,46 @@ describe MediatypeDirectory do
                        extensions: ['.pdf'],
                        linktype: 'hard' } }
 
-      it "should create the correct directory" do
-        subject.create_directory
-        Dir.exists?(xavier_docs_ruby).should be_true
+      context "with test_mode = false" do
+
+        it "should create the correct directory" do
+          subject.create_directory
+          Dir.exists?(xavier_docs_ruby).should be_true
+        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 == []
+          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
+
       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 == []
-        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
+      context "with test_mode = true" do
+
+        before { subject.test_mode = true }
+
+        it "should not create the correct directory" do
+          subject.create_directory
+          Dir.exists?(xavier_docs_ruby).should be_false
+        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_false
+          Dir.glob(File.join("**","*.pdf")).should_not == []
+          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

metadata

@@ -2,7 +2,7 @@
 name: mediatype_directory
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - James Lavin