rb-pygments 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+/pkg
+/doc
+/.yardoc

data/.yardopts

@@ -0,0 +1,3 @@
+--markup          markdown
+--markup-provider maruku
+--no-private

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Nathan Weizenbaum
+
+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,31 @@
+# rb-pygments
+
+This is a wrapper for the [Pygments](http://pygments.org) syntax highlighter.
+It can be used to highlight a wide variety of languages in a wide variety of formats.
+
+## Usage
+
+All functionality is available through the {Pygments} module.
+Highlighting is done via the {Pygments.highlight highlight} method,
+like so (reformatted for readability:
+
+    Pygments.highlight("Some.ruby(:code)", :ruby, :html, :nowrap => true)
+      #=> <span class="no">Some</span>
+          <span class="o">.</span>
+          <span class="n">ruby</span>
+          <span class="p">(</span>
+          <span class="ss">:code</span>
+          <span class="p">)</span>
+
+Stylesheets and such can be retrieved via the {Pygments.style style} method.
+
+## Requirements
+
+yard-pygments requires that Pygments be installed.
+Since Pygments is written in Python, it needs to be installed manually.
+If you've got [`easy_install`](http://peak.telecommunity.com/DevCenter/EasyInstall), you can do
+
+    !!!sh
+    easy_install Pygments
+
+Otherwise, it can be downloaded [here](http://pypi.python.org/pypi/Pygments).

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rb-pygments"
+    gem.summary = %Q{A Ruby wrapper for the Pygments syntax highlighter.}
+    gem.description = gem.summary
+    gem.email = "nex342@gmail.com"
+    gem.homepage = "http://github.com/nex3/rb-pygments"
+    gem.authors = ["Nathan Weizenbaum"]
+    gem.add_development_dependency('yard', '~> 0.5.3')
+    gem.requirements << 'pygments, 1.2.2 or greater'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rb-pygments.rb

@@ -0,0 +1,76 @@
+require 'shellwords'
+
+# A wrapper for the [Pygments](http://pygments.org) command-line interface.
+module Pygments
+  class << self
+    # Returns a list of all langauges supported by Pygments.
+    # This list contains the short names of the languages
+    # as documented [on the Pygments site](http://pygments.org/docs/lexers/).
+    #
+    # @return [Array<String>]
+    def languages
+      @languages ||= languages!
+    end
+
+    # Returns the style definitions for a given style and formatter.
+    # For example, returns the CSS definitions for the HTML formatter
+    # and the LaTeX style definitions for the LaTeX formatter.
+    #
+    # @param style [#to_s] The name of the color theme to use, e.g. `:default` or `:colorful`.
+    #   The full list of color themes can be found by running `pygmentize -L styles`.
+    # @param formatter [#to_s] The name of the formatter to use, e.g. `:html` or `:latex`.
+    #   The full list of formatters can be found by running `pygmentize -L formatters`,
+    #   or [online](http://pygments.org/docs/formatters/).
+    #   At time of writing only `:html` and `:latex` support styles.
+    # @param options [{String => String}] Options passed to the formatter.
+    #   These are formatter-specific;
+    #   available options for a formatter can be found by running
+    #   `pygmentize -H formatter #{formatter}`.
+    # @return [String]
+    def style(style, formatter, options = {})
+      execute(["-S", style, "-f", formatter] + convert_options(options))
+    end
+
+    # Returns the source code, highlighted using the given lexer and formatter.
+    # For example, returns HTML markup surrounding the source code for the `:html` formatter,
+    # or LaTeX markup for the `:latex` formatter.
+    #
+    # @param source [String] The source code to be highlighted
+    # @param lexer [#to_s] The name of the lexer (that is, language) to use, e.g. `:ruby` or `:python`.
+    #   The full list of lexers can be found by running `pygmentize -L lexers`,
+    #   or [online](http://pygments.org/docs/lexers/).
+    # @param formatter [#to_s] The name of the formatter to use, e.g. `:html` or `:latex`.
+    #   The full list of formatters can be found by running `pygmentize -L formatters`,
+    #   or [online](http://pygments.org/docs/formatters/).
+    # @param options [{String => String}] Options passed to the formatter and lexer.
+    #   These are specific to the formatter and lexer being used;
+    #   available options can be found by running `pygmentize -H formatter #{formatter}`
+    #   or `pygmentize -H lexer #{lexer}`.
+    # @return [String]
+    def highlight(source, lexer, formatter, options = {})
+      execute(["-l", lexer, "-f", formatter] + convert_options(options), source)
+    end
+
+    private
+
+    def convert_options(options)
+      options.inject([]) {|a, (n, v)| a + ["-P", "#{n}=#{v}"]}
+    end
+
+    def languages!
+      execute(%w[-L lexers]).split("\n").grep(/^\* (.*):$/) {$1.split(",").map {|s| s.strip}}.flatten
+    end
+
+    def execute(flags, stdin = nil)
+      flags = flags.flatten.map {|f| Shellwords.shellescape(f.to_s)}.join(" ")
+      IO.popen("pygmentize #{flags}", stdin ? "r+" : "r") do |io|
+        if stdin
+          io.puts stdin
+          io.close_write
+        end
+
+        io.read
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: rb-pygments
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nathan Weizenbaum
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-24 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.5.3
+    version: 
+description: A Ruby wrapper for the Pygments syntax highlighter.
+email: nex342@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- .yardopts
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/rb-pygments.rb
+has_rdoc: true
+homepage: http://github.com/nex3/rb-pygments
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- pygments, 1.2.2 or greater
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the Pygments syntax highlighter.
+test_files: []
+