vera 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49ac4042e58861b59ed1173e956b2f4e7adf0476350c0d860a4c046f5480e2bb
-  data.tar.gz: 7d196399ffca78ce41b24f9768f473d3872f83d8b6797c68f23808a45706471e
+  metadata.gz: 390655a8e0f68a6d79a054e7ded01e274d92336f9e47811f627a409fe2b4308e
+  data.tar.gz: 7d6b771345a524614f3396dbbc363f8fb305a34df36b20bbae946d487ffe3d2d
 SHA512:
-  metadata.gz: d8e66192bf76b411fae6d2d7848b64d5be2c3ce3452e41763eebbb8facd58dac401aff0a7b859ba6a7c0757e91e00dbe881c336df723d99890516cbbbbf1c6a1
-  data.tar.gz: cbe46919fb33f10861fda1139c7c480dae4023610d548925f4ae7f5d33b0395d9c218539e85b81af7e42f4d60c883cc8e99ec964acc77127ec54493e0332d58d
+  metadata.gz: f8afcf42416bfc5c37662028d6e88ed842311aea724632338122b16dfc070947133c8ec990055ca6dc5dd57f2646fea70b154fd4dc7c3fb4e933a84f0efa7710
+  data.tar.gz: e8900f74ce81a63a6e6ed050c3c6b31226b467357d74c6127903afb7067f7e81ac2b201b507f0f7644654d9716dd141d92331be483336366b0e1d6e793489710

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vera (0.1.0)
+    vera (0.1.1)
       commander
 
 GEM

data/README.md

@@ -26,11 +26,37 @@ Once you have it installed you can use any of the following commands.
 This command fixes the created date and the modified date of the media files. Run the following command in the folder where you have your photos and videos:
 
 ```bash
-vera timestamp
+vera timestamp --path ~/path/example
 ```
 
+#### Options 
+
+| Parameter     | Default Value     | Descripción                                            |
+| ------------- | ----------------- | ------------------------------------------------------ |
+| path (--path) | Current directory | Path where the command will be applied. Non-recursive. |
+
 This command works on JPG, MOV, HEIC and ARW files.
 
+### Rename
+
+Prepends the creation date to the filename. This is useful to prevent having duplicate names in your files, as most cameras have a limited naming convention like IMG_0000.JPG to IMG_9999.JPG. As a result of this this command you will have file names like 2020-02-02-IMG_0000.JPG, which makes having duplicated file names almost impossible.
+
+```bash
+vera rename --path ~/path/example
+```
+
+#### Options
+
+| Parameter     | Default Value     | Descripción                                            |
+| ------------- | ----------------- | ------------------------------------------------------ |
+| path (--path) | Current directory | Path where the command will be applied. Non-recursive. |
+
+This command works on JPG, MOV, HEIC and ARW files.
+
+#### Example
+
+![vera rename](gif/renamer.gif)
+
 If you want to add more commands, feel free to contribute with a PR to Vera. In the next section I explain how to start working on it.
 
 ## Developement

data/bin/vera

@@ -11,11 +11,23 @@ program :version, Vera::VERSION
 program :description, 'Organize media files'
 
 command :timestamp do |c|
-  c.syntax = 'vera rename, [options]'
+  c.syntax = 'vera timestamp [options]'
   c.summary = 'Fix the timestamp of current folder\'s media'
   c.description = 'Uses picture/movie creation date to change the created and modified date of the media file'
   c.example 'description', 'vera timestamp'
+  c.option '--path PATH', 'Where to execute the command. Default value is the current directory.'
   c.action do |_args, options|
     Vera::Timestamp.execute(options)
   end
 end
+
+command :rename do |c|
+  c.syntax = 'vera rename [options]'
+  c.summary = 'Rename files to include the date at the beggining of the file'
+  c.description = 'Converts IMG_2200.JPG to 2020-02-02-IMG_2200.JPG for all the media files in a folder.'
+  c.example 'description', 'vera rename PATH'
+  c.option '--path PATH', 'Where to execute the command. Default value is the current directory.'
+  c.action do |args, options|
+    Vera::Renamer::execute(options)
+  end
+end

data/lib/vera.rb

@@ -4,3 +4,4 @@ require_relative 'vera/lister'
 require_relative 'vera/timestamp'
 require_relative 'vera/version'
 require_relative 'vera/exiftool'
+require_relative 'vera/renamer'

data/lib/vera/exiftool.rb

@@ -9,5 +9,9 @@ module Vera
     def self.is_installed?
       system("which exiftool >/dev/null")
     end
+
+    def self.change_filename_with_date(date_property, files_string)
+      system("exiftool '-FileName<$#{date_property}-$filename' -d \"%Y-%m-%d\" #{ files_string } 2>/dev/null")
+    end
   end
 end

data/lib/vera/renamer.rb

@@ -0,0 +1,40 @@
+module Vera
+  class Renamer
+    def self.execute(options)
+      unless Exiftool.is_installed?
+        puts """
+          You need to install exiftool to use vera. You can run the following command to do it:
+          bash <(curl -Ls https://git.io/JtbuH)
+        """
+        return
+      end
+      path = options.path
+      path = Dir.pwd if options.path.nil?
+      path = File.expand_path(path)
+      rename path
+    end
+
+    def self.rename path
+      rename_files_with_date path, "ARW",  "DateTimeOriginal"
+      rename_files_with_date path, "JPG",  "DateTimeOriginal"
+      rename_files_with_date path, "HEIC", "DateTimeOriginal"
+      rename_files_with_date path, "MOV",  "CreationDate"
+    end
+
+    def self.rename_files_with_date path, ext, date_property
+      puts "✅ Adding creation date to #{ext} files in the filename"
+      files = Lister.all_files(path, ext)
+      files = Renamer.exclude_already_renamed_files(files)
+      if files.empty?
+        puts "No files to rename for #{ext} file type."
+        return
+      end
+      files_string = files.map { |f| "\"#{f[:path]}\"" }.join(" ")
+      puts "❌Something went wrong" unless Exiftool.change_filename_with_date(date_property, files_string)
+    end
+
+    def self.exclude_already_renamed_files files
+      files.select { |f| f[:filename].match(/\d+\-\d+\-\d+\-/) == nil }
+    end
+  end
+end

data/lib/vera/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vera
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/spec/vera_spec.rb

@@ -31,3 +31,33 @@ RSpec.describe Vera::Timestamp do
     Vera::Timestamp.execute(options)
   end
 end
+
+RSpec.describe Vera::Renamer do
+  it 'skips files that are already renamed' do
+    files = [
+      { filename: '2020-01-02-some.jpg', path: 'example/2020-01-02-some.jpg' },
+      { filename: 'other.jpg', path: 'example/other.jpg' }
+    ]
+    filtered_files = Vera::Renamer.exclude_already_renamed_files files
+    expect(filtered_files).to eq [
+      { filename: 'other.jpg', path: 'example/other.jpg' }
+    ]
+  end
+
+  it 'renames files adding the date' do
+    expect(Vera::Lister).to receive(:all_files)
+      .exactly(4).times
+      .with(anything, anything) {
+                              [
+                                { filename: 'some.jpg', path: 'example/some.jpg' },
+                                { filename: 'other.jpg', path: 'example/other.jpg' }
+                              ]
+                            }
+    files = '"example/some.jpg" "example/other.jpg"'
+    expect(Vera::Exiftool).to receive(:change_filename_with_date)
+      .exactly(4).times
+      .with(anything, files)
+    options = OpenStruct.new({ path: 'example' })
+    Vera::Renamer.execute(options)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vera
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - David Cortés
@@ -80,13 +80,15 @@ files:
 - "./LICENSE.txt"
 - "./README.md"
 - "./Rakefile"
+- "./gif/renamer.gif"
 - "./install.sh"
 - "./lib/vera.rb"
 - "./lib/vera/exiftool.rb"
 - "./lib/vera/lister.rb"
+- "./lib/vera/renamer.rb"
 - "./lib/vera/timestamp.rb"
 - "./lib/vera/version.rb"
-- "./vera-0.1.0.gem"
+- "./vera-0.1.1.gem"
 - "./vera.gemspec"
 - "./vera.jpg"
 - bin/vera