filter_rename 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0772829a453b3d53a307e213ea42d969c6f5f6598a47ca8c19236b2eae7d46fb'
-  data.tar.gz: ac03f34f6eca2f5650bc283f7c139e4f8032cf87a25134b810eda5716a9577de
+  metadata.gz: 7b45ed1cf9b2044a3613d698125dc699c005154bc3c859623be546f748efebdf
+  data.tar.gz: 7b2407fbe28d667e3d298f9b90a11b12704bd30a2152c062484ba267f9fcd2a9
 SHA512:
-  metadata.gz: 4a33e3231cdc186f63cacb21ef752ca78b136a76f64c138ec02cf58470d2ebb02afc35dc5e0a22dbce2a712a93e184faf1a962cce66ab2ef948771fe2f546789
-  data.tar.gz: d08e371afb6cea91b7cef9a228b8e8f4f49bcf3c618b6d1ae0b32664539b744d41a9f02d97fc5537bcc60fa00348f3da54cb10679ba23571beda6c1cf18a5293
+  metadata.gz: 8054cf53f69b2c0aa28fa41d8b9343c6caee5b2ea14b3c829bd09ea2348b0c86e33022eedc7a788ca5b1dc406692a9590bcf810b183cfcf33ed9fd5cfa464658
+  data.tar.gz: 00334ee6bff0e4436e3922340bae92d02df5af45d3b176d2769725ca0063ebc8cfb3ceaae5c35d7707db77e017c9e0e4de6e87e2c026a36331356c2ca94f14e1

data/.github/FUNDING.yml

@@ -1,14 +1,16 @@
+---
 # These are supported funding model platforms
 
 github: [fabiomux]
 #patreon: # Replace with a single Patreon username
 #open_collective: # Replace with a single Open Collective username
-#ko_fi: # Replace with a single Ko-fi username
+ko_fi: freeaptitude
 #tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 #community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
 #liberapay: # Replace with a single Liberapay username
 #issuehunt: # Replace with a single IssueHunt username
 #otechie: # Replace with a single Otechie username
 #custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
-custom: ['https://www.buymeacoffee.com/DCkNYFg']
-
+custom: 
+- 'https://paypal.me/fabiomux'
+- 'https://www.buymeacoffee.com/DCkNYFg'

data/.github/workflows/gem-push.yml

@@ -0,0 +1,46 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches:
+    - master
+    tags:
+    - 'v*'
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.6
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6.10
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    # - name: Publish to RubyGems
+    #  run: |
+    #    mkdir -p $HOME/.gem
+    #    touch $HOME/.gem/credentials
+    #    chmod 0600 $HOME/.gem/credentials
+    #    printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+    #    gem build *.gemspec
+    #    gem push *.gem
+    #  env:
+    #    GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/main.yml

@@ -0,0 +1,32 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '2.7.8'
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install exiv2
+      run: sudo apt-get install -y libexiv2-dev
+    - name: Install taglib
+      run: sudo apt-get install -y libtag1-dev
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Run the default task
+      run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,84 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/ClassVars:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Naming/FileName:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Lint/DuplicateBranch:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: true
+  Exclude:
+  - './lib/**/cli.rb'
+  - './lib/**/config.rb'
+  - './lib/**/filename.rb'
+  - './lib/**/filter_rename.rb'
+  - './lib/**/utils.rb'
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+  - '*.gemspec'
+  - './lib/**/cli.rb'
+  - './spec/**/*'
+
+Metrics/PerceivedComplexity:
+  Enabled: true
+  Exclude:
+  - './lib/**/filter_rename.rb'
+  - './lib/**/cli.rb'
+  - './lib/**/config.rb'
+  - './lib/**/filename_factory.rb'
+  - './lib/**/filter_base.rb'
+  - './lib/**/utils.rb'
+  - './lib/**/audio_filename.rb'
+
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Exclude:
+  - './lib/**/filter_rename.rb'
+  - './lib/**/cli.rb'
+  - './lib/**/config.rb'
+  - './lib/**/filename_factory.rb'
+  - './lib/**/filter_base.rb'
+  - './lib/**/utils.rb'
+  - './lib/**/audio_filename.rb'
+
+Style/MixinUsage:
+  Enabled: true
+  Exclude:
+  - './spec/**/*'
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  Exclude:
+  - './bin/*'
+  - './exe/*'
+
+Style/Documentation:
+  Enabled: true
+  Exclude:
+  - './lib/**/filters.rb'

data/Gemfile

@@ -1,4 +1,18 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in filter_rename.gemspec
 gemspec
+
+gem "bundler", "~> 2.0"
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "rubocop-rake", "~> 0.7.0"
+
+gem "rubocop-rspec", "~> 3.0"

data/README.md

@@ -1,82 +1,126 @@
 # 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.
+FilterRename is a CLI tool created for bulk file renaming that work appending a set of micro
+operations here called *filters*, which aim to replace most, if not all, the shell commands
+usually involved in that kind of operations (*sed*, *awk*, *trim*, ...) in a more safe and
+comfortable manner.
+
+[![Ruby](https://github.com/fabiomux/filter_rename/actions/workflows/main.yml/badge.svg)][wf_main]
+[![Gem Version](https://badge.fury.io/rb/filter_rename.svg)][gem_version]
+
+## Installation
+
+### Requirements
+
+These two libraries must be installed:
+- **exiv2**
+- **taglib**
+
+With *openSUSE*:
+```shell
+$ sudo zypper install libexiv2-devel libtag-devel
+```
+
+With *Debian*/*Ubuntu*:
+```shell
+$ sudo apt-get install libexiv2-dev libtag1-dev
+```
+
+### Rubygem
+
+Install it as a regular Ruby gem with:
+```shell
+$ gem install filter_rename
+```
+
+## Usage
 
 To simplify the whole process through a command line, the full filename is logically organized
-in _targets_ like:
+in *targets*:
 
     <path>/<folder>/<name><ext>
 
-Considering the file `/home/fabio/Documents/Ruby/filter_rename/Gemfile.lock` we have:
+For example, 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
+The chain of *filters* will be applied to the current *target*, which is *name* by default, but can
+be changed using the *--select* option on the same command line without running the command twice.
 
-## Usage
+For example, to capitalize the *ext* and upper case the *name* at the same time we can use:
+```shell
+filter_rename Gemfile.lock --uppercase --select ext --capitalize
+```
 
-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.
+So the file *Gemfile.lock* becomes *GEMFILE.Lock*.
 
-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.
+To make things easier we can use a special class of *filters* that target a string as a list of *words*
+or *numbers* with their position used as index.
 
-Having the files:
+For example, having the files:
 
     home
       fabio
         Documents
           Photos
             Vacations
-              image_portofino_1.jpg
-              image_portofino_2.jpg
-              image_portofino_3.jpg
+              image_from_portofino_0.jpg
+              image_from_portofino_1.jpg
+              image_from_portofino_2.jpg
               ...
 
-to replace _underscores_ with _spaces_ and _capitalize_ each word let's execute:
+We want:
+- space-separated words in place of the underscore;
+- the first and third word capitalized;
+- the final number must start from 1;
+- the final number must be 2 digits wide.
 
-    filter_rename /home/fabio/Documents/Photos/Vacations/*.jpg --spacify '_' --capitalize --apply
+Using:
+```shell
+$ filter_rename /home/fabio/Documents/Photos/Vacations/*.jpg \
+                --spacify '_' \
+                --capitalize-word 1:3 \
+                --add-number 1,1 \
+                --format-number 1,2
+```
 
-and the result will be:
+The result is:
 
     home
       fabio
         Documents
           Photos
             Vacations
-              Image Portofino 1.jpg
-              Image Portofino 2.jpg
-              Image Portofino 3.jpg
+              Image from Portofino 01.jpg
+              Image from Portofino 02.jpg
+              Image from Portofino 03.jpg
               ...
 
+If you are wondering why all the commands above didn't affected the files physically on the disk,
+then must be aware of the three main operations contemplated:
+- *diff*: shows the results verbosly without making any change (default);
+- *dry-run*: executes a simulation warning also for renaming conflicts;
+- *apply*: confirm the changes and rename the files unless the destination file exists.
+
+Last but not least filter_rename also supports *macros* and *regular expressions*, and the ability to
+setup configurations params on the fly (*config* and *global*).
 
 ## Get help
 
 Where to start
+```shell
+$ filter_rename --help
+```
 
-    $ filter_rename --help
-
-More help
-
-- The wiki page: https://github.com/fabiomux/filter_rename/wiki
-
+## More help
 
-## Contributing
+More info is available at:
+- the [FilterRename GitHub wiki][filter_rename_wiki].
 
-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.
 
+[filter_rename_wiki]: https://github.com/fabiomux/filter_rename/wiki "FilterRename wiki page on GitHub"
+[wf_main]: https://github.com/fabiomux/filter_rename/actions/workflows/main.yml
+[gem_version]: https://badge.fury.io/rb/filter_rename

data/Rakefile

@@ -1,6 +1,12 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/filter_rename

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

data/filter_rename.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'filter_rename/version'
+# frozen_string_literal: true
+
+require_relative "lib/filter_rename/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "filter_rename"
@@ -9,36 +8,35 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Fabio Mucciante"]
   spec.email         = ["fabio.mucciante@gmail.com"]
 
-  spec.summary       = %q{File renaming tool which make use of a chain of actions called filters.}
-  spec.description   = %q{FilterRename is a bulk renaming tool, based on the concept of filters as small operations to perform over sections of the full filename logically represented in targets.}
+  spec.summary       = "File renaming tool which make use of a chain of actions called filters."
+  spec.description   = "FilterRename is a bulk renaming tool, based on the concept of filters as small operations " \
+                       "to perform over sections of the full filename logically represented in targets."
   spec.homepage      = "https://github.com/fabiomux/filter_rename"
   spec.license       = "GPL-3.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
-  spec.metadata      = {
-    "bug_tracker_uri"   => "https://github.com/fabiomux/filter_rename/issues",
-    "changelog_uri"     => "https://freeaptitude.altervista.org/projects/filter-rename.htm#changelog",
-    "documentation_uri" => "https://www.rubydoc.info/gems/filter_rename/#{spec.version}",
-    "homepage_uri"      => "https://freeaptitude.altervista.org/projects/filter-rename.html",
-    #"mailing_list_uri"  => "",
-    "source_code_uri"   => "https://github.com/fabiomux/filter_rename",
-    "wiki_uri"          => "https://github.com/fabiomux/filter_rename/wiki"
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/fabiomux/filter_rename/issues",
+    "homepage_uri" => "https://freeaptitude.altervista.org/projects/filter-rename.html",
+    "source_code_uri" => "https://github.com/fabiomux/filter_rename",
+    "changelog_uri" => "https://freeaptitude.altervista.org/projects/filter-rename.html#changelog",
+    "wiki_uri" => "https://github.com/fabiomux/filter_rename/wiki",
+    "rubygems_mfa_required" => "true"
   }
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  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"
+  spec.add_dependency "differ"
+  spec.add_dependency "exiv2"
+  spec.add_dependency "fastimage"
+  spec.add_dependency "keisan"
+  spec.add_dependency "mimemagic"
+  spec.add_dependency "mp3info"
+  spec.add_dependency "pdf-reader"
+  spec.add_dependency "taglib-ruby" #, "~> 1.0"
 end