tonal-tools 0.2.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 618bd26c11332eb200cf9b9bf8bb38f7956b1bc084d07f693ebe41f203839ccf
-  data.tar.gz: 2de816e7bd17637d912c31ebda7b2f93fb717e89caefc804805e4b0a786cee90
+  metadata.gz: bc35954dbfa03dfe0acca0efda8508d06cffc3259fd7f9d959ff260e099c2de5
+  data.tar.gz: 1de6de9804f88b954ec67720e5b29a3de83a6c6d49577de5a679745b5f4491ab
 SHA512:
-  metadata.gz: c90617a5ecef6e01195e2e7d95f8d3588e068d119c5b4dbc602de97b5229086efc17e6de7a4e7c539d281693127d57225536bd259bcb435eeaba1e3646710f47
-  data.tar.gz: a64f852eab9bc77c7ccf5267a4b48999aa5860728191c8f13e67b0184de6b4766480a33415a82eadf3decfc07b9d804c49ad1c76c4b6fb82122a7b47454be903
+  metadata.gz: 4f9cd04eab65b20ddf0263910c661337c6a02d47ebabc5277eeaf7358e686f38283d1158ef985ee238625330b338acca9090021d22c10128d92955b3d5f59891
+  data.tar.gz: '0858ee0672ee37381878371622d7b46471341e56e7c85bceae5c447a3112199330d59931f5ba070fb5a82d6fd9e1e42d8f66838edb229707c9afbdadb13222cd'

data/lib/tonal/approximations.rb

@@ -30,7 +30,7 @@ class Tonal::Ratio
       self_in_cents = to_cents
       within = cents_tolerance.kind_of?(Tonal::Cents) ? cents_tolerance : Tonal::Cents.new(cents: cents_tolerance)
       [].tap do |results|
-        ContinuedFraction.new(antecedent.to_f/consequent, conv_limit).convergents_as_rationals.each do |convergent|
+        ContinuedFraction.new(antecedent.to_f/consequent, conv_limit).convergents.each do |convergent|
           ratio2 = ratio.class.new(convergent.numerator,convergent.denominator)
           results << ratio2 if ratio.class.within_cents?(self_in_cents, ratio2.to_cents, within) && ratio2.within_prime?(max_prime)
           break if results.length >= depth

data/lib/tonal/comma.rb

@@ -1,16 +1,44 @@
 class Tonal::Comma
+  # @return [Hash] of comma key/value pairs
+  # @example
+  #   Tonal::Comma.commas
+  #   => {"ditonic"=>"531441/524288",
+  #       "syntonic"=>"81/80",
+  #       "schisma"=>"32805/32768",
+  #       ...}
+  #
   def self.commas
     @commas ||= JSON.parse(YAML::load_file("#{__dir__}/../../data/commas.yml", aliases: true).to_json)["commas"]
   end
 
+  # @return [Array] of comma values
+  # @example
+  #   Tonal::Comma.values
+  #   => [(531441/524288),
+  #       (81/80),
+  #       (32805/32768),
+  #       ...]
+  #
   def self.values
     @values ||= commas.values.map(&:to_r)
   end
 
+  # @return [Array] of comma keys
+  # @example
+  #   Tonal::Comma.keys
+  #   => ["ditonic",
+  #       "syntonic",
+  #       "schisma",
+  #       ...]
+  #
   def self.keys
     @keys ||= commas.keys
   end
 
+  # @return [Rational] the comma found in the repo
+  # @example
+  #   Tonal::Comma.ditonic => (531441/524288)
+  #
   def self.method_missing(comma)
     commas[comma.to_s].to_r
   end

data/lib/tonal/ratio.rb

@@ -474,7 +474,7 @@ class Tonal::Ratio
 
   # @return [String] the string representation of Tonal::Ratio
   # @example
-  #   Tonal::Ratio.new(3, 2).inspect => "[3, 2]"
+  #   Tonal::Ratio.new(3, 2).inspect => "(3/2)"
   #
   def inspect
     "(#{antecedent}/#{consequent})"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tonal-tools
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Jose Hales-Garcia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-04 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaml
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: fraction-tree
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -188,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 requirements: []
 rubygems_version: 3.4.22
 signing_key: