spec/lib/highlight_spec.rb
spec/lib/pygments_wrapper_spec.rb
spec/lib/view_methods_spec.rb
@@ -1,20 +1,34 @@
= Highlight
-Highlight is a simple syntax highlighting plugin for Ruby on Rails. It's basically a wrapper around the python project
-pygments (http://pygments.org/) that support various languages.
+Highlight is a simple syntax highlighting plugin for Ruby on Rails. It's basically a wrapper around the popular http://pygments.org
+highlighter that's written in Python and supports a huge number of languages.
-The plugin adds a new method available in all templates:
+Highlight provides a new method that's available in views:
- highlight(language, code)
+ highlight(language, code = nil, &block)
-where language can be either a symbol or a string (most file extensions should work for example)
++language+ may be either a Symbolor a String (see supported languages below). The code can be passed either as a string or inside
+a block, e.g.:
+
+ highlight(:ruby, 'class Test; end')
+
+or
+
+ highlight(:ruby) do
+ <<-EOF
+ class Test
+ end
+ EOF
+ end
To perform the highlighting, the code is first written to a file in /tmp, e.g.:
/tmp/highlight_1225993290.70882
-Since writing that file, passing its contents on to pygments etc. takes a while, all highlighted source code should be cached
-of course, e.g.:
+This file is the passed to pygments that returns the HTML and so on...
+
+Since writing that file, passing its contents on to pygments, retrieve the result etc. takes a while, all highlighted source
+code should be cached of course, e.g.:
<% cache do %>
<%= highlight(:ruby, 'class Test; end') -%>
@@ -24,7 +38,7 @@ of course, e.g.:
== Supported Languages
The following languages are supported. All of the paranthesized identifiers may be used as parameters for highlight to denote the
-language the source code to highlight is written in.
+language the source code to highlight is written in (use either Symbols or Strings).
* Actionscript (as, as3, actionscript)
* Applescript (applescript)
@@ -84,9 +98,9 @@ At the moment there are neither TODOs nor future plans. If you want ot suggest a
== Author
-Copyright (c) 2008 Marco Otte-Witte (http://simplabs.com/#projects), released under the MIT license
+Copyright (c) 2008-2009 Marco Otte-Witte (http://simplabs.com), released under the MIT license
== Acknowledgements
-The actual highlighting is done by Pygments (http://pygments.org/).
\ No newline at end of file
+The actual highlighting is done by Pygments (http://pygments.org).
\ No newline at end of file
README.rdoc
@@ -1,7 +1,7 @@
require 'simplabs/highlight'
-if IO::popen("which pygmentize").read == ''
- puts " ** [Highlight] pygments cannot be found, highlighting code won't work!"
+if `which pygmentize`.blank?
+ puts "*** [Highlight] pygments cannot be found, highlighting code won't work!"
Simplabs::Highlight.initialized = false
else
Simplabs::Highlight.initialized = true
init.rb
@@ -1,27 +1,9 @@
module Simplabs
- # Highlight is a simple source code highlighting plugin for Ruby on Rails. It's basically a wrapper around the python project
- # pygments (http://pygments.org/) that support various languages.
+ # = Highlight
#
- # The plugin adds a new method available in all templates:
- #
- # highlight(language, code)
- #
- # where language can be either a symbol or a string (most file extensions should work for example)
- #
- # To perform the highlighting, the code is first written to a file in /tmp, e.g.:
- #
- # /tmp/highlight_1225993290.70882
- #
- # Since writing that file, passing its contents on to pygments etc. takes a while, all highlighted source code should be cached
- # of course, e.g.:
- #
- # <% cache do %>
- # <%= highlight(:ruby) do -%>
- # class Test
- # end
- # <% end -%>
- # <% end %>
+ # Highlight is a simple syntax highlighting plugin for Ruby on Rails. It's basically a wrapper around the popular http://pygments.org
+ # highlighter that's written in Python and supports a huge number of languages.
module Highlight
mattr_accessor :initialized
@@ -60,6 +42,76 @@ module Simplabs
:yaml => ['yaml', 'yml']
}
+ # Highlights the passed +code+ with the appropriate rules according to the specified +language+.
+ #
+ # <b>Supported Languages</b>
+ #
+ # The following languages are supported. All of the paranthesized identifiers may be used as parameters for highlight to denote the
+ # language the source code to highlight is written in (use either Symbols or Strings).
+ #
+ # * Actionscript (as, as3, actionscript)
+ # * Applescript (applescript)
+ # * bash (bash, sh)
+ # * C (c, h)
+ # * Clojure (clojure)
+ # * C++ (c++, cpp, hpp)
+ # * C# (c#, csharp, cs)
+ # * CSS (css)
+ # * diff (diff)
+ # * Dylan (dylan)
+ # * Erlang (erlang, erl, er)
+ # * HTML (html, htm)
+ # * Java (java)
+ # * JavaScript (javascript, js, jscript)
+ # * JSP (jsp)
+ # * Make (make, basemake, makefile)
+ # * Objective-C (objective-c)
+ # * OCaml (ocaml)
+ # * Perl (perl, pl)
+ # * PHP (php)
+ # * Python (python, (py)
+ # * RHTML (erb, rhtml)
+ # * Ruby (ruby, rb)
+ # * Scala (scala)
+ # * Scheme (scheme)
+ # * Smalltalk (smalltalk)
+ # * Smarty (smarty)
+ # * SQL (sql)
+ # * XML (xml, xsd)
+ # * XSLT (xslt)
+ # * YAML (yaml, yml)
+ def self.highlight(language, code)
+ return CGI.escapeHTML(code) unless Simplabs::Highlight.initialized
+ Simplabs::Highlight::PygmentsWrapper.highlight(code, language)
+ end
+
+ # Highlight view methods
+ module ViewMethods
+
+ # Highlights the passed +code+ with the appropriate rules according to the specified +language+. The code can
+ # be specified either as a string or as result f a block.
+ #
+ # <b>Examples:</b>
+ #
+ # highlight(:ruby, 'class Test; end')
+ #
+ # highlight(:ruby) do
+ # <<-EOF
+ # class Test
+ # end
+ # EOF
+ # end
+ #
+ # Also see Simplabs::Highlight.highlight
+ def highlight(language, code = nil, &block)
+ raise ArgumentError.new('Either pass a srting containing the code or a block, not both!') if !code.nil? && block_given?
+ raise ArgumentError.new('Pass a srting containing the code or a block!') if code.nil? && !block_given?
+ code ||= yield
+ Simplabs::Highlight.highlight(language, code)
+ end
+
+ end
+
end
end
lib/simplabs/highlight.rb
@@ -63,10 +63,6 @@
lib/simplabs/highlight/pygments_wrapper.rb
</a>
<br />
- <a href="../files/lib/simplabs/highlight/view_methods_rb.html">
- lib/simplabs/highlight/view_methods.rb
- </a>
- <br />
<a href="../files/lib/simplabs/highlight_rb.html">
lib/simplabs/highlight.rb
</a>
rdoc/classes/Simplabs.html
@@ -63,10 +63,6 @@
lib/simplabs/highlight/pygments_wrapper.rb
</a>
<br />
- <a href="../../files/lib/simplabs/highlight/view_methods_rb.html">
- lib/simplabs/highlight/view_methods.rb
- </a>
- <br />
<a href="../../files/lib/simplabs/highlight_rb.html">
lib/simplabs/highlight.rb
</a>
@@ -85,47 +81,26 @@
<div id="contextContent">
<div id="description">
- <p>
-<a href="Highlight.html">Highlight</a> is a simple source code highlighting
-plugin for Ruby on Rails. It‘s basically a wrapper around the python
-project pygments (<a href="http://pygments.org">pygments.org</a>/) that
-support various languages.
-</p>
-<p>
-The plugin adds a new method available in all templates:
-</p>
-<pre>
- highlight(language, code)
-</pre>
-<p>
-where language can be either a symbol or a string (most file extensions
-should work for example)
-</p>
-<p>
-To perform the highlighting, the code is first written to a file in /tmp,
-e.g.:
-</p>
-<pre>
- /tmp/highlight_1225993290.70882
-</pre>
+ <h1><a href="Highlight.html">Highlight</a></h1>
<p>
-Since writing that file, passing its contents on to pygments etc. takes a
-while, all highlighted source code should be cached of course, e.g.:
+<a href="Highlight.html">Highlight</a> is a simple syntax highlighting
+plugin for Ruby on Rails. It‘s basically a wrapper around the popular
+<a href="http://pygments.org">pygments.org</a> highlighter that‘s
+written in Python and supports a huge number of languages.
</p>
-<pre>
- <% cache do %>
- <%= highlight(:ruby) do -%>
- class Test
- end
- <% end -%>
- <% end %>
-</pre>
</div>
</div>
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000001">highlight</a>
+ </div>
+ </div>
</div>
@@ -162,6 +137,144 @@ Class <a href="Highlight/HighlightException.html" class="link">Simplabs::Highlig
<!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Class methods</h3>
+
+ <div id="method-M000001" class="method-detail">
+ <a name="M000001"></a>
+
+ <div class="method-heading">
+ <a href="#M000001" class="method-signature">
+ <span class="method-name">highlight</span><span class="method-args">(language, code)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Highlights the passed <tt>code</tt> with the appropriate rules according to
+the specified <tt>language</tt>.
+</p>
+<p>
+<b>Supported Languages</b>
+</p>
+<p>
+The following languages are supported. All of the paranthesized identifiers
+may be used as parameters for <a
+href="Highlight.html#M000001">highlight</a> to denote the language the
+source code to <a href="Highlight.html#M000001">highlight</a> is written in
+(use either Symbols or Strings).
+</p>
+<ul>
+<li>Actionscript (as, as3, actionscript)
+
+</li>
+<li>Applescript (applescript)
+
+</li>
+<li>bash (bash, sh)
+
+</li>
+<li>C (c, h)
+
+</li>
+<li>Clojure (clojure)
+
+</li>
+<li>C++ (c++, cpp, hpp)
+
+</li>
+<li>C# (c#, csharp, cs)
+
+</li>
+<li>CSS (css)
+
+</li>
+<li>diff (diff)
+
+</li>
+<li>Dylan (dylan)
+
+</li>
+<li>Erlang (erlang, erl, er)
+
+</li>
+<li>HTML (html, htm)
+
+</li>
+<li>Java (java)
+
+</li>
+<li>JavaScript (javascript, js, jscript)
+
+</li>
+<li>JSP (jsp)
+
+</li>
+<li>Make (make, basemake, makefile)
+
+</li>
+<li>Objective-C (objective-c)
+
+</li>
+<li>OCaml (ocaml)
+
+</li>
+<li>Perl (perl, pl)
+
+</li>
+<li>PHP (php)
+
+</li>
+<li>Python (python, (py)
+
+</li>
+<li>RHTML (erb, rhtml)
+
+</li>
+<li>Ruby (ruby, rb)
+
+</li>
+<li>Scala (scala)
+
+</li>
+<li>Scheme (scheme)
+
+</li>
+<li>Smalltalk (smalltalk)
+
+</li>
+<li>Smarty (smarty)
+
+</li>
+<li>SQL (sql)
+
+</li>
+<li>XML (xml, xsd)
+
+</li>
+<li>XSLT (xslt)
+
+</li>
+<li>YAML (yaml, yml)
+
+</li>
+</ul>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000001-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/simplabs/highlight.rb, line 83</span>
+83: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">highlight</span>(<span class="ruby-identifier">language</span>, <span class="ruby-identifier">code</span>)
+84: <span class="ruby-keyword kw">return</span> <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">escapeHTML</span>(<span class="ruby-identifier">code</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Simplabs</span><span class="ruby-operator">::</span><span class="ruby-constant">Highlight</span>.<span class="ruby-identifier">initialized</span>
+85: <span class="ruby-constant">Simplabs</span><span class="ruby-operator">::</span><span class="ruby-constant">Highlight</span><span class="ruby-operator">::</span><span class="ruby-constant">PygmentsWrapper</span>.<span class="ruby-identifier">highlight</span>(<span class="ruby-identifier">code</span>, <span class="ruby-identifier">language</span>)
+86: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+
+ </div>
</div>
rdoc/classes/Simplabs/Highlight.html
@@ -55,8 +55,8 @@
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
- <a href="../../../files/lib/simplabs/highlight/view_methods_rb.html">
- lib/simplabs/highlight/view_methods.rb
+ <a href="../../../files/lib/simplabs/highlight_rb.html">
+ lib/simplabs/highlight.rb
</a>
<br />
</td>
@@ -74,7 +74,7 @@
<div id="description">
<p>
-Defines methods for highlighting source code in templates
+<a href="../Highlight.html">Highlight</a> view methods
</p>
</div>
@@ -86,7 +86,7 @@ Defines methods for highlighting source code in templates
<h3 class="section-bar">Methods</h3>
<div class="name-list">
- <a href="#M000001">highlight</a>
+ <a href="#M000002">highlight</a>
</div>
</div>
@@ -108,28 +108,49 @@ Defines methods for highlighting source code in templates
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
- <div id="method-M000001" class="method-detail">
- <a name="M000001"></a>
+ <div id="method-M000002" class="method-detail">
+ <a name="M000002"></a>
<div class="method-heading">
- <a href="#M000001" class="method-signature">
- <span class="method-name">highlight</span><span class="method-args">(language, code)</span>
+ <a href="#M000002" class="method-signature">
+ <span class="method-name">highlight</span><span class="method-args">(language, code = nil) {|| ...}</span>
</a>
</div>
<div class="method-description">
<p>
-Highlights <tt>code</tt> according to the syntax of <tt>language</tt>
+Highlights the passed <tt>code</tt> with the appropriate rules according to
+the specified <tt>language</tt>. The code can be specified either as a
+string or as result f a block.
+</p>
+<p>
+<b>Examples:</b>
+</p>
+<pre>
+ highlight(:ruby, 'class Test; end')
+
+ highlight(:ruby) do
+ <<-EOF
+ class Test
+ end
+ EOF
+ end
+</pre>
+<p>
+Also see <a
+href="../Highlight.html#M000001">Simplabs::Highlight.highlight</a>
</p>
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000001-source">
+ onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000002-source">
<pre>
- <span class="ruby-comment cmt"># File lib/simplabs/highlight/view_methods.rb, line 9</span>
- 9: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">highlight</span>(<span class="ruby-identifier">language</span>, <span class="ruby-identifier">code</span>)
-10: <span class="ruby-keyword kw">return</span> <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">escapeHTML</span>(<span class="ruby-identifier">code</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Simplabs</span><span class="ruby-operator">::</span><span class="ruby-constant">Highlight</span>.<span class="ruby-identifier">initialized</span>
-11: <span class="ruby-constant">Simplabs</span><span class="ruby-operator">::</span><span class="ruby-constant">Highlight</span><span class="ruby-operator">::</span><span class="ruby-constant">PygmentsWrapper</span>.<span class="ruby-identifier">highlight</span>(<span class="ruby-identifier">code</span>, <span class="ruby-identifier">language</span>)
-12: <span class="ruby-keyword kw">end</span>
+ <span class="ruby-comment cmt"># File lib/simplabs/highlight.rb, line 106</span>
+106: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">highlight</span>(<span class="ruby-identifier">language</span>, <span class="ruby-identifier">code</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+107: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Either pass a srting containing the code or a block, not both!'</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">code</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">block_given?</span>
+108: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Pass a srting containing the code or a block!'</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">code</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">block_given?</span>
+109: <span class="ruby-identifier">code</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword kw">yield</span>
+110: <span class="ruby-constant">Simplabs</span><span class="ruby-operator">::</span><span class="ruby-constant">Highlight</span>.<span class="ruby-identifier">highlight</span>(<span class="ruby-identifier">language</span>, <span class="ruby-identifier">code</span>)
+111: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
rdoc/classes/Simplabs/Highlight/ViewMethods.html
@@ -1 +1 @@
-Thu, 06 Nov 2008 20:00:18 +0100
+Sat, 14 Mar 2009 18:50:10 +0100
rdoc/created.rid
@@ -56,7 +56,7 @@
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Thu Nov 06 19:59:36 +0100 2008</td>
+ <td>Sat Mar 14 18:42:35 +0100 2009</td>
</tr>
</table>
</div>
@@ -71,21 +71,36 @@
<div id="description">
<h1>Highlight</h1>
<p>
-Highlight is a simple source code highlighting plugin for Ruby on Rails.
-It‘s basically a wrapper around the python project pygments (<a
-href="http://pygments.org">pygments.org</a>/) that support various
-languages.
+Highlight is a simple syntax highlighting plugin for Ruby on Rails.
+It‘s basically a wrapper around the popular <a
+href="http://pygments.org">pygments.org</a> highlighter that‘s
+written in Python and supports a huge number of languages.
</p>
<p>
-The plugin adds a new method available in all templates:
+Highlight provides a new method that‘s available in views:
</p>
<pre>
- highlight(language, code)
+ highlight(language, code = nil, &block)
</pre>
<p>
-where language can be either a symbol or a string (most file extensions
-should work for example)
+<tt>language</tt> may be either a Symbolor a String (see supported
+languages below). The code can be passed either as a string or inside a
+block, e.g.:
</p>
+<pre>
+ highlight(:ruby, 'class Test; end')
+</pre>
+<p>
+or
+</p>
+<pre>
+ highlight(:ruby) do
+ <<-EOF
+ class Test
+ end
+ EOF
+ end
+</pre>
<p>
To perform the highlighting, the code is first written to a file in /tmp,
e.g.:
@@ -94,8 +109,12 @@ e.g.:
/tmp/highlight_1225993290.70882
</pre>
<p>
-Since writing that file, passing its contents on to pygments etc. takes a
-while, all highlighted source code should be cached of course, e.g.:
+This file is the passed to pygments that returns the HTML and so on…
+</p>
+<p>
+Since writing that file, passing its contents on to pygments, retrieve the
+result etc. takes a while, all highlighted source code should be cached of
+course, e.g.:
</p>
<pre>
<% cache do %>
@@ -106,7 +125,7 @@ while, all highlighted source code should be cached of course, e.g.:
<p>
The following languages are supported. All of the paranthesized identifiers
may be used as parameters for highlight to denote the language the source
-code to highlight is written in.
+code to highlight is written in (use either Symbols or Strings).
</p>
<pre>
* Actionscript (as, as3, actionscript)
@@ -149,12 +168,21 @@ Installation is as easy as (for Rails > 2.1):
./script/plugin install git@github.com:marcoow/highlight.git
</pre>
<p>
+The hightlight.css stylesheet that contains the neccessary style
+definitions should be copied to your public/stylesheets directory
+automagically.
+</p>
+<p>
If you are on Rails < 2.1, do this from your RAILS_ROOT
</p>
<pre>
git clone git@github.com:marcoow/highlight.git vendor/plugins/highlight
</pre>
<p>
+In this case you would have to copy the hightlight.css stylesheets manually
+from vendor/plugins/highlight/assets/stylesheets/.
+</p>
+<p>
If you don‘t have python and pygments installed, you will need that
too. For instructions on installing pygments, refer to <a
href="http://pygments.org/docs/installation">pygments.org/docs/installation</a>/
@@ -167,14 +195,14 @@ href="http://simplabs.lighthouseapp.com/projects/19387-highlight/overview">simpl
</p>
<h2>Author</h2>
<p>
-Copyright (c) 2008 Marco Otte-Witte (<a
-href="http://simplabs.com/#projects">simplabs.com/#projects</a>), released
-under the MIT license
+Copyright (c) 2008-2009 Marco Otte-Witte (<a
+href="http://simplabs.com">simplabs.com</a>), released under the MIT
+license
</p>
<h2>Acknowledgements</h2>
<p>
The actual highlighting is done by Pygments (<a
-href="http://pygments.org">pygments.org</a>/).
+href="http://pygments.org">pygments.org</a>).
</p>
</div>
rdoc/files/README_rdoc.html
@@ -56,7 +56,7 @@
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Thu Nov 06 20:00:02 +0100 2008</td>
+ <td>Sat Mar 14 18:50:07 +0100 2009</td>
</tr>
</table>
</div>
rdoc/files/lib/simplabs/highlight_rb.html
@@ -24,7 +24,6 @@
<a href="files/lib/simplabs/highlight_rb.html">lib/simplabs/highlight.rb</a><br />
<a href="files/lib/simplabs/highlight/highlight_exception_rb.html">lib/simplabs/highlight/highlight_exception.rb</a><br />
<a href="files/lib/simplabs/highlight/pygments_wrapper_rb.html">lib/simplabs/highlight/pygments_wrapper.rb</a><br />
- <a href="files/lib/simplabs/highlight/view_methods_rb.html">lib/simplabs/highlight/view_methods.rb</a><br />
</div>
</div>
</body>
rdoc/fr_file_index.html
@@ -20,7 +20,8 @@
<div id="index">
<h1 class="section-bar">Methods</h1>
<div id="index-entries">
- <a href="classes/Simplabs/Highlight/ViewMethods.html#M000001">highlight (Simplabs::Highlight::ViewMethods)</a><br />
+ <a href="classes/Simplabs/Highlight.html#M000001">highlight (Simplabs::Highlight)</a><br />
+ <a href="classes/Simplabs/Highlight/ViewMethods.html#M000002">highlight (Simplabs::Highlight::ViewMethods)</a><br />
</div>
</div>
</body>
rdoc/fr_method_index.html
lib/simplabs/highlight/highlight_exception.rb
lib/simplabs/highlight/view_methods.rb
rdoc/files/lib/simplabs/highlight/view_methods_rb.html
spec/other/pygments_wrapper_spec.rb
spec/other/view_methods_spec.rb
8cdd126d2d129a366da0dd7428af8a39f1dff74e
Marco Otte-Witte
marco.otte-witte@simplabs.com
http://github.com/marcoow/highlight/commit/56a40a2b731d0cbd47beab533f4726a4728aa2da
56a40a2b731d0cbd47beab533f4726a4728aa2da
2009-03-14T10:52:34-07:00
2009-03-14T10:52:34-07:00
some refactorings, updated README
3aadc177dd55a48f7ad543b3d38075f8fac84715
Marco Otte-Witte
marco.otte-witte@simplabs.com