jazz_model 0.1.0 → 0.2.0

metadata

@@ -1,111 +1,109 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: jazz_model
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Ben Hughes
-autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-10-25 00:00:00 +03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: acts_as_list
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: acts_as_list
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 0
-        - 1
-        - 2
-        version: 0.1.2
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
   name: acts_as_tree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 0
-        - 1
-        - 1
-        version: 0.1.1
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
-  type: :development
-  version_requirements: *id005
-description: Jazz theory is a mathematical system of concepts and relationships, why not make an ActiveModel representation of those concepts?
-email: ben@railsgarden.com
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Jazz theory is a mathematical system of concepts and relationships. Jazz
+  Model represents chords, scales, modes, and keys as an ActiveRecord object model
+  so you can resolve chord symbols, spell notes in any key, and traverse chord-scale
+  relationships.
+email: me@benhughes.name
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- LICENSE.txt
+- README.md
+- db/schema.rb
+- lib/jazz_model.rb
 - lib/jazz_model/base.rb
 - lib/jazz_model/chord.rb
 - lib/jazz_model/chord_collection.rb
@@ -115,6 +113,7 @@ files:
 - lib/jazz_model/chord_symbol_collection.rb
 - lib/jazz_model/chord_tone.rb
 - lib/jazz_model/definition.rb
+- lib/jazz_model/definitions.rb
 - lib/jazz_model/definitions/default.rb
 - lib/jazz_model/definitions/keys.rb
 - lib/jazz_model/key.rb
@@ -122,7 +121,6 @@ files:
 - lib/jazz_model/mode.rb
 - lib/jazz_model/mode_context.rb
 - lib/jazz_model/mode_sequence.rb
-- lib/jazz_model/note_sequence.rb
 - lib/jazz_model/notes_collection.rb
 - lib/jazz_model/scale.rb
 - lib/jazz_model/scale_tone.rb
@@ -131,64 +129,29 @@ files:
 - lib/jazz_model/version.rb
 - lib/jazz_model/voicing.rb
 - lib/jazz_model/voicing_tone.rb
-- lib/jazz_model.rb
-- spec/chord_collection_spec.rb
-- spec/chord_quality_spec.rb
-- spec/chord_scale_spec.rb
-- spec/chord_spec.rb
-- spec/chord_symbol_spec.rb
-- spec/chord_tone_spec.rb
-- spec/definition_spec.rb
-- spec/key_context_spec.rb
-- spec/key_spec.rb
-- spec/mode_spec.rb
-- spec/notes_collection_spec.rb
-- spec/scale_spec.rb
-- spec/scale_tone_spec.rb
-- spec/spec_helper.rb
-- spec/tone_sequence_spec.rb
-- spec/tone_spec.rb
-- spec/voicing_spec.rb
-- spec/voicing_tone_spec.rb
-- CHANGELOG.rdoc
-- Gemfile
-- Rakefile
-- README.rdoc
-has_rdoc: true
-homepage: http://github.com/rubiety/jazz_model
-licenses: []
-
-post_install_message: 
+homepage: https://github.com/eigenben/jazz_model
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/eigenben/jazz_model
+  source_code_uri: https://github.com/eigenben/jazz_model
+  bug_tracker_uri: https://github.com/eigenben/jazz_model/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 19
-      segments: 
-      - 1
-      - 3
-      - 4
-      version: 1.3.4
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: jazz_model
-rubygems_version: 1.3.7
-signing_key: 
-specification_version: 3
+rubygems_version: 3.6.7
+specification_version: 4
 summary: An object model of jazz theory.
 test_files: []
-

data/CHANGELOG.rdoc

@@ -1,14 +0,0 @@
-== 0.1.0 [2010-10-20] Modernization
-* Upgraded to RSpec 2.0
-* Ditched Controllers/Rails Application
-* Reworked all models to use in-memory ActiveModel instead of ActiveRecord
-* Internal Refactoring
-* Released as a Gem
-
-== 2008-08-24:
-* Upgraded to Rails 2.1
-* Refactored models to use new Rails 2.1 features.
-
-== Old:
-* Implemented REST Interface
-* Added RSpec

data/Gemfile

@@ -1,4 +0,0 @@
-source 'http://rubygems.org'
-
-gem "activemodel", "~> 3.0.0"
-gem "activesupport", "~> 3.0.0"

data/README.rdoc

@@ -1,186 +0,0 @@
-= Jazz Model
-
-Jazz Model is full ActiveRecord model of concepts in Jazz theory, establishing relationships between chords and scales, and much more.  Aside from representing jazz theory relationships in the database, jazz model can do key conversions and other operations on these jazz "objects".  By default it uses an in-memory sqlite3 database, but it could be persisted elsewhere.
-
-== Architecture Overview
-
-The core of Jazz Toolbox is a full Ruby object model representing concepts of Jazz theory, 
-distilled to their most basic concepts and architected in a very abstract manner.  The system 
-is data-centric and all "rules" (for example, the tones in a C7 chord) in theory are 
-self-contained in the database.
-
-All chord/scale/mode/etc. definitions are stored as a mathematical system (sequences of numbers) 
-which are then used to perform calculations.  For example, putting some chord in a different key 
-is a matter of adding a semitone delta and doing modulo 12.  
-
-While there are currently many chord calculators in existence, to my knowledge this project is the 
-first one that attempts to fully represent the entirety of Jazz theory as a mathematical/computational 
-system exposed through an elegant object model.  
-
-Note: the current database consists entirely of my own personal knowledge of Jazz theory.  I 
-haven't yet scoured through the Jazz theory literature to formalize and expand the current database 
-of chords, scales, and chord-scales.  There's still a lot of work to do and I have lots of ideas for how to expand this.
-
-== Core Features
-
-* Scale & Mode Enumeration
-* Handles Variety of Notations
-* ChordTone Enumeration
-* Traversing ScaleChord Relationships with Strength Metric
-* Full Understanding of Theoretic Tones (vs. only Pitches)
-
-== Installation
-
-Simply include the gem in your Gemfile:
-  
-  gem "jazz_model"
-
-From here you can begin using the classes under +JazzModel+ directly, but it won't be much use until you load the definitions:
-  
-  JazzModel::Base.load_definitions
-
-== Examples using Default Definitions
-
-Everything is under the JazzModel namespace, so first do this if you want to use these classes directly:
-  
-  include JazzModel
-
-* Getting a Chord object:
-   
-  Chord['maj7']
-  Chord['Bbmaj7']  # <- With Key Context
-  Chord['Abmaj7#11']
-  ...
-
-* Getting a Scale object:
-   
-  Scale['Major']
-  Scale['Melodic Minor']
-  Scale['Diminished']
-  ...
-
-* Getting a particular mode of a scale:
-   
-  Scale['Major'].modes['Dorian']  # By Mode Name
-  Scale['Major'].modes[2]  # By Mode Index
-  
-  # Or directly index the scale object (same as above):
-  Scale['Major']['Dorian']
-  Scale['Major'][2]
-
-* Enumerate notes of a Chord:
-   
-  Chord['maj'].notes   # Defaults to C without specified key context
-  # => ['C', 'E', 'G']
-  
-  Chord['Ebmaj7'].notes
-  # => ['Eb', 'G', 'Bb', 'D']
-  
-  # Or specify key context with chained methods like this...
-  Chord['maj7'].in_key_of('Eb').notes
-  
-  Chord['Bmaj7#11'].notes
-  # => ['B', 'D#', 'F#', 'A#', 'E#']
-  # Note E# - Correct theoretic value for this chord, not F
-  
-  Chord['Falt'].notes 
-  Chord['F7b9#9'].notes
-  # => ['F', 'A', 'Eb', 'Gb', 'G#', 'C#']
-  
-  Chord['Gbmaj7'].notes
-  # => ['Gb', 'Bb', 'Db', 'F']
-  
-  # But...
-  
-  Chord['F#maj7'].notes
-  # => ['F#', 'A#', 'C#', 'E#']
-   
-   
-* Enumerate notes of a Scale:
-   
-  Scale['Major'].notes  # Defaults to C without specified key context
-  # => ['C', 'D', 'E', 'F', 'G', 'A', 'B']
-  
-  Scale['Eb Major'].notes
-  # => ['Eb', 'F', 'G', 'Ab', 'Bb', 'C', 'D']
-  
-  # Or specify key context with chained methods like this:
-  Scale['Major'].in_key_of('Eb').notes
-  
-  Scale['Whole Tone'].notes
-  # => ['C', 'D', 'E', 'F#', 'G#', 'Bb']
-  
-  Scale['Bebop'].notes
-  # => ['C', 'D', 'E', 'F', 'G', 'A', 'Bb', 'B']
-   
-   
-* Enumerate notes from a Scale Mode:
-   
-  Scale['Major'].in_key_of('Eb').modes['Dorian'].notes
-  # => ['F', 'G', 'Ab', 'Bb', 'C', 'D', 'Eb']
-  
-  Scale['Melodic Minor']['Lydian Dominant'].notes
-  # => ['F', 'G', 'A', 'B', 'C', 'D', 'Eb']
-   
-
-* Enumerate scale modes associated with a chord:
-   
-  Chord['min7'].modes.names  # .names == .map(&:name)
-  # => ['Dorian']
-  Chord['min7'].modes[0].scale.name
-  # => "Major"
-  
-  Chord['Amin7'].modes.names
-  # => ['A Dorian']
-   
-   
-* Enumerate chords associated with a scale mode:
-   
-  Scale['Major']['Dorian'].chords.symbols
-  # => ['min7', 'min6']
-  
-  Scale['Major'][4].chords.symbols
-	# => ['maj7#11']
-   
-
-* Ruby Example Problem:
-  Find all chords associated with the Major (Ionian) scale and print 
-  each on a new line with the chord tones.
-  
-  Scale['Major'].chords.map {|c| c.name + ': ' + c.notes.join(', ')} * "\n"
-  # => Major 7: C, E, G, B
-	     Major 6: C, E, G, A
-	     Dominant 6/9: C, E, G, Bb, D, A
-
-These examples should show that with the power of Ruby and the elegant nature of 
-this API, extracting Jazz data from the system is a breeze (even fun!).
-
-== Definitions Available
-
-The default definition is just named "default" and is loaded when you run JazzModel::Base.load_definitions without argument, though you can give a custom argument to this to load a different definition:
-  
-  JazzModel::Base.load_definitions(:my_custom_set)
-
-Currently there are two definitions available:
-* Keys - Creates the basic 12 keys.  This definition should always be loaded so long as you are dealing with Western harmony.
-* Default - The default set of data for jazz models, including many scales and chords.  Any other definitions will probably want to build upon this instead of start from scratch.
-
-== Creating Definitions
-
-The gem has a distinction between classes such as +Chord+ and the actual definitions such as "C Major Chord".  Definitions are simply packaged set of instructions for initializing the objects with data (which get put in the database).  Since by default jazz model uses an in-memory sqlite3 database, definitions need to be loaded when your application loads.
-
-To create a definition, simply do this:
-
-  JazzModel::Definition.define :my_definition => [:keys] do
-    
-  end
-
-Within the block you'll want to create whatever data is necessary to comprise your definitions.  For examples of definitions, see lib/jazz_model/definitions in the project.  The argument to define acts like rake tasks - use the hash value to define which dependencies your definition has.  In the above case defining "my_definition" will first ensure the "keys" definition is already defined.
-
-== Anticipated Future Features
-
-* Chord Progression Analysis
-* MIDI Integration
-* User Comments & Contributions (such as Chord-Scale recommendations)
-* Melodic Components & Licks
-* Voicings Associated with Chords

data/Rakefile

@@ -1,14 +0,0 @@
-require 'rubygems'
-require 'rake'
-require 'rake/rdoctask'
-
-desc "Generate documentation for the plugin."
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.title    = "message_block"
-  rdoc.options << "--line-numbers" << "--inline-source"
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-Dir["#{File.dirname(__FILE__)}/lib/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/jazz_model/note_sequence.rb

@@ -1,15 +0,0 @@
-module JazzModel
-  # Mixins for a sequence of note represented as an array.
-  module NoteSequence
-  	def to_xml(options = {})
-  		options[:indent] ||= 2
-  		xml = options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent])
-  		xml.instruct! unless options[:skip_instruct]
-  		xml.notes do
-  			self.each do |note|
-  				xml.tag!(:note, note.to_s)
-  			end
-  		end
-  	end
-  end
-end

data/spec/chord_collection_spec.rb

@@ -1,21 +0,0 @@
-require "spec_helper"
-
-describe JazzModel::ChordCollection do
-  subject { JazzModel::Scale['Major'].modes[1].chords }
-  
-  it "should emit symbols list" do
-    subject.to_s(:symbols).should be_starts_with('maj')
-  end
-  
-  it "should emit names list" do
-    subject.to_s(:names).should be_starts_with('Major')
-  end
-  
-  it "should resolve chord within" do
-    subject['maj'].should_not be_nil
-  end
-  
-  it "should resolve chord within with key context" do
-    subject['Cmaj'].should_not be_nil
-  end
-end

data/spec/chord_quality_spec.rb

@@ -1,27 +0,0 @@
-require "spec_helper"
-
-describe JazzModel::ChordQuality do
-  subject { JazzModel::ChordQuality.new }
-  
-  it { should be_valid }
-  
-  context "of Major" do
-    subject { JazzModel::ChordQuality.find_by_name('Major') }
-    it { should be_valid }
-  end
-  
-  context "of Minor" do
-    subject { JazzModel::ChordQuality.find_by_name('Minor') }
-    it { should be_valid }
-  end
-  
-  context "of Dominant" do
-    subject { JazzModel::ChordQuality.find_by_name('Dominant') }
-    it { should be_valid }
-  end
-  
-  context "of Diminished" do
-    subject { JazzModel::ChordQuality.find_by_name('Diminished') }
-    it { should be_valid }
-  end
-end

data/spec/chord_scale_spec.rb

@@ -1,7 +0,0 @@
-require "spec_helper"
-
-describe JazzModel::ChordScale do
-  subject { JazzModel::ChordScale.new }
-  
-  it { should be_valid }
-end

data/spec/chord_spec.rb

@@ -1,29 +0,0 @@
-require "spec_helper"
-
-describe JazzModel::Chord do
-  subject { JazzModel::Chord.new }
-  
-  it { should be_valid }
-  
-  pairings = {
-    'Cmaj' => %w[C E G],
-    'Cmin' => %w[C Eb G],
-    'Cmaj7' => %w[C E G B],
-    'Cmin7' => %w[C Eb G Bb],
-    'C7' => %w[C E G Bb],
-    'Cfulldim' => %w[C Eb Gb Bbb]
-  }
-  
-  pairings.each do |chord_symbol, notes|
-    context "as #{chord_symbol}" do
-      it "should give valid notes" do
-        chord = JazzModel::Chord[chord_symbol]
-        chord.should_not be_nil
-        chord.notes.should == notes
-      end
-    end
-  end
-end
-
-
-

data/spec/chord_symbol_spec.rb

@@ -1,6 +0,0 @@
-require "spec_helper"
-
-describe JazzModel::ChordSymbol do
-  subject { JazzModel::ChordSymbol.new }
-  it { should be_valid }
-end

data/spec/chord_tone_spec.rb

@@ -1,6 +0,0 @@
-require "spec_helper"
-
-describe JazzModel::ChordTone do
-  subject { JazzModel::ChordTone.new }
-  it { should be_valid }
-end

data/spec/definition_spec.rb

@@ -1,35 +0,0 @@
-require "spec_helper"
-
-describe JazzModel::Definition do
-  context "after creating a definition" do
-    before(:all) do
-      JazzModel::Definition.define :my_definition => [:keys] do
-        JazzModel::Scale.create!(:name => "Sample")
-      end
-    end
-    
-    it "should have registered my_definition" do
-      JazzModel::Definition[:my_definition].should_not be_nil
-    end
-    
-    describe "the definition" do
-      before { @definition = JazzModel::Definition[:my_definition] }
-      
-      it "should list keys as an included_definition" do
-        @definition.included_definitions.should include(:keys)
-      end
-      
-      context "when loaded" do
-        before { @definition.load }
-        
-        it "should create keys" do
-          JazzModel::Key.find_by_name("C").should_not be_nil
-        end
-        
-        it "should create sample scale" do
-          JazzModel::Scale.find_by_name("Sample").should_not be_nil
-        end
-      end
-    end
-  end
-end