media-organizer 0.1.2 → 0.1.3

data/lib/filescanner.rb

@@ -8,11 +8,18 @@ require 'scrapers/music.rb'
 
 module MediaOrganizer
 
-  class FileNotValidError < StandardError ; end
 
+  #FileScanner: scans a file system for images and/or music files, providing a list of file URIs.
+  #Output of FileScanner.open() returns a list of paths that can then be consumed by MediaOrganizer::Renamer.
+  #
+  #===Example
+  #
+  #Filescanner.open("/path/to/files/", {:image => true, :music => true})
+  #
+  #This will return a list of all music and image files contained in /path/to/files/ and it's
   class Filescanner
-    include Image
-    include Music
+    class FileNotValidError < StandardError ; end
+
 
     attr_reader :root_nodes
     attr_accessor :source_list
@@ -26,21 +33,19 @@ module MediaOrganizer
     #
     #Filescanner.open(String, {}): scans directory tree for media files, starting at String specified in first argument.
     #
-    #==Inputs
-    #===Required
-    #(1) String: String containing the URI of the top of the directory tree to scan
+    #===Inputs
+    #   *(1) String: String containing the URI of the top of the directory tree to scan
     #
-    #===Optional
-    #(2) Arguments Hash:
-    #*:mode => (:single) -- if set to :single, only the given URI will be scanned. Subdirectories will be ignored. 
-    #*:music => (true, false) -- if true, music files will be included in the scan. Set to false to exclude music files. Defaults to true
-    #*:image => (true, false) -- if true, image files will be included in the scan. Set to false to exclude image files. Defaults to true
+    #   *2: Optional Arguments Hash:
+    #     *:mode => (:single) -- if set to :single, only the given URI will be scanned. Subdirectories will be ignored. 
+    #     *:music => (true, false) -- if true, music files will be included in the scan. Set to false to exclude music files. Defaults to true
+    #     *:image => (true, false) -- if true, image files will be included in the scan. Set to false to exclude image files. Defaults to true
     #
-    #==Outputs
+    #===Outputs
     #Returns array of strings, where each string is a file URI for a music or image file. 
     #
     #
-    #==Usage Example
+    #===Example
     #Filescanner.open("/absolute/path/for/top/of/directory/tree")
     #
     def open(uri = "", args = {})
@@ -72,7 +77,7 @@ module MediaOrganizer
       return false
     end
 
-    #alternative run mode. Add multiple "root" directories to scan at once
+    #Alternative run mode. Add multiple "root" directories to scan at once
     def addRoot(dir_uri)
         unless !dir_uri.nil? && dir_uri.is_a?(String) && File.directory?(dir_uri)   
           raise FileNotFoundError, "Directory given (#{dir_uri}) could not be accessed."
@@ -84,23 +89,16 @@ module MediaOrganizer
       return false
     end
 
-    #<<(): synonym for addRoot(). Also a deformed emoticon.
-  #  def << (dir_uri) addRoot(dir_uri)  end
-
-    #
-    #multiscan(): scans multiple directories added to @root_nodes using the addRoot() method.
+    #Filescanner:multiscan(): scans multiple directories added to @root_nodes using the addRoot() method.
     #
-    #==Inputs
-    #===Required
-    #none  
+    #===Inputs
     #
-    #===Optional
-    #(1) Arguments Hash:
-    #*:mode => (:single, :multiple) 
-    #*:music => (true, false) -- if true, music files will be included in the scan. Set to false to exclude music files. Defaults to true
-    #*:image => (true, false) -- if true, image files will be included in the scan. Set to false to exclude image files. Defaults to true
+    #   *Optional Arguments Hash:
+    #     *:mode => (:single, :multiple) 
+    #     *:music => (true, false) -- if true, music files will be included in the scan. Set to false to exclude music files. Defaults to true
+    #     *:image => (true, false) -- if true, image files will be included in the scan. Set to false to exclude image files. Defaults to true
     #
-    #==Outputs
+    #===Outputs
     #Array of strings, where each string is a file URI for a music or image file.
     #
     def multiscan(args = {})

data/lib/media-organizer.rb

@@ -3,8 +3,19 @@
 require 'renamer.rb'
 require 'filescanner.rb'
 
+#MediaOrganizer: namespace container for MediaOrganizer sub-classes:
+# 	*Renamer
+# 	*Filescanner
+# 	*Image
+# 	*Music
 module MediaOrganizer
 	VERSION = "0.1.2"	
 
+	class FileNotValidError < StandardError ; end
+	class InvalidArgumentError < StandardError ; end
+	class UnsupportedFileTypeError < StandardError ; end
+	class RenameFailedError < StandardError ; end
+	class FileNotFoundError < StandardError ; end
+
 end
 

data/lib/renamer.rb

@@ -5,11 +5,6 @@ require 'scrapers/image.rb'
 require 'scrapers/music.rb'
 
 module MediaOrganizer
-
-	class FileNotValidError < StandardError ; end
-	class InvalidArgumentError < StandardError ; end
-	class UnsupportedFileTypeError < StandardError ; end
-	class RenameFailedError < StandardError ; end
 	
 	#Renamer: primary class to use for renaming files. Allows renaming of a given list of files to a user-defined scheme based on each file's metadata.
 	#
@@ -34,6 +29,12 @@ module MediaOrganizer
 	#
 	class Renamer
 		DISALLOWED_CHARACTERS = /[\\:\?\*<>\|"\/]/ 	#Characters that are not allowed in file names by many file systems. Replaced with @subchar character.
+		class RenameFailedError < StandardError ; end
+		class FileNotValidError < StandardError ; end
+		class InvalidArgumentError < StandardError ; end
+		class UnsupportedFileTypeError < StandardError ; end
+		class FileNotFoundError < StandardError ; end
+
 
 		attr_accessor	:naming_scheme 	#Array of strings and literals used to construct filenames. Set thruough setNamingScheme as opposed to typical/default accessor.
 		attr_accessor 	:subchar 		#Character with which to substitute disallowed characters

data/lib/scrapers/image.rb

@@ -1,11 +1,10 @@
 require 'exifr'
 
-class FileNotFoundError < StandardError ; end
-
 module MediaOrganizer
 
 	module Image
 		SUPPORTED_FILETYPES = %w{.jpg .tif}
+		class FileNotFoundError < StandardError ; end
 
 		def Image.getJpegData(file)
 			meta = EXIFR::JPEG.new(file)

data/lib/scrapers/music.rb

@@ -2,9 +2,8 @@ require 'taglib'
 
 module MediaOrganizer
 
-	class FileNotFoundError < StandardError ; end
-
 	module Music
+		class FileNotFoundError < StandardError ; end
 
 		SUPPORTED_FILETYPES = %w{.mp3 .m4a .mp4 .flac .m4a .ogg .aiff .asf .wav}
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: media-organizer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,55 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-14 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: taglib-ruby
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: exifr
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: ! 'Provides a set of functions for scanning directory trees and dynamically
-  renaming files using their metadata, according to a customizable taxonomy. For example,
-  use media-organizer to set filenames for a directory of photos to a standard such
-  as: "<date-taken> - Ski Vacation.jpg". Currently supports only JPEG and TIFF files,
-  and various music formats.'
+date: 2015-03-24 00:00:00.000000000 Z
+dependencies: []
+description: ! 'Provides a set of functions to scan file systems for media files,
+  and dynamically rename them using their metadata. Files are renamed according to
+  a customizable taxonomy. For example, use MediaOrganizer::Renamer to set filenames
+  for a directory of photos to a standard such as: "<date-taken> - Ski Vacation.jpg".
+  Currently supports only JPEG and TIFF files. Future releases will include support
+  for music and additional image files.'
 email: djeserkare@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/media-organizer.rb
 - lib/renamer.rb
+- lib/media-organizer.rb
 - lib/filescanner.rb
-- lib/scrapers/image.rb
 - lib/scrapers/music.rb
+- lib/scrapers/image.rb
 homepage: http://rubygems.org/gems/media-organizer
 licenses:
 - MIT
@@ -82,5 +51,5 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Organize & rename files in bulk based on file metadata.
+summary: Rename media files in bulk based on file metadata.
 test_files: []