jekyll-lilypond-converter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5f177cb881ed3ffe14dc792e6b4a7e977f52c63
+  data.tar.gz: f95a2466a47ae5b05e4a840d1165b8ab0a116836
+SHA512:
+  metadata.gz: db985a70e7b851de222f26d9fa3fd61aeb6fe8cd0c5e4b16d756ec2b153fcb75af0a0634ca535e3cf27c93dfd3313071f5e55c6d3f9276b4158f3be178ace649
+  data.tar.gz: fb67ac2e237bf9be7733d4e43933073d896f5fb897dfb19acf1af42e9b36f57869c9c4701380da5aacc5ee3eb89feee708c2a882280baa06dbe80e5de15535da

data/.rspec

@@ -0,0 +1 @@
+--order random

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    jekyll-lilypond-converter (0.1.0)
+      jekyll (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    colorator (1.1.0)
+    diff-lcs (1.3)
+    ffi (1.9.18)
+    forwardable-extended (2.6.0)
+    jekyll (3.5.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (~> 1.7)
+      safe_yaml (~> 1.0)
+    jekyll-sass-converter (1.5.0)
+      sass (~> 3.4)
+    jekyll-watch (1.5.0)
+      listen (~> 3.0, < 3.1)
+    kramdown (1.14.0)
+    liquid (4.0.0)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    mercenary (0.3.6)
+    pathutil (0.14.0)
+      forwardable-extended (~> 2.6)
+    public_suffix (2.0.5)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rouge (1.11.1)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    safe_yaml (1.0.4)
+    sass (3.5.1)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  jekyll-lilypond-converter!
+  rspec (~> 3.6)
+
+BUNDLED WITH
+   1.14.6

data/README.md

@@ -0,0 +1,31 @@
+# Jekyll LilyPond Converter
+
+Add `lily` code blocks to your markdown blog post and automatically convert the code to sheet music using [LilyPond][].
+
+### Installation and Usage
+
+- [Install LilyPond][] and ensure the `lilypond` executable is on your `$PATH`
+- Add this gem to your Jekyll-based static site repository's Gemfile
+- Add `lily_images/` to your `.gitignore`
+- Add the converter to your `_config.yml` file:
+
+      gems:
+      - jekyll-lilypond-converter
+
+- (Optional) specify LilyPond image format in `_config.yml` (default is `svg`, alternative option is `png`)
+
+      lilypond-image-format: png
+
+- Add lily code to a markdown post:
+
+      This is a C major chord:
+
+      ```lilypond
+      \relative {
+        <c' e g>
+      }
+      ```
+
+
+[LilyPond]: http://lilypond.org/
+[Install LilyPond]: http://lilypond.org/download.html

data/jekyll_lilypond_converter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-lilypond-converter"
+  spec.version       = JekyllLilyPondConverter::VERSION
+  spec.authors       = ["Mike Knepper"]
+  spec.email         = ["michaelrknepper@gmail.com"]
+
+  spec.summary       = "Convert LilyPond snippets in blog posts to images"
+  spec.description   = "Automatically identify LilyPond code snippets in Markdown blog posts and, during conversion to HTML, replace snippets with links to generated SVG images"
+  spec.homepage      = "https://github.com/mikeknep/jekyll-lilypond-converter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib", "lib/jekyll_ext/", "lib/jekyll_lilypond_converter/"]
+
+  spec.add_dependency "jekyll", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rspec", "~> 3.6"
+end

data/lib/jekyll-lilypond-converter.rb

@@ -0,0 +1,8 @@
+require "jekyll_lilypond_converter/errors"
+require "jekyll_lilypond_converter/lily"
+require "jekyll_lilypond_converter/handler"
+require "jekyll_lilypond_converter/site_manager"
+require "jekyll_lilypond_converter/naming_policy"
+require "jekyll_ext/converter"
+require "jekyll_ext/generator"
+require "jekyll_ext/lily_pond_static_file_builder"

data/lib/jekyll_ext/converter.rb

@@ -0,0 +1,47 @@
+require "jekyll"
+
+module Jekyll
+  class LilyPondConverter < Converter
+    priority :high
+
+    DEFAULT_CONFIG = {
+      "lilypond-image-format" => "svg"
+    }
+
+    def initialize(config = {})
+      @config = Jekyll::Utils.deep_merge_hashes(DEFAULT_CONFIG, config)
+    end
+
+    def matches(ext)
+      /md|markdown/.match?(ext)
+    end
+
+    def output_ext(ext)
+      ".html"
+    end
+
+    def convert(content)
+      ensure_valid_image_format(image_format)
+
+      ::JekyllLilyPondConverter::Handler.new(
+        content: content,
+        naming_policy: ::JekyllLilyPondConverter::NamingPolicy.new,
+        image_format: image_format,
+        site_manager: ::JekyllLilyPondConverter::SiteManager.instance,
+        static_file_builder: Jekyll::LilyPondStaticFileBuilder
+      ).execute
+    end
+
+    private
+
+    def image_format
+      @config["lilypond-image-format"]
+    end
+
+    def ensure_valid_image_format(image_format)
+      unless ["svg", "png"].include?(image_format)
+        raise ::JekyllLilyPondConverter::INVALID_IMAGE_FORMAT_ERROR
+      end
+    end
+  end
+end

data/lib/jekyll_ext/generator.rb

@@ -0,0 +1,24 @@
+require "jekyll"
+
+module Jekyll
+  class LilyPondGenerator < Generator
+    def generate(site)
+      ::JekyllLilyPondConverter::SiteManager.instance.site = site
+      setup_lily_images_directory
+      remove_stale_lily_image_references(site)
+    end
+
+    private
+
+    def setup_lily_images_directory
+      system("rm", "-rf", "lily_images/")
+      system("mkdir", "lily_images/")
+    end
+
+    def remove_stale_lily_image_references(site)
+      site.static_files.reject! do |static_file|
+        /lily_images\/.*\.(svg|png)/.match?(static_file.path)
+      end
+    end
+  end
+end

data/lib/jekyll_ext/lily_pond_static_file_builder.rb

@@ -0,0 +1,14 @@
+require "jekyll"
+
+module Jekyll
+  class LilyPondStaticFileBuilder
+    def self.build(site, filename)
+      StaticFile.new(
+        site,
+        site.source,
+        "lily_images",
+        filename
+      )
+    end
+  end
+end

data/lib/jekyll_lilypond_converter/errors.rb

@@ -0,0 +1,10 @@
+module JekyllLilyPondConverter
+  class INVALID_IMAGE_FORMAT_ERROR < StandardError
+    def message
+      <<-ERROR
+Invalid lilypond-image-format option selected.
+Valid options are 'svg' (default) and 'png'.
+      ERROR
+    end
+  end
+end

data/lib/jekyll_lilypond_converter/handler.rb

@@ -0,0 +1,58 @@
+module JekyllLilyPondConverter
+  class Handler
+    def initialize(content:, naming_policy:, image_format:, site_manager:, static_file_builder:)
+      @content = content
+      @naming_policy = naming_policy
+      @image_format = image_format
+      @site_manager = site_manager
+      @static_file_builder = static_file_builder
+    end
+
+    def execute
+      lilies.each do |lily|
+        write_lily_code_file(lily)
+        generate_lily_image(lily)
+        add_lily_image_to_site(lily)
+        replace_snippet_with_image_link(lily)
+      end
+      content
+    end
+
+    private
+    attr_reader :content, :naming_policy, :image_format, :site_manager, :static_file_builder
+
+    def write_lily_code_file(lily)
+      open(lily.code_filename, 'w') do |code_file|
+        code_file.puts(lily.code)
+      end
+    end
+
+    def generate_lily_image(lily)
+      system("lilypond", lilypond_output_format_option, lily.code_filename)
+      system("mv", lily.image_filename, "lily_images/")
+      system("rm", lily.code_filename)
+    end
+
+    def add_lily_image_to_site(lily)
+      site_manager.add_image(static_file_builder, lily.image_filename)
+    end
+
+    def replace_snippet_with_image_link(lily)
+      content.gsub!(lily.snippet, lily.image_link)
+    end
+
+    def lilies
+      lily_snippets.map do |snippet|
+        Lily.new(naming_policy.generate_name, image_format, snippet)
+      end
+    end
+
+    def lily_snippets
+      content.scan(/```lilypond.+?```\n/m)
+    end
+
+    def lilypond_output_format_option
+      image_format == "png" ? "--png" : "-dbackend=svg"
+    end
+  end
+end

data/lib/jekyll_lilypond_converter/lily.rb

@@ -0,0 +1,34 @@
+module JekyllLilyPondConverter
+  class Lily
+    attr_reader :snippet
+
+    def initialize(id, extension, snippet)
+      @id = id
+      @extension = extension
+      @snippet = snippet
+    end
+
+    def code_filename
+      "#{id}.ly"
+    end
+
+    def image_filename
+      "#{id}.#{extension}"
+    end
+
+    def image_link
+      "![](/lily_images/#{image_filename})\n"
+    end
+
+    def code
+      strip_delimiters(snippet)
+    end
+
+    private
+    attr_reader :id, :extension
+
+    def strip_delimiters(snippet)
+      snippet.gsub(/```lilypond\n/, "").gsub(/```\n/, "")
+    end
+  end
+end

data/lib/jekyll_lilypond_converter/naming_policy.rb

@@ -0,0 +1,9 @@
+require "securerandom"
+
+module JekyllLilyPondConverter
+  class NamingPolicy
+    def generate_name
+      SecureRandom.uuid
+    end
+  end
+end

data/lib/jekyll_lilypond_converter/site_manager.rb

@@ -0,0 +1,14 @@
+require "singleton"
+
+module JekyllLilyPondConverter
+  class SiteManager
+    include Singleton
+
+    attr_accessor :site
+
+    def add_image(builder, filename)
+      site.static_files << builder.build(site, filename)
+    end
+
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module JekyllLilyPondConverter
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-lilypond-converter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Knepper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: Automatically identify LilyPond code snippets in Markdown blog posts
+  and, during conversion to HTML, replace snippets with links to generated SVG images
+email:
+- michaelrknepper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- jekyll_lilypond_converter.gemspec
+- lib/jekyll-lilypond-converter.rb
+- lib/jekyll_ext/converter.rb
+- lib/jekyll_ext/generator.rb
+- lib/jekyll_ext/lily_pond_static_file_builder.rb
+- lib/jekyll_lilypond_converter/errors.rb
+- lib/jekyll_lilypond_converter/handler.rb
+- lib/jekyll_lilypond_converter/lily.rb
+- lib/jekyll_lilypond_converter/naming_policy.rb
+- lib/jekyll_lilypond_converter/site_manager.rb
+- lib/version.rb
+homepage: https://github.com/mikeknep/jekyll-lilypond-converter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/jekyll_ext/
+- lib/jekyll_lilypond_converter/
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Convert LilyPond snippets in blog posts to images
+test_files: []