spotify 10.2.2 → 10.3.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+[v10.3.0][]
+-----------
+- map :image_id to a ruby string instead of a pointer
+
 [v10.2.2][]
 -----------
 - allow non-UTF8 strings for link_create_from_string and login password
@@ -85,6 +89,7 @@ v0.0.0
 ------
 - release to register rubygems.org name
 
+[v10.3.0]: https://github.com/Burgestrand/libspotify-ruby/compare/v10.2.2...v10.3.0
 [v10.2.2]: https://github.com/Burgestrand/libspotify-ruby/compare/v10.2.1...v10.2.2
 [v10.2.1]: https://github.com/Burgestrand/libspotify-ruby/compare/v10.2.0...v10.2.1
 [v10.2.0]: https://github.com/Burgestrand/libspotify-ruby/compare/v10.1.1...v10.2.0

data/lib/spotify.rb

@@ -35,6 +35,28 @@ module Spotify
     end
   end
 
+  module ImageID
+    extend FFI::DataConverter
+    native_type FFI::Type::POINTER
+
+    def self.to_native(value, ctx)
+      pointer = if value
+        if value.bytesize != 20
+          raise ArgumentError, "image id bytesize must be 20, was #{value.bytesize}"
+        end
+
+        pointer = FFI::MemoryPointer.new(:char, 20)
+        pointer.write_string(value.to_s)
+      end
+
+      super(pointer, ctx)
+    end
+
+    def self.from_native(value, ctx)
+      value.read_string(20) unless value.null?
+    end
+  end
+
   # Override FFI::Library#attach_function to always add the `:blocking` option.
   #
   # The reason for this is that which libspotify functions may call callbacks
@@ -69,10 +91,10 @@ module Spotify
   typedef :pointer, :inbox
 
   typedef :pointer, :userdata
-  typedef :pointer, :image_id
   typedef :pointer, :array
 
   typedef UTF8String, :utf8_string
+  typedef ImageID, :image_id
 
   #
   # Error
@@ -584,7 +606,7 @@ module Spotify
   attach_function :playlist_set_collaborative, :sp_playlist_set_collaborative, [ :playlist, :bool ], :void
   attach_function :playlist_set_autolink_tracks, :sp_playlist_set_autolink_tracks, [ :playlist, :bool ], :void
   attach_function :playlist_get_description, :sp_playlist_get_description, [ :playlist ], :utf8_string
-  attach_function :playlist_get_image, :sp_playlist_get_image, [ :playlist, :image_id ], :bool
+  attach_function :playlist_get_image, :sp_playlist_get_image, [ :playlist, :buffer_out ], :bool
   attach_function :playlist_has_pending_changes, :sp_playlist_has_pending_changes, [ :playlist ], :bool
   attach_function :playlist_add_tracks, :sp_playlist_add_tracks, [ :playlist, :array, :int, :int, :session ], :error
   attach_function :playlist_remove_tracks, :sp_playlist_remove_tracks, [ :playlist, :array, :int ], :error

data/lib/spotify/version.rb

@@ -1,4 +1,4 @@
 module Spotify
   # See README for versioning policy.
-  VERSION = [10, 2, 2].join('.')
+  VERSION = [10, 3, 0].join('.')
 end

data/spec/spotify_spec.rb

@@ -24,6 +24,12 @@ module Spotify
     super
   end
 
+  def resolve_type(type)
+    type = find_type(type)
+    type = type.type if type.respond_to?(:type)
+    type
+  end
+
   attr_reader :attached_methods
 end
 
@@ -129,6 +135,51 @@ describe Spotify do
       result.bytesize.must_equal 1
     end unless "".respond_to?(:force_encoding)
   end
+
+  describe "Image ID" do
+    let(:context) { nil }
+    let(:subject) { Spotify.find_type(:image_id) }
+    let(:null_pointer) { FFI::Pointer::NULL }
+
+    let(:image_id_pointer) do
+      pointer = FFI::MemoryPointer.new(:char, 20)
+      pointer.write_string(image_id)
+      pointer
+    end
+
+    let(:image_id) do
+      # deliberate NULL in middle of string
+      image_id = ":\xD94#\xAD\xD9\x97f\xE0\x00V6\x05\xC6\xE7n\xD2\xB0\xE4P"
+      image_id.force_encoding("BINARY") if image_id.respond_to?(:force_encoding)
+      image_id
+    end
+
+    describe "from_native" do
+      it "should be nil given a null pointer" do
+        subject.from_native(null_pointer, context).must_be_nil
+      end
+
+      it "should be an image id given a non-null pointer" do
+        subject.from_native(image_id_pointer, context).must_equal image_id
+      end
+    end
+
+    describe "to_native" do
+      it "should be a null pointer given nil" do
+        subject.to_native(nil, context).must_be_nil
+      end
+
+      it "should be a 20-byte C string given an actual string" do
+        pointer = subject.to_native(image_id, context)
+        pointer.read_string(20).must_equal image_id_pointer.read_string(20)
+      end
+
+      it "should raise an error given more or less than a 20 byte string" do
+        proc { subject.to_native(image_id + image_id, context) }.must_raise ArgumentError
+        proc { subject.to_native(image_id[0..10], context) }.must_raise ArgumentError
+      end
+    end
+  end
 end
 
 describe "functions" do
@@ -140,7 +191,7 @@ describe "functions" do
       return case type.to_cpp
         when "const char*"
           :utf8_string
-        when /\A(::)?(char|int|size_t|sp_session\*)\*/
+        when /\A(::)?(char|int|size_t|sp_session\*|byte)\*/
           return_type ? :pointer : :buffer_out
         when /::(.+_cb)\*/
           $1.to_sym
@@ -169,15 +220,15 @@ describe "functions" do
         current = Spotify.attached_methods[attached_name][:returns]
         actual  = type_of(func.return_type, true)
 
-        Spotify.find_type(current).must_equal Spotify.find_type(actual)
+        Spotify.resolve_type(current).must_equal Spotify.resolve_type(actual)
       end
 
       it "should expect the correct types of arguments" do
         current = Spotify.attached_methods[attached_name][:args]
         actual  = func.arguments.map { |arg| type_of(arg.cpp_type) }
 
-        current = current.map { |x| Spotify.find_type(x) }
-        actual  = actual.map  { |x| Spotify.find_type(x) }
+        current = current.map { |x| Spotify.resolve_type(x) }
+        actual  = actual.map  { |x| Spotify.resolve_type(x) }
 
         current.must_equal actual
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spotify
 version: !ruby/object:Gem::Version
-  version: 10.2.2
+  version: 10.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-18 00:00:00.000000000 Z
+date: 2011-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &70189454769560 !ruby/object:Gem::Requirement
+  requirement: &70144148345660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -24,10 +24,10 @@ dependencies:
         version: 1.0.11
   type: :runtime
   prerelease: false
-  version_requirements: *70189454769560
+  version_requirements: *70144148345660
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70189454783740 !ruby/object:Gem::Requirement
+  requirement: &70144148344940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70189454783740
+  version_requirements: *70144148344940
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70189454781600 !ruby/object:Gem::Requirement
+  requirement: &70144148344440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +46,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70189454781600
+  version_requirements: *70144148344440
 - !ruby/object:Gem::Dependency
   name: rbgccxml
-  requirement: &70189454776900 !ruby/object:Gem::Requirement
+  requirement: &70144148343820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +57,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70189454776900
+  version_requirements: *70144148343820
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70189454791160 !ruby/object:Gem::Requirement
+  requirement: &70144148343120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,7 +68,7 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70189454791160
+  version_requirements: *70144148343120
 description: ! "    Spotify for Ruby is a primitive wrapper around libspotify using
   Ruby FFI.\n    If all you want is libspotify for Ruby, you should probably use at
   Hallon\n    instead: https://rubygems.org/gems/hallon\n"