musi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 708e228cd4ee61de279c589a2cdc091d82928c4eba56d5aaab228c2b4b9bdd69
+  data.tar.gz: 8575be6ee3a360b55ad375f942086fe6f95fdd481279b2b5e88a2b1272596af9
+SHA512:
+  metadata.gz: 12fb03711aac95ea3cc76687c78fb22cd1bbf4b1ade0715ee0795a67425e9e285e5bfa4462ac950d3e98f1db374514265afba7a049edfd369b8569d379b8f2ff
+  data.tar.gz: e919ecfe0b9bdd16b646ea70202669dc22fb2589559235b984d159dc738de5c3d806682e9a7fe52aeb6d794c9787a819fd150be01675e2fe1d7b5e3af0c1c33b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in musi.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    musi (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  musi!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 <github username>
+
+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,54 @@
+# Musi
+
+Welcome to Musi! A very basic gem for calculating intervals in music theory. Pass a note as a string such as "C" or "Ab" to a method and receive a new note in the form of a string.
+
+You may sharp or flat a note or raise by perfect 4th and 5th intervals. Minor/Major intervals not yet supported.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'musi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install musi
+
+## Usage
+
+.sharp is a method which will raise the input of a note given as a string by one half step
+.flat is a a method which will lower the input of a note given as a string by one half step
+.raise_whole_step raises a note by a whole step
+.lower_whole_step lowers a note by a whole step
+.raiseP4 raises a note by a perfect fourth
+.lowerP4 lowers a note by a perfect fourth
+.raiseP5 raises a note by a perfect fifth
+.lowerP5 lowers a note by a perfect fifth
+
+Musi::Note.sharp("D") => D#
+
+Enharmonic spellings such as B# and Gx are currently not supported.
+.raise_whole_step("A#") will raise to "C"
+
+Currently only these 8 actions available.
+
+## 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 tags, 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/eselbeus/musi.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "musi"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/musi.rb

@@ -0,0 +1,7 @@
+require "musi/version"
+require 'musi/note'
+
+module Musi
+  class Error < StandardError; end
+
+end

data/lib/musi/note.rb

@@ -0,0 +1,137 @@
+# require 'pry'
+module Musi
+  class Note
+
+    @@sharp_notes = {
+      "C" => 1,
+      "C#" => 2,
+      "D" => 3,
+      "D#" => 4,
+      "E" => 5,
+      "F" => 6,
+      "F#" => 7,
+      "G" => 8,
+      "G#" => 9,
+      "A" => 10,
+      "A#" => 11,
+      "B" => 12
+    }
+    @@flat_notes = {
+      "C" => 1,
+      "Db" => 2,
+      "D" => 3,
+      "Eb" => 4,
+      "E" => 5,
+      "F" => 6,
+      "Gb" => 7,
+      "G" => 8,
+      "Ab" => 9,
+      "A" => 10,
+      "Bb" => 11,
+      "B" => 12
+    }
+
+    #Helper Method for lowering intervals that go below C
+    def self.above_zero(next_note)
+      if next_note < 1
+        next_note += 12
+      else
+        next_note
+      end
+    end
+
+    #Helper method for raising(m2, M2, P4, P5)
+    def self.raise_helper(note, modifier)
+      if note.include?("b")
+        next_note = (@@flat_notes[note] + modifier) % 12
+        @@flat_notes.keys.each do |k|
+          if @@flat_notes[k] == next_note
+            return k
+          end
+        end
+      else
+        next_note = (@@sharp_notes[note] + modifier) % 12
+        @@sharp_notes.keys.each do |k|
+          if @@sharp_notes[k] == next_note
+            return k
+          end
+        end
+      end
+    end
+
+    def self.raise_helper_minor(note, modifier)
+      if !note.include?("#")
+        next_note = (@@flat_notes[note] + modifier) % 12
+        @@flat_notes.keys.each do |k|
+          if @@flat_notes[k] == next_note
+            return k
+          end
+        end
+      else
+        next_note = (@@sharp_notes[note] + modifier) % 12
+        @@sharp_notes.keys.each do |k|
+          if @@sharp_notes[k] == next_note
+            return k
+          end
+        end
+      end
+    end
+
+    #Helper method for lowering(m2, M2, P4, P5)
+    def self.lower_helper(note, modifier)
+      if note.include?("#")
+        next_note = (@@sharp_notes[note] - modifier) % 12
+        @@sharp_notes.keys.each do |k|
+          if @@sharp_notes[k] == self.above_zero(next_note)
+            return k
+          end
+        end
+      else
+        next_note = (@@flat_notes[note] - modifier)
+        @@flat_notes.keys.each do |k|
+          if @@flat_notes[k] == self.above_zero(next_note)
+            return k
+          end
+        end
+      end
+    end
+
+    #m2
+    def self.sharp(note)
+      self.raise_helper(note, 1)
+    end
+
+    def self.flat(note)
+      self.lower_helper(note, 1)
+    end
+
+    #M2
+    def self.raise_whole_step(note)
+      self.raise_helper(note, 2)
+    end
+
+    def self.lower_whole_step(note)
+      self.lower_helper(note, 2)
+    end
+
+    #M3
+    def self.raiseP4(note)
+      self.raise_helper_minor(note, 5)
+    end
+
+    def self.lowerP4(note)
+      self.lower_helper(note, 5)
+    end
+
+    #P5
+    def self.raiseP5(note)
+      self.raise_helper(note, 7)
+    end
+
+    def self.lowerP5(note)
+      self.lower_helper(note, 7)
+    end
+
+  end
+
+end

data/lib/musi/version.rb

@@ -0,0 +1,3 @@
+module Musi
+  VERSION = "0.1.0"
+end

data/musi.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "musi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "musi"
+  spec.version       = Musi::VERSION
+  spec.authors       = ["Eselbeus"]
+  spec.email         = ["eselbeus@gmail.com"]
+
+  spec.summary       = %q{Simple music theory gem}
+  spec.description   = %q{A gem for sharping/flattening notes and raising/lowering by perfect 5ths}
+  spec.homepage      = "https://github.com/Eselbeus/musi.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "https://github.com/Eselbeus/musi.git"
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: musi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eselbeus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A gem for sharping/flattening notes and raising/lowering by perfect 5ths
+email:
+- eselbeus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/musi.rb
+- lib/musi/note.rb
+- lib/musi/version.rb
+- musi.gemspec
+homepage: https://github.com/Eselbeus/musi.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Simple music theory gem
+test_files: []