yard-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,28 @@
+# yard-pygments
+
+This is a plugin for the [YARD](http://yardoc.org) documentation system
+that adds syntax highlighting for a wide variety of languages
+using the [Pygments](http://pygments.org) syntax highlighter.
+
+## Usage
+
+Once the gem is installed, YARD should automatically load it.
+Then any block of code beginning with `!!!lang` that YARD doesn't recognize
+will be highlighted using Pygments if possible.
+Unless another highlighter is installed, in which case it might take precedence.
+
+By default, YARD itself only recognizes Ruby.
+The full list of languages recognized by Pygments is available [here](http://pygments.org/docs/lexers/).
+The names that will be recognized for these languages are listed under "short names".
+
+## Requirements
+
+yard-pygments requires [rb-pygments](http://github.com/nex3/rb-pygments),
+which in turn requires Pygments itself.
+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,32 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "yard-pygments"
+    gem.summary = %Q{Pygments-based syntax highlighting for YARD.}
+    gem.description = <<DESC
+A plugin for the YARD documentation system that adds syntax highlighting
+for a wide variety of languages using the Pygments highlighter.
+DESC
+    gem.email = "nex342@gmail.com"
+    gem.homepage = "http://github.com/nex3/yard-pygments"
+    gem.authors = ["Nathan Weizenbaum"]
+    gem.add_dependency('yard', '~> 0.5.3')
+    gem.add_dependency('rb-pygments', '= 0.1.0')
+    # 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/yard-pygments.rb

@@ -0,0 +1,21 @@
+require 'rb-pygments'
+
+YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/../templates'
+
+module YARD
+  # @private
+  module Templates::Helpers::HtmlSyntaxHighlightHelper
+    def method_missing(name, *args, &block)
+      type = name.to_s[/^html_syntax_highlight_(.*)/, 1]
+      type = type.downcase if type
+      return super unless type && Pygments.languages.include?(type)
+      source = args.first
+      Pygments.highlight(source, type, :html, :nowrap => true, :classprefix => "pyg-")
+    end
+
+    def respond_to?(name)
+      super || (name =~ /^html_syntax_highlight_(.*)/ &&
+        Pygments.languages.include?($1.downcase))
+    end
+  end
+end

data/templates/default/fulldoc/html/pygments.erb

@@ -0,0 +1 @@
+<%= Pygments.style(:default, :html, :classprefix => "pyg-") %>

data/templates/default/fulldoc/html/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  asset('css/pygments.css', erb(:pygments))
+end

data/templates/default/layout/html/headers.erb

@@ -0,0 +1,2 @@
+<%= superb :headers %>
+<link rel="stylesheet" href="<%= url_for("css/pygments.css") %>" type="text/css" media="screen" charset="utf-8" />

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: yard-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: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.5.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rb-pygments
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+    version: 
+description: |
+  A plugin for the YARD documentation system that adds syntax highlighting
+  for a wide variety of languages using the Pygments highlighter.
+
+email: nex342@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- .yardopts
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/yard-pygments.rb
+- templates/default/fulldoc/html/pygments.erb
+- templates/default/fulldoc/html/setup.rb
+- templates/default/layout/html/headers.erb
+has_rdoc: true
+homepage: http://github.com/nex3/yard-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: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Pygments-based syntax highlighting for YARD.
+test_files: []
+