chordpro 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c3a004dac5edc5dabd80b9ee292460013c79cc4
+  data.tar.gz: 9aa3b8f96010c1a14ed487d0ebdf308ba81f8e6d
+SHA512:
+  metadata.gz: 497c61b56fb5ff17f4fb85621bdb43e1a2d87f5fe15bdaba179ac3e402df71dbdbbc5a00e9c26c611b5a6798faca964a1cde14612aef6cd98aa274a70a611351
+  data.tar.gz: fa3c1f328439bff9d08a798ba297d51a408c203124045a4873fd89c3beadbb374f85846ebd7cd09c1958335c7c8f0598291c8f737a2d5827248897973e499f1c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chordpro.gemspec
+gemspec
+
+gem 'pry'

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^spec/spec_helper.rb$})    { "spec" }
+  watch(%r{^lib/(.+)\.rb$})           { |m| "spec/#{m[1]}_spec.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brandon Keepers
+
+MIT License
+
+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,31 @@
+# Chordpro
+
+A ruby parser for the [chordpro](http://tenbyten.com/software/songsgen/help/HtmlHelp/files_reference.htm) song file format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'chordpro'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chordpro
+
+## Usage
+
+```ruby
+html = Chordpro.html(File.read('spec/fixtures/sunshine.crd'))
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+  t.verbose = false
+end
+
+task :default => :spec

data/chordpro.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chordpro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chordpro"
+  spec.version       = Chordpro::VERSION
+  spec.authors       = ["Brandon Keepers"]
+  spec.email         = ["brandon@opensoul.org"]
+  spec.summary       = %q{A ruby parser for the chordpro song file format.}
+  spec.description   = %q{A ruby parser for the chordpro song file format.}
+  spec.homepage      = "https://github.com/bkeepers/chordpro"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'parslet'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard-rspec'
+end

data/lib/chordpro.rb

@@ -0,0 +1,9 @@
+require "chordpro/version"
+require "chordpro/parser"
+require "chordpro/html"
+
+module Chordpro
+  def self.html(string)
+    HTML.new(Parser.new.parse(string)).to_s
+  end
+end

data/lib/chordpro/html.rb

@@ -0,0 +1,71 @@
+require 'nokogiri'
+
+module Chordpro
+  class HTML
+    def initialize(tree)
+      @song = tree[:song]
+    end
+
+    def to_s
+      @song.map { |e| elements(e) }.flatten.join("\n")
+    end
+
+    def elements(element)
+      element.map do |key, value|
+        send key, value
+      end
+    end
+
+    def directive(directive)
+      send directive[:name], directive if respond_to?(directive[:name])
+    end
+
+    def title(directive)
+      %Q|<h1 class="title">#{directive[:value]}</h1>|
+    end
+    alias_method :t, :title
+
+    def subtitle(directive)
+      %Q|<h2 class="subtitle">#{directive[:value]}</h2>|
+    end
+    alias_method :st, :subtitle
+    alias_method :su, :subtitle
+
+    def line(line)
+      chords = []
+      lyrics = []
+
+      line.each do |element|
+        if lyric = element[:lyric]
+          lyrics << lyric
+        elsif chord = element[:chord]
+          if chords[lyrics.size]
+            chord << chord
+            lyrics << nil
+          else
+            chords[lyrics.size] = chord
+          end
+        end
+      end
+
+      # ensure chords has same number of cells as lyrics
+      chords[lyrics.size - 1] ||= nil if lyrics.size > 0
+
+      %Q|<table><tr class="chords">#{
+        chords.map {|l| "<td>#{l}</td>" }.join
+      }</tr><tr>#{
+        lyrics.map {|l| "<td>#{l}</td>" }.join
+      }</tr></table>|
+    end
+
+    def newline(_)
+      '<br>'
+    end
+
+    def comment(directive)
+      %|<span class="comment">#{directive[:value]}</span>|
+    end
+    alias_method :c, :comment
+
+  end
+end

data/lib/chordpro/parser.rb

@@ -0,0 +1,37 @@
+require 'parslet'
+
+module Chordpro
+  class Parser < Parslet::Parser
+    # Characters
+    rule(:space)    { match('\s').repeat }
+    rule(:colon)    { space >> str(':') >> space }
+    rule(:newline)  { str("\n") }
+    rule(:lbrace)   { str('{') }
+    rule(:rbrace)   { str('}') }
+    rule(:lbracket) { str('[') }
+    rule(:rbracket) { str(']') }
+
+
+    rule(:identifier) { match['a-z'].repeat(1) }
+    rule(:value) { (rbrace.absent? >> any).repeat }
+
+    rule(:directive) do
+      (
+        lbrace >> space >>
+        identifier.as(:name) >>
+        (
+          space >> colon >> space >>
+          value.as(:value)
+        ).maybe >>
+        rbrace
+      ).as(:directive) >> newline.maybe
+    end
+    rule(:chord) { lbracket >> (rbracket.absent? >> any).repeat.as(:chord) >> rbracket }
+    rule(:lyric) { (lbracket.absent? >> newline.absent? >> any).repeat(1).as(:lyric) }
+    rule(:line)  { (chord | lyric).repeat(1).as(:line) >> newline.maybe }
+
+    rule(:song)  { (directive | newline.as(:newline) | line).repeat.as(:song) }
+
+    root(:song)
+  end
+end

data/lib/chordpro/version.rb

@@ -0,0 +1,3 @@
+module Chordpro
+  VERSION = "0.0.1"
+end

data/spec/chordpro/html_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Chordpro::HTML do
+  def html(string)
+    Chordpro::HTML.new(Chordpro::Parser.new.parse(string))
+  end
+
+  %w(title t).each do |name|
+    it "renders h1 for #{name}" do
+      expect(html("{#{name}: Blackbird}").to_s).to eq('<h1 class="title">Blackbird</h1>')
+    end
+  end
+
+  %w(subtitle st su).each do |name|
+    it "renders h2 for #{name}" do
+      expect(html("{#{name}:The Beatles}").to_s).to eq('<h2 class="subtitle">The Beatles</h2>')
+    end
+  end
+
+  it "renders line" do
+    expect(html("[G7]I dreamed I [C]held you in my [G]arms").to_s).to eq(
+      '<table><tr class="chords"><td>G7</td><td>C</td><td>G</td></tr>' +
+      '<tr><td>I dreamed I </td><td>held you in my </td><td>arms</td></tr></table>'
+    )
+  end
+
+end

data/spec/chordpro/parser_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+require 'parslet/rig/rspec'
+
+describe Chordpro::Parser do
+  let(:parser) { Chordpro::Parser.new }
+
+  subject { parser.send self.class.description }
+
+  describe 'space' do
+    it { should parse(' ') }
+    it { should parse('   ') }
+    it { should parse('') }
+    it { should_not parse('x') }
+  end
+
+  describe 'colon' do
+    it { should parse(':') }
+    it { should_not parse('x') }
+  end
+
+  describe 'newline' do
+    it { should parse("\n") }
+    it { should_not parse("x") }
+  end
+
+  describe 'lbrace' do
+    it { should parse("{") }
+    it { should_not parse("[") }
+  end
+
+  describe 'rbrace' do
+    it { should parse("}") }
+    it { should_not parse("]") }
+  end
+
+  describe 'lbracket' do
+    it { should parse("[") }
+    it { should_not parse("{") }
+  end
+
+  describe 'rbracket' do
+    it { should parse("]") }
+    it { should_not parse("}") }
+  end
+
+  describe 'identifier' do
+    it { should parse('title') }
+    it { should parse('t') }
+    it { should_not parse(' abcdef') }
+    it { should_not parse(' ') }
+    it { should_not parse('') }
+  end
+
+  describe 'value' do
+    it { should parse('some value') }
+    it { should parse(' ahoy ').as(' ahoy ') }
+    it { should_not parse('oops}') }
+  end
+
+  describe 'directive' do
+    it { should parse('{title:Royals}').as(:directive => {:name => 'title', :value => 'Royals'}) }
+    # FIXME: remove trailing space from value
+    it { should parse('{ title : Get Lucky }').as(:directive => {:name => 'title', :value => 'Get Lucky '}) }
+    it { should parse('{soc}').as(:directive => {:name => 'soc'}) }
+    it { should_not parse('{st:oops') }
+  end
+
+  describe 'chord' do
+    %w(A Bb C# Dm Edim Fmaj Gsus2 A/C#).each do |chord|
+      it { should parse("[#{chord}]").as(:chord => chord) }
+    end
+
+    it { should_not parse('[G') }
+  end
+
+  describe 'lyric' do
+    it { should parse("I've never seen") }
+    it { should parse(" a diamond in the ")}
+    it { should_not parse("in the[") }
+    it { should_not parse("in the\n") }
+  end
+
+  describe 'line' do
+    it { should parse("[G]You are my sunshine").as(:line => [{:chord => 'G'}, {:lyric => 'You are my sunshine'}]) }
+    it { should parse("You make me [C]happy when skies are [G]gray").as(:line => [
+      {:lyric => 'You make me '},
+      {:chord => 'C'},
+      {:lyric => 'happy when skies are '},
+      {:chord => 'G'},
+      {:lyric => 'gray'}
+    ]) }
+
+    it { should parse("words with a newline\n").as(:line => [{:lyric => "words with a newline"}]) }
+    it { should_not parse("foo\nbar") }
+  end
+
+  describe 'song' do
+    it do
+      song = "{title: I'll Fly Away}\n\n[C]I'll fly away, [C7]oh, glory\n[F]I'll fly [C]away\n"
+      should parse(song).as({:song => [
+        {:directive => {:name => "title", :value => "I'll Fly Away"}},
+        {:newline => "\n"},
+        {:line => [{:chord => "C"}, {:lyric => "I'll fly away, "}, {:chord => "C7"}, {:lyric => "oh, glory"}]},
+        {:line => [{:chord => "F"}, {:lyric => "I'll fly "}, {:chord => "C"}, {:lyric => "away"}]}
+      ]})
+
+    end
+  end
+end

data/spec/example_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe 'Examples' do
+  Dir[File.expand_path('../fixtures/*.crd', __FILE__)].each do |file|
+    name = File.basename(file)
+
+    describe name, :example => name do
+      it 'matches the example' do
+        expected = Chordpro.html(File.read(file))
+        actual = File.read(file.gsub(/\.crd$/, '.html'))
+
+        expect(expected).to eq(actual)
+      end
+    end
+
+  end
+end

data/spec/fixtures/example.css

@@ -0,0 +1,13 @@
+body {
+  font-family: 'Helvetica Neue', 'Helvetica', sans-serif;
+  font-size: 13px;
+  padding: 20px;
+}
+
+.comment {
+  color: #999;
+}
+
+.chords {
+  font-weight: bold;
+}

data/spec/fixtures/sunshine.crd

@@ -0,0 +1,27 @@
+{title: You Are My Sunshine}
+
+{c:Verse 1}
+[G]The other night dear as I lay sleeping
+[G7]I dreamed I [C]held you in my [G]arms
+[G7]But when I a[C]woke dear I was mis[G]taken
+So I hung my [D7]head and [G]cried
+
+{c:Chorus}
+{soc}
+You are my sunshine my only sunshine
+[G7]You make me [C]happy when skies are [G]gray
+[G7]You'll never [C]know dear how much I [G]love you
+Please don't take [D7]my sunshine a[G]way
+{eoc}
+
+{c:Verse 2}
+I'll always love you and make you happy
+[G7]If you will [C]only say the [G]same
+[G7]But if you [C]leave me and love an[G]other
+You'll regret [D7]it all some [G]day
+
+{c:Verse 3}
+You told me once dear you really loved me
+[G7]And no one [C]else could come be[G]tween
+[G7]But now you've [C]left me and love an[G]other
+You have shattered [D7]all of my [G]dreams

data/spec/fixtures/sunshine.html

@@ -0,0 +1,27 @@
+<h1 class="title">You Are My Sunshine</h1>
+<br>
+<span class="comment">Verse 1</span>
+<table><tr class="chords"><td>G</td></tr><tr><td>The other night dear as I lay sleeping</td></tr></table>
+<table><tr class="chords"><td>G7</td><td>C</td><td>G</td></tr><tr><td>I dreamed I </td><td>held you in my </td><td>arms</td></tr></table>
+<table><tr class="chords"><td>G7</td><td>C</td><td>G</td></tr><tr><td>But when I a</td><td>woke dear I was mis</td><td>taken</td></tr></table>
+<table><tr class="chords"><td></td><td>D7</td><td>G</td></tr><tr><td>So I hung my </td><td>head and </td><td>cried</td></tr></table>
+<br>
+<span class="comment">Chorus</span>
+
+<table><tr class="chords"><td></td></tr><tr><td>You are my sunshine my only sunshine</td></tr></table>
+<table><tr class="chords"><td>G7</td><td>C</td><td>G</td></tr><tr><td>You make me </td><td>happy when skies are </td><td>gray</td></tr></table>
+<table><tr class="chords"><td>G7</td><td>C</td><td>G</td></tr><tr><td>You'll never </td><td>know dear how much I </td><td>love you</td></tr></table>
+<table><tr class="chords"><td></td><td>D7</td><td>G</td></tr><tr><td>Please don't take </td><td>my sunshine a</td><td>way</td></tr></table>
+
+<br>
+<span class="comment">Verse 2</span>
+<table><tr class="chords"><td></td></tr><tr><td>I'll always love you and make you happy</td></tr></table>
+<table><tr class="chords"><td>G7</td><td>C</td><td>G</td></tr><tr><td>If you will </td><td>only say the </td><td>same</td></tr></table>
+<table><tr class="chords"><td>G7</td><td>C</td><td>G</td></tr><tr><td>But if you </td><td>leave me and love an</td><td>other</td></tr></table>
+<table><tr class="chords"><td></td><td>D7</td><td>G</td></tr><tr><td>You'll regret </td><td>it all some </td><td>day</td></tr></table>
+<br>
+<span class="comment">Verse 3</span>
+<table><tr class="chords"><td></td></tr><tr><td>You told me once dear you really loved me</td></tr></table>
+<table><tr class="chords"><td>G7</td><td>C</td><td>G</td></tr><tr><td>And no one </td><td>else could come be</td><td>tween</td></tr></table>
+<table><tr class="chords"><td>G7</td><td>C</td><td>G</td></tr><tr><td>But now you've </td><td>left me and love an</td><td>other</td></tr></table>
+<table><tr class="chords"><td></td><td>D7</td><td>G</td></tr><tr><td>You have shattered </td><td>all of my </td><td>dreams</td></tr></table>

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'chordpro'

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: chordpro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brandon Keepers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby parser for the chordpro song file format.
+email:
+- brandon@opensoul.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- chordpro.gemspec
+- lib/chordpro.rb
+- lib/chordpro/html.rb
+- lib/chordpro/parser.rb
+- lib/chordpro/version.rb
+- spec/chordpro/html_spec.rb
+- spec/chordpro/parser_spec.rb
+- spec/example_spec.rb
+- spec/fixtures/example.css
+- spec/fixtures/sunshine.crd
+- spec/fixtures/sunshine.html
+- spec/spec_helper.rb
+homepage: https://github.com/bkeepers/chordpro
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A ruby parser for the chordpro song file format.
+test_files:
+- spec/chordpro/html_spec.rb
+- spec/chordpro/parser_spec.rb
+- spec/example_spec.rb
+- spec/fixtures/example.css
+- spec/fixtures/sunshine.crd
+- spec/fixtures/sunshine.html
+- spec/spec_helper.rb