coderay 1.0.0 → 1.0.0.598.pre

data/FOLDERS

@@ -0,0 +1,49 @@
+= CodeRay - folder structure
+
+== bench - Benchmarking system
+
+All benchmarking stuff goes here.
+
+Test inputs are stored in files named <code>example.<lang></code>.
+Test outputs go to <code>bench/test.<encoder-default-file-extension></code>.
+
+Run <code>bench/bench.rb</code> to get a usage description.
+
+Run <code>rake bench</code> to perform an example benchmark.
+
+
+== bin - Scripts
+
+Executional files for CodeRay.
+
+coderay:: The CodeRay executable.
+coderay_stylesheet:: Prints the default stylesheet.
+
+== demo - Demos and functional tests
+
+Demonstrational scripts to show of CodeRay's features.
+
+Run them as functional tests with <code>rake test:demos</code>.
+
+
+== etc - Lots of stuff
+
+Some addidtional files for CodeRay, mainly graphics and Vim scripts.
+
+
+== lib - CodeRay library code
+
+This is the base directory for the CodeRay library.
+
+
+== rake_helpers - Rake helper libraries
+
+Some files to enhance Rake, including the Autumnal Rdoc template and some scripts.
+
+
+== test - Tests
+
+In the subfolder scanners/ are the scanners tests.
+Each language has its own subfolder and sub-suite.
+
+Run with <code>rake test</code>.

data/Rakefile

@@ -1,7 +1,9 @@
 $:.unshift File.dirname(__FILE__) unless $:.include? '.'
+require 'rake/rdoctask'
 
 ROOT = '.'
 LIB_ROOT = File.join ROOT, 'lib'
+EXTRA_RDOC_FILES = %w(lib/README FOLDERS)
 
 task :default => :test
 
@@ -14,21 +16,20 @@ if File.directory? 'rake_tasks'
   
 else
   
-  # fallback tasks when rake_tasks folder is not present (eg. in the distribution package)
+  # fallback tasks when rake_tasks folder is not present
   desc 'Run CodeRay tests (basic)'
   task :test do
     ruby './test/functional/suite.rb'
     ruby './test/functional/for_redcloth.rb'
   end
   
-  gem 'rdoc' if defined? gem
-  require 'rdoc/task'
   desc 'Generate documentation for CodeRay'
   Rake::RDocTask.new :doc do |rd|
     rd.title = 'CodeRay Documentation'
-    rd.main = 'README_INDEX.rdoc'
+    rd.main = 'lib/README'
     rd.rdoc_files.add Dir['lib']
-    rd.rdoc_files.add rd.main
+    rd.rdoc_files.add 'lib/README'
+    rd.rdoc_files.add 'FOLDERS'
     rd.rdoc_dir = 'doc'
   end
   

data/bin/coderay

@@ -1,215 +1,99 @@
 #!/usr/bin/env ruby
-require 'coderay'
+# CodeRay Executable
+#
+# Version: 0.2
+# Author: murphy
 
-$options, args = ARGV.partition { |arg| arg[/^-[hv]$|--\w+/] }
-subcommand = args.first if /^\w/ === args.first
-subcommand = nil if subcommand && File.exist?(subcommand)
-args.delete subcommand
-
-def option? *options
-  !($options & options).empty?
-end
-
-def tty?
-  $stdout.tty? || option?('--tty')
+def err msg
+  $stderr.puts msg
 end
 
-def version
-  puts <<-USAGE
-CodeRay #{CodeRay::VERSION}
-  USAGE
+def read
+  if file = ARGV[2]
+    File.read file
+  else
+    $stdin.read
+  end
 end
 
-def help
-  puts <<-HELP
-This is CodeRay #{CodeRay::VERSION}, a syntax highlighting tool for selected languages.
-
-usage:
-  coderay [-language] [input] [-format] [output]
-  
-defaults:
-  language   detect from input file name or shebang; fall back to plain text
-  input      STDIN
-  format     detect from output file name or use terminal; fall back to HTML
-  output     STDOUT
-
-common:
-  coderay file.rb                      # highlight file to terminal
-  coderay file.rb > file.html          # highlight file to HTML page
-  coderay file.rb -div > file.html     # highlight file to HTML snippet
-
-configure output:
-  coderay file.py output.json          # output tokens as JSON
-  coderay file.py -loc                 # count lines of code in Python file
-
-configure input:
-  coderay -python file                 # specify the input language
-  coderay -ruby                        # take input from STDIN
+begin
+  require 'coderay'
 
-more:
-  coderay stylesheet [style]           # print CSS stylesheet
-  HELP
-end
+  if ARGV.empty?
+    puts <<-USAGE
+CodeRay #{CodeRay::VERSION} (http://coderay.rubychan.de)
 
-def commands
-  puts <<-COMMANDS
-  general:
-    highlight   code highlighting (default command, optional)
-    stylesheet  print the CSS stylesheet with the given name (aliases: style, css)
-  
-  about:
-    list [of]   list all available plugins (or just the scanners|encoders|styles|filetypes)
-    commands    print this list
-    help        show some help
-    version     print CodeRay version
-  COMMANDS
-end
+Usage:
+  coderay -<lang> [-<format>] < file > output
+  coderay file [-<format>]
 
-def print_list_of plugin_host
-  plugins = plugin_host.all_plugins.map do |plugin|
-    info = "  #{plugin.plugin_id}: #{plugin.title}"
-    
-    aliases = (plugin.aliases - [:default]).map { |key| "-#{key}" }.sort_by { |key| key.size }
-    if plugin.respond_to?(:file_extension) || !aliases.empty?
-      additional_info = []
-      additional_info << aliases.join(', ') unless aliases.empty?
-      info << " (#{additional_info.join('; ')})"
-    end
-    
-    info << '  <-- default' if plugin.aliases.include? :default
-    
-    info
+Examples:
+  coderay -ruby -statistic < foo.rb
+  coderay -ruby < foo.rb  # colorized output to terminal
+  coderay -ruby -page foo.rb  # HTML page output to terminal
+  coderay -ruby -page foo.rb > foo.html  # HTML page output to file
+  coderay codegen.c  # generates codegen.c.html
+    USAGE
   end
-  puts plugins.sort
-end
 
-if option? '-v', '--version'
-  version
-end
+  first, second = ARGV
 
-if option? '-h', '--help'
-  help
-end
-
-case subcommand
-when 'highlight', nil
-  if ARGV.empty?
-    version
-    help
-  else
-    signature = args.map { |arg| arg[/^-/] ? '-' : 'f' }.join
-    names     = args.map { |arg| arg.sub(/^-/, '') }
-    case signature
-    when /^$/
-      exit
-    when /^ff?$/
-      input_file, output_file, = *names
-    when /^f-f?$/
-      input_file, output_format, output_file, = *names
-    when /^-ff?$/
-      input_lang, input_file, output_file, = *names
-    when /^-f-f?$/
-      input_lang, input_file, output_format, output_file, = *names
-    when /^--?f?$/
-      input_lang, output_format, output_file, = *names
+  if first
+    if first[/-(\w+)/] == first
+      lang = $1
+      input = read
+      tokens = :scan
+    elsif first == '-'
+      lang = $1
+      input = read
+      tokens = :scan
     else
-      $stdout = $stderr
-      help
-      puts
-      puts "Unknown parameter order: #{args.join ' '}, expected: [-language] [input] [-format] [output]"
-      exit 1
-    end
-    
-    if input_file
-      input_lang ||= CodeRay::FileType.fetch input_file, :text, true
+      file = first
+      tokens = CodeRay.scan_file file
+      output_filename, output_ext = file, /#{Regexp.escape(File.extname(file))}$/
     end
-    
-    if output_file
-      output_format ||= CodeRay::FileType[output_file]
+  else
+    puts 'No lang/file given.'
+    exit 1
+  end
+
+  if second
+    if second[/-(\w+)/] == second
+      format = $1
     else
-      output_format ||= :terminal
+      raise 'invalid format (must be -xxx)'
     end
-    
-    output_format = :page if output_format.to_s == 'html'
-    
-    if input_file
-      input = File.read input_file
+  else
+    if $stdout.tty?
+      format = :term
     else
-      input = $stdin.read
-    end
-    
-    begin
-      file =
-        if output_file
-          File.open output_file, 'w'
-        else
-          $stdout.sync = true
-          $stdout
-        end
-      CodeRay.encode(input, input_lang, output_format, :out => file)
-      file.puts
-    rescue CodeRay::PluginHost::PluginNotFound => boom
-      $stdout = $stderr
-      if boom.message[/CodeRay::(\w+)s could not load plugin :?(.*?): /]
-        puts "I don't know the #$1 \"#$2\"."
-      else
-        puts boom.message
-      end
-      # puts "I don't know this plugin: #{boom.message[/Could not load plugin (.*?): /, 1]}."
-    rescue CodeRay::Scanners::Scanner::ScanError  # FIXME: rescue Errno::EPIPE
-      # this is sometimes raised by pagers; ignore [TODO: wtf?]
-    ensure
-      file.close if output_file
+      $stderr.puts 'No format given; setting to default (HTML Page).'
+      format = :page
     end
   end
-when 'li', 'list'
-  arg = args.first && args.first.downcase
-  if [nil, 's', 'sc', 'scanner', 'scanners'].include? arg
-    puts 'input languages (Scanners):'
-    print_list_of CodeRay::Scanners
-  end
-  
-  if [nil, 'e', 'en', 'enc', 'encoder', 'encoders'].include? arg
-    puts 'output formats (Encoders):'
-    print_list_of CodeRay::Encoders
-  end
   
-  if [nil, 'st', 'style', 'styles'].include? arg
-    puts 'CSS themes for HTML output (Styles):'
-    print_list_of CodeRay::Styles
+  if tokens == :scan
+    output = CodeRay::Duo[lang => format].highlight input
+  else
+    output = tokens.encode format
   end
-  
-  if [nil, 'f', 'ft', 'file', 'filetype', 'filetypes'].include? arg
-    puts 'recognized file types:'
-    
-    filetypes = Hash.new { |h, k| h[k] = [] }
-    CodeRay::FileType::TypeFromExt.inject filetypes do |types, (ext, type)|
-      types[type.to_s] << ".#{ext}"
-      types
-    end
-    CodeRay::FileType::TypeFromName.inject filetypes do |types, (name, type)|
-      types[type.to_s] << name
-      types
-    end
-    
-    filetypes.sort.each do |type, exts|
-      puts "  #{type}: #{exts.sort_by { |ext| ext.size }.join(', ')}"
+  out = $stdout
+  if output_filename
+    output_filename += '.' + CodeRay::Encoders[format]::FILE_EXTENSION.to_s
+    if File.exist? output_filename
+      err 'File %s already exists.' % output_filename
+      exit
+    else
+      out = File.open output_filename, 'w'
+      puts "Writing to #{output_filename}..."
     end
   end
-when 'stylesheet', 'style', 'css'
-  puts CodeRay::Encoders[:html]::CSS.new(args.first).stylesheet
-when 'commands'
-  commands
-when 'help'
-  help
-else
-  $stdout = $stderr
-  help
-  puts
-  if subcommand[/\A\w+\z/]
-    puts "Unknown command: #{subcommand}"
-  else
-    puts "File not found: #{subcommand}"
-  end
+  out.puts output
+
+rescue => boom
+  err "Error: #{boom.message}\n"
+  err boom.backtrace
+  err '-' * 50
+  err ARGV
   exit 1
 end

data/bin/coderay_stylesheet

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'coderay'
+
+puts CodeRay::Encoders[:html]::CSS.new.stylesheet

data/{README_INDEX.rdoc → lib/README}

@@ -1,45 +1,57 @@
 = CodeRay
 
-Tired of blue'n'gray? Try the original version of this documentation on
-coderay.rubychan.de[http://coderay.rubychan.de/doc/] :-)
+[- Tired of blue'n'gray? Try the original version of this documentation on
+coderay.rubychan.de[http://coderay.rubychan.de/doc/] (use Ctrl+Click to open it in its own frame.) -]
 
 == About
-
 CodeRay is a Ruby library for syntax highlighting.
 
-You put your code in, and you get it back colored; Keywords, strings,
-floats, comments - all in different colors. And with line numbers.
+Syntax highlighting means: You put your code in, and you get it back colored;
+Keywords, strings, floats, comments - all in different colors.
+And with line numbers.
 
 *Syntax* *Highlighting*...
 * makes code easier to read and maintain
 * lets you detect syntax errors faster
 * helps you to understand the syntax of a language
 * looks nice
-* is what everybody wants to have on their website
+* is what everybody should have on their website
 * solves all your problems and makes the girls run after you
 
+Version: 0.9.2
+Author:: murphy (Kornelius Kalnbach)
+Contact:: murphy rubychan de
+Website:: coderay.rubychan.de[http://coderay.rubychan.de]
+License:: GNU LGPL; see LICENSE file in the main directory.
 
 == Installation
 
+You need RubyGems[http://rubyforge.org/frs/?group_id=126].
+
  % gem install coderay
 
 
 === Dependencies
 
-CodeRay needs Ruby 1.8.7+ or 1.9.2+. It also runs on Rubinius and JRuby.
+CodeRay needs Ruby 1.8.6 or later. It also runs with Ruby 1.9.1+ and JRuby 1.1+.
 
 
 == Example Usage
+(Forgive me, but this is not highlighted.)
 
  require 'coderay'
  
- html = CodeRay.scan("puts 'Hello, world!'", :ruby).div(:line_numbers => :table)
+ tokens = CodeRay.scan "puts 'Hello, world!'", :ruby
+ page = tokens.html :line_numbers => :inline, :wrap => :page
+ puts page
 
 
 == Documentation
 
 See CodeRay.
 
+Please report errors in this documentation to <murphy rubychan de>.
+
 
 == Credits
 
@@ -111,8 +123,6 @@ Where would we be without all those people?
   less useless
 * Term::ANSIColor[http://term-ansicolor.rubyforge.org/]
 * PLEAC[http://pleac.sourceforge.net/] code examples
-* Github
-* Travis CI (http://travis-ci.org/rubychan/github)
 
 === Free