stave 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 298ec095fbd8df1e9ee1f77db4708598d0fbb433a3d364810884787451dcec21
+  data.tar.gz: 1c89449bb41bdabb016ef555b0cc8962eb9d6cf99fe90f35e689632c326ff48a
+SHA512:
+  metadata.gz: 134a5a015273135682beec053a9985eb6f0084e972a516f26da08a221b3c16edee37c3d4ac1ec46c2ffedc4d7b77206ccd539b041a772214ca31ae295ead4c64
+  data.tar.gz: 3d7b9d994d481785c8625757caa253fd4ae2f70e1f9a24531758a7ed392bccbe24a10912069ed2fa2ef51f13be4bf22d09a7c93ad72e267ee487773547435140

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,71 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+Layout/LineLength:
+  Max: 80
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  AllowedMethods:
+    - change
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - spec/spec_helper.rb
+Lint/MissingSuper:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Style/ArgumentsForwarding:
+  Enabled: false
+Style/CharacterLiteral:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/ExplicitBlockArgument:
+  Enabled: false
+Style/FormatStringToken:
+  EnforcedStyle: template
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+RSpec/AnyInstance:
+  Enabled: false
+RSpec/ContextWording:
+  Prefixes:
+    - when
+    - with
+    - without
+    - if
+    - unless
+    - and
+    - but
+RSpec/DescribedClass:
+  SkipBlocks: true
+RSpec/ExpectChange:
+  EnforcedStyle: block
+RSpec/LetSetup:
+  Enabled: false
+RSpec/MultipleMemoizedHelpers:
+  Max: 15
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/SharedExamples:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Chris Welham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# Stave
+
+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/stave`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_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_IMMEDIATELY_AFTER_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_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/stave.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/stave/core/degree_collection.rb

@@ -0,0 +1,51 @@
+module Stave
+  module Core
+    class DegreeCollection < Lookup
+      # Set via the variants interface.
+      def degrees
+        raise NotImplementedError
+      end
+
+      def count
+        uniq.count
+      end
+
+      def intervals
+        degrees.map(&:interval)
+      end
+
+      def rotate(position)
+        return degrees if position == 1
+
+        uniq.rotate(position - 1).tap do |degrees|
+          degrees << degrees.first
+        end
+      end
+
+      def relative_rotate(position)
+        return degrees if position == 1
+
+        rotated_degrees = rotate(position)
+
+        rotated_degrees.map do |degree|
+          degree - rotated_degrees.first
+        end
+      end
+
+      def steps
+        intervals.each_cons(2).map { |pair| pair.reverse.reduce(:-) }
+      end
+
+      def uniq
+        degrees.uniq(&:position)
+      end
+
+      def self.class_key
+        to_s.delete_prefix("Stave::Theory::")
+            .gsub(/([a-z])([A-Z])/, "\\1_\\2")
+            .downcase
+            .to_sym
+      end
+    end
+  end
+end

data/lib/stave/core/lookup.rb

@@ -0,0 +1,110 @@
+module Stave
+  module Core
+    class Lookup
+      extend Forwardable
+
+      attr_reader :variant
+
+      def_delegators :variant, :to_s
+
+      def initialize(variant)
+        @variant = variant.to_sym
+
+        validate_variant!
+        set_attributes!
+      end
+
+      def ==(other)
+        case other
+        when String, Symbol then variant == other.to_sym
+        when Lookup then variant == other.variant
+        else false
+        end
+      end
+
+      alias eql? ==
+
+      class << self
+        def keys = variant_lookup.keys
+
+        def string_keys = keys.map(&:to_s)
+
+        def each_key(&)
+          keys.each(&)
+        end
+
+        def variant(name, prefix: nil, suffix: nil, **attributes)
+          name = :"#{prefix}_#{name}" if prefix
+          name = :"#{name}_#{suffix}" if suffix
+
+          variant_lookup[name] = attributes
+
+          define_singleton_method name, -> { new(name) }
+        end
+
+        def variant?(name)
+          variant_lookup.keys.include?(name)
+        end
+
+        def variants
+          variant_lookup.keys.map { |variant| new(variant) }
+        end
+
+        def variant_lookup
+          @variant_lookup ||= {}
+        end
+
+        def where(**attributes)
+          variants.select do |variant|
+            attributes.all? do |attribute, value|
+              variant.send(attribute) == value
+            end
+          end
+        end
+
+        def find_by(**attributes)
+          where(**attributes).first
+        end
+
+        def with_options(scope: nil, **options, &)
+          merger = OptionMerger.new(self, options)
+
+          merger.instance_eval(&)
+
+          return if scope.nil?
+
+          define_singleton_method scope, -> { where(**options) }
+        end
+      end
+
+      class InvalidVariantError < StandardError
+        def initialize(variant)
+          super("Variant :#{variant} is invalid")
+        end
+      end
+
+      private
+
+      def validate_variant!
+        return if self.class.variant?(variant)
+
+        raise InvalidVariantError, variant
+      end
+
+      def set_attributes!
+        self.class.variant_lookup[variant].each do |attribute, value|
+          set_attribute!(attribute, value)
+        end
+      end
+
+      def set_attribute!(name, value)
+        ivar_name = name.to_s.delete_suffix("?")
+        instance_variable_set(:"@#{ivar_name}", value)
+
+        self.class.define_method name do
+          instance_variable_get(:"@#{ivar_name}")
+        end
+      end
+    end
+  end
+end

data/lib/stave/core/note_collection.rb

@@ -0,0 +1,47 @@
+module Stave
+  module Core
+    class NoteCollection
+      attr_reader :root, :type
+
+      def initialize(root:, type:)
+        @root = root
+        @type = type
+      end
+
+      def notes
+        type.intervals.map { |interval| root + interval }
+      end
+
+      def note_at(position)
+        return if position.zero? || position.negative?
+
+        position -= 7 while position >= 8
+
+        notes[position - 1]
+      end
+
+      def uniq
+        notes.uniq(&:variant)
+      end
+
+      def to_h
+        {
+          self.class.type_class.class_key => { variant: type.variant },
+          root: root.variant
+        }
+      end
+
+      def self.type_class
+        const_get("#{self}Type")
+      end
+
+      def self.inherited(note_class)
+        note_class.type_class.variants.each do |type|
+          self.class.define_method(
+            :"#{type.variant}_from", ->(root) { new(type:, root:) }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stave/core/option_merger.rb

@@ -0,0 +1,25 @@
+module Stave
+  module Core
+    class OptionMerger
+      attr_reader :context, :options
+
+      def initialize(context, options)
+        @context = context
+        @options = options
+      end
+
+      private
+
+      def method_missing(method, *args, **kwargs, &)
+        kwargs ||= {}
+        kwargs = kwargs.merge(options) unless options.empty?
+
+        context.send(method, *args, **kwargs, &)
+      end
+
+      def respond_to_missing?(...)
+        context.respond_to?(...)
+      end
+    end
+  end
+end

data/lib/stave/core/scale_harmoniser.rb

@@ -0,0 +1,34 @@
+module Stave
+  module Core
+    class ScaleHarmoniser
+      attr_reader :scale_type, :chord_set
+
+      def initialize(scale_type:, chord_set:)
+        @scale_type = scale_type
+        @chord_set = chord_set
+      end
+
+      def harmonise!
+        scale_type.uniq.map do |degree|
+          Theory::ChordType.find_by(intervals: intervals(degree))
+        end
+      end
+
+      private
+
+      def scale_intervals(degree)
+        scale_type.rotate(degree.position)
+                  .each_slice(chord_set.slice_size)
+                  .map(&:first)
+                  .map(&:interval)
+                  .take(chord_set.note_count)
+      end
+
+      def intervals(degree)
+        intervals = scale_intervals(degree)
+
+        intervals.map { |interval| interval - intervals.first }
+      end
+    end
+  end
+end

data/lib/stave/theory/accidental.rb

@@ -0,0 +1,23 @@
+module Stave
+  module Theory
+    class Accidental < Core::Lookup
+      variant :double_flat,  transform: -2, symbol: "♭♭"
+      variant :flat,         transform: -1, symbol: "♭"
+      variant :natural,      transform: 0,  symbol: ""
+      variant :sharp,        transform: 1,  symbol: "♯"
+      variant :double_sharp, transform: 2,  symbol: "♯♯"
+
+      def flat?
+        transform.negative?
+      end
+
+      def natural?
+        transform.zero?
+      end
+
+      def sharp?
+        transform.positive?
+      end
+    end
+  end
+end

data/lib/stave/theory/chord.rb

@@ -0,0 +1,15 @@
+module Stave
+  module Theory
+    class Chord < Core::NoteCollection
+      def symbol
+        "#{root.symbol}#{type.symbol}"
+      end
+
+      def inversions
+        notes.drop(1).zip(type.inversion_types).map do |root, type|
+          ChordInversion.new(root:, type:)
+        end
+      end
+    end
+  end
+end

data/lib/stave/theory/chord_inversion.rb

@@ -0,0 +1,15 @@
+module Stave
+  module Theory
+    class ChordInversion < Chord
+      def symbol
+        "#{root_chord.symbol}#{type.symbol}"
+      end
+
+      def root_chord
+        root = notes[type.root_position]
+
+        Chord.new(root:, type: type.chord_type)
+      end
+    end
+  end
+end

data/lib/stave/theory/chord_inversion_type.rb

@@ -0,0 +1,32 @@
+module Stave
+  module Theory
+    class ChordInversionType < Core::DegreeCollection
+      ChordType.triads.each do |chord_type|
+        with_options chord_type:, suffix: chord_type.variant do
+          variant :first_inversion, inversion: 1
+          variant :second_inversion, inversion: 2
+        end
+      end
+
+      ChordType.sevenths.each do |chord_type|
+        with_options chord_type:, suffix: chord_type.variant do
+          variant :first_inversion, inversion: 1
+          variant :second_inversion, inversion: 2
+          variant :third_inversion, inversion: 3
+        end
+      end
+
+      def position = inversion + 1
+
+      def root_position = degrees.count - inversion
+
+      def degrees
+        chord_type.relative_rotate(position).uniq(&:variant)
+      end
+
+      def symbol
+        "(#{'i' * inversion})"
+      end
+    end
+  end
+end

data/lib/stave/theory/chord_type.rb

@@ -0,0 +1,70 @@
+module Stave
+  module Theory
+    class ChordType < Core::DegreeCollection
+      class Set < Core::Lookup
+        with_options slice_size: 2 do
+          variant :triad, note_count: 3
+          variant :seventh, note_count: 4
+        end
+      end
+
+      with_options set: Set.triad, scope: :triads do
+        variant :major_triad, symbol: "", degrees: [
+          Degree.root,
+          Degree.three,
+          Degree.five
+        ]
+
+        variant :minor_triad, symbol: "m", degrees: [
+          Degree.root,
+          Degree.flat_three,
+          Degree.five
+        ]
+
+        variant :diminished_triad, symbol: "o", degrees: [
+          Degree.root,
+          Degree.flat_three,
+          Degree.flat_five
+        ]
+      end
+
+      with_options set: Set.seventh, scope: :sevenths do
+        variant :major_seventh, symbol: "∆7", degrees: [
+          Degree.root,
+          Degree.three,
+          Degree.five,
+          Degree.seven
+        ]
+
+        variant :dominant_seventh, symbol: "7", degrees: [
+          Degree.root,
+          Degree.three,
+          Degree.five,
+          Degree.flat_seven
+        ]
+
+        variant :minor_seventh, symbol: "m7", degrees: [
+          Degree.root,
+          Degree.flat_three,
+          Degree.five,
+          Degree.flat_seven
+        ]
+
+        variant :half_diminished_seventh, symbol: "ø7", degrees: [
+          Degree.root,
+          Degree.flat_three,
+          Degree.flat_five,
+          Degree.flat_seven
+        ]
+      end
+
+      def note_count
+        set.note_count
+      end
+
+      def inversion_types
+        ChordInversionType.where(chord_type: self)
+      end
+    end
+  end
+end

data/lib/stave/theory/circle.rb

@@ -0,0 +1,22 @@
+module Stave
+  module Theory
+    class Circle
+      attr_reader :type, :root
+
+      def initialize(type:, root:)
+        @type = type
+        @root = root
+      end
+
+      def notes
+        7.times.inject([root]) do |notes, _|
+          notes + [notes.last + type.step]
+        end
+      end
+
+      def key_signatures
+        notes.map { |root| Scale.major_from(root).key_signature }
+      end
+    end
+  end
+end

data/lib/stave/theory/circle_type.rb

@@ -0,0 +1,8 @@
+module Stave
+  module Theory
+    class CircleType < Core::Lookup
+      variant :fourths, step: Interval.perfect_fourth
+      variant :fifths, step: Interval.perfect_fifth
+    end
+  end
+end