ffi-coremidi 0.2.0 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0cd3edc0360a57ce8923b96a96f88e61b050ffd
+  data.tar.gz: 38f95b91e6ef5a5e34628dd56d024101062e7ed4
+SHA512:
+  metadata.gz: 46c3ff9c2e946688b0b5f92cb10a0b5062fe90afedcfde912e1fc89b955774ea924da28b3bb01db123615ed93b4218938ddcb149ae55608373e810e451847ef5
+  data.tar.gz: 3e4ccf3a0c4362908c5273f71a11ec989d2abce5fc7f9eb5d3204ebf4f5405561aa331d74a7545d44f2a5555017c906cf1ce48da240b3ee5fda13d656d163fcc

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2011-2013 Ari Russo
+Copyright 2011-2014 Ari Russo
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -2,7 +2,7 @@
 
 #### Realtime MIDI IO with Ruby for OSX
 
-This is a Ruby implementation of the Apple Core MIDI framework API.
+This is a Ruby implementation of the [Apple Core MIDI framework API](https://developer.apple.com/library/mac/#documentation/MusicAudio/Reference/CACoreMIDIRef/MIDIServices/).
 
 Note that in the interest of allowing people on other platforms to utilize your code, please consider using [UniMIDI](http://github.com/arirusso/unimidi).  UniMIDI is a platform independent wrapper which implements this library with a similar API.
 
@@ -18,7 +18,7 @@ Note that in the interest of allowing people on other platforms to utilize your
 
 * [ffi](http://github.com/ffi/ffi)
 
-### Install
+### Installation
 
 If you're using Bundler, add this line to your application's Gemfile:
 
@@ -48,4 +48,4 @@ Also thank you to [Jeremy Voorhis](http://github.com/jvoorhis) for some useful d
 
 Apache 2.0, See the file LICENSE
 
-Copyright (c) 2011-2013 [Ari Russo](http://github.com/arirusso)
+Copyright (c) 2011-2014 [Ari Russo](http://github.com/arirusso)

data/lib/coremidi.rb

@@ -1,21 +1,22 @@
 # ffi-coremidi
+#
 # Realtime MIDI IO with Ruby for OSX
-# (c)2011-2013 Ari Russo
+# (c)2011-2014 Ari Russo
 
 # libs
-require 'ffi'
-require 'forwardable'
+require "ffi"
+require "forwardable"
 
 # modules
-require 'coremidi/endpoint'
-require 'coremidi/map'
+require "coremidi/endpoint"
+require "coremidi/map"
 
 # classes
-require 'coremidi/entity'
-require 'coremidi/device'
-require 'coremidi/source'
-require 'coremidi/destination'
+require "coremidi/entity"
+require "coremidi/device"
+require "coremidi/source"
+require "coremidi/destination"
 
 module CoreMIDI
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/coremidi/destination.rb

@@ -19,6 +19,7 @@ module CoreMIDI
       until (str = data.slice!(0,2)).eql?("")
       	output << str.hex
       end
+
       puts_bytes(*output)
     end
     alias_method :puts_bytestr, :puts_s

data/lib/coremidi/source.rb

@@ -8,45 +8,51 @@ module CoreMIDI
     attr_reader :buffer
 
     #
-    # returns an array of MIDI event hashes as such:
+    # An array of MIDI event hashes as such:
     #   [
     #     { :data => [144, 60, 100], :timestamp => 1024 },
     #     { :data => [128, 60, 100], :timestamp => 1100 },
     #     { :data => [144, 40, 120], :timestamp => 1200 }
     #   ]
     #
-    # the data is an array of Numeric bytes
-    # the timestamp is the number of millis since this input was enabled
+    # The data is an array of Numeric bytes
+    # The timestamp is the number of millis since this input was enabled
     #
+    # @return [Array<Hash>]
     def gets
       until queued_messages?
+        # per https://github.com/arirusso/unimidi/issues/20#issuecomment-44761318
+        sleep(0.0001) # patch to prevent 100% CPU issue with some midi controllers
       end
-      msgs = queued_messages
+      messages = queued_messages
       @pointer = @buffer.length
-      msgs
+      messages
     end
     alias_method :read, :gets
 
-    # same as gets but returns message data as string of hex digits as such:
+    # Same as Source#gets except that it returns message data as string of hex 
+    # digits as such:
     #   [
     #     { :data => "904060", :timestamp => 904 },
     #     { :data => "804060", :timestamp => 1150 },
     #     { :data => "90447F", :timestamp => 1300 }
     #   ]
     #
-    #
+    # @return [Array<Hash>]
     def gets_s
-      msgs = gets
-      msgs.each { |msg| msg[:data] = numeric_bytes_to_hex_string(msg[:data]) }
-      msgs
+      messages = gets
+      messages.each do |message| 
+        message[:data] = numeric_bytes_to_hex_string(message[:data])
+      end
+      messages
     end
     alias_method :gets_bytestr, :gets_s
 
-    # enable this the input for use; can be passed a block
+    # Enable this the input for use; can be passed a block
     def enable(options = {}, &block)
       @enabled = true
 
-      unless block.nil?
+      if block_given?
         begin
           yield(self)
         ensure
@@ -70,6 +76,7 @@ module CoreMIDI
       #error = Map.MIDIEndpointDispose(@resource)
       #raise "MIDIEndpointDispose returned error code #{error}" unless error.zero?
       @enabled = false
+      true
     end
 
     # Shortcut to the first available input endpoint
@@ -140,12 +147,15 @@ module CoreMIDI
 
     # Timestamp for a received MIDI message
     def timestamp(now)
-      ((now - @start_time) * 1000)
+      (now - @start_time) * 1000
     end
 
     # Give a message its timestamp and package it in a Hash
     def get_message_formatted(raw, time)
-      { :data => raw, :timestamp => timestamp(time) }
+      { 
+        :data => raw, 
+        :timestamp => timestamp(time) 
+      }
     end
 
     # Initialize a coremidi port for this endpoint
@@ -156,6 +166,7 @@ module CoreMIDI
       error = Map.MIDIInputPortCreate(@client, port_name, @callback, nil, handle_ptr)
       @handle = handle_ptr.read_pointer
       raise "MIDIInputPortCreate returned error code #{error}" unless error.zero?
+      true
     end
     
     # Initialize the MIDI message buffer
@@ -165,12 +176,18 @@ module CoreMIDI
       def @buffer.clear
         super
         @pointer = 0
-      end     
+      end
+      true
     end
     
     # Convert an array of numeric byes to a hex string (e.g. [0x90, 0x40, 0x40] becomes "904040")
     def numeric_bytes_to_hex_string(bytes)
-      bytes.map { |b| s = b.to_s(16).upcase; b < 16 ? s = "0" + s : s; s }.join
+      string_bytes = bytes.map do |byte| 
+        str = byte.to_s(16).upcase
+        str = "0" + str if byte < 16
+        str
+      end
+      string_bytes.join
     end 
 
   end

data/test/helper.rb

@@ -1,10 +1,10 @@
-#!/usr/bin/env ruby
-
 dir = File.dirname(File.expand_path(__FILE__))
-$LOAD_PATH.unshift dir + '/../lib'
+$LOAD_PATH.unshift dir + "/../lib"
 
-require 'test/unit'
-require 'coremidi'
+require "test/unit"
+require "mocha/test_unit"
+require "shoulda-context"
+require "coremidi"
 
 module TestHelper
   
@@ -55,4 +55,4 @@ module TestHelper
     
 end
 
-TestHelper.select_devices
+TestHelper.select_devices

data/test/{test_input_buffer.rb → input_buffer_test.rb}

@@ -1,6 +1,4 @@
-#!/usr/bin/env ruby
-
-require 'helper'
+require "helper"
 
 class InputBufferTest < Test::Unit::TestCase
 
@@ -42,4 +40,4 @@ class InputBufferTest < Test::Unit::TestCase
     end
   end
 
-end
+end

data/test/io_test.rb

@@ -0,0 +1,90 @@
+require 'helper'
+
+class CoreMIDI::IOTest < Test::Unit::TestCase
+
+  # ** these tests assume that TestOutput is connected to TestInput
+  context "CoreMIDI" do
+
+    setup do
+      sleep(1)
+    end
+
+    context "full IO" do
+
+      context "using Arrays" do
+
+        setup do
+          @messages = TestHelper::VariousMIDIMessages
+          @messages_arr = @messages.inject { |a,b| a+b }.flatten
+          @received_arr = []
+          @pointer = 0
+        end
+
+        should "do IO" do
+          $test_device[:output].open do |output|
+            $test_device[:input].open do |input|
+
+              input.buffer.clear
+
+              @messages.each do |msg|
+
+                $>.puts "sending: " + msg.inspect
+
+                output.puts(msg)
+                sleep(1)
+                received = input.gets.map { |m| m[:data] }.flatten
+
+                $>.puts "received: " + received.inspect
+
+                assert_equal(@messages_arr.slice(@pointer, received.length), received)
+                @pointer += received.length
+                @received_arr += received
+              end
+              assert_equal(@messages_arr.length, @received_arr.length)
+            end
+          end
+
+        end
+      end
+
+      context "using byte Strings" do
+
+        setup do
+          @messages = TestHelper::VariousMIDIByteStrMessages
+          @messages_str = @messages.join
+          @received_str = ""
+          @pointer = 0
+        end
+
+        should "do IO" do
+          $test_device[:output].open do |output|
+            $test_device[:input].open do |input|
+
+              @messages.each do |msg|
+
+                $>.puts "sending: " + msg.inspect
+
+                output.puts(msg)
+                sleep(1)
+                received = input.gets_bytestr.map { |m| m[:data] }.flatten.join
+                $>.puts "received: " + received.inspect
+
+                assert_equal(@messages_str.slice(@pointer, received.length), received)
+                @pointer += received.length
+                @received_str += received
+              end
+              assert_equal(@messages_str, @received_str)
+
+            end
+          end
+
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,73 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: ffi-coremidi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors:
 - Ari Russo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-08 00:00:00.000000000 Z
+date: 2014-08-31 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.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Realtime MIDI IO with Ruby for OSX
+description: Perform realtime MIDI IO with Ruby for OSX
 email:
 - ari.russo@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- lib/coremidi.rb
 - lib/coremidi/destination.rb
 - lib/coremidi/device.rb
 - lib/coremidi/endpoint.rb
 - lib/coremidi/entity.rb
 - lib/coremidi/map.rb
 - lib/coremidi/source.rb
-- lib/coremidi.rb
 - test/helper.rb
-- test/test_input_buffer.rb
-- test/test_io.rb
-- LICENSE
-- README.md
+- test/input_buffer_test.rb
+- test/io_test.rb
 homepage: http://github.com/arirusso/ffi-coremidi
-licenses: []
+licenses:
+- Apache 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: ffi-coremidi
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Realtime MIDI IO with Ruby for OSX
 test_files: []

data/test/test_io.rb

@@ -1,83 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'helper'
-
-class IoTest < Test::Unit::TestCase
-
-  include CoreMIDI
-  include TestHelper
-
-  def test_full_io
-    sleep(2)
-    messages = VariousMIDIMessages
-    messages_arr = messages.inject { |a,b| a+b }.flatten
-    received_arr = []
-    pointer = 0
-    $test_device[:output].open do |output|
-      $test_device[:input].open do |input|
-        
-        input.buffer.clear
-
-        messages.each do |msg|
-
-          $>.puts "sending: " + msg.inspect
-
-          output.puts(msg)
-          sleep(1)
-          received = input.gets.map { |m| m[:data] }.flatten
-          
-          $>.puts "received: " + received.inspect
-
-          assert_equal(messages_arr.slice(pointer, received.length), received)
-          
-          pointer += received.length
-          
-          received_arr += received
-          
-        end
-        
-        assert_equal(messages_arr.length, received_arr.length)
-
-      end
-    end
-  end
-
-  # ** this test assumes that TestOutput is connected to TestInput
-  def test_full_io_bytestr
-    sleep(2) # pause between tests
-
-    messages = VariousMIDIByteStrMessages
-    messages_str = messages.join
-    received_str = ""
-    pointer = 0
-
-    $test_device[:output].open do |output|
-      $test_device[:input].open do |input|
-        
-        input.buffer.clear
-
-        messages.each do |msg|
-
-          $>.puts "sending: " + msg.inspect
-
-          output.puts_s(msg)
-          sleep(1)
-          received = input.gets_bytestr.map { |m| m[:data] }.flatten.join
-          $>.puts "received: " + received.inspect
-
-          assert_equal(messages_str.slice(pointer, received.length), received)
-          
-          pointer += received.length
-          
-          received_str += received
-          
-        end
-   
-        assert_equal(messages_str, received_str)
-        
-      end
-    end
-
-  end
-
-end