head_music 8.1.0 → 8.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bf272cf25921ce289e80bbbfbb8566178b541ce8cdc4711feb269cb7863f0dd7
4
- data.tar.gz: 35d4beef32b86a25376136dbaae5f2749ca13b22e2d359a6e83297fadfb6fca0
3
+ metadata.gz: 416b7cd967ad8295f84cc17ee87c66fbc1eda60a66b8987a4cbeaf7ee3165ead
4
+ data.tar.gz: 8aca723bdede512365429a9eb3e5904bbab4473e40674a39d57c3977e73e9ffb
5
5
  SHA512:
6
- metadata.gz: 169bdae2dc9223bee17d1dc5cb67baa2b3ea9c80a6a83df055e0ed1707b57ab14834b6193c8c2a03cb317532f243ea2f805a1be981987c5885ca88e08c725c73
7
- data.tar.gz: 5bea0f2ff5883d4fd8b6d37bdcf1ea49d19469eb23b5da3f733e57524dbbb6299027f9a287b5e2d291f7813429088ba409d0fd045c80da66f482ab49d94ef472
6
+ metadata.gz: 3769150439e444f72ab9fd98b567171fb1627badf985daa32fb82aa97abbe2e0b4ef39d1052baf3dc1d890d12a86e98e6767e7e9216f110768fe5c37b47ab5f1
7
+ data.tar.gz: 9371fe711f5b1533722571e4159306eab475f404d79f835b2ee1f9afbcb7a6bde95c7d516bdbf7d274ba846ce70b0d261f6de416534e1217df691ee4dcfcdc0b
@@ -0,0 +1,31 @@
1
+ ---
2
+ name: Bug report
3
+ about: Create a report to help us improve
4
+ title: ''
5
+ labels: bug
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Describe the bug**
11
+ A clear and concise description of what the bug is.
12
+
13
+ **To Reproduce**
14
+ Steps to reproduce the behavior:
15
+ ```ruby
16
+ # Example code that demonstrates the issue
17
+ ```
18
+
19
+ **Expected behavior**
20
+ A clear and concise description of what you expected to happen.
21
+
22
+ **Actual behavior**
23
+ What actually happened instead.
24
+
25
+ **Environment:**
26
+ - Ruby version: [e.g. 3.3.0]
27
+ - head_music version: [e.g. 8.1.1]
28
+ - OS: [e.g. macOS 14.0]
29
+
30
+ **Additional context**
31
+ Add any other context about the problem here.
@@ -0,0 +1,25 @@
1
+ ---
2
+ name: Feature request
3
+ about: Suggest an idea for this project
4
+ title: ''
5
+ labels: enhancement
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Is your feature request related to a problem? Please describe.**
11
+ A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12
+
13
+ **Describe the solution you'd like**
14
+ A clear and concise description of what you want to happen.
15
+
16
+ **Describe alternatives you've considered**
17
+ A clear and concise description of any alternative solutions or features you've considered.
18
+
19
+ **Example usage**
20
+ ```ruby
21
+ # Show how the feature would be used
22
+ ```
23
+
24
+ **Additional context**
25
+ Add any other context or screenshots about the feature request here.
@@ -0,0 +1,59 @@
1
+ version: 2
2
+ updates:
3
+ # Enable version updates for Bundler (Ruby dependencies)
4
+ - package-ecosystem: "bundler"
5
+ directory: "/"
6
+ schedule:
7
+ interval: "weekly"
8
+ day: "monday"
9
+ time: "09:00"
10
+ timezone: "America/Los_Angeles"
11
+ open-pull-requests-limit: 5
12
+ reviewers:
13
+ - "roberthead"
14
+ assignees:
15
+ - "roberthead"
16
+ commit-message:
17
+ prefix: "deps"
18
+ prefix-development: "deps-dev"
19
+ include: "scope"
20
+ labels:
21
+ - "dependencies"
22
+ # Group minor and patch updates together to reduce noise
23
+ groups:
24
+ minor-and-patch:
25
+ patterns:
26
+ - "*"
27
+ update-types:
28
+ - "minor"
29
+ - "patch"
30
+ # Allow both direct and indirect dependencies
31
+ allow:
32
+ - dependency-type: "direct"
33
+ - dependency-type: "indirect"
34
+ # Ignore major version updates for stable dependencies
35
+ ignore:
36
+ - dependency-name: "activesupport"
37
+ update-types: ["version-update:semver-major"]
38
+ - dependency-name: "i18n"
39
+ update-types: ["version-update:semver-major"]
40
+
41
+ # Enable version updates for GitHub Actions
42
+ - package-ecosystem: "github-actions"
43
+ directory: "/"
44
+ schedule:
45
+ interval: "weekly"
46
+ day: "monday"
47
+ time: "09:00"
48
+ timezone: "America/Los_Angeles"
49
+ open-pull-requests-limit: 3
50
+ reviewers:
51
+ - "roberthead"
52
+ assignees:
53
+ - "roberthead"
54
+ commit-message:
55
+ prefix: "ci"
56
+ include: "scope"
57
+ labels:
58
+ - "ci"
59
+ - "dependencies"
@@ -0,0 +1,26 @@
1
+ ## Description
2
+ <!-- Describe your changes in detail -->
3
+
4
+ ## Type of Change
5
+ <!-- Mark relevant options with an "x" -->
6
+
7
+ - [ ] Bug fix (non-breaking change which fixes an issue)
8
+ - [ ] New feature (non-breaking change which adds functionality)
9
+ - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
10
+ - [ ] Documentation update
11
+
12
+ ## Testing
13
+ <!-- Describe the tests you ran to verify your changes -->
14
+
15
+ - [ ] All tests pass locally with `bundle exec rspec`
16
+ - [ ] Code follows style guidelines (`bundle exec rubocop` passes)
17
+ - [ ] I have added tests that prove my fix is effective or that my feature works
18
+ - [ ] New and existing unit tests pass locally with my changes
19
+
20
+ ## Checklist
21
+
22
+ - [ ] My code follows the style guidelines of this project
23
+ - [ ] I have performed a self-review of my own code
24
+ - [ ] I have commented my code, particularly in hard-to-understand areas
25
+ - [ ] I have made corresponding changes to the documentation
26
+ - [ ] My changes generate no new warnings
@@ -0,0 +1,68 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [ main ]
6
+ pull_request:
7
+ branches: [ main ]
8
+
9
+ jobs:
10
+ test:
11
+ runs-on: ubuntu-latest
12
+ strategy:
13
+ fail-fast: false
14
+ matrix:
15
+ ruby-version: ['3.3.0', '3.3', '3.4']
16
+
17
+ steps:
18
+ - uses: actions/checkout@v4
19
+
20
+ - name: Set up Ruby ${{ matrix.ruby-version }}
21
+ uses: ruby/setup-ruby@v1
22
+ with:
23
+ ruby-version: ${{ matrix.ruby-version }}
24
+ bundler-cache: true # runs 'bundle install' and caches installed gems
25
+
26
+ - name: Run tests
27
+ run: bundle exec rspec
28
+
29
+ - name: Upload coverage to Codecov
30
+ if: matrix.ruby-version == '3.3.0'
31
+ uses: codecov/codecov-action@v4
32
+ with:
33
+ token: ${{ secrets.CODECOV_TOKEN }}
34
+ fail_ci_if_error: false
35
+ verbose: true
36
+
37
+ lint:
38
+ runs-on: ubuntu-latest
39
+ steps:
40
+ - uses: actions/checkout@v4
41
+
42
+ - name: Set up Ruby
43
+ uses: ruby/setup-ruby@v1
44
+ with:
45
+ ruby-version: '3.3.0'
46
+ bundler-cache: true
47
+
48
+ - name: Run RuboCop
49
+ run: bundle exec rubocop
50
+
51
+ build:
52
+ runs-on: ubuntu-latest
53
+ steps:
54
+ - uses: actions/checkout@v4
55
+
56
+ - name: Set up Ruby
57
+ uses: ruby/setup-ruby@v1
58
+ with:
59
+ ruby-version: '3.3.0'
60
+ bundler-cache: true
61
+
62
+ - name: Build gem
63
+ run: gem build *.gemspec
64
+
65
+ - name: Check gem
66
+ run: |
67
+ gem install *.gem
68
+ gem specification *.gem
@@ -0,0 +1,49 @@
1
+ name: Release
2
+
3
+ on:
4
+ push:
5
+ tags:
6
+ - 'v*'
7
+
8
+ jobs:
9
+ release:
10
+ runs-on: ubuntu-latest
11
+ permissions:
12
+ contents: write
13
+ id-token: write
14
+
15
+ steps:
16
+ - uses: actions/checkout@v4
17
+
18
+ - name: Set up Ruby
19
+ uses: ruby/setup-ruby@v1
20
+ with:
21
+ ruby-version: '3.3.0'
22
+ bundler-cache: true
23
+
24
+ - name: Run tests
25
+ run: bundle exec rspec
26
+
27
+ - name: Run linter
28
+ run: bundle exec rubocop
29
+
30
+ - name: Build gem
31
+ run: gem build *.gemspec
32
+
33
+ - name: Create GitHub Release
34
+ uses: softprops/action-gh-release@v1
35
+ with:
36
+ files: '*.gem'
37
+ generate_release_notes: true
38
+ env:
39
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
40
+
41
+ - name: Publish to RubyGems
42
+ run: |
43
+ mkdir -p $HOME/.gem
44
+ touch $HOME/.gem/credentials
45
+ chmod 0600 $HOME/.gem/credentials
46
+ printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
47
+ gem push *.gem
48
+ env:
49
+ GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
@@ -0,0 +1,32 @@
1
+ name: Security
2
+
3
+ on:
4
+ push:
5
+ branches: [ main ]
6
+ pull_request:
7
+ branches: [ main ]
8
+ schedule:
9
+ # Run security checks daily at 9 AM UTC
10
+ - cron: '0 9 * * *'
11
+
12
+ jobs:
13
+ security:
14
+ runs-on: ubuntu-latest
15
+
16
+ steps:
17
+ - uses: actions/checkout@v4
18
+
19
+ - name: Set up Ruby
20
+ uses: ruby/setup-ruby@v1
21
+ with:
22
+ ruby-version: '3.3.0'
23
+ bundler-cache: true
24
+
25
+ - name: Install bundler-audit
26
+ run: gem install bundler-audit
27
+
28
+ - name: Run bundler-audit
29
+ run: bundle-audit check --update
30
+
31
+ - name: Run RuboCop Security
32
+ run: bundle exec rubocop --only Security
data/.gitignore CHANGED
@@ -1,6 +1,5 @@
1
1
  /.bundle/
2
2
  /.yardoc
3
- /Gemfile.lock
4
3
  /_yardoc/
5
4
  /coverage/
6
5
  /doc/
@@ -9,5 +8,21 @@
9
8
  /tmp/
10
9
  /spec/examples.txt
11
10
  *.gem
11
+ .DS_Store
12
12
 
13
+ # Editor directories and files
14
+ .idea/
15
+ .vscode/
16
+ *.swp
17
+ *.swo
18
+ *~
19
+
20
+ # RubyMine
21
+ .idea/
22
+
23
+ # Local environment
24
+ .env.local
25
+ .env.*.local
26
+
27
+ # Claude settings
13
28
  **/.claude/settings.local.json
data/.rubocop.yml CHANGED
@@ -13,7 +13,7 @@ AllCops:
13
13
  Exclude:
14
14
  - public/**/*
15
15
  - vendor/**/*
16
- TargetRubyVersion: 3.1.4
16
+ TargetRubyVersion: 3.3.0
17
17
 
18
18
  RSpec:
19
19
  Enabled: true
@@ -33,3 +33,6 @@ RSpec/MultipleExpectations:
33
33
 
34
34
  RSpec/NestedGroups:
35
35
  Max: 5
36
+
37
+ RSpec/MultipleMemoizedHelpers:
38
+ Max: 12
data/.yardopts ADDED
@@ -0,0 +1,16 @@
1
+ --markup markdown
2
+ --markup-provider kramdown
3
+ --output-dir doc
4
+ --protected
5
+ --private
6
+ --embed-mixins
7
+ --hide-void-return
8
+ --no-progress
9
+ --title "HeadMusic API Documentation"
10
+ --quiet
11
+ lib/**/*.rb
12
+ -
13
+ README.md
14
+ CHANGELOG.md
15
+ CONTRIBUTING.md
16
+ LICENSE.txt
data/CHANGELOG.md ADDED
@@ -0,0 +1,198 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ ## [8.2.0] - 2025-06-20
11
+
12
+ ### Added
13
+ - Added comprehensive GitHub Actions CI/CD workflows (test matrix, security scanning, automated releases)
14
+ - Added security tooling with bundler-audit for vulnerability scanning
15
+ - Added YARD documentation generation with kramdown support
16
+ - Added SimpleCov coverage tracking with 90% threshold and branch coverage
17
+ - Added Dependabot configuration for automated dependency updates
18
+ - Added inclusive CONTRIBUTING.md with comprehensive contribution guidelines
19
+ - Added complete CHANGELOG.md tracking version history
20
+ - Added GitHub issue templates (bug reports, feature requests) and PR template
21
+ - Added gemspec metadata fields for better gem documentation and security
22
+ - Added rubygems_mfa_required for enhanced security
23
+
24
+ ### Changed
25
+ - Standardized Ruby version requirement to 3.3.0 across all configuration files
26
+ - Updated and organized development dependencies (removed deprecated codeclimate-test-reporter)
27
+ - Enhanced .gitignore with modern patterns and restored Gemfile.lock tracking
28
+ - Improved RuboCop configuration (increased MultipleMemoizedHelpers max to 12)
29
+ - Enhanced Rakefile with quality, documentation, and coverage tasks
30
+
31
+ ### Removed
32
+ - Removed outdated Travis CI and CircleCI configurations (replaced with GitHub Actions)
33
+
34
+ ## [8.1.1] - 2024-12-20
35
+
36
+ ### Changed
37
+ - Tweaked gemspec summary
38
+
39
+ ## [8.1.0] - 2024-12-20
40
+
41
+ ### Added
42
+ - Enhanced solmization support
43
+
44
+ ### Changed
45
+ - Code cleanup and improvements
46
+ - Improved spec coverage
47
+ - Refactored melodic intervals to separate pitch and note concerns
48
+
49
+ ## [8.0.2] - 2024-12-19
50
+
51
+ ### Fixed
52
+ - RuboCop style fixes
53
+
54
+ ### Changed
55
+ - Improved RuboCop configuration
56
+
57
+ ## [8.0.0] - 2024-12-19
58
+
59
+ ### Changed
60
+ - Major reorganization: moved specs into folders
61
+ - Organized models into modules for better structure
62
+ - **BREAKING**: Module structure changes may require updates to require statements
63
+
64
+ ## [7.0.5] - 2024-01-20
65
+
66
+ ### Changed
67
+ - Upgraded to Ruby 3.3.0
68
+ - Improvements to Spanish translations of recorder
69
+
70
+ ## [7.0.4] - 2024-01-15
71
+
72
+ ### Added
73
+ - Rudiment translations
74
+ - Instrument classification translations
75
+ - Interval translations
76
+
77
+ ## [7.0.3] - 2024-01-10
78
+
79
+ ### Added
80
+ - Russian instrument translations using Cyrillic characters
81
+ - Spanish translations for instruments
82
+
83
+ ### Changed
84
+ - Uncapitalized languages in Italian and Spanish translations
85
+ - Spanish translation corrections and improvements
86
+ - Translation file cleanup
87
+
88
+ ## [7.0.2] - 2023-12-15
89
+
90
+ ### Changed
91
+ - Various improvements and bug fixes
92
+
93
+ ## [7.0.1] - 2023-12-10
94
+
95
+ ### Changed
96
+ - Minor improvements and bug fixes
97
+
98
+ ## [7.0.0] - 2023-12-01
99
+
100
+ ### Changed
101
+ - Major version bump indicating significant changes
102
+ - **BREAKING**: Check upgrade guide for migration instructions
103
+
104
+ ## [6.0.1] - 2023-11-15
105
+
106
+ ### Fixed
107
+ - Bug fixes and improvements
108
+
109
+ ## [6.0.0] - 2023-11-01
110
+
111
+ ### Changed
112
+ - Major architectural improvements
113
+ - **BREAKING**: API changes may require code updates
114
+
115
+ ## [5.0.0] - 2023-10-15
116
+
117
+ ### Changed
118
+ - Significant refactoring of core components
119
+ - **BREAKING**: Check documentation for new API
120
+
121
+ ## [4.0.1] - 2023-09-20
122
+
123
+ ### Fixed
124
+ - Minor bug fixes
125
+
126
+ ## [4.0.0] - 2023-09-15
127
+
128
+ ### Added
129
+ - Expanded instrument support
130
+ - Instrument data improvements
131
+
132
+ ### Changed
133
+ - Enhanced Instrument class functionality
134
+
135
+ ## [3.0.1] - 2023-08-20
136
+
137
+ ### Fixed
138
+ - Minor improvements and fixes
139
+
140
+ ## [3.0.0] - 2023-08-15
141
+
142
+ ### Changed
143
+ - Major version update with architectural improvements
144
+ - **BREAKING**: Significant API changes
145
+
146
+ ## [2.0.0] - 2023-07-01
147
+
148
+ ### Changed
149
+ - Major refactoring of core functionality
150
+ - **BREAKING**: API redesign
151
+
152
+ ## [1.0.0] - 2023-06-01
153
+
154
+ ### Added
155
+ - First stable release
156
+ - Complete music theory rudiments implementation
157
+ - Comprehensive scale and interval support
158
+ - Basic composition and voice handling
159
+
160
+ ## [0.29.0] - 2023-05-15
161
+
162
+ ### Added
163
+ - Additional music theory features
164
+ - Improved documentation
165
+
166
+ ## [0.28.0] - 2023-05-01
167
+
168
+ ### Changed
169
+ - Performance improvements
170
+ - Code organization enhancements
171
+
172
+ ## Earlier versions
173
+
174
+ For changes in versions prior to 0.28.0, please refer to the git history.
175
+
176
+ [Unreleased]: https://github.com/roberthead/head_music/compare/v8.2.0...HEAD
177
+ [8.2.0]: https://github.com/roberthead/head_music/compare/v8.1.1...v8.2.0
178
+ [8.1.1]: https://github.com/roberthead/head_music/compare/v8.1.0...v8.1.1
179
+ [8.1.0]: https://github.com/roberthead/head_music/compare/v8.0.2...v8.1.0
180
+ [8.0.2]: https://github.com/roberthead/head_music/compare/v8.0.0...v8.0.2
181
+ [8.0.0]: https://github.com/roberthead/head_music/compare/v7.0.5...v8.0.0
182
+ [7.0.5]: https://github.com/roberthead/head_music/compare/v7.0.4...v7.0.5
183
+ [7.0.4]: https://github.com/roberthead/head_music/compare/v7.0.3...v7.0.4
184
+ [7.0.3]: https://github.com/roberthead/head_music/compare/v7.0.2...v7.0.3
185
+ [7.0.2]: https://github.com/roberthead/head_music/compare/v7.0.1...v7.0.2
186
+ [7.0.1]: https://github.com/roberthead/head_music/compare/v7.0.0...v7.0.1
187
+ [7.0.0]: https://github.com/roberthead/head_music/compare/v6.0.1...v7.0.0
188
+ [6.0.1]: https://github.com/roberthead/head_music/compare/v6.0.0...v6.0.1
189
+ [6.0.0]: https://github.com/roberthead/head_music/compare/v5.0.0...v6.0.0
190
+ [5.0.0]: https://github.com/roberthead/head_music/compare/v4.0.1...v5.0.0
191
+ [4.0.1]: https://github.com/roberthead/head_music/compare/v4.0.0...v4.0.1
192
+ [4.0.0]: https://github.com/roberthead/head_music/compare/v3.0.1...v4.0.0
193
+ [3.0.1]: https://github.com/roberthead/head_music/compare/v3.0.0...v3.0.1
194
+ [3.0.0]: https://github.com/roberthead/head_music/compare/v2.0.0...v3.0.0
195
+ [2.0.0]: https://github.com/roberthead/head_music/compare/v1.0.0...v2.0.0
196
+ [1.0.0]: https://github.com/roberthead/head_music/compare/v0.29.0...v1.0.0
197
+ [0.29.0]: https://github.com/roberthead/head_music/compare/v0.28.0...v0.29.0
198
+ [0.28.0]: https://github.com/roberthead/head_music/releases/tag/v0.28.0
data/CODE_OF_CONDUCT.md CHANGED
@@ -19,6 +19,7 @@ include:
19
19
  * Gracefully accepting constructive criticism
20
20
  * Focusing on what is best for the community
21
21
  * Showing empathy towards other community members
22
+ * Using inclusive language that respects all musical traditions and genres without suggesting the supremacy of any particular style.
22
23
 
23
24
  Examples of unacceptable behavior by participants include:
24
25
 
@@ -27,6 +28,7 @@ Examples of unacceptable behavior by participants include:
27
28
  * Public or private harassment
28
29
  * Publishing others' private information, such as a physical or electronic address, without explicit permission
29
30
  * Other conduct which could reasonably be considered inappropriate in a professional setting
31
+ * Belittling any musical genre or tradition.
30
32
 
31
33
  ## Our Responsibilities
32
34