musedown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bec6c7c82ddd63eea5b707b3717619a51dea5acde6f941636a1e88101b61e6a4
+  data.tar.gz: 2057163776d5399bde0113ef213e5b0623996e90c0f202ddc3ea41606d9cec80
+SHA512:
+  metadata.gz: f04e4ec3986d5e8f4e6a1da60fee3cf87acbeedc24bf395b9c43c357f3ec18db2a8853a9a063f29414ce464d015b681f550c035ed7fe94f901871e487cd19b52
+  data.tar.gz: 27c1fb3a50183af547d6bf4456bb33701de743e00e6e53799d53aa4ec391f46a2e1f7f0cd6a36239dcc89dcfce8ed6ac250fcea611c1b38eb6206e61eada8caf

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.DS_Store

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in musedown.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    musedown (0.1.0)
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (12.3.3)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  musedown!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Erick Durán
+
+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,53 @@
+# Musedown
+This is a simple MuseScore CLI wrapper to easily build markdown files with music notation (and preserve for changes).
+
+## Installation
+To install the `gem` directly:
+```bash
+gem install musedown
+```
+
+Or build directly from the source code:
+```bash
+rake install
+```
+
+## Usage
+The `musedown` CLI will use MuseScore's CLI (`mscore`) to convert your `.mscz` files into `.png` files and replace them in your markdown file. 
+
+To use:
+1. Embed the `.mscz` file into your markdown like this:
+```markdown
+![Awesome score](hello.mscz)
+```
+2. Run `musedown`:
+```
+musedown build hello.md
+```
+3. And your markdown file will now be like this:
+```markdown
+![Awesome score](hello-mscz-1.png)
+```
+And the `hello-mscz-1.png` will be automatically generated. You may keep the `hello.mscz`, perform changes and re-run the command to refresh the `.png` file.
+
+### Commands
+To parse a file, simply run:
+```bash
+musedown build FILE_NAME
+```
+
+To route the output to another file:
+```bash
+musedown build examples/hello.md -o result.md
+```
+
+If `mscore` is not available, you can directly pass the executable with the `-c` flag:
+```bash
+musedown build examples/hello.md -o examples/output.md -c "/Applications/MuseScore\ 3.app/Contents/MacOS/mscore"
+```
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/erickduran/musedown.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "musedown"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/musedown

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "musedown"
+
+md = Musedown::CLI.start(ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/hello.md

@@ -0,0 +1,5 @@
+# Hello World!
+
+This is my cool file.
+
+![](hello.mscz)

data/examples/output.md

@@ -0,0 +1,5 @@
+# Hello World!
+
+This is my cool file.
+
+![](hello-mscz-1.png)

data/lib/musedown.rb

@@ -0,0 +1,93 @@
+require "musedown/version"
+require "thor"
+
+module Musedown
+    class Score
+        attr_accessor :score_file
+        attr_accessor :relative_score_file
+        attr_accessor :relative_image_file
+        attr_reader :prebuilt
+
+        def initialize(prebuilt)
+            @score_file = nil
+            @relative_score_file = nil
+            @relative_image_file = nil
+            @prebuilt = prebuilt
+        end
+
+        def build(command)
+            begin
+                image_file = "#{@score_file.gsub(".mscz", "-mscz")}.png"
+                result = `#{command} #{@score_file} -o #{image_file}`
+            rescue Errno::ENOENT => error
+                puts("⚠️ Error building #{@score_file}: #{error}")
+            end
+
+            if $?.success?
+                if !prebuilt
+                    @relative_image_file = @relative_score_file.sub(/.*\K\.mscz/, "-mscz-1.png")
+                end
+            else
+                puts("⚠️ Failed to convert #{@score_file}")
+            end
+            return $?.success?
+        end
+    end
+
+    class CLI < Thor
+        desc("build [FILE_NAME]", "build markdown file")
+        option(:output, :type => :string, :required => false, :desc => "output file", :aliases => "-o")
+        option(:command, :type => :string, :default => "mscore", :desc => "musescore command, default: mscore", :aliases => "-c")
+        def build(file_name)
+            output_file = file_name
+            if options[:output]
+                puts("✏️  Output file will be #{options[:output]}")
+                output_file = options[:output]
+            end
+
+            puts("👷‍♂️ Building file #{file_name}...")
+            contents = nil
+            File.open(file_name) do |file|
+                contents = file.read
+            end
+            scores = []
+
+            prebuilt_expression = /!\[.*\]\((?<file_name>.*\-mscz-1\.png)\)/
+            prebuilt_matches = contents.scan(prebuilt_expression)
+
+            puts("🔍 Found #{prebuilt_matches.length} previously built images...")
+            prebuilt_matches.each do |match|
+                score = Score.new(true)
+                score.relative_image_file = match[0]
+                resolved_image_file = File.join(File.dirname(file_name), score.relative_image_file)
+                score.score_file = resolved_image_file.gsub("-mscz-1.png", ".mscz")
+                scores << score
+            end
+
+            expression = /!\[.*\]\((?<file_name>.*\.mscz)\)/
+            matches = contents.scan(expression)
+
+            puts("🔍 Found unbuilt #{matches.length} score files...")
+            matches.each do |match|
+                score = Score.new(false)
+                score.relative_score_file = match[0]
+                score.score_file = File.join(File.dirname(file_name), score.relative_score_file)
+                scores << score
+            end
+
+            scores.each do |score|
+                sucess = score.build(options[:command])
+                if !score.prebuilt and sucess
+                    contents = contents.gsub(score.relative_score_file, score.relative_image_file)
+                end
+            end
+
+            puts("💾 Saving...")
+            File.open(output_file, "w") do |file|
+                file.write(contents)
+            end
+
+            puts "✅ Done!"
+        end
+    end
+end

data/lib/musedown/version.rb

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

data/musedown.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/musedown/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "musedown"
+  spec.version       = Musedown::VERSION
+  spec.authors       = ["Erick Durán"]
+  spec.email         = ["me@erickduran.com"]
+
+  spec.summary       = %q{A music notation markdown builder.}
+  spec.description   = %q{A music notation markdown builder.}
+  spec.homepage      = "https://github.com/erickduran/musedown"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/erickduran/musedown"
+  spec.metadata["changelog_uri"] = "https://github.com/erickduran/musedown"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.executables   = ["musedown"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor", "~> 0.20"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: musedown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erick Durán
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+description: A music notation markdown builder.
+email:
+- me@erickduran.com
+executables:
+- musedown
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/musedown
+- bin/setup
+- examples/hello-mscz-1.png
+- examples/hello.md
+- examples/hello.mscz
+- examples/output.md
+- lib/musedown.rb
+- lib/musedown/version.rb
+- musedown.gemspec
+homepage: https://github.com/erickduran/musedown
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/erickduran/musedown
+  source_code_uri: https://github.com/erickduran/musedown
+  changelog_uri: https://github.com/erickduran/musedown
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A music notation markdown builder.
+test_files: []