midi-message 0.3.2 → 0.4.1

data/lib/midi-message/short_message.rb

@@ -1,21 +1,22 @@
-#!/usr/bin/env ruby
-#
-
 module MIDIMessage
 
-  # common behavior amongst all Message types
+  # Common behavior amongst all Message types
   module ShortMessage
 
     attr_reader :name,
                 :status,
                 :verbose_name
-                  
+          
+    # Initialize the message status
+    # @param [Fixnum] status_nibble_1 The first nibble of the status
+    # @param [Fixnum] status_nibble_2 The second nibble of the status
     def initialize_short_message(status_nibble_1, status_nibble_2)
       @status = [status_nibble_1, status_nibble_2]
       populate_using_const
     end
     
-    # byte array representation of the object eg [0x90, 0x40, 0x40] for NoteOn(0x40, 0x40)
+    # 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
@@ -24,7 +25,8 @@ module MIDIMessage
     alias_method :to_byte_array, :to_a
     alias_method :to_bytes, :to_a
 
-    # string representation of the object's bytes eg "904040" for NoteOn(0x40, 0x40)
+    # String representation of the message's bytes eg "904040" for NoteOn(0x40, 0x40)
+    # @return [String] The bytes of the message as a string of hex bytes
     def to_hex_s
       TypeConversion.numeric_byte_array_to_hex_string(to_a)
     end
@@ -42,16 +44,16 @@ module MIDIMessage
     
     private
     
-    # this will populate message metadata with information gathered from midi.yml
+    # This will populate message metadata with information gathered from midi.yml
     def populate_using_const
       const_group_name = self.class.display_name
-      group_name_alias = self.class.constants
-      prop = self.class.map_constants_to
-      val = self.send(prop) unless prop.nil?
-      val ||= @status[1] # default property to use for constants
+      group_name_alias = self.class.constant_name
+      property = self.class.constant_property
+      value = self.send(property) unless property.nil?
+      value ||= @status[1] # default property to use for constants
       group = ConstantGroup[group_name_alias] || ConstantGroup[const_group_name]
       unless group.nil?
-        const = group.find_by_value(val)
+        const = group.find_by_value(value)
         unless const.nil?
           @const = const
           @name = @const.nil? ? const.key : @const.key
@@ -61,38 +63,50 @@ module MIDIMessage
     end
 
     module ClassMethods
-      
-      attr_reader :display_name, :constants, :map_constants_to 
-      
+            
+      # Find a constant value in this class's group for the passed in key
+      # @param [String] name The constant key
+      # @return [String] The constant value
       def get_constant(name)        
-        key = @constants || @display_name
+        key = constant_name || display_name
         unless key.nil?
           group = ConstantGroup[key]
           group.find(name)
         end 
       end
 
-      # this returns a builder for the class, preloaded with the selected const
-      def [](const_name)
-        const = get_constant(const_name)
-        MessageBuilder.new(self, const) unless const.nil?
+      def display_name
+        const_get("DISPLAY_NAME") if const_defined?("DISPLAY_NAME")
       end
-      
-      def use_display_name(name)
-        @display_name = name
+
+      def constant_map
+        const_get("CONSTANT") if const_defined?("CONSTANT")
       end
 
-      def use_constants(name, options = {}) 
-        @map_constants_to = options[:for]
-        @constants = name
+      def constant_name
+        constant_map.keys.first unless constant_map.nil?
       end
 
+      def constant_property
+        constant_map[constant_name] unless constant_map.nil?
+      end
+
+      # 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)
+        const = get_constant(const_name.to_s)
+        MessageBuilder.new(self, const) unless const.nil?
+      end
+      
     end
 
   end
 
   class MessageBuilder
 
+    # @param [MIDIMessage] klass The message class to build
+    # @param [String] const The constant to build the message with
     def initialize(klass, const)      
       @klass = klass      
       @const = const
@@ -105,10 +119,12 @@ module MIDIMessage
 
   end
   
-  # shortcuts for dealing with message status
+  # Shortcuts for dealing with message status
   module Status
     
-    # this returns the value of the Status constant with the name status_name
+    # 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)
       const = Constant.find("Status", status_name)
       const.value unless const.nil?

data/lib/midi-message/system_exclusive.rb

@@ -1,21 +1,17 @@
-#!/usr/bin/env ruby
-#
-
 module MIDIMessage
 
   # MIDI System-Exclusive Messages (SysEx)
   module SystemExclusive
 
-    # basic SysEx data that a message class will contain
-    module Base
+    # Common SysEx data that a message class will contain
+    module InstanceMethods
 
       attr_accessor :node
-      attr_reader :address,
-                  :checksum
+      attr_reader :address, :checksum
 
       StartByte = 0xF0
       EndByte = 0xF7
-      
+
       # an array of message parts.  multiple byte parts will be represented as an array of bytes
       def to_a(options = {})
         omit = options[:omit] || [] 
@@ -40,13 +36,13 @@ module MIDIMessage
       alias_method :to_byte_array, :to_numeric_byte_array
       alias_method :to_bytes, :to_numeric_byte_array
       alias_method :to_byte_a, :to_numeric_byte_array
-      
+
       # 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
       end
       alias_method :to_bytestr, :to_hex_s
-      
+
       def name
         "System Exclusive"
       end
@@ -55,14 +51,14 @@ module MIDIMessage
       def type_byte
         self.class::TypeByte
       end
-      
+
       # 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])
       end
-      
+
       private
 
       def initialize_sysex(address, options = {})
@@ -70,79 +66,22 @@ module MIDIMessage
         @checksum = options[:checksum]
         @address = address
       end
-      
-    end
-
-    # A SysEx command message
-    # a command message is identified by having a status byte equal to 0x12
-    #
-    class Command
 
-      include Base
-
-      attr_accessor :data
-      alias_method :value, :data
-      #alias_method :value=, :data=
-
-      TypeByte = 0x12
-      
-      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
-        initialize_sysex(address, options)
-      end
-      
     end
-    
-    # A SysEx request message
-    # A request message is identified by having a status byte equal to 0x11
-    #
-    class Request
-
-      include Base
-      
-      attr_reader :size
 
-      alias_method :value, :size
-
-      TypeByte = 0x11
-      
-      def initialize(address, size, options = {})
-        self.size = (size.kind_of?(Array) && size.length.eql?(1)) ? size[0] : size
-        initialize_sysex(address, options)
-      end
-      
-      def size=(val)
-        # 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)
-          size = []
-          div, mod = *val.divmod(247)
-          size << mod unless mod.zero?
-          div.times { size << 247 }
-        end
-        (3 - size.size).times { size.unshift 0 }
-        @size = size
-      end
-      
-    end
-    
     # A SysEx message with no implied type
     #
     class Message
 
-      include Base
-      
+      include InstanceMethods
+
       attr_accessor :data
-      
+
       def initialize(data, options = {})
         @data = (data.kind_of?(Array) && data.length.eql?(1)) ? data[0] : data
         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] || [] 
@@ -155,7 +94,7 @@ module MIDIMessage
           self.class::EndByte
         ].compact
       end
-      
+
     end
 
     #
@@ -166,13 +105,13 @@ module MIDIMessage
 
       attr_accessor :device_id
       attr_reader :manufacturer_id, :model_id
-      
+
       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
       end
-      
+
       def to_a(options = {})
         omit = options[:omit] || [] 
         [
@@ -189,14 +128,14 @@ module MIDIMessage
         copy.node = self
         copy
       end
-      
+
       # create a new Command message associated with this node
       def command(*a)
         command = Command.new(*a)
         command.node = self
         command
       end
-      
+
       # create a new Request message associated with this node
       def request(*a)
         request = Request.new(*a)
@@ -205,40 +144,41 @@ module MIDIMessage
       end
 
     end
-    
-    # convert raw MIDI data to SysEx message objects
+
+    # Convert raw MIDI data to SysEx message objects
     def self.new(*bytes)
 
       start_status = bytes.shift
       end_status = bytes.pop
 
-      return nil unless start_status.eql?(0xF0) && end_status.eql?(0xF7)
-      
-      type_byte = bytes[3]
-      
-      # if the 4th byte isn't status, we will just make this a Message object -- this may need some tweaking
-      if type_byte == 0x11
-        msg_class = Request
-      elsif type_byte == 0x12
-        msg_class = Command
-      else 
-        return Message.new(bytes)
-      end
-      
-      fixed_length_message_part = bytes.slice!(0,7)
+      if start_status.eql?(0xF0) && end_status.eql?(0xF7)
 
-      manufacturer_id = fixed_length_message_part[0]
-      device_id = fixed_length_message_part[1]
-      model_id = fixed_length_message_part[2]
+        type_byte = bytes[3]
 
-      address = fixed_length_message_part.slice(4,3)
-      checksum = bytes.slice!((bytes.length - 1), 1)
-      value = bytes
+        # if the 4th byte isn't status, we will just make this a Message object -- this may need some tweaking
+        if type_byte == 0x11
+          msg_class = Request
+        elsif type_byte == 0x12
+          msg_class = Command
+        else 
+          return Message.new(bytes)
+        end
 
-      node = Node.new(manufacturer_id, :model_id => model_id, :device_id => device_id)
-      msg_class.new(address, value, :checksum => checksum, :node => node)
+        fixed_length_message_part = bytes.slice!(0,7)
+
+        manufacturer_id = fixed_length_message_part[0]
+        device_id = fixed_length_message_part[1]
+        model_id = fixed_length_message_part[2]
+
+        address = fixed_length_message_part.slice(4,3)
+        checksum = bytes.slice!((bytes.length - 1), 1)
+        value = bytes
+
+        node = Node.new(manufacturer_id, :model_id => model_id, :device_id => device_id)
+        msg_class.new(address, value, :checksum => checksum, :node => node)
+      end
     end
 
   end
 
-end
+end

data/lib/midi-message/system_message.rb

@@ -1,67 +1,21 @@
-#!/usr/bin/env ruby
-#
-
 module MIDIMessage
 
-  #
-  # MIDI System message
-  #
+  # Common MIDI system message behavior
   module SystemMessage
 
+    def self.included(base)
+      base.include(ShortMessage)
+    end
+
     # In the case of something like SystemCommon.new(0xF2, 0x00, 0x08), the first nibble F is redundant because
     # all system messages start with 0xF and it can be assumed.
     # However, the this method looks to see if this has occurred and strips the redundancy
-    # @param [Integer] byte The byte to strip of a redundant 0xF
-    # @return [Integer] The remaining nibble
+    # @param [Fixnum] byte The byte to strip of a redundant 0xF
+    # @return [Fixnum] The remaining nibble
     def strip_redundant_nibble(byte)
       byte > 0xF ? (byte & 0x0F) : byte
     end
 
   end
-  
-  #
-  # MIDI System-Common message
-  #
-  class SystemCommon
-
-    include ShortMessage
-    include SystemMessage
-    use_display_name 'System Common'
-    
-    attr_reader :data
-    
-    def initialize(*a)
-      options = a.last.kind_of?(Hash) ? a.pop : {}
-      @const = options[:const]
-      id = @const.nil? ? a.shift : @const.value
-      id = strip_redundant_nibble(id)
-      initialize_short_message(0xF, id)
-      @data = [a[0], a[1]]
-    end
     
-  end  
-  
-  #
-  # MIDI System-Realtime message
-  #
-  class SystemRealtime
-
-    include ShortMessage
-    include SystemMessage
-    use_display_name 'System Realtime'
-    
-    def initialize(*a)
-      options = a.last.kind_of?(Hash) ? a.pop : {} 
-      @const = options[:const]
-      id = @const.nil? ? a[0] : @const.value
-      id = strip_redundant_nibble(id)
-      initialize_short_message(0xF, id)
-    end
-
-    def id
-      @status[1]
-    end
-
-  end
-  
 end

data/lib/midi-message/type_conversion.rb

@@ -1,11 +1,11 @@
-#!/usr/bin/env ruby
-#
 module MIDIMessage
  
-  # this is a helper for converting nibbles and bytes
+  # Helper for converting nibbles and bytes
   module TypeConversion
     
-    def self.hex_chars_to_numeric_byte_array(nibbles)
+    extend self
+
+    def hex_chars_to_numeric_byte_array(nibbles)
       nibbles = nibbles.dup
       # get rid of last nibble if there's an odd number
       # it will be processed later anyway
@@ -18,8 +18,8 @@ module MIDIMessage
       bytes
     end
     
-    # convert byte str to byte array 
-    def self.hex_string_to_numeric_byte_array(str)
+    # Convert byte str to byte array 
+    def hex_string_to_numeric_byte_array(str)
       str = str.dup
       bytes = []
       until str.eql?("")
@@ -28,20 +28,20 @@ module MIDIMessage
       bytes
     end
     
-    # converts a string of hex digits to bytes
-    def self.hex_str_to_hex_chars(str)
+    # Converts a string of hex digits to bytes
+    def hex_str_to_hex_chars(str)
       str.split(//)    
     end
     
-    def self.numeric_byte_array_to_hex_string(bytes)
+    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
     end
     
-    def self.numeric_byte_to_hex_chars(num)
+    def numeric_byte_to_hex_chars(num)
       [((num & 0xF0) >> 4), (num & 0x0F)].map { |n| n.to_s(16) }      
     end
 
     
   end
   
-end
+end

data/lib/midi-message.rb

@@ -1,40 +1,29 @@
-#!/usr/bin/env ruby
 #
-# MIDI Messages in Ruby
-# (c)2011 Ari Russo and licensed under the Apache 2.0 License
+# Ruby MIDI message objects
+#
+# (c)2011-2014 Ari Russo and licensed under the Apache 2.0 License
 # 
 module MIDIMessage
-  
-  module Event
-  end
-  
-  module Process    
-  end
-  
-  VERSION = "0.3.2"
+    
+  VERSION = "0.4.1"
  
 end
 
-# libs
+# Libs
 require "forwardable"
 require "yaml"
 
-# messages (mixed format)
+# Modules
 require "midi-message/short_message"
 require "midi-message/channel_message"
-require "midi-message/constant"
-require "midi-message/context"
 require "midi-message/note_message"
-require "midi-message/parser"
-require "midi-message/system_message"
 require "midi-message/system_exclusive"
+require "midi-message/system_message"
 require "midi-message/type_conversion"
 
-# modules
-require "midi-message/process/processor"
+# Classes
+require "midi-message/constant"
+require "midi-message/context"
+require "midi-message/message"
+require "midi-message/parser"
 
-# classes
-require "midi-message/event/note"
-require "midi-message/process/filter"
-require "midi-message/process/limit"
-require "midi-message/process/transpose"

metadata

@@ -1,77 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: midi-message
 version: !ruby/object:Gem::Version
-  version: 0.3.2
-  prerelease: 
+  version: 0.4.1
 platform: ruby
 authors:
 - Ari Russo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-17 00:00:00.000000000 Z
+date: 2014-09-01 00:00:00.000000000 Z
 dependencies: []
-description: MIDI messages, objectified in Ruby
+description: Objects and classes for dealing with MIDI messages.
 email:
 - ari.russo@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- lib/midi-message.rb
 - lib/midi-message/channel_message.rb
 - lib/midi-message/constant.rb
 - lib/midi-message/context.rb
-- lib/midi-message/event/note.rb
+- lib/midi-message/message.rb
 - lib/midi-message/note_message.rb
 - lib/midi-message/parser.rb
-- lib/midi-message/process/filter.rb
-- lib/midi-message/process/limit.rb
-- lib/midi-message/process/processor.rb
-- lib/midi-message/process/transpose.rb
 - lib/midi-message/short_message.rb
 - lib/midi-message/system_exclusive.rb
 - lib/midi-message/system_message.rb
 - lib/midi-message/type_conversion.rb
-- lib/midi-message.rb
 - lib/midi.yml
+- test/constants_test.rb
+- test/context_test.rb
 - test/helper.rb
-- test/test_constants.rb
-- test/test_context.rb
-- test/test_filter.rb
-- test/test_limit.rb
-- test/test_mutability.rb
-- test/test_note_event.rb
-- test/test_parser.rb
-- test/test_processor.rb
-- test/test_short_message.rb
-- test/test_system_exclusive.rb
-- test/test_system_message.rb
-- test/test_transpose.rb
-- LICENSE
-- README.rdoc
-- TODO
+- test/mutability_test.rb
+- test/parser_test.rb
+- test/short_message_test.rb
+- test/system_exclusive_test.rb
+- test/system_message_test.rb
 homepage: http://github.com/arirusso/midi-message
-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: midi-message
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: MIDI messages, objectified in Ruby
+specification_version: 4
+summary: Ruby MIDI message objects
 test_files: []