chordproko 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d96af770f5a7ae0615269a3b09207a6a3d2dd8f0
-  data.tar.gz: 9608370884791fd3bb1a1feeab07fdc9056ce345
+  metadata.gz: aefa543a5043450020a858771369ea9baaa6087f
+  data.tar.gz: 2141d68a44e41b6afa4dfd54d1df05d7decfddfc
 SHA512:
-  metadata.gz: 3b91a886179279f72ade0e3de9ed5cf9ab588208de27095e04283ec708517438cfe73b275872f335c3d7ed0efe3c1b5ec358e41518a69dcbd52932c7b0546d3d
-  data.tar.gz: 36b3c3427068a64239b2e8febf458a8d5effde2f786b6dd324b8b7298d68ec763f3011f4b534436cd327fb07c0ecc242e80769002aa451375cfd54de285c6872
+  metadata.gz: cbfaebf6f7eba0b9ff694ba871eb3e4b54bdbc2eb614535794996d2cc5b28f8dbd73498ab7a9dc0af916de2dfda68b1437aef46aadf9c4cd2d4d528f8f57be54
+  data.tar.gz: f390f1ed16cb172af35b68b9af6c5af1b301821a00e8c5ec285d715630f346375db65b5bc142e16bd1e44d82ceaca6b04edb7c1f3924ee3a4300f0bcaa180f75

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/chordproko.svg)](https://badge.fury.io/rb/chordproko)
 # Chordproko
 
 Chordproko is a parser for ruby. It converts chordpro format to a readable text format.
@@ -50,17 +51,46 @@ parsed = Chordproko::Parser.new.parse(file.read)
 ```
 Then, create your own **Transform** class.
 
-## TODO
+### Extending PlainSong Formatter
+```ruby
+class MyPlainSong < Chordproko::PlainSong
+  def initialize transformed, options={}
+    super(transformed, options)
+  end
+  def chord_group_format str
+    "<span>#{str}</span>"
+  end
+  def lyric_line_format str
+    "<div>#{str}</div>"
+  end
+end
+```
 
-+ Enable you to extend PlainSong class
+Set the Chordproko formatter class. This will globally set our formatter.
 
 ```ruby
-class MySongFormat < Chordproko::PlainSong
-	...
-end
+Chordproko.set_formatter_class("PlainSong")
 ```
 
-PlainSong is responsible in formatting the ChordPro format to a readable plain text format. 
+Then use the Chordproko ```.text``` method
+
+Aside from those two methods, you can override these to modify your song sheet.
+
+```ruby
+def chord_line_format str
+  ...
+end
+def comment_format str
+  ...
+end
+def directive_format str
+  ...
+end
+def lyric_format str
+  ...
+end
+```
+## TODO
 
 + Improve specs
 + Improve documentations

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-midnight

data/lib/chordproko.rb

@@ -12,10 +12,15 @@ require "chordproko/sheet"
 require "chordproko/transform"
 require "chordproko/version"
 module Chordproko
+	@@formatter = "Chordproko::PlainSong"
+
+	def self.set_formatter_class formatter
+		@@formatter = formatter
+	end
   def self.text song, options={}
   	parsed = Chordproko::Parser.new.parse(song)
   	transformed = Transform.new.apply(parsed)
-  	sheet = PlainSong.new(transformed, options)
+  	sheet = Object.const_get(@@formatter).new(transformed, options)
   	sheet.to_s
   end
 end

data/lib/chordproko/plain_song.rb

@@ -26,9 +26,9 @@ module Chordproko
 							textified += item.to_s
 					  when "Chordproko::ChordGroup"
 					  	item.key = @options[:transpose] if @options[:transpose] rescue 0
-					  	chord_group = item.to_s
-					   	chords += (" " * (prev_lyrics.size - prev_chord.size).abs)+ chord_group
-					   	prev_chord = chord_group
+					  	cgroup = item.to_s
+					   	chords += (" " * (prev_lyrics.size - prev_chord.size).abs) + chord_group_format(cgroup)
+					   	prev_chord = cgroup
 
 					  when "Chordproko::Lyric"
 					    prev_lyrics = item.to_s
@@ -37,12 +37,31 @@ module Chordproko
 					end #case
 				end #line
 			  chord_lyrics = []
-			  chord_lyrics << chords if chords.size > 0
-			  chord_lyrics << lyrics if lyrics.size > 0
+			  chord_lyrics << chord_line_format(chords) if chords.size > 0
+			  chord_lyrics << lyric_line_format(lyrics) if lyrics.size > 0
 				textified += chord_lyrics.join("\n")
 				textified += "\n"
 			end #sheet
 			textified
 		end
+		
+		def chord_group_format str
+			str
+		end
+		def lyric_line_format str
+			str
+		end
+		def chord_line_format str
+			str
+		end
+		def comment_format str
+			str
+		end
+		def directive_format str
+			str
+		end
+		def lyric_format str
+			str
+		end
 	end
 end

data/lib/chordproko/version.rb

@@ -1,3 +1,3 @@
 module Chordproko
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chordproko
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Joseph Nelson Valeros
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -82,6 +82,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- _config.yml
 - bin/console
 - bin/setup
 - chordproko.gemspec