phtools 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f645b7d7f323aba0cea04b8a640b3d84d383b20
-  data.tar.gz: 0ccb3bb5953014a8cf1f194f35d62be78a6a5828
+  metadata.gz: 750f4b068327ffb6e442bd159b3954bc6a4e05a9
+  data.tar.gz: 0c3dd2cf633fc173198db39b52bf0158b2b4cb83
 SHA512:
-  metadata.gz: eec57813519d3cc5f553f92f8e867101e52e218a09bd9396f874b175ad06616555c83c67f09c036b835ff967f50393b239e61e5882ec3692f5997b8cee0b4de7
-  data.tar.gz: f4b0f09eb7f01aafb9bef15af263117e442799a6899baa4b5cd8b5e35bd71e3c43c7ad672050418b43f620084edc3e8646c1be68425c6730700d2c18fdbd48c2
+  metadata.gz: 67221245339260073f68931c40fcc7c032733c29a82b66e9c2f2515d68d9c91a42f187c06b634e69175bc6e99ef0f2a9231daa3db670c6ba92c561931789d8be
+  data.tar.gz: b7783f37b130f55dae57a95f285bdee3bf0e65b7ac077e3d46ef01601d83f74ae1dc8e113917ef9ad05bbff2bb3cecb714af14f602ce00fe330465ed684d069e

data/History.md

@@ -1,6 +1,12 @@
 # RELEASED
 
+## [v0.4.0](https://github.com/andrewbiz/phtools/compare/v0.3.0.pre.alpha...v0.4.0)
+* Added description to README.md
+* Changed phls - option -R instead of -r (ls compatibility)
+* Added phmove command
+* Added phrename command
+
 ## [v0.3.0.pre.alpha](https://github.com/andrewbiz/phtools/compare/v0.2.4...v0.3.0.pre.alpha)
 
-* Improved phtools - now it supports DIRs and FILEMASKs parameters
+* Improved phls - now it supports DIRs and FILEMASKs parameters
 * Added aruba (cucumber) tests for phls

data/README.md

@@ -5,7 +5,7 @@ A bundle of small CLI tools for arranging, renaming, tagging of the photo and vi
 ## Rationale
 PHTOOLS is an instrument intended for photographers\photo enthusiasts who:
 * own tons of photo-video files and want to keep it in order
-* really don't like the way how digital cameras name the files: P1193691.JPG, IMP_1409.JPG, _DSC1459.ARW etc.
+* really don't like the way how digital cameras name the files: P1193691.JPG, IMP_1409.JPG, \_DSC1459.ARW etc.
 * for photo storage prefer usage of traditional File System (folder structure) instead of "black box" databases of media managers (like iPhoto, Photoshop etc.)
 * would like to have date-time-original info in the name of the file
 * expects that sorting folder content "by name" will arrange photo-video assets in chronological order
@@ -56,11 +56,31 @@ And all videos are moved to `~/Desktop/assets_staging/VIDEO`.
 
 And all raw photo-files are moved to `~/Desktop/assets_staging/RAW`.
 
+### Use Case 2. Mass rename photos in accordance with PHTOOLS standard (and don't forget to backup before)
+
+#### Given
+I have dozens of photo-files in my working folder `~/Desktop/assets_staging`.
+
+And my friend Alex it the author of the photos (nikname ALX).
+
+#### When
+I run:
+```sh
+cd ~/Desktop/assets_staging
+phls | phbackup | phrename -a alx
+```
+
+#### Then
+I get all photos in `~/Desktop/assets_staging` renamed according to PHTOOLS standard.
+
+And I have all original photo-files are backed-up to `~/Desktop/assets_staging/backup`.
+
+
 ## PHTOOLS concepts
 ### PHTOOLS Standard file name
 PHTOOLS standard file name looks like this: **`YYYYmmdd-HHMMSS_AAA ORIGINAL.EXT`**, where
 
-**YYYYmmdd-HHMMSS** - photo creation datestamp (year-month-day-hours-minutes-seconds). By default PHTOOLS use the value of EXIF tag `DateTimeOriginal` or `CreateDate` for this purpose. 
+**YYYYmmdd-HHMMSS** - photo creation datestamp (year-month-day-hours-minutes-seconds). By default PHTOOLS use the value of EXIF tag `DateTimeOriginal` or `CreateDate` for this purpose.
 
 **AAA** - author nikname. 3 character long, only latin alphabet supported.
 
@@ -68,4 +88,3 @@ PHTOOLS standard file name looks like this: **`YYYYmmdd-HHMMSS_AAA ORIGINAL.EXT`
 
 For example, the digital camera photo file `P1193691.JPG`, taken by AndrewBiz (aka ANB), after PHTOOLS processing will look like:
 `20160902-174939_ANB P1193691.JPG`
-

data/TODO.md

@@ -5,5 +5,7 @@
 - [x] phmove: create phmove tool based on ftarrange code (see ftools repo)
 - [x] phmove: make target_folder as parameter not an option
 - [x] phmove: -a (--arrange) parameter means to put photo, video, raw files into separate folders inside target. If -a is not set all files are moved to root of target directory (plain collection of files)
-- [ ] phmove: delete unused empty RAW and VIDEO folders
+- [x] phmove: delete unused empty RAW and VIDEO folders
 - [ ] phmove: make options to set video, raw folder names
+- [x] phrename: add -c --clean option (based on ftclname functionality)
+- [ ] phrename: add -s --shift_time option (based on ftfixdate functionality)

data/exe/phbackup

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+module PhTools
+  tool_name = File.basename(__FILE__)
+  require "#{tool_name}"
+
+  file_type = FILE_TYPE_IMAGE + FILE_TYPE_VIDEO + FILE_TYPE_AUDIO
+  usage = <<DOCOPT
+***************************************************
+phtools - *Keep Your Photos In Order* (c) ANB
+***************************************************
+#{tool_name} copies the input file to backup directory.
+Optimized to be used with other *phtools* via pipes.
+Example: phls | #{tool_name} | phrename ...
+
+Usage:
+  #{tool_name} [--backup DIR] [-D]
+  #{tool_name} -h | --help
+  #{tool_name} -v | --version
+
+Options:
+  -b DIR --backup=DIR  Sets the backup directory [Default: ./backup]
+  -D --debug           Turn on debugging (verbose) mode
+  -h --help            Show this screen.
+  -v --version         Show version.
+DOCOPT
+
+  PhTools.const_get(tool_name.capitalize).new(usage, file_type).run!
+end

data/exe/phrename

@@ -23,23 +23,23 @@ Example: input file DSC03455.JPG will be renamed to 20130108-124145_ANB DSC03455
   phls | #{tool_name} -a anb
 
 This program uses external utility ExifTool by Phil Harvey
-(http://www.sno.phy.queensu.ca/~phil/exiftool/). Make sure you have exiftool installed.
+(http://www.sno.phy.queensu.ca/~phil/exiftool/).
 
 Usage:
-  #{tool_name} -a NICKNAME [-D] [-t TAG]
+  #{tool_name} -a NICK [-D] [-t TAG]
+  #{tool_name} -c [-D]
   #{tool_name} -h | --help
   #{tool_name} -v | --version
 
 Options:
-  -a NICKNAME --author=NICKNAME  Author nickname size should be #{PhFile::NICKNAME_SIZE} chars,
-                                 have no spaces and other non-word chars,
-                                 have no digits,
-                                 have only ASCII chars (e.g. ANB)
-  -t TAG --tag_date=TAG          Set the TAG name containing Date_Time creation
-                                 info. The TAG value will be used instead of
-                                 standard DateTimeOriginal tag.
-                                 All existing tags and tag names you can get
-                                 using command `phls filename|phmtags -f`
+  -a NICK --author=NICK  Author nickname size should be #{PhFile::NICKNAME_SIZE} chars,
+                         supports only latin ASCII chars (e.g. ANB).
+                         No digits, no spaces, no other non-word chars allowed.
+  -t TAG --tag_date=TAG  Set the TAG name containing Date_Time creation
+                         info. The TAG value will be used instead of
+                         standard DateTimeOriginal tag. All existing tags you
+                         can get using command `phls filename|phmtags -f`
+  -c --clean    Rename file(s) back to original name(s)
   -D --debug    Turn on debugging (verbose) mode
   -h --help     Show this screen.
   -v --version  Show version.

data/lib/phbackup.rb

@@ -6,8 +6,40 @@ require 'phtools/runner'
 
 module PhTools
   class Phbackup < Runner
+
     def self.about
-      "!UNDER CONSTRUCTION!"
+      "copies input files to backup folder"
+    end
+
+    private
+
+    def validate_options
+      @backup_dir = @options_cli['--backup'] || ''
+      fail PhTools::Error, 'backup dir is not defined' if @backup_dir.empty?
+    end
+
+    def process_before
+      if File.exist?(@backup_dir)
+        fail PhTools::Error, "#{@backup_dir} is not a directory" unless
+          File.directory?(@backup_dir)
+        fail PhTools::Error, "#{@backup_dir} is not writable" unless
+          File.writable?(@backup_dir)
+      else
+        begin
+          Dir.mkdir @backup_dir
+        rescue
+          raise PhTools::Error, "Unable to make dir '#{@backup_dir}'"
+        end
+      end
+    end
+
+    def process_file(phfile)
+      backup_path = File.join(@backup_dir,
+                              phfile.basename + phfile.extname)
+      FileUtils.cp(phfile.filename, backup_path, verbose: PhTools.debug)
+      phfile
+    rescue
+      raise PhTools::Error, "file copying to #{@backup_dir}"
     end
   end
 end

data/lib/phmove.rb

@@ -9,6 +9,7 @@ module PhTools
     def self.about
       "moves input files to target folder"
     end
+
     private
 
     def validate_options
@@ -27,8 +28,10 @@ module PhTools
       fail PhTools::Error, "#{@target_folder} does not exist" unless File.exist?(@target_folder)
       fail PhTools::Error, "#{@target_folder} is not a directory" unless File.directory?(@target_folder)
       begin
-        Dir.mkdir @raw_folder unless Dir.exist?(@raw_folder)
-        Dir.mkdir @video_folder unless Dir.exist?(@video_folder)
+        if @arrange
+          Dir.mkdir @raw_folder unless Dir.exist?(@raw_folder)
+          Dir.mkdir @video_folder unless Dir.exist?(@video_folder)
+        end
       rescue
         raise PhTools::Error, "Unable to make dir inside '#{@target_folder}'"
       end
@@ -53,5 +56,17 @@ module PhTools
     rescue SystemCallError => e
       raise PhTools::Error, 'file moving - ' + e.message
     end
+
+    def process_after
+      if @arrange
+        Dir.delete @raw_folder if (Dir.exist?(@raw_folder) and
+                                   Utils.dir_empty?(@raw_folder))
+        Dir.delete @video_folder if (Dir.exist?(@video_folder) and
+                                     Utils.dir_empty?(@video_folder))
+      end
+    rescue
+        raise PhTools::Error, "Unable to delete dir"
+    end
+
   end
 end

data/lib/phrename.rb

@@ -14,30 +14,42 @@ module PhTools
     private
 
     def validate_options
-      @author = @options_cli['--author'].upcase || ''
-      ok, msg = PhFile.validate_author(@author)
-      fail PhTools::Error, msg unless ok
-      @user_tag_date = @options_cli['--tag_date'] || ''
+      if @options_cli['--author']
+        @mode = :rename
+        @author = @options_cli['--author'].upcase
+        ok, msg = PhFile.validate_author(@author)
+        fail PhTools::Error, msg unless ok
+        @user_tag_date = @options_cli['--tag_date'] || ''
+      elsif @options_cli['--clean']
+        @mode = :clean
+      end
     end
 
     def process_file(phfile)
       phfile_out = phfile.clone
-      begin
-        tag = MiniExiftool.new(phfile.filename, timestamps: DateTime)
-      rescue
-        raise PhTools::Error, 'EXIF tags reading'
-      end
-      if @user_tag_date.empty?
-        dto = tag.date_time_original || tag.create_date || PhFile::ZERO_DATE
-      else
-        fail PhTools::Error, "tag #{@user_tag_date} is not found" unless tag[@user_tag_date]
-        fail PhTools::Error, "tag #{@user_tag_date} is not a DateTime type" unless               tag[@user_tag_date].kind_of?(DateTime)
-        dto = tag[@user_tag_date] || PhFile::ZERO_DATE
+      case @mode
+      when :rename
+        begin
+          tag = MiniExiftool.new(phfile.filename, timestamps: DateTime)
+        rescue
+          raise PhTools::Error, 'EXIF tags reading'
+        end
+        if @user_tag_date.empty?
+          dto = tag.date_time_original || tag.create_date || PhFile::ZERO_DATE
+        else
+          fail PhTools::Error, "tag #{@user_tag_date} is not found" unless tag[@user_tag_date]
+          fail PhTools::Error, "tag #{@user_tag_date} is not a DateTime type" unless               tag[@user_tag_date].kind_of?(DateTime)
+          dto = tag[@user_tag_date] || PhFile::ZERO_DATE
+        end
+        phfile_out.standardize!(date_time: dto, author: @author)
+
+      when :clean
+        phfile_out.cleanse!
       end
-      phfile_out.standardize!(date_time: dto, author: @author)
-      FileUtils.mv(phfile.filename, phfile_out.filename) unless
-        phfile == phfile_out
+
+      FileUtils.mv(phfile.filename, phfile_out.filename) unless phfile == phfile_out
       phfile_out
+
     rescue => e
       raise PhTools::Error, 'file renaming - ' + e.message
     end

data/lib/phtools/runner.rb

@@ -2,10 +2,9 @@
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
-require 'phtools/version'
 require 'phtools/utils/ruby_version.rb'
-require 'phtools/utils/os_win.rb'
-require 'phtools/utils/os_unix.rb'
+require 'phtools/version'
+require 'phtools/utils'
 require 'phtools/error.rb'
 require 'phtools/ph_file.rb'
 require 'docopt'
@@ -37,7 +36,7 @@ module PhTools
 
     rescue Docopt::Exit => e
       STDERR.puts e.message
-      exit 0
+      exit 1
     rescue => e
       PhTools.puts_error "FATAL: #{e.message}", e
       exit 1

data/lib/phtools/utils/dir.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+module Utils
+  def self.dir_empty?(dir)
+    (Dir.entries(dir) - ['.', '..']).empty?
+  end
+end

data/lib/phtools/utils/os_unix.rb

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
-require 'phtools/utils/os'
+
+require_relative 'os'
 
 module Utils
   # Unix specific functions

data/lib/phtools/utils/os_win.rb

@@ -2,7 +2,7 @@
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 
-require 'phtools/utils/os'
+require_relative 'os'
 
 module Utils
   # OS platfor related logic

data/lib/phtools/utils.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require 'phtools/utils/dir'
+require 'phtools/utils/os_unix'
+require 'phtools/utils/os_win'

data/lib/phtools/version.rb

@@ -1,4 +1,4 @@
 
 module PhTools
-  VERSION = '0.4.0'
+  VERSION = '0.6.0'
 end

data/lib/phtools.rb

@@ -3,7 +3,6 @@
 # (c) ANB Andrew Bizyaev
 require 'phtools/version'
 require 'phbackup'
-require 'phclname'
 require 'phevent'
 require 'phfixdate'
 require 'phfixfmd'
@@ -19,15 +18,14 @@ module PhTools
 phtools v#{VERSION} is a bundle of small CLI tools for arranging, renaming, tagging
 of the photo and video files. Helps to keep your photo-video assets in order.
 Please run phtools in a terminal via CLI commands:
+    phls\t(#{Phls::about}),
     phmove\t(#{Phmove::about}),
     phbackup\t(#{Phbackup::about}),
-    phclname\t(#{Phclname::about}),
+    phrename\t(#{Phrename::about}),
     phevent\t(#{Phevent::about}),
     phfixdate\t(#{Phfixdate::about}),
     phfixfmd\t(#{Phfixfmd::about}),
-    phls\t(#{Phls::about}),
     phmtags\t(#{Phmtags::about}),
-    phrename\t(#{Phrename::about}),
     phtagset\t(#{Phtagset::about}).
 For more information run these commands with -h option.
 General info about phtools usage see at https://github.com/AndrewBiz/phtools.git

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phtools
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrew Bizyaev
@@ -239,6 +239,7 @@ description: A bundle of small CLI tools for arranging, renaming, tagging of the
 email:
 - andrew.bizyaev@gmail.com
 executables:
+- phbackup
 - phls
 - phmove
 - phrename
@@ -259,12 +260,12 @@ files:
 - bin/console
 - bin/setup
 - bin/stmux
+- exe/phbackup
 - exe/phls
 - exe/phmove
 - exe/phrename
 - exe/phtools
 - lib/phbackup.rb
-- lib/phclname.rb
 - lib/phevent.rb
 - lib/phfixdate.rb
 - lib/phfixfmd.rb
@@ -278,6 +279,8 @@ files:
 - lib/phtools/mini_exiftool-2.3.0anb.rb
 - lib/phtools/ph_file.rb
 - lib/phtools/runner.rb
+- lib/phtools/utils.rb
+- lib/phtools/utils/dir.rb
 - lib/phtools/utils/os.rb
 - lib/phtools/utils/os_unix.rb
 - lib/phtools/utils/os_win.rb

data/lib/phclname.rb

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-# (c) ANB Andrew Bizyaev
-
-require 'phtools/runner'
-
-module PhTools
-  class Phclname < Runner
-    def self.about
-      "!UNDER CONSTRUCTION!"
-    end
-  end
-end