imagebackup 0.2.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19afaa9b557d9f7f975671cbac434cc122ba66c45530b151ca1e3f2927fa721e
-  data.tar.gz: 99c50850195ec05e5689736a0e382596ab5513e5246e8e63abf8b15f03137527
+  metadata.gz: 3ff05d8110aa15c4add99cca0b1d41174fd3978e59e5d744a2411012e7a8e838
+  data.tar.gz: 3ef406408a286734d760175db13b1255cf1b6c025792cd5daa6e32152a9fc134
 SHA512:
-  metadata.gz: 67bb185227e95535d45675263420321bdc42ae3c3616d446d4ef3592c301087f9a82f89216d9249f280f06762b492efdb234c0154892d668a3faeca2791d15d3
-  data.tar.gz: bfe84709a6a03bbcf7135683dd352cd6a0a70e2430a91b4276d53ff6980d12c15a3e70036b640f3e2a672eb327cf8b2493a6d09bbdc9dfe7fefe386012aad9b3
+  metadata.gz: ac5e4ede52a1a770419472068e66c64e02ef7688616c1c44be1a76e384ecc242e9cbfd05517a5bd2876153202af793e473f157fe382bcfb7a2e939763a6e0d62
+  data.tar.gz: f77229df988fa05d9b653d438edf106a3bafcdca787b64838927e4081e44bcedcd6f1bc41f62c8e1d13d214929dbf9a73d60381ef09723fe47e6686c679c5f91

data/.gitignore

@@ -6,6 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-
+README_assessment.md
 # rspec failure tracking
 .rspec_status

data/Gemfile

@@ -1,7 +1,9 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in imagebackup.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/README.md

@@ -2,34 +2,86 @@
 
 ## Keep your photos and videos organized by date.
 
-### A simple terminal app to crawl a folder (usually a camera card's DCIM folder) for pictures and videos, and pop them in dated folders to your destination folder of choice. Uses exif data when available, creation_time, or the file's own creation date if nothing better is present.
+### A simple terminal app to crawl a folder (usually a camera card's DCIM folder) for pictures and videos, and pop them in dated folders to your destination folder of choice. Uses exif data when available, creation_time, or the file's own creation date if nothing better is present.  
+### Will also copy over any xmp sidecar files found, not overwriting.
 
+Source is available here: [https://github.com/adrian-sal-kennedy/imagebackup]()
 
-## Dependencies:
+## Options:
+-n, --dry-run  
+Run without actually doing anything. Good for making sure things are working properly. This will also give you console output which helps identify unreadable files.
 
-**Ruby** v2.3.0 or greater, plus gems:
-  - exiv2
-  - ffprober  
+-a, --add-filetype *extension* *type*  
+This will add a custom file type to the list of files it's looking for. If you have an arcane digital camera (we currently support canon, sony, pentax but new stuff comes out all the time), this will allow you to add your raw files.  
+You can also access *filetypes.csv* and add them manually, but ensure there's a blank line at the end or this program may behave badly.
 
-Ruby modules:
-  - fileutils.rb
-  - json  
-
-Bundler should handle all these dependencies. If for some reason it doesn't you can run this in terminal:  
-```bash
-$ gem install exiv2 ffprober
-```
+-m will move (deleting the original), which is probably not a good idea in most cases but still useful at times.
 
 ## Usage:
 
+### To backup a camera card:
+
 ```bash
 $ cd /media/username/EOS_DIGITAL/DCIM
-$ imagebackup ~/Photos/raw
+$ imagebackup.rb ~/Photos/raw
 ```
+
 This will search all files within the DCIM folder, check them with either exiv2 (for stills) or ffprobe (for videos) and retrieve their creation dates.  
 It will then copy them to a folder of the form ```~/Photos/raw/<yyyy>-<mm>-<dd>```  
 If it's unable to find metadata in a file it will look at the file's creation time attribute, which is less reliable but usually ok.
 
+### To register a new file type:
 
-## Options:
--m will move (deleting the original), which is probably not a good idea in most cases but still useful at times.
+```bash
+$ imagebackup.rb --add-filetype orf pic
+```
+or
+```bash
+$ imagebackup.rb -a orf pic
+```
+This will work with ```*.ORF```, ```orf```, ```".orf"``` as it will strip off any unnecessary characters. It is case-insensitive.
+
+### To do a dry run, checking each file and destination but not actually copying:
+
+```bash
+$ imagebackup.rb -n ~/Photos/raw
+```
+or
+```bash
+$ imagebackup.rb ~/Photos/raw --dry-run
+```
+
+### To move files instead of copying them (careful!):
+```bash
+$ imagebackup.rb -m ~/Photos/raw
+```
+or
+```bash
+$ imagebackup.rb --move ~/Photos/raw
+```
+
+### To make symbolic links instead of copying files:
+```bash
+$ imagebackup.rb -l ~/Photos/raw
+```
+or
+```bash
+$ imagebackup.rb --link ~/Photos/raw
+```
+This mode can be useful if you want to operate on the files in one place but keep them on their media. Particularly useful for large movie files.
+
+## Dependencies:
+
+**Ruby** v2.3.0 or greater, plus gems:
+  - [exiv2](https://rubygems.org/gems/exiv2/versions/0.0.8) to retrieve EXIF date/time.
+  - [ffprober](https://github.com/beanieboi/ffprober) to retrieve video container date/time tags if present.
+  - [colorize](https://github.com/fazibear/colorize) to make output a little more readable and engaging.
+
+Ruby modules:
+  - [fileutils](https://ruby-doc.org/stdlib-2.4.1/libdoc/fileutils/rdoc/FileUtils.html) to manage file operations (get attributes, copy, move, link).
+  - [csv](https://ruby-doc.org/stdlib-2.6.1/libdoc/csv/rdoc/CSV.html) to process the list of available file types.
+
+Bundler should handle all these dependencies. If for some reason it doesn't you can run this in terminal:  
+```bash
+$ gem install exiv2 ffprober colorize
+```

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "imagebackup"
+require 'bundler/setup'
+require 'imagebackup'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "imagebackup"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/imagebackup.gemspec

@@ -1,32 +1,35 @@
+# frozen_string_literal: true
+
 require_relative 'lib/imagebackup/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "imagebackup"
+  spec.name          = 'imagebackup'
   spec.version       = Imagebackup::VERSION
-  spec.authors       = ["adrian-sal-kennedy"]
-  spec.email         = ["adrian.sal.kennedy@gmail.com"]
+  spec.authors       = ['adrian-sal-kennedy']
+  spec.email         = ['adrian.sal.kennedy@gmail.com']
 
-  spec.summary       = %q{A simple CLI app to backup all pics and vids from current folder to a destination in yyyy-mm-dd folders.}
-  spec.description   = %q{Uses Exiv2 and ffprobe to find creation dates for media types it finds.}
-  spec.homepage      = "https://github.com/adrian-sal-kennedy/imagebackup"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = 'A simple CLI app to backup all pics and vids from current folder to a destination in yyyy-mm-dd folders.'
+  spec.description   = 'Uses Exiv2 and ffprobe to find creation dates for media types it finds.'
+  spec.homepage      = 'https://github.com/adrian-sal-kennedy/imagebackup'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
-  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata['homepage_uri'] = spec.homepage
   # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
+  spec.add_dependency 'colorize'
   spec.add_dependency 'exiv2'
   spec.add_dependency 'ffprober'
 end

data/lib/classes/filetypes.csv

@@ -3,9 +3,13 @@ mp4,movie
 avi,movie
 mpg,movie
 vob,movie
+m2ts,movie
 3gp,movie
 mxf,movie
 mlv,movie
+webm,movie
+mkv,movie
+ogm,movie
 dng,pic
 tif,pic
 jpg,pic
@@ -15,5 +19,3 @@ cr2,pic
 arw,pic
 raw,pic
 gif,pic
-gif,pic
-gif,pic

data/lib/classes/filetypes.rb

@@ -1,5 +1,6 @@
-require 'csv'
 
+# FileTypes is a very simple file class to store and retrieve the list of files
+# we are interested in backing up.
 class FileTypes
   def self.list
     file_list = []
@@ -7,11 +8,11 @@ class FileTypes
       file_list << "**/*.#{csv[0]}"
       file_list << "**/*.#{csv[0].upcase}"
     end
-    return file_list
+    file_list
   end
 
-  def self.add(ext=nil,type=nil)
-    unless ext 
+  def self.add(ext = nil, type = nil)
+    unless ext
       puts 'please enter the file type\'s extension, with or without the dot.'
       ext = gets.strip
     end
@@ -19,12 +20,13 @@ class FileTypes
       puts 'please enter "movie" or "pic" so we know what we\'re working with.'
       type = gets.strip
     end
-    ext = ext.to_s.gsub(/[*."]/,'')
-    p type
-    type = (type.downcase.include?('m')) ? "movie" : "pic"
+    ext = ext.to_s.gsub(/[*."]/, '')
+    type = type.downcase.include?('m') ? 'movie' : 'pic'
     puts "opening file \"#{File.dirname(__FILE__)}/filetypes.csv\""
-    CSV.open("#{File.dirname(__FILE__)}/filetypes.csv","a") do |csv|
-      p csv << [ext,type]
+    CSV.open("#{File.dirname(__FILE__)}/filetypes.csv", 'a') do |csv|
+      csv << [ext, type]
     end
+    puts 'New file types registered.'
+    exit
   end
 end

data/lib/imagebackup.rb

@@ -1,62 +1,77 @@
 #!/usr/bin/env ruby
+
 require_relative 'imagebackup/version'
 
 require_relative 'classes/filetypes'
 require_relative 'methods/build_paths'
 require_relative 'methods/get_dates'
 require_relative 'methods/copy_pic'
+require_relative 'methods/display_help'
 
+require 'colorize'
 require 'exiv2'
 require 'fileutils'
 require 'ffprober'
-require 'json'
-require 'getoptlong'
+require 'csv'
 
-def main_loop(dest,dryrun=true)
+def main_loop(dest, dryrun = true, file_op = 'copy')
   file_types = FileTypes.list
   Dir.glob(file_types).reverse_each do |f|
-
     file = "#{Dir.pwd}/#{f}"
 
-    parms = build_paths(dest,file,get_dates(file))
+    parms = build_paths(dest, file, get_dates(file))
     outfile = parms[0]
     destpath = parms[1]
 
-    if File.exist?(outfile)
-      puts "\"#{outfile}\" already exists."
-    else
-      copy_pic(file,outfile,destpath,dryrun)
-    end
+    copy_pic(file, outfile, destpath, dryrun, file_op)
   end
+  puts "\nFinished!\n".colorize(:light_green)
 end
 
-# main_loop(ARGV[0])
-
 dryrun = true
+file_op = 'cp' # or "mv" or "ln_s"
 
-if (ARGV & ['-n','--dry-run']).any?
-  dryrun = true
-  ARGV.delete('-n')
-  ARGV.delete('--dry-run')
-else
-  # FIXME: THIS IS REVERSED TO ALWAYS BE TRUE WHILE I'M TESTING. CHANGE BELOW TO false BEFORE DEPLOYMENT
-  dryrun = true
-  puts "dry run is disabled! i'm really going to mess with your files!"
+if (ARGV & ['-m', '--move']).any?
+  file_op = 'mv'
+  ARGV.delete('-m')
+  ARGV.delete('--move')
 end
-if ARGV.include?('-a')#,'--add-filetype']).any?
-  ext=ARGV[ARGV.index('-a')+1]
-  type=ARGV[ARGV.index('-a')+2]
-  ARGV.slice!(ARGV.index('-a')..ARGV.index('-a')+2)
+if (ARGV & ['-l', '--link']).any?
+  file_op = 'ln_s'
+  ARGV.delete('-l')
+  ARGV.delete('--link')
+end
+if ARGV.include?('-a')
+  ext = ARGV[ARGV.index('-a') + 1]
+  type = ARGV[ARGV.index('-a') + 2]
+  ARGV.slice!(ARGV.index('-a')..ARGV.index('-a') + 2)
+  FileTypes.add(ext, type)
 end
 if ARGV.include?('--add-filetype')
-  ext=ARGV[ARGV.index('--add-filetype')+1]
-  type=ARGV[ARGV.index('--add-filetype')+2]
-  ARGV.slice!(ARGV.index('--add-filetype')..ARGV.index('--add-filetype')+2)
+  ext = ARGV[ARGV.index('--add-filetype') + 1]
+  type = ARGV[ARGV.index('--add-filetype') + 2]
+  ARGV.slice!(ARGV.index('--add-filetype')..ARGV.index('--add-filetype') + 2)
+  FileTypes.add(ext, type)
 end
-if ext
-  FileTypes.add(ext,type)
+if (ARGV & ['-n', '--dry-run']).any?
+  dryrun = true
+  puts 'Doing a dry run - no operations will happen.'.colorize(:light_magenta)
+  sleep 1
+  ARGV.delete('-n')
+  ARGV.delete('--dry-run')
+else
+  dryrun = false
 end
 
-if ARGV
-  main_loop(ARGV[0])
-end
+display_help("Exited normally",:light_green) if (ARGV & ['-h', '--help', '-?']).any?
+
+if ARGV[0].to_s == ''
+  display_help
+elsif File.exist?(ARGV[0])
+  main_loop(ARGV[0], dryrun, file_op)
+elsif ARGV[0][0] == '-'
+  puts "Invalid option!\n-----\n\n"
+  display_help("\n-----\nInvalid option: \"#{ARGV[0]}\"!\n\n",:red)
+else
+  puts 'Specified destination does not exist. Please create this folder first.'
+end

data/lib/imagebackup/version.rb

@@ -1,3 +1,3 @@
 module Imagebackup
-  VERSION = "0.2.0"
+  VERSION = '0.3.4'
 end

data/lib/methods/build_paths.rb

@@ -1,7 +1,9 @@
-def build_paths(dest,file,date)
+# frozen_string_literal: true
+
+def build_paths(dest, file, date)
   date = get_dates(file)
   destpath = "#{dest}/#{date}"
-  destpath = destpath.gsub('//','/')
+  destpath = destpath.gsub('//', '/')
   outfile =  "#{destpath}/#{File.basename(file)}"
-  return [outfile,destpath]
-end
+  [outfile, destpath]
+end

data/lib/methods/copy_pic.rb

@@ -1,11 +1,25 @@
-def copy_pic(file,outfile,destpath,dryrun)
+def process_file(file, outfile, dryrun = nil, file_op = 'cp')
   if dryrun
-    puts "pretending to copy \"#{file}\" to \"#{outfile}\""
-    puts "FileUtils.mkdir_p(#{destpath})"
-    puts "FileUtils.cp(#{file},#{outfile})"
+    puts "#{"pretending to ".colorize(:light_green)}#{file_op} \"#{file}\"#{" to ".colorize(:light_green)}\"#{outfile}\""
   else
-    puts "copying \"#{file}\" to \"#{outfile}\""
-    FileUtils.mkdir_p(destpath)
-    FileUtils.cp(file,outfile)
+    puts "#{file_op}-ing \"#{file} to #{outfile}\"..."
+    FileUtils.public_send(file_op, file, outfile)
+    if File.exist?("#{file}.xmp")
+      FileUtils.public_send(file_op, "#{file}.xmp", "#{outfile}.xmp")
+    end
+  end
+end
+
+def copy_pic(file, outfile, destpath, dryrun = nil, file_op = 'cp')
+  if File.exist?(outfile)
+    puts "\"#{outfile}\" #{"already exists. Skipping...".colorize(:light_blue)}."
+  else
+    unless dryrun
+      unless File.exist?(destpath)
+        puts "creating folder \"#{destpath}\""
+        FileUtils.mkdir_p(destpath)
+      end
+    end
+    process_file(file, outfile, dryrun, file_op)
   end
 end

data/lib/methods/display_help.rb

@@ -0,0 +1,71 @@
+def display_help(err=nil,color=nil)
+  print <<~HELPFILE
+    ===== ImageBackup =====
+
+    Keep your photos and videos organized by date.
+
+    A simple terminal app to crawl a folder (usually a camera card's DCIM folder) for pictures and videos, and pop them in dated folders to your destination folder of choice. Uses exif data when available, creation_time, or the file's own creation date if nothing better is present.
+
+    Will also copy over any xmp sidecar files found, not overwriting.
+
+    Options:
+
+    -n, --dry-run                            Run without actually doing anything. Good for making sure
+                                             things are working properly. This will also give you console
+                                             output which helps identify unreadable files.
+
+    -a, --add-filetype <extension> <type>    This will add a custom file type to the list of files it's
+                                             looking for. If you have an arcane digital camera (we
+                                             currently support canon, sony, pentax but new stuff comes out
+                                             all the time), this will allow you to add your raw files.
+                                             You can also access *filetypes.csv* and add them manually,
+                                             but ensure there's a blank line at the end or this program
+                                             may behave badly.
+
+    -m, --move                               Will move (deleting the original), which is probably not a
+                                             good idea in most cases but still useful at times.
+    -l, --link                               Create symbolic links instead of copying or moving
+                                             actual files. Useful for large videos.
+
+    Usage:
+
+    - To backup a camera card:
+
+    $ cd /media/username/EOS_DIGITAL/DCIM
+    $ imagebackup.rb ~/Photos/raw
+
+    This will search all files within the DCIM folder, check them with either exiv2 (for stills) or ffprobe (for videos) and retrieve their creation dates.
+    It will then copy them to a folder of the form ~/Photos/raw/<yyyy>-<mm>-<dd>
+    If it's unable to find metadata in a file it will look at the file's creation time attribute, which is less reliable but usually ok.
+
+    - To register a new file type:
+
+    $ imagebackup.rb --add-filetype orf pic
+    or
+    $ imagebackup.rb -a orf pic
+
+    This will work with *.ORF, orf, ".orf" as it will strip off any unnecessary characters. It is case-insensitive.
+
+    - To do a dry run, checking each file and destination but not actually copying:
+
+    $ imagebackup.rb -n ~/Photos/raw
+    or
+    $ imagebackup.rb ~/Photos/raw --dry-run
+
+    - To move files instead of copying them (careful!):
+
+    $ imagebackup.rb -m ~/Photos/raw
+    or
+    $ imagebackup.rb --move ~/Photos/raw
+
+    - To make symbolic links instead of copying files:
+
+    $ imagebackup.rb -l ~/Photos/raw
+    or
+    $ imagebackup.rb --link ~/Photos/raw
+
+    This mode can be useful if you want to operate on the files in one place but keep them on their media. Particularly useful for large movie files.
+  HELPFILE
+  puts err.to_s.colorize(color)
+  exit(0)
+end

data/lib/methods/get_dates.rb

@@ -3,15 +3,15 @@ def get_dates(file)
     image = Exiv2::ImageFactory.open(file)
     image.read_metadata
     date = image.exif_data.find { |v| v[0] == 'Exif.Image.DateTime' }
-    date = date[1].split[0].gsub(':','-')
-  rescue => exiv2_no_exifdata
+    date = date[1].split[0].gsub(':', '-')
+  rescue StandardError
     begin
       probe = Ffprober::Parser.from_file(file)
-      date = probe.format.tags[:creation_time].split('T')[0]
-    rescue => invalid_or_corrupt_file
+      date = probe.format.tags[:creation_time].split(/[T ]/)[0]
+    rescue StandardError
       fileobj = File.new(file)
-      date = "#{fileobj.stat.ctime.year}-#{fileobj.stat.ctime.month}-#{fileobj.stat.ctime.day}"
+      date = "#{"%04d" % fileobj.stat.ctime.year}-#{"%02d" % fileobj.stat.ctime.month}-#{"%02d" % fileobj.stat.ctime.day}"
     end
   end
-  return date
-end
+  date
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: imagebackup
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.4
 platform: ruby
 authors:
 - adrian-sal-kennedy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-03-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: exiv2
   requirement: !ruby/object:Gem::Requirement
@@ -61,7 +75,11 @@ files:
 - lib/imagebackup/version.rb
 - lib/methods/build_paths.rb
 - lib/methods/copy_pic.rb
+- lib/methods/display_help.rb
 - lib/methods/get_dates.rb
+- tests/bad_exif/DSC03688.JPG
+- tests/corrupt/test.cr2
+- tests/truncated/IMG_9372.CR2
 homepage: https://github.com/adrian-sal-kennedy/imagebackup
 licenses:
 - MIT