filter_rename 1.0.0

data/README.md

@@ -0,0 +1,82 @@
+# FilterRename
+
+FilterRename is a CLI tool created to rename a bunch of files at once applying a cascade of
+self-explainatory options called _filters_, in order to substitute all the other shell commands
+(like _sed_, _awk_, _trim_, ... ) and personal shell script to achieve that goal safely and
+in comfortable manner.
+
+To simplify the whole process through a command line, the full filename is logically organized
+in _targets_ like:
+
+    <path>/<folder>/<name><ext>
+
+Considering the file `/home/fabio/Documents/Ruby/filter_rename/Gemfile.lock` we have:
+
+- path: */home/fabio/Documents/Ruby*
+- folder: *filter_rename*
+- name: *Gemfile*
+- ext: *.lock*
+
+The chain of filters will be applied to the current _target_ which can be selected using the *--select*
+option, the default target is _name_.
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install filter_rename
+
+## Usage
+
+The main concept about FilterRename is the _target_ manipulation with a chain of _filters_
+executed one by one as they appear in the argument's list.
+
+There are three main operations:
+* _preview_: show the results without make any change (default);
+* _dry-run_: executes a simulation warning when a conflict is raised;
+* _apply_: confirm the changes and rename the files unless the destination file exists.
+
+Having the files:
+
+    home
+      fabio
+        Documents
+          Photos
+            Vacations
+              image_portofino_1.jpg
+              image_portofino_2.jpg
+              image_portofino_3.jpg
+              ...
+
+to replace _underscores_ with _spaces_ and _capitalize_ each word let's execute:
+
+    filter_rename /home/fabio/Documents/Photos/Vacations/*.jpg --spacify '_' --capitalize --apply
+
+and the result will be:
+
+    home
+      fabio
+        Documents
+          Photos
+            Vacations
+              Image Portofino 1.jpg
+              Image Portofino 2.jpg
+              Image Portofino 3.jpg
+              ...
+
+
+## Get help
+
+Where to start
+
+    $ filter_rename --help
+
+More help
+
+- The wiki page: https://github.com/fabiomux/filter_rename/wiki
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fabio_mux/filter_rename. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "filter_rename"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/filter_rename

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'filter_rename/cli'
+
+FilterRename::CLI.start

data/filter_rename.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'filter_rename/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "filter_rename"
+  spec.version       = FilterRename::VERSION
+  spec.authors       = ["Fabio Mucciante"]
+  spec.email         = ["fabio.mucciante@gmail.com"]
+
+  spec.summary       = %q{Rename filenames through a chain of filter.}
+  spec.description   = %q{Rename filenames applying a cascade of commands called filters in specified portion of it called targets.}
+  spec.homepage      = "https://github.com/fabiomux/filter_rename"
+  spec.license       = "GPL-3.0"
+
+  spec.metadata      = {
+    "bug_tracker_uri"   => "https://github.com/fabiomux/filter_rename/issues",
+    #"changelog_uri"     => "",
+    "documentation_uri" => "https://www.rubydoc.info/gems/filter_rename/#{spec.version}",
+    "homepage_uri"      => "https://github.com/fabiomux/filter_rename",
+    #"mailing_list_uri"  => "",
+    "source_code_uri"   => "https://github.com/fabiomux/filter_rename",
+    "wiki_uri"          => "https://github.com/fabiomux/filter_rename/wiki"
+  }
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "mp3info"
+  spec.add_runtime_dependency "mimemagic"
+  spec.add_runtime_dependency "differ"
+  spec.add_runtime_dependency "exiv2"
+  spec.add_runtime_dependency "fastimage"
+  spec.add_runtime_dependency "pdf-reader"
+end

data/lib/filter_rename.rb

@@ -0,0 +1,137 @@
+require 'fileutils'
+require 'filter_rename/version'
+require 'filter_rename/config'
+require 'filter_rename/filter_base'
+require 'filter_rename/filters'
+require 'filter_rename/filter_pipe'
+require 'filter_rename/filename'
+require 'filter_rename/filename_factory'
+require 'filter_rename/utils'
+
+module FilterRename
+
+  class Builder
+
+    def initialize(options)
+      @cfg = Config.new(options.global)
+      @filters = FilterList.new(options.filters)
+      @files = options.files
+      @show_macro = options.show_macro
+    end
+
+    def preview
+      raise MissingFiles if @files.empty?
+
+      @filters.expand_macros!(@cfg.macro)
+
+      Messages.label "Preview:"
+
+      @files.each do |src|
+        fp = FilterPipe.new(src, @filters, @cfg).apply
+        Messages.diff(fp)
+      end
+    end
+
+    def apply
+      raise MissingFiles if @files.empty?
+
+      @filters.expand_macros!(@cfg.macro)
+
+      Messages.label "Apply:"
+      @files.each do |src|
+
+        fp = FilterPipe.new(src, @filters, @cfg).apply
+
+        if fp.changed?
+          old_data = fp.rename!
+
+          if old_data[:full_filename]
+            Messages.renamed!(old_data, fp.dest)
+            Messages.changed_tags(fp, old_data, false) if fp.source.class.has_writable_tags
+          else
+            Messages.changed_tags(fp, old_data)
+          end
+
+        else
+          Messages.skipping(fp)
+        end
+      end
+    end
+
+    def globals
+      Messages.label 'Global configurations:'
+      Messages.config_list @cfg.global
+    end
+
+    def configs
+      Messages.label 'Filter\'s configurations:'
+      Messages.config_list @cfg.filter
+    end
+
+    def words
+      Messages.label 'Groups and subgroups of words available for translation:'
+      Messages.config_multilist @cfg.words
+    end
+
+    def dry_run
+      raise MissingFiles if @files.empty?
+
+      @filters.expand_macros!(@cfg.macro)
+      cache = []
+
+      Messages.label "Dry Run:"
+      @files.each do |src|
+
+        fp = FilterPipe.new(src, @filters, @cfg).apply
+
+        if fp.unchanged?
+          Messages.skipping(fp)
+        elsif (cache.include?(fp.dest.full_filename) || fp.dest.exists?)
+          if fp.source.full_filename == fp.dest.full_filename
+            Messages.changed_tags(fp)
+          else
+            Messages.file_exists(fp)
+          end
+        else
+          Messages.renamed(fp)
+          Messages.changed_tags(fp, {}, false) if fp.source.class.has_writable_tags
+          cache << fp.dest.full_filename
+        end
+      end
+    end
+
+    def targets
+      raise MissingFiles if @files.empty?
+
+      Messages.label 'Targets:'
+      @files.each do |src|
+
+        fname = FilenameFactory.create(src, @cfg.global)
+
+        Messages.multi fname.full_filename
+        Messages.send(@cfg.global.targets == :short ? :short_targets : :long_targets, fname)
+      end
+    end
+
+    def macros
+      Messages.label 'Macros:'
+      Messages.list @cfg.macro.get_macros
+    end
+
+    def show_macro
+      Messages.label "Macro: #{@show_macro}"
+      macro = @cfg.macro.get_macro(@show_macro)
+      if macro.class == Array
+        macro.each do |k|
+          Messages.item k.keys.first.to_s + ': ' + k.values.first.map { |x| '"' + x.to_s.green + '"' }.join(',')
+        end
+      elsif macro.class == Hash
+        macro.each do |k, v|
+          Messages.item k.to_s + ': ' +  v.map { |x| '"' + x.to_s.green + '"'  }.join(', ')
+        end
+      end
+    end
+
+  end
+
+end

data/lib/filter_rename.yaml

@@ -0,0 +1,165 @@
+---
+:global:
+  :hash_type: :none
+  :date_format: '%Y-%m-%d'
+  :counter_length: 3
+  :counter_start: 0
+  :targets: :short
+  :pdf_metadata: false
+  :image_metadata: false
+:filter:
+  :lang: :en
+  :word_separator: " "
+  :target: :name
+  :ignore_case: true
+  :grep: '.*'
+  :grep_on: :source
+  :grep_exclude: false
+  # full_filename, :full_path, :filename, <target>
+  :grep_target: :full_filename
+:words:
+  :shortcut:
+    :short: ['Vol', 'Num']
+    :long: ['Volume', 'Number']
+  :general:
+    :en: ['Hello']
+    :it: ['Ciao']
+    :fr: ['Salut']
+    :es: ['Hola']
+    :pt: ['Olá']
+  :short_months:
+    :en: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+    :it: ['Gen', 'Feb', 'Mar', 'Apr', 'Mag', 'Giu', 'Lug', 'Ago', 'Set', 'Ott', 'Nov', 'Dic']
+    :fr: ['Janv', 'Févr', 'Mars', 'Avril', 'Mai', 'Juin', 'Juil', 'Août|Aout', 'Sept', 'Oct', 'Nov', 'Déc|Dec']
+    :es: ['Ene', 'Feb', 'Mar', 'Abr', 'May', 'Jun', 'Jul', 'Ago', 'Sep', 'Oct', 'Nov', 'Dic']
+    :pt: ['Jan', 'Fev', 'Mar', 'Abr', 'Mai', 'Jun', 'Jul', 'Ago', 'Set', 'Out', 'Nov', 'Dez']
+    :de: ['Jan', 'Feb', 'Mär|Mar', 'Apr', 'Mai', 'Jun', 'Jul', 'Aug', 'Sep', 'Okt', 'Nov', 'Dez']
+    :hr: ['Sij', 'Vel', 'Ožu|Ozu', 'Tra', 'Svi', 'Lip', 'Srp', 'Kol', 'Ruj', 'Lis', 'Stu', 'Pro']
+  :long_months:
+    :en: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']
+    :it: ['Gennaio', 'Febbraio', 'Marzo', 'Aprile', 'Maggio', 'Giugno', 'Luglio', 'Agosto', 'Settembre', 'Ottobre', 'Novembre', 'Dicembre']
+    :fr: ['Janvier', 'Février|Fevrier', 'Mars', 'Avril', 'Mai', 'Juin', 'Juillet', 'Août|Aout', 'Septembre', 'Octobre', 'Novembre', 'Décembre|Decembre']
+    :es: ['Enero', 'Febrero', 'Marzo', 'Abril', 'Mayo', 'Junio', 'Julio', 'Agosto', 'Septiembre', 'Octubre', 'Noviembre', 'Diciembre']
+    :pt: ['Janeiro', 'Fevereiro', 'Março', 'Abril', 'Maio', 'Junho', 'Julho', 'Agosto', 'Setembro', 'Outubro', 'Novembro', 'Dezembro']
+    :de: ['Januar[^y]', 'Februar[^y]', 'März|Marz', 'April', 'Mai', 'Juni', 'Juli', 'August', 'September', 'Oktober', 'November', 'Dezember']
+    :hr: ['Siječanj|Sijecanj', 'Veljača|Veljaca', 'Ožujak|Ozujak', 'Travanj', 'Svibanj', 'Lipanj', 'Srpanj', 'Kolovoz', 'Rujan', 'Listopad', 'Studeni', 'Prosinac']
+  :short_days:
+    :en: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
+    :it: ['Lun', 'Mar', 'Mer', 'Gio', 'Ven', 'Sab', 'Dom']
+    :fr: ['Lun', 'Mar', 'Mer', 'Jeu', 'Ven', 'Sam', 'Dim']
+    :es: ['Lun', 'Mar', 'Mié|Mie', 'Jue', 'Vie', 'Sáb|Sab', 'Dom']
+    :pt: ['Seg', 'Ter', 'Qua', 'Qui', 'Sex', 'Sáb|Sab', 'Dom']
+    :de: ['Mo', 'Di', 'Mi', 'Do', 'Fr', 'Sa', 'So']
+    :hr: ['Pon', 'Uto', 'Sri', 'čet|cet', 'Pet', 'Sub', 'Ned']
+  :long_days:
+    :en: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']
+    :it: ['Lunedì', 'Martedì', 'Mercoledì', 'Giovedì', 'Venerdì', 'Sabato', 'Domenica']
+    :fr: ['Lundi', 'Mardi', 'Mercredi', 'Jeudi', 'Vendredi', 'Samedi', 'Dimanche']
+    :es: ['Lunes', 'Martes', 'Miércoles|Miercoles', 'Jueves', 'Viernes', 'Sábado|Sabado', 'Domingo']
+    :pt: ['Segunda', 'Terça', 'Quarta', 'Quinta', 'Sexta', 'Sábado|Sabado', 'Domingo']
+    :de: ['Montag', 'Dienstag', 'Mittwoch', 'Donnerstag', 'Freitag', 'Samstag', 'Sonntag']
+    :hr: ['Ponedjeljak', 'Utorak', 'Srijeda', 'četvrtak|Cetvrtak', 'Petak', 'Subota', 'Nedjelja']
+
+:macro:
+  humanize:
+    -
+      :spacify:
+      - '_'
+      - "\\."
+    -
+      :squeeze:
+      - ' '
+    -
+      :translate_words:
+      - :long_months
+      - :it
+      - :en
+    -
+      :translate_words:
+      - :long_months
+      - :es
+      - :en
+    -
+      :translate_words:
+      - :long_months
+      - :fr
+      - :en
+    -
+      :translate_words:
+      - :long_months
+      - :de
+      - :en
+    -
+      :translate_words:
+      - :long_months
+      - :hr
+      - :en
+    -
+      :translate_words:
+      - :long_months
+      - :pt
+      - :en
+    -
+      :replace_date:
+      - '<B> <Y>'
+      - '<Y>-<m>'
+    -
+      :replace:
+      - ' ,[ ]*'
+      - ', '
+    -
+      :replace:
+      - '([a-z]) - ([0-9])'
+      - '\1 \2'
+  append_issue:
+    :move_to:
+    - '(Issue|Volume) ([0-9]+)'
+    - 'tmp'
+    :template:
+    - '<name> #<tmp>'
+    :delete:
+    - ' #$'
+    :squeeze:
+    - ' '
+  file_to_id3:
+    -
+      :copy_to:
+      - "([^-]+) -"
+      - "artist"
+    -
+      :copy_to:
+      - "- ([^-]+)"
+      - "title"
+  id3_to_file:
+    :template:
+    - "<artist> - <title>"
+  remove_id3_comments:
+    :select:
+    - "comments"
+    :set:
+    - ''
+  camels_to_words:
+    -
+      :config:
+      - ignore_case:false
+    -
+      :replace:
+      - "([A-Z])([a-z!']+)"
+      - " \\1\\2 "
+    -
+      :replace:
+      - '\( +'
+      - '('
+    -
+      :replace:
+      - ' +\)'
+      - ')'
+    -
+      :squeeze:
+      - " "
+    -
+      :trim: []
+  remove_dash_separator:
+    :replace:
+    - '([a-z]) - ([0-9])'
+    - '\1 \2'