tetsujin 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 265c81d8c091b1fa69ebd13794384500a72398e9ad4001d76a3a2bc855e04c2a
-  data.tar.gz: f5f080815563e35bf4f2de4cce3aca3a4fea406c336d26bc5859e82ca5acdb68
+  metadata.gz: d6a9279855f7d0c718185bb8ed486a3776f7ccfb8c60dfc6af1013399a31e35c
+  data.tar.gz: 8f3852d8bf63e5f125150471c1456b72e4e0cc20b34660e575804a2dce9c22d6
 SHA512:
-  metadata.gz: 3422960fb0606a5d8f0ea7920bd25421ac2f90e987e29692b868651b2d78ebd7c81da9cdb015619f27f6b8f6d09043289d444da6ce86b487aa108b88c89dcb3e
-  data.tar.gz: db59e1f76f730c037ad55c763d4aca4055ee6b8d1c1024e466eb5084cc120b7a1d72bb2f5157e1364f021a9061c819f3cc3b33b9d9479b70c18d5beab7b8dda1
+  metadata.gz: 0dd1cb8536f142f4634dc0d36ec028ecbb266e2ed0d921637783979cf2f0a284ee52df5966eccb0f96e46c7d1d868f3c923fded3a4e51ece578d4393021a33c1
+  data.tar.gz: dabffa5e60b3c2238f6fd7e95777c1c758f5e881193142190ec0fbe2851c1dedd0066b4c664d100bf57cadff663bd83a202bdcfe8efe939fe73eeed206f7eca9

data/README.md

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

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.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tetsujin
 version: !ruby/object:Gem::Version
-  version: 0.2.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:
@@ -41,7 +41,6 @@ files:
 - lib/tetsujin/theory/scale.rb
 - lib/tetsujin/version.rb
 - sig/tetsujin.rbs
-- tetsujin.gemspec
 homepage: https://github.com/Takahashi-Riki/tetsujin
 licenses:
 - MIT

data/tetsujin.gemspec

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/tetsujin/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "tetsujin"
-  spec.version = Tetsujin::VERSION
-  spec.authors = ["mew3880"]
-  spec.email = ["mew3880@gmail.com"]
-
-  spec.summary = "ギターのスケールを生成するライブラリ"
-  # spec.description = "TODO: Write a longer description or delete this line."
-  spec.homepage = "https://github.com/Takahashi-Riki/tetsujin"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end