Merge pull request #79 from Sigill/travis-update

Update Rake tasks to easily run the CI against various versions of taglib

Author: robinst

.travis.yml

@@ -1,11 +1,18 @@
 language: ruby
-rvm:
-  - 1.8.7
-  - 2.0.0
-  - 2.1.1
-  - 2.3.0
-addons:
-  apt:
-    packages:
-    - libtag1-dev
-    - swig
+env:
+  global:
+    - PLATFORM=x86_64-linux-gnu
+    - MAKEFLAGS="-j2"
+matrix:
+  include:
+    - rvm: 2.2.7
+      env: TAGLIB_VERSION=1.7.2 TAGLIB_DIR=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.7.2 LD_LIBRARY_PATH=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.7.2/lib:$LD_LIBRARY_PATH
+    - rvm: 2.2.7
+      env: TAGLIB_VERSION=1.8 TAGLIB_DIR=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.8 LD_LIBRARY_PATH=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.8/lib:$LD_LIBRARY_PATH
+    - rvm: 2.3.4
+      env: TAGLIB_VERSION=1.9.1 TAGLIB_DIR=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.9.1 LD_LIBRARY_PATH=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.9.1/lib:$LD_LIBRARY_PATH
+    - rvm: 2.4.1
+      env: TAGLIB_VERSION=1.10 TAGLIB_DIR=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.10 LD_LIBRARY_PATH=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.10/lib:$LD_LIBRARY_PATH
+    - rvm: 2.4.1
+      env: TAGLIB_VERSION=1.11.1 TAGLIB_DIR=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.11.1 LD_LIBRARY_PATH=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.11.1/lib:$LD_LIBRARY_PATH
+before_script: bundle exec rake vendor

README.md

@@ -95,6 +95,20 @@ Build and install gem into system gems:
 
     rake install
 
+Build a specific version of Taglib:
+
+    PLATFORM=x86_64-linux TAGLIB_VERSION=1.9.1 rake vendor
+
+The above command will automatically download Taglig 1.9.1, build it and install it in `tmp/x86_64-linux/taglib-1.9.1`.
+
+The `swig` and `compile` tasks can then be executed against that specific version of Taglib by setting the `TAGLIB_DIR` environment variable to `$PWD/tmp/x86_64-linux/taglib-1.9.1` (it is assumed that taglib headers are located at `$TAGLIB_DIR/include` and taglib libraries at `$TAGLIB_DIR/lib`).
+
+The `test` task can then be run for that version of Taglib by adding `$PWD/tmp/x86_64-linux/taglib-1.9.1/lib` to the `LD_LIBRARY_PATH` environment variable.
+
+To do everything in one command:
+
+    PLATFORM=x86_64-linux TAGLIB_VERSION=1.7.2 TAGLIB_DIR=$PWD/tmp/x86_64-linux/taglib-1.7.2 LD_LIBRARY_PATH=$PWD/tmp/x86_64-linux/taglib-1.7.2/lib rake vendor compile test
+
 ### Workflow
 
 * Check out the latest master to make sure the feature hasn't been

Rakefile

@@ -25,4 +25,14 @@ end
 
 $gemspec = Bundler::GemHelper.gemspec
 
-FileList['tasks/**/*.rake'].each { |task| import task }
+import 'tasks/docs_coverage.rake'
+import 'tasks/ext.rake'
+import 'tasks/gemspec_check.rake'
+
+# When importing swig.rake, the *_wrap.cxx files depend on being generated
+# by Swig. Since the ExtensionTasks depend on the *_wrap.cxx files,
+# compiling the extensions will trigger Swig, which is not desired as
+# those files have already been generated and there's no reason to make
+# Swig a variable of the CI. To prevent those dependencies, do not import
+# swig.rake when running in Travis.
+import 'tasks/swig.rake' unless ENV['TRAVIS'] == 'true'

ext/extconf_common.rb

@@ -20,7 +20,14 @@ def error msg
   abort
 end
 
-dir_config('tag')
+if ENV.has_key?('TAGLIB_DIR') and !File.directory?(ENV['TAGLIB_DIR'])
+  error "When defined, the TAGLIB_DIR environment variable must point to a valid directory."
+end
+
+# If specified, use the TAGLIB_DIR environment variable as the prefix
+# for finding taglib headers and libs. See MakeMakefile#dir_config
+# for more details.
+dir_config('tag', (ENV['TAGLIB_DIR'] if ENV.has_key?('TAGLIB_DIR')))
 
 # When compiling statically, -lstdc++ would make the resulting .so to
 # have a dependency on an external libstdc++ instead of the static one.

ext/taglib_base/taglib_base.i

@@ -32,11 +32,12 @@ namespace TagLib {
 
 // Rename setters to Ruby convention (combining SWIG rename functions
 // does not seem to be possible, thus resort to some magic)
-%rename("%(command: ruby -e 'print(ARGV[0][3..-1].split(/(?=[A-Z])/).join(\"_\").downcase + \"=\")' )s",
+// setFoo -> foo=
+%rename("%(command: perl -e \"print lc(join('_', split(/(?=[A-Z])/, substr(@ARGV[0], 3)))), '='\" )s",
         regexmatch$name="^set[A-Z]") "";
 
 // isFoo -> foo?
-%rename("%(command: ruby -e 'print(ARGV[0][2..-1].split(/(?=[A-Z])/).join(\"_\").downcase + \"?\")' )s",
+%rename("%(command: perl -e \"print lc(join('_', split(/(?=[A-Z])/, substr(@ARGV[0], 2)))), '?'\" )s",
         regexmatch$name="^is[A-Z]") "";
 
 // ByteVector

tasks/ext.rake

@@ -1,19 +1,28 @@
 # Extension tasks and cross-compiling
 
 host = 'i686-w64-mingw32'
-$plat = 'i386-mingw32'
+$plat = ENV['PLATFORM'] || 'i386-mingw32'
 
-tmp = "#{Dir.pwd}/tmp/#{$plat}"
+
+taglib_version = ENV['TAGLIB_VERSION'] || '1.9.1'
+taglib = "taglib-#{taglib_version}"
+
+tmp = "#{Dir.pwd}/tmp"
+tmp_arch = "#{tmp}/#{$plat}"
 toolchain_file = "#{Dir.pwd}/ext/win.cmake"
-install_dir = "#{tmp}/install"
+install_dir = "#{tmp_arch}/#{taglib}"
 install_dll = "#{install_dir}/bin/libtag.dll"
+install_so = "#{install_dir}/lib/libtag.so"
 $cross_config_options = ["--with-opt-dir=#{install_dir}"]
 
-taglib_version = '1.9.1'
-taglib = "taglib-#{taglib_version}"
-taglib_url = "https://github.com/taglib/taglib/releases/download/v#{taglib_version}/#{taglib}.tar.gz"
-# WITH_MP4, WITH_ASF only needed with taglib 1.7, will be default in 1.8
-taglib_options = "-DCMAKE_BUILD_TYPE=Release -DWITH_MP4=ON -DWITH_ASF=ON"
+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(' ')
 
 def configure_cross_compile(ext)
   ext.cross_compile = true
@@ -62,7 +71,7 @@ task :cross do
   ENV["CXX"] = "#{host}-g++"
 end
 
-file "tmp/#{$plat}/stage/lib/libtag.dll" => [install_dll] do |f|
+file "#{tmp_arch}/stage/lib/libtag.dll" => [install_dll] do |f|
   install install_dll, f
 end
 
@@ -74,6 +83,18 @@ file install_dll => ["#{tmp}/#{taglib}"] do
   end
 end
 
+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"
+  end
+end
+
+directory "#{tmp_arch}/#{taglib}"
+directory "#{tmp_arch}/#{taglib}-build"
+
 file "#{tmp}/#{taglib}" => ["#{tmp}/#{taglib}.tar.gz"] do
   chdir tmp do
     sh "tar xzf #{taglib}.tar.gz"
@@ -83,12 +104,9 @@ end
 file "#{tmp}/#{taglib}.tar.gz" => [tmp] do |t|
   require 'open-uri'
   puts "Downloading #{taglib_url}"
-  data = open(taglib_url).read()
-  break if data == nil
-  chdir tmp do
-    open(File.basename(t.name), 'wb') do |f|
-      f.write(data)
-    end
+
+  File.open(t.name, 'wb') do |f|
+    IO.copy_stream(open(taglib_url), f)
   end
 end
 

tasks/swig.rake

@@ -1,11 +1,30 @@
 # Tasks for generating SWIG wrappers in ext
 
+# Execute SWIG for the specified extension.
+# Arguments:
+# mod:: The name of the SWIG wrapper to process.
+#
+# If the TAGLIB_DIR environment variable points to a directory,
+# $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
-  sh "cd ext/#{mod} && #{swig} -c++ -ruby -autorename -initname #{mod} -I/usr/local/include -I/usr/include #{mod}.i"
+
+  # Standard search location for headers
+  include_args = %w{-I/usr/local/include -I/usr/include}
+
+  if ENV.has_key?('TAGLIB_DIR')
+    unless File.directory?(ENV['TAGLIB_DIR'])
+      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')
+  end
+
+  sh "cd ext/#{mod} && #{swig} -c++ -ruby -autorename -initname #{mod} #{include_args.join(' ')} #{mod}.i"
 end
 
 task :swig =>

test/flac_file_test.rb

@@ -37,7 +37,14 @@ class FlacFileTest < Test::Unit::TestCase
 
       should "contain basic information" do
         assert_equal 1, @properties.length
-        assert_equal 212, @properties.bitrate
+
+        # taglib/taglib#557 changed the way bitrate is calculated.
+        if TagLib::TAGLIB_MAJOR_VERSION > 1 || (TagLib::TAGLIB_MAJOR_VERSION == 1 && TagLib::TAGLIB_MINOR_VERSION >= 10)
+          assert_equal 209, @properties.bitrate
+        else
+          assert_equal 212, @properties.bitrate
+        end
+
         assert_equal 44100, @properties.sample_rate
         assert_equal 1, @properties.channels
       end

test/id3v2_tag_test.rb

@@ -44,11 +44,20 @@ class TestID3v2Tag < Test::Unit::TestCase
     end
 
     should "have nil for string attributes" do
-      assert_nil @tag.title
-      assert_nil @tag.artist
-      assert_nil @tag.album
-      assert_nil @tag.comment
-      assert_nil @tag.genre
+      # taglib/taglib/8c6fe45: return an empty string instead of NULL
+      if TagLib::TAGLIB_MAJOR_VERSION > 1 || (TagLib::TAGLIB_MAJOR_VERSION == 1 && TagLib::TAGLIB_MINOR_VERSION >= 11)
+        assert_equal "", @tag.title
+        assert_equal "", @tag.artist
+        assert_equal "", @tag.album
+        assert_equal "", @tag.comment
+        assert_equal "", @tag.genre
+      else
+        assert_nil @tag.title
+        assert_nil @tag.artist
+        assert_nil @tag.album
+        assert_nil @tag.comment
+        assert_nil @tag.genre
+      end
     end
 
     should "have 0 for numeric attributes" do

test/mp4_file_test.rb

@@ -29,7 +29,14 @@ class MP4FileTest < Test::Unit::TestCase
 
       should "contain basic information" do
         assert_equal 1, @properties.length
-        assert_equal 54, @properties.bitrate
+
+        # taglib/taglib#558 changed the way bitrate is calculated.
+        if TagLib::TAGLIB_MAJOR_VERSION > 1 || (TagLib::TAGLIB_MAJOR_VERSION == 1 && TagLib::TAGLIB_MINOR_VERSION >= 10)
+          assert_equal 55, @properties.bitrate
+        else
+          assert_equal 54, @properties.bitrate
+        end
+
         assert_equal 44100, @properties.sample_rate
         # The test file is mono, this appears to be a TagLib bug
         assert_equal 2, @properties.channels