discid 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: fa1e17690165aeec4fbcbba04e78b7e24ceda6f44b409149d682e8a24b83692b
-  data.tar.gz: c8b61ae0fef04a93105e9e2d120fcc2b67281086696f22a6f3ee8f5c67395c76
+SHA1:
+  metadata.gz: e54ccf0358d9377e073c158bc10c972410446882
+  data.tar.gz: a29145b466deb26a8830d537cb5471a346fc51bd
 SHA512:
-  metadata.gz: 854bd221c4e17c2828a7ede9586f797715ef138f94fa5d039eae227f72e133913db01541e7f7f9f984dbd51dcf8f14c914b7a1b9752b4dc69400e55bca71b5f8
-  data.tar.gz: b4a832781ed273f892a6268cd2a79e2318619b4536e6c49a4b267f10537b9bbaf89d3b1cea64e141496f7b22ee42093f5be48cacd7c06a740da7d07a9fbbc1cb
+  metadata.gz: 0dfed6d0c5d3e631ee3333f02cb86e7b46239b9eb48a9211b5fc4b7952b0a27bac01f42eb548b973b8fef9c89295a3123343c4dba0479814ff1d6f1e566759f1
+  data.tar.gz: 0ca29384229a241332b53d19613583bc5c95bb80ae51a95154b8612d7e71ed72652a89f1bb701acf09d0c61c97c49e0ada88fd01cfbfdefd280855c2e79b31e1

data/CHANGES.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 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
 

data/README.md

@@ -112,7 +112,7 @@ Please report any issues on the
 [issue tracker](https://github.com/phw/ruby-discid/issues).
 
 ## License
-ruby-discid Copyright (c) 2007-2017 by Philipp Wolfer <ph.wolfer@gmail.com>
+ruby-discid Copyright (c) 2007-2019 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.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/lib/discid/disc.rb

@@ -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
@@ -186,7 +193,7 @@ 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.

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.

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.2"
+  VERSION = "1.4.0"
 end

data/test/test_discid.rb

@@ -55,20 +55,25 @@ 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 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 +118,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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discid
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Philipp Wolfer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2019-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -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
@@ -157,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - libdiscid >= 0.1.0
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for libdiscid