unimidi 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fa827114029d69f1567ba44b38c9ba4247849722
-  data.tar.gz: a6f6e46bcf1f1a6b8bd6fc3d01c668b73c65c5e1
+SHA256:
+  metadata.gz: 8a01014709788ce8d62b5331aa871210c5b52caf3172fa88abf737ea0ab1da6e
+  data.tar.gz: 2afe488142025675ce6fcf6413183a4b354b091215199bccecb46fa92b3c0400
 SHA512:
-  metadata.gz: bb35485c5cd885ef8f58bad93adb17a94079885ac3b4b0bed8801c77059025d6e7078589f05a0bea85f8284c59f96bbfeef7c01d17e4f1e6e4a50cfa4fddc40b
-  data.tar.gz: b084ffb6e4829d4fb08b33169c03247dd9f4e8ec2e8ed22341194bc2f91fd24f56507e0b02a1fa69006d085383db9eae4e6aebe8d71ad10a826e87dfcfe0d5dd
+  metadata.gz: cb09c7b5e9ba139f3e4161c2881af05ae6e0536857001118d41e47b611322e093a562995bd3840cc82790d1a84ad8317533948b7f6d098460a7eb1922ecda532
+  data.tar.gz: 954b97c19189b650ab55643d99989d4b88603938f762cf0289f6360672c6174e753202086ad24acd3cdf955db4191fcdda0f256eb1cb18c180389de204e55095

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2010-2014 Ari Russo
+Copyright 2010-2022 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

@@ -16,7 +16,7 @@ Also see [MicroMIDI](http://github.com/arirusso/micromidi) which builds a full M
 
 Using Ruby 1.9.2 or JRuby 1.6.1 (or newer) is strongly recommended.  JRuby should be run in 1.9 mode where applicable
 
-UniMIDI uses one of the following libraries, depending on which platform you're using it on.  The necessary library should install automatically with the unimidi gem. 
+UniMIDI uses one of the following libraries, depending on which platform you're using it on.  The necessary library should install automatically with the unimidi gem.
 
 Platform
 
@@ -24,7 +24,7 @@ Platform
 * Linux: [alsa-rawmidi](http://github.com/arirusso/alsa-rawmidi)
 * OSX: [ffi-coremidi](http://github.com/arirusso/ffi-coremidi)
 * Windows/Cygwin: [midi-winmm](http://github.com/arirusso/midi-winmm)
-	
+
 ### Install
 
 If you're using Bundler, add this line to your application's Gemfile:
@@ -34,7 +34,7 @@ If you're using Bundler, add this line to your application's Gemfile:
 Otherwise...
 
 `gem install unimidi`
-	
+
 ### Usage
 
 ##### Blog Posts
@@ -75,13 +75,13 @@ See below for additional notes on testing with JRuby
 ##### Linux
 
 * *libasound* and *libasound-dev* packages are required
-	
-### Author 
+
+### Author
 
 [Ari Russo](http://github.com/arirusso) <ari.russo at gmail.com>
-		
+
 ### License
 
 Apache 2.0, See the file LICENSE
 
-Copyright (c) 2010-2014 Ari Russo  
+Copyright (c) 2010-2022 Ari Russo  

data/lib/unimidi/adapter/alsa-rawmidi.rb

@@ -1,15 +1,13 @@
-require "alsa-rawmidi"
+# frozen_string_literal: true
 
-module UniMIDI
+require 'alsa-rawmidi'
 
+module UniMIDI
   module Adapter
-
     # Load underlying devices using the alsa-rawmidi gem
     module AlsaRawMIDI
-
       module Loader
-
-        extend self
+        module_function
 
         # @return [Array<AlsaRawMIDI::Input>]
         def inputs
@@ -20,11 +18,7 @@ module UniMIDI
         def outputs
           ::AlsaRawMIDI::Device.all_by_type[:output]
         end
-
       end
-
     end
-
   end
-
 end

data/lib/unimidi/adapter/ffi-coremidi.rb

@@ -1,15 +1,13 @@
-require "coremidi"
+# frozen_string_literal: true
 
-module UniMIDI
+require 'coremidi'
 
+module UniMIDI
   module Adapter
-
     # Load underlying devices using the coremidi gem
     module CoreMIDI
-
       module Loader
-
-        extend self
+        module_function
 
         # @return [Array<CoreMIDI::Source>]
         def inputs
@@ -20,11 +18,7 @@ module UniMIDI
         def outputs
           ::CoreMIDI::Endpoint.all_by_type[:destination]
         end
-
       end
-
     end
-
   end
-
 end

data/lib/unimidi/adapter/midi-jruby.rb

@@ -1,15 +1,13 @@
-require "midi-jruby"
+# frozen_string_literal: true
 
-module UniMIDI
+require 'midi-jruby'
 
+module UniMIDI
   module Adapter
-
     # Load underlying devices using the midi-jruby gem
     module MIDIJRuby
-
       module Loader
-
-        extend self
+        module_function
 
         # @return [Array<MIDIJRuby::Input>]
         def inputs
@@ -20,11 +18,7 @@ module UniMIDI
         def outputs
           ::MIDIJRuby::Device.all_by_type[:output]
         end
-
       end
-
     end
-
   end
-
 end

data/lib/unimidi/adapter/midi-winmm.rb

@@ -1,15 +1,13 @@
-require "midi-winmm"
+# frozen_string_literal: true
 
-module UniMIDI
+require 'midi-winmm'
 
+module UniMIDI
   module Adapter
-
     # Load underlying devices using the midi-winmm gem
     module MIDIWinMM
-
       module Loader
-
-        extend self
+        module_function
 
         # @return [Array<MIDIWinMM::Input>]
         def inputs
@@ -20,11 +18,7 @@ module UniMIDI
         def outputs
           ::MIDIWinMM::Device.all_by_type[:output]
         end
-
       end
-
     end
-
   end
-
 end

data/lib/unimidi/command.rb

@@ -1,26 +1,24 @@
-module UniMIDI
+# frozen_string_literal: true
 
+module UniMIDI
   # Module for command-line use of UniMIDI.  Used by the bin/unimidi script
   module Command
-
-    extend self
+    module_function
 
     # Execute a command
     # @param [Symbol] command
     # @param [Hash] options
     # @return [Boolean]
-    def exec(command, options = {})
-      if [:l, :list, :list_devices].include?(command)
-        puts "input:"
+    def exec(command, _options = {})
+      if %i[l list list_devices].include?(command)
+        puts 'input:'
         Input.list
-        puts "output:"
+        puts 'output:'
         Output.list
         true
       else
-        raise "Command #{command.to_s} not found"
-      end   
+        raise "Command #{command} not found"
+      end
     end
-
   end
-
 end

data/lib/unimidi/device.rb

@@ -1,22 +1,21 @@
-module UniMIDI
+# frozen_string_literal: true
 
+module UniMIDI
   # Common logic that is shared by both Input and Output devices
   module Device
-
     # Methods that are shared by both Input and Output classes
     module ClassMethods
-
       include Enumerable
 
       # Iterate over all devices of this direction (eg Input, Output)
       def each(&block)
-        all.each { |device| yield(device) }
+        all.each(&block)
       end
 
       # Prints ids and names of each device to the console
       # @return [Array<String>]
       def list
-        all.map do |device| 
+        all.map do |device|
           name = device.pretty_name
           puts(name)
           name
@@ -34,19 +33,23 @@ module UniMIDI
       # When their input is received, the device is selected and enabled
       def gets(&block)
         device = nil
-        class_name = self.name.split("::").last.downcase
-        puts ""
-        puts "Select a MIDI #{class_name}..."
+        direction = get_direction
+        puts ''
+        puts "Select a MIDI #{direction}..."
         while device.nil?
           list
-          print "> "
+          print '> '
           selection = $stdin.gets.chomp
-          if selection != ""
-            selection = Integer(selection) rescue nil
-            device = all.find { |d| d.id == selection }
+          next unless selection != ''
+
+          selection = begin
+            Integer(selection)
+          rescue StandardError
+            nil
           end
+          device = all.find { |d| d.id == selection } unless selection.nil?
         end
-        device.open(&block) unless device.enabled?
+        device.open(&block)
         device
       end
 
@@ -63,42 +66,51 @@ module UniMIDI
       end
 
       # Select the device at the given index and enable it
-      # @param [Fixnum] index
+      # @param [Integer] index
       # @return [Input, Output]
       def use(index, &block)
         index = case index
                 when :first then 0
-                when :last then all.size - 1
+                when :last then all.count - 1
                 else index
                 end
-        use_device(all[index], &block) 
+        use_device(at(index), &block)
       end
-      alias_method :open, :use
+      alias open use
 
       # Select the device at the given index
-      # @param [Fixnum] index
+      # @param [Integer] index
       # @return [Input, Output]
-      def [](index)
+      def at(index)
         all[index]
       end
+      alias [] at
 
       private
 
+      # The direction of the device eg "input", "output"
+      # @return [String]
+      def get_direction
+        name.split('::').last.downcase
+      end
+
       # Enable the given device
       # @param [Input, Output] device
       # @return [Input, Output]
       def use_device(device, &block)
-        device.open(&block) unless device.enabled?
-        device         
+        if device.enabled?
+          yield(device) if block_given?
+        else
+          device.open(&block)
+        end
+        device
       end
-
     end
 
     # Methods that are shared by both Input and Output instances
     module InstanceMethods
-
       # @param [AlsaRawMIDI::Input, AlsaRawMIDI::Output, CoreMIDI::Destination, CoreMIDI::Source, MIDIJRuby::Input, MIDIJRuby::Output, MIDIWinMM::Input, MIDIWinMM::Output] device
-      def initialize(device)        
+      def initialize(device)
         @device = device
         @enabled = false
 
@@ -110,7 +122,7 @@ module UniMIDI
       # Can be passed a block to which the device will be passed in as the yieldparam
       # @param [*Object] args
       # @return [Input, Output] self
-      def open(*args, &block)
+      def open(*args)
         unless @enabled
           @device.open(*args)
           @enabled = true
@@ -125,8 +137,8 @@ module UniMIDI
           at_exit do
             close
           end
-          self
         end
+        self
       end
 
       # A human readable display name for this device
@@ -149,6 +161,12 @@ module UniMIDI
         end
       end
 
+      # Returns true if the device is not enabled
+      # @return [Boolean]
+      def closed?
+        !@enabled
+      end
+
       # Add attributes for the device instance
       # :direction, :id, :name
       def self.included(base)
@@ -165,9 +183,9 @@ module UniMIDI
       # Populate the direction attribute
       def populate_direction
         @direction = case @device.type
-                when :source, :input then :input
-                when :destination, :output then :output
-                end
+                     when :source, :input then :input
+                     when :destination, :output then :output
+                     end
       end
 
       # Populate attributes from the underlying device object
@@ -176,9 +194,6 @@ module UniMIDI
         @name = @device.name
         populate_direction
       end
-
     end
-
   end
-
 end

data/lib/unimidi/input/buffer_access.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module UniMIDI
+  class Input
+    module BufferAccess
+      # The device buffer
+      # @return [Array<Hash>]
+      def buffer
+        @device.buffer
+      end
+
+      # Clears the input buffer
+      # @return [Array]
+      def clear_buffer
+        @device.buffer.clear
+      end
+
+      # Gets any messages in the buffer in the same format as Input::StreamReader#gets. This doesn't remove
+      # the messages from the buffer or have any effect on the StreamReader pointer position
+      # @param [*Object] args
+      # @return [Array<Hash>]
+      def gets_buffer(*_args)
+        @device.buffer
+      end
+
+      # Gets any messages in the buffer in the same format as Input#gets_s. This doesn't remove
+      # the messages from the buffer or have any effect on the StreamReader pointer position
+      # @param [*Object] args
+      # @return [Array<Hash>]
+      def gets_buffer_s(*_args)
+        @device.buffer.map do |msg|
+          msg[:data] = TypeConversion.numeric_byte_array_to_hex_string(msg[:data])
+          msg
+        end
+      end
+
+      # Gets any messages in the buffer in the same format as Input#gets_data. . This doesn't remove
+      # the messages from the buffer or have any effect on the StreamReader pointer position
+      # @param [*Object] args
+      # @return [Array<Integer>]
+      def gets_buffer_data(*_args)
+        @device.buffer.map { |msg| msg[:data] }
+      end
+    end
+  end
+end

data/lib/unimidi/input/stream_reader.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module UniMIDI
+  class Input
+    module StreamReader
+      # Returns any data in the input buffer that have been received since the last call to a
+      # StreamReader method. If a StreamReader method has not yet been called, all data received
+      # since the program was initialized will be returned
+      #
+      # The data is returned as 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 }
+      #   ]
+      #
+      # In this case, the data is an array of Numeric bytes
+      # The timestamp is the number of millis since this input was enabled
+      # Arguments are passed to the underlying device object
+      #
+      # @param [*Object] args
+      # @return [Array<Hash>]
+      def gets(*args)
+        @device.gets(*args)
+      rescue SystemExit, Interrupt
+        exit
+      end
+
+      # Returns any data in the input buffer that have been received since the last call to a
+      # StreamReader method. If a StreamReader method has not yet been called, all data received
+      # since the program was initialized will be returned
+      #
+      # Similar to Input#gets except that the returned message data as string of hex digits eg:
+      #   [
+      #     { :data => "904060", :timestamp => 904 },
+      #     { :data => "804060", :timestamp => 1150 },
+      #     { :data => "90447F", :timestamp => 1300 }
+      #   ]
+      #
+      # @param [*Object] args
+      # @return [Array<Hash>]
+      def gets_s(*args)
+        @device.gets_s(*args)
+      rescue SystemExit, Interrupt
+        exit
+      end
+      alias gets_bytestr gets_s
+      alias gets_hex gets_s
+
+      # Returns any data in the input buffer that have been received since the last call to a
+      # StreamReader method. If a StreamReader method has not yet been called, all data received
+      # since the program was initialized will be returned
+      #
+      # Similar to Input#gets except that the returned message data as an array of data bytes such as
+      #   [144, 60, 100, 128, 60, 100, 144, 40, 120]
+      #
+      # @param [*Object] args
+      # @return [Array<Integer>]
+      def gets_data(*args)
+        arr = gets(*args)
+        arr.map { |msg| msg[:data] }.inject(:+)
+      end
+
+      # Returns any data in the input buffer that have been received since the last call to a
+      # StreamReader method. If a StreamReader method has not yet been called, all data received
+      # since the program was initialized will be returned
+      #
+      # Similar to Input#gets except that the returned message data as a string of data such as
+      #   "90406080406090447F"
+      #
+      # @param [*Object] args
+      # @return [String]
+      def gets_data_s(*args)
+        arr = gets_bytestr(*args)
+        arr.map { |msg| msg[:data] }.join
+      end
+      alias gets_data_bytestr gets_data_s
+      alias gets_data_hex gets_data_s
+    end
+  end
+end

data/lib/unimidi/input.rb

@@ -1,113 +1,20 @@
-module UniMIDI
+# frozen_string_literal: true
+
+require 'unimidi/input/buffer_access'
+require 'unimidi/input/stream_reader'
 
+module UniMIDI
   # A MIDI input device
   class Input
-
     extend Device::ClassMethods
+    include BufferAccess
     include Device::InstanceMethods
+    include StreamReader
 
     # All MIDI input devices -- used to populate the class
     # @return [Array<Input>]
     def self.all
-      Loader.devices(:direction => :input)
-    end
-
-    # The device buffer
-    # @return [Array<Hash>]
-    def buffer
-      @device.buffer
-    end
-
-    #
-    # Plucks data from the input buffer and returns it as 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 }
-    #   ]
-    #
-    # In this case, the data is an array of Numeric bytes
-    # The timestamp is the number of millis since this input was enabled
-    # Arguments are passed to the underlying device object
-    #
-    # @param [*Object] args
-    # @return [Array<Hash>]
-    def gets(*args)
-      @device.gets(*args)
-    rescue SystemExit, Interrupt
-      exit
-    end
-
-    #
-    # Plucks data from the input buffer and returns it as array of MIDI event hashes.
-    # Similar to Input#gets except that the returned message data as string of hex digits eg:
-    #   [
-    #     { :data => "904060", :timestamp => 904 },
-    #     { :data => "804060", :timestamp => 1150 },
-    #     { :data => "90447F", :timestamp => 1300 }
-    #   ]
-    #
-    # @param [*Object] args
-    # @return [Array<Hash>]
-    def gets_s(*args)
-      @device.gets_s(*args)
-    rescue SystemExit, Interrupt
-      exit
-    end
-    alias_method :gets_bytestr, :gets_s
-    alias_method :gets_hex, :gets_s
-
-    #
-    # Plucks data from the input buffer and returns it as an array of data bytes such as
-    #   [144, 60, 100, 128, 60, 100, 144, 40, 120]
-    #
-    # @param [*Object] args
-    # @return [Array<Fixnum>]
-    def gets_data(*args)
-      arr = gets(*args)
-      arr.map { |msg| msg[:data] }.inject(:+)
+      Loader.devices(direction: :input)
     end
-
-    #
-    # Plucks data from the input buffer and returns it as a string of data such as
-    #   "90406080406090447F"
-    #
-    # @param [*Object] args
-    # @return [String]
-    def gets_data_s(*args)
-      arr = gets_bytestr(*args)
-      arr.map { |msg| msg[:data] }.join
-    end
-    alias_method :gets_data_bytestr, :gets_data_s
-    alias_method :gets_data_hex, :gets_data_s
-
-    # Clears the input buffer
-    # @return [Array]
-    def clear_buffer
-      @device.buffer.clear
-    end
-
-    # Gets any messages in the buffer in the same format as Input#gets, without removing them from the buffer
-    # @param [*Object] args
-    # @return [Array<Hash>]
-    def gets_buffer(*args)
-      @device.buffer
-    end
-
-    # Gets any messages in the buffer in the same format as Input#gets_s, without removing them from the buffer
-    # @param [*Object] args
-    # @return [Array<Hash>]
-    def gets_buffer_s(*args)
-      @device.buffer.map { |msg| msg[:data] = TypeConversion.numeric_byte_array_to_hex_string(msg[:data]); msg }
-    end
-
-    # Gets any messages in the buffer in the same format as Input#gets_data without removing them from the buffer
-    # @param [*Object] args
-    # @return [Array<Fixnum>]
-    def gets_buffer_data(*args)
-      @device.buffer.map { |msg| msg[:data] }
-    end
-
   end
-
 end