taglib-ruby 1.0.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecceaec5949a978d7197944553e81b279f29eac9b3cb896285d31feaf8eb62c1
-  data.tar.gz: cd7c8acdfb435435b20af23c82490987b94f44ef45366902d0c2fd55f45c4f3d
+  metadata.gz: 1289419ad11f81f79052e260fbb9e1debbf2cd956389797bb6b664356e287ec0
+  data.tar.gz: '0582a88e09b6e96108a2e4a51a34e5c486f0552918780f38b1c4f05a448745d3'
 SHA512:
-  metadata.gz: 288cbdd0cba616f093e9a6332f85f61d6ae17b1026694d32813105a8c22c1b70c26fa224f669fb2bdab965212608e68e210474b2e8b9fab19aab82420f6e9a94
-  data.tar.gz: 927524f682dcda566219cb60895043d2c07c308122f162fbb6d140549e179ebaed08a3aa011f606f0a17bfa62ba4b4dcb47491de0efe3d3a4ab6122982c9d413
+  metadata.gz: 966e6e0fed73bb68ed20a6f4e9cab07b98f476220e5a294d77f679ea748ddb245e5221241845c7ad515337d1d3f673ebce6cb293cc97ca5e773a385e7e7110e3
+  data.tar.gz: 35ac3a6342f59be0c6641b861a0c9c9f2b00a2914d12fa8bc4bc05b5ba3af5c2f0199d8b3eb67155146b142274597ab8456ed1df48a72b30bbf90a1ebe86caf5

data/.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  NewCops: disable
+  Include:
+    - '**/*.rb'
+    - '**/*.arb'
+    - '**/*.gemfile'
+    - '**/*.gemspec'
+    - '**/*.rake'
+    - '**/.simplecov'
+    - '**/Gemfile'
+    - '**/Guardfile'
+    - '**/Rakefile'
+  Exclude:
+    - 'docs/**/*'
+    - 'tmp/**/*'
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/.yardopts

@@ -5,5 +5,5 @@
 docs/**/*.rb
 -
 README.md
-CHANGES.md
+CHANGELOG.md
 LICENSE.txt

data/CHANGELOG.md

@@ -6,6 +6,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 1.1.2 - 2022-04-13
+### Fixed
+- Fix UserTextIdentificationFrame's constructor so that overloaded
+  variants with StringList arguments can be called (#107)
+
+## 1.1.1 - 2022-04-12
+### Changed
+- Fixed build time warnings with Ruby >= 2.7.0 (#85)
+- Upgraded to SWIG 4.0.2
+- Fixed running tests against TagLib 1.12
+
+## 1.1.0 - 2021-01-20
+### Added
+- Added support for CTOC and CHAP frames for ID3v2
+
 ## 1.0.1 - 2020-03-25
 
 ### Fixed

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 source 'http://rubygems.org'
 
 # Use dependencies from .gemspec

data/Guardfile

@@ -1,8 +1,10 @@
+# frozen-string-literal: true
+
 # Guardfile for tests
 # More info at https://github.com/guard/guard#readme
 
 guard :test do
-  watch(%r{^lib/(.+)\.so$})     { "test" }
-  watch('test/test_helper.rb')  { "test" }
+  watch(%r{^lib/(.+)\.so$})     { 'test' }
+  watch('test/test_helper.rb')  { 'test' }
   watch(%r{^test/.+_test\.rb$})
 end

data/README.md

@@ -1,5 +1,4 @@
-taglib-ruby
-===========
+# taglib-ruby
 
 Ruby interface for the [TagLib C++ library][taglib], for reading and
 writing meta-data (tags) of many audio formats.
@@ -8,7 +7,7 @@ In contrast to other libraries, this one wraps the full C++ API, not
 only the minimal C API. This means that all tag data can be accessed,
 e.g. cover art of ID3v2 or custom fields of Ogg Vorbis comments.
 
-taglib-ruby currently supports the following:
+`taglib-ruby` currently supports the following:
 
 * Reading/writing common tag data of all formats that TagLib supports
 * Reading/writing ID3v1 and ID3v2 including ID3v2.4 and Unicode
@@ -19,13 +18,12 @@ taglib-ruby currently supports the following:
 Contributions for more coverage of the library are very welcome.
 
 [![Gem version][gem-img]][gem-link]
-[![Build status][travis-img]][travis-link]
+[![ci](https://github.com/robinst/taglib-ruby/workflows/ci/badge.svg)](https://github.com/robinst/taglib-ruby/actions?query=workflow%3Aci)
 
-Installation
-------------
+## Installation
 
-Before you install the gem, make sure to have [taglib 1.11.1 or higher][taglib] installed
-with header files (and a C++ compiler of course):
+Before you install the gem, make sure to have [taglib 1.11.1 or higher][taglib]
+installed with header files (and a C++ compiler of course):
 
 * Debian/Ubuntu: `sudo apt-get install libtag1-dev`
 * Fedora/RHEL: `sudo dnf install taglib-devel`
@@ -36,29 +34,41 @@ Then do:
 
     gem install taglib-ruby
 
-### OS X C++ compiler override
+### MacOS
 
-Not all versions of TagLib get along with `clang++`, the default C++ compiler
-on OS X. To compile taglib-ruby's C++ extensions with a different compiler
-during installation, set the `TAGLIB_RUBY_CXX` environment variable.
+Depending on your brew setup, TagLib might be installed in different locations,
+which makes it hard for taglib-ruby to find it. To get the library location, run:
+
+    $ brew info taglib
+    taglib: stable 1.12 (bottled), HEAD
+    Audio metadata library
+    https://taglib.org/
+    /usr/local/Cellar/taglib/1.12 (122 files, 1.5MB) *
+    ...
+
+Note the line with the path at the end. Provide that using the `TAGLIB_DIR`
+environment variable when installing, like this:
+
+    TAGLIB_DIR=/usr/local/Cellar/taglib/1.12 gem install taglib-ruby
+
+Another problem might be that `clang++` doesn't work with a specific version
+of TagLib. In that case, try compiling taglib-ruby's C++ extensions with a
+different compiler:
 
     TAGLIB_RUBY_CXX=g++-4.2 gem install taglib-ruby
 
-Usage
------
+## Usage
 
 Complete API documentation can be found on
 [rubydoc.info](http://rubydoc.info/gems/taglib-ruby/frames).
 
-Begin with the {TagLib} namespace.
+Begin with the `TagLib` namespace.
 
-Release Notes
--------------
+## Release Notes
 
-See {file:CHANGELOG.md}.
+See [CHANGELOG.md](CHANGELOG.md).
 
-Contributing
-------------
+## Contributing
 
 ### Dependencies
 
@@ -73,7 +83,8 @@ if you don't have it):
 
     bundle install
 
-Regenerate SWIG wrappers if you made changes in `.i` files (use version 3.0.7 of SWIG - 3.0.8 through 3.0.12 will not work):
+Regenerate SWIG wrappers if you made changes in `.i` files (use version 3.0.7 of
+SWIG - 3.0.8 through 3.0.12 will not work):
 
     rake swig
 
@@ -102,11 +113,17 @@ Build a specific version of Taglib:
 
     PLATFORM=x86_64-linux TAGLIB_VERSION=1.11.1 rake vendor
 
-The above command will automatically download Taglib 1.11.1, build it and install it in `tmp/x86_64-linux/taglib-1.11.1`.
+The above command will automatically download Taglib 1.11.1, build it and
+install it in `tmp/x86_64-linux/taglib-1.11.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.11.1` (it is assumed that taglib headers are located at `$TAGLIB_DIR/include` and taglib libraries at `$TAGLIB_DIR/lib`).
+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.11.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.11.1/lib` to the `LD_LIBRARY_PATH` environment variable.
+The `test` task can then be run for that version of Taglib by adding
+`$PWD/tmp/x86_64-linux/taglib-1.11.1/lib` to the `LD_LIBRARY_PATH` environment
+variable.
 
 To do everything in one command:
 
@@ -114,27 +131,30 @@ To do everything in one command:
 
 ### Workflow
 
-* Check out the latest master to make sure the feature hasn't been
-  implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't
-  requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it
+* Check out the latest `main` branch to make sure the feature hasn't been
+  implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone hasn't already
+  requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch from `main`.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so that I don't break it
   in a future version unintentionally.
+* Run `rubocop` locally to lint your changes and fix the issues. Please refer to
+  [.rubocop.yml](.rubocop.yml) for the list of relaxed rules. Try to keep the
+  liniting offenses to minimum. Preferably, first run `rubocop` on your fork to
+  have a general idea of the existing linting offenses before writing new code.
 * Please try not to mess with the Rakefile, version, or history. If you
   want to have your own version, or is otherwise necessary, that is
   fine, but please isolate to its own commit so I can cherry-pick around
   it.
 
-License
--------
+## License
 
 Copyright (c) 2010-2020 Robin Stocker and others, see Git history.
 
-taglib-ruby is distributed under the MIT License,
-see LICENSE.txt for details.
+`taglib-ruby` is distributed under the MIT License, see
+[LICENSE.txt](LICENSE.txt) for details.
 
 In the binary gem for Windows, a compiled [TagLib][taglib] is bundled as
 a DLL. TagLib is distributed under the GNU Lesser General Public License
@@ -143,5 +163,3 @@ version 2.1 (LGPL) and Mozilla Public License (MPL).
 [taglib]: http://taglib.github.io/
 [gem-img]: https://badge.fury.io/rb/taglib-ruby.svg
 [gem-link]: https://rubygems.org/gems/taglib-ruby
-[travis-img]: https://api.travis-ci.org/robinst/taglib-ruby.png
-[travis-link]: https://travis-ci.org/robinst/taglib-ruby

data/Rakefile

@@ -1,11 +1,11 @@
-# encoding: utf-8
+# frozen-string-literal: true
 
 require 'bundler/gem_tasks'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 
@@ -15,7 +15,7 @@ Rake::TestTask.new(:test) do |test|
   test.pattern = 'test/**/*_test.rb'
 end
 
-task :default => [:compile, :test]
+task default: %i[compile test]
 
 require 'yard'
 YARD::Rake::YardocTask.new do |t|
@@ -30,9 +30,9 @@ 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,
+# 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'
+# Swig a variable of the CI. The environment variable can be set to
+# prevent running swig.
+import 'tasks/swig.rake' unless ENV['SKIP_SWIG'] == 'true'

data/docs/taglib/aiff.rb

@@ -1,6 +1,5 @@
 # @since 0.7.0
 module TagLib::RIFF::AIFF
-
   # The file class for `.aiff` files.
   #
   # @example Reading the title
@@ -58,7 +57,6 @@ module TagLib::RIFF::AIFF
     # @since 1.0.0
     def id3v2_tag?
     end
-
   end
 
   class Properties < TagLib::AudioProperties
@@ -91,5 +89,4 @@ module TagLib::RIFF::AIFF
     def aiff_c?
     end
   end
-
 end

data/docs/taglib/base.rb

@@ -45,7 +45,6 @@
 #   tag.title
 #   # => "Title of the song"
 module TagLib
-
   # Major version of TagLib the extensions were compiled against
   # (major.minor.patch). Note that the value is not actually 0, but
   # depends on the version of the installed library.
@@ -88,7 +87,6 @@ module TagLib
   #   end
   #
   class FileRef
-
     # Creates a new file and passes it to the provided block,
     # closing the file automatically at the end of the block.
     #
@@ -165,7 +163,6 @@ module TagLib
 
   # @abstract Base class for files, see subclasses.
   class File
-
     # Save the file and the associated tags.
     #
     # See subclasses, as some provide more control over what is saved.
@@ -241,7 +238,6 @@ module TagLib
 
   # @abstract Base class for audio properties.
   class AudioProperties
-
     Fast = 0
     Average = 1
     Accurate = 2

data/docs/taglib/flac.rb

@@ -1,6 +1,5 @@
 # @since 0.5.0
 module TagLib::FLAC
-
   # The file class for `.flac` files.
   #
   # Note that Xiph comments is the primary tagging format for FLAC files. When
@@ -30,7 +29,6 @@ module TagLib::FLAC
   #     file.save
   #   end
   class File < TagLib::File
-
     NoTags      = 0x0000
     XiphComment = 0x0001
     ID3v1       = 0x0002
@@ -183,7 +181,7 @@ module TagLib::FLAC
     BandLogo           = 0x13
     PublisherLogo      = 0x14
 
-    def initialize()
+    def initialize
     end
 
     # Type of the picture, see constants.

data/docs/taglib/id3v2.rb

@@ -223,7 +223,7 @@ module TagLib::ID3v2
     BandLogo           = 0x13
     PublisherLogo      = 0x14
 
-    def initialize()
+    def initialize
     end
 
     # @return [String]

data/docs/taglib/mp4.rb

@@ -1,5 +1,4 @@
 module TagLib::MP4
-
   # The file class for '.m4a' files.
   #
   # @example Finding an MP4 item by field name
@@ -53,7 +52,6 @@ module TagLib::MP4
   #   #  ["©too",
   #   #   #<TagLib::MP4::Item:0x007f9bab61d818 @__swigtype__="_p_TagLib__MP4__Item">]]
   class File < TagLib::File
-
     # {include:::TagLib::FileRef.open}
     #
     # @param (see #initialize)
@@ -331,7 +329,7 @@ module TagLib::MP4
     def to_h
     end
   end
-  #
+
   class Properties < TagLib::AudioProperties
     Unknown = 0
     AAC     = 1
@@ -367,7 +365,7 @@ module TagLib::MP4
 
     # Returns the raw image data
     # @return [String]
-   attr_reader :data
+    attr_reader :data
 
     # @param [Fixnum] format
     # @param [String] data

data/docs/taglib/mpeg.rb

@@ -171,7 +171,6 @@ module TagLib::MPEG
 
   # Xing VBR header.
   class XingHeader
-
     Invalid = 0
     Xing    = 1
     VBRI    = 2

data/docs/taglib/ogg.rb

@@ -1,5 +1,4 @@
 module TagLib::Ogg
-
   # @abstract Base class for Ogg files, see subclasses.
   class File < TagLib::File
   end
@@ -11,7 +10,6 @@ module TagLib::Ogg
   # name and a value. Multiple fields with the same name are allowed, so
   # you can also view it as a map from names to a list of values.
   class XiphComment < TagLib::Tag
-
     # Add a name-value pair to the comment.
     #
     # @param [String] name field name
@@ -113,7 +111,5 @@ module TagLib::Ogg
 
     # @return [String] vendor ID of the encoder used
     attr_reader :vendor_id
-
   end
-
 end

data/docs/taglib/vorbis.rb

@@ -1,5 +1,4 @@
 module TagLib::Ogg::Vorbis
-
   # The file class for `.ogg` and other `.oga` files.
   #
   # @example Reading Vorbis comments

data/docs/taglib/wav.rb

@@ -1,6 +1,5 @@
 # @since 0.7.0
 module TagLib::RIFF::WAV
-
   FORMAT_UNKNOWN = 0x0000 # @since 1.0.0
   FORMAT_PCM     = 0x0001 # @since 1.0.0
 
@@ -27,7 +26,6 @@ module TagLib::RIFF::WAV
   # @see ID3v2::Tag ID3v2 examples.
   #
   class File < TagLib::File
-
     NoTags  = 0x0000
     ID3v1   = 0x0001
     ID3v2   = 0x0002
@@ -79,7 +77,6 @@ module TagLib::RIFF::WAV
     # @since 1.0.0
     def strip(tags=TagLib::RIFF::WAV::File::AllTags)
     end
-
   end
 
   class Properties < TagLib::AudioProperties
@@ -112,5 +109,4 @@ module TagLib::RIFF::WAV
     # @since 1.0.0
     attr_reader :format
   end
-
 end

data/ext/extconf_common.rb

@@ -1,54 +1,50 @@
-# Default opt dirs to help mkmf find taglib
+# frozen-string-literal: true
 
-opt_dirs = ["/usr/local", "/opt/local", "/sw"]
+# Default opt dirs to help mkmf find taglib
+opt_dirs = ['/usr/local', '/opt/local', '/sw']
 
 # Heroku vendor dir
-vendor = ENV.fetch('GEM_HOME', "")[/^[^ ]*\/vendor\//]
-if vendor
-  opt_dirs << (vendor + "taglib")
-end
-opt_dirs_joined = opt_dirs.join(":")
+vendor = ENV.fetch('GEM_HOME', '')[/^[^ ]*\/vendor\//]
+opt_dirs << "#{vendor}taglib" if vendor
+opt_dirs_joined = opt_dirs.join(':')
 
 configure_args = "--with-opt-dir=#{opt_dirs_joined} "
-ENV['CONFIGURE_ARGS'] = configure_args + ENV.fetch('CONFIGURE_ARGS', "")
-
+ENV['CONFIGURE_ARGS'] = configure_args + ENV.fetch('CONFIGURE_ARGS', '')
 
 require 'mkmf'
 
-def error msg
-  message msg + "\n"
+def error(msg)
+  message "#{msg}\n"
   abort
 end
 
-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."
+if ENV.key?('TAGLIB_DIR') && !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 finding taglib headers and libs. See MakeMakefile#dir_config
 # for more details.
-dir_config('tag', (ENV['TAGLIB_DIR'] if ENV.has_key?('TAGLIB_DIR')))
+dir_config('tag', (ENV['TAGLIB_DIR'] if ENV.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.
-unless $LDFLAGS.split(" ").include?("-static-libstdc++")
-  if not have_library('stdc++')
-    error "You must have libstdc++ installed."
-  end
+unless $LDFLAGS.split(' ').include?('-static-libstdc++')
+  error 'You must have libstdc++ installed.' unless have_library('stdc++')
 end
 
-if not have_library('tag')
-  error <<-DESC
-You must have taglib installed in order to use taglib-ruby.
+unless have_library('tag')
+  error <<~DESC
+    You must have taglib installed in order to use taglib-ruby.
 
-Debian/Ubuntu: sudo apt-get install libtag1-dev
-Fedora/RHEL: sudo dnf install taglib-devel
-Brew: brew install taglib
-MacPorts: sudo port install taglib
-DESC
+    Debian/Ubuntu: sudo apt-get install libtag1-dev
+    Fedora/RHEL: sudo dnf install taglib-devel
+    Brew: brew install taglib
+    MacPorts: sudo port install taglib
+  DESC
 end
 
-$CFLAGS << " -DSWIG_TYPE_TABLE=taglib"
+$CFLAGS << ' -DSWIG_TYPE_TABLE=taglib'
 
 # Allow users to override the Ruby runtime's preferred CXX
 RbConfig::MAKEFILE_CONFIG['CXX'] = ENV['TAGLIB_RUBY_CXX'] if ENV['TAGLIB_RUBY_CXX']

data/ext/taglib_aiff/extconf.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
 require 'extconf_common'