photo_rename 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ec86080ae15389f539c47aafc0f780d795319c7
-  data.tar.gz: 03d2696d36dcb5090c4fea24246d2a1a7d8d5a63
+  metadata.gz: a20d12e50f922698424746ea8206ea72230bb793
+  data.tar.gz: a6a9c6b88d896a15b1e5a0a7a91225177591e0a4
 SHA512:
-  metadata.gz: 9e1543cfc677fa16d43663658a5da164e280ab69f29c5e51f5e9c22d93f9111469546df1841d2d660df6efa104560cd10c69e05cc8796a015c14587e78e29cdb
-  data.tar.gz: 3d14851a6b3fa6f2fe52d73dc9d2de3c9e199268edbe2eca1e8daa155c80bb2a7dfd8f55682ab19078773fec012a79c27f06a3a12ca98e72f3d82d37186eed61
+  metadata.gz: 2366457fdf78e74faeb28f9a3ab79108fce51c03db57338544dadfc2926f162a60b6bd99e5a1bb357905fc8769c95432951b9020de27f98324801f854c09f182
+  data.tar.gz: f898f40546b680eb0bdf9a9086319b4cf952b94c39325981bdde4da44d72c3342190efd56ecde4326e1c9bdd7fc6f322a2862e1d04793a9cdbfeb92609b0f41e

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -1,5 +1,17 @@
-source 'https://rubygems.org'
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'awesome_print' , '~> 1.6'
+gem 'mini_exiftool' , '~> 2.5'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end
 
-# Specify your gem's dependencies in photo_rename.gemspec
-gemspec
-gem 'awesome_print' , '~> 1.2.0'

data/README.md

@@ -0,0 +1,89 @@
+# Photo Renamer #
+
+![img](//badge.fury.io/rb/photo_rename.svg) 
+
+## What the script does ##
+
+This script is fairly specific. It renames all JPG files (technically files with a .jpg or .jpeg extenstion) in a given directory to the form IMG<sub>\*</sub>yyyymmdd\*<sub>\*</sub>hhmmss\*.jpg
+
+## Rationale ##
+
+The naming pattern described above is the naming pattern used by the stock Android camera.Renaming photos taken with other devices to this scheme allows me to seamlessly merge photos into a single directory and maintain consistent file names.
+
+## Extracting the date ##
+
+### exif meta data ###
+Per default we now use the JPEG `exif meta data` to find the creation date of the file. This gives much more reliable results than using the `mtime` of the file.
+
+The case that convinced me this change was necessary:
+I wanted to rename images that was recovered after being deleted. The recovery process changed the `mtime` of the files, but the `meta data` remained intact. 
+
+### mtime ###
+
+It is still possible to find the date with `mtime` using the `-f` command line switch, but using the `exif metadata` is the highly preferred method. 
+
+~~After some experimenting I found that if I copy photos from my camera's memory card to my PC the "Modify Time" field gets preserved. Therefore I use this field as the basis for renaming the files. Obviously if you modify the file before renaming the mtime field will get updated and your file name will be wrong, so be warned!~~
+
+~~**IMPORTANT NOTE**~~
+~~Since I am renaming files based on the date created by the device that captured the image, this device's date should be correctly set. (For the next release I want to add more options to manually set the date)~~
+
+
+## Installation ##
+
+### Dependencies ###
+Since version `0.1.0` we use exif metadata to get the file creation date by default. We use the ruby library `mini_exiftool` which has a dependency on [exiftool](http://www.sno.phy.queensu.ca/~phil/exiftool/).
+
+`exiftool` should be easily installable through the package manager of most distributions.
+
+**Arch Linux**
+
+```bash
+pacman -S perl-image-exiftool
+```
+
+**Ubuntu**
+
+```bash
+apt-get install libimage-exiftool-perl
+```
+
+**OSX**
+http://www.sno.phy.queensu.ca/~phil/exiftool/ExifTool-10.00.dmg
+
+**Windows**
+http://www.sno.phy.queensu.ca/~phil/exiftool/exiftool-10.00.zip
+
+
+### Ruby Gems ###
+
+The easiest way to install the script is by using rubygems.
+
+    gem install photo_rename
+
+![img](./screenshots/install.png)
+
+## Usage ##
+
+    photo_rename photo_directory
+
+![img](./screenshots/example.png)
+
+
+## Release notes ##
+
+### 0.1.0 ###
+
+-   Use mini_exiftool to get the date from image metadata
+-   Removed `-b` command line option, as this is not implemented yet
+
+### 0.0.4 ###
+
+-   Do not rename files that are already in the correct format.
+
+### 0.0.1 - 0.0.3 ###
+
+-   Sort out teething problems with gem.
+
+### License ###
+
+This program is licensed under [(<http://www.gnu.org/licenses/gpl-3.0.txt>)[GNU GPL]]

data/Rakefile

@@ -1,4 +1,56 @@
-require "bundler/gem_tasks"
-require "bundler"
-Bundler.setup
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "photo_rename"
+  gem.homepage = "http://github.com/tjaartvdwalt/photo_rename"
+  gem.license = "GPL"
+  gem.summary = "Photo renamer"
+  gem.description =  "Rename JPG images in a directory based on the date in the file's mtime field. By default the target file names are in the same format as those created by Android devices."
+  gem.email = "github@tjaart.co.za"
+  gem.authors = ["Tjaart van der Walt"]
+  # dependencies defined in Gemfile
+
+  # include the file runner
+  gem.files.include 'bin/*'
+  
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "photo_rename #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
 

data/VERSION

@@ -0,0 +1 @@
+0.0.5

data/bin/photo_rename

@@ -5,11 +5,11 @@ require 'photo_rename'
 def main()
     photo_rename = Photo_rename.new()
     ARGV.length == 0 ? print_opts = true : print_opts = false
-    photo_rename.parse_options(print_opts)
+    options = photo_rename.parse_options(print_opts)
 
     ARGV.each do |arg|
-        map = photo_rename.name_map(arg)
-        photo_rename.print_replace_names(arg, map)
+      map = photo_rename.name_map(arg, options)
+      photo_rename.print_replace_names(arg, map)
     end
 
 end

data/lib/photo_rename.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # photo_renamer renames all .jpg files in a given directory to the form IMG_*yyyymmdd*_*hhmmss*.jpg
-# Copyright (C) 2013  Tjaart van der Walt
+# Copyright (C) 2015  Tjaart van der Walt
 
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -19,6 +19,7 @@
 require 'optparse'
 require 'rubygems'
 require 'awesome_print'
+require 'mini_exiftool'
 
 class Photo_rename
   def new_name(mdate)
@@ -29,12 +30,19 @@ class Photo_rename
     return ret_string
   end
 
-  def name_map(dir_path)
+  def name_map(dir_path, options)
     no_change_array = []
     change_map = {}
     Dir.glob("#{dir_path}/*.[jJ][pP][gG]").sort.each do |f|
       if /[Ii][Mm][Gg]\_[0-9]{8}\_[0-9]{6}\.[Jj][Pp][Gg]/.match(f) == nil
-        mdate = File.mtime(f)
+
+        if not options[:file] then
+          photo = MiniExiftool.new f
+          mdate = photo[:DateTimeOriginal]
+          puts mdate          
+        else 
+          mdate = File.mtime(f)
+        end
         change_map[f] = "#{dir_path}/#{new_name(mdate)}"
       else
         no_change_array.push(f)
@@ -63,9 +71,14 @@ class Photo_rename
     optparse = OptionParser.new do|opts|
       opts.banner = "Usage: photo_renamer.rb [options] dir1 [dir2 ...]"
 
-      options[:batch] = false
-      opts.on( '-b', '--batch', 'Batch mode. Will not ask confirmation before renaming.' ) do
-        options[:batch] = true
+      # options[:batch] = false
+      # opts.on( '-b', '--batch', 'Batch mode. Will not ask confirmation before renaming.' ) do
+      #   options[:batch] = true
+      # end
+
+      options[:file] = false
+      opts.on( '-f', '--filedate', 'Use the file creation date, instead of the exif meta data' ) do
+        options[:file] = true
       end
 
       opts.on( '-h', '--help', 'Display this screen' ) do

data/lib/photo_rename/version.rb

@@ -1,3 +1,3 @@
 module PhotoRename
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/photo_rename.gemspec

@@ -1,27 +1,72 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'photo_rename/version'
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: photo_rename 0.0.5 ruby lib
 
-Gem::Specification.new do |spec|
-  spec.name          = "photo_rename"
-  spec.version       = PhotoRename::VERSION
-  spec.authors       = ["Tjaart van der Walt"]
-  spec.email         = ["github@tjaart.co.za"]
-  spec.summary     = "Photo renamer"
-  spec.description = "Rename JPG images in a directory based on the date in the file's mtime field. By default the target file names are in the same format as those created by Android devices."
-  spec.homepage    ='https://github.com/tjaartvdwalt/photo_rename'
-  spec.license       = "GNU GPL"
+Gem::Specification.new do |s|
+  s.name = "photo_rename"
+  s.version = "0.0.5"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Tjaart van der Walt"]
+  s.date = "2015-09-02"
+  s.description = "Rename JPG images in a directory based on the date in the file's mtime field. By default the target file names are in the same format as those created by Android devices."
+  s.email = "github@tjaart.co.za"
+  s.executables = ["photo_rename"]
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "COPYING",
+    "Gemfile",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/photo_rename",
+    "lib/photo_rename.rb",
+    "lib/photo_rename/version.rb",
+    "photo_rename.gemspec",
+    "screenshots/example.png",
+    "screenshots/install.png",
+    "test/helper.rb",
+    "test/test_photo_rename.rb"
+  ]
+  s.homepage = "http://github.com/tjaartvdwalt/photo_rename"
+  s.licenses = ["GPL"]
+  s.rubygems_version = "2.4.8"
+  s.summary = "Photo renamer"
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.3"
-  
-  spec.add_runtime_dependency "awesome_print" , "~> 1.2"
-  
-  spec.required_ruby_version = '~> 2.0'
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<awesome_print>, ["~> 1.6"])
+      s.add_runtime_dependency(%q<mini_exiftool>, ["~> 2.5"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<awesome_print>, ["~> 1.6"])
+      s.add_dependency(%q<mini_exiftool>, ["~> 2.5"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<awesome_print>, ["~> 1.6"])
+    s.add_dependency(%q<mini_exiftool>, ["~> 2.5"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
 end
+

data/test/helper.rb

@@ -0,0 +1,34 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'photo_rename'
+
+class Test::Unit::TestCase
+end

data/test/test_photo_rename.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestPhotoRename < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: photo_rename
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Tjaart van der Walt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-08 00:00:00.000000000 Z
+date: 2015-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,57 +25,116 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: mini_exiftool
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
+        version: '1.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rename JPG images in a directory based on the date in the file's mtime
   field. By default the target file names are in the same format as those created
   by Android devices.
-email:
-- github@tjaart.co.za
+email: github@tjaart.co.za
 executables:
 - photo_rename
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
-- ".gitignore"
+- ".document"
 - COPYING
 - Gemfile
-- README.org
+- README.md
 - Rakefile
+- VERSION
 - bin/photo_rename
 - lib/photo_rename.rb
 - lib/photo_rename/version.rb
 - photo_rename.gemspec
 - screenshots/example.png
 - screenshots/install.png
-homepage: https://github.com/tjaartvdwalt/photo_rename
+- test/helper.rb
+- test/test_photo_rename.rb
+homepage: http://github.com/tjaartvdwalt/photo_rename
 licenses:
-- GNU GPL
+- GPL
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -83,9 +142,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -93,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Photo renamer

data/.gitignore

@@ -1,22 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/README.org

@@ -1,38 +0,0 @@
-* Photo Renamer
- 
-** What the script does
-This script is fairly specific. It renames all JPG files (technically files with a .jpg or .jpeg extenstion) in a given directory to the form IMG_*yyyymmdd*_*hhmmss*.jpg
-
-** Rationale
-The naming pattern described above is the naming pattern used by the stock Android camera.
-Renaming photos taken with other devices to this scheme allows me to seamlessly merge photos into a single directory and maintain consistent file names.
-
-** mtime
-After some experimenting I found that if I copy photos from my camera's memory card to my PC the "Modify Time" field gets preserved. Therefore I use this field as the basis for renaming the files. Obviously if you modify the file before renaming the mtime field will get updated and your file name will be wrong, so be warned!
-
-*IMPORTANT NOTE*
-Since I am renaming files based on the date created by the device that captured the image, this device's date should be correctly set. (For the next release I want to add more options to manually set the date)
-
-** Install
-The easiest way to install the script is by using rubygems.
-#+begin_src bash
-gem install photo_rename
-#+end_src
-
-[[./screenshots/install.png]]
-
-** Usage
-#+begin_src bash
-photo_rename photo_directory
-#+end_src
-
-[[./screenshots/example.png]]
-** Release notes
-*** 0.0.4
-- Do not rename files that are already in the correct format.
-
-*** 0.0.1 - 0.0.3
-- Sort out teething problems with gem.
-
-** GNU GPL
-This program is licensed under [(http://www.gnu.org/licenses/gpl-3.0.txt)[GNU GPL]]