ultraviolet 0.10.2 → 1.0.0

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "_pages"]
+	path = _pages
+	url = git@github.com:grosser/ultraviolet.git

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gem 'oniguruma', :platform => :ruby_18
+gem 'textpow', '>=1.3'
+
+group :dev do
+  gem 'rake'
+  gem 'rspec'
+  gem 'rack'
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    oniguruma (1.1.0)
+    plist (3.1.0)
+    rack (1.4.1)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    textpow (1.3.0)
+      plist (>= 3.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  oniguruma
+  rack
+  rake
+  rspec
+  textpow (>= 1.3)

data/Rakefile

@@ -1,51 +1,22 @@
-require 'rubygems'
-require 'fileutils'
+require "bundler/gem_tasks"
 
-rubyforge_name = "ultraviolet"
+task :default do
+  sh "rspec spec/"
+end
+
+# extracted from https://github.com/grosser/project_template
+rule /^version:bump:.*/ do |t|
+  sh "git status | grep 'nothing to commit'" # ensure we are not dirty
+  index = ['major', 'minor','patch'].index(t.name.split(':').last)
+  file = 'lib/uv/version.rb'
 
-begin
-   require 'hoe'
-   
-   class Hoe 
-      # Dirty hack to eliminate Hoe from gem dependencies
-      def extra_deps 
-         @extra_deps.delete_if{ |x| x.first == 'hoe' }
-      end
-   end
-   
-   version = /^== *(\d+\.\d+\.\d+)/.match( File.read( 'History.txt' ) )[1]
-   
-   h = Hoe.new('ultraviolet', version) do |p|
-      p.rubyforge_name = 'ultraviolet'
-      p.author = ['Dizan Vasquez']
-      p.email  = ['dichodaemon@gmail.com']
-      p.email = 'dichodaemon@gmail.com'
-      p.summary = 'Syntax highlighting engine'
-      p.description = p.paragraphs_of('README.txt', 1 ).join('\n\n')
-      p.url = 'http://ultraviolet.rubyforge.org'
-      p.rdoc_pattern = /^(lib|bin|ext)|txt$/
-      p.changes = p.paragraphs_of('History.txt', 0).join("\n\n")
-      p.extra_deps << ['textpow', '>= 0.10.0']
-      p.clean_globs = ["manual/*"]
-   end
-   
-   desc 'Create MaMa documentation'
-   task :mama => :clean do
-      system "mm -c -t refresh -o manual mm/manual.mm"
-   end
-   
-   desc 'Publish MaMa documentation to RubyForge'
-      task :mama_publish => [:clean, :mama] do
-      config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
-      host = "#{config["username"]}@rubyforge.org"
-      remote_dir = "/var/www/gforge-projects/#{h.rubyforge_name}"
-      local_dir = 'manual'
-      system "rsync -av --delete #{local_dir}/ #{host}:#{remote_dir}"
-   end
+  version_file = File.read(file)
+  old_version, *version_parts = version_file.match(/(\d+)\.(\d+)\.(\d+)/).to_a
+  version_parts[index] = version_parts[index].to_i + 1
+  version_parts[2] = 0 if index < 2 # remove patch for minor
+  version_parts[1] = 0 if index < 1 # remove minor for major
+  new_version = version_parts * '.'
+  File.open(file,'w'){|f| f.write(version_file.sub(old_version, new_version)) }
 
-rescue LoadError => e
-   desc 'Run the test suite.'
-   task :test do
-      system "ruby -Ibin:lib:test test_#{rubyforge_name}.rb"
-   end
+  sh "bundle && git add #{file} Gemfile.lock && git commit -m 'bump version to #{new_version}'"
 end

data/Readme.md

@@ -0,0 +1,89 @@
+Ultraviolet is a html syntax highlighting library.<br/>
+It uses [Textpow](https://github.com/grosser/textpow) to supports more than 60 programming languages.
+
+# INSTALL
+
+    gem install ultraviolet
+
+Ruby 1.8: [Install onigumura](https://github.com/grosser/textpow#ruby-18)
+
+# [Demo](http://grosser.github.com/ultraviolet)
+
+# Usage
+
+### Commandline interface
+
+    uv -l syntax # Listing available syntaxes:
+    uv -l themes # Listing available themes:
+    uv lib/uv.rb # Letting to guess the parameters
+    uv -s yaml -t espresso_libre syntax/ini.syntax Specifying a syntax and a theme
+
+    # Output results to `index.html` and copy required files (/eg/ css):
+    uv -c . syntax/ini.syntax > index.html
+
+    # Producing output in latex and converting to pdf:
+    uv -h -o latex lib/uv.rb > uv.tex
+    pdflatex uv.tex
+
+### Ruby interface
+
+    # List of available syntaxes
+    puts Uv.syntaxes.join( ", " )
+
+    # Listing available themes
+    puts Uv.themes.join( ", " )
+
+    # Parsing a css string. Produce xhtml output, with line numbers using amy theme
+    result = Uv.parse( text, "xhtml", "css", true, "amy")
+
+    # Output copy required files for `xhtml` format to directory `site`
+    Uv.copy_files "xhtml", "site"
+
+### Examples
+ - [Macaronic markup engine](http://mama.rubyforge.org)
+ - [Radiograph rails plugin](http://agilewebdevelopment.com/plugins/radiograph)
+ - [SimpleHighlight plugin for SimpleLog](http://www.daikini.com/past/2007/6/14/simplehighlight_syntax_highlighting_for_simplelog)
+
+# TODO
+ - less crazy Uv.parse interface -> options hash
+ - replace them gallery example with some nice example code
+
+# Maintainer info
+
+### Updating demo
+
+    cd _pages
+    bundle exec ruby generate.rb
+    bundle exec rackup
+
+    open http://localhost:9292
+
+### Updating theme files
+
+Currently only XHTML is "officially" supported by ultraviolet, nevertheless,
+experimental latex output support already exists and other output formats can
+be included in the future. This is important because theme conversion is format
+dependent. For xhmtl, the command is `theme2xhtmlrender` as shown in the
+following example.
+
+    theme2xhtmlrender Amy.tmTheme
+
+For latex, the command `theme2latexrender` is used instead.
+
+    theme2latexrender Amy.tmTheme
+
+Authors
+=======
+
+Original author [Dizan Vasquez](https://github.com/dichodaemon).
+
+### [Contributors](https://github.com/grosser/ultraviolet/contributors)
+ - [Chris Hoffman](https://github.com/cehoffman)
+ - [Spox](https://github.com/spox)
+ - [Richard Ramsden](https://github.com/rramsden)
+ - [Humza](https://github.com/secondplanet)
+ - [Harry Brundage](https://github.com/hornairs)
+
+[Michael Grosser](http://grosser.it)<br/>
+michael@grosser.it<br/>
+License: MIT<br/>

data/lib/uv.rb

@@ -1,89 +1,92 @@
+#encoding: ascii-8bit
 require 'fileutils'
 require 'textpow'
 require 'uv/render_processor.rb'
+require "uv/version"
 
 
 module Uv
+  class << self
+    attr_accessor :render_path, :theme_path, :syntax_path, :default_style, :syntaxes
+  end
 
-   def Uv.path
-      result = []
-      result << File.join(File.dirname(__FILE__), ".." )   
-   end
-   
-   def Uv.copy_files output, output_dir
-      Uv.path.each do |dir|
-         dir_name = File.join( dir, "render", output, "files" )
-         FileUtils.cp_r( Dir.glob(File.join( dir_name, "." )), output_dir ) if File.exists?( dir_name )
-      end
-   end
+  self.syntax_path   = Textpow.syntax_path
+  self.render_path   = File.join(File.dirname(__FILE__), '..', 'render')
+  self.theme_path    = File.join(render_path, 'xhtml', 'files', 'css')
+  self.default_style = 'mac_classic'
+  self.syntaxes      = {}
+  
+  def self.path
+    result = []
+    result << File.join(File.dirname(__FILE__), ".." )
+  end
 
-   def Uv.init_syntaxes
-      @syntaxes = {}
-      Dir.glob( File.join(File.dirname(__FILE__), '..', 'syntax', '*.syntax') ).each do |f| 
-         @syntaxes[File.basename(f, '.syntax')] = Textpow::SyntaxNode.load( f )
-      end
-   end
+  def self.syntax_node_for(syntax)
+    if @syntaxes.key?(syntax)
+      @syntaxes[syntax]
+    else
+      @syntaxes[syntax] = Textpow.syntax(syntax) || raise(ArgumentError, "No syntax found for #{syntax}")
+    end
+  end
 
-   def Uv.syntaxes
-      Dir.glob( File.join(File.dirname(__FILE__), '..', 'syntax', '*.syntax') ).collect do |f| 
-         File.basename(f, '.syntax')
-      end
-   end
-   
-   def Uv.themes
-      Dir.glob( File.join(File.dirname(__FILE__), '..', 'render', 'xhtml', 'files', 'css', '*.css') ).collect do |f| 
-         File.basename(f, '.css')
-      end
-   end
+  def self.copy_files(output, output_dir)
+    Uv.path.each do |dir|
+      dir_name = File.join( dir, "render", output, "files" )
+      FileUtils.cp_r( Dir.glob(File.join( dir_name, "." )), output_dir ) if File.exists?( dir_name )
+    end
+  end
 
-   def Uv.syntax_for_file file_name
-      init_syntaxes unless @syntaxes
-      first_line = ""
-      File.open( file_name, 'r' ) { |f|
-         while (first_line = f.readline).strip.size == 0; end
-      }
-      result = []
-      @syntaxes.each do |key, value|
-         assigned = false
-         if value.fileTypes
-            value.fileTypes.each do |t|
-               if t == File.basename( file_name ) || t == File.extname( file_name )[1..-1]
-                  result << [key, value] 
-                  assigned = true
-                  break
-               end
-            end
-         end
-         unless assigned
-            if value.firstLineMatch && value.firstLineMatch =~ first_line
-               result << [key, value] 
-            end
-         end
-      end
-      result
-   end
-   
-   def Uv.parse text, output = "xhtml", syntax_name = nil, line_numbers = false, render_style = "classic", headers = false
-      init_syntaxes unless @syntaxes
-      renderer = File.join( File.dirname(__FILE__), '..',"render", output,"#{render_style}.render")
-      raise( ArgumentError, "Output for #{output} is not yet implemented" ) unless File.exists?(renderer)
-      css_class = render_style
-      render_options = YAML.load( File.open(  renderer ) )
-      render_processor = RenderProcessor.new( render_options, line_numbers, headers )
-      @syntaxes[syntax_name].parse( text,  render_processor )
-      render_processor.string
-   end
+  def self.syntaxes
+    Dir.glob( File.join(@syntax_path, '*.syntax') ).collect do |f| 
+      File.basename(f, '.syntax')
+    end
+  end
 
-   def Uv.debug text, syntax_name
-      unless @syntaxes
-         @syntaxes = {}
-         Dir.glob( File.join(File.dirname(__FILE__), '..', 'syntax', '*.syntax') ).each do |f| 
-            @syntaxes[File.basename(f, '.syntax')] = Textpow::SyntaxNode.load( f )
-         end
+  def self.themes
+    Dir.glob( File.join(@theme_path, '*.css') ).collect do |f| 
+      File.basename(f, '.css')
+    end
+  end
+
+  def self.syntax_for_file(file_name)
+    init_syntaxes unless @syntaxes
+
+    # get first non-empty line
+    first_line = ""
+    File.open( file_name, 'r' ) { |f|
+      while (first_line = f.readline).strip.size == 0; end
+    }
+
+
+    # find syntax by file-extension
+    result = []
+    @syntaxes.each do |key, syntax|
+      assigned = false
+      if syntax.fileTypes
+        syntax.fileTypes.each do |t|
+          if t == File.basename( file_name ) || t == File.extname( file_name )[1..-1]
+            result << [key, syntax]
+            assigned = true
+            break
+          end
+        end
+      end
+      unless assigned
+        if syntax.firstLineMatch && syntax.firstLineMatch =~ first_line
+          result << [key, syntax]
+        end
       end
-      processor = Textpow::DebugProcessor.new
+    end
+    result
+  end
 
-      @syntaxes[syntax_name].parse( text, processor )
-   end
+  def self.parse(text, output = "xhtml", syntax_name = nil, line_numbers = false, render_style = nil, headers = false)
+    RenderProcessor.load(output, render_style, line_numbers, headers) do |processor|
+      syntax_node_for(syntax_name).parse(text, processor)
+    end.string
+  end
 
-end
+  def self.debug(text, syntax_name)
+    syntax_node_for(syntax_name).parse(text, Textpow::DebugProcessor.new)
+  end
+end

data/lib/uv/render_processor.rb

@@ -1,131 +1,140 @@
 require 'cgi'
 
-module Uv   
-   
+module Uv
 
-   class RenderProcessor
-      @@score_manager = Textpow::ScoreManager.new
-      
-      attr_reader :string
-      attr_accessor :escapeHTML
-      
-      def initialize render_options, line_numbers = false, headers = true, score_manager = nil
-         @score_manager = score_manager || @@score_manager
-         @render_options = render_options
-         @options = {}
-         @headers = headers
-         @line_numbers = line_numbers
-         @escapeHTML = true
-      end
-      
-      def start_parsing name
-         @stack = [name]
-         @string = ""
-         @line = nil
-         @line_number = 0
-         print @render_options["document"]["begin"] if @headers
-         print @render_options["listing"]["begin"]
-#         opt = options @stack
-#         print opt["begin"] if opt
-      end
-      
-      def print string
-         @string << string
-      end
-      
-      def escape string
-         if @render_options["filter"]
-            @escaped = string
-            @escaped = self.instance_eval( @render_options["filter"] )
-            @escaped
-         else
-            string
-         end
-      end
-      
-      def open_tag name, position
-         @stack << name
-         print escape(@line[@position...position].gsub(/\n|\r/, '')) if position > @position
-         @position = position
-         opt = options @stack
-         print opt["begin"] if opt
+  class RenderProcessor
+    @@score_manager = Textpow::ScoreManager.new
+
+    attr_reader :string
+    attr_accessor :escapeHTML
+
+    def self.load(output, style = nil, line_numbers = false, headers = false)
+      style  ||= Uv.default_style
+      renderer = File.join( Uv.render_path, output,"#{style}.render")
+      raise( ArgumentError, "Output for #{output} in #{style} style is not yet implemented" ) unless File.exists?(renderer)
+      options   = YAML.load_file(renderer)
+      processor = RenderProcessor.new(options, line_numbers, headers)
+      yield processor if block_given?
+      processor
+    end
+
+    def initialize render_options, line_numbers = false, headers = true, score_manager = nil
+      @score_manager  = score_manager || @@score_manager
+      @render_options = render_options
+      @options        = {}
+      @headers        = headers
+      @line_numbers   = line_numbers
+      @escapeHTML     = true
+    end
+    
+    def start_parsing name
+      @stack       = [name]
+      @string      = ""
+      @line        = nil
+      @line_number = 0
+      print @render_options["document"]["begin"] if @headers
+      print @render_options["listing"]["begin"]
+      #         opt = options @stack
+      #         print opt["begin"] if opt
+    end
+    
+    def print string
+      @string << string
+    end
+    
+    def escape string
+      if @render_options["filter"]
+        @escaped = string
+        @escaped = self.instance_eval( @render_options["filter"] )
+        @escaped
+      else
+        string
       end
-      
-      def close_tag name, position
-         print escape(@line[@position...position].gsub(/\n|\r/, '')) if position > @position
-         @position = position
-         opt = options @stack
-         print opt["end"] if opt
-         @stack.pop
+    end
+    
+    def open_tag name, position
+      @stack << name
+      print escape(@line[@position...position].gsub(/\n|\r/, '')) if position > @position
+      @position = position
+      opt = options @stack
+      print opt["begin"] if opt
+    end
+    
+    def close_tag name, position
+      print escape(@line[@position...position].gsub(/\n|\r/, '')) if position > @position
+      @position = position
+      opt = options @stack
+      print opt["end"] if opt
+      @stack.pop
+    end
+    
+    def close_line
+      stack = @stack[0..-1]
+      while stack.size > 1
+        opt = options stack
+        print opt["end"] if opt
+        stack.pop
       end
-      
-      def close_line
-         stack = @stack[0..-1]
-         while stack.size > 1
-            opt = options stack
-            print opt["end"] if opt
-            stack.pop
-         end
+    end
+    
+    def open_line
+      stack = [@stack.first]
+      clone = @stack[1..-1]
+      while stack.size < @stack.size
+        stack << clone.shift
+        opt = options stack
+        print opt["begin"] if opt
       end
-      
-      def open_line
-         stack = [@stack.first]
-         clone = @stack[1..-1]
-         while stack.size < @stack.size
-            stack << clone.shift
-            opt = options stack
-            print opt["begin"] if opt
-         end
+    end
+    
+    def new_line line
+      if @line
+        print escape(@line[@position..-1].gsub(/\n|\r/, ''))
+        close_line
+        print @render_options["line"]["end"]
+        print "\n" 
       end
-      
-      def new_line line
-         if @line
-            print escape(@line[@position..-1].gsub(/\n|\r/, ''))
-            close_line
-            print @render_options["line"]["end"]
-            print "\n" 
-         end
-         @position = 0
-         @line_number += 1
-         @line = line
-         print @render_options["line"]["begin"]
-         if @line_numbers
-            print @render_options["line-numbers"]["begin"] 
-            print @line_number.to_s.rjust(4).ljust(5)
-            print @render_options["line-numbers"]["end"] 
-            print " "
-         end
-         open_line
+      @position = 0
+      @line_number += 1
+      @line = line
+      print @render_options["line"]["begin"]
+      if @line_numbers
+        print @render_options["line-numbers"]["begin"] 
+        print @line_number.to_s.rjust(4).ljust(5)
+        print @render_options["line-numbers"]["end"] 
+        print " "
       end
-      
-      def end_parsing name
-         if @line
-            print escape(@line[@position..-1].gsub(/\n|\r/, '')) 
-            while @stack.size > 1
-               opt = options @stack
-               print opt["end"] if opt
-               @stack.pop
-            end
-            print @render_options["line"]["end"]
-            print "\n"
-         end
-#         opt = options @stack
-#         print opt["end"] if opt
-         @stack.pop
-         print @render_options["listing"]["end"]
-         print @render_options["document"]["end"] if @headers
+      open_line
+    end
+    
+    def end_parsing name
+      if @line
+        print escape(@line[@position..-1].gsub(/\n|\r/, '')) 
+        while @stack.size > 1
+          opt = options @stack
+          print opt["end"] if opt
+          @stack.pop
+        end
+        print @render_options["line"]["end"]
+        print "\n"
       end
-      
-      def options stack
-         ref = stack.join ' '
-         return @options[ref] if @options.has_key? ref
-         
-         result = @render_options['tags'].max do |a, b| 
-            @score_manager.score( a['selector'], ref ) <=> @score_manager.score( b['selector'], ref )
-         end
-         result = nil if @score_manager.score( result['selector'], ref ) == 0
-         @options[ref] = result
+      #         opt = options @stack
+      #         print opt["end"] if opt
+      @stack.pop
+      print @render_options["listing"]["end"]
+      print @render_options["document"]["end"] if @headers
+    end
+    
+    def options stack
+      ref = stack.join ' '
+      return @options[ref] if @options.has_key? ref
+    
+      result = @render_options['tags'].max do |a, b| 
+        @score_manager.score( a['selector'], ref ) <=> @score_manager.score( b['selector'], ref )
       end
-   end
+      result = nil if @score_manager.score( result['selector'], ref ) == 0
+      @options[ref] = result
+    end
+  end
 end