midi-message 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad978e231aef5931892a5fb96573c4e709f3ad64
-  data.tar.gz: 53cc976f50cb5c4d5ba619f3d3d4b1aaa10a71d9
+  metadata.gz: 539a68753cc6d0c17fed06cae7103d1f7b0f95a8
+  data.tar.gz: 2b3949261e5e5fa7061cb7860c325d6a0c067efb
 SHA512:
-  metadata.gz: 6a51573df46bbee8bc764be4d139b52c7366c192c0402846bb3cae67efa4e5cbfa87b4ad1982765fc80f2d6d3e088c857f6ee5a9b0bc6d0f68a2e2ca08f3a931
-  data.tar.gz: c7264a018b5b523aeaa7391ab2f387aab0a2a9b66f583692bdd05a12eb7968c9ebc0ef120de61cfe82ab42e6f8c3301522fe957f6fc9ca9b5969d387ff8f1c5c
+  metadata.gz: edc31730d5ffc918377fb342f63c3ce095b187e8f17ed194a47756a701286f3a78b7d7102f05850a2eeca59108d90ec3ed1a9cb5e0e78294cea699c6ede821b6
+  data.tar.gz: 86c8b7a355baa3a46d93ca63294a512538dc8478fbea9844be00c917916fe1d13fde7bd19eb599a2cf61fefff021df45f853a43622d6bb8380322f03136e6e30

data/lib/midi-message.rb

@@ -5,7 +5,7 @@
 # 
 module MIDIMessage
     
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
  
 end
 

data/lib/midi-message/channel_message.rb

@@ -46,8 +46,8 @@ module MIDIMessage
     protected
 
     def self.included(base)
-      base.include(ShortMessage)
-      base.extend(ClassMethods)
+      base.send(:include, ShortMessage)
+      base.send(:extend, ClassMethods)
     end
 
     private

data/lib/midi-message/constant.rb

@@ -11,12 +11,12 @@ module MIDIMessage
     end
     
     def find(name)
-      @constants.find { |const| const.key.to_s.downcase.eql?(name.to_s.downcase) }       
+      @constants.find { |const| const.key.to_s.downcase == name.to_s.downcase }       
     end
     alias_method :[], :find
     
     def find_by_value(value)
-      @constants.find { |const| const.value.to_s.downcase.eql?(value.to_s.downcase) }
+      @constants.find { |const| const.value.to_s.downcase == value.to_s.downcase }
     end
     
     def self.all
@@ -26,7 +26,7 @@ module MIDIMessage
 
     def self.[](key)      
       ensure_initialized
-      @groups.find { |g| g.key.to_s.downcase.eql?(key.to_s.downcase) }
+      @groups.find { |g| g.key.to_s.downcase == key.to_s.downcase }
     end
     
     private

data/lib/midi-message/context.rb

@@ -1,7 +1,3 @@
-#!/usr/bin/env ruby
-#
-#
-
 module MIDIMessage
 
   class Context

data/lib/midi-message/message.rb

@@ -109,13 +109,13 @@ module MIDIMessage
     
     attr_reader :data
     
-    def initialize(*a)
-      options = a.last.kind_of?(Hash) ? a.pop : {}
+    def initialize(*args)
+      options = args.last.kind_of?(Hash) ? args.pop : {}
       @const = options[:const]
-      id = @const.nil? ? a.shift : @const.value
+      id = @const.nil? ? args.shift : @const.value
       id = strip_redundant_nibble(id)
       initialize_short_message(0xF, id)
-      @data = [a[0], a[1]]
+      @data = args.slice(0..1)
     end
     
   end  
@@ -129,10 +129,10 @@ module MIDIMessage
 
     DISPLAY_NAME = "System Realtime"
     
-    def initialize(*a)
-      options = a.last.kind_of?(Hash) ? a.pop : {} 
+    def initialize(*args)
+      options = args.last.kind_of?(Hash) ? args.pop : {} 
       @const = options[:const]
-      id = @const.nil? ? a[0] : @const.value
+      id = @const.nil? ? args.first : @const.value
       id = strip_redundant_nibble(id)
       initialize_short_message(0xF, id)
     end
@@ -149,7 +149,7 @@ module MIDIMessage
     # A command message is identified by having a status byte equal to 0x12
     class Command
 
-      include SystemExclusive::InstanceMethods
+      include SystemExclusive
 
       attr_accessor :data
       alias_method :value, :data
@@ -158,7 +158,11 @@ module MIDIMessage
       
       def initialize(address, data, options = {})
         # store as a byte if it's a single byte
-        @data = (data.kind_of?(Array) && data.length.eql?(1)) ? data[0] : data
+        @data = if data.kind_of?(Array) && data.length == 1
+          data.first
+        else
+          data
+        end
         initialize_sysex(address, options)
       end
       
@@ -168,7 +172,7 @@ module MIDIMessage
     # A request message is identified by having a status byte equal to 0x11
     class Request
 
-      include SystemExclusive::InstanceMethods
+      include SystemExclusive
       
       attr_reader :size
       alias_method :value, :size
@@ -176,19 +180,23 @@ module MIDIMessage
       TypeByte = 0x11
       
       def initialize(address, size, options = {})
-        self.size = (size.kind_of?(Array) && size.length.eql?(1)) ? size[0] : size
+        self.size = if size.kind_of?(Array) && size.count == 1
+          size.first
+        else
+          size
+        end
         initialize_sysex(address, options)
       end
       
-      def size=(val)
+      def size=(value)
         # accepts a Numeric or Array but
         # must always store value as an array of three bytes
         size = []
-        if val.kind_of?(Array) && val.size <= 3
-          size = val
-        elsif val.kind_of?(Numeric) && (((val + 1) / 247) <= 2)
+        if value.kind_of?(Array) && value.size <= 3
+          size = value
+        elsif value.kind_of?(Numeric) && (value + 1) / 247 <= 2
           size = []
-          div, mod = *val.divmod(247)
+          div, mod = *value.divmod(247)
           size << mod unless mod.zero?
           div.times { size << 247 }
         end

data/lib/midi-message/note_message.rb

@@ -4,7 +4,7 @@ module MIDIMessage
   module NoteMessage
 
     def self.included(base)
-      base.include(ChannelMessage)
+      base.send(:include, ChannelMessage)
     end
 
     # The octave number of the note

data/lib/midi-message/parser.rb

@@ -1,48 +1,46 @@
-#!/usr/bin/env ruby
-#
-
 module MIDIMessage
 
-    # very simple parsing
-    # for more advanced parsing check out {nibbler}[http://github.com/arirusso/nibbler]
-    class Parser
-      
-      # can take either a hex string eg Parser.new("904040")
-      # or bytes eg Parser.new(0x90, 0x40, 0x40)
-      # or an array of bytes eg Parser.new([0x90, 0x40, 0x40])
-      def initialize(*a)
-        @data = case a.first
-          when Array then a.first
-          when Numeric then a 
-          when String then TypeConversion.hex_string_to_numeric_byte_array(a.first)
-        end
-      end
-      
-      def parse
-        first_nibble = ((@data.first & 0xF0) >> 4)
-        second_nibble = (@data.first & 0x0F)
-        case first_nibble
-          when 0x8 then NoteOff.new(second_nibble, @data[1], @data[2])
-          when 0x9 then NoteOn.new(second_nibble, @data[1], @data[2])
-          when 0xA then PolyphonicAftertouch.new(second_nibble, @data[1], @data[2])
-          when 0xB then ControlChange.new(second_nibble, @data[1], @data[2])
-          when 0xC then ProgramChange.new(second_nibble, @data[1])
-          when 0xD then ChannelAftertouch.new(second_nibble, @data[1])
-          when 0xE then PitchBend.new(second_nibble, @data[1], @data[2])
-          when 0xF then case second_nibble
-            when 0x0 then SystemExclusive.new(*@data)
-            when 0x1..0x6 then SystemCommon.new(second_nibble, @data[1], @data[2])
-            when 0x8..0xF then SystemRealtime.new(second_nibble)
-            else nil
-          end
-          else nil
+  # Very simple parsing
+  # for more advanced parsing check out {nibbler}[http://github.com/arirusso/nibbler]
+  class Parser
+
+    # Can take either a hex string eg Parser.new("904040")
+    # or bytes eg Parser.new(0x90, 0x40, 0x40)
+    # or an array of bytes eg Parser.new([0x90, 0x40, 0x40])
+    def initialize(*args)
+      @data = case args.first
+              when Array then args.first
+              when Numeric then args 
+              when String then TypeConversion.hex_string_to_numeric_byte_array(args.first)
+              end
+    end
+
+    # Parse the data and return a message
+    def parse
+      first_nibble = ((@data.first & 0xF0) >> 4)
+      second_nibble = (@data.first & 0x0F)
+      case first_nibble
+      when 0x8 then NoteOff.new(second_nibble, @data[1], @data[2])
+      when 0x9 then NoteOn.new(second_nibble, @data[1], @data[2])
+      when 0xA then PolyphonicAftertouch.new(second_nibble, @data[1], @data[2])
+      when 0xB then ControlChange.new(second_nibble, @data[1], @data[2])
+      when 0xC then ProgramChange.new(second_nibble, @data[1])
+      when 0xD then ChannelAftertouch.new(second_nibble, @data[1])
+      when 0xE then PitchBend.new(second_nibble, @data[1], @data[2])
+      when 0xF then case second_nibble
+        when 0x0 then SystemExclusive.new(*@data)
+        when 0x1..0x6 then SystemCommon.new(second_nibble, @data[1], @data[2])
+        when 0x8..0xF then SystemRealtime.new(second_nibble)
+        else nil
         end
+      else nil
       end
-    
-    end
-    
-    def self.parse(*a)
-      Parser.new(*a).parse
-    end
+    end   
+
+  end
+
+  def self.parse(*args)
+    Parser.new(*args).parse
+  end
 
 end

data/lib/midi-message/short_message.rb

@@ -35,7 +35,7 @@ module MIDIMessage
     protected
     
     def self.included(base)
-      base.extend(ClassMethods)
+      base.send(:extend, ClassMethods)
     end
     
     def update

data/lib/midi-message/system_exclusive.rb

@@ -3,6 +3,10 @@ module MIDIMessage
   # MIDI System-Exclusive Messages (SysEx)
   module SystemExclusive
 
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+    end
+
     # Common SysEx data that a message class will contain
     module InstanceMethods
 
@@ -15,16 +19,17 @@ module MIDIMessage
       # an array of message parts.  multiple byte parts will be represented as an array of bytes
       def to_a(options = {})
         omit = options[:omit] || [] 
+        node = @node.to_a(options) unless @node.nil? || omit.include?(:node)
         # this may need to be cached when properties are updated
         # might be worth benchmarking
         [
-          self.class::StartByte,
-          (@node.to_a(options) unless @node.nil? || omit.include?(:node)),
+          start_byte,
+          node,
           (type_byte unless omit.include?(:type)),
           [address].compact.flatten,
           [value].compact.flatten,
           (checksum unless omit.include?(:checksum)),
-          self.class::EndByte
+          end_byte
         ].compact
       end
 
@@ -39,7 +44,12 @@ module MIDIMessage
 
       # string representation of the object's bytes
       def to_hex_s
-        to_bytes.map { |b| s = b.to_s(16); s.length.eql?(1) ? "0#{s}" : s }.join.upcase
+        strings = to_bytes.map do |byte| 
+          string = byte.to_s(16)
+          string = "0#{string}" if string.length == 1
+          string
+        end
+        strings.join.upcase
       end
       alias_method :to_bytestr, :to_hex_s
 
@@ -48,6 +58,14 @@ module MIDIMessage
       end
       alias_method :verbose_name, :name
 
+      def start_byte
+        self.class::StartByte
+      end
+
+      def end_byte
+        self.class::EndByte
+      end
+
       def type_byte
         self.class::TypeByte
       end
@@ -55,8 +73,9 @@ module MIDIMessage
       # alternate method from
       # http://www.2writers.com/eddie/TutSysEx.htm
       def checksum
-        sum = (address + [value].flatten).inject { |a, b| a + b } 
-        (128 - sum.divmod(128)[1])
+        sum = (address + [value].flatten).inject(&:+) 
+        mod = sum.divmod(128)[1]
+        128 - mod
       end
 
       private
@@ -78,20 +97,25 @@ module MIDIMessage
       attr_accessor :data
 
       def initialize(data, options = {})
-        @data = (data.kind_of?(Array) && data.length.eql?(1)) ? data[0] : data
+        @data = if data.kind_of?(Array) && data.length == 1
+          data.first
+        else
+          data
+        end
         initialize_sysex(nil, options)
       end
 
       # an array of message parts.  multiple byte parts will be represented as an array of bytes
       def to_a(options = {})
         omit = options[:omit] || [] 
+        node = @node.to_a(options) unless @node.nil? || omit.include?(:node)
         # this may need to be cached when properties are updated
         # might be worth benchmarking
         [
-          self.class::StartByte,
-          (@node.to_a(options) unless @node.nil? || omit.include?(:node)),
+          start_byte,
+          node,
           @data,
-          self.class::EndByte
+          end_byte
         ].compact
       end
 
@@ -109,16 +133,17 @@ module MIDIMessage
       def initialize(manufacturer, options = {})
         @device_id = options[:device_id]
         @model_id = options[:model_id]
-        @manufacturer_id = manufacturer.kind_of?(Numeric) ? manufacturer : Constant.find("Manufacturer", manufacturer).value
+        @manufacturer_id = get_manufacturer_id(manufacturer)
       end
 
       def to_a(options = {})
-        omit = options[:omit] || [] 
-        [
-          (@manufacturer_id unless omit.include?(:manufacturer) || omit.include?(:manufacturer_id)),
-          (@device_id unless omit.include?(:device) || omit.include?(:device_id)),
-          (@model_id unless omit.include?(:model) || omit.include?(:model_id))
-        ].compact
+        omit = options[:omit] || []
+        properties = [:manufacturer, :device, :model].map do |property|
+          unless omit.include?(property) || omit.include?("#{property.to_s}_id")
+            instance_variable_get("@#{property.to_s}_id")
+          end
+        end
+        properties.compact
       end
 
       # this message takes a prototype message, copies it, and returns the copy with its node set
@@ -143,6 +168,17 @@ module MIDIMessage
         request
       end
 
+      private
+
+      def get_manufacturer_id(manufacturer)
+        if manufacturer.kind_of?(Numeric)
+          manufacturer
+        else
+          const = Constant.find("Manufacturer", manufacturer)
+          const.value
+        end
+      end
+
     end
 
     # Convert raw MIDI data to SysEx message objects
@@ -151,7 +187,7 @@ module MIDIMessage
       start_status = bytes.shift
       end_status = bytes.pop
 
-      if start_status.eql?(0xF0) && end_status.eql?(0xF7)
+      if start_status == 0xF0 && end_status == 0xF7
 
         type_byte = bytes[3]
 

data/lib/midi-message/system_message.rb

@@ -4,7 +4,7 @@ module MIDIMessage
   module SystemMessage
 
     def self.included(base)
-      base.include(ShortMessage)
+      base.send(:include, ShortMessage)
     end
 
     # In the case of something like SystemCommon.new(0xF2, 0x00, 0x08), the first nibble F is redundant because

data/lib/midi-message/type_conversion.rb

@@ -5,8 +5,13 @@ module MIDIMessage
     
     extend self
 
+    # Convert an array of hex nibbles to an array of numeric bytes
+    # eg ["9", "0", "4", "0"] to [0x90, 0x40]
+    #
+    # @param [Array<String>] An array of hex nibbles eg ["9", "0", "4", "0"]
+    # @return [Array<Fixnum] An array of numeric bytes eg [0x90, 0x40]
     def hex_chars_to_numeric_byte_array(nibbles)
-      nibbles = nibbles.dup
+      nibbles = nibbles.dup # Don't mess with the input
       # get rid of last nibble if there's an odd number
       # it will be processed later anyway
       nibbles.slice!(nibbles.length-2, 1) if nibbles.length.odd?
@@ -18,30 +23,57 @@ module MIDIMessage
       bytes
     end
     
-    # Convert byte str to byte array 
-    def hex_string_to_numeric_byte_array(str)
-      str = str.dup
+    # Convert byte string to an array of numeric bytes
+    # eg. "904040" to [0x90, 0x40, 0x40]
+    # @param [String] string A string representing hex digits eg "904040"
+    # @return [Array<Fixnum>] An array of numeric bytes eg [0x90, 0x40, 0x40]
+    def hex_string_to_numeric_byte_array(string)
+      string = string.dup
       bytes = []
-      until str.eql?("")
-        bytes << str.slice!(0, 2).hex
+      until string.length == 0
+        bytes << string.slice!(0, 2).hex
       end
       bytes
     end
     
-    # Converts a string of hex digits to bytes
-    def hex_str_to_hex_chars(str)
-      str.split(//)    
+    # Convert a string of hex digits to an array of nibbles
+    # eg. "904040" to ["9", "0", "4", "0", "4", "0"]
+    # @param [String] string A string representing hex digits eg "904040"
+    # @return [Array<String>] An array of hex nibble chars eg ["9", "0", "4", "0", "4", "0"]
+    def hex_str_to_hex_chars(string)
+      string.split(//)    
     end
     
+    # Convert an array of numeric bytes to a string of hex digits
+    # eg. [0x90, 0x40, 0x40] to "904040"
+    # @param [Array<Fixnum>] bytes An array of numeric bytes eg [0x90, 0x40, 0x40]
+    # @return [String] A string representing hex digits eg "904040"
     def numeric_byte_array_to_hex_string(bytes)
-      bytes.map { |b| s = b.to_s(16); s.length.eql?(1) ? "0#{s}" : s }.join.upcase
+      string_bytes = bytes.map do |byte| 
+        string = byte.to_s(16)
+        string = "0#{string}" if string.length == 1
+        string
+      end
+      string_bytes.join.upcase
     end
     
+    # Convert a numeric byte to hex chars
+    # eg 0x90 to ["9", "0"]
+    # @param [Fixnum] num A numeric byte eg 0x90
+    # @return [Array<String>] An array of hex nibble chars eg ["9", "0"]
     def numeric_byte_to_hex_chars(num)
-      [((num & 0xF0) >> 4), (num & 0x0F)].map { |n| n.to_s(16) }      
+      nibbles = numeric_byte_to_nibbles(num)
+      nibbles.map { |n| n.to_s(16) }      
+    end
+
+    # Convert a numeric byte to nibbles
+    # eg 0x90 to [0x9, 0x0]
+    # @param [Fixnum] num A numeric byte eg 0x90
+    # @return [Array<Fixnum>] An array of nibbles eg [0x9, 0x0]
+    def numeric_byte_to_nibbles(num)
+      [((num & 0xF0) >> 4), (num & 0x0F)]
     end
 
-    
   end
   
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: midi-message
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Ari Russo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-01 00:00:00.000000000 Z
+date: 2014-09-27 00:00:00.000000000 Z
 dependencies: []
 description: Objects and classes for dealing with MIDI messages.
 email: