tonal-tools 8.5.1 → 8.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2692d9bde2f36dbc28cae1f8e0a892af38e901939ad2e93561442c5d12df67d
-  data.tar.gz: 5b10622098df90d28d52c99037cc0eda5e834eeba1e200d63bb75dcf70ed811f
+  metadata.gz: d35ccfb34bc36393de62b66954048131b48eff9a9aa0c3af8c9f5d97d79d8406
+  data.tar.gz: 16b2e4235caeaf796ddd7ceec8e6b881eb2291b4ec0f7f6389ac2faaca1fe243
 SHA512:
-  metadata.gz: 18eff7addd0dcc1cba4d9a59a7272853e1bba9a22c13cb727989214542e5705d69134dfb27e61f31d975e0b344226abc9758c5b1d3074285baf68854fc2c07d7
-  data.tar.gz: 74c467d127fbcbb1c56f43530a3b1d6cbd9b7b7d9fa1f52ad44a443d5a2aef28c43f90b8e187039c4d79a31d32284cc4056c4d766dc1216c6d8db686918e4406
+  metadata.gz: 6849510f855a326970cf7a7ad4ee619b05251b15331659192c4a7d1cf17a08eb64cdd55e70232300587f6f263cb906ddde329fba2d7923002b34f303f1ee4bd1
+  data.tar.gz: ab77a51fb2c82acf98fb1b65b1d33ace5baac0fbfc4c823140fb1a746995468f8cf3621824af17b07f0f099300dd7b4b244da4578711705e8a62f9d22c1976cd

data/lib/tonal/attributions.rb

@@ -1,4 +1,4 @@
 module Tonal
   TOOLS_PRODUCER = "mTonal"
-  TOOLS_VERSION = "8.5.1"
+  TOOLS_VERSION = "8.5.3"
 end

data/lib/tonal/step.rb

@@ -48,7 +48,15 @@ class Tonal::Scale
     def step_to_r
       Rational(step, modulo)
     end
-    alias :to_r :step_to_r
+
+    # @return [Tonal::Ratio] of the step/modulo
+    # @example
+    #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).step_to_ratio
+    #   => 18/31
+    #
+    def step_to_ratio
+      Tonal::Ratio.new(step, modulo)
+    end
 
     # @return [Rational] of the ratio
     # @example
@@ -59,15 +67,14 @@ class Tonal::Scale
       ratio.to_r
     end
 
-    # @return [Tonal::Cents] measure of step in cents
+    # @return [Tonal::Cents] measure of tempered in cents
     # @example
-    #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).step_to_cents
+    #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).tempered_to_cents
     #   => 696.77
     #
-    def step_to_cents
+    def tempered_to_cents
       tempered.to_cents
     end
-    alias :to_cents :step_to_cents
 
     # @return [Tonal::Cents] measure of ratio in cents
     # @example
@@ -78,13 +85,13 @@ class Tonal::Scale
       ratio.to_cents
     end
 
-    # @return [Tonal::Cents] the difference between the step and the ratio
+    # @return [Tonal::Cents] the difference between the tempered number and the ratio
     # @example
     #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).efficiency => 5.19 ¢
     #
     def efficiency
-      # We want the efficiency from the step (self). The step is the tempered approximation of the ratio, so we want to know how far off the step is from the ratio. So we take the ratio and subtract the step.
-      ratio_to_cents - step_to_cents
+      # We want the efficiency from the step (self). The tempered value is the tempered approximation of the ratio, so we want to know how far off the step is from the ratio. So we take the ratio and subtract the tempered value.
+      ratio_to_cents - tempered_to_cents
     end
     alias :cents_difference :efficiency
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tonal-tools
 version: !ruby/object:Gem::Version
-  version: 8.5.1
+  version: 8.5.3
 platform: ruby
 authors:
 - Jose Hales-Garcia