song_pro 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a60d1b3170f1c93d6715aaf1e6ac32d4f7ea36279fd6337332e548f0d0b27ead
-  data.tar.gz: d6f071f7c7be13424e9861279ddae1cc5edf5f7264dfad1a2bbd9ee66cfcd542
+  metadata.gz: 4a8912e61f72c53d7969bbb24900237db809601766d9c48cf2dd6ebf76eec3f2
+  data.tar.gz: bf71cf6ffed3faa98236eb696826c96934b6576cda6ca217c69d0d9a33f428ad
 SHA512:
-  metadata.gz: 92826523e6724d3f5b94904302a0e2d037af838c6d0d0b5761de1b8a88241bccbd6c2a6be30b18c1eeca7b0e012119584204d7c33d72ffc79c574571ed8cddff
-  data.tar.gz: e63ddc6b96e8538d74b6158fa6ddfa9f7688d9a3b374f82beec5a6381cb8729e41437ee26ea68335114b235ea9d41ff44896435fe31062c2e0a5667b1f68e03f
+  metadata.gz: 216a122140922b1de0745821ef16fa4caeb741ff95db6f1d1c35bf0320117a7f6f87e1d1239efede11a11951c14b325b11282863200642c5a0e06445113badfa
+  data.tar.gz: d7c977c87a85f3a508738d38783941236ec73f9e5eb3e6a79ecd4a8257c94c2d2788df80947b254c10992e903a702727bc0c65876f7e83339c889fb4fb507d82

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.3
+2.7.3

data/.travis.yml

@@ -1,5 +1,7 @@
+---
 sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.1
+  - 2.7.3
+before_install: gem install bundler -v 2.2

data/Gemfile.lock

@@ -1,57 +1,39 @@
 PATH
   remote: .
   specs:
-    song_pro (0.1.4)
+    song_pro (0.1.9)
       markaby
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    builder (3.2.3)
-    diff-lcs (1.3)
-    jaro_winkler (1.5.1)
+    builder (3.2.4)
+    diff-lcs (1.4.4)
     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)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       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.10.0)
+    rspec-support (3.10.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop
+  bundler (>= 2.2.19)
+  rake (~> 13.0)
+  rspec (~> 3.8)
   song_pro!
 
 BUNDLED WITH
-   1.17.2
+   2.2.21

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

@@ -11,9 +11,11 @@ module SongPro
   SECTION_REGEX = /#\s*([^$]*)/
   ATTRIBUTE_REGEX = /@(\w*)=([^%]*)/
   CUSTOM_ATTRIBUTE_REGEX = /!(\w*)=([^%]*)/
-  CHORDS_AND_LYRICS_REGEX = %r{(\[[\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
+  CHORDS_REGEX = %r{\[([\w#b+\/]+)\]?}i
+  COMMENT_REGEX = />\s*([^$]*)/
 
   def self.parse(lines)
     song = Song.new
@@ -88,6 +90,10 @@ module SongPro
       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
 
@@ -95,7 +101,7 @@ module SongPro
         part = Part.new
         chord = pair[0]&.strip || ''
         part.chord = chord.delete('[').delete(']')
-        part.lyric = pair[1]&.strip || ''
+        part.lyric = pair[1] || ''
 
         line.parts << part unless (part.chord == '') && (part.lyric == '')
       end

data/lib/song_pro/line.rb

@@ -2,21 +2,25 @@
 
 module SongPro
   class Line
-    attr_accessor :parts, :tablature, :measures
+    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?
-      return @measures != nil
+      !@measures.nil?
     end
 
+    def comment?
+      !@comment.nil?
+    end
   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

data/lib/song_pro/version.rb

@@ -1,3 +1,3 @@
 module SongPro
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.1.9'.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 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency "bundler", ">= 2.2.19"
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: song_pro
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.9
 platform: ruby
 authors:
 - Brian Kelly
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2021-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: markaby
@@ -28,65 +28,52 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.19
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.19
 - !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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
   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'
+        version: '3.8'
 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"
@@ -126,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Converts SongPro files to HTML