RubyGems - jam_script_highlighter - Versions diffs - 0.0.1 - Mend

jam_script_highlighter 0.0.1

Files changed (33) hide show

data/.gemfiles/Gemfile.travis +9 -0
data/.travis.yml +10 -0
data/Gemfile +2 -0
data/Gemfile.lock +55 -0
data/Guardfile +30 -0
data/Rakefile +17 -0
data/bin/jam_as_html +73 -0
data/bin/jam_as_pdf +78 -0
data/jam_script_highlighter.gemspec +32 -0
data/lib/jam_script_highlighter/html/tag_helpers.rb +5 -0
data/lib/jam_script_highlighter/html.rb +51 -0
data/lib/jam_script_highlighter/line.rb +24 -0
data/lib/jam_script_highlighter/line_types/control_line.rb +9 -0
data/lib/jam_script_highlighter/line_types/empty_line.rb +6 -0
data/lib/jam_script_highlighter/line_types/metadata_line.rb +9 -0
data/lib/jam_script_highlighter/line_types/note_line.rb +9 -0
data/lib/jam_script_highlighter/line_types/other_line.rb +6 -0
data/lib/jam_script_highlighter/line_types/section_line.rb +9 -0
data/lib/jam_script_highlighter/line_types/title_line.rb +9 -0
data/lib/jam_script_highlighter/line_types/variation_line.rb +9 -0
data/lib/jam_script_highlighter/line_types.rb +8 -0
data/lib/jam_script_highlighter/version.rb +9 -0
data/lib/jam_script_highlighter.rb +59 -0
data/readme.md +103 -0
data/test/support/colors.rb +26 -0
data/test/support/helpers/section_helpers.rb +26 -0
data/test/support/jams/jams.rb +42 -0
data/test/support/output.rb +35 -0
data/test/test_helper.rb +41 -0
data/test/unit/jam_script_highlighter/html_test.rb +65 -0
data/test/unit/jam_script_highlighter/line_test.rb +22 -0
data/test/unit/jam_script_highlighter_test.rb +84 -0
metadata +173 -0

data/.gemfiles/Gemfile.travis ADDED Viewed

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+gem 'rake'
+gem 'minitest'
+gem 'turn'
+gem 'rb-fsevent', '~> 0.9.1'
+gem 'hirb'
+gem 'wirble'

data/.travis.yml ADDED Viewed

@@ -0,0 +1,10 @@
+language: ruby
+script: 'bundle exec rake test'
+rvm:
+  - 1.9.2
+  - 1.9.3
+gemfile:
+  - .gemfiles/Gemfile.travis
+notifications:
+  recipients:
+    - adam@29ways.co.uk

data/Gemfile ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ source "http://rubygems.org"
2	+ gemspec

data/Gemfile.lock ADDED Viewed

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    jam_script_highlighter (0.0.1)
+      pdfkit
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ansi (1.4.3)
+    coderay (1.0.8)
+    columnize (0.3.6)
+    debugger (1.2.3)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.5)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.6)
+    guard (1.6.1)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-minitest (0.5.0)
+      guard (>= 0.4)
+    hirb (0.7.0)
+    listen (0.7.1)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    minitest (4.4.0)
+    pdfkit (0.5.2)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rb-fsevent (0.9.3)
+    slop (3.3.3)
+    thor (0.16.0)
+    turn (0.9.6)
+      ansi
+    wirble (0.1.3)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  debugger
+  guard-minitest
+  hirb
+  jam_script_highlighter!
+  minitest
+  rb-fsevent (~> 0.9.1)
+  turn
+  wirble

data/Guardfile ADDED Viewed

@@ -0,0 +1,30 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+def run testfile
+  cmd = "rake test TEST='#{testfile}'"
+  out cmd
+  exec cmd
+end
+guard 'minitest' do
+  # with Minitest::Unit
+  watch(%r|^test/(.*)\/?test_(.*)\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+  # with Minitest::Spec
+  # watch(%r|^spec/(.*)_spec\.rb|)
+  # watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  # watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+  # Rails 3.2
+  # watch(%r|^app/controllers/(.*)\.rb|) { |m| "test/controllers/#{m[1]}_test.rb" }
+  # watch(%r|^app/helpers/(.*)\.rb|)     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r|^app/models/(.*)\.rb|)      { |m| "test/unit/#{m[1]}_test.rb" }
+  # Rails
+  # watch(%r|^app/controllers/(.*)\.rb|) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r|^app/helpers/(.*)\.rb|)     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r|^app/models/(.*)\.rb|)      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/Rakefile ADDED Viewed

@@ -0,0 +1,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+Bundler::GemHelper.install_tasks
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  # t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end

data/bin/jam_as_html ADDED Viewed

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+require 'jam_script_highlighter'
+template = "
+<html>
+<head>
+<title>{{ title }}</title>
+<style>
+body {font-family: arial; font-size: 16px;}
+div {margin: 0px; padding: 0px}
+h1 {font-weight: 400; font-size: 20px; margin-bottom: 2px; text-transform: uppercase}
+h2 {font-weight: 400; font-size: 17px; margin-top: 0px}
+h3 {font-weight: 400; font-size: 19px;}
+h4 {font-weight: 400; font-size: 18px;}
+.container {width: 80%; margin: 0px auto; padding: 20px;-webkit-column-count: 2;-webkit-column-fill: auto;-webkit-column-gap: 50px; height: 90%;}
+p {font-size: 17px}
+.note {color: #505050; font-size: 13px; margin-bottom: 0px; margin-top: 4px; font-style: italic;}
+.control, .section {margin-top: 25px; margin-bottom: 0px; border-bottom: 5px solid #d0d0d0}
+.variation {font-size: 16px; margin-top: 15px; margin-bottom: 0px; border-bottom: 1px solid #d0d0d0}
+.control {margin-bottom: 25px;}
+.chords .other {background-color: #f0f0f0; color: #404040; padding: 10px; margin: 5px 0px;}
+.structure .other {margin: 5px 0px;}
+</style>
+</head>
+<body>
+<div class=\"container\">
+{{ yield }}
+</div>
+</body>
+</html>
+"
+ARGV.each do |a|
+  if File.directory? a
+    files = Dir.glob a
+  else
+    files = [a]
+  end
+  files.each do |fl|
+    puts "Reading #{a}\n"
+    file = File.open(fl, 'r')
+    js = file.read
+    html = ""
+    title = ""
+    html = JamScriptHighlighter::Html.render js
+    template = template.gsub '{{ title }}', title
+    html = template.gsub '{{ yield }}', html
+    output = File.open("#{a}.html", 'w')
+    output << html
+    file.close
+    output.close
+    puts "<< Rendered to #{a}.html >>\n"
+    `open #{a}.html`
+  end
+end

data/bin/jam_as_pdf ADDED Viewed

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+require 'pdfkit'
+require 'jam_script_highlighter'
+template = "
+<html>
+<head>
+<title>{{ title }}</title>
+<style>
+body {font-family: arial; font-size: 16px;}
+div {margin: 0px; padding: 0px}
+h1 {font-weight: 400; font-size: 20px; margin-bottom: 2px; text-transform: uppercase}
+h2 {font-weight: 400; font-size: 17px; margin-top: 0px}
+h3 {font-weight: 400; font-size: 19px;}
+h4 {font-weight: 400; font-size: 18px;}
+.container {width: 80%; margin: 0px auto; padding: 20px;-webkit-column-count: 2;-webkit-column-fill: auto;-webkit-column-gap: 50px; height: 90%;}
+p {font-size: 17px}
+.note {color: #505050; font-size: 13px; margin-bottom: 0px; margin-top: 4px; font-style: italic;}
+.control, .section {margin-top: 25px; margin-bottom: 0px; border-bottom: 5px solid #d0d0d0}
+.variation {font-size: 16px; margin-top: 15px; margin-bottom: 0px; border-bottom: 1px solid #d0d0d0}
+.control {margin-bottom: 25px;}
+.chords .other {background-color: #f0f0f0; color: #404040; padding: 10px; margin: 5px 0px;}
+.structure .other {margin: 5px 0px;}
+</style>
+</head>
+<body>
+<div class=\"container\">
+{{ yield }}
+</div>
+</body>
+</html>
+"
+ARGV.each do |a|
+  if File.directory? a
+    files = Dir.glob a
+  else
+    files = [a]
+  end
+  files.each do |fl|
+    puts "Reading #{a}\n"
+    file = File.open(fl, 'r')
+    js = file.read
+    html = ""
+    title = ""
+    html = JamScriptHighlighter::Html.render js
+    template = template.gsub '{{ title }}', title
+    html = template.gsub '{{ yield }}', html
+    kit = PDFKit.new(html, :page_size => 'A4')
+    # Get an inline PDF
+    pdf = kit.to_pdf
+    # Save the PDF to a file
+    kit.to_file("#{a}.pdf")
+    file.close
+    puts "<< Rendered to #{a}.pdf >>"
+    `open #{a}.pdf`
+  end
+end

data/jam_script_highlighter.gemspec ADDED Viewed

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "jam_script_highlighter/version"
+Gem::Specification.new do |s|
+  s.name        = 'jam_script_highlighter'
+  s.version     = JamScriptHighlighter::VERSION::STRING
+  s.authors     = ["Adam Phillips"]
+  s.description = 'Simple JamScript highlighter'
+  s.summary     = "jam_script_highlighter-#{s.version}"
+  s.email       = ''
+  s.homepage    = ""
+  s.platform    = Gem::Platform::RUBY
+  s.add_dependency 'pdfkit'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'turn'
+  s.add_development_dependency 'debugger'
+  s.add_development_dependency 'guard-minitest'
+  s.add_development_dependency 'rb-fsevent', '~> 0.9.1'
+  s.add_development_dependency 'hirb'
+  s.add_development_dependency 'wirble'
+  s.rubygems_version = ">= 1.6.1"
+  s.files            = `git ls-files`.split("\n").reject {|path| path =~ /\.gitignore$/ }
+  s.test_files       = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.rdoc_options     = ["--charset=UTF-8"]
+  s.require_path     = "lib"
+end

data/lib/jam_script_highlighter/html/tag_helpers.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module JamScriptHighlighter
+  module TagHelpers
+  end
+end

data/lib/jam_script_highlighter/html.rb ADDED Viewed

@@ -0,0 +1,51 @@
+module JamScriptHighlighter
+  module Html
+    class << self
+      def render string, opts={}
+        @html = ''
+        @section_type = 'chords'
+        @processing_metadata = true
+        @processing_section = false
+        js = JamScriptHighlighter.highlight(string)
+        js.each do |line|
+          render_line line
+        end
+        @html += "</div>\n" if @processing_section
+        @html += "</div>\n" unless @processing_metadata
+        @html
+      end
+      def render_line line_details
+        line = Line.new(line_details[:line], line_details[:type])
+        @html += case line_details[:type]
+        when :control
+          ret = ''
+          if @processing_section
+            ret += "</div>\n\n"
+            @processing_section = false
+          end
+          ret += line.to_html
+          @section_type = line.text.downcase
+          ret += "<div class=\"#{@section_type}\">"
+          ret
+        when :section
+          ret = ''
+          ret += "</div>\n\n" if @processing_section
+          ret += line.to_html
+          ret += "<div class=\"#{@section_type}\">"
+          @processing_metadata = false
+          @processing_section = true
+          ret
+        else
+          line.to_html
+        end + "\n"
+      end
+    end
+  end
+end

data/lib/jam_script_highlighter/line.rb ADDED Viewed

@@ -0,0 +1,24 @@
+module JamScriptHighlighter
+  class Line
+    attr_accessor :text
+    def to_html
+      @text || ''
+    end
+    class << self
+      def new text, type=nil
+        if type
+          class_name = "#{type.to_s.split('_').map{|e| e.capitalize}.join}Line"
+          cls = JamScriptHighlighter::LineTypes.const_get(class_name)
+          cls.new text
+        else
+          ret = super()
+          ret.text = text
+          ret
+        end
+      end
+    end
+  end
+end

data/lib/jam_script_highlighter/line_types/control_line.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module JamScriptHighlighter
+  module LineTypes
+    class ControlLine < Line
+      def to_html
+        "<h3 class=\"control\">#{@text}</h3>"
+      end
+    end
+  end
+end

data/lib/jam_script_highlighter/line_types/empty_line.rb ADDED Viewed

@@ -0,0 +1,6 @@
+module JamScriptHighlighter
+  module LineTypes
+    class EmptyLine < Line
+    end
+  end
+end

data/lib/jam_script_highlighter/line_types/metadata_line.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module JamScriptHighlighter
+  module LineTypes
+    class MetadataLine < Line
+      def to_html
+        "<h2>#{@text}</h2>"
+      end
+    end
+  end
+end

data/lib/jam_script_highlighter/line_types/note_line.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module JamScriptHighlighter
+  module LineTypes
+    class NoteLine < Line
+      def to_html
+        "<p class=\"note\">#{@text}</p>"
+      end
+    end
+  end
+end

data/lib/jam_script_highlighter/line_types/other_line.rb ADDED Viewed

@@ -0,0 +1,6 @@
+module JamScriptHighlighter
+  module LineTypes
+    class OtherLine < Line
+    end
+  end
+end

data/lib/jam_script_highlighter/line_types/section_line.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module JamScriptHighlighter
+  module LineTypes
+    class SectionLine < Line
+      def to_html
+        "<h4 class=\"section\">#{@text}</h4>"
+      end
+    end
+  end
+end

data/lib/jam_script_highlighter/line_types/title_line.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module JamScriptHighlighter
+  module LineTypes
+    class TitleLine < Line
+      def to_html
+        "<h1>#{@text}</h1>"
+      end
+    end
+  end
+end

data/lib/jam_script_highlighter/line_types/variation_line.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module JamScriptHighlighter
+  module LineTypes
+    class VariationLine < Line
+      def to_html
+        "<h4 class=\"variation\">#{@text}</h4>"
+      end
+    end
+  end
+end

data/lib/jam_script_highlighter/line_types.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'jam_script_highlighter/line_types/control_line'
+require 'jam_script_highlighter/line_types/empty_line'
+require 'jam_script_highlighter/line_types/metadata_line'
+require 'jam_script_highlighter/line_types/note_line'
+require 'jam_script_highlighter/line_types/other_line'
+require 'jam_script_highlighter/line_types/section_line'
+require 'jam_script_highlighter/line_types/title_line'
+require 'jam_script_highlighter/line_types/variation_line'

data/lib/jam_script_highlighter/version.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module JamScriptHighlighter #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/jam_script_highlighter.rb ADDED Viewed

@@ -0,0 +1,59 @@
+require 'jam_script_highlighter/html'
+require 'jam_script_highlighter/line'
+require 'jam_script_highlighter/line_types'
+module JamScriptHighlighter
+  CONTROL = '#'
+  NOTE = '!'
+  SECTION = '*'
+  VARIATION = '-'
+  class << self
+    def highlight(string)
+      @index = 0
+      @ctrl_char_set = false
+      result = []
+      lines = string.split "\n"
+      lines.each_with_index do |line, index|
+        @index = index
+        result << process(line)
+      end
+      result
+    end
+    def process line
+      type = type_of line
+      if [:control, :note, :section, :variation].include?(type)
+        line = line[1..line.length].strip
+        @ctrl_char_set = true
+      elsif type == :empty
+        @ctrl_char_set = true
+      else
+        unless @ctrl_char_set
+          type = (@index == 0) ? :title : :metadata
+        end
+      end
+      {:type => type, :line => line}
+    end
+    def type_of(line)
+      return :empty if line.empty?
+      case line[0]
+      when CONTROL
+        :control
+      when NOTE
+        :note
+      when SECTION
+        :section
+      when VARIATION
+        :variation
+      else
+        :other
+      end
+    end
+  end
+end

data/readme.md ADDED Viewed

@@ -0,0 +1,103 @@
+JamScript Highligher
+--------------------
+[![Build Status](https://travis-ci.org/adamphillips/JamScriptHighlighter.png?branch=master)](undefined)
+SyntaxHighlighter for [JamScript](https://github.com/adamphillips/JamScript)
+## Installing
+Requires
+- Ruby 1.9.2 or higher
+- [wkhtmltopdf](https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF) for PDF conversion.
+At the command line type
+    gem install jam_script_highlighter
+if you are planning to use the highlighter in a Ruby application and you are using Bundler, add the following to your Gemfile
+    gem 'jam_script_highlighter'
+then at the command line run
+    bundle install
+## Highlighting a JamScript
+To use the highlighter in Ruby, you must first require jam_script_highlighter
+    require 'jam_script_highlighter'
+Then in order to highlight some JamScript, call the JamScriptHighlighter.highlight method passing it the JamScript as a string.  It will return an array of hashes, 1 for each line of the document.  The hash will contain the line of JamScript and its type.  The type will be one of the following
+- :title , The title line of the document. Always the first line
+- :metadata, Document metadata such as composer or tempo
+- :control, A control line such as # Structure, # Chords, # Beats
+- :section, A section of the song such as * Verse, * Chorus
+- :note, A note (textual not musical) about the section
+- :other, Usually data such as chords or beats
+For example
+    require 'jam_script_highlighter'
+    jam1 = "A Funky Tune
+    by Someone Cool
+    tempo 123bpm
+    * Verse
+    C F | G G
+    * Chorus
+    F | C :x4
+    # Structure
+    Verse, Verse, Chorus
+    Verse, Verse, Chorus
+    Chorus
+    "
+    puts JamScriptHighlighter.highlight(jam1).inspect
+    # => [{:type=>:title, :line=>"A Funky Tune"},
+    # {:type=>:metadata, :line=>"by Someone Cool"},
+    # {:type=>:metadata, :line=>"tempo 123bpm"},
+    # {:type=>:section, :line=>"Verse"},
+    # {:type=>:other, :line=>"C F | G G"},
+    # {:type=>:section, :line=>"Chorus"},
+    # {:type=>:other, :line=>"F | C :x4"},
+    # {:type=>:control, :line=>"Structure"},
+    # {:type=>:other, :line=>"Verse, Verse, Chorus"},
+    # {:type=>:other, :line=>"Verse, Verse, Chorus"},
+    # {:type=>:other, :line=>"Chorus"}]
+## Converting to HTML
+To convert a JamScript document to html, at the command line type
+    jam_as_html path/to/jam
+The html will be output to /path/to/jam.html
+You can use wildcards
+    jam_as_html folder/of/jams/*.jam
+This will convert each file that matches the path
+## Converting to a PDF
+This requires that [wkhtmltopdf](https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF) is installed.
+To convert a JamScript document to a pdf, at the command line type
+    jam_as_pdf path/to/jam
+The html will be output to /path/to/jam.pdf
+You can use wildcards
+    jam_as_pdf folder/of/jams/*.jam
+This will convert each file that matches the path

data/test/support/colors.rb ADDED Viewed

@@ -0,0 +1,26 @@
+# Standard terminal color codes
+COLORS = {
+  :reset => '0',
+  :bold => '1',
+  :red => '31',
+  :green => '32',
+  :yellow => '33',
+  :blue => '34',
+  :magenta => '35',
+  :cyan => '36',
+  :white => '37'
+}
+def color(text, color)
+  if COLORS[color]
+    "#{start_color color}#{text}#{reset_color}"
+  end
+end
+def reset_color
+  "\e[#{COLORS[:reset]}m"
+end
+def start_color color
+  "\e[#{COLORS[color]}m"
+end

data/test/support/helpers/section_helpers.rb ADDED Viewed

@@ -0,0 +1,26 @@
+module Kernel
+  def should_parse_bar text, expectations, &block
+    describe "when the text is #{text}" do
+      before do
+        @bar = Parsers::SectionParser.new.bar
+        @text = text
+      end
+      it 'should parse OK' do
+        bar = @bar.parse(@text)[:bar]
+        out bar, :yellow
+        bar[:chords].wont_be_nil
+        bar[:chords].length.must_equal expectations[:notes].length
+        bar[:chords].each_with_index do |ch, i|
+          chord = ch[:chord]
+          chord[:note].must_equal expectations[:notes][i]
+          # note the extra array around the expectation
+          # avoids unsightly [[]] when using
+          chord[:modifiers].must_equal [expectations[:modifiers][i]]
+        end
+      end
+      yield if block_given?
+    end
+  end
+end

data/test/support/jams/jams.rb ADDED Viewed

@@ -0,0 +1,42 @@
+module Kernel
+  # sample jams to use for testing
+  def jams
+    {
+      :single_section => 'A single section jam
+by Someone Cool
+tempo 130bpm
+* Verse
+C F | F G
+C F | C
+',
+      :two_sections => 'A jam in two parts
+by Someone Cooler
+tempo 110bpm
+* Verse
+C F | F G
+C F | C
+* Chorus
+C | F
+',
+      :three_sections => 'A jam in three parts
+by Someone Else
+tempo 50bpm
+* Verse
+C F | F G
+C F | C
+* Chorus
+C | F
+* Bridge
+Am | G | F | G
+'
+    }
+  end
+end

data/test/support/output.rb ADDED Viewed

@@ -0,0 +1,35 @@
+require 'hirb'
+# Output functions
+# =================
+# Functions to format and display output
+# Writes content out to the terminal
+# Use Hirb to format tables.
+# Can specify a color using one of the defined color constants
+#
+# Examples
+#
+#   out 'some_text', :blue  # Prints out the text in blue
+#
+def out(text, text_color=nil, *opts)
+  extend Hirb::Console
+  #text = text.to_a if text.kind_of? ActiveRecord::Base
+  if text.kind_of? Array
+    STDOUT.puts start_color text_color if text_color
+    table text, *opts
+    STDOUT.puts reset_color if text_color
+  else
+    text = color(text.inspect, text_color) if text_color
+    STDOUT.puts "\n\n#{text}"
+  end
+end
+# Puts out an error.
+# The error is written to STDERR and colored in the error color.
+def err(message, backtrace=nil)
+  STDERR.puts color(message, error_color)
+  backtrace.each {|line| line_color = (line[0..1] == '/') ? backtrace_local_color : backtrace_gem_color; STDERR.puts color(line, line_color)} unless backtrace.nil? || backtrace.empty?
+end

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,41 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'turn/autorun'
+begin
+  require 'hirb'
+  require 'wirble'
+  require 'debugger'
+rescue LoadError
+end
+require 'support/colors'
+require 'support/output'
+require 'support/jams/jams'
+require 'jam_script_highlighter'
+def h text
+  JamScriptHighlighter.highlight text
+end
+def htmlr text
+  JamScriptHighlighter::Html.render text
+end
+Turn.config do |c|
+ # use one of output formats:
+ # :outline  - turn's original case/test outline mode [default]
+ # :progress - indicates progress with progress bar
+ # :dotted   - test/unit's traditional dot-progress mode
+ # :pretty   - new pretty reporter
+ # :marshal  - dump output as YAML (normal run mode only)
+ # :cue      - interactive testing
+ c.format  = :cue
+ # turn on invoke/execute tracing, enable full backtrace
+ c.trace   = true
+ # use humanized test names (works only with :outline format)
+ c.natural = true
+end

data/test/unit/jam_script_highlighter/html_test.rb ADDED Viewed

@@ -0,0 +1,65 @@
+require 'test_helper'
+describe JamScriptHighlighter::Html do
+  describe '.render' do
+    describe 'when passed a string' do
+      before do
+        @jam = ''
+      end
+      describe 'containing just a title' do
+        before do
+          @jam += "Some jam\n"
+        end
+        it 'should be wrapped in title tags' do
+          htmlr(@jam).must_match %r{<h1>Some jam</h1>}
+        end
+        describe 'containing metadata' do
+          before do
+            @jam += "by Some one\n"
+          end
+          it 'should wrap the metadata in a metadata div' do
+            htmlr(@jam).must_match %r{<h2>by Some one</h2>}
+          end
+          describe 'containing a section' do
+            before do
+              @jam += "\n* Verse\n"
+            end
+            it 'should contain a h4 with class of section' do
+              htmlr(@jam).must_match %r{<h4 class="section">Verse</h4>}
+            end
+            describe 'containing chords' do
+              before do
+                @jam += "C F | G\n"
+              end
+              it 'should wrap the chords in a containing div' do
+                htmlr(@jam).must_match %r{<div class="chords">\s*.*C F | G.*\s*<\/div>}
+              end
+              describe 'containing a structure' do
+                before do
+                  @jam += "\n# Structure\nVerse, Chorus"
+                end
+                it 'should contain a h3 with a class of control' do
+                  htmlr(@jam).must_match %r{<h3 class="control">Structure</h3>}
+                end
+                it 'should wrap the structure in a structure div' do
+                  htmlr(@jam).must_match %r{<div class="structure">\s*.*Verse, Chorus.*\s*</div>}
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/unit/jam_script_highlighter/line_test.rb ADDED Viewed

@@ -0,0 +1,22 @@
+require 'test_helper'
+describe JamScriptHighlighter::Line do
+  describe '.new' do
+    describe 'when passed just a string' do
+      it 'should return a line with the text property set to the string' do
+        JamScriptHighlighter::Line.new("some text").must_be_kind_of JamScriptHighlighter::Line
+        JamScriptHighlighter::Line.new("some text").text.must_equal 'some text'
+      end
+    end
+    describe 'when a second parameter is passed' do
+      it 'should return the appropriate subclass with the text property set' do
+        JamScriptHighlighter::Line.new("some text", :title).must_be_kind_of JamScriptHighlighter::LineTypes::TitleLine
+        JamScriptHighlighter::Line.new("some text", :title).text.must_equal 'some text'
+        JamScriptHighlighter::Line.new("some text", :variation).must_be_kind_of JamScriptHighlighter::LineTypes::VariationLine
+        JamScriptHighlighter::Line.new("some text", :variation).text.must_equal 'some text'
+      end
+    end
+  end
+end

data/test/unit/jam_script_highlighter_test.rb ADDED Viewed

@@ -0,0 +1,84 @@
+require 'test_helper'
+describe  JamScriptHighlighter do
+  describe '.highlight' do
+    describe 'when passed a single line string' do
+      it 'should return an array containing the hash {:type => :title, :line => ...}' do
+        h('Some text').must_equal [{:type => :title, :line => 'Some text'}]
+      end
+    end
+    describe 'when passed a multiple line string' do
+      it 'should return an array of hashes, 1 for for each line' do
+        h("Some text\nby Some one").must_equal [
+          {
+            :type => :title,
+            :line => 'Some text'
+          }, {
+            :type => :metadata,
+            :line => 'by Some one'
+          }
+        ]
+      end
+    end
+    describe 'when passed a string containing a section' do
+      it 'should return metadata lines until the first control line and type :other' do
+        h("Some text\nby Some one\n\n* Verse\nC F | G G").must_equal [
+          {
+            :type => :title,
+            :line => 'Some text'
+          }, {
+            :type => :metadata,
+            :line => 'by Some one'
+          }, {
+            :type => :empty,
+            :line => ''
+          }, {
+            :type => :section,
+            :line => 'Verse'
+          }, {
+            :type => :other,
+            :line => 'C F | G G'
+          }
+        ]
+      end
+    end
+  end
+  describe '.type_of' do
+    describe 'when passed a line that starts with a #' do
+      it 'should return :control' do
+        JamScriptHighlighter.type_of('# Some line').must_equal :control
+      end
+    end
+    describe 'when passed a line that starts with a !' do
+      it 'should return :note' do
+        JamScriptHighlighter.type_of('! Some line').must_equal :note
+      end
+    end
+    describe 'when passed a line that starts with a *' do
+      it 'should return :section' do
+        JamScriptHighlighter.type_of('* Some line').must_equal :section
+      end
+    end
+    describe 'when the line is empty' do
+      it 'should return :empty' do
+        JamScriptHighlighter.type_of('').must_equal :empty
+      end
+    end
+    describe 'otherwise' do
+      it 'should return :other' do
+        JamScriptHighlighter.type_of('oeiruqw').must_equal :other
+      end
+    end
+  end
+  describe 'repeats?' do
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: jam_script_highlighter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease:
+platform: ruby
+authors:
+- Adam Phillips
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-01-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pdfkit
+  requirement: &2151834560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151834560
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2151833680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151833680
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &2151832060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151832060
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: &2151830180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151830180
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: &2151829020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151829020
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &2151826120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: *2151826120
+- !ruby/object:Gem::Dependency
+  name: hirb
+  requirement: &2151824240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151824240
+- !ruby/object:Gem::Dependency
+  name: wirble
+  requirement: &2151823080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151823080
+description: Simple JamScript highlighter
+email: ''
+executables:
+- jam_as_html
+- jam_as_pdf
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemfiles/Gemfile.travis
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- Rakefile
+- bin/jam_as_html
+- bin/jam_as_pdf
+- jam_script_highlighter.gemspec
+- lib/jam_script_highlighter.rb
+- lib/jam_script_highlighter/html.rb
+- lib/jam_script_highlighter/html/tag_helpers.rb
+- lib/jam_script_highlighter/line.rb
+- lib/jam_script_highlighter/line_types.rb
+- lib/jam_script_highlighter/line_types/control_line.rb
+- lib/jam_script_highlighter/line_types/empty_line.rb
+- lib/jam_script_highlighter/line_types/metadata_line.rb
+- lib/jam_script_highlighter/line_types/note_line.rb
+- lib/jam_script_highlighter/line_types/other_line.rb
+- lib/jam_script_highlighter/line_types/section_line.rb
+- lib/jam_script_highlighter/line_types/title_line.rb
+- lib/jam_script_highlighter/line_types/variation_line.rb
+- lib/jam_script_highlighter/version.rb
+- readme.md
+- test/support/colors.rb
+- test/support/helpers/section_helpers.rb
+- test/support/jams/jams.rb
+- test/support/output.rb
+- test/test_helper.rb
+- test/unit/jam_script_highlighter/html_test.rb
+- test/unit/jam_script_highlighter/line_test.rb
+- test/unit/jam_script_highlighter_test.rb
+homepage: ''
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1597204558210840588
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1597204558210840588
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.10
+signing_key:
+specification_version: 3
+summary: jam_script_highlighter-0.0.1
+test_files: []