midi-events 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efa887d5687fbcd076a6af23aa56e05634c59578dab1ce763fbf31b8a586bd21
-  data.tar.gz: d9276c92109a9755e70a4489f9e6ca3760b3e74021d29329a5a1cf390f243f00
+  metadata.gz: 82ba2c51e9befc6c456bcb3d16a467a89d10b9d4e4c85331fbf2b6194f41abc9
+  data.tar.gz: 0a5f5e2ee32d85f5dba7e0bd3039502ab763259fa36f8f740f5927dc0cfb1ef1
 SHA512:
-  metadata.gz: a54daff37ba44f3eb3960b5bf0d142126337dfe841cea90c26838f0f7bde92434c8a98c34ef4893e2bfc40b4e58ceee04bf5f3edef16630371b4562dc9148120
-  data.tar.gz: d33556354701aac402d8f335ea32035e3754bb35c5215d658907094056ae7fb1998b1fb0870956ffca5f783bcc3de1babcd6d910554c48fc4db833ed6df9036c
+  metadata.gz: c7ab224cfdbd77e43bf886808f21283b249f36821f3fd5e84d54f44bd77ebf02a5afe804b02f9e196c3eadc2f6112d64fe23b6b34fbea389c185b414ef0c5ea0
+  data.tar.gz: 6d844c549b9dbcfa1132f050748e4dbf7972ed9152a1c1d72126af537c7fcd344918c811b4f4ffb2f3a15ec27298c987fe8a381531fdeb18ba5ce4739ef376fc

data/Gemfile

@@ -1,8 +1,3 @@
 source 'https://rubygems.org'
 
-group :test do
-  gem 'minitest', '~> 5.14', '>= 5.14.4'
-  gem 'mocha', '~> 1.13', '>= 1.13.0'
-  gem 'rake', '~> 13.0', '>= 13.0.6'
-  gem 'shoulda-context', '~> 2.0', '>= 2.0.0'
-end
+gemspec

data/README.md

@@ -114,32 +114,33 @@ One way or another, you will wind up with a pair of objects like this:
 
 ## Then, why does exist this library if it is mostly a clone of another library?
 
-The author has been developing since 2016 a Ruby project called 
-[Musa DSL](https://github.com/javier-sy/musa-dsl) that needs a way 
-of representing MIDI Events and a way of communicating with 
+The author has been developing since 2016 a Ruby project called
+[Musa DSL](https://github.com/javier-sy/musa-dsl) that needs a way
+of representing MIDI Events and a way of communicating with
 MIDI Instruments and MIDI Control Surfaces.
 
-[Ari Russo](https://github.com/arirusso) has done a great job creating 
-several interdependent Ruby libraries that allow 
-MIDI Events representation ([MIDI Message](https://github.com/arirusso/midi-message) 
-and [Nibbler](https://github.com/arirusso/nibbler)) 
-and communication with MIDI Instruments and MIDI Control Surfaces 
-([unimidi](https://github.com/arirusso/unimidi), 
-[ffi-coremidi](https://github.com/arirusso/ffi-coremidi) and others) 
+[Ari Russo](https://github.com/arirusso) has done a great job creating
+several interdependent Ruby libraries that allow
+MIDI Events representation ([MIDI Message](https://github.com/arirusso/midi-message)
+and [Nibbler](https://github.com/arirusso/nibbler))
+and communication with MIDI Instruments and MIDI Control Surfaces
+([unimidi](https://github.com/arirusso/unimidi),
+[ffi-coremidi](https://github.com/arirusso/ffi-coremidi) and others)
 that, **with some modifications**, I've been using in MusaDSL.
 
-After thinking about the best approach to publish MusaDSL 
+After thinking about the best approach to publish MusaDSL
 I've decided to publish my own renamed version of the modified dependencies because:
 
+* The original libraries have features
+  (buffering, very detailed logging and processing history information, not locking behaviour when waiting input midi messages)
+  that are not needed in MusaDSL and, in fact,
+  can degrade the performance on some use cases in MusaDSL.
+* The requirements for **Musa DSL** users probably will evolve in time, so it will be easier to maintain an independent source code base.
 * Some differences on the approach of the modifications vs the original library doesn't allow to merge the modifications on the original libraries.
 * Then the renaming of the libraries is needed to avoid confusing existent users of the original libraries.
-* Due to some of the interdependencies of Ari Russo libraries, 
+* Due to some of the interdependencies of Ari Russo libraries,
   the modification and renaming on some of the low level libraries (ffi-coremidi, etc.)
   forces to modify and rename unimidi library.
-* The original libraries have features
-  (very detailed logging and processing history information, not locking behaviour when waiting input midi messages)
-  that are not needed in MusaDSL and, in fact,
-  can degrade the performance on some use case scenarios in MusaDSL.
 
 All in all I have decided to publish a suite of libraries optimized for MusaDSL use case that also can be used by other people in their projects.
 
@@ -147,8 +148,8 @@ All in all I have decided to publish a suite of libraries optimized for MusaDSL
 | --- | --- | --- | --- |
 | MIDI Events representation | [MIDI Events](https://github.com/javier-sy/midi-events) | [MIDI Message](https://github.com/arirusso/midi-message) | removed parsing, small improvements |
 | MIDI Data parsing | [MIDI Parser](https://github.com/javier-sy/midi-parser) | [Nibbler](https://github.com/arirusso/nibbler) | removed process history information, minor optimizations |
-| MIDI communication with Instruments and Control Surfaces | [MIDI Communications](https://github.com/javier-sy/midi-communications) | [unimidi](https://github.com/arirusso/unimidi) | use of [MIDI Communications MacOS Layer](https://github.com/javier-sy/midi-communications-macos)
-| Low level MIDI interface to MacOS | [MIDI Communications MacOS Layer](https://github.com/javier-sy/midi-communications-macos) | [ffi-coremidi](https://github.com/arirusso/ffi-coremidi) | removed process history information, locking behaviour when waiting midi events, improved midi devices name detection, minor optimizations |
+| MIDI communication with Instruments and Control Surfaces | [MIDI Communications](https://github.com/javier-sy/midi-communications) | [unimidi](https://github.com/arirusso/unimidi) | use of [MIDI Communications MacOS Layer](https://github.com/javier-sy/midi-communications-macos, removed process history information, removed buffering, removed command line script)
+| Low level MIDI interface to MacOS | [MIDI Communications MacOS Layer](https://github.com/javier-sy/midi-communications-macos) | [ffi-coremidi](https://github.com/arirusso/ffi-coremidi) | removed buffering and process history information, locking behaviour when waiting midi events, improved midi devices name detection, minor optimizations |
 | Low level MIDI interface to Linux | **TO DO** | | |
 | Low level MIDI interface to JRuby | **TO DO** | | |
 | Low level MIDI interface to Windows | **TO DO** | | |

data/Rakefile

@@ -1,3 +1,6 @@
+$LOAD_PATH.prepend __dir__
+$LOAD_PATH.prepend File.join(__dir__, 'lib')
+
 require 'rake'
 require 'rake/testtask'
 

data/lib/midi-events/constant.rb

@@ -1,9 +1,7 @@
 module MIDIEvents
-
   # Refer to a MIDI message by its usage
   # eg *C4* for MIDI note *60* or *Bank Select* for MIDI control change *0*
   module Constant
-
     # Get a Mapping object for the specified constant
     # @param [Symbol, String] group_name
     # @param [String] const_name
@@ -23,14 +21,13 @@ module MIDIEvents
     end
 
     module Name
-
       extend self
 
       # eg "Control Change" -> "control_change"
       # @param [Symbol, String] string
       # @return [String]
       def underscore(string)
-        string.to_s.downcase.gsub(/(\ )+/, "_")
+        string.to_s.downcase.gsub(/(\ )+/, '_')
       end
 
       # @param [Symbol, String] key
@@ -40,12 +37,10 @@ module MIDIEvents
         match_key = key.to_s.downcase
         [match_key, Name.underscore(match_key)].include?(other.to_s.downcase)
       end
-
     end
 
     # MIDI Constant container
     class Group
-
       attr_reader :constants, :key
 
       # @param [String] key
@@ -70,7 +65,6 @@ module MIDIEvents
       end
 
       class << self
-
         # All constant groups
         # @return [Array<ConstantGroup>]
         def all
@@ -85,7 +79,7 @@ module MIDIEvents
           ensure_initialized
           @groups.find { |group| Name.match?(group.key, key) }
         end
-        alias_method :[], :find
+        alias [] find
 
         private
 
@@ -98,21 +92,21 @@ module MIDIEvents
         # Populate the dictionary of constants
         # @return [Boolean]
         def populate_dictionary
-          if @dict.nil?
-            file = File.expand_path('../../midi.yml', __FILE__)
-            @dict = YAML.load_file(file)
-            @dict.freeze
-            true
-          end
+          return unless @dict.nil?
+
+          file = File.expand_path('../midi.yml', __dir__)
+          @dict = YAML.load_file(file)
+          @dict.freeze
+          true
         end
 
         # Populate the constant groups using the dictionary
         # @return [Boolean]
         def populate_groups
-          if @groups.nil? && !@dict.nil?
-            @groups = @dict.map { |k, v| new(k, v) }
-            true
-          end
+          return unless @groups.nil? && !@dict.nil?
+
+          @groups = @dict.map { |k, v| new(k, v) }
+          true
         end
 
       end
@@ -121,7 +115,6 @@ module MIDIEvents
 
     # The mapping of a constant key to its value eg "Note On" => 0x9
     class Map
-
       attr_reader :key, :value
 
       # @param [String] key
@@ -130,11 +123,9 @@ module MIDIEvents
         @key = key
         @value = value
       end
-
     end
 
     class MessageBuilder
-
       # @param [MIDIEvents] klass The message class to build
       # @param [MIDIEvents::Constant::Map] const The constant to build the message with
       def initialize(klass, const)
@@ -146,31 +137,27 @@ module MIDIEvents
       # @return [Message]
       def new(*args)
         args = args.dup
-        args.last.kind_of?(Hash) ? args.last[:const] = @const : args.push(:const => @const)
+        args.last.is_a?(Hash) ? args.last[:const] = @const : args.push(const: @const)
         @klass.new(*args)
       end
-
     end
 
     # 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 find(status_name)
-        const = Constant.find("Status", status_name)
-        const.value unless const.nil?
+        const = Constant.find('Status', status_name)
+        const&.value
       end
-      alias_method :[], :find
-
+      alias [] find
     end
 
     # Loading constants from the spec file into messages
     module Loader
-
       extend self
 
       # Get the index of the constant from the given message's type
@@ -194,9 +181,9 @@ module MIDIEvents
         unless group.nil?
           unless (const = group.find_by_value(value)).nil?
             {
-              :const => const,
-              :name => const.key,
-              :verbose_name => "#{message.class.display_name}: #{const.key}"
+              const: const,
+              name: const.key,
+              verbose_name: "#{message.class.display_name}: #{const.key}"
             }
           end
         end
@@ -204,31 +191,30 @@ module MIDIEvents
 
       # DSL type class methods for loading constants into messages
       module DSL
-
         # 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 = constant_name || display_name
-          unless key.nil?
-            group = Group[key]
-            group.find(name)
-          end
+          return if key.nil?
+
+          group = Group[key]
+          group.find(name)
         end
 
         # @return [String]
         def display_name
-          const_get("DISPLAY_NAME") if const_defined?("DISPLAY_NAME")
+          const_get('DISPLAY_NAME') if const_defined?('DISPLAY_NAME')
         end
 
         # @return [Hash]
         def constant_map
-          const_get("CONSTANT") if const_defined?("CONSTANT")
+          const_get('CONSTANT') if const_defined?('CONSTANT')
         end
 
         # @return [String]
         def constant_name
-          constant_map.keys.first unless constant_map.nil?
+          constant_map&.keys&.first
         end
 
         # @return [Symbol]
@@ -249,12 +235,8 @@ module MIDIEvents
           const = get_constant(const_name.to_s)
           MessageBuilder.new(self, const) unless const.nil?
         end
-        alias_method :[], :find
-
+        alias [] find
       end
-
     end
-
   end
-
 end

data/lib/midi-events.rb

@@ -23,5 +23,5 @@ require 'midi-events/context'
 require 'midi-events/messages'
 
 module MIDIEvents
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.5.1'.freeze
 end

data/midi-events.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'midi-events'
-  s.version     = '0.5.0'
-  s.date        = '2021-11-12'
+  s.version     = '0.5.1'
+  s.date        = '2021-11-19'
   s.summary     = 'A Ruby simple library for creating MIDI Event Messages'
   s.description = 'MIDI Events is a library for creating MIDI Event Messages that can be sent to MIDI Instruments through other libraries such as midi-communications or unimidi'
   s.authors     = ['Javier Sánchez Yeste']
@@ -19,4 +19,8 @@ Gem::Specification.new do |s|
     # "documentation_uri" => "",
     # "changelog_uri" => ""
   #}
+
+  s.add_development_dependency 'minitest', '~> 5.14', '>= 5.14.4'
+  s.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
+  s.add_development_dependency 'shoulda-context', '~> 2.0', '>= 2.0.0'
 end

metadata

@@ -1,15 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: midi-events
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Javier Sánchez Yeste
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-12 00:00:00.000000000 Z
-dependencies: []
+date: 2021-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 description: MIDI Events is a library for creating MIDI Event Messages that can be
   sent to MIDI Instruments through other libraries such as midi-communications or
   unimidi