taffy 1.3.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 58282fce937d3bff94a00d40c3d8798b0211415f
-  data.tar.gz: 585d5092e405198779f2ae3876ee93ce6a0e1d54
+SHA256:
+  metadata.gz: 7b1c511bd3c2b69dc0a43e2f9ede16732f6712bce3f1cdee40240e2147622189
+  data.tar.gz: 78562d02d2ace2e15661d50547cbfb661b5f584257c57650f96f2aabb32c7669
 SHA512:
-  metadata.gz: f14622caae83525e8e890932dd1ce446b4530cf03a1d6ae8b4aede000a8368508ef6dcde6e4abbf433fbc5e58c757c25948b7361b0e175f3da6858b9988b7c72
-  data.tar.gz: 135bb7b972ad6f1516d2ecc2a41be27dba2aaaefd9504b532d0e09fc377aa546b91c61dc6ad8ea708898ce56c793e0453eac72887f986e1b495ff18bd33d3002
+  metadata.gz: b227a31fd3b62c419f7501c423057a876ee5d33b17477ea720ab8971effe6dc3491b37eb9bf997af9b1336c754eca157709cb5e580fc2c999e58194b40ae1f2a
+  data.tar.gz: 4705920bb9fdeb000f43abb4641ce00772172dc4c18cc36df6bcc1eebf8077340816dd5f6d4f91f732813388a5498de3971596eced429b86bf77321f926e6bb8

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, 0]
+VERSION = [1, 4, 2]
 
 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,13 +157,25 @@ 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
-      match.size == 3 ? sub.shellescape.gsub(/\\./, $1) : sub
+      strip_special_chars(sub, $1 || '', special_chars)
     end
   end
 
   spec
 end
 
+def safe_save(filename, fileref)
+  lowername = filename.downcase
+
+  if lowername.end_with?('.ogg') or lowername.end_with?('.oga')
+    warn("Not saving Ogg Vorbis file: #{filename} - see " +
+      "https://github.com/robinst/taglib-ruby/issues/82")
+    return false
+  else
+    return fileref.save
+  end
+end
+
 ARGV.each do |filename|
   TagLib::FileRef.open(filename) do |fileref|
     if fileref.null?
@@ -156,20 +186,19 @@ ARGV.each do |filename|
 
     if extract_spec
       extract(fileref.tag, extract_spec, filename)
-      fileref.save
+      $status = 2 if not safe_save(filename, fileref)
     end
 
     if actions.empty? and !(extract_spec or rename_spec)
       print_info(filename, fileref.tag)
     elsif !actions.empty?
       actions.each { |action| action.call(fileref.tag) }
-      fileref.save
+      $status = 2 if not safe_save(filename, fileref)
     end
 
     if rename_spec
-      name = rename(fileref.tag, rename_spec) + File.extname(filename)
-      name.gsub!('/', '-') # problematic on unix
-      name.gsub!(':', '')  # problematic on windows
+      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,17 +1,17 @@
 Gem::Specification.new do |s|
   s.name        = 'taffy'
-  s.version     = '1.3.0'
-  s.date        = '2017-07-07'
+  s.version     = '1.4.2'
+  s.date        = '2020-03-17'
   s.summary     = 'A command-line audio tagging tool'
   s.description = "A command-line tool for reading and writing audio \
                    metadata.".squeeze(' ')
   s.authors     = ['Brandon Mulcahy']
-  s.email       = 'brandon@jangler.info'
+  s.email       = 'brandon@lightcones.net'
   s.files       = `git ls-files`.split
-  s.homepage    = 'https://jangler.info/code/taffy'
+  s.homepage    = 'https://github.com/jangler/taffy'
   s.license     = 'MIT'
 
   s.executables << 'taffy'
-  s.add_runtime_dependency 'taglib-ruby', '~> 0.7', '>= 0.7.0'
+  s.add_runtime_dependency 'taglib-ruby', '~> 1.1', '>= 1.1.0'
   s.required_ruby_version = '>= 2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taffy
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Brandon Mulcahy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-07-07 00:00:00.000000000 Z
+date: 2020-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: taglib-ruby
@@ -16,36 +16,37 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 1.1.0
 description: A command-line tool for reading and writing audio metadata.
-email: brandon@jangler.info
+email: brandon@lightcones.net
 executables:
 - taffy
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - LICENSE
 - README.md
 - bin/taffy
 - taffy.gemspec
-homepage: https://jangler.info/code/taffy
+homepage: https://github.com/jangler/taffy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -60,9 +61,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
 summary: A command-line audio tagging tool
 test_files: []