phtools 0.15.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38105ed36855c6951006e4d016300abeb71376c8
-  data.tar.gz: 3147aeae28704093e02c36e7acf46c7d1ad6389c
+  metadata.gz: f37bf58f801dd2e2dae773bf219c3b28357d6ad2
+  data.tar.gz: 67a33c3205c22f9980201562b70bee2641ce21e6
 SHA512:
-  metadata.gz: dc5692669197d8c219c463f107370cf040d5202a74ac78a69742b940316859a4b1a3f644ee4bb5c4959f241087a0490f1a74d1c9db362f3d879a97e68c8bcec3
-  data.tar.gz: 0276417d4fe7e2767a20712dca41d67a52f18356bcdf3783e4e1ed8c250d711f7875933f4ba0fd6f1fcc5539849135fad8a81a4536b3d8146f4f09f1fe7c3967
+  metadata.gz: 5c8a23354bdb69ee63c15975cdd0d7b386eb5664be43bc5630eeb8d36a393c58372e86955f49d149feff8523962bd91015f9d32296b18983353760fb3f318a75
+  data.tar.gz: 99628b863d8cff4a26d40b8f3bcda46e07b5522eeafc3fe93688e40e492d27a9e84e87546888155baa4790d67c7e42fe7b89c5fc247977213e0aa09318777f92

data/History.md

@@ -1,5 +1,8 @@
 # RELEASED
 
+## [v0.16.0](https://github.com/andrewbiz/phtools/compare/v0.15.0...v0.16.0)
+* phtools now support Apple HEIC image file format (as exiftool it can only read tags)
+
 ## [v0.15.0](https://github.com/andrewbiz/phtools/compare/v0.14.0...v0.15.0)
 * phls now supports --range parameter allowing the user to filter files which name endings are not in the given range
 

data/README.md

@@ -1,61 +1,74 @@
 [![Version     ](https://img.shields.io/gem/v/phtools.svg?style=flat)](https://rubygems.org/gems/phtools)
+
 # PHTOOLS by ANB
+
 A bundle of small CLI tools for arranging, renaming, tagging of the photo and video files. Helps to keep photo-video assets in order.
 
 ## 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.
-* for photo storage prefer usage of traditional File System (folder structure) instead of "black box" databases of media managers (like iPhoto, Photoshop 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
-* for some events (wedding, holydays etc.) have photos from different authors and would like to keep visible author name (nik) in the file name
-* appreciate the use of internal metadata (EXIF, XMP etc.) beleiving it is the best way to keep context info of the picture
+* for some events \(wedding, holydays etc.\) have photos from different authors and would like to keep visible author name \(nik\) in the file name
+* appreciate the use of internal metadata \(EXIF, XMP etc.\) beleiving it is the best way to keep context info of the picture
 * are Ok with the use of Command Line tools
 
-**********
+---
 
 ## Installation
+
 ### Install for usage
-1. Get the latest [ruby](https://www.ruby-lang.org/) (>= 2.3) installed.
-2. Install ExifTool by Phil Harvey (http://www.sno.phy.queensu.ca/~phil/exiftool/).
+
+1. Get the latest [ruby](https://www.ruby-lang.org/) \(>= 2.4\) installed.
+2. Install ExifTool by Phil Harvey \([http://www.sno.phy.queensu.ca/~phil/exiftool/](http://www.sno.phy.queensu.ca/~phil/exiftool/)\).
 3. `gem install phtools`
 4. Get list of phtools: `phtools`
 5. Get usage info for particular command: `phls -h`
 
 ### Install for development
+
 1. Fork or download from GitHub.
 2. Install dependencies: `bundle install`
 3. Develop.
 4. Test:
-```sh
-bundle exec rspec
-bundle exec cucumber
-```
-... or do testing automatically to get real Test Driven Development:
-```sh
-bundle exec guard
-```
+   ```sh
+   bundle exec rspec
+   bundle exec cucumber
+   ```
+
+   ... or do testing automatically to get real Test Driven Development:
+   ```sh
+   bundle exec guard
+   ```
 
-**********
+---
 
 ## PHTOOLS Use cases
 
-### USE CASE 1. Collect photos, videos, raw-photos from different sources into one place (for further processing)
+### USE CASE 1. Collect photos, videos, raw-photos from different sources into one place \(for further processing\)
+
 #### Given
+
 I have copies of SD Cards with photos, videos taken with DSLR camera on my Hard Disk in `~/Desktop/SDCard1` and in `~/Desktop/SDCard2`.
 
-And I have empty folder `~/Desktop/assets_staging` (lets call it _working folder_).
+And I have empty folder `~/Desktop/assets_staging` \(lets call it _working folder_\).
 
-And I want all the photo-video files from SD copies (including ones placed deep inside the folder structure of the SD card) to be moved to the _working folder_.
+And I want all the photo-video files from SD copies \(including ones placed deep inside the folder structure of the SD card\) to be moved to the _working folder_.
 
 #### When
+
 I run:
+
 ```sh
 phls -R ~/Desktop/SDCard1 ~/Desktop/SDCard2 | phmove -a ~/Desktop/assets_staging
 ```
 
 #### Then
+
 I get all photos moved to `~/Desktop/assets_staging`.
 
 And all videos are moved to `~/Desktop/assets_staging/VIDEO`.
@@ -66,20 +79,25 @@ And all raw photo-files are moved to `~/Desktop/assets_staging/RAW`.
 
 ### USE CASE 2. Renaming files in accordance with PHTOOLS standard
 
-#### USE CASE 2.1 Mass rename photos in accordance with PHTOOLS standard (and don't forget to backup before)
+#### USE CASE 2.1 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).
+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`.
@@ -87,72 +105,90 @@ And I have all original photo-files are backed-up to `~/Desktop/assets_staging/b
 ==========
 
 #### USE CASE 2.2 Rename photos back to it's original names
+
 #### Given
+
 I have several photo files in my working folder `~/Desktop/assets_staging` renamed to PHTOOLS standard.
 
-And I want to get all the files renamed back to it's original names (given by DSLR camera)
+And I want to get all the files renamed back to it's original names \(given by DSLR camera\)
 
 #### When
+
 I run:
+
 ```sh
 cd ~/Desktop/assets_staging
 phls | phrename --clean
 ```
 
 #### Then
+
 I get all photos in `~/Desktop/assets_staging` renamed to it's original names.
 
 ==========
 
 #### USE CASE 2.3 Change author nickname in the filenames
+
 #### Given
-I have several photo files in my working folder `~/Desktop/assets_staging` renamed to PHTOOLS standard. Some photos were made by ANB, some photos were made by Alex (nick _ALE_)
+
+I have several photo files in my working folder `~/Desktop/assets_staging` renamed to PHTOOLS standard. Some photos were made by ANB, some photos were made by Alex \(nick _ALE_\)
 
 And I want to change the author NICKNAME _ALE_ to _ALX_.
 
 #### When
+
 I run:
+
 ```sh
 cd ~/Desktop/assets_staging
 phls '*ALE*'| phrename -a alx
 ```
 
 #### Then
+
 I get all _ALE_ photos in `~/Desktop/assets_staging` renamed to _ALX_ nickname.
 
 And all _ANB_ photos are kept unchanged.
 
-_Note. `phrename` is smart enough to let the user to re-run it several times on one file. Every time `phrename -a` re-runs it only overwrites author nickname (if it is different) keeping date-time-in-the-name unchanged._
+_Note. _`phrename`_ is smart enough to let the user to re-run it several times on one file. Every time _`phrename -a`_ re-runs it only overwrites author nickname \(if it is different\) keeping date-time-in-the-name unchanged._
 
 ==========
 
 #### USE CASE 2.4 Adjust date-time in the filename
+
 #### Given
+
 I have several video files taken by iPhone in my working folder `~/Desktop/assets_staging` renamed to PHTOOLS standard.
 
-And I've found out that iPhone gives the wrong value to CreateDate tag (in my case the error is minus 2 hours to real time of creation). Because of that 'phrename' gives the wrong _YYYYmmdd-HHMMSS_ timestamp in the filename. I want to get the correct date-time info in the names of video files.
+And I've found out that iPhone gives the wrong value to CreateDate tag \(in my case the error is minus 2 hours to real time of creation\). Because of that 'phrename' gives the wrong _YYYYmmdd-HHMMSS_ timestamp in the filename. I want to get the correct date-time info in the names of video files.
 
 #### When
+
 I run:
+
 ```sh
 cd ~/Desktop/assets_staging
 phls '*.mov'| phrename --shift_time 7200
 ```
 
 #### Then
-I get all _mov_ files in `~/Desktop/assets_staging` renamed with correct _YYYYmmdd-HHMMSS_ timestamp (+ 7200 second = + 2 hours than it was before).
 
-**********
+I get all _mov_ files in `~/Desktop/assets_staging` renamed with correct _YYYYmmdd-HHMMSS_ timestamp \(+ 7200 second = + 2 hours than it was before\).
+
+---
 
 ## 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 groups `DateTimeOriginal` or `CreateDate` for this purpose _(for more details see phrename help: `phrename -h`)_.
+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 groups `DateTimeOriginal` or `CreateDate` for this purpose _\(for more details see phrename help: _`phrename -h`_\)_.
 
 **AAA** - author nikname. 3 character long, only latin alphabet supported.
 
 **ORIGINAL.EXT** - original file name, created by digital camera.
 
-For example, the digital camera photo file `P1193691.JPG`, taken by AndrewBiz (aka ANB), after PHTOOLS processing will look like:
+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

@@ -2,6 +2,7 @@
 - [x] core - runner.rb: print class instance variables in debug mode
 - [x] get rid of nesty
 - [x] switch to fresh MiniExiftool gem
+- [x] support of Apple HEIC files
 
 ### phls
 - [x] phls: use init method to initialize variables

data/extras/help-release.md

@@ -0,0 +1,8 @@
+# How to release a new gem version
+1. Develop and test the feature in a separate branch
+2. Merge branch in to master
+3. Bump a version (version.rb)
+4. Update TODO.md
+5. Update History.md
+6. Update README.md
+7. `rake release`

data/extras/logbook.md

@@ -0,0 +1,8 @@
+# Бортовой журнал проекта
+## 2018-01-22
+Стоит попробовать альтернативные утилиты работы с тегами:
+- [libexif/exif](https://github.com/libexif/exif)
+- [exiv2](http://www.exiv2.org/getting-started.html)
+- [jhead](http://www.sentex.net/~mwandel/jhead/)
+
+Надо бы подумать и сделать выбираемыми движки для работы с тегами - либо exiftool либо альтернатива

data/lib/phtools/ph_file.rb

@@ -10,7 +10,7 @@ require 'fileutils'
 
 module PhTools
   # media type constants
-  FILE_TYPE_IMAGE_NORMAL = %w[jpg jpeg tif tiff png].freeze
+  FILE_TYPE_IMAGE_NORMAL = %w[jpg jpeg tif tiff png heic].freeze
   FILE_TYPE_IMAGE_RAW = %w[orf arw dng].freeze
   FILE_TYPE_IMAGE = FILE_TYPE_IMAGE_NORMAL + FILE_TYPE_IMAGE_RAW
   FILE_TYPE_VIDEO = %w[avi mp4 mpg mts dv mov mkv m2t m2ts 3gp].freeze

data/lib/phtools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PhTools
-  VERSION = '0.15.1'
+  VERSION = '0.16.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phtools
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.16.0
 platform: ruby
 authors:
 - Andrew Bizyaev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-04 00:00:00.000000000 Z
+date: 2019-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -273,6 +273,8 @@ files:
 - exe/phmove
 - exe/phrename
 - exe/phtools
+- extras/help-release.md
+- extras/logbook.md
 - lib/phbackup.rb
 - lib/phevent.rb
 - lib/phfixdto.rb