jekyll-lilypond 0.1.1

data/spec/file_processor_spec.rb

@@ -0,0 +1,167 @@
+require "jekyll-lilypond"
+require "spec_helper"
+require "tmpdir"
+include Liquid
+
+RSpec.shared_context 'temp_dir' do
+  around do |example|
+    Dir.mktmpdir do |dir|
+      @temp_dir = dir
+      example.run
+    end
+  end
+
+  attr_reader :temp_dir
+
+  let(:source) { '\version "2.14.1" { c d e f g a b c }' }
+  let(:hash) { "99cef9f0865c2c21ba7b5b00d1092f61" }
+  let(:sourcepath) { "#{@temp_dir}/99cef9f0865c2c21ba7b5b00d1092f61.ly" }
+  let(:svgpath) { "#{@temp_dir}/99cef9f0865c2c21ba7b5b00d1092f61.svg" }
+  let(:barepath) { "#{@temp_dir}/99cef9f0865c2c21ba7b5b00d1092f61" }
+end
+
+RSpec.describe(Jekyll::Lilypond::FileProcessor) do
+  include_context 'temp_dir'
+
+  context "initialization" do
+    it "works if the working dir exists" do
+      expect { described_class.new(@temp_dir, hash, source) }.not_to raise_error
+    end
+    it "works even if the working dir is in a deeply nested path" do
+      path = "#{@temp_dir}/foo/bar/baz/whatever"
+      FileUtils.mkdir_p(path)
+      expect { described_class.new(path, hash, source) }.not_to raise_error
+    end
+  end
+
+  context "writing" do
+    it "creates a file at the expected location" do
+      file_processor = described_class.new(@temp_dir, hash, source)
+      file_processor.write
+      expect(File.file?(sourcepath)).to eq(true)
+    end
+    it "populates that file with the right source" do
+      file_processor = described_class.new(@temp_dir, hash, source)
+      file_processor.write
+      expect(File.open(sourcepath).read).to eq(source)
+    end
+    it "doesn't overwrite an existing source file with the same name" do
+      File.open(sourcepath, "w") do |f|
+        f.write("This should not be overwritten")
+      end
+      file_processor = described_class.new(@temp_dir, hash, source)
+      file_processor.write
+      expect(File.open(sourcepath).read).to eq("This should not be overwritten")
+    end
+    it "creates the working directory if it does not exist" do
+      path = "#{@temp_dir}/foo/bar/baz/whatever"
+      expect { 
+        fp = described_class.new(path, hash, source) 
+        fp.write
+      }.not_to raise_error
+      expect(File.exists?(path)).to eq(true)
+    end
+  end
+
+  context "compiling" do
+    it "results in an svg file" do
+      file_processor = described_class.new(@temp_dir, hash, source)
+      file_processor.write
+      file_processor.compile
+      expect(File.exist?(svgpath)).to eq(true)
+    end
+    it "doesn't call lilypond if the target svg exists" do
+      File.open(svgpath, "w") do |f|
+        f.write("This should not be overwritten")
+      end
+      file_processor = described_class.new(@temp_dir, hash, source)
+      file_processor.write
+      file_processor.compile
+      expect(File.open(svgpath).read).to eq("This should not be overwritten")
+    end
+  end
+  context "trimming" do
+    it "results in an svg file" do
+      file_processor = described_class.new(@temp_dir, hash, source)
+      file_processor.write
+      file_processor.compile
+      file_processor.trim_svg
+      expect(File.exist?(svgpath)).to eq(true)
+    end
+    it "raises an error if the target svg does not exist" do
+      file_processor = described_class.new(@temp_dir, hash, source)
+      expect { file_processor.trim_svg }.to raise_error(RuntimeError)
+    end
+  end
+  context "integration with lilypond" do
+    it "puts output in the target directory even if it's deeply nested" do
+      path = "#{@temp_dir}/foo/bar/baz/whatever"
+      FileUtils.mkdir_p(path)
+      file_processor = described_class.new(path, hash, source)
+      file_processor.write
+      file_processor.compile
+      expect(File.exist?("#{path}/#{hash}.svg")).to eq(true)
+    end
+  end
+end
+
+RSpec.shared_context 'temp_dir_with_midi' do
+  around do |example|
+    Dir.mktmpdir do |dir|
+      @temp_dir = dir
+      example.run
+    end
+  end
+
+  attr_reader :temp_dir
+
+  let(:source) { '\version "2.14.1" \score { { c d e f g a b c } \midi { } }' }
+  let(:hash) { "f95206924ddb60916690c047a2345b87" }
+  let(:sourcepath) { "#{@temp_dir}/f95206924ddb60916690c047a2345b87.ly" }
+  let(:svgpath) { "#{@temp_dir}/f95206924ddb60916690c047a2345b87.svg" }
+  let(:mp3path) { "#{@temp_dir}/f95206924ddb60916690c047a2345b87.mp3" }
+  let(:barepath) { "#{@temp_dir}/f95206924ddb60916690c047a2345b87" }
+end
+
+RSpec.describe(Jekyll::Lilypond::FileProcessor) do
+  include_context 'temp_dir_with_midi'
+
+  context "making mp3" do
+    it "results in an mp3 file" do
+      file_processor = described_class.new(@temp_dir, hash, source)
+      file_processor.write
+      file_processor.compile
+      file_processor.make_mp3
+      expect(File.exist?(mp3path)).to eq(true)
+    end
+    it "doesn't touch a target mp3 that already exists" do
+      File.open(mp3path, "w") do |f|
+        f.write("This should not be overwritten")
+      end
+      file_processor = described_class.new(@temp_dir, hash, source)
+      file_processor.write
+      file_processor.compile
+      file_processor.make_mp3
+      expect(File.open(mp3path).read).to eq("This should not be overwritten")
+    end
+    it "errors sensibly if its midi dependency doesn't exist" do
+      file_processor = described_class.new(@temp_dir, hash, source)
+      expect { file_processor.make_mp3 }.to raise_error(RuntimeError)
+    end
+  end
+
+  context "integration with lilypond" do
+    it "puts output in the target directory even if it's deeply nested" do
+      path = "#{@temp_dir}/foo/bar/baz/whatever"
+      FileUtils.mkdir_p(path)
+      file_processor = described_class.new(path, hash, source)
+      file_processor.write
+      file_processor.compile
+      expect(File.exist?("#{path}/#{hash}.midi")).to eq(true)
+    end
+  end
+  #To do: Error handling
+  #To do: Flexible lilypond invocation
+  #To do: Do lilypond's products end up in the right place?
+end
+

data/spec/fixtures/.gitignore

@@ -0,0 +1,5 @@
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor

data/spec/fixtures/404.html

@@ -0,0 +1,25 @@
+---
+permalink: /404.html
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

data/spec/fixtures/Gemfile

@@ -0,0 +1,31 @@
+source "https://rubygems.org"
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "~> 4.2.0"
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.5"
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.12"
+  gem "jekyll-lilypond", path: "../.."
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", "~> 1.2"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+

data/spec/fixtures/_config.yml

@@ -0,0 +1,56 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+#
+# If you need help with YAML syntax, here are some quick references for you: 
+# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
+# https://learnxinyminutes.com/docs/yaml/
+#
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+
+title: Your awesome title
+email: your-email@example.com
+description: >- # this means to ignore newlines until "baseurl:"
+  Write an awesome description for your new site here. You can edit this
+  line in _config.yml. It will appear in your document head meta (for
+  Google search results) and in your feed.xml site description.
+baseurl: "" # the subpath of your site, e.g. /blog
+url: "" # the base hostname & protocol for your site, e.g. http://example.com
+twitter_username: jekyllrb
+github_username:  jekyll
+
+# Build settings
+theme: minima
+plugins:
+  - jekyll-feed
+  - jekyll-lilypond
+
+# Exclude from processing.
+# The following items will not be processed, by default.
+# Any item listed under the `exclude:` key here will be automatically added to
+# the internal "default list".
+#
+# Excluded items can be processed by explicitly listing the directories or
+# their entries' file path in the `include:` list.
+#
+# exclude:
+#   - .sass-cache/
+#   - .jekyll-cache/
+#   - gemfiles/
+#   - Gemfile
+#   - Gemfile.lock
+#   - node_modules/
+#   - vendor/bundle/
+#   - vendor/cache/
+#   - vendor/gems/
+#   - vendor/ruby/

data/spec/fixtures/_layouts/basic_html.html

@@ -0,0 +1 @@
+<img src='{{ filename }}.png'>

data/spec/fixtures/_layouts/vacuous_html.html

@@ -0,0 +1 @@
+{{- content -}}

data/spec/fixtures/_layouts/vacuous_ly.ly

@@ -0,0 +1 @@
+{ {{ content }} }

data/spec/fixtures/_layouts/variables_html.html

@@ -0,0 +1 @@
+{{- a }} {{ content }} {{ b -}}

data/spec/fixtures/_layouts/variables_ly.ly

@@ -0,0 +1 @@
+{{- a }} {{ content }} {{ b -}}

data/spec/fixtures/_posts/2021-01-16-welcome-to-jekyll.markdown

@@ -0,0 +1,29 @@
+---
+layout: post
+title:  "Welcome to Jekyll!"
+date:   2021-01-16 16:01:22 -0500
+categories: jekyll update
+---
+You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
+
+Jekyll requires blog post files to be named according to the following format:
+
+`YEAR-MONTH-DAY-title.MARKUP`
+
+Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit numbers, and `MARKUP` is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works.
+
+Jekyll also offers powerful support for code snippets:
+
+{% highlight ruby %}
+def print_hi(name)
+  puts "Hi, #{name}"
+end
+print_hi('Tom')
+#=> prints 'Hi, Tom' to STDOUT.
+{% endhighlight %}
+
+Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk].
+
+[jekyll-docs]: https://jekyllrb.com/docs/home
+[jekyll-gh]:   https://github.com/jekyll/jekyll
+[jekyll-talk]: https://talk.jekyllrb.com/

data/spec/fixtures/about.markdown

@@ -0,0 +1,18 @@
+---
+layout: page
+title: About
+permalink: /about/
+---
+
+This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/)
+
+You can find the source code for Minima at GitHub:
+[jekyll][jekyll-organization] /
+[minima](https://github.com/jekyll/minima)
+
+You can find the source code for Jekyll at GitHub:
+[jekyll][jekyll-organization] /
+[jekyll](https://github.com/jekyll/jekyll)
+
+
+[jekyll-organization]: https://github.com/jekyll

data/spec/fixtures/index.markdown

@@ -0,0 +1,6 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: home
+---

data/spec/fixtures/page.md

@@ -0,0 +1,8 @@
+---
+title: Test Page
+layout: default
+---
+
+Test test
+
+Content content

data/spec/integration_spec.rb

@@ -0,0 +1,115 @@
+require "jekyll"
+require "jekyll-lilypond"
+require "spec_helper"
+require "tmpdir"
+
+RSpec.describe(Jekyll::Lilypond) do
+  around(:each) do |example|
+    Dir.mktmpdir do |dir| 
+      @temp_dir = dir
+      @test_page = "#{@temp_dir}/test_page.md"
+      @dest_page = "#{dest_dir}/test_page.html"
+      FileUtils.cp_r("spec/fixtures/.", @temp_dir)
+      File.open(@test_page, "w") { |f| f.write(test_page_contents) } 
+      example.run
+    end
+  end
+
+  let(:overrides) { {} }
+  let(:config) do
+    Jekyll.configuration(Jekyll::Utils.deep_merge_hashes({
+      "full_rebuild" => true,
+      "source"       => @temp_dir,
+      "destination"  => dest_dir,
+      "show_drafts"  => false,
+      "url"          => "http://example.org",
+      "name"         => "My awesome site",
+      "author"       => {
+        "name" => "Dr. Jekyll",
+      },
+      "collections"  => {
+        "my_collection" => { "output" => true },
+        "other_things"  => { "output" => false },
+      },
+    }, overrides))
+  end
+  let(:site)     { Jekyll::Site.new(config) }
+  let(:context)  { make_context(:site => site) }
+
+
+  context "somethingorother" do
+    let(:test_page_contents) { 
+<<-MD
+---
+layout: home
+---
+foobledooble
+MD
+}
+    it "works" do
+      expect(File).to exist(@test_page)
+      site.process
+      expect(File.read(@dest_page)).to include("foobledooble")
+    end
+  end
+
+  context "used with the vacuous template" do
+    let(:test_page_contents) { 
+<<-MD
+---
+layout: vacuous_html
+---
+Test test test
+{% lilypond source_template_code: "{ {{ content }} }", 
+            include_template_code: '<img src="{{ filename }}.svg" />' %}
+c d e f g a b c
+{% endlilypond %}
+Test test test
+MD
+}
+    before(:each) do site.process end
+    it "doesn't just emit the tag contents" do
+      expect(File.read(@dest_page)).not_to include("c d e f g a b c")
+    end
+    it "produces a SVG in the source tree" do
+      expect(File).to exist("#{@temp_dir}/lilypond_files/a5b1d61f70473f0247629a66cfc50e52.svg")
+    end
+    it "produces a SVG in the destination tree" do
+      expect(File).to exist("#{dest_dir}/lilypond_files/a5b1d61f70473f0247629a66cfc50e52.svg")
+    end
+    it "produces an image element in the rendered page" do
+      expect(File.read(@dest_page)).to include('<img src="a5b1d61f70473f0247629a66cfc50e52.svg" />')
+    end
+  end
+
+  context "used with the vacuous template" do
+    let(:test_page_contents) { 
+<<-MD
+---
+layout: vacuous_html
+---
+Test test test
+{% lilypond source_template: "vacuous_ly", 
+            include_template_code: '<img src="{{ filename }}.svg" />' %}
+c d e f g a b c
+{% endlilypond %}
+Test test test
+MD
+}
+    before(:each) do site.process end
+    it "doesn't just emit the tag contents" do
+      expect(File.read(@dest_page)).not_to include("c d e f g a b c")
+    end
+    it "produces a SVG in the source tree" do
+      expect(File).to exist("#{@temp_dir}/lilypond_files/a5b1d61f70473f0247629a66cfc50e52.svg")
+    end
+    it "produces a SVG in the destination tree" do
+      expect(File).to exist("#{dest_dir}/lilypond_files/a5b1d61f70473f0247629a66cfc50e52.svg")
+    end
+    it "produces an image element in the rendered page" do
+      expect(File.read(@dest_page)).to include('<img src="a5b1d61f70473f0247629a66cfc50e52.svg" />')
+    end
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,88 @@
+require 'simplecov'
+SimpleCov.start
+
+require "jekyll"
+require "jekyll-lilypond"
+
+RSpec.configure do |config|
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  #https://ayastreb.me/writing-a-jekyll-plugin/ from here on down
+  SOURCE_DIR = File.expand_path("../fixtures", __FILE__)
+  DEST_DIR   = File.expand_path("../dest", __FILE__)
+
+  def source_dir(*files)
+    File.join(SOURCE_DIR, *files)
+  end
+
+  def dest_dir(*files)
+    File.join(DEST_DIR, *files)
+  end
+
+  def make_context(registers = {})
+    Liquid::Context.new({}, {}, { :site => site }.merge(registers))
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows 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. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = 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
+=end
+end