fet 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a6eaf2c2012e548d709b7c60d8bb087f55062ea7a069fade95adb5ee04f8c70
-  data.tar.gz: d9a82a31165883c5219fd94b042dcc0ceda2c12e4e2c8fb915257e5bb02e6df6
+  metadata.gz: 6482a7f1b9a0e8375267c1220690f706e9058b0b485bb3079c174726425594ec
+  data.tar.gz: 0fd439a8ac3631db1f88d345bb8c50a8f0baf1dd267017b88ec7884613f4b867
 SHA512:
-  metadata.gz: 9c78069eab1b047f0e7bf72580e5d5dac1c12467e606ff8be3637fcd202a6e666d009900bbcee3e7bad66992fbf488df3abe049d0a14494a54c9209223401d30
-  data.tar.gz: b7d43fc3d8edff904615b9e6b681edc4b77d6becca9beee2a137c3b2e8fdd0071aab9953dffd090a3f107f5b0e24054fd5af4cdfba544920949aa6ee39490fd6
+  metadata.gz: 8e3bec0d13c52547ab1f71aa2197b38ec85abf794f8d2e160fbb34bf45219e006a28e47cbab9d6f86e9067694cedbff2164621684fa9339ab21c424b3f722d7f
+  data.tar.gz: bc68f79d35ba1114f79963f027ee3155b260f462e0a6589b3e5562f82615a1910ca01ea5b2fea5e2c99c4936b31e6a75c0b4f6ad788a10e0e4358079400abdb8

data/.github/workflows/main.yml

@@ -7,6 +7,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+    - name: Ruby2D dependencies
+      run: sudo apt-get install -y libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.rubocop.yml

@@ -44,4 +44,7 @@ Style/RedundantReturn:
   Enabled: false
 
 Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/ExplicitBlockArgument:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,11 @@
-## [Unreleased]
+## [Released]
 
-## [0.1.0] - 2021-08-26
+## [0.3.0] - 2021-09-06
 
-- Initial release
+- Smoother singing MIDI exercises.
+- UI for listening exercises.
+
+## [0.2.0] - 2021-09-01
+
+- Initial release.
+- Convert individual binaries to a self-contained gem and add 100% test coverage.

data/Gemfile

@@ -7,7 +7,9 @@ gemspec
 
 group :test do
   gem "minitest", "~> 5.0"
+  gem "minitest-stub_any_instance", "~> 1.0", ">= 1.0.2"
   gem "simplecov", "~> 0.21.2"
+  gem "timecop", "~> 0.9.4"
 end
 
 group :test, :development do

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    fet (0.2.0)
+    fet (0.3.0)
       gli (~> 2.20, >= 2.20.1)
       ice_nine (~> 0.11.2)
       midilib (~> 2.0, >= 2.0.5)
+      ruby2d (~> 0.10.0)
 
 GEM
   remote: https://rubygems.org/
@@ -20,6 +21,7 @@ GEM
     method_source (1.0.0)
     midilib (2.0.5)
     minitest (5.14.4)
+    minitest-stub_any_instance (1.0.2)
     parallel (1.20.1)
     parser (3.0.2.0)
       ast (~> 2.4.1)
@@ -46,12 +48,14 @@ GEM
     rubocop-ast (1.11.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
+    ruby2d (0.10.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
+    timecop (0.9.4)
     unicode-display_width (2.0.0)
 
 PLATFORMS
@@ -61,11 +65,13 @@ DEPENDENCIES
   codecov (~> 0.6.0)
   fet!
   minitest (~> 5.0)
+  minitest-stub_any_instance (~> 1.0, >= 1.0.2)
   pry-byebug (~> 3.9)
   rake (~> 13.0)
   rdoc (~> 6.3, >= 6.3.2)
   rubocop (~> 1.7)
   simplecov (~> 0.21.2)
+  timecop (~> 0.9.4)
 
 BUNDLED WITH
    2.2.22

data/README.md

@@ -1,7 +1,11 @@
 [![codecov](https://codecov.io/gh/DimitriosLisenko/fet/branch/master/graph/badge.svg?token=6W2B0Z4E4S)](https://codecov.io/gh/DimitriosLisenko/fet)
 
 # FET (Functional Ear Trainer)
-Create MIDI files for functional ear training. Each file will contain a major/minor chord progression, followed by note(s) that you should identify the scale degree of by ear.
+This is a functional ear trainer, meaning that it teaches you to identify degrees in a key.
+
+Every level, a chord progression is played to identify a major/minor key, followed by random notes played harmonically. The degrees of these notes should be identified and selected.
+
+<img src="./assets/readme/demo.gif">
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -19,12 +23,42 @@ Or install it yourself as:
     $ gem install fet
 
 ## Usage
-Refer to [the rdoc](https://github.com/DimitriosLisenko/fet/blob/master/fet.rdoc) for detailed usage instructions and descriptions of commands.
 
-## Filename Format
+### Ear Training via the UI
+The UI currently supports listening exercises, where a chord progression is played to establish a key, followed by notes played harmonically. The degrees of these notes should be identified by selecting them in the UI.
+
+The binary can be executed as follows:
+```sh
+fet play listening --degrees 1 --key-type major --next-on-correct --tempo 200
+```
+
+All flags are optional, and serve the following purposes:
+
+| Flag | Description |
+| ------------- | ------------- |
+| --degrees | How many unique degrees to play for the random notes - maximum of 11. |
+| --key-type | Type of key to play, can be "major" or "minor". |
+| --[no-]next-on-correct | Go to the next level automatically when answered correctly. |
+| --tempo | The tempo at which the chord progression is played. |
+
+When using the UI, the following keyboard shortcuts are defined to allow for mouse-free interaction:
+| Keyboard Shortcut | Description |
+| ------------- | ------------- |
+| ENTER | Go to the next level once this level is over. |
+| q | Quit the application. |
+| c | Repeat the chord progression only. |
+| n | Repeat the notes only. |
+| l | Repeat the question (looping). |
+| 1-7 | Select the degree, e.g. "2" selects the 2nd degree. |
+| - | Modify the above degree to flatten it, e.g. "-" followed by "2" will select the b2nd degree. |
+| + | Modify the above degree to sharpen it, e.g. "+" followed by "4" will select the #4th degree. |
+| 0 | Make the degree natural, e.g. "+" followed by followed by "0" followed by "4" will select the 4th degree. |
+
+### Ear Training via MIDI files
+#### Filename Format
 The generators will currently create MIDI files. The correct answer is included in the filename.
 
-### Listening exercises
+#### Listening exercises
 For listening exercises, here is a potential list of generated MIDI files (for 2 degrees):
 ```sh
 $ find .
@@ -54,7 +88,7 @@ The file name contains all the information required for the answer. For example,
 
 `(G#2)`: the [scientific pitch notation](https://en.wikipedia.org/wiki/Scientific_pitch_notation) of which is G#2
 
-### Singing exercises
+#### Singing exercises
 The singing exercises will generate all possible combinations for keys and degrees as follows:
 ```sh
 $ find .
@@ -78,7 +112,7 @@ The file name contains all the information required for the answer. For example,
 
 `3`: you should sing the 3rd degree.
 
-### Single Note Listening exercises
+#### Single Note Listening exercises
 For single note listening exercises, the same note is played across all possible keys:
 ```sh
 $ find .
@@ -98,6 +132,9 @@ The file name contains all the information required for the answer. For example,
 
 `3`: the note that is played is the 3rd degree in this key.
 
+### More Information
+Refer to [the rdoc](https://github.com/DimitriosLisenko/fet/blob/master/fet.rdoc) for detailed usage instructions and descriptions of commands.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/assets/fonts/PTSans/OFL.txt

@@ -0,0 +1,94 @@
+Copyright (c) 2010, ParaType Ltd. (http://www.paratype.com/public),
+with Reserved Font Names "PT Sans" and "ParaType".
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

data/bin/fet

@@ -77,11 +77,38 @@ class App
     end
   end
 
-  # NOTE: if you need the backtrace for an exception, this can be uncommented
-  # on_error do |exception|
-  #   puts exception.backtrace
-  #   true
-  # end
+  desc("Run the ear training application")
+  # arg_name "Describe arguments to generate here"
+  command(:play) do |c|
+    c.desc("Run the ear training application for listening")
+    c.long_desc("Each level will contain a chord progression, followed by the specified number of degrees - first harmonically, then melodically after a pause.")
+    c.command :listening do |listening|
+      listening.desc("Tempo at which the chord progression is played at")
+      listening.default_value(120)
+      listening.flag([:t, :tempo], type: Integer)
+
+      listening.desc("Number of degrees to play")
+      listening.default_value(1)
+      listening.flag([:d, :degrees], type: Integer, must_match: (1..11).map(&:to_s))
+
+      listening.desc("Type of the chord progression")
+      listening.default_value("major")
+      listening.flag([:k, :"key-type"], type: String, must_match: ["major", "minor"])
+
+      listening.desc("Automatically go to the next exercise when the answer was correct")
+      listening.default_value(true)
+      listening.switch [:n, :"next-on-correct"]
+
+      listening.action do |global_options, options, args|
+        Fet::Cli::Play::Listening.run(global_options, options, args)
+      end
+    end
+  end
+
+  on_error do |exception|
+    puts exception.backtrace
+    true
+  end
 end
 
 exit App.run(ARGV)

data/fet.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "gli", "~> 2.20", ">= 2.20.1"
   spec.add_dependency "ice_nine", "~> 0.11.2"
   spec.add_dependency "midilib", "~> 2.0", ">= 2.0.5"
+  spec.add_dependency "ruby2d", "~> 0.10.0"
 
   # RDoc configuration
   spec.extra_rdoc_files = ["README.rdoc", "fet.rdoc"]

data/fet.rdoc

@@ -92,3 +92,41 @@ List commands one per line, to assist with shell completion
 
 
 
+==== Command: <tt>play </tt>
+Run the ear training application
+
+
+===== Commands
+====== Command: <tt>listening </tt>
+Run the ear training application for listening
+
+Each level will contain a chord progression, followed by the specified number of degrees - first harmonically, then melodically after a pause.
+======= Options
+======= -d|--degrees arg
+
+Number of degrees to play
+
+[Default Value] 1
+[Must Match] ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11"]
+
+
+======= -k|--key-type arg
+
+Type of the chord progression
+
+[Default Value] major
+[Must Match] ["major", "minor"]
+
+
+======= -t|--tempo arg
+
+Tempo at which the chord progression is played at
+
+[Default Value] 120
+
+
+======= -n|--[no-]next-on-correct
+Automatically go to the next exercise when the answer was correct
+
+
+

data/lib/fet/cli/play/listening.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Fet
+  module Cli
+    module Play
+      # CLI implementation for the "play listening" command
+      module Listening
+        def self.run(_global_options, options, _args)
+          Fet::Ui::Game.new(
+            tempo: options[:tempo],
+            degrees: options[:degrees],
+            key_type: options[:"key-type"],
+            next_on_correct: options[:"next-on-correct"],
+          ).start
+        end
+      end
+    end
+  end
+end

data/lib/fet/degree.rb

@@ -33,6 +33,10 @@ module Fet
       return degree_name.size == 2 ? degree_name[1].to_i : degree_name[0].to_i
     end
 
+    def degree_index
+      return DEGREE_NAMES.index { |degree_names| degree_names.include?(degree_name) }
+    end
+
     private
 
     attr_writer :degree_name

data/lib/fet/degrees.rb

@@ -23,10 +23,18 @@ module Fet
       return Degree::DEGREE_NAMES[degree_index_of_midi_value(midi_value)]
     end
 
+    def degree_index_of_midi_value(midi_value)
+      return MidiNote.new(midi_value).degree(root_midi_value)
+    end
+
     def note_name_of_degree(degree_name)
       return degree_to_note_name[Degree.new(degree_name).degree_name]
     end
 
+    def select_degrees_from_midi_values(midi_value_range, number_of_degrees)
+      return select_degrees_from_midi_values_recursive(midi_value_range, [], number_of_degrees)
+    end
+
     private
 
     attr_writer :root_name,
@@ -54,8 +62,17 @@ module Fet
       return result
     end
 
-    def degree_index_of_midi_value(midi_value)
-      return MidiNote.new(midi_value).degree(root_midi_value)
+    def select_degrees_from_midi_values_recursive(all_notes, chosen_notes, number_of_degrees)
+      return chosen_notes if number_of_degrees.zero?
+
+      selected_note = all_notes.sample
+      chosen_notes << selected_note
+
+      all_notes_without_note_degree = all_notes.reject do |note|
+        Fet::MidiNote.new(note).degree(root_midi_value) == Fet::MidiNote.new(selected_note).degree(root_midi_value)
+      end
+
+      select_degrees_from_midi_values_recursive(all_notes_without_note_degree, chosen_notes, number_of_degrees - 1)
     end
   end
 end