discid 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 04925bc0ab19f720f642b3cdc2421138d26d2b5a
-  data.tar.gz: 57815371438236e32ec759332070e307893edef1
+SHA256:
+  metadata.gz: 0c1f99777183d8decf97ffb214d424300ae1546f72d30e0a9fe3891e24b66882
+  data.tar.gz: 65cc1ffde114bcd7860697ac081d266f434d294a86094a0f26efdd418096f1dc
 SHA512:
-  metadata.gz: 1e479cecb1a34c9002397a1c959b547942156d32592822ea1e0312a63efec7c8f5470af20b7eb51a06132887d6f2e905ad6df1bd8c47b15299d7777eaed776c8
-  data.tar.gz: 2dd736a7d7c23cd01076d0703270982d10aa0268f11234b95376294a4b5e5b38f1ad7a54496d7571a422e0de94967eb48c2ee84427e5538eb0f3f3a884062617
+  metadata.gz: 6ccdebac904df0839af7ce5ad36d130e7c00d36324fabf72e64bdebf686bdb7a290c82d520dcd909b4b83295cc8ea0389540b66086b06e2f3a39646d277d70c1
+  data.tar.gz: 6fe953875c071bd33973596c4bc9e18c1313a58df2273e4b929ca628e0923f79b93efa8bbf1c7fb26067278cf2f46588a3c2754a72b3f0febfb311b860725aa5

data/CHANGES.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 1.4.1 (2021-09-23)
+* Fix Ruby 3 compatibility if {DiscId.tracks} gets called with a block
+
+## 1.4.0 (2019-05-06)
+* Fixed {DiscId.put} handling of first_track being > 1
+* Added {DiscId.parse} to parse a TOC string
+* Documentation fixes
+
+## 1.3.2 (2017-12-19)
+* Fixed call to {DiscId::Disc#toc_string} with native implementation
+
+## 1.3.1 (2017-02-16)
+* codeclimate-test-reporter is no longer a development dependency
+
 ## 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.

data/README.md

@@ -1,8 +1,7 @@
 # Ruby bindings for MusicBrainz libdiscid
-[![Build Status](https://travis-ci.org/phw/ruby-discid.svg?branch=master)](https://travis-ci.org/phw/ruby-discid)
-[![Code Climate](https://codeclimate.com/github/phw/ruby-discid.png)](https://codeclimate.com/github/phw/ruby-discid)
-[![Code Climate](https://codeclimate.com/github/phw/ruby-discid/coverage.png)](https://codeclimate.com/github/phw/ruby-discid)
 [![Gem Version](https://badge.fury.io/rb/discid.svg)](http://badge.fury.io/rb/discid)
+[![Maintainability](https://api.codeclimate.com/v1/badges/50e356f4260a127af75b/maintainability)](https://codeclimate.com/github/phw/ruby-discid/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/50e356f4260a127af75b/test_coverage)](https://codeclimate.com/github/phw/ruby-discid/test_coverage)
 
 ## About
 ruby-discid provides Ruby bindings for the MusicBrainz DiscID library [libdiscid](http://musicbrainz.org/doc/libdiscid).
@@ -112,7 +111,7 @@ Please report any issues on the
 [issue tracker](https://github.com/phw/ruby-discid/issues).
 
 ## License
-ruby-discid Copyright (c) 2007-2016 by Philipp Wolfer <ph.wolfer@gmail.com>
+ruby-discid Copyright (c) 2007-2021 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

data/examples/discfromtoc.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+#
+# Example script for DiscId.
+#
+# This script shows how to generate a disc ID for given TOC data
+#
+# Example:
+#  ./discid.rb /dev/dvd
+
+# Just make sure we can run this example from the command
+# line even if DiscId is not yet installed properly.
+$: << 'lib/' << 'ext/' << '../ext/' << '../lib/'
+
+require 'discid'
+
+offsets = [150, 44942, 61305, 72755, 96360, 130485, 147315, 164275, 190702, 205412, 220437]
+
+disc = DiscId.put(1, 242457, offsets)
+
+
+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
+Sectors     : #{disc.sectors}
+
+Submit via #{disc.submission_url}
+EOF

data/examples/parsetoc.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+#
+# Example script for DiscId.
+#
+# This script shows how to generate a disc ID by parsing a given TOC string
+#
+# Example:
+#  ./discid.rb /dev/dvd
+
+# Just make sure we can run this example from the command
+# line even if DiscId is not yet installed properly.
+$: << 'lib/' << 'ext/' << '../ext/' << '../lib/'
+
+require 'discid'
+
+toc = '1 11 242457 150 44942 61305 72755 96360 130485 147315 164275 190702 205412 220437'
+
+disc = DiscId.parse(toc)
+
+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
+Sectors     : #{disc.sectors}
+
+Submit via #{disc.submission_url}
+EOF

data/lib/discid/disc.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013-2014 Philipp Wolfer
+# Copyright (C) 2013-2014, 2021 Philipp Wolfer
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published by
@@ -18,6 +18,7 @@ require 'discid/disc_error'
 require 'discid/lib'
 require 'discid/track'
 
+#
 module DiscId
   # This class holds information about a disc (TOC, MCN, ISRCs).
   #
@@ -59,11 +60,14 @@ module DiscId
     def put(first_track, sectors, offsets)
       @read = false
       @device = nil
-      last_track = offsets.length
+      last_track = first_track - 1 + offsets.length
 
       # discid_put expects always an offsets array with exactly 100 elements.
       FFI::MemoryPointer.new(:int, 100) do |p|
-        p.write_array_of_int([sectors] + offsets)
+        if last_track > offsets.length
+          offsets = Array.new(last_track - offsets.length, 0) + offsets
+        end
+        p.write_array_of_int(([sectors] + offsets)[0, 100])
         result = Lib.put @handle, first_track, last_track, p
 
         if result == 0
@@ -132,12 +136,15 @@ module DiscId
 
     # Return a string representing CD Table Of Contents (TOC).
     #
-    # The TOC suitable as value of the toc parameter when accessing the
+    # The TOC suitable as a 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.
     #
+    # For libdiscid >= 0.6 the native implementation will be used. For older
+    # versions falls back to extract the TOC from {Disc#submission_url}.
+    #
     # @since 1.3
     #
     # @raise [RuntimeError] get_toc_string is unsupported by libdiscid and
@@ -145,13 +152,13 @@ module DiscId
     # @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
+      result = Lib.get_toc_string @handle
       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("+", " ")
+          result = match[1].tr("+", " ")
         else
           raise "can't get toc string from submission url"
         end
@@ -186,16 +193,16 @@ module DiscId
     # Returns always `nil` if no ID was yet read. The block won't be
     # called in this case.
     #
-    # @yield [track_info] If a block is given this method returns `nil` and
+    # @yield [Track] If a block is given this method returns `nil` and
     #     instead iterates over the block calling the block with one argument.
     # @yieldreturn [nil]
     # @return [Array<Track>] Array of {Track} objects.
-    def tracks
+    def tracks(&block)
       if @read
         read_tracks if @tracks.nil?
 
-        if block_given?
-          @tracks.each(&Proc.new)
+        if block
+          @tracks.each(&block)
           return nil
         else
           return @tracks

data/lib/discid/disc_error.rb

@@ -13,6 +13,7 @@
 # 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/>.
 
+#
 module DiscId
   # This exception is thrown on errors reading the disc or setting the TOC.
   class DiscError < StandardError

data/lib/discid/lib.rb

@@ -15,6 +15,7 @@
 
 require "ffi"
 
+#
 module DiscId
 
   # This module encapsulates the C interface for libdiscid using FFI.
@@ -35,7 +36,7 @@ module DiscId
     rescue FFI::NotFoundError
       attach_function :legacy_read, :discid_read, [:pointer, :string], :int
 
-      def self.read(handle, device, features)
+      def self.read(handle, device, _features)
         legacy_read(handle, device)
       end
     end
@@ -73,7 +74,7 @@ module DiscId
     begin
       attach_function :get_mcn, :discid_get_mcn, [:pointer], :string
     rescue FFI::NotFoundError
-      def self.get_mcn(handle)
+      def self.get_mcn(_handle)
         return nil
       end
     end
@@ -81,7 +82,7 @@ module DiscId
     begin
       attach_function :get_track_isrc, :discid_get_track_isrc, [:pointer, :int], :string
     rescue FFI::NotFoundError
-      def self.get_track_isrc(handle, track)
+      def self.get_track_isrc(_handle, _track)
         return nil
       end
     end
@@ -109,17 +110,24 @@ module DiscId
     end
 
     def self.features_to_int(features)
-      feature_flag = 0
+      feature_flags = 0
       features.each do |feature|
         if feature.respond_to? :to_sym
           feature = feature.to_sym
-          feature_flag |= self::Features[feature] if
-            self::Features.symbols.include?(feature) and
-            self.has_feature(feature)
+          feature_flags = self.add_feature_to_flags(feature_flags, feature)
         end
       end
 
-      return feature_flag
+      return feature_flags
+    end
+
+    private
+
+    def self.add_feature_to_flags(flags, feature)
+      flags |= self::Features[feature] if
+        self::Features.symbols.include?(feature) and
+        self.has_feature(feature)
+      return flags
     end
   end
 end

data/lib/discid/track.rb

@@ -13,7 +13,7 @@
 # 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/>.
 
-
+#
 module DiscId
 
   # This class holds information about a single track.

data/lib/discid/version.rb

@@ -13,8 +13,8 @@
 # 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/>.
 
-
+#
 module DiscId
   # The version of ruby-discid.
-  VERSION = "1.3.0"
+  VERSION = "1.4.1"
 end

data/lib/discid.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 Philipp Wolfer
+# Copyright (C) 2013-2017, 2019 Philipp Wolfer
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published by
@@ -120,6 +120,29 @@ module DiscId
     return disc
   end
 
+  # Parses a TOC string and returns a [Disc] instance for it.
+  #
+  # This function can be used if you already have a TOC string like e.g.
+  # `1 11 242457 150 44942 61305 72755 96360 130485 147315 164275 190702 205412 220437`
+  #
+  # @raise [DiscError] The TOC string was invalid and could not be parsed.
+  # @param toc [String] A TOC string in the format `1 11 242457 150 44942 61305 72755 96360 130485 147315 164275 190702 205412 220437`.
+  # @return [Disc]
+  def self.parse(toc)
+    if toc.nil? || toc.empty?
+      raise DiscError, "Invalid TOC #{toc.inspect}"
+    end
+    begin
+      parts = toc.split(' ')
+      first_track = Integer(parts[0])
+      sectors = Integer(parts[2])
+      offsets = parts[3..-1].map{|i| Integer(i)}
+    rescue ArgumentError, TypeError => e
+      raise DiscError, e
+    end
+    return self.put(first_track, sectors, offsets)
+  end
+
   # Return the name of the default disc drive for this operating system.
   #
   # @return [String] An operating system dependent device identifier

data/test/helper.rb

@@ -14,9 +14,9 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 begin
-  require 'codeclimate-test-reporter'
+  require 'simplecov'
 
-  CodeClimate::TestReporter.start do
+  SimpleCov.start do
     add_filter "/test/"
   end
 rescue LoadError

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_relative 'helper'
 require 'test/unit'
 require 'discid'
-require_relative 'helper'
 
 # Unit test for the DiscId::Disc class.
 class TestDisc < Test::Unit::TestCase
@@ -85,4 +85,10 @@ class TestDisc < Test::Unit::TestCase
     assert_equal @fiction_lengths, disc.tracks.map{|t| t.sectors}
   end
 
+  def test_toc_string
+    disc = DiscId.put(@fiction_first_track, @fiction_sectors, @fiction_offsets)
+    expected_toc = '1 10 206535 150 18901 39738 59557 79152 100126 124833 147278 166336 182560'
+    assert_equal expected_toc, disc.toc_string
+  end
+
 end

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_relative 'helper'
 require 'test/unit'
 require 'discid'
-require_relative 'helper'
 
 # Helper class which can't be converted into a string.
 class NotAString
@@ -55,20 +55,26 @@ class TestDiscId < Test::Unit::TestCase
   # Those reads should all fail, but they must never cause a segmentation fault.
   def test_read_invalid_arguments
     assert_raise(TypeError) {DiscId.read(NotAString.new)}
-    assert_raise(DiscId::DiscError) {DiscId.read(1)}
-    assert_raise(DiscId::DiscError) {DiscId.read('invalid_device')}
-    assert_raise(DiscId::DiscError) {DiscId.read(:invalid_device)}
+    assert_raise(DiscId::DiscError) { DiscId.read('invalid_device') }
+    assert_raise(DiscId::DiscError) { DiscId.read(:invalid_device) }
   end
 
   def test_put_first_track_not_one
     disc = DiscId.put(3, @fiction_sectors,
-                      [0, 0, 150, 18901, 39738, 59557, 79152, 100126,
+                      [150, 18901, 39738, 59557, 79152, 100126,
                        124833, 147278, 166336, 182560])
+    assert_equal "ByBKvJM1hBL7XtvsPyYtIjlX0Bw-", disc.id
     assert_equal 3, disc.first_track_number
     assert_equal 12, disc.last_track_number
     assert_equal 10, disc.tracks.size
   end
 
+  def test_put_invalid_track_count
+    assert_raise(DiscId::DiscError) {
+      disc = DiscId.put(1, @fiction_sectors, Array.new(101) {|i| i + 150 })
+    }
+  end
+
   # Test the tracks method and TrackInfo objects
   def test_put_and_tracks
     disc = nil
@@ -113,6 +119,47 @@ class TestDiscId < Test::Unit::TestCase
     assert_equal disc.last_track_number, number
   end
 
+  def test_parse
+    toc = '1 11 242457 150 44942 61305 72755 96360 130485 147315 164275 190702 205412 220437'
+    assert_nothing_raised do
+      disc = DiscId.parse(toc)
+      assert_equal 'lSOVc5h6IXSuzcamJS1Gp4_tRuA-', disc.id
+      assert_equal toc, disc.toc_string
+    end
+  end
+
+  def test_parse_minimal
+    toc = '1 1 44942 150'
+    assert_nothing_raised do
+      disc = DiscId.parse(toc)
+      assert_equal 'ANJa4DGYN_ktpzOwvVPtcjwP7mE-', disc.id
+      assert_equal toc, disc.toc_string
+    end
+  end
+
+  def test_parse_first_track_not_one
+    toc = '3 12 242457 150 18901 39738 59557 79152 100126 124833 147278 166336 182560'
+    assert_nothing_raised do
+      disc = DiscId.parse(toc)
+      assert_equal 'fC1yNbC5bVjbvphqlAY9JyYoWEY-', disc.id
+      assert_equal toc, disc.toc_string
+    end
+  end
+
+  def test_parse_invalid_empty
+    assert_raise(DiscId::DiscError) { DiscId.parse("") }
+    assert_raise(DiscId::DiscError) { DiscId.parse(nil) }
+  end
+
+  def test_parse_invalid_nan
+    assert_raise(DiscId::DiscError) { DiscId.parse("1 2 242457 150 a") }
+  end
+
+  def test_parse_invalid_not_enough_elements
+    assert_raise(DiscId::DiscError) { DiscId.parse("1 2 242457") }
+    assert_raise(DiscId::DiscError) { DiscId.parse("1 242457") }
+  end
+
   # Test the conversion from sectors to seconds
   def test_sectors_to_seconds
     assert_equal 0, DiscId.sectors_to_seconds(0)

data/test/test_lib.rb

@@ -0,0 +1,40 @@
+# Copyright (C) 2013-2014 Philipp Wolfer
+#
+# This program 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.
+#
+# 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_relative 'helper'
+require 'test/unit'
+require 'discid/lib'
+
+class TestTrack < Test::Unit::TestCase
+  def test_features_to_int
+    assert_equal 1, DiscId::Lib.features_to_int([:read])
+  end
+
+  def test_features_to_int_no_features
+    assert_equal 0, DiscId::Lib.features_to_int([])
+  end
+
+  def test_features_to_int_as_strings
+    assert_equal 1, DiscId::Lib.features_to_int(['read'])
+  end
+
+  def test_features_to_int_ignores_unknown
+    assert_equal 1, DiscId::Lib.features_to_int([:read, :fake])
+  end
+
+  def test_has_feature
+    assert_equal 1, DiscId::Lib.has_feature(:read)
+  end
+end

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_relative '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.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Philipp Wolfer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-19 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,7 +122,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/discfromtoc.rb
 - examples/discidinfo.rb
+- examples/parsetoc.rb
 - examples/readdiscid.rb
 - lib/discid.rb
 - lib/discid/disc.rb
@@ -133,6 +135,7 @@ files:
 - test/helper.rb
 - test/test_disc.rb
 - test/test_discid.rb
+- test/test_lib.rb
 - test/test_track.rb
 homepage: https://github.com/phw/ruby-discid
 licenses:
@@ -155,8 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements:
 - libdiscid >= 0.1.0
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for libdiscid
@@ -164,5 +166,5 @@ test_files:
 - test/helper.rb
 - test/test_disc.rb
 - test/test_discid.rb
+- test/test_lib.rb
 - test/test_track.rb
-has_rdoc: