midi-message 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9796cb4569f21bfb836502370ca6329634b35900
-  data.tar.gz: 8fa9fd01613d569ebb0cb9aec601ebd14faec95f
+  metadata.gz: e474d330bc417e19471d1dbd4c931748445db639
+  data.tar.gz: 8516f6b1ee25c485bfbb7265d2e4e5620f7800ed
 SHA512:
-  metadata.gz: f714e1746e5fbd490f25b2ce0c582714a7e6c11edc0b0bf99a5d200796be8ba60f294aa77162425f3fe5b74f0b69231fbef0e0150565d0a72d40b55294b418ea
-  data.tar.gz: 21f9e7978fa17ab50f6c5fd8492bf92d1637986f7ba3a7e463a8b1e7a170ef0e1593285c3920b386d5002656045876ec70bb5b135a85640e0a77d7a1ece0a697
+  metadata.gz: 28b952c964be9603b65def9802d72fdf7a6c9d5b8641b537601b4b91be8c5889a7aec75cc3d396cecb25d98f62dfcbf1544d657f4a24efa61d012778bb96d46e
+  data.tar.gz: 61d515a21f72a2d7fd340d82067fe5401bb1ad142e940b94c6fa9e1fc9114b8bc43e0331558243812cf8334135f2676fa06a962217cb44a1927af911d7a55cde

data/README.md

@@ -22,8 +22,6 @@ Or if you're using Bundler, add this to your Gemfile
 
 ```ruby
 require "midi-message"
-  
-include MIDIMessage
 ```
   
 #### Basic Messages
@@ -31,11 +29,11 @@ include MIDIMessage
 There are a few ways to create a new MIDI message.  Here are some examples
  
 ```ruby   
-NoteOn.new(0, 64, 64)
+MIDIMessage::NoteOn.new(0, 64, 64)
   
-NoteOn["E4"].new(0, 100)
+MIDIMessage::NoteOn["E4"].new(0, 100)
   
-with(:channel => 0, :velocity => 100) { note_on("E4") }
+MIDIMessage.with(:channel => 0, :velocity => 100) { note_on("E4") }
 ```
 
 Those expressions all evaluate to the same object
@@ -56,7 +54,7 @@ Those expressions all evaluate to the same object
 As with any kind of message, you can begin with raw data
   
 ```ruby
-SystemExclusive.new(0xF0, 0x41, 0x10, 0x42, 0x12, 0x40, 0x00, 0x7F, 0x00, 0x41, 0xF7)
+MIDIMessage::SystemExclusive.new(0xF0, 0x41, 0x10, 0x42, 0x12, 0x40, 0x00, 0x7F, 0x00, 0x41, 0xF7)
 ```
   
 Or in a more object oriented way

data/lib/midi-message/context.rb

@@ -1,19 +1,27 @@
 module MIDIMessage
 
+  # A DSL for instantiating message objects
   class Context
-    
-    attr_accessor :channel,
-                  :velocity
-    
+
+    attr_accessor :channel, :velocity
+
+    # @param [Hash] options
+    # @option options [Fixnum] :channel
+    # @option options [Fixnum] :velocity
     def initialize(options = {})
       @channel = options[:channel]
-      @velocity = options[:velocity]  
+      @velocity = options[:velocity]
     end
 
+    # A note off message
+    # @param [Fixnum, String] note
+    # @param [Hash] options
+    # @option options [Fixnum] :channel
+    # @option options [Fixnum] :velocity
     def note_off(note, options = {})
       channel = options[:channel] || @channel
       velocity = options[:velocity] || @velocity
-      raise 'note_off requires both channel and velocity' if channel.nil? || velocity.nil?
+      raise "note_off requires both channel and velocity" if channel.nil? || velocity.nil?
       if note.kind_of?(String)
         NoteOff[note].new(channel, velocity, options)
       else
@@ -21,11 +29,16 @@ module MIDIMessage
       end
     end
     alias_method :NoteOff, :note_off
-    
+
+    # A note on message
+    # @param [Fixnum, String] note
+    # @param [Hash] options
+    # @option options [Fixnum] :channel
+    # @option options [Fixnum] :velocity
     def note_on(note, options = {})
       channel = options[:channel] || @channel
       velocity = options[:velocity] || @velocity
-      raise 'note_on requires both channel and velocity' if channel.nil? || velocity.nil?
+      raise "note_on requires both channel and velocity" if channel.nil? || velocity.nil?
       if note.kind_of?(String)
         NoteOn[note].new(channel, velocity, options)
       else
@@ -33,68 +46,98 @@ module MIDIMessage
       end
     end
     alias_method :NoteOn, :note_on
-    
+
+    # A program change message
+    # @param [Fixnum, String] program
+    # @param [Hash] options
+    # @option options [Fixnum] :channel
     def program_change(program, options = {})
       channel = options[:channel] || @channel
-      raise 'program_change requires channel' if channel.nil?
+      raise "program_change requires channel" if channel.nil?
       if program.kind_of?(String)
         ProgramChange[program].new(channel, options)
       else
         ProgramChange.new(channel, program, options)
-      end    
+      end
     end
     alias_method :ProgramChange, :program_change
-    
+
+    # A control change message
+    # @param [Fixnum, String] index
+    # @param [Fixnum] value
+    # @param [Hash] options
+    # @option options [Fixnum] :channel
+    # @option options [Fixnum] :velocity
     def control_change(index, value, options = {})
       channel = options[:channel] || @channel
-      raise 'control_change requires channel' if channel.nil?
+      raise "control_change requires channel" if channel.nil?
       if index.kind_of?(String)
         ControlChange[index].new(channel, value, options)
       else
         ControlChange.new(channel, index, value, options)
-      end    
+      end
     end
     alias_method :ControlChange, :control_change
     alias_method :Controller, :control_change
     alias_method :controller, :control_change
-    
+
+    # A poly pressure message
+    # @param [Fixnum, String] note
+    # @param [Fixnum] value
+    # @param [Hash] options
+    # @option options [Fixnum] :channel
     def polyphonic_aftertouch(note, value, options = {})
       channel = options[:channel] || @channel
-      raise 'channel_aftertouch requires a channel' if channel.nil?
+      raise "channel_aftertouch requires a channel" if channel.nil?
       if note.kind_of?(String)
         PolyphonicAftertouch[note].new(channel, value, options)
       else
         PolyphonicAftertouch.new(channel, note, value, options)
-      end    
+      end
     end
     alias_method :PolyphonicAftertouch, :polyphonic_aftertouch
-    alias_method :PolyAftertouch, :polyphonic_aftertouch    
+    alias_method :PolyAftertouch, :polyphonic_aftertouch
     alias_method :PolyphonicPressure, :polyphonic_aftertouch
-    alias_method :PolyPressure, :polyphonic_aftertouch    
+    alias_method :PolyPressure, :polyphonic_aftertouch
     alias_method :poly_aftertouch, :polyphonic_aftertouch
     alias_method :poly_pressure, :polyphonic_aftertouch
-        
+
+    # A channel pressure message
+    # @param [Fixnum] value
+    # @param [Hash] options
+    # @option options [Fixnum] :channel
     def channel_aftertouch(value, options = {})
       channel = options[:channel] || @channel
-      raise 'channel_aftertouch requires a channel' if channel.nil?
-      ChannelAftertouch.new(channel, value, options)    
+      raise "channel_aftertouch requires a channel" if channel.nil?
+      ChannelAftertouch.new(channel, value, options)
     end
     alias_method :ChannelAftertouch, :channel_aftertouch
-    alias_method :ChannelPressure, :channel_aftertouch    
+    alias_method :ChannelPressure, :channel_aftertouch
     alias_method :channel_pressure, :channel_aftertouch
-    
+
+    # A poly pressure message
+    # @param [Fixnum] low
+    # @param [Fixnum] high
+    # @param [Hash] options
+    # @option options [Fixnum] :channel
     def pitch_bend(low, high, options = {})
       channel = options[:channel] || @channel
-      raise 'channel_aftertouch requires a channel' if channel.nil?
-      PitchBend.new(channel, low, high, options)    
+      raise "channel_aftertouch requires a channel" if channel.nil?
+      PitchBend.new(channel, low, high, options)
     end
     alias_method :PitchBend, :pitch_bend
-    
+
   end
-  
-  def with_context(options = {}, &block)
+
+  # @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)
   end
-  alias_method :with, :with_context
+  class << self
+    alias_method :with, :with_context
+  end
 
 end

data/lib/midi-message.rb

@@ -4,11 +4,6 @@
 # (c)2011-2014 Ari Russo
 # Apache 2.0 License
 #
-module MIDIMessage
-
-  VERSION = "0.4.3"
-
-end
 
 # Libs
 require "forwardable"
@@ -27,3 +22,9 @@ require "midi-message/constant"
 require "midi-message/context"
 require "midi-message/message"
 require "midi-message/parser"
+
+module MIDIMessage
+
+  VERSION = "0.4.4"
+
+end

data/test/context_test.rb

@@ -4,10 +4,10 @@ require 'helper'
 
 class ContextTest < Test::Unit::TestCase
 
-  include MIDIMessage
   include TestHelper
+
   def test_note_off
-    msg = with(:channel => 0, :velocity => 64) do
+    msg = MIDIMessage.with(:channel => 0, :velocity => 64) do
       note_off(55)
     end
     assert_equal(0, msg.channel)
@@ -18,7 +18,7 @@ class ContextTest < Test::Unit::TestCase
   end
 
   def test_note_on
-    msg = with(:channel => 0, :velocity => 64) do
+    msg = MIDIMessage.with(:channel => 0, :velocity => 64) do
       note_on(55)
     end
     assert_equal(0, msg.channel)
@@ -29,7 +29,7 @@ class ContextTest < Test::Unit::TestCase
   end
 
   def test_control_change
-    msg = with(:channel => 2) do
+    msg = MIDIMessage.with(:channel => 2) do
       control_change(0x20, 0x30)
     end
     assert_equal(msg.channel, 2)
@@ -41,7 +41,7 @@ class ContextTest < Test::Unit::TestCase
   end
 
   def test_polyphonic_aftertouch
-    msg = with(:channel => 1) do
+    msg = MIDIMessage.with(:channel => 1) do
       polyphonic_aftertouch(0x40, 0x40)
     end
     assert_equal(1, msg.channel)
@@ -52,7 +52,7 @@ class ContextTest < Test::Unit::TestCase
   end
 
   def test_program_change
-    msg = with(:channel => 3) do
+    msg = MIDIMessage.with(:channel => 3) do
       program_change(0x40)
     end
     assert_equal(3, msg.channel)
@@ -63,7 +63,7 @@ class ContextTest < Test::Unit::TestCase
   end
 
   def test_channel_aftertouch
-    msg = with(:channel => 3) do
+    msg = MIDIMessage.with(:channel => 3) do
       channel_aftertouch(0x50)
     end
     assert_equal(3, msg.channel)
@@ -73,7 +73,7 @@ class ContextTest < Test::Unit::TestCase
   end
 
   def test_pitch_bend
-    msg = with(:channel => 0) do
+    msg = MIDIMessage.with(:channel => 0) do
       pitch_bend(0x50, 0xA0)
     end
     assert_equal(0, msg.channel)
@@ -83,4 +83,4 @@ class ContextTest < Test::Unit::TestCase
     assert_equal("E050A0", msg.to_bytestr)
   end
 
-end
+end

metadata

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