mediatype_directory 0.0.2

data/.gitignore

@@ -0,0 +1,2 @@
+*.swp
+*.gem

data/README.markdown

@@ -0,0 +1,51 @@
+# MediatypeDirectory
+
+## DESCRIPTION
+
+MediatypeDirectory lets Linux/Mac users create a directory of (soft or hard) links to all files of a specified media type (or types) in a directory tree.
+
+## WHY?
+
+I store content (text files, PDFs, HTML pages, office suite files, audio files, video files, etc.) mixed together in directory trees organized by subject. For example, the directory ~/Tech/Ruby/TESTING/RSpec may hold videos, HTML files, PDFs, podcasts, etc. all related to RSpec testing in Ruby.
+
+But when I'm programming, I often want to quickly grab a PDF reference document without searching through the directory tree. I want links to PDF files on Jasmine, RSpec, Rails, Ruby, Coffeescript, Underscore, JQuery, Javascript, Backbone, etc. all in one directory.
+
+And when I have free time to watch videos, I'd like to quickly see the list of all available programming video files.
+
+## REQUIREMENTS
+
+I've run this only on Linux. It likely works on OS X. It probably won't work on Windows.
+
+## BASIC USAGE
+
+Create a new MediatypeDirectory object, passing in all your configuration options (or setting them on the object via setters). Then tell the new object to .create_directory:
+
+    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
+
+    MediatypeDirectory.new(config).create_directory
+
+## 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
+        })
+
+    md.create_directory
+
+## LEGAL DISCLAIMER
+
+Please use at your own risk. I guarantee nothing about this program.
+

data/examples/create_pdf_dir.rb

@@ -0,0 +1,10 @@
+require_relative '../lib/mediatype_directory/mediatype_directory'
+
+md = MediatypeDirectory.new({
+      extensions: ['.pdf'],
+      directory_tree: '/home/jimmy/Tech/Ruby/DOCUMENTATION',
+      mediatype_dirname: '~/Tech/Docs2/PDFs',
+      linktype: 'hard'
+    })
+
+md.create_directory

data/examples/create_video_dir.rb

@@ -0,0 +1,10 @@
+require_relative '../lib/mediatype_directory/mediatype_directory'
+
+md = MediatypeDirectory.new({
+      extensions: [".flv",".mov",".mpg",'.mp4'],
+      directory_tree: '/home/jimmy/Tech/Ruby',
+      mediatype_dirname: '~/Tech/Docs2/Videos',
+      linktype: 'hard'
+    })
+
+md.create_directory

data/lib/mediatype_directory.rb

@@ -0,0 +1 @@
+require_relative 'mediatype_directory/mediatype_directory'

data/lib/mediatype_directory/mediatype_directory.rb

@@ -0,0 +1,145 @@
+require 'rubygems'
+require 'fileutils'
+require 'pathname'
+
+# MediatypeDirectory.new takes a configuration hash and creates an object with a create_directory() method
+# Calling create_directory() on the MediatypeDirectory object creates a directory, configured according to 
+# the configuration hash settings, containing softlinks to all files of the requested file extension(s) in
+# the specified directory tree.
+#
+# Usage:
+# MediatypeDirectory.new(options_hash).create_directory
+#
+# Alternative usage:
+# md = MediatypeDirectory.new
+# md.property = value (for all desired property-value pairs)
+# md.create_directory
+#
+# Example:
+# To create a directory at '~/Tech/Docs/PDFs' with softlinks to all PDF and ODT files under '~/Tech':
+# md = MediatypeDirectory.new
+# md.extensions        = ['.pdf','.odt']
+# md.mediatype_dirname = '~/Tech/Docs/PDFs'
+# md.directory_tree    = '~/Tech'
+# md.create_directory
+#
+class MediatypeDirectory
+
+  attr_accessor :extensions, :linktype, :test_mode
+  attr_reader :mediatype_dirname, :directory_tree
+
+  class InvalidDirname < StandardError
+  end
+
+  def initialize(config)
+    self.extensions         = config[:extensions]
+    self.mediatype_dirname  = config[:mediatype_dirname]
+    self.directory_tree     = config[:directory_tree]
+    self.linktype           = config[:linktype] || 'soft'
+    self.test_mode          = config[:test_mode] || false
+  end
+
+  def create_directory
+    check_directories
+    create_links
+  end
+
+  def mediatype_dirname=(dirname)
+    @mediatype_dirname = nil_or_convert_dirname(dirname)
+  end
+
+  def directory_tree=(dirname)
+    @directory_tree = nil_or_convert_dirname(dirname)
+  end
+
+  private
+
+  def hardlinks?
+    @linktype == 'hard'
+  end
+
+  def create_links
+    @mediatype_files = get_all_mediatype_files
+    #puts "Found these files: " + @mediatype_files.to_s
+    mediatype_files_to_links
+  end
+
+  # returns array of file pathnames in the directory_tree
+  # matching one of the file extensions
+  def get_all_mediatype_files
+    puts "Searching for files in #{directory_tree}"
+    Dir.chdir(directory_tree)
+    mediatype_files = []
+    @extensions.each do |ex|
+      search_for = File.join("**", '*' + ex)        # example: "**/*.pdf"
+      mediatype_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 }
+  end
+
+  def convert_to_pathnames(filenames)
+    filenames.map { |mf| Pathname.new(mf).realdirpath }
+  end
+
+  def mediatype_files_to_links
+    Dir.chdir(mediatype_dirname) unless test_mode
+    @mediatype_files.each do |pathname|
+      mediatype_file_to_link pathname
+    end
+  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)
+      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
+    end
+  end
+
+  def source_pathname_to_target_pathname(source_pathname)
+    Pathname.new(mediatype_dirname) + source_pathname.basename
+  end
+
+  def nil_or_convert_dirname(dirname)
+    (dirname.nil? || dirname == '') ? nil : convert_dirname(dirname)
+  end
+
+  def check_directories
+    validate_directories
+    create_missing_directories
+  end
+
+  def create_missing_directories
+    [mediatype_dirname, directory_tree].each do|dn|
+      make_dirname(dn)
+    end
+  end
+
+  def validate_directories
+    [mediatype_dirname, directory_tree].each do|dn|
+      validate_dirname(dn)
+    end
+  end
+
+  def make_dirname(dn)
+    unless File.directory? dn
+      puts "Creating directory #{dn}"
+      FileUtils.mkdir_p(dn) 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(/^\//)
+  end
+
+  def convert_dirname(dirname)
+    File.expand_path(dirname)
+  end
+
+end

data/lib/mediatype_directory/version.rb

@@ -0,0 +1,3 @@
+module MediatypeDirectory
+  VERSION = "0.0.2"
+end

data/license.txt

@@ -0,0 +1,20 @@
+Copyright (C) 2011 by James K. Lavin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/mediatype_directory.gemspec

@@ -0,0 +1,20 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'mediatype_directory/version'
+
+Gem::Specification.new do |s|
+  s.name            = 'mediatype_directory'
+  s.version         = MediatypeDirectory::VERSION
+  s.platform        = Gem::Platform::RUBY
+  s.authors         = ['James Lavin']
+  s.email           = ['mediatype_directory@futureresearch.com']
+  s.homepage        = "https://github.com/JamesLavin/mediatype_directory"
+  s.summary         = %q{Creates directory of links for all files with specified mediatype in subdirectory tree}
+  s.description     = %q{Creates directory of hard or soft links for all files with specified mediatype (.pdf, .mp4, etc.) in subdirectory tree}
+  #s.add_runtime_dependency = ['fileutils','pathname']
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'fakefs'
+  s.require_paths   = ['lib']
+  s.files           = `git ls-files`.split("\n")
+  s.test_files      = `git ls-files -- {test,spec,features}/*`.split("\n")
+  #s.executables     = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+end

data/spec/mediatype_directory_spec.rb

@@ -0,0 +1,183 @@
+require "spec_helper"
+require_relative '../lib/mediatype_directory/mediatype_directory'
+#require 'fakefs'
+
+# Overriding FakeFS' File.expand_path
+# because it delegates to the same class
+# method in the REAL file system
+module FakeFS
+  class File
+    def self.expand_path(*args)
+      args[0].gsub(/~/,'/home/xavier')
+    end
+  end
+end
+
+# Overriding File.expand_path
+# so it will provide the fake user's
+# home directory
+class File
+  def self.expand_path(*args)
+    args[0].gsub(/~/,'/home/xavier')
+  end
+end
+
+describe MediatypeDirectory do
+
+  subject { MediatypeDirectory.new(config) }
+
+  let(:tilde_pdf_dir) { '~/my/pdf_dir' }
+  let(:tilde_dir_tree) { '~/my/techfiles' }
+  let(:exts) { ['.pdf','.odt'] }
+  
+  before do
+    FileUtils.mkdir_p('/home/xavier/Tech2')
+    FileUtils.mkdir_p('/home/xavier/Tech2/Ruby/TESTING')
+    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/TESTING/ruby_testing.pdf')
+    FileUtils.touch('/home/xavier/Tech2/JQuery/jquery.pdf')
+    FileUtils.touch('/home/xavier/Tech2/XML/xml.xml')
+    Dir.chdir('/home/xavier/Tech2')
+  end
+
+  describe "test that FakeFS is properly configured" do
+    specify { File.exists?('/home/xavier/Tech2/Ruby/ruby.pdf') }
+    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 == []
+    end
+  end
+
+  context "when config is empty hash" do
+
+    let(:config) { {} }
+
+    it { should be_true }
+    it { should respond_to :create_directory }
+  
+    context "when setter sets mediatype_dirname" do
+
+      before { subject.mediatype_dirname = tilde_pdf_dir }
+
+      its(:mediatype_dirname) { should == File.expand_path(tilde_pdf_dir) }
+
+    end
+
+    context "when setter sets directory_tree" do
+
+      before { subject.directory_tree = tilde_dir_tree }
+
+      its(:directory_tree) { should == File.expand_path(tilde_dir_tree) }
+
+    end
+
+    context "when setter sets extensions" do
+
+      before do
+        subject.extensions = exts
+      end
+
+      its(:extensions) { should == exts }
+
+    end
+
+  end
+
+  context "when config sets mediatype_dirname" 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
+
+  end
+
+  context "when config sets directory_tree" do
+
+    let(:config) { { directory_tree: tilde_dir_tree } }
+  
+    it { should be_true }
+    its(:directory_tree) { should == File.expand_path(tilde_dir_tree) }
+
+  end
+
+  context "when config sets extensions" do
+
+    let(:config) { { extensions: exts } }
+  
+    it { should be_true }
+    its(:extensions) { should == exts }
+
+  end
+
+  describe "#create_directory" do
+
+    context "when values are set properly (with tildes)" do
+
+      let(:config) { { mediatype_dirname: tilde_pdf_dir,
+                       directory_tree: tilde_dir_tree,
+                       extensions: exts } }
+
+      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
+
+    end
+
+    context "when values are set properly (with full paths)" do
+
+      let(:xavier_docs_ruby) { '/home/xavier/Tech3/Docs/Ruby' }
+      let(:xavier_ruby) { '/home/xavier/Tech2/Ruby' }
+      let(:config) { { mediatype_dirname: xavier_docs_ruby,
+                       directory_tree: xavier_ruby,
+                       extensions: ['.pdf'],
+                       linktype: 'hard' } }
+
+      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
+
+    context "when invalid mediatype_dirname" do
+
+      let(:config) { { mediatype_dirname: '~/techfiles/ /pd fs' } }
+ 
+      it "throws InvalidDirname error" do
+        expect { subject.create_directory }.to raise_error(MediatypeDirectory::InvalidDirname)
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'fakefs/spec_helpers'
+
+RSpec.configure do |config|
+  config.include FakeFS::SpecHelpers
+end
+
+Dir["./spec/support/**/*.rb"].each {|f| require f}

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: mediatype_directory
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.2
+platform: ruby
+authors:
+- James Lavin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :development
+description: Creates directory of hard or soft links for all files with specified mediatype (.pdf, .mp4, etc.) in subdirectory tree
+email:
+- mediatype_directory@futureresearch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.markdown
+- examples/create_pdf_dir.rb
+- examples/create_video_dir.rb
+- lib/mediatype_directory.rb
+- lib/mediatype_directory/mediatype_directory.rb
+- lib/mediatype_directory/version.rb
+- license.txt
+- mediatype_directory.gemspec
+- spec/mediatype_directory_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/JamesLavin/mediatype_directory
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Creates directory of links for all files with specified mediatype in subdirectory tree
+test_files: []
+...