music_set_theory 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a54615c8b9ddf6ecabe27b78c6d84d76fb9c618fb3120267eadd21ed67e7267
+  data.tar.gz: 9d56b5499b87e6eed6e6c36cf3d396885b6cfb28340f855e79ae8ce2e8fecc0c
+SHA512:
+  metadata.gz: ffabf6585aade8f22055f93594e9b0f265f4da8fc110917a0460072abb67b2b82953a72c4d31dab145ea9bccdf91bb51743d26f371a1e112f41a201c82b62831
+  data.tar.gz: d5e6d8ed0e69e4e9a865cb233ff96efe92ba48690ae5ac3a7a087ec03e6a8b77e4d3d57e46d96a43528fce92985b6111cba4c86252f0f0dab033591f8a63d45f

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-07-13
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 YAMAMOTO, Masayuki (https://voidptrjp.blogspot.com)
+
+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,104 @@
+# MusicSetTheory
+
+`music_set_theory.gem` is ruby version of `musictheory` of python package, by Peter Murphy.
+> The package has roughly the same philosophy as [Music Set Theory](https://www.jaytomlin.com/music/settheory/help.html) but uses different terminology.
+
+The music theory treats notes and the relationships among them, i.e., temperament, chords, scale, modes, etc.
+
+
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+See the `examples/` directory. The scripts for listing chords and scales are there.
+
+
+## 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).
+
+### Testing
+
+If you want to test all:
+
+```bash
+bundle exec rake test
+```
+
+test a specified one:
+
+```bash
+TEST=./test/something_test.rb  bundle exec rake test
+```
+
+If you want to test a test in a specified file, then:
+
+```bash
+TESTOPTS=--name=/pattern-matches-to-the-description/ TEST=./test/something_test.rb  bundle exec rake test
+```
+
+## Future Works, etc.
+
+I would like to add some examples, debug more, and refactor the structure and method names...
+(Actually, I don't have the knowledge about temperament and modes at (almost) all, though I
+can understand chords and scales a little since I had played the guitar.)
+
+The state-dependencies exists in the original test cases on `WestTemp`. So I have already removed them.
+All tests, including commented out one (`TestChords`), are passed now.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at `https://github.com/mephistobooks/music_set_theory`.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+The original [`musictheory`](https://github.com/peterkmurphy/musictheory) is BSD 3-clauses Licence.
+
+```
+Copyright (c) 2009-2020 Peter Murphy <peterkmurphy@gmail.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * The names of its contributors may not be used to endorse or promote 
+      products derived from this software without specific prior written
+      permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
+

data/Rakefile

@@ -0,0 +1,14 @@
+# 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 "standard/rake"
+
+task default: %i[test standard]

data/examples/mst_chords.rb

@@ -0,0 +1,25 @@
+#! /usr/bin/env ruby
+#
+#
+
+require_relative "../lib/music_set_theory"
+
+
+include MusicSetTheory
+tmp = WestTempNew()
+generate_west_chords(tmp).each_with_index{|e, i|
+  puts "(#{i+1}) #{e}:#{e.class}"
+  puts "  name:     #{e.name}"
+  puts "  type:     #{e.type}"
+  puts "  tment:    #{e.tment}"
+  puts "  notes:    #{e.notes} (unit: number of semitones)"
+  puts "            #{e.notes_deg} (unit: degree, base 0)"
+
+  abbr = "abbr:     #{e.abbr}"
+  abbr += "; #{e.abbr_others}" if e.abbr_others.size > 0
+  puts "  #{abbr}"
+  puts "  syns:     #{e.syns}"
+}
+
+
+#### endof filename: examples/mt_chords.rb

data/examples/mst_temperament.rb

@@ -0,0 +1,46 @@
+#! /usr/bin/env ruby
+#
+# filename: examples/mt_temperament.rb
+#
+
+require_relative "../lib/music_set_theory"
+
+
+include MusicSetTheory
+# tmp = WestTempNew()
+generate_west_chords(WestTemp)
+
+#
+puts "Temperament."
+seq_dict = WestTemp.seq_dict
+nseqtype_dict = seq_dict.nseqtype_maps
+
+pad = " "*2
+pad2 = pad*2
+nseqtype_dict.each {|k, v|
+  puts pad+"dict type (nseqtype): #{NSEQ_TYPE_HASH[k]} (#{k})"
+
+  #
+  dict = v
+  puts pad2+"name_dict (#{dict.name_dict.keys.size}):"
+  dict.name_dict.each_with_index {|(k, v), i|
+    puts pad2+pad+"(#{i+1}) #{k}: #{v}"
+  }
+  puts
+
+  puts pad2+"abbr_dict (#{dict.abbr_dict.keys.size}):"
+  dict.abbr_dict.each_with_index {|(k, v), i|
+    puts pad2+pad+"(#{i+1}) #{k}: #{v}"
+  }
+  puts
+
+  puts pad2+"seqpos_dict (#{dict.seqpos_dict.keys.size}):"
+  dict.seqpos_dict.each_with_index {|(k, v), i|
+    puts pad2+pad+"(#{i+1}) #{k}: #{v}"
+  }
+
+  puts '-'*40
+}
+
+
+#### endof filename: examples/mt_temperament.rb

data/lib/music_set_theory/chord_generator.rb

@@ -0,0 +1,331 @@
+#
+# frozen_string_literal: true
+#
+# filename: music_set_theory/chord_generator.rb
+#
+# Generating tables of chords associated with scales.
+
+
+#-*- coding: UTF-8 -*-
+# chordgenerator.py: Generating tables of chords associated with scales.
+#
+# Copyright (c) 2008-2020 Peter Murphy <peterkmurphy@gmail.com>
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * The names of its contributors may not be used to endorse or promote 
+#       products derived from this software without specific prior written 
+#       permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ''AS IS'' AND ANY
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# This software was originally written by Peter Murphy (2008). It has been
+# updated in 2011 to use the assoicated musictheory classes. Updated for 2011.
+#
+# The goal of this utility is to find all the possible chords (major, minor, 
+# 7th) in common diatonic scales (such as Major and Harmonic Minor).  The
+# results are tables that can be displayed in an HTML file.
+
+
+require_relative "./musutility"
+require_relative "./temperament"
+require_relative "./scales"
+require_relative "./chords"
+
+require 'romannumerals'
+
+
+# import copy, codecs
+# from .musutility import seqtostr;
+# from .temperament import WestTemp, temperament, WestTemp, seq_dict,\
+#     NSEQ_SCALE, NSEQ_CHORD, M_SHARP, M_FLAT;
+# from .scales import MajorScale, MelMinorScale, HarmMinorScale,\
+#     HarmMajorScale;
+# from .chords import CHORDTYPE_DICT;
+
+
+#
+#
+#
+module MusicSetTheory
+
+  class ScaleChords;    end
+  class ScaleChordRow;  end
+  class ScaleChordCell; end
+
+end
+
+
+#
+#
+#
+module MusicSetTheory
+
+  # Used to give a full list of chord types.
+  CHORDTYPE_ARRAY = [
+    "Fifth", "Triad", "Seventh", "Ninth", "Eleventh", "Thirteenth",
+    "Added Ninth", "Suspended", "Suspended Seventh", "Sixth", "Sixth/Ninth",
+    "Added Eleventh",
+  ]
+
+  #
+  PRINT_ABBRV = 0
+  PRINT_FNAME = 1
+  PRINT_BOTH  = 2
+
+end
+
+
+module MusicSetTheory
+
+  # Roman numerals are used for the table headers.
+
+  # Following routine comes from "Roman Numerals (Python recipe)".
+  # Author: Paul Winkler on Sun, 14 Oct 2001. See:
+  # http://code.activestate.com/recipes/81611-roman-numerals/
+
+#    """
+#    Convert an integer to Roman numerals.
+# 
+#    Examples:
+#    >>> int_to_roman(0)
+#    Traceback (most recent call last):
+#    ValueError: Argument must be between 1 and 3999
+# 
+#    >>> int_to_roman(-1)
+#    Traceback (most recent call last):
+#    ValueError: Argument must be between 1 and 3999
+# 
+#    >>> int_to_roman(1.5)
+#    Traceback (most recent call last):
+#    TypeError: expected integer, got <type 'float'>
+# 
+#    >>> for i in range(1, 21): print int_to_roman(i)
+#    ...
+#    I
+#    II
+#    III
+#    IV
+#    V
+#    VI
+#    VII
+#    VIII
+#    IX
+#    X
+#    XI
+#    XII
+#    XIII
+#    XIV
+#    XV
+#    XVI
+#    XVII
+#    XVIII
+#    XIX
+#    XX
+#    >>> print int_to_roman(2000)
+#    MM
+#    >>> print int_to_roman(1999)
+#    MCMXCIX
+#    """
+  def int_to_roman(input)
+    raise "#{input} must be greater than zero." if input <= 0
+
+    input.to_roman
+  end
+
+  #
+  # Make a sequence of roman numerals from 1 to num.
+  def make_roman_numeral_list( num )
+    #return([int_to_roman(i) for i in range(1, num + 1)])
+    (1...(num + 1)).map{|i| int_to_roman(i) }
+  end
+
+end
+
+
+module MusicSetTheory
+  # Represents all the chords associated with a scale. This is
+  # used to make a tabular representation.
+  #
+  class ScaleChords
+
+    attr_accessor :full_name, :key, :full_notes, :table_title, :rows
+    def initialize( full_name, key, full_notes, table_title )
+      self.full_name    = full_name;
+      self.key          = key;
+      self.full_notes   = full_notes;
+      self.table_title  = table_title;
+      self.rows         = [];
+    end
+  end
+
+  # Represents different rows (triads, 7ths, 9ths) in tabular
+  # representations of scale chords.
+  #
+  class ScaleChordRow
+    attr_accessor :chord_type, :notes
+    def initialize( chord_type )
+      self.chord_type = chord_type;
+      self.notes = [];
+    end
+  end
+
+  # Represents different cells in the table of chords.
+  class ScaleChordCell
+    attr_accessor :chordname_1, :chordname_2, :notes
+    def initialize( chordname_1, chordname_2, notes )
+      self.chordname_1 = chordname_1;
+      self.chordname_2 = chordname_2;
+      self.notes = notes;
+    end
+  end
+
+end
+
+
+module MusicSetTheory
+
+  # Used for converting "C" -> 1, "Db"-> 2b, etc.
+  def makebaserep( notex, base = 0 )
+    notexparsed = WestTemp.note_parse(notex)
+    #pos_rep = str(WestTemp.nat_key_lookup_order[notexparsed[0]] + base)
+    pos_rep = (WestTemp.nat_key_lookup_order[notexparsed[0]] + base).to_s
+
+    if notexparsed[1] > 0
+      ret = pos_rep + (M_SHARP * notexparsed[1])
+    elsif notexparsed[1] < 0
+      ret = pos_rep + (M_FLAT * (-1 * notexparsed[1]))
+    else
+      ret = pos_rep;
+    end
+
+    ret
+  end
+
+
+  # Returns an instance of scale_chords using the following inputs:
+  # 
+  # scale_name: a name of a scale like "Dorian".
+  # key: generally a standard music key like "C".
+  # possiblechords: a sequence of chord types like "Seventh" and "Ninth".
+  #
+  def populate_scale_chords( scale_name, key, possiblechords )
+    our_scale = WestTemp.get_nseqby_name(scale_name, NSEQ_SCALE);
+    num_elem = len(our_scale.nseq_posn);
+    begin
+      int_of_key    = key.to_i
+      is_key_an_int = true;
+    rescue ValueError
+      is_key_an_int = false;
+      int_of_key    = nil;
+    end
+
+    if is_key_an_int
+      #our_scale_notes = [makebaserep(x, int_of_key) for x in 
+      #our_scale.get_notes_for_key("C")];
+      our_scale_notes = our_scale.get_notes_for_key("C").map{|x|
+                          makebaserep(x, int_of_key) }
+    else
+      our_scale_notes = our_scale.get_notes_for_key(key)
+    end
+
+    our_chord_data = ScaleChords.new(scale_name, key, our_scale_notes,
+                       make_roman_numeral_list(num_elem))
+
+    for i in possiblechords
+      ourchordrow = ScaleChordRow.new(i)
+      our_chord_data.rows.append(ourchordrow)
+
+      for j in range(num_elem):
+        our_slice = CHORDTYPE_DICT[i];
+        if is_key_an_int
+          #our_chord_notes = [makebaserep(x, int_of_key) for x in
+          #  our_scale.get_notes_for_key("C", j, our_slice)];
+          our_chord_notes = our_scale.get_notes_for_key("C", j, our_slice).
+                              map{|x| makebaserep(x, int_of_key) }
+        else
+          our_chord_notes = our_scale.get_notes_for_key(key, j, our_slice)
+        end
+
+        our_posn  = our_scale.get_posn_for_offset(j, our_slice, true)
+        our_chord = WestTemp.get_nseqby_seqpos(our_posn, NSEQ_CHORD)
+        if our_chord
+          ourchordrow.notes.append(ScaleChordCell.new(our_chord.nseq_name,
+            our_chord.nseq_abbrev, our_chord_notes))
+        else
+          ourchordrow.notes.append(ScaleChordCell.new("", "", our_chord_notes))
+        end
+
+      end
+    end
+
+    return our_chord_data
+  end
+
+
+  # (**) I dont need this.
+  # Generates a table representation of a series of scales,
+  # represented by a scale_chords instance.
+  #
+  def chordgentable( scales )
+    startrow  = "<tr>\n"
+    endrow    = "</tr>\n"
+    thestring = ""
+
+
+    for scale in scales
+      thestring += "<h2>%s</h2>\n" % (scale.key + " " +scale.full_name)
+      thestring += ("<table id=\"%s\" class=\"chordtable\">\n" % 
+          (scale.key + ""))
+      thestring += "<caption>%s</caption>\n" %
+        (scale.key + " " + scale.full_name +
+          ": " + seqtostr(scale.full_notes))
+      thestring += "<thead>\n" + startrow + "<th>Chord Types</th>\n";
+      for q in range(7):
+#             thestring += "<th>%s</th>\n" % str(int_to_roman(q+1));
+      end
+      thestring += endrow + "</thead>\n<tbody>\n";
+
+      for i in scale.rows:
+        thestring += startrow;    
+        thestring += "<td>%s</td>\n" % i.chord_type;
+        for j in i.notes:
+          if not j.chordname_1
+            thestring += ("<td><p>%s<br />" % (str(j.chordname_1)))
+            thestring += ("<i>%s</i><br />" % (str(j.chordname_2)))
+          else
+            thestring += ("<td><p>%s<br />" %
+                          (j.notes[0]+" "+str(j.chordname_1)))
+            thestring += ("<i>%s</i><br />" % (j.notes[0]+str(j.chordname_2)))
+          end
+
+          thestring += ("<b>%s</b></p></td>" % seqtostr(j.notes))
+        end
+        thestring += endrow
+      end
+      thestring += "\n</tbody>\n</table>\n"
+    end
+
+    return thestring
+  end
+
+
+end
+
+
+#### endof filename: music_set_theory/chord_generator.rb