hallon 0.10.1 → 0.11.0

data/.travis.yml

@@ -1,4 +1,3 @@
 rvm:
   - 1.9.2
   - 1.9.3
-

data/CHANGELOG

@@ -1,7 +1,20 @@
 Hallon’s Changelog
 ==================
 
-v10.0.0
+v0.11.0
+------------------
+[ Added ]
+- Playlist#can_move?
+- Base.from(pointer)
+
+[ Changed ]
+- Playlist#move no longer takes a dry_run parameter
+
+[ Fixed ]
+- Player#music_delivery callback ignoring consumed frames
+- Session#wait_for minimum timeout time from 0 to 10 ms
+
+v0.10.1 (actually v0.10.0)
 ------------------
 [ Added ]
 - Add PlaylistContainer::Folder#rename

data/Rakefile

@@ -60,6 +60,7 @@ task 'spotify:coverage' do
   covered = Set.new(methods)
   warning = []
   ignored = [
+    'attach_function',  # spotify overloads this
     'session_release',  # segfaults on libspotify <= 9
     'session_userdata', # wont support this
     'link_as_track',    # using link_as_track_and_offset instead
@@ -82,7 +83,7 @@ task 'spotify:coverage' do
   # Direct calls
   handlers[Sexp.new(:const, :Spotify)] = Hash.new(proc do |_, meth, _|
     if auto_gc.include?("#{meth}!")
-      warning << meth
+      warning << [$file, meth]
     end
 
     result = [meth]
@@ -102,6 +103,7 @@ task 'spotify:coverage' do
   # DSL Methods
   no_receiver = handlers[nil] = Hash.new(silencer)
   no_receiver[:from_link] = no_receiver[:to_link] = proc do |recv, meth, (_, name)|
+    next unless name.respond_to?(:value)
     prefix = meth == :to_link ? "link_create" : "link"
     method = "%s_%s" % [prefix, name.value]
     [method, "#{method}!"]
@@ -110,7 +112,8 @@ task 'spotify:coverage' do
   fails = {}
   FileList['lib/**/*.rb'].each do |file|
     begin
-      ast   = RubyParser.new.parse File.read(file)
+      $file = file
+      ast = Ruby19Parser.new.parse File.read(file)
       ast.each_of_type(:call) do |_, recv, meth, args, *rest|
         name = handlers[recv][meth].call(recv, meth, args)
         covered.subtract Array(name).map(&:to_s)
@@ -144,8 +147,8 @@ task 'spotify:coverage' do
 
   unless warning.empty?
     puts "Warnings (use auto-gc methods instead!):"
-    warning.each do |method|
-      puts "  #{method}"
+    warning.each do |file, method|
+      puts "  #{file}: #{method}"
     end
     puts
   end

data/lib/hallon/album.rb

@@ -74,7 +74,7 @@ module Hallon
     # @return [Artist, nil] album artist.
     def artist
       artist = Spotify.album_artist!(pointer)
-      Artist.new(artist) unless artist.null?
+      Artist.from(artist)
     end
 
     # Retrieves album cover art as an {Image} or a {Link}.
@@ -87,7 +87,7 @@ module Hallon
         Image.new cover.read_string(20) unless cover.null?
       else
         cover = Spotify.link_create_from_album_cover!(pointer)
-        Link.new cover unless cover.null?
+        Link.from(cover)
       end
     end
 

data/lib/hallon/album_browse.rb

@@ -47,13 +47,13 @@ module Hallon
     # @return [Artist, nil] artist performing this album.
     def artist
       artist = Spotify.albumbrowse_artist!(pointer)
-      Artist.new(artist) unless artist.null?
+      Artist.from(artist)
     end
 
     # @return [Album, nil] album this object is browsing.
     def album
       album = Spotify.albumbrowse_album!(pointer)
-      Album.new(album) unless album.null?
+      Album.from(album)
     end
 
     # @note If the object is not loaded, the result is undefined.

data/lib/hallon/artist.rb

@@ -52,7 +52,7 @@ module Hallon
         Image.new portrait.read_bytes(20) unless portrait.null?
       else
         portrait = Spotify.link_create_from_artist_portrait!(pointer)
-        Link.new portrait unless portrait.null?
+        Link.from(portrait)
       end
     end
 

data/lib/hallon/artist_browse.rb

@@ -46,7 +46,7 @@ module Hallon
     # @return [Artist, nil] artist this browser is browsing.
     def artist
       artist = Spotify.artistbrowse_artist!(pointer)
-      Artist.new(artist) unless artist.null?
+      Artist.from(artist)
     end
 
     # @return [String] artist biography.

data/lib/hallon/base.rb

@@ -3,6 +3,12 @@ module Hallon
   # All objects in Hallon are mere representations of Spotify objects.
   # Hallon::Base covers basic functionality shared by all of these.
   class Base
+    # @param [#null?] pointer
+    # @return [self, nil] a new instance of self, unless given pointer is #null?
+    def self.from(pointer, *args, &block)
+      new(pointer, *args, &block) unless pointer.null?
+    end
+
     # Underlying FFI pointer.
     #
     # @return [FFI::Pointer]
@@ -13,9 +19,11 @@ module Hallon
     # @param [Object] other
     # @return [Boolean]
     def ==(other)
-      pointer == other.pointer
-    rescue NoMethodError
-      super
+      if other.respond_to?(:pointer)
+        pointer == other.pointer
+      else
+        super
+      end
     end
 
     # Default string representation of self.
@@ -74,7 +82,7 @@ module Hallon
         end
 
         if pointer.nil? or pointer.null?
-          raise ArgumentError, "#{resource.inspect} is not a valid spotify #{type} URI or pointer"
+          raise ArgumentError, "#{resource.inspect} could not be converted to a spotify #{type} pointer"
         elsif not Spotify::Pointer.typechecks?(pointer, type)
           raise TypeError, "“#{resource}” is of type #{resource.type}, #{type} expected"
         else

data/lib/hallon/image.rb

@@ -24,7 +24,6 @@ module Hallon
     #   image = Hallon::Image.new("3ad93423add99766e02d563605c6e76ed2b0e450")
     #
     # @param [String, Link, Spotify::Pointer] link link or image id
-    # @param [Hallon::Session] session
     def initialize(link)
       if link.respond_to?(:=~) and link =~ %r~(?:image[:/]|\A)([a-fA-F0-9]{40})\z~
         link = to_id($1)

data/lib/hallon/linkable.rb

@@ -94,7 +94,7 @@ module Hallon
     def to_link(cmethod)
       define_method(:to_link) do |*args|
         link = Spotify.__send__(:"link_create_#{cmethod}!", pointer, *args)
-        Link.new(link) unless link.null?
+        Link.from(link)
       end
     end
 

data/lib/hallon/player.rb

@@ -69,7 +69,6 @@ module Hallon
 
       @session.on(:music_delivery) do |format, frames, num_frames|
         trigger(:music_delivery, format, frames, num_frames)
-        num_frames # assume we consume all data
       end
     end
 

data/lib/hallon/playlist.rb

@@ -27,7 +27,7 @@ module Hallon
         @seen        = Spotify.playlist_track_seen(playlist.pointer, index)
         @creator     = begin
           creator = Spotify.playlist_track_creator!(playlist.pointer, index)
-          User.new(creator) unless creator.null?
+          User.from(creator)
         end
       end
 
@@ -181,7 +181,7 @@ module Hallon
     # @return [User, nil]
     def owner
       user = Spotify.playlist_owner!(pointer)
-      User.new(user) unless user.null?
+      User.from(user)
     end
 
     # @return [String]
@@ -253,7 +253,7 @@ module Hallon
     def tracks
       Enumerator.new(size) do |index|
         track = Spotify.playlist_track!(pointer, index)
-        Playlist::Track.new(track, self, index) unless track.null?
+        Playlist::Track.from(track, self, index)
       end
     end
 

data/lib/hallon/playlist_container.rb

@@ -91,7 +91,7 @@ module Hallon
     # @return [User, nil] owner of the container (nil if unknown or no owner).
     def owner
       owner = Spotify.playlistcontainer_owner!(pointer)
-      User.new(owner) unless owner.null?
+      User.from(owner)
     end
 
     # @return [Integer] number of playlists and folders in this container.
@@ -145,7 +145,7 @@ module Hallon
         Spotify.playlistcontainer_add_playlist!(pointer, link.pointer)
       end
 
-      Playlist.new(playlist) unless playlist.null?
+      Playlist.from(playlist)
     end
 
     # Create a new folder with the given name at the end of the container.
@@ -193,27 +193,52 @@ module Hallon
 
     # Move a playlist or a folder.
     #
+    # @example an illustration of how contents are moved
+    #   # given a container like this:
+    #   # A, B, C, D
+    #
+    #   container.move(0, 1)
+    #     # => B, A, C, D
+    #
+    #   container.move(0, 3)
+    #     # => B, C, D, A
+    #
+    #   container.move(3, 1)
+    #     # => A, D, B, C
+    #
     # @note If moving a folder, only that end of the folder is moved. The folder
     #       size will change!
-    #
-    # @param [Integer] from
-    # @param [Integer] to
-    # @param [Boolean] dry_run don’t really move anything (useful to check if it can be moved)
+    # @param [Integer] from index to move from
+    # @param [Integer] to index the item will end up at
     # @return [Playlist, Folder] the entity that was moved
     # @raise [Error] if the operation failed
-    def move(from, to, dry_run = false)
-      error = Spotify.playlistcontainer_move_playlist(pointer, from, to, !! dry_run)
+    def move(from, to)
+      error = move_playlist(from, to, false)
+      Error.maybe_raise(error)
+      contents[to]
+    end
 
-      if dry_run
-        error, symbol = Error.disambiguate(error)
-        symbol == :ok
-      else
-        Error.maybe_raise(error)
-        contents[from > to ? to : to - 1]
-      end
+    # Control if if the item at index `from` can be moved to `infront_of`.
+    #
+    # @param (see #move)
+    # @return [Boolean] true if the operation can be performed
+    def can_move?(from, to)
+      error = move_playlist(from, to, true)
+      number, symbol = Error.disambiguate(error)
+      symbol == :ok
     end
 
     protected
+      # Wrapper for original API; adjusts indices accordingly.
+      #
+      # @param [Integer] from
+      # @param [Integer] from
+      # @return [Integer] error
+      def move_playlist(from, infront_of, dry_run)
+        infront_of += 1 if from < infront_of
+        Spotify.playlistcontainer_move_playlist(pointer, from, infront_of, dry_run)
+      end
+
       # Given an index, find out the starting point and ending point
       # of the folder at that index.
       #
@@ -247,9 +272,5 @@ module Hallon
       def folder_id(index)
         Spotify.playlistcontainer_playlist_folder_id(pointer, index)
       end
-
-    # playlistcontainer_remove_playlist
-    # playlistcontainer_move_playlist
-    # playlistcontainer_add_folder (#insert)
   end
 end

data/lib/hallon/search.rb

@@ -129,7 +129,7 @@ module Hallon
     # @return [Link] link for this search query.
     def to_link
       link = Spotify.link_create_from_search!(pointer)
-      Link.new(link) unless link.null?
+      Link.from(link)
     end
   end
 end

data/lib/hallon/session.rb

@@ -130,7 +130,7 @@ module Hallon
     # @return [PlaylistContainer, nil]
     def container
       container = Spotify.session_playlistcontainer!(pointer)
-      PlaylistContainer.new(container) unless container.null?
+      PlaylistContainer.from(container)
     end
 
     # Process pending Spotify events (might fire callbacks).
@@ -160,6 +160,7 @@ module Hallon
         loop do
           begin
             timeout = [process_events.fdiv(1000), 5].min # scope to five seconds
+            timeout = timeout + 0.010 # minimum of ten miliseconds timeout
             params = Timeout::timeout(timeout) { channel.pop }
             redo if params == :notify
           rescue Timeout::Error
@@ -252,7 +253,7 @@ module Hallon
     # @return [User] the User currently logged in.
     def user
       user = Spotify.session_user!(pointer)
-      User.new(user) unless user.null?
+      User.from(user)
     end
 
     # @return [Symbol] current connection status.
@@ -364,14 +365,14 @@ module Hallon
     # @return [Playlist, nil] currently logged in user’s starred playlist.
     def starred
       playlist = Spotify.session_starred_create!(pointer)
-      Playlist.new(playlist) unless playlist.null?
+      Playlist.from(playlist)
     end
 
     # @note Returns nil when no user is logged in.
     # @return [Playlist, nil] currently logged in user’s inbox playlist.
     def inbox
       playlist = Spotify.session_inbox_create!(pointer)
-      Playlist.new(playlist) unless playlist.null?
+      Playlist.from(playlist)
     end
 
     # @see #status

data/lib/hallon/track.rb

@@ -132,7 +132,7 @@ module Hallon
     # @return [Hallon::Album] album this track belongs to.
     def album
       album = Spotify.track_album!(pointer)
-      Album.new(album) unless album.null?
+      Album.from(album)
     end
 
     # @note There may be more than one artist, see {#artists} for retrieving them all!

data/lib/hallon/user.rb

@@ -76,14 +76,14 @@ module Hallon
     # @return [Playlist, nil] starred playlist of the User.
     def starred
       playlist = Spotify.session_starred_for_user_create!(session.pointer, name)
-      Playlist.new(playlist) unless playlist.null?
+      Playlist.from(playlist)
     end
 
     # @note Returns nil unless {#loaded?}
     # @return [PlaylistContainer, nil] published playlists of the User.
     def published
       container = Spotify.session_publishedcontainer_for_user_create!(session.pointer, name)
-      PlaylistContainer.new(container) unless container.null?
+      PlaylistContainer.from(container)
     end
 
     # Send tracks to this users’ inbox, with an optional message.

data/lib/hallon/version.rb

@@ -3,5 +3,5 @@ module Hallon
   # Current release version of Hallon
   #
   # @see http://semver.org/
-  VERSION = [0, 10, 1].join('.')
+  VERSION = [0, 11, 0].join('.')
 end

data/spec/hallon/base_spec.rb

@@ -0,0 +1,38 @@
+describe Hallon::Base do
+  let(:klass) do
+    Class.new(Hallon::Base) do
+      def initialize(pointer)
+        @pointer = pointer
+      end
+    end
+  end
+
+  describe ".from" do
+    it "should return a new object if given pointer is not null" do
+      a_pointer.should_receive(:null?).and_return(false)
+      klass.from(a_pointer).should_not be_nil
+    end
+
+    it "should return nil if given pointer is null" do
+      a_pointer.should_receive(:null?).and_return(true)
+      klass.from(a_pointer).should be_nil
+    end
+  end
+
+  describe "#==" do
+    it "should compare the pointers if applicable" do
+      one = klass.new(a_pointer)
+      two = klass.new(a_pointer)
+
+      one.should eq two
+    end
+
+    it "should fall back to default object comparison" do
+      one = klass.new(a_pointer)
+      two = klass.new(a_pointer)
+      two.stub(:respond_to?).and_return(false)
+
+      one.should_not eq two
+    end
+  end
+end

data/spec/hallon/link_spec.rb

@@ -11,8 +11,8 @@ describe Hallon::Link do
         expect { Hallon::Link.new("spotify:user:burgestrand") }.to_not raise_error
       end
 
-      it "should accept an FFI pointer" do
-        expect { Hallon::Link.new(Spotify::Pointer.new(null_pointer, :link, false)) }.to raise_error(ArgumentError, /is not a valid spotify link/)
+      it "should raise an error given a null pointer" do
+        expect { Hallon::Link.new(Spotify::Pointer.new(null_pointer, :link, false)) }.to raise_error(ArgumentError)
       end
 
       it "should raise an error when no session instance is about" do

data/spec/hallon/playlist_container_spec.rb

@@ -121,24 +121,24 @@ describe Hallon::PlaylistContainer do
       playlist = container.contents[0]
 
       container.contents.map(&:class).should eq [Hallon::Playlist, Hallon::PlaylistContainer::Folder, Hallon::PlaylistContainer::Folder]
-      container.move(0, 2).should eq playlist
+      container.move(0, 1).should eq playlist
       container.contents.map(&:class).should eq [Hallon::PlaylistContainer::Folder, Hallon::Playlist, Hallon::PlaylistContainer::Folder]
       container.move(1, 0).should eq playlist
       container.contents.map(&:class).should eq [Hallon::Playlist, Hallon::PlaylistContainer::Folder, Hallon::PlaylistContainer::Folder]
     end
 
-    it "should not do anything if it’s a dry-run operation" do
-      container.contents.map(&:class).should eq [Hallon::Playlist, Hallon::PlaylistContainer::Folder, Hallon::PlaylistContainer::Folder]
-      container.move(0, 2, :dry_run).should be_true
-      container.contents.map(&:class).should eq [Hallon::Playlist, Hallon::PlaylistContainer::Folder, Hallon::PlaylistContainer::Folder]
+    it "should raise an error if the operation failed" do
+      expect { container.move(0, -1) }.to raise_error(Hallon::Error)
     end
+  end
 
-    it "should not raise an error for an invalid operation when dry_run is active" do
-      container.move(0, -1, :dry_run).should be_false
+  describe "#can_move?" do
+    it "should be true if the operation can be performed" do
+      expect { container.can_move?(0, 1).should be_true }.to_not change { container.contents.to_a }
     end
 
-    it "should raise an error if the operation failed" do
-      expect { container.move(0, -1) }.to raise_error(Hallon::Error)
+    it "should be false if the operation cannot be performed" do
+      expect { container.can_move?(0, -1).should be_false }.to_not change { container.contents.to_a }
     end
   end
 
@@ -172,7 +172,7 @@ describe Hallon::PlaylistContainer do
         folder.should_not be_moved
         container.move(folder.begin, 0).id.should eq folder.id
         folder.should be_moved
-        container.move(0, 2).id.should eq folder.id
+        container.move(0, 1).id.should eq folder.id
         folder.should_not be_moved
       end
     end

data/spec/support/common_objects.rb

@@ -104,6 +104,7 @@ RSpec::Core::ExampleGroup.instance_eval do
   let(:mock_image_hex) { "3ad93423add99766e02d563605c6e76ed2b0e450" }
   let(:mock_image_id)  { ":\xD94#\xAD\xD9\x97f\xE0-V6\x05\xC6\xE7n\xD2\xB0\xE4P".force_encoding("BINARY") }
   let(:null_pointer)   { FFI::Pointer.new(0) }
+  let(:a_pointer)      { FFI::Pointer.new(1) }
 
   let(:mock_offline_sync_status) do
     sync = Spotify::OfflineSyncStatus.new

data/spec/support/shared_for_linkable_objects.rb

@@ -13,7 +13,7 @@ shared_examples_for "a Linkable object" do
     end
 
     it "should fail with an invalid spotify pointer" do
-      expect { described_class.new("i_am_invalid_uri") }.to raise_error(ArgumentError, /not a valid spotify \w+ URI or pointer/)
+      expect { described_class.new("i_am_invalid_uri") }.to raise_error(ArgumentError, /could not be converted to a spotify \w+ pointer/)
     end
 
     it "should work with a Link object" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hallon
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-30 00:00:00.000000000 Z
+date: 2011-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spotify
-  requirement: &70214553379640 !ruby/object:Gem::Requirement
+  requirement: &70296624265220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 10.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *70214553379640
+  version_requirements: *70296624265220
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70214553395220 !ruby/object:Gem::Requirement
+  requirement: &70296624264760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70214553395220
+  version_requirements: *70296624264760
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70214553394740 !ruby/object:Gem::Requirement
+  requirement: &70296624264300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *70214553394740
+  version_requirements: *70296624264300
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70214553394240 !ruby/object:Gem::Requirement
+  requirement: &70296619129680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *70214553394240
+  version_requirements: *70296619129680
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70214553393680 !ruby/object:Gem::Requirement
+  requirement: &70296619126080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70214553393680
+  version_requirements: *70296619126080
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70214553393200 !ruby/object:Gem::Requirement
+  requirement: &70296619124020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,14 +76,13 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70214553393200
+  version_requirements: *70296619124020
 description: 
 email: kim@burgestrand.se
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .autotest
 - .gemtest
 - .gitignore
 - .gitmodules
@@ -131,6 +130,7 @@ files:
 - spec/hallon/album_spec.rb
 - spec/hallon/artist_browse_spec.rb
 - spec/hallon/artist_spec.rb
+- spec/hallon/base_spec.rb
 - spec/hallon/enumerator_spec.rb
 - spec/hallon/error_spec.rb
 - spec/hallon/ffi_spec.rb
@@ -202,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.12
 signing_key: 
 specification_version: 3
 summary: Hallon allows you to write Ruby applications utilizing the official Spotify
@@ -214,6 +214,7 @@ test_files:
 - spec/hallon/album_spec.rb
 - spec/hallon/artist_browse_spec.rb
 - spec/hallon/artist_spec.rb
+- spec/hallon/base_spec.rb
 - spec/hallon/enumerator_spec.rb
 - spec/hallon/error_spec.rb
 - spec/hallon/ffi_spec.rb

data/.autotest

@@ -1,6 +0,0 @@
-require 'autotest/rspec2'
-require 'autotest/growl'
-require 'autotest/fsevent' rescue nil
-
-Autotest::add_discovery { 'rspec2' }
-Autotest::Growl::image_dir = 'ampelmaennchen'