vissen-input 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf9e2d7e4ab570645627dab31c509d35c94c1dd0fab403113505fcd807acf4ec
-  data.tar.gz: 12845d0b04e56faf957a4780d0a04e671d304197a9d0b2040f7c5665ab1aa0fc
+  metadata.gz: ba0c28648eb117befa313aef9e8e83f2e1b75db97f2d5899f727368c9bd39926
+  data.tar.gz: c3207e55160d602acf04008df707fbf20388de7ac209be2e37b2cf37e88abef1
 SHA512:
-  metadata.gz: 560ac7d4f5e7670e2ebf5d79fd8e4ce5ada839b61ab8ec30815bf44be5b6e5b5e683aac9f992f1e003bdc2c22947cb2db5a8a97e4209b87636391e88de46d30d
-  data.tar.gz: ed3da5a2f4f479dcc9ef4fac688945ebdda4ec2b1a3c7e045ffb991babe330201f53e076c39e5783ead938e1cf1b2309bab84c6b70d59637fe5f5b6c3624330e
+  metadata.gz: cddb65a57ed9b49f7a6b9e367d133cd095586f6f05b6e75b975b8a9a2fdea31e49034bffebd7d2635447a743a498cfb4bfba51dc947003f24bb2dc1dab6fbddb
+  data.tar.gz: d88b5534407b282d7c9f35bf360d9a1f185a3a2871cd205125daeeaafac560b00799074700d799c9bb4edd26376c2c0712c4d638a65d12f4359797b5046d0116

data/.rubocop.yml

@@ -46,3 +46,21 @@ Metrics/BlockLength:
 Metrics/ModuleLength:
   Exclude:
     - 'test/**/*.rb'
+
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+    - 'io'
+    - 'id'
+    - 'to'
+    - 'by'
+    - 'on'
+    - 'in'
+    - 'at'
+    - '_'
+
+Style/MixinUsage:
+  Exclude:
+    - 'examples/*.rb'
+    
+Style/FormatStringToken:
+  Enabled: false

data/.yardopts

@@ -0,0 +1,2 @@
+--markup-provider=redcarpet
+--markup=markdown

data/CHANGELOG.md

@@ -5,6 +5,15 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Message#to_h converts messages into a Hash format that include their data and timestamp.
+- Matcher#match accepts a message and yields it in case of a match.
+
+### Changed
+- Improved the documentation.
+- Matcher#match? now also accepts a Hash.
+- Broker#publish now accepts raw messages and handles the conversion into message objects.
+- Broker#publish no longer accepts an array.
 
 ## [0.2.2] - 2018-04-18
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vissen-input (0.2.2)
+    vissen-input (0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -16,6 +16,7 @@ GEM
     powerpack (0.1.1)
     rainbow (3.0.0)
     rake (10.5.0)
+    redcarpet (3.4.0)
     rubocop (0.55.0)
       parallel (~> 1.10)
       parser (>= 2.5)
@@ -30,6 +31,7 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     unicode-display_width (1.3.0)
+    yard (0.9.12)
 
 PLATFORMS
   ruby
@@ -38,9 +40,11 @@ DEPENDENCIES
   bundler (~> 1.16)
   minitest (~> 5.0)
   rake (~> 10.0)
+  redcarpet (~> 3.4)
   rubocop (~> 0.52)
   simplecov (~> 0.16)
   vissen-input!
+  yard (~> 0.9)
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -1,7 +1,9 @@
-# Vissen::Input
+# 🥀 Vissen Input
 
+[![Gem Version](https://badge.fury.io/rb/vissen-input.svg)](https://badge.fury.io/rb/vissen-input)
 [![Build Status](https://travis-ci.org/midi-visualizer/vissen-input.svg?branch=master)](https://travis-ci.org/midi-visualizer/vissen-input)
 [![Inline docs](http://inch-ci.org/github/midi-visualizer/vissen-input.svg?branch=master)](http://inch-ci.org/github/midi-visualizer/vissen-input)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/vissen-input/)
 
 ## Installation
 
@@ -21,7 +23,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+include Vissen::Input
+
+# First we setup a broker.
+broker = Broker.new
+
+# We then subscribe to a message type and provide a callback.
+broker.subscribe Message::Note[0] do |msg|
+    play msg.note if msg.on?
+end
+
+# We simulate a raw note on message arriving to the broker
+# at time 4.2.
+broker.publish data: [0x90, 42, 0], timestamp: 4.2
+
+# Finally we let the broker process the next message in its
+# queue. The callback should now have been called.
+broker.run_once
+```
+
+Please see the [documentation](http://www.rubydoc.info/gems/vissen-input/) for more details.
 
 ## Development
 

data/Rakefile

@@ -2,6 +2,8 @@
 
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'yard'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
@@ -9,4 +11,13 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task default: :test
+RuboCop::RakeTask.new(:rubocop)
+
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.stats_options = %w[--list-undoc]
+end
+
+desc 'Generate Ruby documentation'
+task doc: %w[yard]
+
+task default: %w[test rubocop:auto_correct]

data/examples/raw_input_stream.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'benchmark'
+require 'vissen/input'
+include Vissen::Input
+
+T = 4.2
+N = 100_000
+
+# First we setup a broker.
+broker = Broker.new
+
+Counter = Struct.new :count, :limit do
+  def call(_, _)
+    self.count += 1
+  end
+
+  def percent
+    count.to_f / limit * 100
+  end
+end
+
+counter = Counter.new 0, N
+
+# Subscribe to some messages
+broker.subscribe(Message::Note[5, 1],        counter)
+broker.subscribe(Message::ControlChange[8],  counter)
+broker.subscribe(Message::ProgramChange[15], counter)
+broker.subscribe(Message::PitchBendChange,   counter)
+broker.subscribe(Message::Aftertouch,        counter)
+
+# We then define the message generation process.
+stream_generator = proc { [rand(0..255), rand(0..127), 0] }
+
+puts 'Benchmark results:'
+
+res =
+  Benchmark.bm(10, 'Real') do |x|
+    # We measure just the random message generation as a
+    # baseline.
+    bl = x.report('Baseline') do
+      N.times { { data: stream_generator.call, timestamp: T } }
+    end
+
+    # We then let the factory build N messages from the
+    # random message stream.
+    fa = x.report('Factory') do
+      N.times do
+        broker.publish(data: stream_generator.call, timestamp: T)
+        broker.run_once
+      end
+    end
+
+    # We remove the baseline from the result.
+    re = fa - bl
+
+    [re]
+  end
+
+puts
+puts format('%d messages processed (%0.1f%%)', counter.count, counter.percent)
+puts format('%.2f us per message', res.last.utime * (1_000_000 / N))
+puts format('%.0f messages per second', N / res.last.utime)

data/lib/vissen/input.rb

@@ -19,8 +19,6 @@ require 'vissen/input/message/program_change'
 require 'vissen/input/message/unknown'
 
 module Vissen
-  # Input
-  #
   # This module includes all the input messages that can be sent to the vissen
   # engine, as well as some facilities for converting them to and from their
   # binary form.

data/lib/vissen/input/broker.rb

@@ -74,9 +74,11 @@ module Vissen
       # Insert a new message into the message queue. The message is handled at a
       # later time in `#run_once`.
       #
-      # @param  message [Message] the message(s) to handle.
+      # @param  message [Message, Hash] the message(s) to handle.
       def publish(*message)
-        message.each { |m| @message_queue.push m }
+        message.each do |m|
+          @message_queue.push m
+        end
       end
 
       # Takes one message from the message queue and handles it.
@@ -100,16 +102,18 @@ module Vissen
         # TODO: Remap the message if needed.
         @subscriptions.each do |subscription|
           break if ctrl.stop?(subscription.priority)
-          next unless subscription.match? message
 
-          subscription.handle message, ctrl
+          subscription.match message do |msg|
+            subscription.handle msg, ctrl
+            message = msg
+          end
         end
         nil
       end
 
       private
 
-      # Insert of append a new subscription to the list. The subscription will
+      # Insert or append a new subscription to the list. The subscription will
       # be placed before the first subscription that is found to have a lower
       # priority, or last.
       #
@@ -152,7 +156,8 @@ module Vissen
           @current_priority = 0
         end
 
-        # @param  [Integer] the priority to test if
+        # @param  priority [Integer] the priority to check out stopping
+        #   condition against.
         # @return [true, false] whether to stop or not.
         def stop?(priority)
           return true if priority < @stop_at_priority

data/lib/vissen/input/matcher.rb

@@ -17,6 +17,8 @@ module Vissen
     #   matcher.match? [0xA0, 0, 0] # => true
     #
     class Matcher
+      # @return [Message] the message class responsible for the messages that
+      #   this matcher matches.
       attr_reader :klass
 
       # @param message_klass [Message] the message class that should be used to
@@ -36,14 +38,43 @@ module Vissen
       # Match either a byte array or a `Message` against the rule stored in the
       # matcher.
       #
-      # @param  obj [#to_a] the message data to match.
+      # @raise  [KeyError] if `obj` is a `Hash` but does not include the `:data`
+      #   key.
+      #
+      # @param  obj [Hash, #to_a] the message data to match.
       # @return [true, false] true if the data matches.
       def match?(obj)
-        data = obj.to_a
+        data = obj.is_a?(Hash) ? obj.fetch(:data) : obj.to_a
 
-        return false unless data.length >= @klass::DATA_LENGTH
+        return false if data.length < @klass::DATA_LENGTH
         @rule.call data
       end
+
+      # Matches either a hash or a `Message` against the internal matching rule.
+      # If the object matches and is not a `Message` object a new instance will
+      # be created.
+      #
+      # If a block is given the message will be yielded to it.
+      #
+      # @param  obj [Message, Hash] the message to be matched.
+      # @return [false] if the object does not match.
+      # @return [Object] the return value of the given block, if a block was
+      #   given.
+      # @return [Message] the given message if it is a `Message` or a new
+      #   instance.
+      def match(obj)
+        data = obj.fetch :data
+        return false if data.length < @klass::DATA_LENGTH || !@rule.call(data)
+
+        message =
+          case obj
+          when Message then obj
+          when Hash then @klass.new data, obj.fetch(:timestamp)
+          end
+
+        return message unless block_given?
+        yield message
+      end
     end
   end
 end

data/lib/vissen/input/message.rb

@@ -22,14 +22,22 @@ module Vissen
     # term _status_ is, howerver, sometimes also used to name only the upper
     # nibble of the status field.
     module Message
+      # The status mask determines which bits of the first byte belong to the
+      # status code.
       STATUS_MASK  = 0xF0
+
+      # The channel mask determines which bits of the first byte belong to the
+      # channel value.
       CHANNEL_MASK = 0x0F
+
+      # Data length specifies what number of bytes must be present in the raw
+      # message for it to be valid.
       DATA_LENGTH  = 1
 
-      # @return [Array<Integer>]
+      # @return [Array<Integer>] the raw message data.
       attr_reader :data
 
-      # @return [Float]
+      # @return [Float] the time of arrival for the message.
       attr_reader :timestamp
 
       # Allow a message to pass for the raw byte array
@@ -52,6 +60,32 @@ module Vissen
         true
       end
 
+      # Converts the message back into a raw hash representation. The format is
+      # intentionally similar to the output of the `Unimidi` gem.
+      #
+      # @return [Hash] a hash containing both the message data and the timestamp
+      #   marking when it arrived.
+      def to_h
+        { data: @data, timestamp: @timestamp }.freeze
+      end
+
+      # Allows every message instance to pass for a `Hash` object on the same
+      # form returned by #to_h.
+      #
+      # @raise  [KeyError] unless the given key is `:data` or `:timestamp`.
+      #
+      # @param  key [Symbol] the field to fetch (either `:data` or
+      #   `:timestamp`).
+      # @return [Array<Integer>] when key is `:data`.
+      # @return [Float] when key is `:timestamp`.
+      def fetch(key)
+        case key
+        when :data then @data
+        when :timestamp then @timestamp
+        else raise KeyError
+        end
+      end
+
       # @return [Integer] the message status.
       def status
         @data[0] & self.class::STATUS_MASK

data/lib/vissen/input/message/aftertouch.rb

@@ -4,9 +4,11 @@ module Vissen
   module Input
     module Message
       # From the MIDI Association:
-      #   Polyphonic Key Pressure (Aftertouch). This message is most often sent
-      #   by pressing down on the key after it "bottoms out".
+      #
+      # > Polyphonic Key Pressure (Aftertouch). This message is most often sent
+      # > by pressing down on the key after it "bottoms out".
       class Aftertouch < Base
+        # @see Message
         STATUS = 0xA0
 
         # @return [Integer] the note value.

data/lib/vissen/input/message/base.rb

@@ -13,7 +13,9 @@ module Vissen
       class Base
         include Message
 
+        # @see Message
         DATA_LENGTH = 3
+        # @see Message
         STATUS      = 0
 
         # Checks message data consistency with the class default matcher.
@@ -25,6 +27,9 @@ module Vissen
         end
 
         class << self
+          extend Forwardable
+          # rubocop:disable Metrics/AbcSize
+
           # Returns a new instance of a Matcher, configured to match this
           # particular Message class. Subclasses of Base can utilize the same
           # functionality by simply redefining STATUS and, if necessary,
@@ -54,13 +59,25 @@ module Vissen
             end
           end
 
-          # Accessor for the class default matcher.
+          # rubocop:enable Metrics/AbcSize
+
+          # @!method match?(obj)
+          # Accessor to `Matcher#match?` on the default class matcher.
           #
-          # @param  message [#to_a] the message or data to match.
-          # @return [true, false] see `Matcher#match?`.
-          def match?(message)
-            matcher.match? message
-          end
+          # @see Matcher#match?
+          #
+          # @param  obj [#to_a] the message or data to match.
+          # @return [true, false] (see Matcher#match?)
+          def_delegator :klass_matcher, :match?, :match?
+
+          # @!method match(obj)
+          # Accessor to `Matcher#match` on the default class matcher.
+          #
+          # @see Matcher#match
+          #
+          # @param  obj [Hash, Message] the message to match.
+          # @return [false, Object, Message] (see Matcher#match)
+          def_delegator :klass_matcher, :match, :match
 
           # Creates a new factory with all the subclasses of base added to it as
           # matchers.
@@ -74,6 +91,8 @@ module Vissen
 
           # Alias to `#matcher` that swaps named arguments for positional ones.
           #
+          # @see #matcher
+          #
           # @param  (see #matcher)
           # @return (see #matcher)
           def [](channel, number = nil)
@@ -116,18 +135,52 @@ module Vissen
 
           protected
 
+          # Called automatically by inheriting classes.
+          #
+          # @param  subclass [Base] the inheriting class.
+          # @return [nil]
           def inherited(subclass)
             (@subclasses ||= []) << subclass
+            nil
           end
 
+          # Helper method to validate a status value.
+          #
+          # @raise  [RangeError] if the status is outside its allowable range.
+          #
+          # @param  status [Integer] the status to validate.
+          # @return [true] when the status is valid.
           def validate_status(status)
             raise RangeError unless (status & ~STATUS_MASK).zero?
+            true
           end
 
+          # Helper method to validate a channel value.
+          #
+          # @raise  [RangeError] if the channel is outside its allowable range.
+          #
+          # @param  channel [Integer] the channel to validate.
+          # @return [true] when the channel is valid.
           def validate_channel(channel)
             raise RangeError unless (channel & ~CHANNEL_MASK).zero?
+            true
           end
 
+          # Creates a value and mask that can be used to match the first byte of
+          # a message.
+          #
+          # == Usage
+          # The following example illustrates how the value and mask are
+          # intended to be used.
+          #
+          #   value, mask = status_value_and_mask
+          #   0x42 & mask == value # => true if STATUS == 0x40
+          #
+          #   value, mask = status_value_and_mask 3
+          #   0x42 & mask == value # => false since channel is 2
+          #
+          # @param  channel [Integer] the channel to match.
+          # @return [Array<Integer>] a value and a mask.
           def status_value_and_mask(channel = nil)
             if channel
               validate_channel channel
@@ -138,6 +191,16 @@ module Vissen
             end
           end
 
+          # The klass matcher is the most generic `Matcher` for the message
+          # class and is cached to avoid duplication. By default the default
+          # `Matcher` uses the value and mask returned by
+          # `#status_value_and_mask` to match messages. Subclasses that need
+          # different behaviour can pass a block to be forwarded directly to the
+          # matcher (see Matcher.new).
+          #
+          # @param  block [Proc] the block that should be passed to
+          #   `Matcher.new` when first creating the matcher.
+          # @return [Matcher] a matcher that matches all messages of this type.
           def klass_matcher(&block)
             return @klass_matcher if defined?(@klass_matcher)
 

data/lib/vissen/input/message/channel_mode.rb

@@ -4,26 +4,29 @@ module Vissen
   module Input
     module Message
       # From the MIDI Association:
-      #   This the same code as the Control Change (above), but implements Mode
-      #   control and special message by using reserved controller numbers
-      #   120-127. The commands are:
       #
-      #   - All Sound Off (120)
-      #       When All Sound Off is received all oscillators will turn off, and
-      #       their volume envelopes are set to zero as soon as possible.
-      #   - Reset All Controllers (121)
-      #       When Reset All Controllers is received, all controller values are
-      #       reset to their default values.
-      #   - Local Control (122)
-      #       When Local Control is Off, all devices on a given channel will
-      #       respond only to data received over MIDI. Played data, etc. will be
-      #       ignored. Local Control On restores the functions of the normal
-      #       controllers.
-      #   - All Notes Off (123..127)
-      #       When an All Notes Off is received, all oscillators will turn off.
+      # > This the same code as the Control Change (above), but implements Mode
+      # > control and special message by using reserved controller numbers
+      # > 120-127. The commands are:
+      #
+      # > - All Sound Off (120)
+      # >     When All Sound Off is received all oscillators will turn off, and
+      # >     their volume envelopes are set to zero as soon as possible.
+      # > - Reset All Controllers (121)
+      # >     When Reset All Controllers is received, all controller values are
+      # >     reset to their default values.
+      # > - Local Control (122)
+      # >     When Local Control is Off, all devices on a given channel will
+      # >     respond only to data received over MIDI. Played data, etc. will be
+      # >     ignored. Local Control On restores the functions of the normal
+      # >     controllers.
+      # > - All Notes Off (123..127)
+      # >     When an All Notes Off is received, all oscillators will turn off.
       #
       class ChannelMode < Base
+        # @see Message
         DATA_LENGTH = 2
+        # @see Message
         STATUS      = 0xB0
 
         # @return [Integer] the control number.

data/lib/vissen/input/message/channel_pressure.rb

@@ -4,13 +4,16 @@ module Vissen
   module Input
     module Message
       # From the MIDI Association:
-      #   Channel Pressure (After-touch). This message is most often sent by
-      #   pressing down on the key after it "bottoms out". This message is
-      #   different from polyphonic after-touch. Use this message to send the
-      #   single greatest pressure value (of all the current depressed keys)
+      #
+      # > Channel Pressure (After-touch). This message is most often sent by
+      # > pressing down on the key after it "bottoms out". This message is
+      # > different from polyphonic after-touch. Use this message to send the
+      # > single greatest pressure value (of all the current depressed keys)
       class ChannelPressure < Base
-        STATUS      = 0xD0
+        # @see Message
         DATA_LENGTH = 2
+        # @see Message
+        STATUS      = 0xD0
 
         # @return [Integer] the pressure value.
         def pressure

data/lib/vissen/input/message/control_change.rb

@@ -4,10 +4,12 @@ module Vissen
   module Input
     module Message
       # From the MIDI Association:
-      #   This message is sent when a controller value changes. Controllers
-      #   include devices such as pedals and levers. Controller numbers 120-127
-      #   are reserved as "Channel Mode Messages".
+      #
+      # > This message is sent when a controller value changes. Controllers
+      # > include devices such as pedals and levers. Controller numbers 120-127
+      # > are reserved as "Channel Mode Messages".
       class ControlChange < Base
+        # @see Message
         STATUS = 0xB0
 
         # @return [Integer] the control number.

data/lib/vissen/input/message/note.rb

@@ -4,15 +4,24 @@ module Vissen
   module Input
     module Message
       # From the MIDI Association:
-      #   Note On event.
-      #   This message is sent when a note is depressed (start).
       #
-      #   Note Off event.
-      #   This message is sent when a note is released (ended).
+      # > Note On event.
+      # > This message is sent when a note is depressed (start).
+      #
+      # > Note Off event.
+      # > This message is sent when a note is released (ended).
       class Note < Base
+        # @see Message
         STATUS_MASK = 0xE0
+        # @see Message
         STATUS      = 0x80
+
+        # Note On specifies the value of the lowest status bit for note on
+        # messages.
         NOTE_ON     = 0x10
+
+        # Note On specifies the value of the lowest status bit for note off
+        # messages.
         NOTE_OFF    = 0x00
 
         # @return [Integer] the note value.

data/lib/vissen/input/message/pitch_bend_change.rb

@@ -4,12 +4,17 @@ module Vissen
   module Input
     module Message
       # From the MIDI Association:
-      #   This message is sent to indicate a change in the pitch bender (wheel
-      #   or lever, typically). The pitch bender is measured by a fourteen bit
-      #   value. Center (no pitch change) is 2000H. Sensitivity is a function of
-      #   the receiver, but may be set using RPN 0.
+      #
+      # > This message is sent to indicate a change in the pitch bender (wheel
+      # > or lever, typically). The pitch bender is measured by a fourteen bit
+      # > value. Center (no pitch change) is 2000H. Sensitivity is a function of
+      # > the receiver, but may be set using RPN 0.
       class PitchBendChange < Base
+        # @see Message
         STATUS       = 0xE0
+
+        # Center value is defined as the the offset that should be removed from
+        # the 14 bit pitch bend value to center it around zero.
         CENTER_VALUE = 0x2000
 
         # @return [Integer] the integer pitch bend value.

data/lib/vissen/input/message/program_change.rb

@@ -4,9 +4,12 @@ module Vissen
   module Input
     module Message
       # From the MIDI Association:
-      #   This message sent when the patch number changes.
+      #
+      # > This message sent when the patch number changes.
       class ProgramChange < Base
+        # @see Message
         DATA_LENGTH = 2
+        # @see Message
         STATUS      = 0xC0
 
         # @return [Integer] the program number.

data/lib/vissen/input/message_factory.rb

@@ -23,7 +23,7 @@ module Vissen
       # @param  matchers [nil, Array<Matcher>] the matchers to use when building
       #   messages. If provided the factory will be frozen after creation.
       def initialize(matchers = nil)
-        @lookup_table = Array.new(16)
+        @lookup_table = Array.new(16) { [] }
         @matchers     = []
 
         return unless matchers
@@ -79,22 +79,11 @@ module Vissen
 
         unless matcher
           matcher = @matchers.find { |m| m.match? data }
-          add_to_lookup matcher, data if matcher
+          @lookup_table[status] << matcher if matcher
         end
 
         matcher
       end
-
-      def add_to_lookup(matcher, data)
-        status = data[0] >> 4
-        entry  = @lookup_table[status]
-
-        if entry
-          entry << matcher
-        else
-          @lookup_table[status] = [matcher]
-        end
-      end
     end
   end
 end

data/lib/vissen/input/subscription.rb

@@ -15,15 +15,18 @@ module Vissen
       attr_reader :priority
 
       # @!method match?(message)
-      # This method is forwarded to `Message#match?`.
+      # This method is forwarded to `Matcher#match?`.
       #
+      # @param  message (see Matcher#match?)
       # @return [true, false] (see Matcher#match?).
       def_delegator :@matcher, :match?, :match?
 
+      def_delegator :@matcher, :match, :match
+
       # @!method handle(message)
       # Calls the registered handler with the given message.
       #
-      # @return (see Matcher#match?)
+      # @param  message [Message] the message that the subscriber should handle.
       def_delegator :@handler, :call, :handle
 
       # @param  matcher [#match?] the matcher to use when filtering messages.

data/lib/vissen/input/version.rb

@@ -3,6 +3,6 @@
 module Vissen
   module Input
     # The Vissen Input library version number.
-    VERSION = '0.2.2'
+    VERSION = '0.3.0'
   end
 end

data/vissen-input.gemspec

@@ -27,6 +27,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.4'
   spec.add_development_dependency 'rubocop', '~> 0.52'
   spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vissen-input
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Sebastian Lindberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2018-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: This gem implements the input messages and message matching engine used
   in the vissen project.
 email:
@@ -91,6 +119,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -99,6 +128,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/raw_input_stream.rb
 - lib/vissen/input.rb
 - lib/vissen/input/broker.rb
 - lib/vissen/input/matcher.rb