tetsujin 0.1.0 → 0.3.0

checksums.yaml

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

data/README.md

@@ -1,24 +1,116 @@
 # 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
+```
+$ gem install tetsujin
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Please include Tetsujin Module
+
+```ruby
+require "tetsujin"
+
+class YourClass
+  include Tetsujin
+end
+```
+
+### Generate a Note
+
+```ruby
+# Can generate C4 sound
+c_note = create_note("C", 4)
+c_note = create_note("ド", 4)
+```
+
+### Generate a Scale
+
+```ruby
+# Can generate major scales starting from C4
+c_note = create_note("C", 4)
+c_major_scale = create_scale(c_note, :major)
+c_major_scale = create_scale(c_note, "major")
+```
+
+### Generate a Guitar
+
+```ruby
+# Can generate a guitar in regular tuning
+guitar = create_regular_tuning_guitar(fretboard_length: 22)
+
+# Can generate custom tuned guitars
+tunings = [
+  create_note("B", 2),
+  create_note("E", 2),
+  create_note("A", 2),
+  create_note("D", 3),
+  create_note("G", 3),
+  create_note("B", 3),
+  create_note("E", 4)
+]
+guitar = create_guitar(tunings: tunings, fretboard_length: 22)
+```
+
+### Playing notes on the guitar
+
+```ruby
+guitar = create_regular_tuning_guitar(fretboard_length: 12)
+
+c_note = create_note("C", 4)
+d_note = create_note("D", 4)
+
+guitar.play!([c_note, d_note])
+display_guitar(guitar)
+
+#  1 : ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- -------
+#  2 : -------      C4 -------      D4 ------- ------- ------- ------- ------- ------- ------- ------- -------
+#  3 : ------- ------- ------- ------- -------      C4 -------      D4 ------- ------- ------- ------- -------
+#  4 : ------- ------- ------- ------- ------- ------- ------- ------- ------- -------      C4 -------      D4
+#  5 : ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- -------
+#  6 : ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- -------
+#    :       0       1       2       3       4       5       6       7       8       9      10      11      12
+```
+
+### Playing scales on the guitar
+
+```ruby
+guitar = create_regular_tuning_guitar(fretboard_length: 12)
+
+c_note = create_note("C", 4)
+c_major_scale = create_scale(c_note, :major)
+
+guitar.play!(c_major_scale)
+create_display_guitar(guitar)
+
+#  1 :      E4      F4 -------      G4 -------      A4 -------      B4      C5 ------- ------- ------- -------
+#  2 : -------      C4 -------      D4 -------      E4      F4 -------      G4 -------      A4 -------      B4
+#  3 : ------- ------- ------- ------- -------      C4 -------      D4 -------      E4      F4 -------      G4
+#  4 : ------- ------- ------- ------- ------- ------- ------- ------- ------- -------      C4 -------      D4
+#  5 : ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- -------
+#  6 : ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- -------
+#    :       0       1       2       3       4       5       6       7       8       9      10      11      12
+```
+
+### Pressing frets
+
+```ruby
+guitar = create_regular_tuning_guitar(fretboard_length: 12)
+
+guitar.press!(2, 1)
+guitar.press!(2, 3)
+display_guitar(guitar)
+
+#  1 : ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- -------
+#  2 : -------      C4 -------      D4 ------- ------- ------- ------- ------- ------- ------- ------- -------
+#  3 : ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- -------
+#  4 : ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- -------
+#  5 : ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- -------
+#  6 : ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- -------
+#    :       0       1       2       3       4       5       6       7       8       9      10      11      12
+```
 
 ## Development
 

data/lib/tetsujin/dsl/instrument.rb

@@ -5,7 +5,7 @@ module Tetsujin
     module Instrument
       # @param fretboard_length [Integer] フレット数
       # @return [Tetsujin::Instrument::Guitar]
-      def regular_tuning_guitar(fretboard_length:)
+      def create_regular_tuning_guitar(fretboard_length:)
         tunings = [
           Tetsujin::Theory::Note.new(pitch_class:  4, octave: 2),
           Tetsujin::Theory::Note.new(pitch_class:  9, octave: 2),
@@ -14,12 +14,12 @@ module Tetsujin
           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)
+        create_guitar(tunings: tunings, fretboard_length: fretboard_length)
       end
 
       # @param tunings [Array<Tetsujin::Theory::Note>] チューニング 低い方から順に
       # @param fretboard_length [Integer] フレット数
-      def guitar(tunings:, fretboard_length:)
+      def create_guitar(tunings:, fretboard_length:)
         Tetsujin::Instrument::Guitar::Factory.create(tunings: tunings, fretboard_length: fretboard_length)
       end
 

data/lib/tetsujin/dsl/theory.rb

@@ -5,13 +5,13 @@ module Tetsujin
     module Theory
       # @param name [String] 音名
       # @param octave [Integer] オクターブ
-      def note(name, octave)
+      def create_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)
+      def create_scale(root, pattern)
         Tetsujin::Theory::Scale.new(root: root, pattern: pattern.to_sym)
       end
     end

data/lib/tetsujin/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tetsujin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - mew3880
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-25 00:00:00.000000000 Z
+date: 2024-09-01 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: