phtools 0.3.0.pre.alpha → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2ba039340b6db82d48a60d8f61bc675ad8c7f55
-  data.tar.gz: c68da1cc277fffea7af2746ec5c0a35301f7f03b
+  metadata.gz: 921ff0d0c9821c060f63be602f1ac915100cd08c
+  data.tar.gz: bd7b1d4d522b91cbf0e968660efc2cedafb27e0d
 SHA512:
-  metadata.gz: 9417503eb41d424de70de88973b4f43c50778948bf2b41c6601b8a1e383ebbccd3a3e38b72b571abfc19d0f01cc3e4041efd1a82c5932a873759b279ca451739
-  data.tar.gz: 1de101093f41bf5e058226a79fe21610a099ad53dc842880854c13fe714092f90bae814ea5879b91427752c32185a8d6294d531df1991aeae5a01c426d8dd8ee
+  metadata.gz: 8f76752ffec443ad1cfd8eed65ba440d83b2511f8152cf9c7bbf6e16d6cda16529729357189fce04888039e18761aaa5f327f98efefc880030259e0aee0bc29d
+  data.tar.gz: 87ac9775742fb7840b69e7a71d9c322c7d9f6184f4cb02e48a267728bcf6308b39fa47c183048e65dc17cb6e7808a3983a735dd704e5eadd58e119ea0ca01d0b

data/Guardfile

@@ -5,16 +5,30 @@ notification :terminal_notifier, app_name: "phtools"
 # notification :terminal_title
 # notification :tmux, display_message: false
 
-guard 'cucumber', notification: true do
-  watch(%r{^features/.+\.feature$})
-  watch(%r{^features/support/.+$}) { 'features' }
-  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/{m[1]}.feature")][0] || 'features' }
-  watch(%r{^bin/(.+)$}) { |m| "features/#{m[1]}.feature" }
-end
-
 guard :rspec, cmd: "bundle exec rspec" do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^bin/(.+)$}) { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end
+
+cucumber_options = {
+  # Below are examples overriding defaults
+  # cmd: 'bundle exec cucumber',
+  # cmd_additional_args: '--profile guard',
+  # all_after_pass: false,
+  # all_on_start: false,
+  # keep_failed: false,
+  # feature_sets: ['features/frontend', 'features/experimental'],
+  # run_all: { cmd_additional_args: '--profile guard_all' },
+  # focus_on: { 'wip' }, # @wip
+  notification: true
+}
+
+guard 'cucumber', cucumber_options do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$}) { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/{m[1]}.feature")][0] || 'features' }
+  watch(%r{^exe/(.+)$}) { |m| "features/#{m[1]}.feature" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "features/#{m[1]}.feature" }
 end

data/History.md

@@ -1,6 +1,6 @@
 # RELEASED
 
-## [v0.3.0-alpha](https://github.com/andrewbiz/phtools/compare/v0.3.0-alpha...v0.2.4)
+## [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
 * Added aruba (cucumber) tests for phls

data/README.md

@@ -1,6 +1,49 @@
-# ANB's phtools
+[![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 keep photo-video assets in order.
 
-A bundle of small CLI tools for arranging, renaming, tagging  of the photo and video files. Helps keep photo-video assets in order.
+##Installation
+### Install for usage
+Get the latest [ruby](https://www.ruby-lang.org/) (>= 2.3) installed.
 
-## Install for usage
-    gem install phtools
+Install ExifTool by Phil Harvey (http://www.sno.phy.queensu.ca/~phil/exiftool/)
+```
+gem install phtools
+```
+### Install for development
+Fork or download from GitHub.
+
+```sh
+bundle install
+```
+Develop, test:
+```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)
+
+####Given
+I have copies of SD Cards with photos, videos taken with DSLR camera on my Hard Disk in `~/path/to/copy/SDCard1` and in `~/path/to/copy/SDCard2`.
+
+And I have empty folder `~/Desktop/assets_staging` I would like to collect all the photo-files to.
+
+####When
+I run:
+```sh
+cd ~/Desktop/assets_staging
+phls -R ~/path/to/copy/SDCard1 ~/path/to/copy/SDCard2 | phmove -a
+```
+
+####Then
+I get all photos moved to `~/Desktop/assets_staging`.
+
+And all videos are moved to `~/Desktop/assets_staging/VIDEO`.
+
+And all raw photo-files are moved to `~/Desktop/assets_staging/RAW`.

data/TODO.md

@@ -0,0 +1,6 @@
+- [x] core - runner.rb: print class instance variables in debug mode
+- [x] phls: use init method to initialize variables
+- [x] phls: change -r to -R
+- [x] phmove: create phmove tool based on ftarrange code (see ftools repo)
+- [ ] phmove: make parameters to set photo, video, raw folder names
+- [ ] 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 target directory (plain collection of files)

data/exe/phls

@@ -24,13 +24,13 @@ Example: #{tool_name} abc '*aaa*' | phrename -a anb => scans 'abc' folder and
 sends all found phtools friendly files filtered with *aaa* to phrename command.
 
 Usage:
-  #{tool_name} [-D] [-r] [DIR_OR_FILEMASK...]
+  #{tool_name} [-D] [-R] [DIR_OR_FILEMASK...]
   #{tool_name} -h | --help
   #{tool_name} -v | --version
 
 Options:
   -D --debug      Turn on debugging (verbose) mode
-  -r --recursive  Recursively scan directories
+  -R --recursive  Recursively scan directories
   -h --help       Show this screen.
   -v --version    Show version.
 DOCOPT

data/exe/phmove

@@ -0,0 +1,36 @@
+#!/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} moves input file(s) into WORKING_FOLDER
+separating photo files, RAW photo files and VIDEO files in corresponding
+subfolders.
+phtools friendly files: #{file_type * ','}
+
+Optimized to be used with other *phtools* via pipes.
+Example: phls | phrename -a anb | #{tool_name}
+
+Usage:
+  #{tool_name} [-w WORKING_FOLDER] [-D]
+  #{tool_name} -h | --help
+  #{tool_name} -v | --version
+
+Options:
+  -w FLD --working_folder=FLD  Folder the input files to be
+                               moved to [default: .]
+  -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/lib/phls.rb

@@ -12,15 +12,8 @@ module PhTools
     end
 
     def run!
-      dirs_to_scan = []
-      filemasks = []
-      @options_cli['DIR_OR_FILEMASK'].each do |item|
-        File.directory?(item) ? dirs_to_scan << item : filemasks << item
-      end
-      dirs_to_scan = ['.'] if dirs_to_scan.empty?
-      filemasks = ['*.*'] if filemasks.empty?
-      dirs_to_scan.each do |dir|
-        fmask = File.join(dir, @options_cli['--recursive'] ? '**' : '', "{#{filemasks * ','}}")
+      @dirs_to_scan.each do |dir|
+        fmask = File.join(dir, @options_cli['--recursive'] ? '**' : '', "{#{@filemasks * ','}}")
         Dir.glob(fmask, File::FNM_CASEFOLD).each { |f| output_file(f) if File.file?(f) }
       end
 
@@ -34,6 +27,16 @@ module PhTools
 
     private
 
+    def validate_options
+      @dirs_to_scan = []
+      @filemasks = []
+      @options_cli['DIR_OR_FILEMASK'].each do |item|
+        File.directory?(item) ? @dirs_to_scan << item : @filemasks << item
+      end
+      @dirs_to_scan = ['.'] if @dirs_to_scan.empty?
+      @filemasks = ['*.*'] if @filemasks.empty?
+    end
+
     def output_file(file)
       ftype = File.extname(file).empty? ? '' : File.extname(file).slice(1..-1).downcase
       @os.output(File.join(File.dirname(file), File.basename(file))) if @file_type.include?(ftype)

data/lib/phmove.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require 'phtools/runner'
+
+module PhTools
+  class Phmove < Runner
+    def self.about
+      "moves input files into working folder"
+    end
+    private
+
+    def validate_options
+      @working_folder = @options_cli['--working_folder'] || ''
+      @raw_folder = File.join(@working_folder, 'RAW')
+      @video_folder = File.join(@working_folder, 'VIDEO')
+    end
+
+    def process_before
+      fail PhTools::Error, "#{@working_folder} does not exist" unless File.exist?(@working_folder)
+      fail PhTools::Error, "#{@working_folder} is not a directory" unless File.directory?(@working_folder)
+      begin
+        Dir.mkdir @raw_folder unless Dir.exist?(@raw_folder)
+        Dir.mkdir @video_folder unless Dir.exist?(@video_folder)
+      rescue
+        raise PhTools::Error, "Unable to make dir inside '#{@working_folder}'"
+      end
+    end
+
+    def process_file(ftfile)
+      ftfile_out = ftfile.clone
+      file_type = ftfile.extname.slice(1..-1).downcase
+      case
+      when FILE_TYPE_IMAGE_NORMAL.include?(file_type)
+        ftfile_out.dirname = @working_folder
+      when FILE_TYPE_IMAGE_RAW.include?(file_type)
+        ftfile_out.dirname = @raw_folder
+      when FILE_TYPE_VIDEO.include?(file_type)
+        ftfile_out.dirname = @video_folder
+      when FILE_TYPE_AUDIO.include?(file_type)
+        ftfile_out.dirname = @working_folder
+      end
+
+      FileUtils.mv(ftfile.filename, ftfile_out.filename) unless ftfile == ftfile_out
+      ftfile_out
+    rescue SystemCallError => e
+      raise PhTools::Error, 'file moving - ' + e.message
+    end
+  end
+end

data/lib/phtools/runner.rb

@@ -27,10 +27,14 @@ module PhTools
       @options_cli = Docopt.docopt(usage, version: "v#{PhTools::VERSION}")
       @file_type = file_type
       PhTools.debug = true if @options_cli['--debug']
-      PhTools.puts_error "OPTIONS = #{@options_cli}" if PhTools.debug
 
       validate_options
 
+      if PhTools.debug
+        STDERR.puts "Instance Variables: "
+        STDERR.puts context
+      end
+
     rescue Docopt::Exit => e
       STDERR.puts e.message
       exit 0
@@ -79,5 +83,11 @@ module PhTools
 
     def process_after
     end
+
+    def context
+      self.instance_variables.map do |item|
+        { item => self.instance_variable_get(item) }
+      end
+    end
   end
 end

data/lib/phtools/version.rb

@@ -1,4 +1,4 @@
 
 module PhTools
-  VERSION = '0.3.0-alpha'
+  VERSION = '0.3.0'
 end

data/lib/phtools.rb

@@ -2,13 +2,13 @@
 # encoding: UTF-8
 # (c) ANB Andrew Bizyaev
 require 'phtools/version'
-require 'pharrange'
 require 'phbackup'
 require 'phclname'
 require 'phevent'
 require 'phfixdate'
 require 'phfixfmd'
 require 'phls'
+require 'phmove'
 require 'phmtags'
 require 'phrename'
 require 'phtagset'
@@ -19,7 +19,7 @@ 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:
-    pharrange\t(#{Phrename::about}),
+    phmove\t(#{Phmove::about}),
     phbackup\t(#{Phbackup::about}),
     phclname\t(#{Phclname::about}),
     phevent\t(#{Phevent::about}),
@@ -30,6 +30,7 @@ Please run phtools in a terminal via CLI commands:
     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
 TEXT
   end
 end

data/phtools.gemspec

@@ -33,7 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'cucumber', '~> 2.0'
   spec.add_development_dependency 'aruba', '~> 0.14'
   spec.add_development_dependency 'fuubar'
-  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'guard-cucumber'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phtools
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre.alpha
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Bizyaev
@@ -108,20 +108,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  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: guard
   requirement: !ruby/object:Gem::Requirement
@@ -254,6 +240,7 @@ email:
 - andrew.bizyaev@gmail.com
 executables:
 - phls
+- phmove
 - phtools
 extensions: []
 extra_rdoc_files: []
@@ -267,18 +254,20 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/console
 - bin/setup
 - bin/stmux
 - exe/phls
+- exe/phmove
 - exe/phtools
-- lib/pharrange.rb
 - lib/phbackup.rb
 - lib/phclname.rb
 - lib/phevent.rb
 - lib/phfixdate.rb
 - lib/phfixfmd.rb
 - lib/phls.rb
+- lib/phmove.rb
 - lib/phmtags.rb
 - lib/phrename.rb
 - lib/phtagset.rb
@@ -310,9 +299,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements:
 - ExifTool by Phil Harvey (http://www.sno.phy.queensu.ca/~phil/exiftool/)
 rubyforge_project: 

data/lib/pharrange.rb

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