taffy 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7d644a16238a79b0c5af671a80d85b762743ed26237ee6f10de84e3143f335c
-  data.tar.gz: '08127e50105fcb07976bf45f4372348285d91d85811ed03b7cf3e04fb6a50f10'
+  metadata.gz: 94c59b3b99ae79f14bb9562aa46f0a47521e4c63e8d6c399131d9e915705aa4c
+  data.tar.gz: d34948bbe7c36a177eff310b65aca989c4f5e7432fcbe5c860173a8a4b226d06
 SHA512:
-  metadata.gz: 954d73838f92851014724273e9a56fa643b0152ddc5b0aa8c95f99e6e6ec1cc9ba7db21a531a0e4761e10721a338be2e5ceffa0b51b84dccb46a8191da59918f
-  data.tar.gz: a527a5f2a2017dc996d7e60c07b5d09164c635f61a53df5c280a7d67fa94730e3fda8c78e7684c3fe66086915911622945f14e7bd0fac67bf6ae86ff63fd61e1
+  metadata.gz: 57200fdecd3b1fa98036c0ed20646e4ec9127faff5483bd4e68e984c78de1ba1cb0e852167ead1dc53532b6a670cc54c0121e8d4bbaae3bf69d5bec9139e168b
+  data.tar.gz: ecac7926ac03bfd179b7a243836dea1eab14cd2860c2ed5132509fd826bc38beb5e1c3d422fe032306a6f1aaa67448c83fbc83892084de9b8b0066ef6e1ba1aa

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Brandon Mulcahy
+Copyright (c) 2015-2018 Brandon Mulcahy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -40,6 +40,7 @@ Usage
 	Filename options:
 	        --extract SPEC               Extract tags from filename
 	        --rename SPEC                Rename file based on tags
+	        --rename-fs SPEC             Like --rename; see below
 	
 	If no options are given, file tags are printed instead.
 	
@@ -48,6 +49,9 @@ Usage
 	filename, %R leaves letter case intact, while %r downcases
 	the tag. A sequence such as %_t maps special characters in
 	the tag to the given substitute, in this case an underscore.
+	--rename remaps all characters that need to be escaped in
+	the shell, while --rename-fs remaps only characters that
+	are invalid in filenames.
 	
 	Other options:
 	    -h, --help                       Show this message and exit
@@ -65,7 +69,7 @@ Tag a series of files with an artist, album, and year:
 
 Tag an audio file, then rename it to "14 - Queen of the Mole People.mp3":
 
-	taffy -n 14 -t "Queen of the Mole People" --rename "%n - %T" song.mp3
+	taffy -n 14 -t "Queen of the Mole People" --rename-fs "%n - %T" song.mp3
 
 Etymology
 ---------

data/bin/taffy

@@ -5,7 +5,7 @@ require 'shellwords'
 
 require 'taglib'
 
-VERSION = [1, 3, 2]
+VERSION = [1, 4, 0]
 
 FIELDS = [
   ['l', 'album',   String],
@@ -17,8 +17,11 @@ FIELDS = [
   ['y', 'year',    Integer],
 ]
 
+RENAME_CHARS = /[ `~!#$%^&*()=[{}\\|;:",<>\/?]|\\]/
+RENAME_FS_CHARS = /[<>:"\/\\|?*]/
+
 actions = []
-extract_spec = rename_spec = nil
+extract_spec = rename_spec = special_chars = nil
 $status = 0
 
 options = OptionParser.new do |opts|
@@ -60,6 +63,11 @@ options = OptionParser.new do |opts|
   end
   opts.on("--rename SPEC", String, "Rename file based on tags") do |spec|
     rename_spec = spec
+    special_chars = RENAME_CHARS
+  end
+  opts.on("--rename-fs SPEC", String, "Like --rename; see below") do |spec|
+    rename_spec = spec
+    special_chars = RENAME_FS_CHARS
   end
 
   opts.separator ""
@@ -70,6 +78,9 @@ options = OptionParser.new do |opts|
   opts.separator "filename, %R leaves letter case intact, while %r downcases"
   opts.separator "the tag. A sequence such as %_t maps special characters in"
   opts.separator "the tag to the given substitute, in this case an underscore."
+  opts.separator "--rename remaps all characters that need to be escaped in"
+  opts.separator "the shell, while --rename-fs remaps only characters that"
+  opts.separator "are invalid in filenames."
   opts.separator ""
   opts.separator "Other options:"
 
@@ -131,7 +142,14 @@ def extract(tag, spec, filename)
   end
 end
 
-def rename(tag, spec)
+def strip_special_chars(str, subchar, special_chars)
+  # removing single quotes is usually better than remapping them
+  str.delete(special_chars == RENAME_CHARS ? "'" : '')
+    .gsub(special_chars, subchar).gsub(/(#{subchar})+/, subchar)
+    .gsub(/(^#{subchar}|#{subchar}$)/, '') || '_'
+end
+
+def rename(tag, spec, special_chars)
   spec = spec.dup
 
   FIELDS.each do |f|
@@ -139,8 +157,7 @@ def rename(tag, spec)
     tag_string = tag_string.rjust(2, '0') if f[1] == 'track'
     spec.gsub!(/%(\W|_)?(#{f[0]}|#{f[0].upcase})/) do |match|
       sub = $2 == f[0] ? tag_string.downcase : tag_string
-      sub = sub.shellescape.gsub(/(\\.)|[\/:]/, $1 || '')
-      sub == '' ? '_' : sub
+      strip_special_chars(sub, $1 || '', special_chars)
     end
   end
 
@@ -180,7 +197,8 @@ ARGV.each do |filename|
     end
 
     if rename_spec
-      name = rename(fileref.tag, rename_spec) + File.extname(filename)
+      name = rename(fileref.tag, rename_spec, special_chars) +
+        File.extname(filename)
       path = File.join(File.dirname(filename), name)
       if File.exist?(path)
         warn("Cannot rename; file exists: #{name}")

data/taffy.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'taffy'
-  s.version     = '1.3.2'
-  s.date        = '2018-04-02'
+  s.version     = '1.4.0'
+  s.date        = '2018-05-20'
   s.summary     = 'A command-line audio tagging tool'
   s.description = "A command-line tool for reading and writing audio \
                    metadata.".squeeze(' ')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taffy
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Brandon Mulcahy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-02 00:00:00.000000000 Z
+date: 2018-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: taglib-ruby
@@ -37,6 +37,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - LICENSE
 - README.md
 - bin/taffy