head_music 9.0.1 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 012ce64dd4174cbeec42f1d4825e9fd10af79ed8f4b83a3beedbc14a9aea34fa
-  data.tar.gz: a31dbb0b6b3d732bd41e1dbfe6a042a8395db05832d58848ec4d53e5ae4a4524
+  metadata.gz: c3abf9e12840eb88aee1cb454116cbd092f224eb1961cfda5567444ad9e91d2f
+  data.tar.gz: e7680154e971414788fc8bd1a87f53111bc82c9452f4df5a8ad47a74b1c5c16d
 SHA512:
-  metadata.gz: a98367425dcfb4899b24ef2e7986a7fbc594202c960b553ab35d3cecd5ee0b5ecb10f65e1e458fe2d1797b70eded378fd319b2cbfc7b9a5a2e393773ce75f06b
-  data.tar.gz: d3baf95b28de6c2df0e3d14250ed9c335cb3793d598eb7cf1c417dd40b6463bb57ddcda19be309a1045e835809ad3b9ad45dc0fd21797563319069da35db76bc
+  metadata.gz: 199c8cdba49e5d6e15e7047a8bb8ee28eaa5c8087c9f427916d087d4ce8986f04cf7dd354666247b389836256230d5c3535ff5fd79964443626e397c0cdb3288
+  data.tar.gz: d793d6730a790b088fcc7906bc6cb02b865364852767534c15c1b76b40622ae6a12b23a2bde5f651687e9ce124941501ae8d1f17f9a63a7c8c473a2112914024

data/.github/workflows/ci.yml

@@ -12,7 +12,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['3.3.0', '3.3', '3.4']
+        ruby-version: ['3.3', '3.4']
+        activesupport-version: ['7.2', '8.0']
 
     steps:
     - uses: actions/checkout@v4
@@ -21,13 +22,18 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems
+        bundler-cache: false
+
+    - name: Install dependencies with ActiveSupport ${{ matrix.activesupport-version }}
+      run: |
+        bundle config set --local path vendor/bundle
+        ACTIVESUPPORT_VERSION="${{ matrix.activesupport-version }}" bundle install
 
     - name: Run tests
       run: bundle exec rspec
 
     - name: Upload coverage to Codecov
-      if: matrix.ruby-version == '3.3.0'
+      if: matrix.ruby-version == '3.3' && matrix.activesupport-version == '8.0'
       uses: codecov/codecov-action@v5
       with:
         token: ${{ secrets.CODECOV_TOKEN }}

data/CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [11.0.0] - 2026-01-05
+
+### Changed
+- **BREAKING**: Widened ActiveSupport dependency from `~> 7.0` to `>= 7.0, < 10` to support Rails 8.x
+- Improved I18n initialization to be non-destructive:
+  - No longer overwrites `I18n.default_locale` (allows Rails apps to control their default)
+  - Adds HeadMusic locales to `available_locales` instead of replacing them
+  - Only sets fallbacks if not already configured by the application
+- Updated CI workflow to test against both ActiveSupport 7.x and 8.x
+
+### Fixed
+- Fixed compatibility issue with Rails 8.1.x applications
+
+## [10.0.0] - 2025-12-01
+
+### Changed
+- Internal release for testing
+
 ## [9.0.0] - 2025-10-24
 
 ### Added

data/CLAUDE.md

@@ -43,7 +43,7 @@ bundle exec rake doc_stats
 
 ### Git Etiquette
 
-Do not make a commit unless I ask you to.
+**IMPORTANT: Do not make a commit unless I explicitly ask you to.** Wait for explicit instruction before running `git commit`.
 
 When composing git commit messages, follow best-practices. However, do not mention yourself (claude) or list yourself as a co-author.
 
@@ -72,22 +72,35 @@ Tests are written in RSpec and located in the `/spec` directory, mirroring the `
 The codebase follows a domain-driven design with clear module boundaries:
 
 1. **HeadMusic::Rudiment** - Core music theory elements
-  - Pitch, Note, Scale, Key, Interval, Chord
+  - Abstract concepts: pitch, interval, scale, chord, key
+  - Duration concepts (without visual representation)
   - Factory methods: `.get()` for most rudiments
 
-2. **HeadMusic::Analysis** - Musical analysis tools
-  - Intervals, Chords, Motion analysis
-  - Harmonic and melodic analysis
-
-3. **HeadMusic::Content** - Musical composition representation
-  - Composition, Voice, Note, Rest
-  - Rhythmic values and time signatures
+2. **HeadMusic::Notation** - Visual music notation and representation
+  - Staff positions, lines, spaces, ledger lines
+  - Musical symbols (ASCII, Unicode, HTML entities)
+  - Clef placement and rendering
+  - Notehead shapes, stems, flags, beams
+  - Accidental placement rules
+  - Future: ties, slurs, articulations, dynamics
 
-4. **HeadMusic::Instruments** - Instrument definitions
-  - Instrument families and properties
+3. **HeadMusic::Instruments** - Instrument definitions
+  - Instrument families and classification
   - Pitch ranges and transposition
+  - Playing techniques
+  - Score ordering
+
+4. **HeadMusic::Content** - Musical composition representation
+  - Compositions, voices, bars, positions
+  - Notes in context (pitch + duration + placement)
+  - Temporal organization
+
+5. **HeadMusic::Analysis** - Musical analysis tools
+  - Intervals, chords, motion analysis
+  - Harmonic and melodic analysis
+  - Pitch class sets and collections
 
-5. **HeadMusic::Style** - Composition rules and guidelines
+6. **HeadMusic::Style** - Composition rules and guidelines
   - Counterpoint rules
   - Voice leading guidelines
   - Style analysis
@@ -121,11 +134,19 @@ The gem supports multiple languages through the HeadMusic::Named mixin:
 - Shared examples in `spec/support/`
 - `composition_context.rb` provides test utilities
 
+### Documentation Philosophy
+
+This project deliberately deprioritizes formal documentation in favor of clear, comprehensive tests.
+
+- **Tests serve as documentation**: RSpec specs demonstrate how to use the code
+- **Comments explain "why", not "what"**: Only add comments when the implementation is surprising or non-obvious
+- **No YARD documentation required**: The code should be self-explanatory through clear naming and test examples
+- Documentation tools like `rake doc` and `rake doc_stats` exist but low coverage is intentional
+
 ### Code Style
 
 - Ruby 3.3.0+ features are allowed
 - Follow Standard Ruby style guide
-- Use YARD documentation format for public methods
 - Prefer delegation over inheritance
 - Always run `bundle exec rubocop -a` after editing ruby code
 
@@ -143,8 +164,7 @@ The gem supports multiple languages through the HeadMusic::Named mixin:
 
 1. Check for dependent classes that might be affected
 2. Run tests for the specific module: `bundle exec rspec spec/head_music/[module_name]`
-3. Update documentation with YARD comments
-4. Ensure translations are updated if names change
+3. Ensure translations are updated if names change
 
 ## Music theory and concepts
 

data/Gemfile

@@ -1,10 +1,15 @@
 source "https://rubygems.org"
 
-ruby "3.3.0"
+ruby ">= 3.3.0"
 
 # Specify your gem's dependencies in head_music.gemspec
 gemspec
 
+# Allow CI to test against specific ActiveSupport versions
+if ENV["ACTIVESUPPORT_VERSION"]
+  gem "activesupport", "~> #{ENV["ACTIVESUPPORT_VERSION"]}.0"
+end
+
 gem "standard", require: false
 
 group :test do
@@ -16,6 +21,7 @@ end
 
 group :development do
   gem "bundler-audit", require: false
+  gem "rubycritic", require: false
   gem "yard", require: false
   gem "kramdown", require: false
 end

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    head_music (9.0.0)
-      activesupport (~> 7.0)
+    head_music (11.0.0)
+      activesupport (>= 7.0, < 10)
       humanize (~> 2.0)
       i18n (~> 1.8)
 
@@ -21,25 +21,81 @@ GEM
       minitest (>= 5.1)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.3)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
     base64 (0.3.0)
     benchmark (0.4.1)
     bigdecimal (3.2.2)
     bundler-audit (0.9.2)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
+    childprocess (5.1.0)
+      logger (~> 1.5)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
     concurrent-ruby (1.3.5)
     connection_pool (2.5.3)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.6.2)
     docile (1.4.1)
     drb (2.2.3)
+    dry-configurable (1.3.0)
+      dry-core (~> 1.1)
+      zeitwerk (~> 2.6)
+    dry-core (1.1.0)
+      concurrent-ruby (~> 1.0)
+      logger
+      zeitwerk (~> 2.6)
+    dry-inflector (1.2.0)
+    dry-initializer (3.2.0)
+    dry-logic (1.6.0)
+      bigdecimal
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.1)
+      zeitwerk (~> 2.6)
+    dry-schema (1.14.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      dry-core (~> 1.1)
+      dry-initializer (~> 3.2)
+      dry-logic (~> 1.5)
+      dry-types (~> 1.8)
+      zeitwerk (~> 2.6)
+    dry-types (1.8.3)
+      bigdecimal (~> 3.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    erubi (1.13.1)
+    flay (2.13.3)
+      erubi (~> 1.10)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.8.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
     humanize (2.5.1)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
     json (2.13.1)
     kramdown (2.5.1)
       rexml (>= 3.3.9)
     language_server-protocol (3.17.0.5)
+    launchy (3.1.1)
+      addressable (~> 2.8)
+      childprocess (~> 5.0)
+      logger (~> 1.6)
     lint_roller (1.1.0)
     logger (1.7.0)
     minitest (5.25.5)
@@ -47,12 +103,20 @@ GEM
     parser (3.3.9.0)
       ast (~> 2.4.1)
       racc
+    path_expander (1.1.3)
     prism (1.4.0)
+    public_suffix (6.0.2)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.3.0)
+    reek (6.5.0)
+      dry-schema (~> 1.13)
+      logger (~> 1.6)
+      parser (~> 3.3.0)
+      rainbow (>= 2.0, < 4.0)
+      rexml (~> 3.1)
     regexp_parser (2.10.0)
-    rexml (3.4.1)
+    rexml (3.4.4)
     rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -94,7 +158,23 @@ GEM
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
     ruby-progressbar (1.13.0)
+    ruby_parser (3.21.1)
+      racc (~> 1.5)
+      sexp_processor (~> 4.16)
+    rubycritic (4.11.0)
+      flay (~> 2.13)
+      flog (~> 4.7)
+      launchy (>= 2.5.2)
+      parser (>= 3.3.0.5)
+      rainbow (~> 3.1.1)
+      reek (~> 6.5.0, < 7.0)
+      rexml
+      ruby_parser (~> 3.21)
+      simplecov (>= 0.22.0)
+      tty-which (~> 0.5.0)
+      virtus (~> 2.0)
     securerandom (0.4.1)
+    sexp_processor (4.17.4)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -114,12 +194,19 @@ GEM
       lint_roller (~> 1.1)
       rubocop-performance (~> 1.25.0)
     thor (1.4.0)
+    thread_safe (0.3.6)
+    tty-which (0.5.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
+    virtus (2.0.0)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
     yard (0.9.37)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   arm64-darwin-22
@@ -136,6 +223,7 @@ DEPENDENCIES
   rubocop
   rubocop-rake
   rubocop-rspec
+  rubycritic
   simplecov
   standard
   yard

data/README.md

@@ -101,6 +101,24 @@ bundle exec rake doc
 - `rake doc_stats` - Show documentation coverage statistics
 - `rake coverage` - Open coverage report in browser
 
+### Releasing a New Version
+
+1. Update the version number in `lib/head_music/version.rb`
+2. Commit the version change: `git commit -am "Bump version to X.Y.Z"`
+3. Push to main: `git push origin main`
+4. Release the gem:
+
+```bash
+bundle exec rake release
+```
+
+This will:
+- Build the gem
+- Create and push a git tag (e.g., `vX.Y.Z`)
+- Push the gem to RubyGems
+
+The git tag push also triggers a GitHub Actions workflow that creates a GitHub Release with auto-generated release notes.
+
 ## Contributing
 
 We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.

data/Rakefile

@@ -26,10 +26,15 @@ rescue LoadError
   # bundler-audit not available
 end
 
+desc "Run RubyCritic code quality analysis"
+task :rubycritic do
+  sh "rubycritic lib"
+end
+
 task default: :spec
 
-desc "Run all quality checks (tests, linting, security audit)"
-task quality: [:spec, :standard, "bundle:audit:check"]
+desc "Run all quality checks (tests, linting, security audit, code quality)"
+task quality: [:spec, :standard, "bundle:audit:check", :rubycritic]
 
 desc "Open an irb session preloaded with this library"
 task :console do

data/head_music.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 3.3.0"
 
-  spec.add_runtime_dependency "activesupport", "~> 7.0"
+  spec.add_runtime_dependency "activesupport", ">= 7.0", "< 10"
   spec.add_runtime_dependency "humanize", "~> 2.0"
   spec.add_runtime_dependency "i18n", "~> 1.8"
 

data/lib/head_music/analysis/dyad.rb

@@ -0,0 +1,229 @@
+# A module for musical analysis
+module HeadMusic::Analysis; end
+
+# A Dyad is a two-pitch combination that can imply various chords.
+# It analyzes the harmonic implications of two pitches sounding together.
+class HeadMusic::Analysis::Dyad
+  attr_reader :pitch1, :pitch2, :key
+
+  def initialize(pitch1, pitch2, key: nil)
+    @pitch1, @pitch2 = [
+      HeadMusic::Rudiment::Pitch.get(pitch1),
+      HeadMusic::Rudiment::Pitch.get(pitch2)
+    ].sort
+    @key = key ? HeadMusic::Rudiment::Key.get(key) : nil
+  end
+
+  def interval
+    @interval ||= HeadMusic::Analysis::DiatonicInterval.new(lower_pitch, upper_pitch)
+  end
+
+  def pitches
+    [pitch1, pitch2]
+  end
+
+  def lower_pitch
+    @lower_pitch ||= [pitch1, pitch2].min
+  end
+
+  def upper_pitch
+    @upper_pitch ||= [pitch1, pitch2].max
+  end
+
+  def possible_trichords
+    @possible_trichords ||= begin
+      trichords = generate_possible_trichords
+      trichords = filter_by_key(trichords) if key
+      sort_by_diatonic_agreement(trichords)
+    end
+  end
+
+  def possible_triads
+    @possible_triads ||= possible_trichords.select(&:triad?)
+  end
+
+  def possible_seventh_chords
+    @possible_seventh_chords ||= begin
+      seventh_chords = generate_possible_seventh_chords
+      seventh_chords = filter_by_key(seventh_chords) if key
+      sort_by_diatonic_agreement(seventh_chords)
+    end
+  end
+
+  def enharmonic_respellings
+    @enharmonic_respellings ||= generate_enharmonic_respellings
+  end
+
+  def to_s
+    "#{pitch1} - #{pitch2}"
+  end
+
+  def method_missing(method_name, *args, &block)
+    respond_to_missing?(method_name) ? interval.send(method_name, *args, &block) : super
+  end
+
+  def respond_to_missing?(method_name, *_args)
+    interval.respond_to?(method_name)
+  end
+
+  private
+
+  def generate_possible_trichords
+    trichords = []
+    pitch_classes = [lower_pitch.pitch_class, upper_pitch.pitch_class]
+
+    HeadMusic::Rudiment::Spelling::CHROMATIC_SPELLINGS.each do |root_spelling|
+      root_pitch = HeadMusic::Rudiment::Pitch.get("#{root_spelling}4")
+
+      # Try all common trichord types from this root
+      trichord_intervals = [
+        %w[M3 P5],   # major triad
+        %w[m3 P5],   # minor triad
+        %w[m3 d5],   # diminished triad
+        %w[M3 A5],   # augmented triad
+        %w[P4 P5],   # sus4 (not a triad)
+        %w[M2 P5]    # sus2 (not a triad)
+      ]
+
+      trichord_intervals.each do |intervals|
+        trichord_pitches = [root_pitch]
+
+        # Each interval is FROM THE ROOT, not consecutive
+        intervals.each do |interval_name|
+          interval = HeadMusic::Analysis::DiatonicInterval.get(interval_name)
+          next_pitch = interval.above(root_pitch)
+          trichord_pitches << next_pitch
+        end
+
+        pitch_collection = HeadMusic::Analysis::PitchCollection.new(trichord_pitches)
+        trichord_pitch_classes = pitch_collection.pitch_classes
+
+        # Check if this trichord contains both pitches from our dyad
+        if pitch_classes.all? { |pc| trichord_pitch_classes.include?(pc) }
+          trichords << pitch_collection
+        end
+      end
+    end
+
+    trichords.uniq { |t| t.pitch_classes.sort.map(&:to_i) }
+  end
+
+  def generate_possible_seventh_chords
+    seventh_chords = []
+    pitch_classes = [lower_pitch.pitch_class, upper_pitch.pitch_class]
+
+    HeadMusic::Rudiment::Spelling::CHROMATIC_SPELLINGS.each do |root_spelling|
+      root_pitch = HeadMusic::Rudiment::Pitch.get("#{root_spelling}4")
+
+      # Try all common seventh chord types from this root
+      seventh_chord_intervals = [
+        %w[M3 P5 M7],   # major seventh
+        %w[M3 P5 m7],   # dominant seventh (major-minor)
+        %w[m3 P5 m7],   # minor seventh
+        %w[m3 P5 M7],   # minor-major seventh
+        %w[m3 d5 m7],   # half-diminished seventh
+        %w[m3 d5 d7],   # diminished seventh
+        %w[M2 M3 P5 m7], # dominant ninth
+        %w[m2 M3 P5 m7], # dominant minor ninth
+        %w[M2 m3 P5 m7], # minor ninth
+        %w[M2 M3 P5 M7]  # major ninth
+      ]
+
+      seventh_chord_intervals.each do |intervals|
+        chord_pitches = [root_pitch]
+
+        # Each interval is FROM THE ROOT, not consecutive
+        intervals.each do |interval_name|
+          interval = HeadMusic::Analysis::DiatonicInterval.get(interval_name)
+          next_pitch = interval.above(root_pitch)
+          chord_pitches << next_pitch
+        end
+
+        pitch_collection = HeadMusic::Analysis::PitchCollection.new(chord_pitches)
+        chord_pitch_classes = pitch_collection.pitch_classes
+
+        # Check if this chord contains both pitches from our dyad
+        if pitch_classes.all? { |pc| chord_pitch_classes.include?(pc) }
+          seventh_chords << pitch_collection
+        end
+      end
+    end
+
+    seventh_chords.uniq { |c| c.pitch_classes.sort.map(&:to_i) }
+  end
+
+  def filter_by_key(pitch_collections)
+    return pitch_collections unless key
+
+    diatonic_spellings = key.scale.spellings
+
+    pitch_collections.select do |pitch_collection|
+      pitch_collection.pitches.all? { |pitch| diatonic_spellings.include?(pitch.spelling) }
+    end
+  end
+
+  def sort_by_diatonic_agreement(pitch_collections)
+    return pitch_collections unless key
+
+    diatonic_spellings = key.scale.spellings
+
+    pitch_collections.sort_by do |pitch_collection|
+      # Count how many pitches match diatonic spellings (lower is better for sort)
+      diatonic_count = pitch_collection.pitches.count { |pitch| diatonic_spellings.include?(pitch.spelling) }
+      -diatonic_count # Negative so higher counts come first
+    end
+  end
+
+  def generate_enharmonic_respellings
+    respellings = []
+
+    # Get enharmonic equivalents for each pitch
+    pitch1_equivalents = get_enharmonic_equivalents(pitch1)
+    pitch2_equivalents = get_enharmonic_equivalents(pitch2)
+
+    # Generate all combinations
+    pitch1_equivalents.each do |p1|
+      pitch2_equivalents.each do |p2|
+        # Skip the original combination
+        next if p1.spelling == pitch1.spelling && p2.spelling == pitch2.spelling
+
+        # Create new dyad with same key context
+        respellings << self.class.new(p1, p2, key: key)
+      end
+    end
+
+    respellings
+  end
+
+  def get_enharmonic_equivalents(pitch)
+    equivalents = [pitch]
+
+    # Get common enharmonic spellings
+    pitch_class = pitch.pitch_class
+    letter_names = HeadMusic::Rudiment::LetterName.all
+
+    letter_names.each do |letter_name|
+      [-2, -1, 0, 1, 2].each do |alteration_semitones|
+        spelling = HeadMusic::Rudiment::Spelling.get("#{letter_name}#{alteration_sign(alteration_semitones)}")
+        next unless spelling
+
+        if spelling.pitch_class == pitch_class
+          equivalent_pitch = HeadMusic::Rudiment::Pitch.fetch_or_create(spelling, pitch.register)
+          equivalents << equivalent_pitch unless equivalents.any? { |p| p.spelling == spelling }
+        end
+      end
+    end
+
+    equivalents
+  end
+
+  def alteration_sign(semitones)
+    case semitones
+    when -2 then "bb"
+    when -1 then "b"
+    when 0 then ""
+    when 1 then "#"
+    when 2 then "##"
+    end
+  end
+end

data/lib/head_music/analysis/melodic_interval.rb

@@ -62,7 +62,7 @@ class HeadMusic::Analysis::MelodicInterval
     combined_pitches = (pitches + other_interval.pitches).uniq
     return false if combined_pitches.length < 3
 
-    HeadMusic::Analysis::PitchSet.new(combined_pitches).consonant_triad?
+    HeadMusic::Analysis::PitchCollection.new(combined_pitches).consonant_triad?
   end
 
   def method_missing(method_name, *args, &block)