stringyfi 0.0.1

data/spec/spec_helper.rb

@@ -0,0 +1,85 @@
+require 'stringyfi'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

data/spec/support/fixtures_helper.rb

@@ -0,0 +1,14 @@
+module FixturesHelper
+
+  def xml_sample_path(name='chromatic.xml')
+    File.join(xml_samples_path, name)
+  end
+
+  def xml_samples_path
+    "#{File.dirname(__FILE__)}/../fixtures/music_xml"
+  end
+end
+
+RSpec.configure do |conf|
+  conf.include FixturesHelper
+end

data/spec/unit/converter_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+
+describe StringyFi::Converter do
+  subject(:converter) { described_class.new(filename) }
+
+  context "with chromatic.xml sample" do
+    let(:filename) { xml_sample_path }
+
+    describe "#xml_doc" do
+      subject { converter.xml_doc }
+      it "returns the XML doc" do
+        expect(subject).to be_a(Nokogiri::XML::Document)
+      end
+    end
+
+    describe "#identification" do
+      subject(:identification) { converter.identification }
+      it "returns expected metadata" do
+        expect(subject).to eql({
+          title: "chromatic scale",
+          encoding: {
+            date: "2017-10-15",
+            software: "Guitar Pro 7.0.6"
+          }
+        })
+      end
+    end
+
+    describe "#part_list" do
+      subject(:part_list) { converter.part_list }
+      it "returns an array of parts" do
+        expect(part_list).to eql([
+          {id: "P1"}
+        ])
+      end
+    end
+
+    describe "#parts" do
+      subject(:parts) { converter.parts }
+      it "returns parts corresponding to parts list" do
+        expect(parts.count).to eql(converter.part_list.count)
+      end
+    end
+
+    describe "#measures" do
+      subject(:measures) { converter.measures }
+      it "has the correct number of measures" do
+        expect(measures).to be_a(StringyFi::Measures)
+        expect(measures.count).to eql(7)
+      end
+    end
+
+    describe "#measure" do
+      subject(:measure) { converter.measure(measure_id) }
+      context "with first measure" do
+        let(:measure_id) { 0 }
+        it "has the correct note info" do
+          expect(measure).to be_an(Array)
+          expect(measure.size).to eql(1)
+          expect(measure[0]).to be_a(StringyFi::Note)
+          expect(measure[0].to_str).to eql("3:E:0")
+        end
+      end
+    end
+
+    describe "#score_preamble" do
+      subject { converter.score_preamble }
+      it "includes the expected identification" do
+        expect(subject).to include(';** Title: chromatic scale')
+      end
+      it "includes the tstart" do
+        expect(subject).to include("\ttstart DemoTune")
+      end
+    end
+
+    describe "#score_coda" do
+      subject { converter.score_coda }
+      it "includes a rest and tstop" do
+        expect(subject).to include("\ttrest 8")
+        expect(subject).to include("\ttstop")
+      end
+    end
+
+    describe "#score_body" do
+      subject { converter.score_body(1/32.0) }
+      it "returns the expected conversion" do
+        expect(subject).to eql([
+          "\t; measure 1",
+          "\ttoctave -1",
+          "\ttnote E1,4,0  ; 3:E:0",
+          "\t; measure 2",
+          "\ttnote F1,4,0  ; 3:F:0",
+          "\ttnote F1S,4,0  ; 3:F:1",
+          "\t; measure 3",
+          "\ttnote G1,4,0  ; 3:G:0",
+          "\ttnote A1,4,0  ; 3:A:0",
+          "\ttnote A1S,4,0  ; 3:A:1",
+          "\ttnote B1,4,0  ; 3:B:0",
+          "\t; measure 4",
+          "\ttoctave +1",
+          "\ttnote C1,4,0  ; 4:C:0",
+          "\ttnote C1S,4,0  ; 4:C:1",
+          "\ttnote D1,4,0  ; 4:D:0",
+          "\ttnote D1S,4,0  ; 4:D:1",
+          "\t; measure 5",
+          "\ttnote E1,3,0  ; 4:E:0",
+          "\ttnote F1,3,0  ; 4:F:0",
+          "\ttnote F1S,3,0  ; 4:F:1",
+          "\ttnote G1,3,0  ; 4:G:0",
+          "\ttnote G1S,3,0  ; 4:G:1",
+          "\ttnote A1,3,0  ; 4:A:0",
+          "\ttnote A1S,3,0  ; 4:A:1",
+          "\ttnote B1,3,0  ; 4:B:0",
+          "\t; measure 6",
+          "\ttoctave +1",
+          "\ttnote C1,2,0  ; 5:C:0",
+          "\ttnote C1S,2,0  ; 5:C:1",
+          "\ttnote D1,2,0  ; 5:D:0",
+          "\ttnote D1S,2,0  ; 5:D:1",
+          "\ttnote E1,2,0  ; 5:E:0",
+          "\ttnote F1,2,0  ; 5:F:0",
+          "\ttnote F1S,2,0  ; 5:F:1",
+          "\ttnote G1,2,0  ; 5:G:0",
+          "\ttnote G1S,2,0  ; 5:G:1",
+          "\ttnote A1,2,0  ; 5:A:0",
+          "\ttnote A1S,2,0  ; 5:A:1",
+          "\ttnote B1,2,0  ; 5:B:0",
+          "\ttoctave +1",
+          "\ttnote C1,2,0  ; 6:C:0",
+          "\ttnote C1S,2,0  ; 6:C:1",
+          "\ttnote D1,2,0  ; 6:D:0",
+          "\ttnote D1S,2,0  ; 6:D:1",
+          "\t; measure 7",
+          "\ttnote E1,1,0  ; 6:E:0",
+          "\ttnote F1,1,0  ; 6:F:0",
+          "\ttnote F1S,1,0  ; 6:F:1",
+          "\ttnote G1,1,0  ; 6:G:0",
+          "\ttnote G1S,1,0  ; 6:G:1",
+          "\ttnote A1,1,0  ; 6:A:0",
+          "\ttnote A1S,1,0  ; 6:A:1",
+          "\ttnote B1,1,0  ; 6:B:0",
+          "\ttoctave +1",
+          "\ttnote C1,1,0  ; 7:C:0",
+          "\ttnote C1S,1,0  ; 7:C:1",
+          "\ttnote D1,1,0  ; 7:D:0",
+          "\ttnote D1S,1,0  ; 7:D:1",
+          "\ttnote E1,4,0  ; 7:E:0",
+          "\ttnote E1,4,0  ; 7:E:0"
+        ])
+      end
+    end
+
+    describe "#convert!" do
+      subject { converter.convert! }
+      it "calls all the necessary bits" do
+        expect(converter).to receive(:score_preamble)
+        expect(converter).to receive(:score_body)
+        expect(converter).to receive(:score_coda)
+        expect($stderr).to receive(:puts).exactly(4).times
+        expect($stdout).to receive(:puts).exactly(3).times
+        subject
+      end
+    end
+
+  end
+end

data/spec/unit/measures_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe StringyFi::Measures do
+
+  let(:note_class) { StringyFi::Note }
+  let(:measures) { described_class.new }
+
+  before do
+    measures << [
+      note_class.new('G', 4, 1, 1, "half"),
+      note_class.new('G', 2, 0, 1, "quarter")
+    ]
+    measures << [
+      note_class.new('G', 3, 0, 1, "whole"),
+      note_class.new('A', 4, 0, 1, "32nd"),
+      note_class.new('G', 4, 1, 1, "eighth")
+    ]
+  end
+
+  describe "#shortest_fractional_duration" do
+    subject { measures.shortest_fractional_duration }
+    it "returns the shortest of any note" do
+      expect(subject).to eql(1/32.0)
+    end
+  end
+
+  describe "#octave_range" do
+    subject { measures.octave_range }
+    it "returns the lowest and highest as an array" do
+      expect(subject).to eql([2, 4])
+    end
+  end
+
+end

data/spec/unit/note_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe StringyFi::Note do
+
+  let(:name) { 'G' }
+  let(:octave) { '4' }
+  let(:alter) { nil }
+  let(:duration) { 1 }
+  let(:duration_type) { "quarter" }
+  subject(:note) { described_class.new(name, octave, alter, duration, duration_type) }
+
+
+  describe "#stringy_durations" do
+    subject { note.stringy_durations(shortest_fractional_duration)}
+    context "when quarter is shortest" do
+      let(:shortest_fractional_duration) { 1/4.0 }
+      [
+        {duration: 1, duration_type: "quarter", expect: [1, 0, 0, 0]},
+        {duration: 2, duration_type: "quarter", expect: [0, 1, 0, 0]},
+        {duration: 3, duration_type: "quarter", expect: [0, 1, 0, 0]},
+        {duration: 4, duration_type: "quarter", expect: [0, 0, 1, 0]},
+        {duration: 5, duration_type: "quarter", expect: [0, 0, 1, 0]},
+        {duration: 6, duration_type: "quarter", expect: [0, 0, 1, 0]},
+        {duration: 7, duration_type: "quarter", expect: [0, 0, 1, 0]},
+        {duration: 1, duration_type: "half",    expect: [0, 1, 0, 0]},
+        {duration: 4, duration_type: "half",    expect: [0, 0, 0, 1]},
+        {duration: 1, duration_type: "whole",   expect: [0, 0, 1, 0]},
+        {duration: 2, duration_type: "whole",   expect: [0, 0, 0, 1]},
+      ].each do |options|
+        context "and duration=#{options[:duration]}-#{options[:duration_type]}" do
+          let(:duration) { options[:duration] }
+          let(:duration_type) { options[:duration_type] }
+          it "returns expected repeats/remainder" do
+            expect(subject).to eql(options[:expect])
+          end
+        end
+      end
+    end
+    context "when 32nd is shortest" do
+      let(:shortest_fractional_duration) { 1/32.0 }
+      [
+        {duration: 1, duration_type: "32nd",    expect: [1, 0, 0, 0]},
+        {duration: 1, duration_type: "quarter", expect: [0, 0, 0, 1]},
+      ].each do |options|
+        context "and duration=#{options[:duration]}-#{options[:duration_type]}" do
+          let(:duration) { options[:duration] }
+          let(:duration_type) { options[:duration_type] }
+          it "returns expected repeats/remainder" do
+            expect(subject).to eql(options[:expect])
+          end
+        end
+      end
+    end
+  end
+
+  describe "#to_s" do
+    subject { note.to_s }
+    context "when not altered" do
+      it { should eql('G')}
+    end
+    context "when altered up" do
+      let(:alter) { 1 }
+      it { should eql('G#')}
+    end
+    context "when altered down" do
+      let(:alter) { -1 }
+      it { should eql('Gb')}
+    end
+  end
+
+  describe "#to_str" do
+    subject { note.to_str }
+    context "when not altered" do
+      it { should eql('4:G:0')}
+    end
+    context "when altered up" do
+      let(:alter) { 1 }
+      it { should eql('4:G:1')}
+    end
+    context "when altered down" do
+      let(:alter) { -1 }
+      it { should eql('4:G:-1')}
+    end
+  end
+
+  describe "#<=>" do
+    let(:other_name) { name }
+    let(:other_octave) { octave }
+    let(:other_alter) { alter }
+    let(:other_note) { described_class.new(other_name, other_octave, other_alter) }
+
+    subject { note <=> other_note }
+    context "when same" do
+      it { should eql(0) }
+    end
+    context "when vary by alter up" do
+      let(:other_alter) { 1 }
+      it { should eql(-1) }
+    end
+    context "when vary by octave down" do
+      let(:other_octave) { 3 }
+      it { should eql(1) }
+    end
+  end
+
+end

data/spec/unit/shell_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe StringyFi::Shell do
+  subject(:shell) { described_class.new }
+
+  context "when no args passed" do
+    it "initialises with sample fixture" do
+      expect(subject).to be_a(described_class)
+      expect(subject.converter.filename).to include("chromatic.xml")
+    end
+  end
+end

data/spec/unit/version_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe StringyFi do
+
+  it "has a version" do
+    expect(described_class::VERSION).to match(/\d+\.\d+\.\d+/)
+  end
+
+end

data/stringyfi.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stringyfi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stringyfi"
+  spec.version       = StringyFi::VERSION
+  spec.authors       = ["Paul Gallagher"]
+  spec.email         = ["gallagher.paul@gmail.com"]
+  spec.summary       = "Convert MusicXML to PIC assembler for the Boldport Stringy"
+  spec.homepage      = "https://github.com/tardate/stringyfi"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "nokogiri", "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  # guard versions are pegged to avoid issue with ruby_dep requires Ruby version >= 2.2.5, ~> 2.2.
+  spec.add_development_dependency "guard-rspec", "4.6.4"
+  spec.add_development_dependency "rb-fsevent", "0.9.6"
+  spec.add_development_dependency "rb-inotify", "0.9.5"
+  spec.add_development_dependency "pry-coolline", "0.2.5" # avoid readline dependency
+end