tetsujin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8387e5d1a33b5216b6c4e6582a177021364deca9993d38348fddc920746f72e6
+  data.tar.gz: 7da91bdede287a154db7540e21f7d9d94725cad16e8bb4d4263b830aa432312d
+SHA512:
+  metadata.gz: 0c80e2e2cc875565d6302f95ce9862cbea0578f5a9ce2e865e520bfd1fc13870188d566bf189f11bfbe63de6866a9750a7e96293e44c616026d29384e93d400a
+  data.tar.gz: '08a835992f845f166e9fb6be0148fa9f72b7a7956ed31e3894f4eb54d5efe898825a5ab87e0c35718d2eab509525af6d32c5ac624225448e08b47d87f417ab32'

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Documentation:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Takahashi-Riki
+
+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,35 @@
+# Tetsujin
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tetsujin`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_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:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/tetsujin.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/tetsujin/dsl/instrument.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Tetsujin
+  module DSL
+    module Instrument
+      # @param fretboard_length [Integer] フレット数
+      # @return [Tetsujin::Instrument::Guitar]
+      def regular_tuning_guitar(fretboard_length:)
+        tunings = [
+          Tetsujin::Theory::Note.new(pitch_class:  4, octave: 2),
+          Tetsujin::Theory::Note.new(pitch_class:  9, octave: 2),
+          Tetsujin::Theory::Note.new(pitch_class:  2, octave: 3),
+          Tetsujin::Theory::Note.new(pitch_class:  7, octave: 3),
+          Tetsujin::Theory::Note.new(pitch_class: 11, octave: 3),
+          Tetsujin::Theory::Note.new(pitch_class:  4, octave: 4)
+        ]
+        guitar(tunings: tunings, fretboard_length: fretboard_length)
+      end
+
+      # @param tunings [Array<Tetsujin::Theory::Note>] チューニング 低い方から順に
+      # @param fretboard_length [Integer] フレット数
+      def guitar(tunings:, fretboard_length:)
+        Tetsujin::Instrument::Guitar::Factory.create(tunings: tunings, fretboard_length: fretboard_length)
+      end
+
+      # @param guitar [Tetsujin::Instrument::Guitar]
+      # @return [void]
+      def display_guitar(guitar)
+        displayer = Tetsujin::Instrument::Guitar::Displayer.new
+        guitar.print_fretboard(displayer)
+      end
+    end
+  end
+end

data/lib/tetsujin/dsl/theory.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Tetsujin
+  module DSL
+    module Theory
+      # @param name [String] 音名
+      # @param octave [Integer] オクターブ
+      def note(name, octave)
+        Tetsujin::Theory::Note::Factory.create_from_name(name: name, octave: octave)
+      end
+
+      # @param root [Tetsujin::Theory::Note] ルート音
+      # @param pattern [String | Symbol] スケールのパターン
+      def scale(root, pattern)
+        Tetsujin::Theory::Scale.new(root: root, pattern: pattern.to_sym)
+      end
+    end
+  end
+end

data/lib/tetsujin/dsl.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "dsl/theory"
+require_relative "dsl/instrument"
+
+module Tetsujin
+  module DSL
+    include Tetsujin::DSL::Theory
+    include Tetsujin::DSL::Instrument
+  end
+end

data/lib/tetsujin/instrument/guitar/displayer.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Tetsujin::Instrument
+  class Guitar::Displayer
+    FRET_CHAR_WITDH = 7.freeze # 例えば "A♯4/B♭4" など最大7文字
+    STRING_NUMBER_WITDH = 2.freeze # 例えば "12" など最大2文字を想定
+    private_constant :FRET_CHAR_WITDH
+
+    # @param guitar [Tetsujin::Instrument::Guitar]
+    # @return [void]
+    def print_fretboard(guitar)
+      guitar.strings.sort_by(&:string_number).each{ |string| display_string(string) }
+      display_fretboard_numbers(guitar.fretboard_length)
+    end
+
+    private
+
+    attr_reader :guitar
+
+    # @example
+    #  " 1 : -------      F4 -------      G4 G♯4/A♭4 ------- A♯4/B♭4 -------      C5 C♯5/D♭5 ------- D♯5/E♭5 -------"
+    def display_string(string)
+      frets = string.frets.map{ |fret| fret_representation(fret) }.join(" ")
+      puts [string_number_representation(string.string_number), frets].join(" ")
+    end
+
+    # @example
+    #  "   :       0       1       2       3       4       5       6       7       8       9      10      11      12"
+    def display_fretboard_numbers(fretboard_length)
+      fretnumbers = (0..fretboard_length).to_a.map { |fret_number| fretboard_number_representation(fret_number) }.join(" ")
+      puts [string_number_representation(""), fretnumbers].join(" ")
+    end
+
+    # @example
+    #  "A♯4/B♭4"
+    #  "-------"
+    def fret_representation(fret)
+      fret_char_width = 7
+      fret.pressed? ? fret.note.to_s.rjust(fret_char_width) : "-" * fret_char_width
+    end
+
+    # @example
+    #  1 => " 1 :"
+    def string_number_representation(string_number)
+      "#{string_number.to_s.rjust(string_number_width)} :"
+    end
+
+    # @example
+    #  1 => "      1"
+    def fretboard_number_representation(fret_number)
+      fret_number.to_s.rjust(fretboard_number_width)
+    end
+
+    def fretboard_number_width
+      FRET_CHAR_WITDH
+    end
+
+    def string_number_width
+      STRING_NUMBER_WITDH
+    end
+  end
+end

data/lib/tetsujin/instrument/guitar/factory.rb

@@ -0,0 +1,17 @@
+module Tetsujin::Instrument
+  class Guitar::Factory
+    # @param tunings [Array<Tetsujin::Theory::Note>] チューニング 低い方から順に
+    # @param fretboard_length [Integer] フレット数
+    # @return [Tetsujin::Instrument::Guitar]
+    def self.create(tunings:, fretboard_length:)
+      strings = tunings.reverse.map.with_index(1) do |tuning, string_number|
+        Tetsujin::Instrument::Guitar::String.new(
+          tuning: tuning,
+          string_number: string_number,
+          fretboard_length: fretboard_length
+        )
+      end
+      Tetsujin::Instrument::Guitar.new(strings: strings)
+    end
+  end
+end

data/lib/tetsujin/instrument/guitar/fret.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Tetsujin::Instrument
+  class Guitar::Fret
+    attr_reader :note, :string_number, :fret_number
+
+    # @param note [Tetsujin::Theory::Note] 音
+    # @param string_number [Integer] 弦番号
+    # @param fret_number [Integer] フレット番号
+    def initialize(note:, string_number:, fret_number:)
+      raise TypeError unless note.is_a?(Tetsujin::Theory::Note)
+      raise TypeError unless string_number.is_a?(Integer)
+      raise TypeError unless fret_number.is_a?(Integer)
+
+      @note = note
+      @string_number = string_number
+      @fret_number = fret_number
+      @pressed = false
+    end
+
+    # @param other [Tetsujin::Instrument::Guitar::Fret]
+    # @return [Boolean]
+    def ==(other)
+      note == other.note && string_number == other.string_number && fret_number == other.fret_number
+    end
+
+    # @return [Boolean] フレットが押されているか
+    def pressed?
+      pressed
+    end
+
+    # @return [void]
+    def press!
+      @pressed = true
+    end
+
+    # @return [void]
+    def release!
+      @pressed = false
+    end
+
+    private
+
+    attr_reader :pressed
+  end
+end

data/lib/tetsujin/instrument/guitar/frets.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Tetsujin::Instrument
+  class Guitar::Frets
+    extend Forwardable
+    def_delegators :frets, :each, :map, :find, :size
+
+    attr_reader :frets
+
+    # @param frets [Array<Tetsujin::Instrument::Guitar::Fret>] フレットの配列
+    def initialize(frets:)
+      raise TypeError unless frets.all? { |fret| fret.is_a?(Tetsujin::Instrument::Guitar::Fret) }
+      @frets = frets
+    end
+
+    # @param note [Tetsujin::Theory::Note]
+    def ==(other)
+      self_sorted = frets.sort do |a, b|
+        [a.string_number, a.fret_number] <=> [b.string_number, b.fret_number]
+      end
+      other_sorted = other.frets.sort do |a, b|
+        [a.string_number, a.fret_number] <=> [b.string_number, b.fret_number]
+      end
+      self_sorted == other_sorted
+    end
+
+    # @param note [Tetsujin::Theory::Note]
+    # @return [void]
+    def play!(note)
+      find_by_note(note)&.press!
+    end
+
+    # @param fret_number [Integer]
+    # @return [void]
+    def press!(fret_number)
+      find_by_fret_number(fret_number).press!
+    end
+
+    # @return [void]
+    def release!
+      frets.each(&:release!)
+    end
+
+    # @param fret_number [Integer] フレット番号
+    # @return [Tetsujin::Instrument::Guitar::Fret]
+    def find_by_fret_number(fret_number)
+      frets.find { |fret| fret.fret_number == fret_number }
+    end
+
+    # @param note [Tetsujin::Theory::Note]
+    # @return [Tetsujin::Instrument::Guitar::Fret]
+    def find_by_note(note)
+      frets.find { |fret| fret.note == note }
+    end
+  end
+end

data/lib/tetsujin/instrument/guitar/string.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Tetsujin::Instrument
+  class Guitar::String
+    attr_reader :tuning, :fretboard_length, :string_number
+
+    # @param tuning [Tetsujin::Theory::Note] チューニング
+    # @param string_number [Integer] 弦番号
+    # @param fretboard_length [Integer] フレット数
+    def initialize(tuning:, string_number:, fretboard_length: 22)
+      raise TypeError unless tuning.is_a?(Tetsujin::Theory::Note)
+      raise TypeError unless string_number.is_a?(Integer)
+      raise TypeError unless fretboard_length.is_a?(Integer)
+
+      @tuning = tuning
+      @string_number = string_number
+      @fretboard_length = fretboard_length
+    end
+
+    # @return [Tetsujin::Instrument::Guitar::Frets]
+    def frets
+      @_frets ||= generate_frets
+    end
+
+    # @param fret_number [Integer]
+    # @return [Tetsujin::Instrument::Guitar::Fret]
+    def [](fret_number)
+      frets.find_by_fret_number(fret_number)
+    end
+
+    # @param notes [Enumerable<Tetsujin::Theory::Note>] each でループした際に Note オブジェクトが取得できる Enumerable
+    # @return [void]
+    def play!(notes)
+      notes.each { |note| frets.play!(note) }
+    end
+
+    # @param fret_number [Integer]
+    # @return [void]
+    def press!(fret_number)
+      frets.press!(fret_number)
+    end
+
+    # @return [void]
+    def release!
+      frets.release!
+    end
+
+    # @param other [Tetsujin::Instrument::Guitar::String]
+    # @return [Boolean]
+    def ==(other)
+      tuning == other.tuning && string_number == other.string_number && fretboard_length == other.fretboard_length
+    end
+
+    private
+
+    def generate_frets
+      frets = (0..fretboard_length).map do |fret_number|
+        interval = Tetsujin::Theory::Interval.new(value: fret_number)
+        Tetsujin::Instrument::Guitar::Fret.new(note: tuning.add(interval), string_number: string_number, fret_number: fret_number)
+      end
+      Tetsujin::Instrument::Guitar::Frets.new(frets: frets)
+    end
+  end
+end

data/lib/tetsujin/instrument/guitar.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Tetsujin::Instrument
+  class Guitar
+    attr_reader :strings
+
+    def initialize(strings:)
+      raise TypeError unless strings.is_a?(Array)
+      raise TypeError unless strings.all? { |string| string.is_a?(Tetsujin::Instrument::Guitar::String) }
+      @strings = strings
+    end
+
+    # @param notes [Enumerable<Tetsujin::Theory::Note>] each でループした際に Note オブジェクトが取得できる Enumerable
+    # @return [void]
+    def play!(notes)
+      strings.each { |string| string.play!(notes) }
+    end
+
+    # @param string_number [Integer]
+    # @param fret_number [Integer]
+    # @return [void]
+    def press!(string_number, fret_number)
+      find_string(string_number).press!(fret_number)
+    end
+
+    # @return [void]
+    def release!
+      strings.each(&:release!)
+    end
+
+    # @param string_number [Integer]
+    # @return [Tetsujin::Instrument::Guitar::String]
+    def [](string_number)
+      strings.find { |string| string.string_number == string_number }
+    end
+    alias find_string []
+
+    # @return [Integer]
+    def fretboard_length
+      strings.map(&:fretboard_length).max
+    end
+
+    # @param displayer [Tetsujin::Instrument::Guitar::Displayer] フレットボードを表示するための Displayer オブジェクト
+    # @example
+    # 1:      E4 ------- F♯4/G♭4      G4 -------      A4 -------      B4 ------- C♯5/D♭5 ------- ------- -------
+    # 2: ------- ------- -------      D4 -------      E4 ------- F♯4/G♭4      G4 -------      A4 -------      B4
+    # 3: ------- ------- ------- ------- ------- ------- -------      D4 -------      E4 ------- F♯4/G♭4      G4
+    # 4: ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- -------      D4
+    # 5: ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- -------
+    # 6: ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- -------
+    #          0       1       2       3       4       5       6       7       8       9      10      11      12
+    def print_fretboard(displayer)
+      displayer.print_fretboard(self)
+    end
+
+    # @param other [Tetsujin::Instrument::Guitar]
+    # @return [Boolean]
+    def ==(other)
+      strings.sort_by(&:string_number) == other.strings.sort_by(&:string_number)
+    end
+  end
+end

data/lib/tetsujin/instrument.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module Tetsujin::Instrument
+end

data/lib/tetsujin/theory/interval.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Tetsujin::Theory
+  class Interval
+    attr_reader :value
+
+    # @param value [Integer] 度数
+    def initialize(value:)
+      raise TypeError unless value.is_a?(Integer)
+      @value = value
+    end
+
+    # @param other [Tetsujin::Theory::Interval]
+    # @return [Boolean]
+    def ==(other)
+      value == other.value
+    end
+  end
+end

data/lib/tetsujin/theory/note/factory.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Tetsujin::Theory
+  class Note::Factory
+    NOTE_NAME_JA_TO_PITCH_CLASS = {
+      "ド" => 0,
+      "ド#" => 1, "ド♯" => 1, "レb" => 1, "レ♭" => 1,
+      "レ" => 2,
+      "レ#" => 3, "レ♯" => 3, "ミb" => 3, "ミ♭" => 3,
+      "ミ" => 4,
+      "ファ" => 5,
+      "ファ#" => 6, "ファ♯" => 6, "ソb" => 6, "ソ♭" => 6,
+      "ソ" => 7,
+      "ソ#" => 8, "ソ♯" => 8, "ラb" => 8, "ラ♭" => 8,
+      "ラ" => 9,
+      "ラ#" => 10, "ラ♯" => 10, "シb" => 10, "シ♭" => 10,
+      "シ" => 11
+    }.freeze
+    NOTE_NAME_EN_TO_PITCH_CLASS = {
+      "C" => 0,
+      "C#" => 1, "C♯" => 1, "Db" => 1, "D♭" => 1,
+      "D" => 2,
+      "D#" => 3, "D♯" => 3, "Eb" => 3, "E♭" => 3,
+      "E" => 4,
+      "F" => 5,
+      "F#" => 6, "F♯" => 6, "Gb" => 6, "G♭" => 6,
+      "G" => 7,
+      "G#" => 8, "G♯" => 8, "Ab" => 8, "A♭" => 8,
+      "A" => 9,
+      "A#" => 10, "A♯" => 10, "Bb" => 10, "B♭" => 10,
+      "B" => 11
+    }.freeze
+    NOTE_NAME_ALIAS_TO_PITCH_CLASS = NOTE_NAME_JA_TO_PITCH_CLASS.merge(NOTE_NAME_EN_TO_PITCH_CLASS).freeze
+    private_constant :NOTE_NAME_JA_TO_PITCH_CLASS, :NOTE_NAME_EN_TO_PITCH_CLASS, :NOTE_NAME_ALIAS_TO_PITCH_CLASS
+
+    # @param name [String | Symbol] 音名
+    # @param octave [Integer] オクターブ
+    # @return [Tetsujin::Theory::Note]
+    def self.create_from_name(name:, octave:)
+      raise TypeError unless name.is_a?(String) || name.is_a?(Symbol)
+      pitch_class = search_pitch_class(name.to_s)
+      raise ArgumentError unless pitch_class
+      Tetsujin::Theory::Note.new(pitch_class: pitch_class, octave: octave)
+    end
+
+    private
+
+    def self.search_pitch_class(name)
+      note_name_alias_to_pitch_class[name]
+    end
+
+    def self.note_name_alias_to_pitch_class
+      NOTE_NAME_ALIAS_TO_PITCH_CLASS
+    end
+  end
+end

data/lib/tetsujin/theory/note.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Tetsujin::Theory
+  class Note
+    attr_reader :pitch_class, :octave
+
+    PITCH_CLASS_TO_NOTE_NAME = {
+      0 => ["C"],
+      1 => ["C♯", "D♭"],
+      2 => ["D"],
+      3 => ["D♯", "E♭"],
+      4 => ["E"],
+      5 => ["F"],
+      6 => ["F♯", "G♭"],
+      7 => ["G"],
+      8 => ["G♯", "A♭"],
+      9 => ["A"],
+      10 => ["A♯", "B♭"],
+      11 => ["B"]
+    }.freeze
+    NOTES_IN_OCTAVE = 12
+    private_constant :PITCH_CLASS_TO_NOTE_NAME, :NOTES_IN_OCTAVE
+
+    # @param pitch_class [Integer] ピッチクラス
+    # @param octave [Integer] オクターブ
+    def initialize(pitch_class:, octave: 4)
+      raise TypeError unless pitch_class.is_a?(Integer)
+      raise TypeError unless octave.is_a?(Integer)
+      raise ArgumentError unless PITCH_CLASS_TO_NOTE_NAME.key?(pitch_class)
+
+      @pitch_class = pitch_class
+      @octave = octave
+    end
+
+    # @return [String] 音名とオクターブを結合した文字列 (例: "G♯4/A♭4")
+    def to_s
+      note_names = PITCH_CLASS_TO_NOTE_NAME[pitch_class]
+      note_names.map { |note_name| "#{note_name}#{octave}" }.join("/")
+    end
+
+    # @param interval [Tetsujin::Theory::Interval] 移動する音程
+    # @return [Tetsujin::Theory::Note] 移動後の音
+    def add(interval)
+      added_octaves, new_pitch_class = (pitch_class + interval.value).divmod(notes_in_octave)
+      self.class.new(pitch_class: new_pitch_class, octave: octave + added_octaves)
+    end
+
+    # @param interval [Tetsujin::Theory::Interval] 移動する音程
+    # @return [Tetsujin::Theory::Note] 移動後の音
+    def subtract(interval)
+      subtracted_octaves, new_pitch_class = (pitch_class - interval.value).divmod(notes_in_octave)
+      self.class.new(pitch_class: new_pitch_class, octave: octave + subtracted_octaves)
+    end
+
+    # @param other [Tetsujin::Theory::Note] 比較対象の音
+    # @return [Tetsujin::Theory::Interval] 2つの音の音程
+    def diff(other)
+      pitch_diff = (other.octave - octave) * notes_in_octave + other.pitch_class - pitch_class
+      Tetsujin::Theory::Interval.new(value: pitch_diff)
+    end
+
+    # @param other [Tetsujin::Theory::Note] 比較対象の音
+    # @return [Boolean] 音名とオクターブが一致しているか
+    def ==(other)
+      return false unless other.is_a?(self.class)
+      pitch_class == other.pitch_class && octave == other.octave
+    end
+    alias eql? ==
+
+    # @return [Integer] ハッシュ値
+    def hash
+      [pitch_class, octave].hash
+    end
+
+    # @param other [Tetsujin::Theory::Note] 比較対象の音
+    # @return [Integer] 音名とオクターブの比較結果
+    def <=>(other)
+      return nil unless other.is_a?(self.class)
+      octave == other.octave ? pitch_class <=> other.pitch_class : octave <=> other.octave
+    end
+
+    private
+
+    # @return [Integer] 1オクターブあたりの音数
+    def notes_in_octave
+      NOTES_IN_OCTAVE
+    end
+  end
+end

data/lib/tetsujin/theory/notes.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require "forwardable"
+
+module Tetsujin::Theory
+  class Notes
+    extend Forwardable
+    def_delegators :notes, :each, :map
+
+    attr_reader :notes
+
+    # @param notes [Array<Tetsujin::Theory::Note>] 音の配列
+    def initialize(notes:)
+      raise TypeError unless notes.is_a?(Array)
+      raise ArgumentError unless notes.all? { |note| note.is_a?(Tetsujin::Theory::Note) }
+      @notes = notes
+    end
+
+    # @param other [Tetsujin::Theory::Notes]
+    # @return [Boolean] 同じ音を持つかどうか
+    def ==(other)
+      self_sorted = notes.sort do |a, b|
+        [a.octave, a.pitch_class] <=> [b.octave, b.pitch_class]
+      end
+      other_sorted = other.notes.sort do |a, b|
+        [a.octave, a.pitch_class] <=> [b.octave, b.pitch_class]
+      end
+      self_sorted == other_sorted
+    end
+
+    # @param other [Tetsujin::Theory::Notes]
+    # @return [Tetsujin::Theory::Notes] 2つの音の和集合
+    def +(other)
+      new_notes = (notes + other.notes).uniq.sort
+      Tetsujin::Theory::Notes.new(notes: new_notes)
+    end
+  end
+end

data/lib/tetsujin/theory/scale.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Tetsujin::Theory
+  class Scale < Notes
+    SCALE_PATTERNS = {
+      major:            [2, 2, 1, 2, 2, 2, 1],
+      minor:            [2, 1, 2, 2, 1, 2, 2],
+      harmonic_minor:   [2, 1, 2, 2, 1, 3, 1],
+      melodic_minor:    [2, 1, 2, 2, 2, 2, 1],
+      dorian:           [2, 1, 2, 2, 2, 1, 2],
+      phrygian:         [1, 2, 2, 2, 1, 2, 2],
+      lydian:           [2, 2, 2, 1, 2, 2, 1],
+      mixolydian:       [2, 2, 1, 2, 2, 1, 2],
+      aeolian:          [2, 1, 2, 2, 1, 2, 2],
+      locrian:          [1, 2, 2, 1, 2, 2, 2],
+      whole_tone:       [2, 2, 2, 2, 2, 2],
+      chromatic:        [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+      blues:            [3, 2, 1, 1, 3, 2],
+      pentatonic_major: [2, 2, 3, 2, 3],
+      pentatonic_minor: [3, 2, 2, 3, 2],
+      diminished:       [2, 1, 2, 1, 2, 1, 2, 1]
+    }.freeze
+
+    # @param root [Tetsujin::Theory::Note] スケールのルート音
+    # @param pattern [Symbol] スケールの構成パターン
+    def initialize(root:, pattern: :major)
+      raise TypeError unless root.is_a?(Tetsujin::Theory::Note)
+      raise TypeError unless pattern.is_a?(Symbol)
+      raise ArgumentError unless SCALE_PATTERNS.key?(pattern)
+
+      @root = root
+      @pattern = SCALE_PATTERNS[pattern]
+    end
+
+    # @return [Array<Tetsujin::Theory::Note>] スケールの音階
+    def notes
+      @_notes ||= generate_scale
+    end
+
+    private
+
+    attr_reader :root, :pattern
+
+    # @return [Array<Tetsujin::Theory::Note>] スケールの音階
+    def generate_scale
+      notes = [root]
+      pattern.each do |interval|
+        notes << notes.last.add(Tetsujin::Theory::Interval.new(value: interval))
+      end
+      notes
+    end
+  end
+end

data/lib/tetsujin/theory.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module Tetsujin::Theory
+end

data/lib/tetsujin/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Tetsujin
+  VERSION = "0.1.0"
+end

data/lib/tetsujin.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "tetsujin/version"
+
+# ------------- Theory -------------
+require_relative "tetsujin/theory"
+
+# Note
+require_relative "tetsujin/theory/note"
+require_relative "tetsujin/theory/notes"
+require_relative "tetsujin/theory/note/factory"
+
+# Scale
+require_relative "tetsujin/theory/scale"
+
+# Interval
+require_relative "tetsujin/theory/interval"
+
+# ------------- Instrument -------------
+require_relative "tetsujin/instrument"
+
+# Guitar
+require_relative "tetsujin/instrument/guitar"
+require_relative "tetsujin/instrument/guitar/string"
+require_relative "tetsujin/instrument/guitar/fret"
+require_relative "tetsujin/instrument/guitar/frets"
+require_relative "tetsujin/instrument/guitar/displayer"
+require_relative "tetsujin/instrument/guitar/factory"
+
+# ------------- DSL -------------
+require_relative "tetsujin/dsl"
+require_relative "tetsujin/dsl/theory"
+require_relative "tetsujin/dsl/instrument"
+
+module Tetsujin
+  include Tetsujin::DSL
+end

data/sig/tetsujin.rbs

@@ -0,0 +1,4 @@
+module Tetsujin
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: tetsujin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mew3880
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-25 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- mew3880@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tetsujin.rb
+- lib/tetsujin/dsl.rb
+- lib/tetsujin/dsl/instrument.rb
+- lib/tetsujin/dsl/theory.rb
+- lib/tetsujin/instrument.rb
+- lib/tetsujin/instrument/guitar.rb
+- lib/tetsujin/instrument/guitar/displayer.rb
+- lib/tetsujin/instrument/guitar/factory.rb
+- lib/tetsujin/instrument/guitar/fret.rb
+- lib/tetsujin/instrument/guitar/frets.rb
+- lib/tetsujin/instrument/guitar/string.rb
+- lib/tetsujin/theory.rb
+- lib/tetsujin/theory/interval.rb
+- lib/tetsujin/theory/note.rb
+- lib/tetsujin/theory/note/factory.rb
+- lib/tetsujin/theory/notes.rb
+- lib/tetsujin/theory/scale.rb
+- lib/tetsujin/version.rb
+- sig/tetsujin.rbs
+homepage: https://github.com/Takahashi-Riki/tetsujin
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Takahashi-Riki/tetsujin
+  source_code_uri: https://github.com/Takahashi-Riki/tetsujin
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: ギターのスケールを生成するライブラリ
+test_files: []