tonal-tools 0.2.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 618bd26c11332eb200cf9b9bf8bb38f7956b1bc084d07f693ebe41f203839ccf
-  data.tar.gz: 2de816e7bd17637d912c31ebda7b2f93fb717e89caefc804805e4b0a786cee90
+  metadata.gz: 496a1287b6645e141aae7b35adadb77a1a9add394a92921c69aa7d5fb2f69c95
+  data.tar.gz: 49c8251e9bbc99f352042d6184accb916d81c1b22a09a1d296268203e0f759df
 SHA512:
-  metadata.gz: c90617a5ecef6e01195e2e7d95f8d3588e068d119c5b4dbc602de97b5229086efc17e6de7a4e7c539d281693127d57225536bd259bcb435eeaba1e3646710f47
-  data.tar.gz: a64f852eab9bc77c7ccf5267a4b48999aa5860728191c8f13e67b0184de6b4766480a33415a82eadf3decfc07b9d804c49ad1c76c4b6fb82122a7b47454be903
+  metadata.gz: 998647702008bf98462b2e246a868649906348c083563c1e537ead89cccacb4fccf4f2125d3aad79137f1b37ae2b7e5371132fe720ad1e5013c5f638b1e6c4a9
+  data.tar.gz: 64faa5fb6347d5259fb803e7627a1469fa0d1ae154852ccaad11be9f33371f5ac73b0ea30de2a4eaf40d96699037ea4b519e2cfa9f1b8f845590d123449d6b75

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/cents.rb

@@ -68,7 +68,7 @@ class Tonal::Cents
   end
 
   # @return
-  #   [Cents] nearest hundredth cent difference
+  #   [Tonal::Cents] nearest hundredth cent difference
   # @example
   #   Tonal::Cents.new(701.9550008653874).nearest_hundredth_difference => 1.955000865387433
   #
@@ -76,7 +76,10 @@ class Tonal::Cents
     self.class.new(cents: (value - nearest_hundredth))
   end
 
-  # TODO: Document or Consider if needed
+  # @return [Array] a tuple of self offset positively/negatively by limit
+  # @example
+  #   Tonal::Cents.new(cents: 100.0).plus_minus
+  #   => [95.0, 105.0]
   #
   def plus_minus(limit = 5)
     [self - limit, self + limit]
@@ -133,11 +136,6 @@ class Tonal::Cents
     case result
     when Numeric
       self.class.new(cents: result)
-    # TODO: Work this case out or remove
-    #when Array
-    #  result.collect do |e|
-    #    e.kind_of?(Numeric) ? Cents.new(e) : e
-    #  end
     else
       result
     end

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/extensions.rb

@@ -11,7 +11,7 @@ class Prime
 end
 
 class Numeric
-  # @return [Array], a tuple of self offset positively/negatively
+  # @return [Array] a tuple of self offset positively/negatively
   # @example
   #   Math::PI.plus_minus(3)
   #     => [6.141592653589793, 0.14159265358979312]
@@ -74,7 +74,7 @@ class Numeric
 
   # @return [Tonal::Cents] of self interpreted as a ratio
   # @example
-  #   (3/2r).cents => 701.96
+  #   (3/2r).to_cents => 701.96
   #
   def to_cents
     self.log2.to_cents
@@ -371,8 +371,9 @@ class Array
   end
   alias :vector :to_vector
 
-  # @return [Integer] least common multiple of elements of self
-  # @example TODO
+  # @return [Integer] least common multiple of integer elements of self
+  # @example
+  #   [3, 2, 7].lcm => 42
   #
   def lcm
     self.reduce(1, :lcm)
@@ -414,11 +415,6 @@ class Array
   end
   alias :cents :to_cents
 
-  # TODO: Consider removing
-  #def cons_diff(cons=2)
-  #  self.each_cons(cons).map{|a,b| (a - b).abs }
-  #end
-
   # @return [Float] the mean of the elements of self
   # @example
   #   [1, 2].mean => 1.5

data/lib/tonal/log.rb

@@ -15,6 +15,8 @@ class Tonal::Log
   #
   def initialize(logarithmand: nil, logarithm: nil, base: nil)
     raise ArgumentError, "logarithmand or logarithm must be provided" if logarithmand.nil? && logarithm.nil?
+    raise ArgumentError, "logarithmand must be Numeric" unless logarithmand.kind_of?(Numeric) || logarithmand.nil?
+    raise ArgumentError, "logarithm must be Numeric" unless logarithm.kind_of?(Numeric) || logarithm.nil?
 
     if logarithmand && logarithm && base
       @logarithmand = logarithmand
@@ -97,8 +99,6 @@ class Tonal::Log
     end
   end
 
-  # TODO Explain how this works
-  #
   def method_missing(op, *args, &blk)
     rhs = args.collect do |arg|
       arg.kind_of?(self.class) ? arg.inspect : arg
@@ -108,11 +108,6 @@ class Tonal::Log
     case result
     when Numeric
       self.class.new(result)
-    # Work this case out
-    #when Array
-    #  result.collect do |e|
-    #    e.kind_of?(Numeric) ? Cents.new(e) : e
-    #  end
     else
       result
     end

data/lib/tonal/ratio.rb

@@ -147,7 +147,7 @@ class Tonal::Ratio
   # @param base
   #
   def to_log(base=2)
-    Tonal::Log.new(logarithmand: self, base: base)
+    Tonal::Log.new(logarithmand: to_r, base: base)
   end
   alias :log :to_log
 
@@ -156,7 +156,7 @@ class Tonal::Ratio
   #   Tonal::ReducedRatio.new(3,2).to_log2 => 0.5849625007211562
   #
   def to_log2
-    Tonal::Log2.new(logarithmand: self)
+    Tonal::Log2.new(logarithmand: to_r)
   end
   alias :log2 :to_log2
 
@@ -165,7 +165,7 @@ class Tonal::Ratio
   #   Tonal::Ratio.new(3,2).to_cents => 701.96
   #
   def to_cents
-    Tonal::Cents.new(ratio: self)
+    Tonal::Cents.new(ratio: to_r)
   end
   alias :cents :to_cents
 
@@ -255,16 +255,19 @@ class Tonal::Ratio
     self
   end
 
-  # @return [Tonal::ReducedRatio] the mirror of self along the axis (default 1/1)
+  # @return [Tonal::Ratio] the mirror of self along the axis (default 1/1)
   # @example
-  #   Tonal::ReducedRatio.new(4,3).mirror => (3/2)
+  #   Tonal::Ratio.new(4,3).mirror => (3/2)
   # @param axis
   #
   def mirror(axis=1/1r)
     (self.class.new(axis) ** 2) / self
   end
 
-  # TODO: Justify or remove
+  # @return [Tonal::Ratio]
+  # @example
+  #   Tonal::Ratio.new(4/3r).mirror2(4/2r) => (3/8)
+  # @param ratio
   #
   def mirror2(ratio)
     self.class.new(invert.to_r / ratio)
@@ -474,7 +477,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})"

data/lib/tonal/step.rb

@@ -36,7 +36,7 @@ class Tonal::Step
     ratio.to_r
   end
 
-  def cents
+  def to_cents
     ratio.to_cents
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tonal-tools
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Jose Hales-Garcia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-04 00:00:00.000000000 Z
+date: 2023-12-15 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
@@ -183,14 +183,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.2
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.1
 signing_key:
 specification_version: 4
 summary: Tonal tools