fet 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6482a7f1b9a0e8375267c1220690f706e9058b0b485bb3079c174726425594ec
-  data.tar.gz: 0fd439a8ac3631db1f88d345bb8c50a8f0baf1dd267017b88ec7884613f4b867
+  metadata.gz: 67009d9f1befb2258f255e646971889e81afdc34dc56fec363a5624bffb868f0
+  data.tar.gz: e0277de27773dd8bebd89d2f7aedad3c4e8aac24c6a0099a00656b22ce2620ce
 SHA512:
-  metadata.gz: 8e3bec0d13c52547ab1f71aa2197b38ec85abf794f8d2e160fbb34bf45219e006a28e47cbab9d6f86e9067694cedbff2164621684fa9339ab21c424b3f722d7f
-  data.tar.gz: bc68f79d35ba1114f79963f027ee3155b260f462e0a6589b3e5562f82615a1910ca01ea5b2fea5e2c99c4936b31e6a75c0b4f6ad788a10e0e4358079400abdb8
+  metadata.gz: 119ea1729a8c11ec5f0ec54a25f47b9007cf4d23c23c89f98ed8c4f5d66829b6dfb35363592a528b3293a7b01649b8348422bf8eb123702b7bd3cebe09a1bb1c
+  data.tar.gz: 64620f0f58519de0bfa633d783d652a5442ebc1b34ce9a7e91a0712e164152ddb2cc315338e94f7cc7c34cbc1c1feb6b3f556094cbadf2086c2503bb1d577eb0

data/.rubocop.yml

@@ -40,6 +40,9 @@ Layout/CaseIndentation:
 Layout/LineLength:
   Max: 175
 
+Style/Lambda:
+  EnforcedStyle: lambda
+
 Style/RedundantReturn:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## [Released]
+# [Unreleased]
+
+# [Released]
+
+## [0.3.1] - 2021-09-27
+- Allow limiting questions to specific degrees.
+- Improve positioning of the score element in the UI.
+- Add ability to show score summary over multiple games.
+- Write game files to system temporary directory.
 
 ## [0.3.0] - 2021-09-06
 

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    fet (0.3.0)
+    fet (0.3.1)
       gli (~> 2.20, >= 2.20.1)
       ice_nine (~> 0.11.2)
       midilib (~> 2.0, >= 2.0.5)
       ruby2d (~> 0.10.0)
+      terminal-table (~> 3.0, >= 3.0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -55,6 +56,8 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
+    terminal-table (3.0.1)
+      unicode-display_width (>= 1.1.1, < 3)
     timecop (0.9.4)
     unicode-display_width (2.0.0)
 

data/README.md

@@ -8,6 +8,18 @@ Every level, a chord progression is played to identify a major/minor key, follow
 <img src="./assets/readme/demo.gif">
 
 ## Installation
+### Prerequisites
+Install TiMidity++ for required performance improvements when converting MIDI to other formats.
+#### OS X
+```sh
+brew install timidity
+```
+#### Ubuntu
+```sh
+apt install timidity
+```
+
+### Gem
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -29,7 +41,7 @@ The UI currently supports listening exercises, where a chord progression is play
 
 The binary can be executed as follows:
 ```sh
-fet play listening --degrees 1 --key-type major --next-on-correct --tempo 200
+fet play listening --degrees 1 --key-type major --next-on-correct --tempo 200 --limit-degrees b6 --limit-degrees 5
 ```
 
 All flags are optional, and serve the following purposes:
@@ -40,6 +52,7 @@ All flags are optional, and serve the following purposes:
 | --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. |
+| --limit-degrees | Limit to specific degrees. Can be supplied multiple times. |
 
 When using the UI, the following keyboard shortcuts are defined to allow for mouse-free interaction:
 | Keyboard Shortcut | Description |
@@ -49,7 +62,7 @@ When using the UI, the following keyboard shortcuts are defined to allow for mou
 | 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. |
+| 1-7 | Select the degree, e.g. "2" selects the 2nd degree. Will also play that degree once the level is over. |
 | - | 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. |

data/bin/fet

@@ -16,94 +16,11 @@ class App
   subcommand_option_handling(:normal)
   arguments(:strict)
 
-  desc("Generate MIDI files for ear training")
-  # arg_name "Describe arguments to generate here"
-  command(:generate) do |c|
-    c.desc("Generate MIDI files for listening")
-    c.long_desc("Each MIDI file 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("Number of exercises to generate")
-      listening.default_value(200)
-      listening.flag([:e, :exercises], type: Integer)
-
-      listening.desc("Generate all single degree listening exercises (ignores -e and -d flag)")
-      listening.default_value(false)
-      listening.switch [:a, :"all-single-degree"]
-
-      listening.action do |global_options, options, args|
-        Fet::Cli::Generate::Listening.run(global_options, options, args)
-      end
-    end
-  end
-
-  command(:generate) do |c|
-    c.desc("Generate MIDI files for listening (single note)")
-    c.long_desc("Each MIDI file will contain a chord progression, followed the same note across all files.")
-    c.command :single_note_listening do |single_note_listening|
-      single_note_listening.desc("Tempo at which the chord progression is played at")
-      single_note_listening.default_value(120)
-      single_note_listening.flag([:t, :tempo], type: Integer)
-
-      single_note_listening.action do |global_options, options, args|
-        Fet::Cli::Generate::SingleNoteListening.run(global_options, options, args)
-      end
-    end
-  end
-
-  command(:generate) do |c|
-    c.desc("Generate MIDI files for singing")
-    c.long_desc("Each MIDI file will contain a chord progression, followed by a specified pause, during which the degree should be sung."\
-                " The degree is then played for confirmation.")
-    c.command :singing do |singing|
-      singing.desc("Tempo at which the chord progression is played at")
-      singing.default_value(120)
-      singing.flag([:t, :tempo], type: Integer)
-
-      singing.desc("How many seconds to wait before playing the correct note")
-      singing.default_value(3)
-      singing.flag([:p, :pause], type: Integer)
-
-      singing.action do |global_options, options, args|
-        Fet::Cli::Generate::Singing.run(global_options, options, args)
-      end
-    end
-  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
+  include ::Fet::Cli::Generate::ListeningCommand
+  include ::Fet::Cli::Generate::SingleNoteListeningCommand
+  include ::Fet::Cli::Generate::SingingCommand
+  include ::Fet::Cli::Play::ListeningCommand
+  include ::Fet::Cli::Score::SummaryCommand
 
   on_error do |exception|
     puts exception.backtrace

data/fet.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "ice_nine", "~> 0.11.2"
   spec.add_dependency "midilib", "~> 2.0", ">= 2.0.5"
   spec.add_dependency "ruby2d", "~> 0.10.0"
+  spec.add_dependency "terminal-table", "~> 3.0", ">= 3.0.1"
 
   # RDoc configuration
   spec.extra_rdoc_files = ["README.rdoc", "fet.rdoc"]

data/fet.rdoc

@@ -1,6 +1,6 @@
 == fet - Functional Ear Trainer
 
-v0.2.0
+v0.3.0
 
 === Global Options
 === --help
@@ -100,7 +100,7 @@ Run the ear training application
 ====== 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.
+Each level will play a chord progression, followed by the specified number of degrees harmonically. The correct degrees should be selected.
 ======= Options
 ======= -d|--degrees arg
 
@@ -118,6 +118,14 @@ Type of the chord progression
 [Must Match] ["major", "minor"]
 
 
+======= -l|--limit-degrees arg
+
+Limit which degrees can play
+
+[Default Value] []
+[Must Match] ["1", "#1", "b2", "2", "#2", "b3", "3", "4", "#4", "b5", "5", "#5", "b6", "6", "#6", "b7", "7"]
+
+
 ======= -t|--tempo arg
 
 Tempo at which the chord progression is played at
@@ -130,3 +138,50 @@ Automatically go to the next exercise when the answer was correct
 
 
 
+==== Command: <tt>score </tt>
+Score commands
+
+
+===== Commands
+====== Command: <tt>summary </tt>
+Show the score summary
+
+
+======= Options
+======= -b|--begin-offset arg
+
+Offset beginning index of resulting array
+
+[Default Value] 0
+
+
+======= -d|--degrees arg
+
+Number of degrees to play
+
+[Default Value] 1
+[Must Match] ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11"]
+
+
+======= -e|--end-offset arg
+
+Offset end index of resulting array
+
+[Default Value] 0
+
+
+======= -k|--key-type arg
+
+Type of the chord progression
+
+[Default Value] major
+[Must Match] ["major", "minor"]
+
+
+======= -s|--seconds arg
+
+Only include games that had greater or equal playtime to the specified amount (in seconds)
+
+[Default Value] 0
+
+

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

@@ -11,7 +11,6 @@ module Fet
             tempo: options[:tempo],
             degrees: options[:degrees],
             all_single_degree: options[:"all-single-degree"],
-            directory_prefix: options[:directory_prefix] || "",
           ).generate
         end
       end

data/lib/fet/cli/generate/listening_command.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Fet
+  module Cli
+    module Generate
+      # Defines the CLI "generate listening" command
+      module ListeningCommand
+        def self.included(klass)
+          klass.class_eval do
+            extend ClassMethods
+
+            desc("Generate MIDI files for ear training")
+            command(:generate) do |c|
+              define_listening_command(c)
+            end
+          end
+        end
+
+        # Internal methods for the "generate listening" command
+        module ClassMethods
+          private
+
+          def define_listening_command(command)
+            command.desc("Generate MIDI files for listening")
+            command.long_desc(long_listening_command_description)
+            command.command :listening do |listening|
+              define_tempo_flag(listening)
+              define_degrees_flag(listening)
+              define_exerises_flag(listening)
+              define_all_single_degree_flag(listening)
+              define_action(listening)
+            end
+          end
+
+          def long_listening_command_description
+            return "Each MIDI file will contain a chord progression, followed by the specified number of degrees - first harmonically, then melodically after a pause."
+          end
+
+          def define_tempo_flag(command)
+            command.desc("Tempo at which the chord progression is played at")
+            command.default_value(120)
+            command.flag([:t, :tempo], type: Integer)
+          end
+
+          def define_degrees_flag(command)
+            command.desc("Number of degrees to play")
+            command.default_value(1)
+            command.flag([:d, :degrees], type: Integer, must_match: (1..11).map(&:to_s))
+          end
+
+          def define_exerises_flag(command)
+            command.desc("Number of exercises to generate")
+            command.default_value(200)
+            command.flag([:e, :exercises], type: Integer)
+          end
+
+          def define_all_single_degree_flag(command)
+            command.desc("Generate all single degree listening exercises (ignores -e and -d flag)")
+            command.default_value(false)
+            command.switch [:a, :"all-single-degree"]
+          end
+
+          def define_action(command)
+            command.action do |global_options, options, args|
+              Fet::Cli::Generate::Listening.run(global_options, options, args)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fet/cli/generate/singing.rb

@@ -9,7 +9,6 @@ module Fet
           Fet::Generator::Singing.new(
             tempo: options[:tempo],
             pause: options[:pause],
-            directory_prefix: options[:directory_prefix] || "",
           ).generate
         end
       end

data/lib/fet/cli/generate/singing_command.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Fet
+  module Cli
+    module Generate
+      # Defines the CLI "generate singing" command
+      module SingingCommand
+        def self.included(klass)
+          klass.class_eval do
+            extend ClassMethods
+
+            command(:generate) do |c|
+              define_singing_command(c)
+            end
+          end
+        end
+
+        # Internal methods for the "generate singing" command
+        module ClassMethods
+          private
+
+          def define_singing_command(command)
+            command.desc("Generate MIDI files for singing")
+            command.long_desc("Each MIDI file will contain a chord progression, followed by a specified pause, during which the degree should be sung."\
+                              " The degree is then played for confirmation.")
+            command.command :singing do |singing|
+              define_tempo_flag(singing)
+              define_pause_flag(singing)
+              define_singing_action(singing)
+            end
+          end
+
+          def define_tempo_flag(command)
+            command.desc("Tempo at which the chord progression is played at")
+            command.default_value(120)
+            command.flag([:t, :tempo], type: Integer)
+          end
+
+          def define_pause_flag(command)
+            command.desc("How many seconds to wait before playing the correct note")
+            command.default_value(3)
+            command.flag([:p, :pause], type: Integer)
+          end
+
+          def define_singing_action(command)
+            command.action do |global_options, options, args|
+              Fet::Cli::Generate::Singing.run(global_options, options, args)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fet/cli/generate/single_note_listening.rb

@@ -8,7 +8,6 @@ module Fet
         def self.run(_global_options, options, _args)
           Fet::Generator::SingleNoteListening.new(
             tempo: options[:tempo],
-            directory_prefix: options[:directory_prefix] || "",
           ).generate
         end
       end

data/lib/fet/cli/generate/single_note_listening_command.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Fet
+  module Cli
+    module Generate
+      # Defines the CLI "generate single_note_listening" command
+      module SingleNoteListeningCommand
+        def self.included(klass)
+          klass.class_eval do
+            extend ClassMethods
+
+            command(:generate) do |c|
+              define_single_note_listening_command(c)
+            end
+          end
+        end
+
+        # Internal methods for the "generate single_note_listening" command
+        module ClassMethods
+          private
+
+          def define_single_note_listening_command(command)
+            command.desc("Generate MIDI files for listening (single note)")
+            command.long_desc("Each MIDI file will contain a chord progression, followed the same note across all files.")
+            command.command :single_note_listening do |single_note_listening|
+              define_tempo_flag(single_note_listening)
+              define_single_note_listening_action(single_note_listening)
+            end
+          end
+
+          def define_tempo_flag(command)
+            command.desc("Tempo at which the chord progression is played at")
+            command.default_value(120)
+            command.flag([:t, :tempo], type: Integer)
+          end
+
+          def define_single_note_listening_action(command)
+            command.action do |global_options, options, args|
+              Fet::Cli::Generate::SingleNoteListening.run(global_options, options, args)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,6 +11,7 @@ module Fet
             degrees: options[:degrees],
             key_type: options[:"key-type"],
             next_on_correct: options[:"next-on-correct"],
+            limit_degrees: options[:"limit-degrees"],
           ).start
         end
       end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Fet
+  module Cli
+    module Play
+      # Defines the CLI "play listening" command
+      module ListeningCommand
+        def self.included(klass)
+          klass.class_eval do
+            extend ClassMethods
+
+            desc("Run the ear training application")
+            command(:play) do |c|
+              define_listening_command(c)
+            end
+          end
+        end
+
+        # Internal methods for the "play listening" command
+        module ClassMethods
+          private
+
+          def define_listening_command(command)
+            command.desc("Run the ear training application for listening")
+            command.long_desc("Each level will play a chord progression, followed by the specified number of degrees harmonically. The correct degrees should be selected.")
+            command.command :listening do |listening|
+              define_tempo_flag(listening)
+              define_degrees_flag(listening)
+              define_key_type_flag(listening)
+              define_next_on_correct_flag(listening)
+              define_limit_degrees_flag(listening)
+
+              define_listening_action(listening)
+            end
+          end
+
+          def define_tempo_flag(command)
+            command.desc("Tempo at which the chord progression is played at")
+            command.default_value(120)
+            command.flag([:t, :tempo], type: Integer)
+          end
+
+          def define_degrees_flag(command)
+            command.desc("Number of degrees to play")
+            command.default_value(1)
+            command.flag([:d, :degrees], type: Integer, must_match: (1..11).map(&:to_s))
+          end
+
+          def define_key_type_flag(command)
+            command.desc("Type of the chord progression")
+            command.default_value("major")
+            command.flag([:k, :"key-type"], type: String, must_match: ["major", "minor"])
+          end
+
+          def define_next_on_correct_flag(command)
+            command.desc("Automatically go to the next exercise when the answer was correct")
+            command.default_value(true)
+            command.switch [:n, :"next-on-correct"]
+          end
+
+          def define_limit_degrees_flag(command)
+            command.desc("Limit which degrees can play")
+            command.default_value([])
+            command.flag([:l, :"limit-degrees"], type: String, must_match: Fet::Degree::DEGREE_NAMES.flatten, multiple: true)
+          end
+
+          def define_listening_action(command)
+            command.action do |global_options, options, args|
+              Fet::Cli::Play::Listening.run(global_options, options, args)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fet/cli/score/summary.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Fet
+  module Cli
+    module Score
+      # CLI implementation for the "score summary" command
+      module Summary
+        def self.run(_global_options, options, _args)
+          Fet::ScoreSummary.new(
+            minimum_session_length: options[:seconds],
+            number_of_degrees: options[:degrees],
+            key_type: options[:"key-type"],
+            begin_offset: options[:"begin-offset"],
+            end_offset: options[:"end-offset"],
+          ).summary
+        end
+      end
+    end
+  end
+end

data/lib/fet/cli/score/summary_command.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Fet
+  module Cli
+    module Score
+      # Defines the CLI "score summary" command
+      module SummaryCommand
+        def self.included(klass)
+          klass.class_eval do
+            extend ClassMethods
+
+            desc("Score commands")
+            command(:score) do |c|
+              define_summary_command(c)
+            end
+          end
+        end
+
+        # Internal methods for the "score summary" command
+        module ClassMethods
+          private
+
+          def define_summary_command(command)
+            command.desc("Show the score summary")
+            command.command :summary do |summary|
+              define_seconds_flag(summary)
+              define_degrees_flag(summary)
+              define_key_type_flag(summary)
+              define_begin_offset_flag(summary)
+              define_end_offset_flag(summary)
+              define_score_action(summary)
+            end
+          end
+
+          def define_seconds_flag(command)
+            command.desc("Only include games that had greater or equal playtime to the specified amount (in seconds)")
+            command.default_value(0)
+            command.flag([:s, :seconds], type: Integer)
+          end
+
+          def define_degrees_flag(command)
+            command.desc("Number of degrees to play")
+            command.default_value(1)
+            command.flag([:d, :degrees], type: Integer, must_match: (1..11).map(&:to_s))
+          end
+
+          def define_key_type_flag(command)
+            command.desc("Type of the chord progression")
+            command.default_value("major")
+            command.flag([:k, :"key-type"], type: String, must_match: ["major", "minor"])
+          end
+
+          def define_begin_offset_flag(command)
+            command.desc("Offset beginning index of resulting array")
+            command.default_value(0)
+            command.flag([:b, :"begin-offset"], type: Integer)
+          end
+
+          def define_end_offset_flag(command)
+            command.desc("Offset end index of resulting array")
+            command.default_value(0)
+            command.flag([:e, :"end-offset"], type: Integer)
+          end
+
+          def define_score_action(command)
+            command.action do |global_options, options, args|
+              Fet::Cli::Score::Summary.run(global_options, options, args)
+            end
+          end
+        end
+      end
+    end
+  end
+end