discid 1.0.0rc2 → 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWU1OTZiMzAyYzIxNGEzOTliYmRmMjc4MzI5MWNiZjAxM2FlOWJkOA==
+  data.tar.gz: !binary |-
+    NzRjNTM3MjYwMzQ2NWJlNjVmY2YyNmE0NDBlMDE1ZThiNDIwODcyNQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZWI2ZTdjOTNlOTIyMzk5NDNhZDVjOGFmNjk4MTg4ZDVmYWVhNzBmNTQ0ZjI3
+    MmM2YWNlZDI3NmZiOTVmNzU1NTk0NGM0YTkwMjAyOWFiNWNiOTY0ZDgyMTYw
+    MDQ3ODEyMGVlZDBjYmZiYmFjZTc0N2ZmYzZjYTRhZGE0M2MzNTQ=
+  data.tar.gz: !binary |-
+    NDUxZmJkOGQ4NTA3ZTdiYjk4Yjg4YjFhOTZkNTBhOThhMDA4NTE5NzE2YzYy
+    NDM3NjBlZmZmYzQ5MTUxZmE1NDVlMGYzNmZjMDFiMzgxZTY1YzVmYjEyZmM0
+    MjA4ZDljY2Y1NmYzNzg0OWQ1ZDkxNTQxNDJlMzJjNWExMWMzYTY=

data/CHANGES

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.0 (2013-05-01)
+* Final API and documentation cleanup.
+* Fixed library loading on Windows and OSX.
+
 ## 1.0.0.rc2 (2013-04-29)
 * Fixed loading libdiscid library
 

data/README.md

@@ -6,8 +6,9 @@ It allows calculating DiscIDs (MusicBrainz and freedb) for Audio CDs. Additional
 the library can extract the MCN/UPC/EAN and the ISRCs from disc.
 
 ## Requirements
-* Ruby >= 1.8.6
-* Ruby-FFI
+* Ruby >= 1.8.7
+* RubyGems >= 1.3.6
+* Ruby-FFI >= 1.6.0
 * libdiscid >= 0.1.0
 
 ## Installation
@@ -18,9 +19,18 @@ Installing ruby-discid is best done using RubyGems:
 
     gem install discid
 
-Or install it from the source tarball:
+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.
  
 ## Usage
 

data/discid.gemspec

@@ -13,16 +13,19 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/phw/ruby-discid"
   spec.license       = "LGPL-3"
   spec.post_install_message = %q{Please make sure you have libdiscid (http://musicbrainz.org/doc/libdiscid) installed.}
-  spec.requirements  = "libdiscid >= 0.1.0"
+
+  spec.requirements              = "libdiscid >= 0.1.0"
+  spec.required_ruby_version     = ">= 1.8.7"
+  spec.required_rubygems_version = ">= 1.3.6"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "ffi", "~> 1.6.0"
+  spec.add_dependency "ffi", ">= 1.6.0"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", ">= 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "yard"
   spec.add_development_dependency "kramdown"

data/examples/discidinfo.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+#
+# Example script for DiscId.
+# 
+# This script will read the disc ID from the default device and print
+# the results. You can specify an alternate device to use by giving the
+# device's name as the first command line argument.
+# 
+# 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'
+
+# Print information about libdiscid
+print <<EOF
+Version           : #{DiscId::LIBDISCID_VERSION}
+Default device    : #{DiscId.default_device}
+Supported features: #{DiscId.feature_list.join(', ')}
+EOF

data/examples/readdiscid.rb

@@ -52,7 +52,7 @@ disc.tracks do |track|
   puts "  Length: %02d:%02d (%i sectors)" %
       [track.seconds / 60, track.seconds % 60, track.sectors]
   puts "  Start : %02d:%02d (sector %i)" %
-      [track.start_time / 60, track.start_time % 60, track.start_sector]
+      [track.start_time / 60, track.start_time % 60, track.offset]
   puts "  End   : %02d:%02d (sector %i)" %
       [track.end_time / 60, track.end_time % 60, track.end_sector]
   puts "  ISRC  : %s" % track.isrc if DiscId.has_feature?(:isrc)

data/lib/discid/disc.rb

@@ -15,7 +15,7 @@
 
 require 'ffi'
 require 'discid/lib'
-require 'discid/track_info'
+require 'discid/track'
 
 module DiscId
   # This class holds information about a disc (TOC, MCN, ISRCs).
@@ -149,7 +149,7 @@ module DiscId
       id.to_s
     end
 
-    # Returns an array of {TrackInfo} objects. Each TrackInfo object contains
+    # Returns an array of {Track} objects. Each Track object contains
     # detailed information about the track.
     # 
     # Returns always `nil` if no ID was yet read. The block won't be
@@ -158,7 +158,7 @@ module DiscId
     # @yield [track_info] 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<TrackInfo>] Array of {TrackInfo} objects.
+    # @return [Array<Track>] Array of {Track} objects.
     def tracks
       if @read
         read_tracks if @tracks.nil?
@@ -183,7 +183,7 @@ module DiscId
         isrc = Lib.get_track_isrc(@handle, track_number)
         offset = Lib.get_track_offset(@handle, track_number)
         length = Lib.get_track_length(@handle, track_number)
-        track_info = TrackInfo.new(track_number, offset, length, isrc)
+        track_info = Track.new(track_number, offset, length, isrc)
         
         @tracks << track_info
       end

data/lib/discid/lib.rb

@@ -24,7 +24,7 @@ module DiscId
   # @private
   module Lib
     extend FFI::Library
-    ffi_lib %w[discid libdiscid.so.0]
+    ffi_lib %w[discid libdiscid.so.0 libdiscid.0.dylib]
 
     attach_function :new, :discid_new, [], :pointer
 

data/lib/discid/{track_info.rb → track.rb}

@@ -22,7 +22,7 @@ module DiscId
   #
   # * number:       The number of the track on the disc.
   # * sectors:      Length of the track in sectors.
-  # * start_sector: Start position of the track on the disc in sectors.
+  # * offset:       Start position of the track on the disc in sectors.
   # * end_sector:   End position of the track on the disc in sectors.
   # * seconds:      Length of the track in seconds.
   # * start_time:   Start position of the track on the disc in seconds.
@@ -33,12 +33,12 @@ module DiscId
   # You can access all fields either directly or with the square bracket
   # notation:
   # 
-  #     track = TrackInfo.new(1, 150, 16007)
+  #     track = Track.new(1, 150, 16007)
   #     puts track.sectors   # 16007
   #     puts track[:sectors] # 16007
   #  
   # @see DiscId::Disc#tracks
-  class TrackInfo
+  class Track
       
     # The number of the track on the disc.
     #
@@ -53,7 +53,7 @@ module DiscId
     # Start position of the track on the disc in sectors.
     #
     # @return [Integer]
-    attr_reader :start_sector
+    attr_reader :offset
     
     # ISRC number of the track.
     #
@@ -64,11 +64,11 @@ module DiscId
     # @return [String]
     attr_reader :isrc
     
-    # Returns a new TrackInfo.
-    def initialize(number, offset, length, isrc)
+    # Initializes a new Track object.
+    def initialize(number, offset, sectors, isrc)
       @number = number
-      @start_sector = offset
-      @sectors = length
+      @offset = offset
+      @sectors = sectors
       @isrc = isrc
     end
       
@@ -76,7 +76,7 @@ module DiscId
     #
     # @return [Integer]
     def end_sector
-      start_sector + sectors
+      offset + sectors
     end
       
     # Length of the track in seconds.
@@ -90,7 +90,7 @@ module DiscId
     #
     # @return [Integer]
     def start_time
-      DiscId.sectors_to_seconds(start_sector)
+      DiscId.sectors_to_seconds(offset)
     end
     
     # End position of the track on the disc in seconds.
@@ -104,24 +104,24 @@ module DiscId
     # 
     # Example:
     #
-    #     track = TrackInfo.new(1, 150, 16007)
+    #     track = Track.new(1, 150, 16007)
     #     puts track.sectors   # 16007
     #     puts track[:sectors] # 16007
     def [](key)
-      if [:number, :sectors, :start_sector, :end_sector,
+      if [:number, :sectors, :offset, :end_sector,
           :seconds, :start_time, :end_time, :isrc].include?(key.to_sym)
         method(key).call
       end
     end
     
-    # Converts the TrackInfo into a Hash.
+    # Converts the Track into a Hash.
     #
     # @return [Hash]
     def to_hash
       {
         :number       => number,
         :sectors      => sectors,
-        :start_sector => start_sector,
+        :offset       => offset,
         :end_sector   => end_sector,
         :seconds      => seconds,
         :start_time   => start_time,

data/lib/discid/version.rb

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

data/test/test_disc.rb

@@ -80,7 +80,7 @@ class TestDisc < Test::Unit::TestCase
     assert_equal @fiction_last_track, disc.last_track_number
     assert_equal @fiction_sectors, disc.sectors
     assert_equal @fiction_seconds, disc.seconds
-    assert_equal @fiction_offsets, disc.tracks.map{|t| t.start_sector}
+    assert_equal @fiction_offsets, disc.tracks.map{|t| t.offset}
     assert_equal @fiction_lengths, disc.tracks.map{|t| t.sectors}
   end
 

data/test/test_discid.rb

@@ -81,7 +81,7 @@ class TestDiscId < Test::Unit::TestCase
     proc_test_track = lambda do |track|
       assert_equal number + 1, track.number
       
-      assert_equal @fiction_offsets[number], track.start_sector
+      assert_equal @fiction_offsets[number], track.offset
       assert_equal @fiction_lengths[number], track.sectors
       assert_equal @fiction_offsets[number]+ @fiction_lengths[number],
                    track.end_sector

data/test/{test_track_info.rb → test_track.rb}

@@ -14,10 +14,10 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'test/unit'
-require 'discid/track_info'
+require 'discid/track'
 
-# Unit test for the DiscId::TrackInfo class.
-class TestTrackInfo < Test::Unit::TestCase
+# Unit test for the DiscId::Track class.
+class TestTrack < Test::Unit::TestCase
 
   def setup
     @number = 3
@@ -27,10 +27,10 @@ class TestTrackInfo < Test::Unit::TestCase
   end
 
   def test_init_track_info
-    track = DiscId::TrackInfo.new @number, @offset, @length, @isrc
+    track = DiscId::Track.new @number, @offset, @length, @isrc
 
     assert_equal @number, track.number
-    assert_equal @offset, track.start_sector
+    assert_equal @offset, track.offset
     assert_equal @length, track.sectors
     assert_equal @isrc, track.isrc
 
@@ -41,11 +41,11 @@ class TestTrackInfo < Test::Unit::TestCase
   end
 
   def test_to_hash
-    track = DiscId::TrackInfo.new @number, @offset, @length, @isrc
+    track = DiscId::Track.new @number, @offset, @length, @isrc
     hash = track.to_hash
 
     assert_equal track.number, hash[:number]
-    assert_equal track.start_sector, hash[:start_sector]
+    assert_equal track.offset, hash[:offset]
     assert_equal track.sectors, hash[:sectors]
     assert_equal track.isrc, hash[:isrc]
 
@@ -56,10 +56,10 @@ class TestTrackInfo < Test::Unit::TestCase
   end
 
   def test_selector_access
-    track = DiscId::TrackInfo.new @number, @offset, @length, @isrc
+    track = DiscId::Track.new @number, @offset, @length, @isrc
  
     assert_equal track.number, track[:number]
-    assert_equal track.start_sector, track[:start_sector]
+    assert_equal track.offset, track[:offset]
     assert_equal track.sectors, track[:sectors]
     assert_equal track.isrc, track[:isrc]
 
@@ -70,7 +70,7 @@ class TestTrackInfo < Test::Unit::TestCase
   end
 
   def test_invalid_selector_value
-    track = DiscId::TrackInfo.new @number, @offset, @length, @isrc
+    track = DiscId::Track.new @number, @offset, @length, @isrc
     assert_equal nil, track[:invalid_value]
   end
 

metadata

@@ -1,52 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: discid
 version: !ruby/object:Gem::Version
-  version: 1.0.0rc2
-  prerelease: 5
+  version: 1.0.0
 platform: ruby
 authors:
 - Philipp Wolfer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -109,44 +98,44 @@ files:
 - README.md
 - Rakefile
 - discid.gemspec
+- examples/discidinfo.rb
 - examples/readdiscid.rb
 - lib/discid.rb
 - lib/discid/disc.rb
 - lib/discid/lib.rb
-- lib/discid/track_info.rb
+- lib/discid/track.rb
 - lib/discid/version.rb
 - test/test_disc.rb
 - test/test_discid.rb
-- test/test_track_info.rb
+- test/test_track.rb
 homepage: https://github.com/phw/ruby-discid
 licenses:
 - LGPL-3
+metadata: {}
 post_install_message: Please make sure you have libdiscid (http://musicbrainz.org/doc/libdiscid)
   installed.
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: 1.3.6
 requirements:
 - libdiscid >= 0.1.0
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby bindings for libdiscid
 test_files:
 - test/test_disc.rb
 - test/test_discid.rb
-- test/test_track_info.rb
+- test/test_track.rb
 has_rdoc: