midi-message 0.4.8 → 0.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a74063f4fe5e1a622a69fc4c775763f20046defb
-  data.tar.gz: 19638072ab7f93b748d5a435263947ece626f9ea
+  metadata.gz: 96815929056b3d199312f9d0ea055edcdade2313
+  data.tar.gz: bd58cc3e59de12731d9541dcf4cfb00ef81b4ef7
 SHA512:
-  metadata.gz: f85ede4091a84b04f9f292298205cdd7e8fa7e12c24f27e078de4076ede187f94aad464cec41640dfb7aeaf45b2d010a753a4248441143b1157ea93ff5be0a37
-  data.tar.gz: 5f031bf9d385a268d2c3355f787918bf8f1ebdc65321df5a25b7dfc67bc8d5a000f23851e899310f4ee644c9c8f5d161915ffaf74a4845bd87ad0d3630cc4787
+  metadata.gz: 61721e744f4c482f7a7318866ef2e61fb23d7d7b7bf21311070b67eb7d37a72a7d4f788b5b1dd87d24877b098bed676506871019fb795382803bfb8e5f872da1
+  data.tar.gz: 467155c933d12d8d7de50b65e050013685eb28ab4b663187fa3eb23a88b35b2eb86c0090ef843505b7d57832b3f92bad4143f2bbd6a9516ca5d6f6d02e02ff69

data/lib/midi-message.rb

@@ -25,6 +25,6 @@ require "midi-message/parser"
 
 module MIDIMessage
 
-  VERSION = "0.4.8"
+  VERSION = "0.4.9"
 
 end

data/lib/midi-message/channel_message.rb

@@ -10,13 +10,13 @@ module MIDIMessage
     # Shortcut to RawChannelMessage.new
     # aka build a ChannelMessage from raw nibbles and bytes
     # eg ChannelMessage.new(0x9, 0x0, 0x40, 0x40)
-    # @param [*Array<Fixnum>] data The status nibbles and data bytes
+    # @param [*Fixnum] data The status nibbles and data bytes
     # @return [RawChannelMessage] The resulting RawChannelMessage object
     def self.new(*data, &block)
       Message.new(*data, &block)
     end
 
-    # @param [*Array<Fixnum>] data The status nibbles and data bytes
+    # @param [*Fixnum] data The status nibbles and data bytes
     def initialize(*data)
       data = data.dup
       options = data.last.kind_of?(Hash) ? data.pop : {}
@@ -24,13 +24,6 @@ module MIDIMessage
       initialize_channel_message(self.class.type_for_status, *data)
     end
 
-    # Decorates the object with the particular properties for its type
-    # @return [Boolean]
-    def initialize_properties
-      properties = self.class.properties
-      add_properties(properties) unless properties.nil?
-    end
-
     private
 
     def self.included(base)
@@ -38,62 +31,92 @@ module MIDIMessage
       base.send(:extend, ClassMethods)
     end
 
+    # Add the given constant to message data
     def add_constant_value(constant, data)
       index = Constant::Loader.get_index(self)
       data.insert(index, constant.value)
     end
 
-    # @param [Array<Symbol>] properties
-    # @return [Boolean]
-    def add_properties(properties)
-      has_properties = false
-      schema = [
+    # Assign the message data
+    def assign_data(status_nibble_1, status_nibble_2, data_byte_1, data_byte_2 = 0)
+      @status = [status_nibble_1, status_nibble_2]
+      @data = [data_byte_1]
+      @data[1] = data_byte_2 if self.class.second_data_byte?
+    end
+
+    # Initialize the message: assign data, decorate with accessors
+    def initialize_channel_message(status_nibble_1, status_nibble_2, data_byte_1, data_byte_2 = 0)
+      assign_data(status_nibble_1, status_nibble_2, data_byte_1, data_byte_2)
+      Accessors.initialize(self) unless self.class.properties.nil?
+      initialize_message(status_nibble_1, status_nibble_2)
+    end
+
+    class Accessors
+
+      SCHEMA = [
         { :name => :status, :index => 1 }, # second status nibble
         { :name => :data, :index => 0 }, # first data byte
         { :name => :data, :index => 1 } # second data byte
-      ]
-      properties.each_with_index do |property, i|
-        property_schema = schema[i]
-        define_getter(property, property_schema)
-        define_setter(property, property_schema)
-        has_properties = true
+      ].freeze
+
+      # @param [Class] klass
+      # @return [Class]
+      def self.decorate(klass)
+        decorator = new(klass)
+        decorator.decorate
       end
-      has_properties
-    end
 
-    # @param [Symbol, String] property
-    # @param [Hash] container
-    # @param [Fixnum] index
-    # @return [Boolean]
-    def define_getter(property, property_schema)
-      container = send(property_schema[:name])
-      index = property_schema[:index]
-      self.class.send(:attr_reader, property)
-      instance_variable_set("@#{property.to_s}", container[index])
-      true
-    end
+      # Initialize a message object with it's properties
+      # @param [MIDIMessage] message
+      # @return [Boolean]
+      def self.initialize(message)
+        message.class.properties.each_with_index do |property, i|
+          data_mapping = SCHEMA[i]
+          container = message.send(data_mapping[:name])
+          index = data_mapping[:index]
+          message.send(:instance_variable_set, "@#{property.to_s}", container[index])
+        end
+        true
+      end
 
-    # @param [Symbol, String] property
-    # @param [Hash] container
-    # @param [Fixnum] index
-    # @return [Boolean]
-    def define_setter(property, property_schema)
-      index = property_schema[:index]
-      self.class.send(:define_method, "#{property.to_s}=") do |value|
-        send(:instance_variable_set, "@#{property.to_s}", value)
-        send(property_schema[:name])[index] = value
-        update
-        return self
+      # @param [Class] klass
+      def initialize(klass)
+        @klass = klass
+      end
+
+      # @return [Class]
+      def decorate
+        @klass.properties.each_with_index do |property, i|
+          data_mapping = SCHEMA[i]
+          define_getter(property)
+          define_setter(property, data_mapping)
+        end
+        @klass
+      end
+
+      private
+
+      # @param [Symbol, String] property
+      # @return [Boolean]
+      def define_getter(property)
+        @klass.send(:attr_reader, property)
+        true
+      end
+
+      # @param [Symbol, String] property
+      # @param [Hash] mapping
+      # @return [Boolean]
+      def define_setter(property, mapping)
+        index = mapping[:index]
+        @klass.send(:define_method, "#{property.to_s}=") do |value|
+          send(:instance_variable_set, "@#{property.to_s}", value)
+          send(mapping[:name])[index] = value
+          send(:update)
+          return self
+        end
+        true
       end
-      true
-    end
 
-    def initialize_channel_message(status_nibble_1, status_nibble_2, data_byte_1, data_byte_2 = 0)
-      @status = [status_nibble_1, status_nibble_2]
-      @data = [data_byte_1]
-      @data[1] = data_byte_2 if self.class.second_data_byte?
-      initialize_properties
-      initialize_message(status_nibble_1, status_nibble_2)
     end
 
     # For defining Channel Message class types
@@ -124,7 +147,7 @@ module MIDIMessage
 
       # Build a Channel Mssage from raw nibbles and bytes
       # eg ChannelMessage.new(0x9, 0x0, 0x40, 0x40)
-      # @param [*Array<Fixnum>] data The status nibbles and data bytes
+      # @param [*Fixnum] data The status nibbles and data bytes
       # @return [RawChannelMessage] The resulting RawChannelMessage object
       def initialize(*data)
         initialize_channel_message(*data)

data/lib/midi-message/constant.rb

@@ -22,6 +22,27 @@ module MIDIMessage
       map.value
     end
 
+    module Name
+
+      extend self
+
+      # eg "Control Change" -> "control_change"
+      # @param [Symbol, String] string
+      # @return [String]
+      def underscore(string)
+        string.to_s.downcase.gsub(/(\ )+/, "_")
+      end
+
+      # @param [Symbol, String] key
+      # @param [Symbol, String] other
+      # @return [Boolean]
+      def match?(key, other)
+        match_key = key.to_s.downcase
+        [match_key, Name.underscore(match_key)].include?(other.to_s.downcase)
+      end
+
+    end
+
     # MIDI Constant container
     class Group
 
@@ -38,14 +59,14 @@ module MIDIMessage
       # @param [String, Symbol] name
       # @return [Constant::Map]
       def find(name)
-        @constants.find { |const| const.key.to_s.downcase == name.to_s.downcase }
+        @constants.find { |const| Name.match?(const.key, name) }
       end
 
       # Find a constant by its value
       # @param [Object] value
       # @return [Constant::Map]
       def find_by_value(value)
-        @constants.find { |const| const.value.to_s.downcase == value.to_s.downcase }
+        @constants.find { |const| Name.match?(const.value, value) }
       end
 
       class << self
@@ -62,7 +83,7 @@ module MIDIMessage
         # @return [ConstantGroup]
         def find(key)
           ensure_initialized
-          @groups.find { |g| g.key.to_s.downcase == key.to_s.downcase }
+          @groups.find { |group| Name.match?(group.key, key) }
         end
         alias_method :[], :find
 
@@ -78,7 +99,9 @@ module MIDIMessage
         # @return [Boolean]
         def populate_dictionary
           if @dict.nil?
-            @dict = YAML.load_file(File.expand_path('../../midi.yml', __FILE__))
+            file = File.expand_path('../../midi.yml', __FILE__)
+            @dict = YAML.load_file(file)
+            @dict.freeze
             true
           end
         end
@@ -113,7 +136,7 @@ module MIDIMessage
     class MessageBuilder
 
       # @param [MIDIMessage] klass The message class to build
-      # @param [String] const The constant to build the message with
+      # @param [MIDIMessage::Constant::Map] const The constant to build the message with
       def initialize(klass, const)
         @klass = klass
         @const = const
@@ -132,13 +155,16 @@ module MIDIMessage
     # Shortcuts for dealing with message status
     module Status
 
+      extend self
+
       # The value of the Status constant with the name status_name
       # @param [String] status_name The key to use to look up a constant value
       # @return [String] The constant value that was looked up
-      def self.[](status_name)
+      def find(status_name)
         const = Constant.find("Status", status_name)
         const.value unless const.nil?
       end
+      alias_method :[], :find
 
     end
 
@@ -219,10 +245,11 @@ module MIDIMessage
         # This returns a MessageBuilder for the class, preloaded with the selected const
         # @param [String, Symbol] const_name The constant key to use to build the message
         # @return [MIDIMessage::MessageBuilder] A MessageBuilder object for the passed in constant
-        def [](const_name)
+        def find(const_name)
           const = get_constant(const_name.to_s)
           MessageBuilder.new(self, const) unless const.nil?
         end
+        alias_method :[], :find
 
       end
 

data/lib/midi-message/context.rb

@@ -5,6 +5,15 @@ module MIDIMessage
 
     attr_accessor :channel, :velocity
 
+    # Open a context with the given options
+    # @param [Hash] options
+    # @param [Proc] block
+    # @option options [Fixnum] :channel
+    # @option options [Fixnum] :velocity
+    def self.with(options = {}, &block)
+      new(options, &block).instance_eval(&block)
+    end
+
     # @param [Hash] options
     # @option options [Fixnum] :channel
     # @option options [Fixnum] :velocity
@@ -129,12 +138,13 @@ module MIDIMessage
 
   end
 
+  # Shortcut to MIDIMessage::Context.with
   # @param [Hash] options
   # @param [Proc] block
   # @option options [Fixnum] :channel
   # @option options [Fixnum] :velocity
   def self.with_context(options = {}, &block)
-    Context.new(options, &block).instance_eval(&block)
+    Context.with(options, &block)
   end
   class << self
     alias_method :with, :with_context

data/lib/midi-message/message.rb

@@ -14,8 +14,9 @@ module MIDIMessage
     # Byte array representation of the message eg [0x90, 0x40, 0x40] for NoteOn(0x40, 0x40)
     # @return [Array<Fixnum>] The array of bytes in the MIDI message
     def to_a
-      data = @data.nil? ? [] : [@data[0], @data[1]]
-      [(@status[0] << 4) + @status[1], *data].compact
+      data = [@data[0], @data[1]] unless @data.nil?
+      data ||= []
+      [status_as_byte, *data].compact
     end
     alias_method :to_byte_a, :to_a
     alias_method :to_byte_array, :to_a
@@ -32,7 +33,14 @@ module MIDIMessage
       populate_using_const
     end
 
-    protected
+    private
+
+    # Convert the status nibbles to a single byte
+    # Eg [0x9, 0xF] -> 0x9F
+    # @return [Fixnum]
+    def status_as_byte
+      (@status[0] << 4) + @status[1]
+    end
 
     def populate_using_const
       unless (info = Constant::Loader.get_info(self)).nil?

data/lib/midi-message/messages.rb

@@ -7,9 +7,12 @@ module MIDIMessage
 
     include ChannelMessage
 
-    DATA = [:channel, :value]
+    STATUS = 0xD
+    DATA = [:channel, :value].freeze
     DISPLAY_NAME = "Channel Aftertouch"
 
+    ChannelMessage::Accessors.decorate(self)
+
   end
   ChannelPressure = ChannelAftertouch
 
@@ -20,9 +23,12 @@ module MIDIMessage
 
     include ChannelMessage
 
-    DATA = [:channel, :index, :value]
+    STATUS = 0xB
+    DATA = [:channel, :index, :value].freeze
     DISPLAY_NAME = "Control Change"
-    CONSTANT = { "Control Change" => :index }
+    CONSTANT = { "Control Change" => :index }.freeze
+
+    ChannelMessage::Accessors.decorate(self)
 
   end
   Controller = ControlChange #shortcut
@@ -34,9 +40,12 @@ module MIDIMessage
 
     include ChannelMessage
 
-    DATA = [:channel, :low, :high]
+    STATUS = 0xE
+    DATA = [:channel, :low, :high].freeze
     DISPLAY_NAME = "Pitch Bend"
 
+    ChannelMessage::Accessors.decorate(self)
+
   end
 
   #
@@ -46,9 +55,12 @@ module MIDIMessage
 
     include ChannelMessage
 
-    DATA = [:channel, :note, :value]
+    STATUS = 0xA
+    DATA = [:channel, :note, :value].freeze
     DISPLAY_NAME = "Polyphonic Aftertouch"
-    CONSTANT = { "Note" => :note }
+    CONSTANT = { "Note" => :note }.freeze
+
+    ChannelMessage::Accessors.decorate(self)
 
   end
   PolyAftertouch = PolyphonicAftertouch
@@ -62,9 +74,12 @@ module MIDIMessage
 
     include ChannelMessage
 
-    DATA = [:channel, :program]
+    STATUS = 0xC
+    DATA = [:channel, :program].freeze
     DISPLAY_NAME = "Program Change"
 
+    ChannelMessage::Accessors.decorate(self)
+
   end
 
   #
@@ -74,9 +89,12 @@ module MIDIMessage
 
     include NoteMessage
 
-    DATA = [:channel, :note, :velocity]
+    STATUS = 0x8
+    DATA = [:channel, :note, :velocity].freeze
     DISPLAY_NAME = "Note Off"
-    CONSTANT = { "Note" => :note }
+    CONSTANT = { "Note" => :note }.freeze
+
+    ChannelMessage::Accessors.decorate(self)
 
   end
 
@@ -87,9 +105,12 @@ module MIDIMessage
 
     include NoteMessage
 
-    DATA = [:channel, :note, :velocity]
+    STATUS = 0x9
+    DATA = [:channel, :note, :velocity].freeze
     DISPLAY_NAME = "Note On"
-    CONSTANT = { "Note" => :note }
+    CONSTANT = { "Note" => :note }.freeze
+
+    ChannelMessage::Accessors.decorate(self)
 
     # returns the NoteOff equivalent of this object
     def to_note_off
@@ -105,6 +126,7 @@ module MIDIMessage
 
     include SystemMessage
 
+    ID = 0x1..0x6
     DISPLAY_NAME = "System Common"
 
     attr_reader :data
@@ -114,7 +136,7 @@ module MIDIMessage
       @const = options[:const]
       id = @const.nil? ? args.shift : @const.value
       id = strip_redundant_nibble(id)
-      initialize_message(0xF, id)
+      initialize_message(SystemMessage::STATUS, id)
       @data = args.slice(0..1)
     end
 
@@ -127,6 +149,7 @@ module MIDIMessage
 
     include SystemMessage
 
+    ID = 0x8..0xF
     DISPLAY_NAME = "System Realtime"
 
     def initialize(*args)
@@ -134,7 +157,7 @@ module MIDIMessage
       @const = options[:const]
       id = @const.nil? ? args.first : @const.value
       id = strip_redundant_nibble(id)
-      initialize_message(0xF, id)
+      initialize_message(SystemMessage::STATUS, id)
     end
 
     def id
@@ -145,6 +168,13 @@ module MIDIMessage
 
   module SystemExclusive
 
+    ID = 0x0
+    DELIMITER = {
+      :start => 0xF0,
+      :finish => 0xF7
+    }
+    DISPLAY_NAME = "System Exclusive"
+
     # A SysEx command message
     # A command message is identified by having a status byte equal to 0x12
     class Command
@@ -154,7 +184,7 @@ module MIDIMessage
       attr_accessor :data
       alias_method :value, :data
 
-      TypeByte = 0x12
+      TYPE = 0x12
 
       def initialize(address, data, options = {})
         # store as a byte if it's a single byte
@@ -177,7 +207,7 @@ module MIDIMessage
       attr_reader :size
       alias_method :value, :size
 
-      TypeByte = 0x11
+      TYPE = 0x11
 
       def initialize(address, size, options = {})
         self.size = if size.kind_of?(Array) && size.count == 1