midi-parser 0.4.1 → 0.5.0

data/lib/midi-parser.rb

@@ -18,11 +18,58 @@ require 'midi-parser/session'
 
 require_relative 'midi-parser/version'
 
+# A Ruby parser for raw MIDI data that converts bytes, hex strings, and nibbles
+# into MIDIEvents message objects.
 #
-# Parse MIDI Messages
+# MIDIParser accepts various input formats and incrementally parses MIDI data,
+# supporting running status and System Exclusive messages.
+#
+# This library is part of the MusaDSL MIDI suite:
+# - {https://github.com/javier-sy/midi-events MIDI Events} - MIDI message representation
+# - {https://github.com/javier-sy/midi-parser MIDI Parser} - MIDI data parsing (this library)
+# - {https://github.com/javier-sy/midi-communications MIDI Communications} - MIDI I/O
+#
+# @example Basic usage - create a parser and parse a complete message
+#   parser = MIDIParser.new
+#   message = parser.parse(0x90, 0x40, 0x40)
+#   # => #<MIDIEvents::NoteOn @channel=0, @note=64, @velocity=64>
+#
+# @example Parsing from hex string
+#   parser = MIDIParser.new
+#   message = parser.parse("904040")
+#   # => #<MIDIEvents::NoteOn @channel=0, @note=64, @velocity=64>
+#
+# @example Incremental parsing (piece by piece)
+#   parser = MIDIParser.new
+#   parser.parse("90")  # => []
+#   parser.parse("40")  # => []
+#   parser.parse("40")  # => [#<MIDIEvents::NoteOn ...>]
+#
+# @example Using running status
+#   parser = MIDIParser.new
+#   parser.parse(0x90, 0x40, 0x40)  # First note
+#   parser.parse(0x40, 0x50)        # Second note using running status
+#
+# @example Checking the buffer
+#   parser = MIDIParser.new
+#   parser.parse("90", "40")
+#   parser.buffer    # => ["9", "0", "4", "0"]
+#   parser.buffer_s  # => "9040"
+#
+# @see Session The main parsing session class
+# @see https://github.com/javier-sy/midi-events MIDIEvents library
 #
+# @api public
 module MIDIParser
-  # Shortcut to a new parser session
+  # Creates a new parser session.
+  #
+  # This is a convenience method that instantiates a new {Session} object.
+  #
+  # @return [Session] a new parser session
+  #
+  # @example
+  #   parser = MIDIParser.new
+  #   parser.parse(0x90, 0x40, 0x40)
   def self.new(...)
     Session.new(...)
   end

data/midi-parser.gemspec

@@ -14,17 +14,18 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.7'
 
-  # TODO
-  #s.metadata    = {
-    # "source_code_uri" => "https://",
-    # "homepage_uri" => "",
-    # "documentation_uri" => "",
-    # "changelog_uri" => ""
-  #}
+  s.metadata = {
+    'homepage_uri' => s.homepage,
+    'source_code_uri' => s.homepage,
+    'documentation_uri' => 'https://www.rubydoc.info/gems/midi-parser'
+  }
 
-  s.add_runtime_dependency 'midi-events', '~> 0.6'
+  s.add_runtime_dependency 'midi-events', '~> 0.7'
 
   s.add_development_dependency 'minitest', '~>5', '>= 5.14.4'
   s.add_development_dependency 'rake', '~>13', '>= 13.0.6'
   s.add_development_dependency 'shoulda-context', '~>2', '>= 2.0.0'
+  s.add_development_dependency 'yard', '~> 0.9'
+  s.add_development_dependency 'redcarpet', '~> 3.6'
+  s.add_development_dependency 'webrick', '~> 1.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: midi-parser
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Javier Sánchez Yeste
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -83,6 +83,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !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'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: MIDI Parser is a library for parsing MIDI Event Messages received from
   any MIDI device through other libraries such as midi-communications or unimidi
 email: javier.sy@gmail.com
@@ -91,6 +133,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".version"
+- ".yardopts"
 - Gemfile
 - LICENSE
 - LICENSE.nibbler
@@ -103,11 +147,15 @@ files:
 - lib/midi-parser/parser.rb
 - lib/midi-parser/session.rb
 - lib/midi-parser/type_conversion.rb
+- lib/midi-parser/version.rb
 - midi-parser.gemspec
 homepage: https://github.com/javier-sy/midi-parser
 licenses:
 - LGPL-3.0-or-later
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/javier-sy/midi-parser
+  source_code_uri: https://github.com/javier-sy/midi-parser
+  documentation_uri: https://www.rubydoc.info/gems/midi-parser
 rdoc_options: []
 require_paths:
 - lib