discid 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da3abc81eca7a228d26984a9db667b91477ea068
-  data.tar.gz: d7fd697e3d2b833734417240b9be5919159338e3
+  metadata.gz: 04925bc0ab19f720f642b3cdc2421138d26d2b5a
+  data.tar.gz: 57815371438236e32ec759332070e307893edef1
 SHA512:
-  metadata.gz: 22ae22372a5d41b633eef98a56609f5dd8f5152e140c922fef1b606ce62a4ae57acec27005f317ef633f3879455f0df0ba76df24cf885dd9a8b77f40885e1af5
-  data.tar.gz: a9761bc666fa56fb5e16112911e3536d702cf69722037b155390217e9e180950754bd2f922568c752c81bf0a7ee93507eb0a1e20bb7a649a7441bed3c975b29f
+  metadata.gz: 1e479cecb1a34c9002397a1c959b547942156d32592822ea1e0312a63efec7c8f5470af20b7eb51a06132887d6f2e905ad6df1bd8c47b15299d7777eaed776c8
+  data.tar.gz: 2dd736a7d7c23cd01076d0703270982d10aa0268f11234b95376294a4b5e5b38f1ad7a54496d7571a422e0de94967eb48c2ee84427e5538eb0f3f3a884062617

data/.yardopts

@@ -0,0 +1 @@
+--no-private --markup markdown --markup-provider redcarpet - CHANGES.md examples/*.rb

data/CHANGES.md

@@ -1,10 +1,17 @@
 # Changelog
 
+## 1.3.0 (2016-02-19)
+* Add support for {DiscId::Disc#toc_string}. Will use the implementation from
+  libdiscid 0.6 or a fallback for older versions.
+* Removed support for Ruby 1.8
+* codeclimate-test-reporter is not required anymore for running the tests
+* Updated documentation
+
 ## 1.2.0 (2016-02-12)
-* `DiscId.sectors_to_seconds`: Truncate instead of round resulting float
+* {DiscId.sectors_to_seconds}: Truncate instead of round resulting float
 
 ## 1.1.2 (2016-02-11)
-* Fixed first and last track being swapped in example readdiscid.rb
+* Fixed first and last track being swapped in {file:examples/readdiscid.rby example readdiscid.rb}
 * Restricted dependencies for Ruby 1.8 to maintain compatibility
 * Test against Ruby 2.3
 
@@ -12,7 +19,7 @@
 * Fixed gem file permissions
 
 ## 1.1.0 (2015-08-26)
-* Fixed Disc#put handling of first_track being > 1
+* Fixed {DiscId.put} handling of first_track being > 1
 
 ## 1.0.0 (2013-05-01)
 * Final API and documentation cleanup.

data/README.md

@@ -5,12 +5,17 @@
 [![Gem Version](https://badge.fury.io/rb/discid.svg)](http://badge.fury.io/rb/discid)
 
 ## About
-ruby-discid provides Ruby bindings for the MusicBrainz DiscID library libdiscid.
+ruby-discid provides Ruby bindings for the MusicBrainz DiscID library [libdiscid](http://musicbrainz.org/doc/libdiscid).
 It allows calculating DiscIDs (MusicBrainz and freedb) for Audio CDs. Additionally
 the library can extract the MCN/UPC/EAN and the ISRCs from disc.
 
+ruby-discid supports all features from libdiscid 0.6, but will also work with
+any earlier version. If a feature is unsupported in the libdiscid version used
+ruby-discid will just return a default value. The version required for a feature
+is documented in the [API documentation](http://www.rubydoc.info/github/phw/ruby-discid/master).
+
 ## Requirements
-* Ruby >= 1.8.7
+* Ruby >= 1.9.0
 * RubyGems >= 1.3.6
 * Ruby-FFI >= 1.6.0
 * libdiscid >= 0.1.0
@@ -18,54 +23,83 @@ the library can extract the MCN/UPC/EAN and the ISRCs from disc.
 ## Installation
 Before installing ruby-discid make sure you have libdiscid installed. See
 http://musicbrainz.org/doc/libdiscid for more information on how to do this.
+For Windows see also the notes below.
 
+### Installing with RubyGems
 Installing ruby-discid is best done using RubyGems:
 
     gem install discid
 
+### Installing from package repository
+For some Linux distributions packages are available:
+
+* [Arch Linux AUR package](https://aur.archlinux.org/packages/ruby-discid/)
+* [Ubuntu PPA](https://launchpad.net/~musicbrainz-developers/+archive/ubuntu/stable)
+
+### Install from source
 You can also install from source. This requires RubyGems and Bundler installed.
 First make sure you have installed bundler:
 
     gem install bundler
 
 Then inside the ruby-discid source directory run:
-    
+
     bundle install
     rake install
 
-`bundle install` will install additional development dependencies (Rake, Yard
-and Kramdown). `rake install` will build the discid gem and install it.
- 
+`bundle install` will install additional development dependencies (Rake,
+Yard etc.). `rake install` will build the discid gem and install it.
+
+### Windows installation notes
+On Windows you will need `discid.dll` available in a place where Windows can
+find it, see [Search Path Used by Windows to Locate a DLL](https://msdn.microsoft.com/en-us/library/7d83bc18.aspx).
+You can install the `discid.dll` system wide, but it is recommended to place
+it in the local working directory of your application.
+
+Also the architecture (32 or 64 bit) of the DLL must match your Ruby version.
+As the official build of libdiscid contains only a 32 bit version of `discid.dll`
+it is recommended to use the 32 bit version of Ruby.
+
+If you want or need to use 64 bit Ruby you will have to compile libdiscid
+yourself. Refer to the [libdiscid install instructions](https://github.com/metabrainz/libdiscid/blob/master/INSTALL)
+for further details.
+
 ## Usage
 
 ### Read only the TOC
 
-    require 'discid'
+```ruby
+require 'discid'
 
-    device = "/dev/cdrom"
-    disc = DiscId.read(device)
-    puts disc.id
+# Specifying the device is optional. If omitted a platform
+# specific default will be used.
+device = "/dev/cdrom"
+disc = DiscId.read(device)
+puts disc.id
+```
 
 ### Read the TOC, MCN and ISRCs
 
-    require 'discid'
-    
-    device = "/dev/cdrom"
-    disc = DiscId.read(device, :mcn, :isrc)
-    
-    # Print information about the disc:
-    puts "DiscID      : #{disc.id}"
-    puts "FreeDB ID   : #{disc.freedb_id}"
-    puts "Total length: #{disc.seconds} seconds"
-    puts "MCN         : #{disc.mcn}"
-
-    # Print information about individual tracks:
-    disc.tracks do |track|
-      puts "Track ##{track.number}"
-      puts "  Length: %02d:%02d (%i sectors)" %
-          [track.seconds / 60, track.seconds % 60, track.sectors]
-      puts "  ISRC  : %s" % track.isrc
-    end
+```ruby
+require 'discid'
+
+device = "/dev/cdrom"
+disc = DiscId.read(device, :mcn, :isrc)
+
+# Print information about the disc:
+puts "DiscID      : #{disc.id}"
+puts "FreeDB ID   : #{disc.freedb_id}"
+puts "Total length: #{disc.seconds} seconds"
+puts "MCN         : #{disc.mcn}"
+
+# Print information about individual tracks:
+disc.tracks do |track|
+  puts "Track ##{track.number}"
+  puts "  Length: %02d:%02d (%i sectors)" %
+      [track.seconds / 60, track.seconds % 60, track.sectors]
+  puts "  ISRC  : %s" % track.isrc
+end
+```
 
 See the [API documentation](http://www.rubydoc.info/github/phw/ruby-discid/master)
 of {DiscId} or the files in the `examples` directory for more usage information.
@@ -78,5 +112,16 @@ Please report any issues on the
 [issue tracker](https://github.com/phw/ruby-discid/issues).
 
 ## License
-ruby-discid is released under the GNU Lesser General Public License Version 3.
+ruby-discid Copyright (c) 2007-2016 by Philipp Wolfer <ph.wolfer@gmail.com>
+
+ruby-discid is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
 See LICENSE for details.

data/examples/readdiscid.rb

@@ -37,6 +37,7 @@ print <<EOF
 Device      : #{disc.device}
 DiscID      : #{disc.id}
 FreeDB ID   : #{disc.freedb_id}
+TOC string  : #{disc.toc_string}
 First track : #{disc.first_track_number}
 Last track  : #{disc.last_track_number}
 Total length: #{disc.seconds} seconds

data/lib/discid/disc.rb

@@ -130,6 +130,36 @@ module DiscId
       return Lib.get_mcn @handle if @read
     end
 
+    # Return a string representing CD Table Of Contents (TOC).
+    #
+    # The TOC suitable as value of the toc parameter when accessing the
+    # MusicBrainz Web Service. This enables fuzzy searching when the actual
+    # DiscID is not found.
+    #
+    # Note that this is the unencoded value, which still contains spaces.
+    #
+    # @since 1.3
+    #
+    # @raise [RuntimeError] get_toc_string is unsupported by libdiscid and
+    #                       could not get extracted from {Disc#submission_url}
+    # @return [String] The TOC string or `nil` if no ID was yet read.
+    def toc_string
+      return nil if not @read
+      result = Lib.get_toc_string
+      if not result
+        # probably an old version of libdiscid (< 0.6.0)
+        # gather toc string from submission_url
+        match = /toc=([0-9+]+)/.match self.submission_url
+        if match
+          result = match[1].gsub("+", " ")
+        else
+          raise "can't get toc string from submission url"
+        end
+      end
+
+      return result
+    end
+
     # An URL for submitting the DiscID to MusicBrainz.
     #
     # The URL leads to an interactive disc submission wizard that guides the

data/lib/discid/lib.rb

@@ -62,6 +62,14 @@ module DiscId
 
     attach_function :get_track_length, :discid_get_track_length, [:pointer, :int], :int
 
+    begin
+      attach_function :get_toc_string, :discid_get_toc_string, [:pointer], :string
+    rescue FFI::NotFoundError
+      def self.get_toc_string
+        return nil
+      end
+    end
+
     begin
       attach_function :get_mcn, :discid_get_mcn, [:pointer], :string
     rescue FFI::NotFoundError

data/lib/discid/version.rb

@@ -16,5 +16,5 @@
 
 module DiscId
   # The version of ruby-discid.
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/test/helper.rb

@@ -13,11 +13,12 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-# The code coverage is only supported for Ruby >= 1.9
-if (RUBY_VERSION.split('.').map{|s|s.to_i} <=> [1, 9, 0]) >= 0
+begin
   require 'codeclimate-test-reporter'
 
   CodeClimate::TestReporter.start do
     add_filter "/test/"
   end
+rescue LoadError
+  puts 'WARNING: codeclimate-test-reporter not available, no code coverage reported.'
 end

data/test/test_disc.rb

@@ -13,9 +13,9 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-require 'helper'
 require 'test/unit'
 require 'discid'
+require_relative 'helper'
 
 # Unit test for the DiscId::Disc class.
 class TestDisc < Test::Unit::TestCase

data/test/test_discid.rb

@@ -13,9 +13,9 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-require 'helper'
 require 'test/unit'
 require 'discid'
+require_relative 'helper'
 
 # Helper class which can't be converted into a string.
 class NotAString

data/test/test_track.rb

@@ -13,9 +13,9 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-require 'helper'
 require 'test/unit'
 require 'discid/track'
+require_relative 'helper'
 
 # Unit test for the DiscId::Track class.
 class TestTrack < Test::Unit::TestCase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discid
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Philipp Wolfer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-12 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -25,35 +25,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: kramdown
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -117,6 +117,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGES.md
 - LICENSE
 - README.md
@@ -146,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="