taglib-ruby 1.0.0 → 1.1.1

data/tasks/ext.rake

@@ -1,9 +1,10 @@
+# frozen-string-literal: true
+
 # Extension tasks and cross-compiling
 
 host = 'i686-w64-mingw32'
 $plat = ENV['PLATFORM'] || 'i386-mingw32'
 
-
 taglib_version = ENV['TAGLIB_VERSION'] || '1.9.1'
 taglib = "taglib-#{taglib_version}"
 
@@ -16,62 +17,62 @@ install_so = "#{install_dir}/lib/libtag.so"
 $cross_config_options = ["--with-opt-dir=#{install_dir}"]
 
 taglib_url = "https://github.com/taglib/taglib/archive/v#{taglib_version}.tar.gz"
-taglib_options = [ "-DCMAKE_BUILD_TYPE=Release",
-                   "-DBUILD_EXAMPLES=OFF",
-                   "-DBUILD_TESTS=OFF",
-                   "-DBUILD_BINDINGS=OFF", # 1.11 builds bindings by default
-                   "-DBUILD_SHARED_LIBS=ON", # 1.11 builds static by default
-                   "-DWITH_MP4=ON",# WITH_MP4, WITH_ASF only needed with taglib 1.7, will be default in 1.8
-                   "-DWITH_ASF=ON"].join(' ')
+taglib_options = ['-DCMAKE_BUILD_TYPE=Release',
+                  '-DBUILD_EXAMPLES=OFF',
+                  '-DBUILD_TESTS=OFF',
+                  '-DBUILD_BINDINGS=OFF', # 1.11 builds bindings by default
+                  '-DBUILD_SHARED_LIBS=ON', # 1.11 builds static by default
+                  '-DWITH_MP4=ON', # WITH_MP4, WITH_ASF only needed with taglib 1.7, will be default in 1.8
+                  '-DWITH_ASF=ON'].join(' ')
 
 def configure_cross_compile(ext)
   ext.cross_compile = true
   ext.cross_platform = $plat
   ext.cross_config_options.concat($cross_config_options)
   ext.cross_compiling do |gem|
-    gem.files << "lib/libtag.dll"
+    gem.files << 'lib/libtag.dll'
   end
 end
 
 require 'rake/extensiontask'
-Rake::ExtensionTask.new("taglib_base", $gemspec) do |ext|
+Rake::ExtensionTask.new('taglib_base', $gemspec) do |ext|
   configure_cross_compile(ext)
 end
-Rake::ExtensionTask.new("taglib_mpeg", $gemspec) do |ext|
+Rake::ExtensionTask.new('taglib_mpeg', $gemspec) do |ext|
   configure_cross_compile(ext)
 end
-Rake::ExtensionTask.new("taglib_id3v1", $gemspec) do |ext|
+Rake::ExtensionTask.new('taglib_id3v1', $gemspec) do |ext|
   configure_cross_compile(ext)
 end
-Rake::ExtensionTask.new("taglib_id3v2", $gemspec) do |ext|
+Rake::ExtensionTask.new('taglib_id3v2', $gemspec) do |ext|
   configure_cross_compile(ext)
 end
-Rake::ExtensionTask.new("taglib_ogg", $gemspec) do |ext|
+Rake::ExtensionTask.new('taglib_ogg', $gemspec) do |ext|
   configure_cross_compile(ext)
 end
-Rake::ExtensionTask.new("taglib_vorbis", $gemspec) do |ext|
+Rake::ExtensionTask.new('taglib_vorbis', $gemspec) do |ext|
   configure_cross_compile(ext)
 end
-Rake::ExtensionTask.new("taglib_flac_picture", $gemspec) do |ext|
+Rake::ExtensionTask.new('taglib_flac_picture', $gemspec) do |ext|
   configure_cross_compile(ext)
 end
-Rake::ExtensionTask.new("taglib_flac", $gemspec) do |ext|
+Rake::ExtensionTask.new('taglib_flac', $gemspec) do |ext|
   configure_cross_compile(ext)
 end
-Rake::ExtensionTask.new("taglib_mp4", $gemspec) do |ext|
+Rake::ExtensionTask.new('taglib_mp4', $gemspec) do |ext|
   configure_cross_compile(ext)
 end
-Rake::ExtensionTask.new("taglib_aiff", $gemspec) do |ext|
+Rake::ExtensionTask.new('taglib_aiff', $gemspec) do |ext|
   configure_cross_compile(ext)
 end
-Rake::ExtensionTask.new("taglib_wav", $gemspec) do |ext|
+Rake::ExtensionTask.new('taglib_wav', $gemspec) do |ext|
   configure_cross_compile(ext)
 end
 
 task :cross do
   # Mkmf just uses "g++" as C++ compiler, despite what's in rbconfig.rb.
   # So, we need to hack around it by setting CXX to the cross compiler.
-  ENV["CXX"] = "#{host}-g++"
+  ENV['CXX'] = "#{host}-g++"
 end
 
 file "#{tmp_arch}/stage/lib/libtag.dll" => [install_dll] do |f|
@@ -81,17 +82,17 @@ end
 file install_dll => ["#{tmp}/#{taglib}"] do
   chdir "#{tmp}/#{taglib}" do
     sh %(cmake -DCMAKE_INSTALL_PREFIX=#{install_dir} -DCMAKE_TOOLCHAIN_FILE=#{toolchain_file} #{taglib_options})
-    sh "make VERBOSE=1"
-    sh "make install"
+    sh 'make VERBOSE=1'
+    sh 'make install'
   end
 end
 
-task :vendor => [install_so]
+task vendor: [install_so]
 
 file install_so => ["#{tmp_arch}/#{taglib}", "#{tmp_arch}/#{taglib}-build", "#{tmp}/#{taglib}"] do
   chdir "#{tmp_arch}/#{taglib}-build" do
     sh %(cmake -DCMAKE_INSTALL_PREFIX=#{install_dir} #{taglib_options} #{tmp}/#{taglib})
-    sh "make install VERBOSE=1"
+    sh 'make install VERBOSE=1'
   end
 end
 

data/tasks/gemspec_check.rake

@@ -1,6 +1,8 @@
-desc "Checks file list in .gemspec against files tracked in Git"
-task :gemspec_check do |t|
-  exclude = ['.gitignore', '.travis.yml']
+# frozen-string-literal: true
+
+desc 'Checks file list in .gemspec against files tracked in Git'
+task :gemspec_check do |_t|
+  exclude = ['.gitignore', '.github/workflows/ci.yml']
   git_files = `git ls-files`.split("\n") - exclude
   gemspec_files = $gemspec.files
 
@@ -8,12 +10,12 @@ task :gemspec_check do |t|
   only_in_git = git_files - gemspec_files
 
   unless only_in_gemspec.empty?
-    puts "In gemspec but not in git:"
+    puts 'In gemspec but not in git:'
     puts only_in_gemspec
   end
 
   unless only_in_git.empty?
-    puts "In git but not in gemspec:"
+    puts 'In git but not in gemspec:'
     puts only_in_git
   end
 end

data/tasks/swig.rake

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 # Tasks for generating SWIG wrappers in ext
 
 # Execute SWIG for the specified extension.
@@ -8,26 +10,24 @@
 # $TAGLIB_DIR/include will be searched first for taglib headers.
 def run_swig(mod)
   swig = `which swig`.chomp
-  if swig.empty?
-    swig = `which swig2.0`.chomp
-  end
+  swig = `which swig2.0`.chomp if swig.empty?
 
-  # Standard search location for headers
-  include_args = %w{-I/usr/local/include -I/usr/include}
+  # Standard search location for headers
+  include_args = %w[-I/usr/local/include -I/usr/include]
 
-  if ENV.has_key?('TAGLIB_DIR')
+  if ENV.key?('TAGLIB_DIR')
     unless File.directory?(ENV['TAGLIB_DIR'])
-      abort "When defined, the TAGLIB_DIR environment variable must point to a valid directory."
+      abort 'When defined, the TAGLIB_DIR environment variable must point to a valid directory.'
     end
 
     # Push it in front to get it searched first.
-    include_args.unshift('-I' + ENV['TAGLIB_DIR'] + '/include')
+    include_args.unshift("-I#{ENV['TAGLIB_DIR']}/include")
   end
 
   sh "cd ext/#{mod} && #{swig} -c++ -ruby -autorename -initname #{mod} #{include_args.join(' ')} #{mod}.i"
 end
 
-task :swig =>
+task swig:
   ['ext/taglib_base/taglib_base_wrap.cxx',
    'ext/taglib_mpeg/taglib_mpeg_wrap.cxx',
    'ext/taglib_id3v1/taglib_id3v1_wrap.cxx',
@@ -38,8 +38,7 @@ task :swig =>
    'ext/taglib_flac/taglib_flac_wrap.cxx',
    'ext/taglib_mp4/taglib_mp4_wrap.cxx',
    'ext/taglib_aiff/taglib_aiff_wrap.cxx',
-   'ext/taglib_wav/taglib_wav_wrap.cxx',
-  ]
+   'ext/taglib_wav/taglib_wav_wrap.cxx']
 
 base_dependencies = ['ext/taglib_base/taglib_base.i', 'ext/taglib_base/includes.i']
 

data/test/aiff_examples_test.rb

@@ -1,14 +1,12 @@
+# frozen-string-literal: true
+
 require File.join(File.dirname(__FILE__), 'helper')
 
 class AIFFExamples < Test::Unit::TestCase
+  DATA_FILE_PREFIX = 'test/data/aiff-'
 
-  DATA_FILE_PREFIX = "test/data/aiff-"
-
-  context "TagLib::RIFF::AIFF::File" do
-
-    should "Run TagLib::RIFF::AIFF::File examples" do
-
-
+  context 'TagLib::RIFF::AIFF::File' do
+    should 'Run TagLib::RIFF::AIFF::File examples' do
       # @example Reading the title
       title = TagLib::RIFF::AIFF::File.open("#{DATA_FILE_PREFIX}sample.aiff") do |file|
         file.tag.title
@@ -16,7 +14,7 @@ class AIFFExamples < Test::Unit::TestCase
 
       # @example Reading AIFF-specific audio properties
       TagLib::RIFF::AIFF::File.open("#{DATA_FILE_PREFIX}sample.aiff") do |file|
-        file.audio_properties.bits_per_sample  #=>  16
+        file.audio_properties.bits_per_sample # => 16
       end
 
       # @example Saving ID3v2 cover-art to disk
@@ -24,16 +22,13 @@ class AIFFExamples < Test::Unit::TestCase
         id3v2_tag = file.tag
         cover = id3v2_tag.frame_list('APIC').first
         ext = cover.mime_type.rpartition('/')[2]
-        File.open("#{DATA_FILE_PREFIX}cover-art.#{ext}", "wb") { |f| f.write cover.picture }
+        File.open("#{DATA_FILE_PREFIX}cover-art.#{ext}", 'wb') { |f| f.write cover.picture }
       end
 
-
       # checks
-      assert_equal "AIFF Dummy Track Title - ID3v2.4", title
+      assert_equal 'AIFF Dummy Track Title - ID3v2.4', title
       assert_equal true, File.exist?("#{DATA_FILE_PREFIX}cover-art.jpeg")
       FileUtils.rm("#{DATA_FILE_PREFIX}cover-art.jpeg")
     end
-
   end
-
 end

data/test/aiff_file_test.rb

@@ -1,70 +1,71 @@
+# frozen-string-literal: true
+
 require File.join(File.dirname(__FILE__), 'helper')
 
 class AIFFFileTest < Test::Unit::TestCase
+  SAMPLE_FILE = 'test/data/aiff-sample.aiff'
+  PICTURE_FILE = 'test/data/globe_east_540.jpg'
 
-  SAMPLE_FILE = "test/data/aiff-sample.aiff"
-  PICTURE_FILE = "test/data/globe_east_540.jpg"
-
-  context "TagLib::RIFF::AIFF::File" do
+  context 'TagLib::RIFF::AIFF::File' do
     setup do
       @file = TagLib::RIFF::AIFF::File.new(SAMPLE_FILE)
       @tag = @file.tag
-      File.open(PICTURE_FILE, "rb") do |f|
+      File.open(PICTURE_FILE, 'rb') do |f|
         @picture_data = f.read
       end
     end
 
-    should "have an ID3v2 tag" do
+    should 'have an ID3v2 tag' do
       assert @file.id3v2_tag?
       refute_nil @tag
       assert_equal TagLib::ID3v2::Tag, @tag.class
     end
 
-    should "contain basic tag information" do
-      assert_equal "AIFF Dummy Track Title - ID3v2.4", @tag.title
-      assert_equal "AIFF Dummy Artist Name", @tag.artist
-      assert_equal "AIFF Dummy Album Title", @tag.album
-      assert_equal "AIFF Dummy Comment", @tag.comment
-      assert_equal "Jazz", @tag.genre
+    should 'contain basic tag information' do
+      assert_equal 'AIFF Dummy Track Title - ID3v2.4', @tag.title
+      assert_equal 'AIFF Dummy Artist Name', @tag.artist
+      assert_equal 'AIFF Dummy Album Title', @tag.album
+      assert_equal 'AIFF Dummy Comment', @tag.comment
+      assert_equal 'Jazz', @tag.genre
       assert_equal 2014, @tag.year
       assert_equal 3, @tag.track
       assert_equal false, @tag.empty?
     end
 
-    context "APIC frame" do
+    context 'APIC frame' do
       setup do
         @apic = @tag.frame_list('APIC').first
       end
 
-      should "exist" do
+      should 'exist' do
         assert_not_nil @apic
         assert_equal TagLib::ID3v2::AttachedPictureFrame, @apic.class
       end
 
-      should "have a type" do
+      should 'have a type' do
         assert_equal TagLib::ID3v2::AttachedPictureFrame::FrontCover, @apic.type
       end
 
-      should "have a mime type" do
-        assert_equal "image/jpeg", @apic.mime_type
+      should 'have a mime type' do
+        assert_equal 'image/jpeg', @apic.mime_type
       end
 
-      should "have picture bytes" do
+      should 'have picture bytes' do
         assert_equal 61649, @apic.picture.size
         assert_equal @picture_data, @apic.picture
       end
     end
 
-    context "audio properties" do
+    context 'audio properties' do
       setup do
         @properties = @file.audio_properties
       end
 
-      should "exist" do
+      should 'exist' do
         assert_not_nil @properties
       end
 
-      should "contain basic information" do
+      should 'contain basic information' do
         assert_equal 2, @properties.length_in_seconds
         assert_equal 2937, @properties.length_in_milliseconds
         assert_equal 256, @properties.bitrate
@@ -72,15 +73,15 @@ class AIFFFileTest < Test::Unit::TestCase
         assert_equal 2, @properties.channels
       end
 
-      should "contain AIFF-specific information" do
+      should 'contain AIFF-specific information' do
         assert_equal 16, @properties.bits_per_sample
         assert_equal 23493, @properties.sample_frames
       end
 
-      should "do not contain AIFF-C information" do
+      should 'do not contain AIFF-C information' do
         refute @properties.aiff_c?
-        assert_equal "", @properties.compression_type
-        assert_equal "", @properties.compression_name
+        assert_equal '', @properties.compression_type
+        assert_equal '', @properties.compression_name
       end
     end
 
@@ -90,14 +91,13 @@ class AIFFFileTest < Test::Unit::TestCase
     end
   end
 
-  context "TagLib::RIFF::AIFF::File.open" do
-    should "have open method" do
+  context 'TagLib::RIFF::AIFF::File.open' do
+    should 'have open method' do
       title = nil
       TagLib::RIFF::AIFF::File.open(SAMPLE_FILE, false) do |file|
         title = file.tag.title
       end
-      assert_equal "AIFF Dummy Track Title - ID3v2.4", title
+      assert_equal 'AIFF Dummy Track Title - ID3v2.4', title
     end
   end
-
 end

data/test/aiff_file_write_test.rb

@@ -1,27 +1,26 @@
+# frozen-string-literal: true
+
 require File.join(File.dirname(__FILE__), 'helper')
 
 class AIFFFileWriteTest < Test::Unit::TestCase
+  SAMPLE_FILE = 'test/data/aiff-sample.aiff'
+  OUTPUT_FILE = 'test/data/_output.aiff'
+  PICTURE_FILE = 'test/data/globe_east_90.jpg'
 
-  SAMPLE_FILE = "test/data/aiff-sample.aiff"
-  OUTPUT_FILE = "test/data/_output.aiff"
-  PICTURE_FILE = "test/data/globe_east_90.jpg"
-
-  def reloaded
-    TagLib::RIFF::AIFF::File.open(OUTPUT_FILE, false) do |file|
-      yield file
-    end
+  def reloaded(&block)
+    TagLib::RIFF::AIFF::File.open(OUTPUT_FILE, false, &block)
   end
 
-  context "TagLib::RIFF::AIFF::File" do
+  context 'TagLib::RIFF::AIFF::File' do
     setup do
       FileUtils.cp SAMPLE_FILE, OUTPUT_FILE
       @file = TagLib::RIFF::AIFF::File.new(OUTPUT_FILE, false)
     end
 
-    should "be able to save the title" do
+    should 'be able to save the title' do
       tag = @file.tag
       assert_not_nil tag
-      tag.title = "New Title"
+      tag.title = 'New Title'
       success = @file.save
       assert success
       @file.close
@@ -30,14 +29,14 @@ class AIFFFileWriteTest < Test::Unit::TestCase
       written_title = reloaded do |file|
         file.tag.title
       end
-      assert_equal "New Title", written_title
+      assert_equal 'New Title', written_title
     end
 
-    should "have one picture frame" do
+    should 'have one picture frame' do
       assert_equal 1, @file.tag.frame_list('APIC').size
     end
 
-    should "be able to remove all picture frames" do
+    should 'be able to remove all picture frames' do
       @file.tag.remove_frames('APIC')
       success = @file.save
       assert success
@@ -49,12 +48,12 @@ class AIFFFileWriteTest < Test::Unit::TestCase
       end
     end
 
-    should "be able to add a picture frame" do
+    should 'be able to add a picture frame' do
       picture_data = File.open(PICTURE_FILE, 'rb') { |f| f.read }
 
       apic = TagLib::ID3v2::AttachedPictureFrame.new
-      apic.mime_type = "image/jpeg"
-      apic.description = "desc"
+      apic.mime_type = 'image/jpeg'
+      apic.description = 'desc'
       apic.text_encoding = TagLib::String::UTF8
       apic.picture = picture_data
       apic.type = TagLib::ID3v2::AttachedPictureFrame::BackCover
@@ -70,9 +69,9 @@ class AIFFFileWriteTest < Test::Unit::TestCase
       end
 
       reloaded do |file|
-        written_apic = file.tag.frame_list("APIC")[1]
-        assert_equal "image/jpeg", written_apic.mime_type
-        assert_equal "desc", written_apic.description
+        written_apic = file.tag.frame_list('APIC')[1]
+        assert_equal 'image/jpeg', written_apic.mime_type
+        assert_equal 'desc', written_apic.description
         assert_equal picture_data, written_apic.picture
       end
     end

data/test/base_test.rb

@@ -1,8 +1,10 @@
+# frozen-string-literal: true
+
 require File.join(File.dirname(__FILE__), 'helper')
 
 class BaseTest < Test::Unit::TestCase
-  context "TagLib" do
-    should "contain version constants" do
+  context 'TagLib' do
+    should 'contain version constants' do
       assert TagLib::TAGLIB_MAJOR_VERSION.is_a? Integer
       assert TagLib::TAGLIB_MINOR_VERSION.is_a? Integer
       assert TagLib::TAGLIB_PATCH_VERSION.is_a? Integer

data/test/data/add-relative-volume.cpp

@@ -1,5 +1,5 @@
 #include <iostream>
-#include <stdlib.h>
+#include <cstdlib>
 
 #include <taglib/taglib.h>
 #include <taglib/mpegfile.h>
@@ -10,8 +10,8 @@ using namespace TagLib;
 
 int main(int argc, char **argv) {
   if (argc != 2) {
-    std::cout << "usage: " << argv[0] << " file.mp3" << std::endl;
-    exit(1);
+    std::cerr << "usage: " << argv[0] << " file.mp3" << std::endl;
+    return EXIT_FAILURE;
   }
   char *filename = argv[1];
 
@@ -35,6 +35,10 @@ int main(int argc, char **argv) {
 
   tag->addFrame(rv);
   file.save();
+
+  delete rv;
+
+  return EXIT_SUCCESS;
 }
 
 // vim: set filetype=cpp sw=2 ts=2 expandtab:

data/test/data/flac-create.cpp

@@ -1,5 +1,5 @@
 #include <iostream>
-#include <stdlib.h>
+#include <cstdlib>
 
 #include <taglib/taglib.h>
 #include <taglib/flacfile.h>
@@ -11,9 +11,10 @@ using namespace TagLib;
 
 int main(int argc, char **argv) {
   if (argc != 2) {
-    std::cout << "usage: " << argv[0] << " file" << std::endl;
-    exit(1);
+    std::cerr << "usage: " << argv[0] << " file" << std::endl;
+    return EXIT_FAILURE;
   }
+
   char *filename = argv[1];
 
   FLAC::File file(filename);
@@ -49,12 +50,21 @@ int main(int argc, char **argv) {
   picture->setColorDepth(8);
   picture->setNumColors(0);
 
-  ByteVector data = getPictureData("globe_east_90.jpg");
+  const ByteVector data = getPictureData("globe_east_90.jpg");
+  if (data.isEmpty()) {
+    std::cerr << "failed to get picture data" << std::endl;
+    delete picture;
+    return EXIT_FAILURE;
+  }
+
   picture->setData(data);
 
   file.addPicture(picture);
-
   file.save();
+
+  delete picture;
+
+  return EXIT_SUCCESS;
 }
 
 // vim: set filetype=cpp sw=2 ts=2 expandtab:

data/test/data/get_picture_data.cpp

@@ -5,9 +5,13 @@ using namespace TagLib;
 ByteVector getPictureData(const char *filename) {
   std::ifstream is;
   is.open(filename, std::ios::binary);
+  if (!is.is_open()) {
+    std::cerr << "failed to open file: " << filename << std::endl;
+    return ByteVector();
+  }
 
   is.seekg(0, std::ios::end);
-  int length = is.tellg();
+  const int length = is.tellg();
   is.seekg(0, std::ios::beg);
 
   char *buffer = new char[length];

data/test/data/id3v1-create.cpp

@@ -1,5 +1,5 @@
 #include <iostream>
-#include <stdlib.h>
+#include <cstdlib>
 
 #include <taglib/taglib.h>
 #include <taglib/mpegfile.h>
@@ -9,9 +9,10 @@ using namespace TagLib;
 
 int main(int argc, char **argv) {
   if (argc != 2) {
-    std::cout << "usage: " << argv[0] << " file.mp3" << std::endl;
-    exit(1);
+    std::cerr << "usage: " << argv[0] << " file.mp3" << std::endl;
+    return EXIT_FAILURE;
   }
+
   char *filename = argv[1];
 
   MPEG::File file(filename);
@@ -26,6 +27,8 @@ int main(int argc, char **argv) {
   tag->setTrack(7);
 
   file.save(MPEG::File::ID3v1);
+
+  return EXIT_SUCCESS;
 }
 
 // vim: set filetype=cpp sw=2 ts=2 expandtab:

data/test/data/mp4-create.cpp

@@ -1,5 +1,5 @@
 #include <iostream>
-#include <stdlib.h>
+#include <cstdlib>
 
 #include <taglib/taglib.h>
 #include <taglib/mp4file.h>
@@ -10,9 +10,10 @@ using namespace TagLib;
 
 int main(int argc, char **argv) {
   if (argc != 2) {
-    std::cout << "usage: " << argv[0] << " file.m4a" << std::endl;
-    exit(1);
+    std::cerr << "usage: " << argv[0] << " file.m4a" << std::endl;
+    return EXIT_FAILURE;
   }
+
   char *filename = argv[1];
 
   MP4::File file(filename);
@@ -26,13 +27,20 @@ int main(int argc, char **argv) {
   tag->setYear(2011);
   tag->setTrack(7);
 
-  ByteVector data = getPictureData("globe_east_90.jpg");
+  const ByteVector data = getPictureData("globe_east_90.jpg");
+  if (data.isEmpty()) {
+    std::cerr << "failed to get picture data" << std::endl;
+    return EXIT_FAILURE;
+  }
+
   MP4::CoverArt cover_art = MP4::CoverArt(MP4::CoverArt::JPEG, data);
   MP4::CoverArtList cover_art_list = MP4::CoverArtList();
   cover_art_list.append(cover_art);
   tag->itemListMap().insert("covr", MP4::Item(cover_art_list));
 
   file.save();
+
+  return EXIT_SUCCESS;
 }
 
 // vim: set filetype=cpp sw=2 ts=2 expandtab: