song_pro 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7926744caec7f509bb70754bda4dfb77ffa68dcd72566de3489162d9fd215ea
+  data.tar.gz: 8899b2137302c1e95862a0db9bae954bc7e055b1f45ef65c384984b82da5cfb2
+SHA512:
+  metadata.gz: 946d6c7f401224daafb65c57b1a9e33ba9a7b2c887a7149e02228d19c38a8d9c8f2bc511ec56a49f536e6ab1fb02338a45493ccfc2279ab710cbe11f30b7c4cb
+  data.tar.gz: ffcea2097a1e359d0ab8715059309dcd86775ce553211862bd95e0ef2d94f75bd4dcf389c3889c5e1f39ee02e569b7be78f395039c9a28a57bee0654bf5489d4

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in song_pro.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    song_pro (0.1.1)
+      markaby
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    builder (3.2.3)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    markaby (0.9.0)
+      builder
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  song_pro!
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Brian Kelly
+
+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,110 @@
+# SongPro [![Build Status](https://travis-ci.org/spilth/song_pro.svg?branch=master)](https://travis-ci.org/spilth/song_pro)
+
+SongPro is a text format for transcribing songs.
+ 
+This project is a Ruby Gem that converts the song into a data model that can then be converted into various output formats such as text or HTML.
+
+It is heavily inspired by [ChordPro](https://www.chordpro.org/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'song_pro'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install song_pro
+
+## Usage
+
+Given then file `bad-moon-rising.sng` with the following contents:
+
+```
+@title=Bad Moon Rising
+@artist=Cleedence Clearwater Revival
+
+# Intro
+
+[D][A][G][D]
+
+# Verse 1
+
+[D]I see a [A]bad [G]moon a-[D]rising
+[D]I see [A]trouble [G]on the [D]way
+[D]I see [A]earth-[G]quakes and [D]lightnin'
+[D]I see [A]bad [G]times to-[D]day
+```
+
+You can then parse the file to create a `Song` object:
+
+```ruby
+require 'song_pro'
+
+text = File.read('bad-moon-rising.sng')
+song = SongPro.parse(text)
+
+puts song.title
+# Bad Moon Rising
+
+puts song.artist
+# Creedence Clearwater Revival 
+
+puts song.sections[1].title
+# Verse 1
+
+```
+## SongPro Format
+
+- Attributes are declared using: `@key=value`
+- Sections are declared using: `# Section Name`
+- Chords are declared using: `[Xy#]`
+
+```
+@title=Bad Moon Rising
+@artist=Cleedence Clearwater Revival
+
+# Intro
+
+[D][A][G][D]
+
+# Verse 1
+
+[D]I see a [A]bad [G]moon a-[D]rising
+[D]I see [A]trouble [G]on the [D]way
+[D]I see [A]earth-[G]quakes and [D]lightnin'
+[D]I see [A]bad [G]times to-[D]day
+```
+
+## Song Object
+
+- a **Song** can have a Title
+- a **Song** can have an Artist
+- a **Song** has zero or more **Sections**
+- a **Section** has zero or more **Lines**
+- a **Line** has one or more **Parts**
+- a **Part** has a **Chord** and **Lyric**
+- a **Chord** is the textual representation of a single chord
+  - this may be empty
+- a **Lyric** is the textual representation of lyrics
+  - this may be empty
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/spilth/song_pro>.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "song_pro"
+
+# 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/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/lib/song_pro/line.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Line
+  attr_accessor :parts, :tablature
+
+  def initialize
+    @parts = []
+    @tablature = nil
+  end
+
+  def tablature?
+    return @tablature != nil
+  end
+end

data/lib/song_pro/part.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Part
+  attr_accessor :lyric, :chord
+end

data/lib/song_pro/section.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Section
+  attr_accessor :name, :lines
+
+  def initialize(name: '')
+    @name = name
+    @lines = []
+  end
+end

data/lib/song_pro/song.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'markaby'
+
+class Song
+  attr_accessor :title,
+                :artist,
+                :capo,
+                :key,
+                :tempo,
+                :year,
+                :album,
+                :tuning,
+                :sections
+
+  def initialize
+    @sections = []
+  end
+
+  def to_html
+    mab = Markaby::Builder.new(song: self)
+    mab.div.song do
+      h1.title song.title if song.title
+      h2.artist song.artist if song.artist
+
+      dl.information do
+        if song.tuning
+          dt.tuning 'Tuning'
+          dd.tuning song.tuning
+        end
+        if song.capo
+          dt.capo 'Capo'
+          dd.capo song.capo
+        end
+        if song.key
+          dt.key 'Key'
+          dd.key song.key
+        end
+        if song.tempo
+          dt.tempo 'Tempo'
+          dd.tempo song.tempo
+        end
+        if song.year
+          dt.year 'Year'
+          dd.year song.year
+        end
+        if song.album
+          dt.album 'Album'
+          dd.album song.album
+        end
+      end
+
+      song.sections.each do |section|
+        div.section do
+          div.name section.name
+          div.lines do
+            section.lines.each do |line|
+              if line.tablature?
+                div.tablature do
+                  line.tablature
+                end
+              else
+                div.line do
+                  line.parts.each do |part|
+                    div.part do
+                      div.chord part.chord
+                      div.lyric part.lyric
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    mab.to_s
+  end
+end

data/lib/song_pro/version.rb

@@ -0,0 +1,3 @@
+module SongPro
+  VERSION = '0.1.1'.freeze
+end

data/lib/song_pro.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'song_pro/version'
+require 'song_pro/song'
+require 'song_pro/section'
+require 'song_pro/line'
+require 'song_pro/part'
+
+module SongPro
+  SECTION_REGEX = /#\s*([^$]*)/
+  ATTRIBUTE_REGEX = /@(\w*)=([^%]*)/
+  CHORDS_AND_LYRICS_REGEX = /(\[[\w#b\/]+\])?([\w\s',.!\(\)_\-"]*)/i
+
+  def self.parse(lines)
+    song = Song.new
+    current_section = nil
+
+    lines.split("\n").each do |text|
+      if text.start_with?('@')
+        process_attribute(song, text)
+      elsif text.start_with?('#')
+        current_section = process_section(song, text)
+      else
+        process_lyrics_and_chords(song, current_section, text)
+      end
+    end
+
+    song
+  end
+
+  def self.process_section(song, text)
+    matches = SECTION_REGEX.match(text)
+    name = matches[1].strip
+    current_section = Section.new(name: name)
+    song.sections << current_section
+
+    current_section
+  end
+
+  def self.process_attribute(song, text)
+    matches = ATTRIBUTE_REGEX.match(text)
+    key = matches[1]
+    value = matches[2].strip
+
+    if song.respond_to?("#{key}=".to_sym)
+      song.send("#{key}=", value)
+    else
+      puts "WARNING: Unknown attribute '#{key}'"
+    end
+  end
+
+  def self.process_lyrics_and_chords(song, current_section, text)
+    return if text == ''
+
+    if current_section.nil?
+      current_section = Section.new(name: '')
+      song.sections << current_section
+    end
+
+    line = Line.new
+
+    if text.start_with?('|')
+      line.tablature = text
+    else
+      captures = text.scan(CHORDS_AND_LYRICS_REGEX).flatten
+
+    captures.each_slice(2) do |pair|
+      part = Part.new
+      chord = pair[0]&.strip || ''
+      part.chord = chord.delete('[').delete(']')
+      part.lyric = pair[1]&.strip || ''
+
+        line.parts << part unless (part.chord == '') && (part.lyric == '')
+      end
+    end
+
+    current_section.lines << line
+  end
+end

data/song_pro.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'song_pro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'song_pro'
+  spec.version       = SongPro::VERSION
+  spec.authors       = ['Brian Kelly']
+  spec.email         = ['polymonic@gmail.com  ']
+
+  spec.summary       = 'Converts SongPro files to HTML'
+  spec.description   = 'Provides classes for creating, parsing and rendering SongPro files'
+  spec.homepage      = 'https://songpro.org'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'markaby'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: song_pro
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Brian Kelly
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: markaby
+  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: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Provides classes for creating, parsing and rendering SongPro files
+email:
+- 'polymonic@gmail.com  '
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/song_pro.rb
+- lib/song_pro/line.rb
+- lib/song_pro/part.rb
+- lib/song_pro/section.rb
+- lib/song_pro/song.rb
+- lib/song_pro/version.rb
+- song_pro.gemspec
+homepage: https://songpro.org
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Converts SongPro files to HTML
+test_files: []