musicxml 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6ee424ff81a6fc3e48e995744f296e7a8796778
+  data.tar.gz: ec5671b612320f2cc717dde7f98bcffce3996078
+SHA512:
+  metadata.gz: 705281df74f15b612922ab47af95f052221fed252805e06231a65a736310158f5f081045000100d46ea7ce4790ef8bcde20d0f55c5a8bef5dd35df9f7e19cb3e
+  data.tar.gz: 20973e13ddcbc7fc6d1bb8b79c951eace6fc58fb8586bf2a50ba62c227b94e472311ed36ba913d5080c3108d9718b2eff5b8e2813c35e3658c3f2c305a6cc641

data/.gitignore

@@ -0,0 +1,6 @@
+/.bundle/
+/.ruby-version
+/.ruby-gemset
+/coverage/
+/Gemfile.lock
+/pkg/

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - vendor/**/*
+
+Metrics/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '[]'
+    '%w': '[]'
+
+Style/PerlBackrefs:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm: 2.3.1
+cache: bundler
+script:
+- bundle exec rake
+- bundle exec rubocop

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kevin Deisz
+
+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,42 @@
+# MusicXML
+
+[![Build Status](https://travis-ci.org/kddeisz/musicxml.svg?branch=master)](https://travis-ci.org/kddeisz/musicxml)
+
+Ruby bindings for MusicXML.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'musicxml'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install musicxml
+
+## Usage
+
+```ruby
+filepath = 'my-piece.xml'
+score = MusicXML::Parser.new(filepath)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/kddeisz/musicxml.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'musicxml'
+
+filepath = ARGV.shift
+@score = MusicXML::Parser.new(filepath).parse if filepath
+
+require 'irb'
+IRB.start

data/lib/musicxml.rb

@@ -0,0 +1,12 @@
+require 'forwardable'
+require 'json'
+require 'nokogiri'
+
+require 'musicxml/node/config'
+require 'musicxml/node/json_export'
+require 'musicxml/node/base'
+require 'musicxml/node/parser'
+require 'musicxml/node'
+
+require 'musicxml/key_signature'
+require 'musicxml/parser'

data/lib/musicxml/key_signature.rb

@@ -0,0 +1,16 @@
+module MusicXML
+  class KeySignature
+
+    FIFTHS = %w[Gb Db Ab Eb Bb F C G D A E B F#].freeze
+
+    attr_reader :number
+
+    def initialize(number)
+      @number = number
+    end
+
+    def humanize
+      FIFTHS[number + 6]
+    end
+  end
+end

data/lib/musicxml/node.rb

@@ -0,0 +1,129 @@
+module MusicXML
+  # Namespace for all nodes defined by the system. Nodes are used
+  # to represent the various segments of the XML describing different
+  # musical concepts.
+  module Node
+
+    class << self
+      attr_accessor :registry
+    end
+    self.registry = {}
+
+    def self.register(name, &block)
+      class_name = name.to_s.capitalize.gsub(/\_([a-z])/) { $1.to_s.upcase }
+      clazz = Class.new(Base, &block)
+
+      registry[name] = clazz
+      const_set(class_name.to_sym, clazz)
+    end
+
+    register :articulations do
+      sattrs :accent, :breath_mark, :staccato, :tenuto
+    end
+
+    register :attributes do
+      pattrs :divisions, :staves
+      snodes :clef, :key, :transpose
+    end
+
+    register :barline do
+      snodes :repeat
+    end
+
+    register :chord
+
+    register :clef do
+      sattrs :line, :sign
+    end
+
+    register :defaults do
+      sattrs :music_font, :word_font
+    end
+
+    register :direction do
+      snodes :direction_type
+    end
+
+    register :direction_type do
+      pattrs :words, :dynamics
+    end
+
+    register :dot
+
+    register :encoding do
+      pattrs :supports
+      sattrs :encoding_data, :software
+    end
+
+    register :identification do
+      sattrs :creator, :rights
+      snodes :encoding
+    end
+
+    register :key do
+      sattrs :fifths, :mode
+
+      def humanize
+        (@key_signature ||= KeySignature.new(fifths.to_i)).humanize
+      end
+    end
+
+    register :measure do
+      sattrs :sound
+      snodes :clef, :direction, :key, :time, :barline, :transpose
+      pnodes :note
+    end
+
+    register :notations do
+      pnodes :articulations
+      sattrs :arpeggiate, :slur
+    end
+
+    register :note do
+      sattrs :duration, :staff, :stem, :type, :voice, :accidental
+
+      pnodes :notations, :dot
+      snodes :pitch, :chord
+    end
+
+    register :part do
+      pnodes :measure
+    end
+
+    register :part_list do
+      pnodes :score_part
+    end
+
+    register :pitch do
+      sattrs :step, :alter, :octave
+    end
+
+    register :repeat do
+      props :direction, :times
+    end
+
+    register :score_instrument do
+      sattrs :instrument_name
+    end
+
+    register :score_part do
+      sattrs :part_name
+      snodes :score_instrument
+    end
+
+    register :score_partwise do
+      sattrs :movement_title
+
+      pnodes :defaults, :part
+      snodes :identification, :part_list
+    end
+
+    register :time do
+      sattrs :beats, :beat_type
+    end
+
+    register :transpose do
+      sattrs :diatonic, :chromatic, :octave
+    end
+  end
+end

data/lib/musicxml/node/base.rb

@@ -0,0 +1,30 @@
+module MusicXML
+  module Node
+
+    # Superclass for all node types
+    class Base
+
+      include JsonExport
+
+      # Build a Parser to parse the node based on this class' config
+      def initialize(node)
+        Parser.new(node: node, config: self.class.config).parse.each do |key, value|
+          instance_variable_set(key, value)
+        end
+      end
+
+      class << self
+        # forward class methods to the config to store the configuration
+        extend Forwardable
+        def_delegators :config, :pattrs, :pnodes, :props, :sattrs, :snodes
+
+        attr_accessor :config
+
+        # when this class is subclassed build a new config
+        def inherited(subclass)
+          subclass.config = ::MusicXML::Node::Config.new(subclass)
+        end
+      end
+    end
+  end
+end

data/lib/musicxml/node/config.rb

@@ -0,0 +1,48 @@
+module MusicXML
+  module Node
+    class Config
+
+      attr_accessor :clazz, :properties
+      attr_accessor :plural_attrs, :singular_attrs
+      attr_accessor :plural_nodes, :singular_nodes
+
+      def initialize(clazz)
+        self.clazz = clazz
+        %w[plural_attrs plural_nodes singular_attrs singular_nodes properties].each do |name|
+          send("#{name}=", [])
+        end
+      end
+
+      def pattrs(*names)
+        self.plural_attrs += names
+        add_accessors(*names)
+      end
+
+      def pnodes(*names)
+        self.plural_nodes += names
+        add_accessors(*names)
+      end
+
+      def props(*names)
+        self.properties += names
+        add_accessors(*names)
+      end
+
+      def sattrs(*names)
+        self.singular_attrs += names
+        add_accessors(*names)
+      end
+
+      def snodes(*names)
+        self.singular_nodes += names
+        add_accessors(*names)
+      end
+
+      private
+
+      def add_accessors(*names)
+        clazz.class_eval { attr_accessor(*names) }
+      end
+    end
+  end
+end

data/lib/musicxml/node/json_export.rb

@@ -0,0 +1,54 @@
+module MusicXML
+  module Node
+    module JsonExport
+      def to_json
+        { json_key => json_values }.to_json
+      end
+
+      def json_key
+        self.class.name.split('::').last.gsub(/^([A-Z])/) { $1.downcase }
+      end
+
+      def json_values
+        output = {}
+        load_plural_attrs(output)
+        load_singular_attrs(output)
+        load_plural_nodes(output)
+        load_singular_nodes(output)
+        output
+      end
+
+      private
+
+      def jsify(name)
+        name.to_s.gsub(/(_[a-z])/) { $1.upcase[1..-1] }
+      end
+
+      def load_plural_attrs(output)
+        self.class.config.plural_attrs.each do |name|
+          output[jsify(name)] = send(name) || []
+        end
+      end
+
+      def load_plural_nodes(output)
+        self.class.config.plural_nodes.each do |name|
+          nodes = send(name)
+          output[jsify(name)] = nodes ? nodes.map(&:json_values) : []
+        end
+      end
+
+      def load_singular_attrs(output)
+        (self.class.config.properties + self.class.config.singular_attrs).each do |name|
+          output[jsify(name)] = send(name)
+        end
+      end
+
+      def load_singular_nodes(output)
+        self.class.config.singular_nodes.each do |name|
+          node = send(name)
+          output[jsify(name)] = node ? node.json_values : nil
+        end
+      end
+    end
+  end
+end