fet 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a6eaf2c2012e548d709b7c60d8bb087f55062ea7a069fade95adb5ee04f8c70
+  data.tar.gz: d9a82a31165883c5219fd94b042dcc0ceda2c12e4e2c8fb915257e5bb02e6df6
+SHA512:
+  metadata.gz: 9c78069eab1b047f0e7bf72580e5d5dac1c12467e606ff8be3637fcd202a6e666d009900bbcee3e7bad66992fbf488df3abe049d0a14494a54c9209223401d30
+  data.tar.gz: b7d43fc3d8edff904615b9e6b681edc4b77d6becca9beee2a137c3b2e8fdd0071aab9953dffd090a3f107f5b0e24054fd5af4cdfba544920949aa6ee39490fd6

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.2
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake
+      env:
+        CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}

data/.gitignore

@@ -0,0 +1,11 @@
+/singing/
+/listening/
+/listening_single_note/
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,47 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/RaiseArgs:
+  Enabled: true
+  EnforcedStyle: compact
+
+Style/WordArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+Style/SymbolArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+Layout/CaseIndentation:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 175
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false

data/.ruby_version

@@ -0,0 +1 @@
+3.0.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-08-26
+
+- Initial release

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's runtime dependencies in fet.gemspec
+gemspec
+
+group :test do
+  gem "minitest", "~> 5.0"
+  gem "simplecov", "~> 0.21.2"
+end
+
+group :test, :development do
+  gem "codecov", "~> 0.6.0"
+  gem "pry-byebug", "~> 3.9"
+  gem "rake", "~> 13.0"
+  gem "rdoc", "~> 6.3", ">= 6.3.2"
+  gem "rubocop", "~> 1.7"
+end

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    fet (0.2.0)
+      gli (~> 2.20, >= 2.20.1)
+      ice_nine (~> 0.11.2)
+      midilib (~> 2.0, >= 2.0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    coderay (1.1.3)
+    docile (1.4.0)
+    gli (2.20.1)
+    ice_nine (0.11.2)
+    method_source (1.0.0)
+    midilib (2.0.5)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rdoc (6.3.2)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.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)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codecov (~> 0.6.0)
+  fet!
+  minitest (~> 5.0)
+  pry-byebug (~> 3.9)
+  rake (~> 13.0)
+  rdoc (~> 6.3, >= 6.3.2)
+  rubocop (~> 1.7)
+  simplecov (~> 0.21.2)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Dimitrios Lisenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Dimitrios Lisenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,113 @@
+[![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.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fet'
+```
+
+And then execute:
+
+    $ bundle install
+
+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
+The generators will currently create MIDI files. The correct answer is included in the filename.
+
+### Listening exercises
+For listening exercises, here is a potential list of generated MIDI files (for 2 degrees):
+```sh
+$ find .
+...
+./listening/major/DbM_b6(Bbb2)_5(Ab5).mid
+./listening/major/BbM_7(A4)_2(C6).mid
+./listening/major/EM_b6(C2)_3(G#2).mid
+./listening/major/GbM_6(Eb4)_3(Bb5).mid
+./listening/major/FM_6(D4)_3(A5).mid
+...
+./listening/minor/Dm_b7(C3)_1(D4).mid
+./listening/minor/F#m_b2(G2)_3(A#4).mid
+./listening/minor/G#m_b6(E1)_b2(A2).mid
+./listening/minor/Dm_6(B0)_7(C#3).mid
+./listening/minor/C#m_5(G#4)_6(A#4).mid
+...
+```
+The file name contains all the information required for the answer. For example, `EM_b6(C2)_3(G#2).mid`:
+
+`EM`: the chord progression is in E Major.
+
+`b6`: the bottom note will be the b6 degree
+
+`(C2)`: the [scientific pitch notation](https://en.wikipedia.org/wiki/Scientific_pitch_notation) of which is C2
+
+`3`: the next note from the bottom will be the 3 degree
+
+`(G#2)`: the [scientific pitch notation](https://en.wikipedia.org/wiki/Scientific_pitch_notation) of which is G#2
+
+### Singing exercises
+The singing exercises will generate all possible combinations for keys and degrees as follows:
+```sh
+$ find .
+...
+./singing/major/AM_1.mid
+./singing/major/BbM_3.mid
+./singing/major/CM_4.mid
+./singing/major/CM_5.mid
+./singing/major/BbM_2.mid
+...
+./singing/minor/Am_1.mid
+./singing/minor/Bbm_3.mid
+./singing/minor/Cm_4.mid
+./singing/minor/G#m_4.mid
+./singing/minor/F#m_1.mid
+...
+```
+The file name contains all the information required for the answer. For example, `BbM_3.mid`:
+
+`BbM`: the chord progression is in Bb Major.
+
+`3`: you should sing the 3rd degree.
+
+### Single Note Listening exercises
+For single note listening exercises, the same note is played across all possible keys:
+```sh
+$ find .
+...
+./listening_single_note/major/CM_1.mid
+./listening_single_note/major/BM_b2.mid
+./listening_single_note/major/F#M_b5.mid
+...
+./listening_single_note/minor/Am_b3.mid
+./listening_single_note/minor/G#m_3.mid
+./listening_single_note/minor/Cm_1.mid
+...
+```
+The file name contains all the information required for the answer. For example, `G#m_3.mid`:
+
+`G#m`: the chord progression is in G# Minor.
+
+`3`: the note that is played is the 3rd degree in this key.
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DimitriosLisenko/fet.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/README.rdoc

@@ -0,0 +1,6 @@
+= fet
+
+FET (Functional Ear Trainer)
+
+:include:fet.rdoc
+

data/Rakefile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+require "rdoc/task"
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb", "bin/**/*")
+  rd.title = "FET (Functional Ear Trainer)"
+end
+
+task(default: [:test, :rubocop])

data/bin/bash_scripts/cleanup_listening_exercises.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+rm -rf listening

data/bin/bash_scripts/cleanup_singing_exercises.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+rm -rf singing

data/bin/bash_scripts/midi_to_mp3.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+for i in ${1}/major/*.mid ; do 
+  timidity -Ow -o - $i | lame - ${i/mid/mp3}
+  # rm $i
+done
+
+for i in ${1}/minor/*.mid ; do 
+  timidity -Ow -o - $i | lame - ${i/mid/mp3}
+  # rm $i
+done
+
+mv ${1}/major/*.mp3 ${1}/major/mp3
+mv ${1}/minor/*.mp3 ${1}/minor/mp3

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "fet"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/fet

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "gli"
+require "fet"
+
+# Class in charge of implementing command-line interface
+class App
+  extend GLI::App
+
+  program_desc("Functional Ear Trainer")
+
+  version(Fet::VERSION)
+
+  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
+
+  # NOTE: if you need the backtrace for an exception, this can be uncommented
+  # on_error do |exception|
+  #   puts exception.backtrace
+  #   true
+  # end
+end
+
+exit App.run(ARGV)