musical_score 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b09d9932a8034a704c30a63a3bf1f2c656788e9
-  data.tar.gz: db84bae2d9473dfda8d6ab146ad0effd966de5d5
+  metadata.gz: f4fe9ce7d2dc51b7136d205eef2d8401b67c1e0b
+  data.tar.gz: 339ccef7ae5b6bf7492a5e8e3d9d4a5c830b3579
 SHA512:
-  metadata.gz: e16f49f188756a8738f2a2b533f9b1d9bbe6b8fc19d5aa507432ed23b2dff3ccd73bae9125bb021832a349d29d5f0cdb04f1982261985ad6f74cf6ed9e347474
-  data.tar.gz: ee2052aa91df90bd32184c2e83c8e50dada2928dd6b88fbce9eda6c128ae3822fcddc9158f5f8924703ccd767cc670c061ffd584f4f54388a2703377efd4e641
+  metadata.gz: 07b419d4fd50b20fb505954537794fec98b24eddb2c3bddcad8fb16dd0f015f53ca9f386e9766de725590a716a41c0294a8485a88e4f4689f2a4fd0278fd75e6
+  data.tar.gz: cf3d0a5a58b34be0364668b29ef635cd11c64741bacca005ba33f15b32bec295665ae987c48e1c8fedd9208714c75d9f563909e73ec19c0a44b3db3a3e5b536c

data/.rspec

@@ -1,2 +1,2 @@
---format Fuubar
+--format documentation
 --color

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/yumaito/musical_score.svg?branch=master)](https://travis-ci.org/yumaito/musical_score)
 [![Code Climate](https://codeclimate.com/github/yumaito/musical_score/badges/gpa.svg)](https://codeclimate.com/github/yumaito/musical_score)
+[![Gem Version](https://badge.fury.io/rb/musical_score.svg)](https://badge.fury.io/rb/musical_score)
 
 Library for representing and analysing musical score.
 This library is implemented along with the definitions of [MusicXML](http://www.musicxml.com/) mainly.
@@ -32,9 +33,15 @@ require 'musical_score'
 
 musical_score = MusicalScore::IO.import("path/to/musicxml.xml")
 ```
-
 Now you can handle the musical score as a ruby class object.
 
+For example, if you want to know the pitch of the first note information:
+```ruby
+pitch = musical_score.part[0].measures[0].notes[0].pitch
+puts pitch
+# E3
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/yumaito/musical_score. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/musical_score/attribute/attribute.rb

@@ -50,6 +50,17 @@ module MusicalScore
                 return attributes
             end
 
+            Contract HashOf[String => Any] => MusicalScore::Attribute::Attribute
+            def self.create_by_hash(doc)
+                divisions = doc["divisions"][0].to_i
+                clef      = doc.has_key?("clef") ? MusicalScore::Attribute::Clef.create_by_hash(doc["clef"][0]) : nil
+                time      = doc.has_key?("time") ? MusicalScore::Attribute::Time.create_by_hash(doc["time"][0]) : nil
+                key       = doc.has_key?("key") ? MusicalScore::Attribute::Key.create_by_hash(doc["key"][0]) : nil
+
+                attributes = MusicalScore::Attribute::Attribute.new(divisions: divisions, clef: clef, key: key, time: time)
+                return attributes
+            end
+
             def export_xml
                 attribute_element = REXML::Element.new('attributes')
                 divisions_element = REXML::Element.new('divisions').add_text(@divisions.to_s)

data/lib/musical_score/attribute/clef.rb

@@ -27,6 +27,15 @@ module MusicalScore
                 return clef
             end
 
+            Contract HashOf[String => Any] => MusicalScore::Attribute::Clef
+            def self.create_by_hash(doc)
+                sign = doc["sign"][0].to_sym
+                line = doc.has_key?("line") ? doc["line"][0].to_i : 0
+                clef_octave_change = doc.has_key?("clef-octave-change") ? doc["clef-octave-change"][0].to_i : 0
+                clef = MusicalScore::Attribute::Clef.new(sign, line, clef_octave_change)
+                return clef
+            end
+
             def export_xml
                 clef_element  = REXML::Element.new('clef')
                 sign_element = REXML::Element.new('sign').add_text(@sign.to_s)
@@ -41,4 +50,4 @@ module MusicalScore
             end
         end
     end
-end
+end

data/lib/musical_score/attribute/key.rb

@@ -3,7 +3,7 @@ module MusicalScore
     module Attribute
         class Key < MusicalScore::ElementBase
             include Contracts
-            @@mode = %i(major :minor)
+            @@mode = %i(major minor)
             @@circle_of_fifths = [0, 7, 2, 9, 4, 11, 6, 1, 8, 3, 10, 5]
 
             attr_reader :fifths, :mode
@@ -59,6 +59,13 @@ module MusicalScore
                 return MusicalScore::Attribute::Key.new(fifths, mode)
             end
 
+            Contract HashOf[String => Any] => MusicalScore::Attribute::Key
+            def self.create_by_hash(doc)
+                fifths = doc["fifths"][0].to_i
+                mode   = doc["mode"][0].to_sym
+                return MusicalScore::Attribute::Key.new(fifths, mode)
+            end
+
             def export_xml
                 key_element    = REXML::Element.new('key')
                 fifths_element = REXML::Element.new('fifths').add_text(@fifths.to_s)
@@ -71,4 +78,4 @@ module MusicalScore
             end
         end
     end
-end
+end

data/lib/musical_score/attribute/time.rb

@@ -25,6 +25,13 @@ module MusicalScore
                 return MusicalScore::Attribute::Time.new(beats, beat_type)
             end
 
+            Contract HashOf[String => Any] => MusicalScore::Attribute::Time
+            def self.create_by_hash(doc)
+                beats     = doc["beats"][0].to_i
+                beat_type = doc["beat-type"][0].to_i
+                return MusicalScore::Attribute::Time.new(beats, beat_type)
+            end
+
             def export_xml
                 time      = REXML::Element.new('time')
                 beats     = REXML::Element.new('beats')

data/lib/musical_score/element_base.rb

@@ -10,6 +10,10 @@ module MusicalScore
             raise "Called abstract method: create_by_xml"
         end
 
+        def self.create_by_hash(hash)
+            raise "Called abstract method: create_by_hash"
+        end
+
         def export_xml
             raise "Called abstract method: export_xml"
         end

data/lib/musical_score/io/exporter.rb

@@ -0,0 +1,16 @@
+require 'musical_score'
+require 'rexml/document'
+require 'rexml/formatters/pretty'
+module MusicalScore
+    module IO
+        def export_xml(path, score)
+            formatter = REXML::Formatters::Pretty.new(4)
+            formatter.compact = true
+            File.open(path, 'w') do |file|
+                formatter.write(score.export_xml, file)
+            end
+        end
+
+        module_function :export_xml
+    end
+end

data/lib/musical_score/io/importer.rb

@@ -1,12 +1,13 @@
 require 'musical_score'
 require 'rexml/document'
+require 'xmlsimple'
 module MusicalScore
     module IO
         def import(file)
             extname = File.extname(file)
             case extname
             when ".xml"
-                return import_xml(file)
+                return import_xml_via_hash(file)
             else
                 raise MusicalScore::InvalidFileType
             end
@@ -17,6 +18,12 @@ module MusicalScore
             return score
         end
 
-        module_function :import, :import_xml
+        def import_xml_via_hash(file_path)
+            doc = XmlSimple.xml_in(open(file_path))
+            score = MusicalScore::Score::Score.create_by_hash(doc, file_path)
+            return score
+        end
+
+        module_function :import, :import_xml, :import_xml_via_hash
     end
 end

data/lib/musical_score/measures.rb

@@ -21,6 +21,10 @@ module MusicalScore
             end
         end
 
+        def last
+            return @measures[@measures.size-1]
+        end
+
         def all_notes
             result = Array.new
             @measures.each do |measure|

data/lib/musical_score/note/lyric.rb

@@ -25,6 +25,14 @@ module MusicalScore
                 return MusicalScore::Note::Lyric.new(text, syllabic, is_extend)
             end
 
+            Contract HashOf[String => Any] => MusicalScore::Note::Lyric
+            def self.create_by_hash(doc)
+                syllabic  = doc.has_key?("syllabic") ? doc["syllabic"][0].to_sym : nil
+                text      = doc["text"][0]
+                is_extend = doc.has_key?("extend")
+                return MusicalScore::Note::Lyric.new(text, syllabic, is_extend)
+            end
+
             def export_xml(number)
                 lyric_element = REXML::Element.new('lyric')
                 lyric_element.add_attribute('number', number.to_s)
@@ -40,4 +48,4 @@ module MusicalScore
             end
         end
     end
-end
+end

data/lib/musical_score/note/notation/notation.rb

@@ -80,6 +80,17 @@ module MusicalScore
                     return MusicalScore::Note::Notation::Notation.new(articulation: articulation, dynamics: dynamics, tie: tie, tuplet: tuplet)
                 end
 
+                Contract HashOf[String => Any] => MusicalScore::Note::Notation::Notation
+                def self.create_by_hash(doc)
+                    articulation = doc.has_key?("articulations") ? doc["articulations"][0].keys[0].to_sym : nil
+                    dynamics     = doc.has_key?("dynamics") ? doc["dynamics"][0].keys[0].to_sym : nil
+                    tie_arg      = doc.has_key?("tied") ? doc.dig("tied", 0, "type").to_sym : nil
+                    tie          = tie_arg ? MusicalScore::Note::Notation::Tie.new(tie_arg) : nil
+                    tuplet_arg   = doc.has_key?("tuplet") ? doc.dig("tuplet", 0, "type").to_sym : nil
+                    tuplet = tuplet_arg ? MusicalScore::Note::Notation::Tuplet.new(tuplet_arg) : nil
+                    return MusicalScore::Note::Notation::Notation.new(articulation: articulation, dynamics: dynamics, tie: tie, tuplet: tuplet)
+                end
+
                 def export_xml
                     notations_element    = REXML::Element.new('notations')
                     articulation_element = REXML::Element.new('articulations')

data/lib/musical_score/note/note.rb

@@ -113,6 +113,26 @@ module MusicalScore
                 end
             end
 
+            Contract HashOf[String => Any] => MusicalScore::Note::Note
+            def self.create_by_hash(doc)
+                dots     = doc.has_key?("dot") ? doc["dot"].size : 0
+                duration = doc["duration"][0].to_i
+                type     = MusicalScore::Note::Type.new(doc["type"][0])
+                tie      = doc.has_key?("tie") ? doc.dig("tie", 0, "type").to_sym : nil
+                notation = doc.has_key?("notations") ? MusicalScore::Note::Notation::Notation.create_by_hash(doc["notations"][0]) : nil
+                time_modification = doc.has_key?("time-modification") ? MusicalScore::Note::TimeModification.create_by_hash(doc["time-modification"][0]) : nil
+                rest = doc.has_key?("rest")
+
+                if (rest)
+                    return MusicalScore::Note::Note.new(duration: duration, tie: tie, dot: dots, rest: rest, type: type, time_modification: time_modification, notation: notation)
+                else
+                    pitch = MusicalScore::Note::Pitch.create_by_hash(doc["pitch"][0])
+                    lyric = doc.has_key?("lyric") ? MusicalScore::Note::Lyric.create_by_hash(doc["lyric"][0]) : nil
+                    return MusicalScore::Note::Note.new(duration: duration, tie: tie, dot: dots, type: type, lyric: lyric, pitch: pitch, time_modification: time_modification, notation: notation)
+                end
+
+            end
+
             def export_xml
                 note_element = REXML::Element.new('note')
                 note_element.add_element('rest') if @rest

data/lib/musical_score/note/pitch.rb

@@ -100,6 +100,14 @@ module MusicalScore
                 return MusicalScore::Note::Pitch.new(step, alter, octave)
             end
 
+            Contract HashOf[String => Any] => MusicalScore::Note::Pitch
+            def self.create_by_hash(doc)
+                step   = doc["step"][0].to_sym
+                octave = doc["octave"][0].to_i
+                alter  = doc.has_key?("alter") ? doc["alter"][0].to_i : 0
+                return MusicalScore::Note::Pitch.new(step, alter, octave)
+            end
+
             def export_xml
                 pitch_element  = REXML::Element.new('pitch')
                 step_element   = REXML::Element.new('step').add_text(@step.to_s)

data/lib/musical_score/note/time_modification.rb

@@ -18,6 +18,13 @@ module MusicalScore
                 return MusicalScore::Note::TimeModification.new(actual_notes, normal_notes)
             end
 
+            Contract HashOf[String => Any] => MusicalScore::Note::TimeModification
+            def self.create_by_hash(doc)
+                actual_notes = doc["actual-notes"][0].to_i
+                normal_notes = doc["normal-notes"][0].to_i
+                return MusicalScore::Note::TimeModification.new(actual_notes, normal_notes)
+            end
+
             def export_xml
                 time_modification_element = REXML::Element.new('time-modification')
                 actual_notes_element      = REXML::Element.new('actual-notes').add_text(@actual_notes.to_s)
@@ -30,4 +37,4 @@ module MusicalScore
             end
         end
     end
-end
+end

data/lib/musical_score/part/measure.rb

@@ -29,6 +29,19 @@ module MusicalScore
                 return MusicalScore::Part::Measure.new(notes, number, attributes)
             end
 
+            Contract HashOf[String => Any] => MusicalScore::Part::Measure
+            def self.create_by_hash(doc)
+                number = doc["number"].to_i
+                attributes = doc.has_key?("attributes") ? MusicalScore::Attribute::Attribute.create_by_hash(doc["attributes"][0]) : nil
+                note_array = Array.new
+                doc["note"].each do |element|
+                    note = MusicalScore::Note::Note.create_by_hash(element)
+                    note_array.push(note)
+                end
+                notes = MusicalScore::Notes.new(note_array)
+                return MusicalScore::Part::Measure.new(notes, number, attributes)
+            end
+
             def export_xml
                 measure_element = REXML::Element.new('measure')
                 measure_element.add_attribute('number',@number.to_s)

data/lib/musical_score/part/part.rb

@@ -26,6 +26,17 @@ module MusicalScore
                 return MusicalScore::Part::Part.new(measures)
             end
 
+            Contract HashOf[String => Any] => MusicalScore::Part::Part
+            def self.create_by_hash(doc)
+                measure_array = Array.new
+                doc["measure"].each do |element|
+                    measure = MusicalScore::Part::Measure.create_by_hash(element)
+                    measure_array.push(measure)
+                end
+                measures = MusicalScore::Measures.new(measure_array)
+                return MusicalScore::Part::Part.new(measures)
+            end
+
             def export_xml(number)
                 part = REXML::Element.new('part')
                 part.add_attribute('id', "P" + number.to_s)

data/lib/musical_score/score/identification/creator.rb

@@ -17,6 +17,14 @@ module MusicalScore
                     name = xml_doc.text
                     return MusicalScore::Score::Identification::Creator.new(name, type)
                 end
+
+                Contract HashOf[String => Any] => MusicalScore::Score::Identification::Creator
+                def self.create_by_hash(doc)
+                    type = doc["type"].to_sym
+                    name = doc["content"]
+                    return MusicalScore::Score::Identification::Creator.new(name, type)
+                end
+
                 def export_xml
                     creator = REXML::Element.new('creator')
                     creator.add_attribute('type', @type)

data/lib/musical_score/score/identification/encoding.rb

@@ -36,6 +36,28 @@ module MusicalScore
                     return MusicalScore::Score::Identification::Encoding.new(encoding_date, encoding_description, softwares, supports)
                 end
 
+                Contract HashOf[String => Any] => MusicalScore::Score::Identification::Encoding
+                def self.create_by_hash(doc)
+                    encoding_date = Time.new
+                    if (doc.has_key?("encoding-date"))
+                        encoding_date = Time.parse(doc["encoding-date"][0])
+                    end
+                    encoding_description = doc.has_key?("encoding_description") ? doc["encoding_date"] : ''
+                    softwares = Array.new
+                    if doc.has_key?("software")
+                        doc["software"].each do |element|
+                            softwares.push(element)
+                        end
+                    end
+                    supports = Array.new
+                    doc["supports"].each do |element|
+                        if (element["type"] == "yes")
+                            supports.push(element["element"])
+                        end
+                    end
+                    return MusicalScore::Score::Identification::Encoding.new(encoding_date, encoding_description, softwares, supports)
+                end
+
                 def export_xml
                     encoding = REXML::Element.new('encoding')
                     @softwares.each do |software|

data/lib/musical_score/score/identification/identification.rb

@@ -32,6 +32,18 @@ module MusicalScore
                     return MusicalScore::Score::Identification::Identification.new(creators, encoding)
                 end
 
+                Contract HashOf[String => Any] => MusicalScore::Score::Identification::Identification
+                def self.create_by_hash(doc)
+                    creators = Array.new
+                    if (doc.has_key?("creator"))
+                        doc["creator"].each do |element|
+                            creators.push(MusicalScore::Score::Identification::Creator.create_by_hash(element))
+                        end
+                    end
+                    encoding = doc.has_key?("encoding") ? MusicalScore::Score::Identification::Encoding.create_by_hash(doc["encoding"][0]) : nil
+                    return MusicalScore::Score::Identification::Identification.new(creators, encoding)
+                end
+
                 def export_xml
                     identification = REXML::Element.new('identification')
                     @creators.each do |creator|

data/lib/musical_score/score/score.rb

@@ -72,7 +72,43 @@ module MusicalScore
                 return MusicalScore::Score::Score.new(args)
             end
 
-            def export_xml(path)
+            Contract HashOf[String => Any], Maybe[String] => MusicalScore::Score::Score
+            def self.create_by_hash(doc, file_path)
+                args = {}
+                args[:file_path] = file_path
+
+                if doc.has_key?("identification")
+                    identification = MusicalScore::Score::Identification::Identification.create_by_hash(doc["identification"][0])
+                    args[:identification] = identification
+                end
+
+                credits = Array.new
+                doc["credit"].each do |element|
+                    if (element.has_key?("credit-words"))
+                        credits.push(element.dig("credit-words", 0, "content"))
+                    end
+                end
+                args[:credits] = credits
+
+                part_list = Array.new
+                doc.dig("part-list", 0, "score-part").each do |element|
+                    part_name         = element["part-name"][0]
+                    part_abbreviation = element["part-abbreviation"][0]
+                    part = MusicalScore::Score::Part::Part.new(part_name, part_abbreviation)
+                    part_list.push(part)
+                end
+                args[:part_list] = part_list
+
+                parts = Array.new
+                doc["part"].each do |element|
+                    part = MusicalScore::Part::Part.create_by_hash(element)
+                    parts.push(part)
+                end
+                args[:parts] = parts
+                return MusicalScore::Score::Score.new(args)
+            end
+
+            def export_xml()
                 doc = REXML::Document.new
                 doc << REXML::XMLDecl.new('1.0', 'UTF-8')
                 doc << REXML::Document.new(<<-EOS).doctype
@@ -108,12 +144,7 @@ module MusicalScore
 
                 doc.add_element(score_partwise)
 
-                xml = ''
-                formatter = REXML::Formatters::Pretty.new(4)
-                formatter.compact = true
-                formatter.write(doc, xml)
-
-                # puts xml
+                return doc
             end
 
             def set_location

data/lib/musical_score/version.rb

@@ -1,4 +1,4 @@
 module MusicalScore
-  VERSION  = "0.1.0"
+  VERSION  = "0.1.1"
   APP_NAME = "MusicalScore"
 end

data/musical_score.gemspec

@@ -34,9 +34,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.1"
-  spec.add_development_dependency "fuubar"
   spec.add_development_dependency "yard"
   spec.add_development_dependency "yard-contracts"
 
   spec.add_dependency "contracts"
+  spec.add_dependency "xml-simple"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: musical_score
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Yuma Ito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-19 00:00:00.000000000 Z
+date: 2016-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: fuubar
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: yard-contracts
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,13 +81,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard-contracts
+  name: contracts
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: contracts
+  name: xml-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,6 +136,7 @@ files:
 - lib/musical_score/const.rb
 - lib/musical_score/element_base.rb
 - lib/musical_score/errors.rb
+- lib/musical_score/io/exporter.rb
 - lib/musical_score/io/importer.rb
 - lib/musical_score/location.rb
 - lib/musical_score/measures.rb