imagebackup 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc81529419a0623c0598dabfbba9e4b5806b62a9dfa8ccd3eb9310912157b11b
-  data.tar.gz: 650bfa77a3adfadc530c9466261f077b901f9b00e693180dd00d93978586ddfa
+  metadata.gz: c4a1d4dd786b4165fd4812dea1de48ef9ad9ad9040e2b4c572f633117e7147f9
+  data.tar.gz: 67d0e990a7491fee092a0b58386b218a52635ae1f68a79608dca347c791d8814
 SHA512:
-  metadata.gz: ad5fe5bf394bb6282b772683aac8c66a18ff9b4fb58ea67bfaed17f0a19ff844ff6f77afa72cd1c0e5bfa8c463ca0d9de317f1c43e8b88089c918a1f9ac148ef
-  data.tar.gz: b1fb8c3bf729427c2de5f34a79bb924ec465679f1b85b68d0acecf0b8fb9282468777bcaa0ca93f2e988cf479f5c8dc649bf66006a7becc973de24ffb619ca55
+  metadata.gz: 9b0b396b58101630b0c8390e9b0a6b8e139774b29d775136518becc866157bc66245682be814fc299b79095147f00c53d15a13079017fdc73b2973a8148aa511
+  data.tar.gz: d6c1d1dadc59c952dfca3d99f559fc69538459cde68d6268914a5e25bb4668fe5ec05d8e4f6e4d6914744cc91623331c79556bc3fbfc3b96c33d7322a9b7e38f

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/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,31 +1,33 @@
+# 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 'exiv2'
   spec.add_dependency 'ffprober'

data/lib/classes/filetypes.rb

@@ -1,5 +1,7 @@
 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 +9,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 +21,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,4 +1,5 @@
 #!/usr/bin/env ruby
+
 require_relative 'imagebackup/version'
 
 require_relative 'classes/filetypes'
@@ -11,56 +12,46 @@ require 'exiv2'
 require 'fileutils'
 require 'ffprober'
 
-def main_loop(dest,dryrun=true,file_op="copy")#,move=nil,link=nil)
+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]
 
-    copy_pic(file,outfile,destpath,dryrun,file_op)#,move,link)
-    
+    copy_pic(file, outfile, destpath, dryrun, file_op)
   end
 end
 
-# main_loop(ARGV[0])
-
 dryrun = true
-# link = false
-# move = false
-file_op = "cp" # or "mv" or "ln_s"
+file_op = 'cp' # or "mv" or "ln_s"
 
-if (ARGV & ['-m','--move']).any?
-  # move = true
-  file_op = "mv"
+if (ARGV & ['-m', '--move']).any?
+  file_op = 'mv'
   ARGV.delete('-m')
   ARGV.delete('--move')
 end
-if (ARGV & ['-l','--link']).any?
-  # link = true
-  file_op = "ln_s"
+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)
+  ext = ARGV[ARGV.index('-a') + 1]
+  type = ARGV[ARGV.index('-a') + 2]
+  ARGV.slice!(ARGV.index('-a')..ARGV.index('-a') + 2)
 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)
-end
-if ext
-  FileTypes.add(ext,type)
+  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)
 end
-if (ARGV & ['-n','--dry-run']).any?
+FileTypes.add(ext, type) if ext
+if (ARGV & ['-n', '--dry-run']).any?
   dryrun = true
-  puts "Doing a dry run - no operations will happen."
+  puts 'Doing a dry run - no operations will happen.'
   sleep 1
   ARGV.delete('-n')
   ARGV.delete('--dry-run')
@@ -68,16 +59,15 @@ else
   dryrun = false
 end
 
-if (ARGV & ['-h','--help','-?']).any?
-  display_help()
-end
+display_help if (ARGV & ['-h', '--help', '-?']).any?
 
 if ARGV[0].to_s == ''
-  display_help()
+  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
 else
-  if File.exist?(ARGV[0])
-    main_loop(ARGV[0],dryrun,file_op)
-  else
-    puts "Specified destination does not exist. Please create this folder first."
-  end
-end
+  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.3.0"
+  VERSION = '0.3.1'
 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,29 +1,28 @@
-def process_file(file,outfile,dryrun=nil,file_op="cp")
+def process_file(file, outfile, dryrun = nil, file_op = 'cp')
   if dryrun
     puts "pretending to #{file_op} \"#{file} to #{outfile}\""
   else
     puts "#{file_op}-ing \"#{file} to #{outfile}\"..."
-    FileUtils.public_send(file_op,file,outfile)
-    FileUtils.public_send(file_op,"#{file}.xmp",outfile,:force => true)
-    if file_op == "cp"
-      FileUtils.public_send(file_op,"#{file}.xmp",outfile)
+    FileUtils.public_send(file_op, file, outfile)
+    FileUtils.public_send(file_op, "#{file}.xmp", outfile, force: true)
+    if file_op == 'cp'
+      FileUtils.public_send(file_op, "#{file}.xmp", outfile)
     else
-      FileUtils.public_send(file_op,"#{file}.xmp",outfile,:force => true)
+      FileUtils.public_send(file_op, "#{file}.xmp", outfile, force: true)
     end
   end
 end
 
-def copy_pic(file,outfile,destpath,dryrun=nil,file_op="cp") #,move=nil,link=nil)
-  unless File.exist?(outfile)
+def copy_pic(file, outfile, destpath, dryrun = nil, file_op = 'cp')
+  if File.exist?(outfile)
+    puts "\"#{outfile}\" already exists. Skipping..."
+  else
     unless dryrun
       unless File.exist?(destpath)
         puts "creating folder \"#{destpath}\""
         FileUtils.mkdir_p(destpath)
-      else
       end
     end
-    process_file(file,outfile,dryrun,file_op)
-  else
-    puts "\"#{outfile}\" already exists. Skipping..."
+    process_file(file, outfile, dryrun, file_op)
   end
 end

data/lib/methods/display_help.rb

@@ -1,82 +1,82 @@
 def display_help
-  print <<EOF
-===== ImageBackup =====
+  print <<~HELPFILE
+    ===== ImageBackup =====
 
-Keep your photos and videos organized by date.
+    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.
+    Will also copy over any xmp sidecar files found, not overwriting.
 
-Options:
+    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.
+    -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.
+    -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                                       will move (deleting the original), which is probably not a
-                                         good idea in most cases but still useful at times.
+    -m                                       will move (deleting the original), which is probably not a
+                                             good idea in most cases but still useful at times.
 
-Usage:
+    Usage:
 
-- To backup a camera card:
+    - To backup a camera card:
 
-$ cd /media/username/EOS_DIGITAL/DCIM
-$ imagebackup.rb ~/Photos/raw
+    $ 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.
+    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:
+    - To register a new file type:
 
-$ imagebackup.rb --add-filetype orf pic
-or
-$ imagebackup.rb -a orf pic
+    $ 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.
+    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:
+    - 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
+    $ imagebackup.rb -n ~/Photos/raw
+    or
+    $ imagebackup.rb ~/Photos/raw --dry-run
 
-- To move files instead of copying them (careful!):
+    - To move files instead of copying them (careful!):
 
-$ imagebackup.rb -m ~/Photos/raw
-or
-$ imagebackup.rb --move ~/Photos/raw
+    $ imagebackup.rb -m ~/Photos/raw
+    or
+    $ imagebackup.rb --move ~/Photos/raw
 
-- To make symbolic links instead of copying files:
+    - To make symbolic links instead of copying files:
 
-$ imagebackup.rb -l ~/Photos/raw
-or
-$ imagebackup.rb --link ~/Photos/raw
+    $ 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.
+    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:
+    Dependencies:
 
-Ruby v2.3.0 or greater, plus gems:
- - exiv2
- - ffprober  
+    Ruby v2.3.0 or greater, plus gems:
+     - exiv2
+     - ffprober
 
-Ruby modules:
- - fileutils
+    Ruby modules:
+     - fileutils
 
-Bundler should handle all these dependencies. If for some reason it doesn't you can run this in terminal:  
-$ gem install exiv2 ffprober
+    Bundler should handle all these dependencies. If for some reason it doesn't you can run this in terminal:
+    $ gem install exiv2 ffprober
 
-EOF
+  HELPFILE
 
-exit(0)
-end
+  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
+    rescue StandardError
       fileobj = File.new(file)
       date = "#{fileobj.stat.ctime.year}-#{fileobj.stat.ctime.month}-#{fileobj.stat.ctime.day}"
     end
   end
-  return date
-end
+  date
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imagebackup
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - adrian-sal-kennedy