chordproko 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d96af770f5a7ae0615269a3b09207a6a3d2dd8f0
+  data.tar.gz: 9608370884791fd3bb1a1feeab07fdc9056ce345
+SHA512:
+  metadata.gz: 3b91a886179279f72ade0e3de9ed5cf9ab588208de27095e04283ec708517438cfe73b275872f335c3d7ed0efe3c1b5ec358e41518a69dcbd52932c7b0546d3d
+  data.tar.gz: 36b3c3427068a64239b2e8febf458a8d5effde2f786b6dd324b8b7298d68ec763f3011f4b534436cd327fb07c0ecc242e80769002aa451375cfd54de285c6872

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at valerosjoseph@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Joseph Nelson Valeros
+
+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,80 @@
+# Chordproko
+
+Chordproko is a parser for ruby. It converts chordpro format to a readable text format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chordproko'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chordproko
+
+## Usage
+
+Suppose you have a song sheet written in ChordPro format:
+
+```ruby
+sheet = "Th[C]is is a sam[G]ple lyr[Em]ic with ch[D]ord"
+readable_sheet = Chordproko.text(sheet)
+```
+
+Or load from file
+
+```ruby
+file = File.new("file_location")
+readable_sheet = Chordproko.text(file.read)
+```
+### Transposing
+
+You can transpose a song by adding ```transpose``` option.
+
+```ruby
+readable_sheet = Chordproko.text(file.read, transpose: 2)
+``` 
+Negative value means transpose down, otherwise, transpose up.
+
+### Using raw data
+
+Create your own algorithm using the result of Chordproko **Parser**. It uses parslet so you have to learn parslet first. You can check the source code for rules.
+```ruby
+parsed = Chordproko::Parser.new.parse(file.read)
+```
+Then, create your own **Transform** class.
+
+## TODO
+
++ Enable you to extend PlainSong class
+
+```ruby
+class MySongFormat < Chordproko::PlainSong
+	...
+end
+```
+
+PlainSong is responsible in formatting the ChordPro format to a readable plain text format. 
+
++ Improve specs
++ Improve documentations
++ Improve source (so many unnecessary lines. It works, so it's fine for now.)
++ Support ```b``` flat sign 
++ Implement PlainSong methods with block (Might help a lot in customizing contents.)
++ Add settings and customization
++ Learns sheet key.
+
+## Contributing
+
+I'm certain that you have reached this section haha. This is my first gem, I still have a lot to learn. You can report errors, suggest features and create pull requests here, https://github.com/neume/chordproko.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+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 "chordproko"
+
+# 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/chordproko.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chordproko/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chordproko"
+  spec.version       = Chordproko::VERSION
+  spec.authors       = ["Joseph Nelson Valeros"]
+  spec.email         = ["valerosjoseph@gmail.com"]
+
+  spec.summary       = "Ruby ChordPro parser"
+  spec.description   = "It converts ChordPro File to a readable plain text chord sheet"
+  spec.homepage      = "https://github.com/neume/chordproko"
+  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'] = "TODO: Set to 'http://mygemserver.com'"
+  # 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 'parslet','~> 1.8'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/chordproko/chord.rb

@@ -0,0 +1,40 @@
+module Chordproko
+
+	class Chord
+	  attr_accessor :content, :key
+	  def initialize content
+	    @content = content	
+	    @chord_list = ["C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B"]
+	    @chord_indexes = {
+	      "C" => 0,
+	      "D" => 2,
+	      "E" => 4,
+	      "F" => 5,
+	      "G" => 7,
+	      "A" => 9,
+	      "B" => 11,
+	    }
+	  end
+	  def each(&block)
+	  	[self].each(&block)
+	  end
+	  def to_s
+	    "#{transpose_key}"
+	  end
+	  def transpose_key
+	    return @content.to_s if @key == 0
+	    chord_value = @chord_indexes[@content.to_s[0]]
+	    @content.to_s[1..-1].each_char do |mod|
+	      case mod
+	      when "#"
+	        chord_value += 1
+	      when "b"
+	        chord_value -= 1
+	      end
+	    end
+	    chord_index = (chord_value + @key)% 12
+	    res = @chord_list[chord_index]
+
+	  end
+	end
+end

data/lib/chordproko/chord_group.rb

@@ -0,0 +1,20 @@
+module Chordproko
+	class ChordGroup
+	  attr_accessor :content, :key
+	  def initialize content
+	    @content = content
+	    @key = 0
+	  end
+	  def each(&block)
+	  	[self].each(&block)
+	  end
+	  def to_s
+	  	@content.each do |c|
+	    	if c.class.to_s == "Chordproko::Chord"
+	    		c.key = @key
+	    	end
+	   		c.to_s
+	    end.join
+	  end
+	end
+end

data/lib/chordproko/comment.rb

@@ -0,0 +1,15 @@
+module Chordproko
+	class Comment
+	  attr_accessor :content
+	  def each(&block)
+	  	[self].each(&block)
+	  end
+	  def initialize content
+	    @content = content
+	  end
+
+	  def to_s
+	    "#{@content}"
+	  end
+	end
+end

data/lib/chordproko/directive.rb

@@ -0,0 +1,16 @@
+module Chordproko
+	class Directive
+	  attr_accessor :key, :value
+
+	  def each(&block)
+	  	[self].each(&block)
+	  end
+	  def initialize key, value
+	    @key = key
+	    @value = value
+	  end
+	  def to_s
+	    "#{@key.to_s.capitalize}: #{@value}"
+	  end
+	end
+end

data/lib/chordproko/line.rb

@@ -0,0 +1,36 @@
+module Chordproko
+  class Line
+    attr_accessor :content
+    def initialize content
+      @content = content
+    end
+
+    def each(&block)
+      @content.each(&block) rescue [@content]
+    end
+    def to_s
+      case @content.class.to_s
+      when "Chordproko::Comment"
+        @content.to_s
+      when "Chordproko::Directive"
+        @content.to_s
+      when "String"
+        ""
+      else
+        chords = ""
+        lyrics = ""
+        prev_lyrics = ""
+        @content.each do |c|
+          case c.class.to_s
+          when "Chordproko::ChordGroup"
+            chords += " " * prev_lyrics.size + "#{c}"
+          when "Chordproko::Lyric"
+            prev_lyrics = "#{c}"
+            lyrics += "#{c}"
+          end
+        end
+        "#{chords}\n#{lyrics}"
+      end
+    end
+  end
+end

data/lib/chordproko/lyric.rb

@@ -0,0 +1,14 @@
+module Chordproko
+	class Lyric
+	  attr_accessor :content
+	  def initialize content
+	    @content = content
+	  end
+	  def each(&block)
+	  	[self].each(&block)
+	  end
+	  def to_s
+	    "#{@content.to_s}"
+	  end
+	end
+end

data/lib/chordproko/newline.rb

@@ -0,0 +1,14 @@
+module Chordproko
+	class Newline
+	  attr_accessor :content
+	  def initialize content
+	    @content = content
+	  end
+	  def each(&block)
+	  	[self].each(&block)
+	  end
+	  def to_s
+	    ""
+	  end
+	end
+end

data/lib/chordproko/parser.rb

@@ -0,0 +1,41 @@
+require 'parslet'
+require 'parslet/convenience'
+module Chordproko
+  class Parser < Parslet::Parser
+ # Characters
+  rule(:space)    { match('\s').repeat }
+  rule(:newline)  { str("\n")}
+  rule(:lbrace)   { str('{') }
+  rule(:rbrace)   { str('}') }
+  rule(:lbracket) { str('[') }
+  rule(:rbracket) { str(']') }
+  rule(:colon)    { str(':')}
+  rule(:sharp) { str('#') }
+  rule(:flat) { str('b') }
+  rule(:chord_modifier) { sharp.maybe >> flat.maybe}
+  rule(:chord_base) {match('[ABCDEFG]')}
+  rule(:chord) { (chord_base >> chord_modifier.maybe).as(:chord) }
+  rule(:chord_delim) { (rbracket.absent? >> chord_base.absent? >>  any).repeat(0).as(:chord_delim) }
+  rule(:chords) { (lbracket >> ((rbracket.absent? >> (chord | chord_delim)).repeat(1)).as(:chords) >> rbracket) }
+  rule(:lyric) { (lbracket.absent? >> newline.absent? >> any).repeat(1).as(:lyric)}
+  rule(:comments) do
+   (sharp >> (newline.absent? >> any).repeat).as(:comment)
+  end
+  rule(:lyrics) do
+    ( (newline.absent? >> ( chords | lyric )).repeat(1))
+  end
+  rule(:key) { match["a-z"].repeat(1).as(:key)}
+  rule(:value) { ((rbrace.absent? >> any).repeat(1)).as(:value)}
+  rule(:directive) do
+    (key >> space.maybe >> colon >> space.maybe >> value).as(:directive)
+  end
+  rule(:directives) do
+    (lbrace >> space.maybe >> (rbrace.absent? >> directive) >> rbrace)
+  end
+  rule(:line) { ((comments | directives | lyrics | newline.as(:newline)) >> newline.maybe).as(:line)}
+  rule(:lines) { line.repeat(1)}
+  rule(:sheet) { lines.as(:sheet) }
+
+  root(:sheet)
+  end
+end

data/lib/chordproko/plain_song.rb

@@ -0,0 +1,48 @@
+module Chordproko
+	class PlainSong
+		def initialize sheet, options={transpose: 1}
+			@sheet = sheet
+			@options = options
+		end
+		def to_s
+			content
+		end
+		def content
+			@content ||= generate
+		end
+		def generate
+			textified = ""
+			@sheet.each do |line|
+				chords = ""
+				lyrics = ""
+				prev_lyrics = ""
+				prev_chord = ""
+				line.each do |element|
+					element.each do |item|
+						case item.class.to_s
+						when "Chordproko::Comment"
+							textified += item.to_s
+						when "Chordproko::Directive"
+							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
+
+					  when "Chordproko::Lyric"
+					    prev_lyrics = item.to_s
+					    lyrics += item.to_s
+					  end
+					end #case
+				end #line
+			  chord_lyrics = []
+			  chord_lyrics << chords if chords.size > 0
+			  chord_lyrics << lyrics if lyrics.size > 0
+				textified += chord_lyrics.join("\n")
+				textified += "\n"
+			end #sheet
+			textified
+		end
+	end
+end

data/lib/chordproko/sheet.rb

@@ -0,0 +1,16 @@
+module Chordproko
+	class Sheet
+	  attr_accessor :content, :transpose
+	  def initialize content
+	    @content = content
+	  end
+	  def each(&block)
+	  	@content.each(&block)
+	  end
+	  def to_s
+	    @content.each do |line|
+	      "#{line}"
+	    end.join("\n")
+	  end
+	end
+end

data/lib/chordproko/transform.rb

@@ -0,0 +1,15 @@
+module Chordproko
+	class Transform < Parslet::Transform
+	  rule(newline: simple(:x)) 			{ "" }
+	  rule(comment: simple(:x)) 			{ Chordproko::Comment.new(x)}
+	  rule(chord: simple(:x))					{ Chordproko::Chord.new(x)}
+	  rule(chord_delim: simple(:delim)) { "#{delim}" }
+	  rule(lyric: simple(:x)) 				{ Chordproko::Lyric.new(x)}
+	  rule(directive: { key: simple(:key), value: simple(:value) }) do
+	  	Chordproko::Directive.new(key, value)
+	  end
+	  rule(chords: subtree(:chords)) 	{ Chordproko::ChordGroup.new(chords)}
+	  rule(line: subtree(:line))			{ Chordproko::Line.new(line) }
+	  rule(sheet: sequence(:sheet)) 	{ Chordproko::Sheet.new(sheet) }
+	end
+end

data/lib/chordproko/version.rb

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

data/lib/chordproko.rb

@@ -0,0 +1,21 @@
+
+require "chordproko/chord"
+require "chordproko/chord_group"
+require "chordproko/comment"
+require "chordproko/directive"
+require "chordproko/line"
+require "chordproko/lyric"
+require "chordproko/newline"
+require "chordproko/parser"
+require "chordproko/plain_song"
+require "chordproko/sheet"
+require "chordproko/transform"
+require "chordproko/version"
+module Chordproko
+  def self.text song, options={}
+  	parsed = Chordproko::Parser.new.parse(song)
+  	transformed = Transform.new.apply(parsed)
+  	sheet = PlainSong.new(transformed, options)
+  	sheet.to_s
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: chordproko
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Nelson Valeros
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: It converts ChordPro File to a readable plain text chord sheet
+email:
+- valerosjoseph@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chordproko.gemspec
+- lib/chordproko.rb
+- lib/chordproko/chord.rb
+- lib/chordproko/chord_group.rb
+- lib/chordproko/comment.rb
+- lib/chordproko/directive.rb
+- lib/chordproko/line.rb
+- lib/chordproko/lyric.rb
+- lib/chordproko/newline.rb
+- lib/chordproko/parser.rb
+- lib/chordproko/plain_song.rb
+- lib/chordproko/sheet.rb
+- lib/chordproko/transform.rb
+- lib/chordproko/version.rb
+homepage: https://github.com/neume/chordproko
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby ChordPro parser
+test_files: []