song_pro 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d13f7f76dd430f25293eab52b8ebb42c1a6ed45eb5a5dedbd117cb4b0206b80
-  data.tar.gz: b13503808204e547d71b958d8ac7691bb040a3b1f3f7c8029e3dc9638753ca58
+  metadata.gz: de07eeede6a20f6904f08e2f4d4caa8e68a1c40c94bebb270967eefb2947c986
+  data.tar.gz: adf3d562172dcbce5132fd744a87a08029d4c84e1e38522f3950fc574f9ba5da
 SHA512:
-  metadata.gz: 234fdde6636efb454f57b9bd12c9a25a087aad982ca732e04114c2dbf9166b118bc39a69d2371064ffe88064bf0760157ee632f84aa8f2ff490f4d4f90e2baa7
-  data.tar.gz: 31d1cafad5793a282bf37705794239d03a1eb8e4a0f7a273db153cef170ed29bf2acd685c6a7c93fcaa0860a8e5c98ee90277a04646066abc351d5e6a4adbe45
+  metadata.gz: 9f39ddfc9ed35543564f30eaeca952d648b8bb6670f5c188f7cdfd5b1696ff41489f641ddffb066acdf556087025122f49432ade8b31b35b5db717c1eb01bc9f
+  data.tar.gz: b24c9088c98bc491425b2b3a4dc7820cc2c1e36541389034c9c5b76f9506e2ac5c4eef3804a167c7188056e83b492225d136829e3b15ed5cad9ce066edb0e242

data/.github/workflows/build.yml

@@ -0,0 +1,21 @@
+name: Build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.ruby-version

@@ -1 +1 @@
-2.6.1
+2.7.0

data/Gemfile.lock

@@ -1,57 +1,39 @@
 PATH
   remote: .
   specs:
-    song_pro (0.1.3)
+    song_pro (0.1.8)
       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)
+    rake (13.0.1)
     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-core (3.8.2)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       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)
+    rspec-support (3.8.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
-  rake (~> 10.0)
+  bundler (~> 2.1.2)
+  rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop
   song_pro!
 
 BUNDLED WITH
-   1.17.2
+   2.1.4

data/README.md

@@ -1,4 +1,4 @@
-# SongPro for Ruby [![Build Status](https://travis-ci.org/spilth/song_pro.svg?branch=master)](https://travis-ci.org/spilth/song_pro)
+# SongPro for Ruby ![Build](https://github.com/SongProOrg/songpro-ruby/workflows/Build/badge.svg?branch=master)
 
 [SongPro](https://songpro.org) is a text format for transcribing songs.
  
@@ -14,30 +14,36 @@ gem 'song_pro'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install song_pro
+```bash
+$ gem install song_pro
+```
 
 ## Usage
 
-Given then file `bad-moon-rising.sng` with the following contents:
+Given then file `escape-capsule.sng` with the following contents:
 
 ```
-@title=Bad Moon Rising
-@artist=Cleedence Clearwater Revival
+@title=Escape Capsule
+@artist=Brian Kelly
+!bandcamp=https://spilth.bandcamp.com/track/escape-capsule-nashville-edition
 
-# Intro
+# Verse 1
 
-[D][A][G][D]
+Climb a-[D]board [A]
+I've been [Bm]waiting for you [F#m]
+Climb a-[G]board [D]
+You'll be [Asus4]safe in [A7]here
 
-# Verse 1
+# Chorus 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
+[G] I'm a [D]rocket [F#]made for your pro-[Bm]tection
+You're [G]safe with me, un-[A]til you leave
 ```
 
 You can then parse the file to create a `Song` object:
@@ -45,18 +51,17 @@ You can then parse the file to create a `Song` object:
 ```ruby
 require 'song_pro'
 
-text = File.read('bad-moon-rising.sng')
+text = File.read('escape-capsule.sng')
 song = SongPro.parse(text)
 
 puts song.title
-# Bad Moon Rising
+# Escape Capsule
 
 puts song.artist
-# Creedence Clearwater Revival 
+# Brian Kelly
 
 puts song.sections[1].title
-# Verse 1
-
+# Chorus 1
 ```
 
 ## Development

data/lib/song_pro.rb

@@ -5,12 +5,17 @@ require 'song_pro/song'
 require 'song_pro/section'
 require 'song_pro/line'
 require 'song_pro/part'
+require 'song_pro/measure'
 
 module SongPro
   SECTION_REGEX = /#\s*([^$]*)/
   ATTRIBUTE_REGEX = /@(\w*)=([^%]*)/
   CUSTOM_ATTRIBUTE_REGEX = /!(\w*)=([^%]*)/
-  CHORDS_AND_LYRICS_REGEX = /(\[[\w#b\/]+\])?([\w\s',.!\(\)_\-"]*)/i
+  CHORDS_AND_LYRICS_REGEX = %r{(\[[\w#b\/]+\])?([^\[]*)}i
+
+  MEASURES_REGEX = %r{([\[[\w#b\/]+\]\s]+)[|]*}i
+  CHORDS_REGEX = %r{\[([\w#b\/]+)\]?}i
+  COMMENT_REGEX = />\s*([^$]*)/
 
   def self.parse(lines)
     song = Song.new
@@ -60,7 +65,6 @@ module SongPro
     song.set_custom(key, value)
   end
 
-
   def self.process_lyrics_and_chords(song, current_section, text)
     return if text == ''
 
@@ -71,16 +75,33 @@ module SongPro
 
     line = Line.new
 
-    if text.start_with?('|')
+    if text.start_with?('|-')
       line.tablature = text
+    elsif text.start_with?('| ')
+      captures = text.scan(MEASURES_REGEX).flatten
+
+      measures = []
+
+      captures.each do |capture|
+        chords = capture.scan(CHORDS_REGEX).flatten
+        measure = Measure.new
+        measure.chords = chords
+        measures << measure
+      end
+
+      line.measures = measures
+    elsif text.start_with?('>')
+      matches = COMMENT_REGEX.match(text)
+      comment = matches[1].strip
+      line.comment = comment
     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 || ''
+      captures.each_slice(2) do |pair|
+        part = Part.new
+        chord = pair[0]&.strip || ''
+        part.chord = chord.delete('[').delete(']')
+        part.lyric = pair[1] || ''
 
         line.parts << part unless (part.chord == '') && (part.lyric == '')
       end

data/lib/song_pro/line.rb

@@ -2,15 +2,25 @@
 
 module SongPro
   class Line
-    attr_accessor :parts, :tablature
+    attr_accessor :parts, :tablature, :measures, :comment
 
     def initialize
       @parts = []
       @tablature = nil
+      @measures = nil
+      @comment = nil
     end
 
     def tablature?
-      return @tablature != nil
+      !@tablature.nil?
+    end
+
+    def measures?
+      !@measures.nil?
+    end
+
+    def comment?
+      !@comment.nil?
     end
   end
-end
+end

data/lib/song_pro/measure.rb

@@ -0,0 +1,9 @@
+module SongPro
+  class Measure
+    attr_accessor :chords
+
+    def initialize
+      @chords = []
+    end
+  end
+end

data/lib/song_pro/song.rb

@@ -24,6 +24,18 @@ module SongPro
       @custom[key.to_sym] = value
     end
 
+    def chords
+      sections.collect do |section|
+        section.lines.collect do |line|
+          if line.measures?
+            line.measures.collect(&:chords)
+          else
+            line.parts.collect(&:chord)
+          end
+        end
+      end.flatten.uniq.reject(&:empty?)
+    end
+
     def to_html
       mab = Markaby::Builder.new(song: self)
       mab.div.song do
@@ -66,6 +78,16 @@ module SongPro
                   div.tablature do
                     line.tablature
                   end
+                elsif line.measures?
+                  div.measures do
+                    line.measures.each do |measure|
+                      div.measure do
+                        measure.chords.each do |chord|
+                          div.chord chord
+                        end
+                      end
+                    end
+                  end
                 else
                   div.line do
                     line.parts.each do |part|

data/lib/song_pro/version.rb

@@ -1,3 +1,3 @@
 module SongPro
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.8'.freeze
 end

data/song_pro.gemspec

@@ -8,15 +8,13 @@ Gem::Specification.new do |spec|
   spec.name          = 'song_pro'
   spec.version       = SongPro::VERSION
   spec.authors       = ['Brian Kelly']
-  spec.email         = ['polymonic@gmail.com  ']
+  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
@@ -27,13 +25,10 @@ Gem::Specification.new do |spec|
   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 'bundler', '~> 2.1.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: song_pro
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Brian Kelly
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: markaby
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,31 +66,17 @@ dependencies:
     - - "~>"
       - !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  '
+- polymonic@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -100,6 +86,7 @@ files:
 - bin/setup
 - lib/song_pro.rb
 - lib/song_pro/line.rb
+- lib/song_pro/measure.rb
 - lib/song_pro/part.rb
 - lib/song_pro/section.rb
 - lib/song_pro/song.rb
@@ -125,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Converts SongPro files to HTML

data/.travis.yml

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