wbzyl-rack-codehighlighter 0.1.4 → 0.1.5

data/README.markdown

@@ -1,31 +1,116 @@
 # Rack Middleware for Code Highlighting
 
-The *Codehighlighter* gem provides a thin interface over a bunch 
-of exisitng code highlighters to make their usage as generic possible.
+Why one should use middleware (filter) for code highlighting?
+The short answer is: because it is unobtrusive.
+
+In pre-Rack applications era the possible approaches were:
+
+1. pure javascript
+
+[*Ruby tips from me, your idol*](http://www.binarylogic.com/2009/04/19/ruby-tips-from-me-your-idol):
+I can not tell you how much time I’ve wasted trying to add in some
+cool feature into rails. I would dig into the rails internals,
+override methods, do all kinds of tricky stuff. I thought I was
+awesome. A month later rails comes out with some cool new feature, I
+update rails and everything explodes.
+
+2. gems (ok) + conection (obtrusive)
+
 
 To install it, run:
 
     sudo gem install wbzyl-rack-codehighlighter -s http://gems.github.com
 
+Analyze
+[Syntax Highlighting](http://ruby-toolbox.com/categories/syntax_highlighting.html)
+packages from the *The Ruby Toolbox* page.
+
+Exisitng practice is obtrusive:
+
+    http://carboni.ca/projects/harsh/  
+      unless HAML is used
+    http://redclothcoderay.rubyforge.org/  
+    http://github.com/augustl/redcloth-with-coderay
+      how to use with Rails
+      does't degrade to html: new source tag
+    http://github.com/arya/tm_syntax_highlighting/
+      how to connect to rails/sinatra?
+    
+Pure Javascript highlighters:
+
+In Ruby on Rails (redcloth)
+
+Add censored method/example.
+
+
+
+
+## Using with Rack application
+
+*Rack::Codehighlighter* can be used with any Rack application, for example with
+a **Sinatra** application. If your application includes a rackup file or
+uses *Rack::Builder* to construct the application pipeline, simply
+require and use as follows:
+
+    gem 'wbzyl-rack-codehighlighter'
+    require 'rack/codehighlighter'
+    
+    gem 'ultraviolet'
+    require 'uv'
+    
+    use Rack::Codehighlighter, :ultraviolet
+    run app
+
+Instead of *ultraviolet* you can use other supported highlighters:
+*syntax*, *coderay*, *prettify*.
+
+Include in the layout one of provided stylesheets.
+
+## Using with Rails
+
+In order to use include the following in a Rails application
+`config/environment.rb` file:
+
+    require 'rack/codehighlighter'
+    
+    Rails::Initializer.run do |config|  
+      config.gem 'wbzyl-rack-codehighlighter'
+      config.middleware.use Rack::Codehighlighter, :ultraviolet
+    end  
+
+Check the Rack configuration:
+
+    rake middleware
+
+More configuration options: see below.
+
+
+[*Ruby tips from me, your idol*](http://www.binarylogic.com/2009/04/19/ruby-tips-from-me-your-idol):
+Think about what you are doing, try to understand it, come up with a
+better solution, etc.
+*Is it Rack a cool feature?*
+
+
+## Configuration options
+
 Markup your code with:
 
     <pre><code>:::ruby
     ...
     </code></pre>
 
+## Quick Sinatra example
+
 Example (incomplete html, needs a layout file with link to css):
 
-    # file simple.rb
+    # file example.rb
 
     require 'rubygems'
     require 'sinatra'
 
     gem 'coderay'
-    require 'coderay'    # use the Coderay highlighter
+    require 'coderay'
     
-    gem 'wbzyl-sinatra-rdiscount'
-    require 'sinatra/rdiscount'
-
     gem 'wbzyl-rack-codehighlighter'
     require 'rack/codehighlighter'
     
@@ -50,20 +135,19 @@ Example (incomplete html, needs a layout file with link to css):
     end
     </code></pre>
 
-## An example
+Run the above example with:
+
+    ruby example.rb
+
 
-The Codehighlighter follows the same syntax as regular Markdown
-code blocks, with one exception. It needs to know what
-language to use for the code block.
+## More Sinatra examples
+
+The default markup:
 
 If the first line begins with three colons, the text following
 the colons identifies the language (ruby in the example). 
 The first line is removed from the code block before processing.
 
-Run the above example with:
-
-    ruby simple.rb
-
 The directory *examples* contains ready to run, simple Sinatra app. Try
 
     rackup -p 4567 config.ru
@@ -83,51 +167,43 @@ and contemplate the sheer beauty of the rendered code.
 ## Supported Highlighters
 
 These currently include: *Syntax* (fast), *Coderay* (very fast), 
-*Ultraviolet* (slow).
+*Ultraviolet* (slow, but highlights almost any language).
 
-### Syntax
+The *Codehighlighter* gem provides a thin interface over a bunch of
+exisitng code highlighters to make their usage as generic possible.
 
-Supported languages: 
+What does it mean? Explain.
 
-* xml
-* ruby
 
-I added support for these languages:
+### [Syntax](http://syntax.rubyforge.org/)
 
-* ansic 
-* javascript
-* css21
-* sqlite
+Languages supported by *Syntax*: 
+
+* xml
+* ruby
 
 
 ### [Coderay](http://coderay.rubychan.de/)
 
-Supported languages:
-
-* C
-* CSS
-* Delphi
-* diff
-* HTML
-* RHTML (Rails)
-* Nitro-XHTML
-* Java
-* JavaScript
-* JSON
+Languages supported by *Coderay*:
+
+* C, CSS
+* Delphi, diff
+* HTML, RHTML (Rails), Nitro-XHTML
+* Java, JavaScript, JSON
 * Ruby
 * YAML
 
 ### [Google Code Prettify](http://code.google.com/p/google-code-prettify/), pure Javascript
 
-Supported languages:
+Languages supported by *Prettify*:
 
 * css, lisp, hs, lua, sql, vb, wiki,
 * bsh, c, cc, cpp, cs, csh, cyc, cv, htm, html,
 * java, js, m, mxml, perl, pl, pm, py, rb, sh,
 * xhtml, xml, xsl
 
-
-### Ultraviolet
+### [Ultraviolet](http://ultraviolet.rubyforge.org/)
 
 The *ultraviolet* gem needs oniguruma regexp library.
 
@@ -142,165 +218,39 @@ Now, install the gem:
 
     sudo gem install ultraviolet
 
-[Ultraviolet themes gallery](: http://ultraviolet.rubyforge.org/themes.xhtml)
+See also [Ultraviolet themes gallery](http://ultraviolet.rubyforge.org/themes.xhtml)
 
 Ultraviolet supports almost any language:
 
-* actionscript
-* active4d
-* active4d\_html
-* active4d\_ini
-* active4d\_library
-* ada
-* antlr
-* apache
-* applescript
-* asp
-* asp\_vb.net
-* bibtex
-* blog\_html
-* blog\_markdown
-* blog\_text
-* blog\_textile
-* build
-* bulletin\_board
-* c
-* c++
-* cake
-* camlp4
-* cm
-* coldfusion
-* context\_free
-* cs
-* css
-* css\_experimental
-* csv
-* d
-* diff
-* dokuwiki
-* dot
-* doxygen
-* dylan
-* eiffel
-* erlang
-* f-script
-* fortran
-* fxscript
-* greasemonkey
-* gri
-* groovy
-* gtd
-* gtdalt
-* haml
-* haskell
-* html
-* html-asp
-* html\_django
-* html\_for\_asp.net
-* html\_mason
-* html\_rails
-* html\_tcl
-* icalendar
-* inform
-* ini
-* installer\_distribution\_script
-* io
-* java
-* javaproperties
-* javascript
-* javascript\_+\_prototype
-* javascript\_+\_prototype\_bracketed
-* jquery\_javascript
-* json
-* languagedefinition
-* latex
-* latex\_beamer
-* latex\_log
-* latex\_memoir
-* lexflex
-* lighttpd
-* lilypond
-* lisp
-* literate\_haskell
-* logo
-* logtalk
-* lua
-* m
-* macports\_portfile
-* mail
-* makefile
-* man
-* markdown
-* mediawiki
-* mel
-* mips
-* mod\_perl
-* modula-3
-* moinmoin
-* mootools
-* movable\_type
-* multimarkdown
-* objective-c
-* objective-c++
-* ocaml
-* ocamllex
-* ocamlyacc
-* opengl
-* pascal
-* perl
-* php
-* plain\_text
-* pmwiki
-* postscript
-* processing
-* prolog
-* property\_list
-* python
-* python\_django
-* qmake\_project
-* qt\_c++
-* quake3\_config
-* r
-* r\_console
-* ragel
-* rd\_r\_documentation
-* regexp
-* regular\_expressions\_oniguruma
-* regular\_expressions\_python
-* release\_notes
-* remind
-* restructuredtext
-* rez
-* ruby
-* ruby\_experimental
-* ruby\_on\_rails
-* s5
-* scheme
-* scilab
-* setext
-* shell-unix-generic
-* slate
-* smarty
-* sql
-* sql\_rails
-* ssh-config
-* standard\_ml
-* strings\_file
-* subversion\_commit\_message
-* sweave
-* swig
-* tcl
-* template\_toolkit
-* tex
-* tex\_math
-* textile
-* tsv
-* twiki
-* txt2tags
+* actionscript, active4d, active4d\_html, active4d\_ini, active4d\_library,
+  ada, antlr, apache, applescript, asp, asp\_vb.net
+* bibtex, blog\_html, blog\_markdown, blog\_text, blog\_textile, build,
+  bulletin\_board
+* c, c++, cake, camlp4, cm, coldusion, context\_free, cs, css, css\_experimental,
+  csv
+* d, diff, dokuwiki, dot, doxygen, dylan
+* eiffel, erlang, f-script, fortran, fxscript
+* greasemonkey, gri, groovy, gtd, gtdalt
+* haml, haskell, html, html-asp, html\_django, html\_for\_asp.net, html\_mason,
+  html\_rails, html\_tcl
+* icalendar, inform, ini, installer\_distribution\_script, io
+* java, javaproperties, javascript, javascript\_+\_prototype, 
+  javascript\_+\_prototype\_bracketed, jquery\_javascript, json
+* languagedefinition, latex, latex\_beamer, latex\_log, latex\_memoir, lexflex,
+  lighttpd, lilypond, lisp, literate\_haskell, logo, logtalk, lua
+* m, macports\_portfile, mail, makefile, man, markdown, mediawiki, mel,
+  mips, mod\_perl, modula-3, moinmoin, mootools, movable\_type, multimarkdown
+* objective-c, objective-c++, ocaml, ocamllex, ocamlyacc, opengl
+* pascal, perl, php, plain\_text, pmwiki, postscript, processing,
+  prolog, property\_list, python, python\_django
+* qmake\_project, qt\_c++, quake3\_config
+* r, r\_console, ragel, rd\_r\_documentation, regexp,
+  regular\_expressions\_oniguruma, regular\_expressions\_python, release\_notes
+  remind, restructuredtext, rez, ruby, ruby\_experimental, ruby\_on\_rails
+* s5, scheme, scilab, setext, shell-unix-generic, slate, smarty,
+  sql, sql\_rails, ssh-config, standard\_ml, strings\_file, subversion\_commit\_message,
+  sweave, swig
+* tcl, template\_toolkit, tex, tex\_math, textile, tsv, twiki, txt2tags
 * vectorscript
-* xhtml\_1.0
-* xml
-* xml\_strict
-* xsl
-* yaml
-* yui\_javascript
+* xhtml\_1.0, xml, xml\_strict, xsl
+* yaml, yui\_javascript

data/Rakefile

@@ -0,0 +1,30 @@
+require "rake"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name         = "rack-codehighlighter"
+    gemspec.summary      = "Rack Middleware for Code Highlighting."
+    gemspec.email        = "matwb@univ.gda.pl"  
+    gemspec.homepage     = "http://github.com/wbzyl/rack-codehighlighter"
+    gemspec.authors      = ["Wlodek Bzyl"]
+    gemspec.description  = gemspec.summary
+    
+    gemspec.files = %w[LICENSE TODO Rakefile VERSION.yml] + FileList['lib/**/*.rb', "examples/**/*"]
+    
+    gemspec.add_runtime_dependency 'rack', '>=1.0.0'
+    gemspec.add_runtime_dependency 'hpricot', '>=0.8.1'   
+    
+    gemspec.add_development_dependency 'rack-test', '>=0.3.0'
+  end
+rescue LoadError
+  puts "Jeweler not available."
+  puts "Install it with:"
+  puts "  sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+#Rake::TestTask.new(:test) do |t|
+#  t.libs << 'lib' << 'test'
+#  t.pattern = 'test/**/*_test.rb'
+#  t.verbose = false
+#end

data/TODO

@@ -0,0 +1,22 @@
+
+[1.05.2009, done] 
+  Add support for code-prettify:
+
+    * [source code](http://code.google.com/p/google-code-prettify/)
+      [example](http://google-code-prettify.googlecode.com/svn/trunk/README.html)
+
+   
+    * see http://tomayko.com/writings/javascript-prettification
+      (support for jQuery, new pallette)
+
+    * example:
+      <pre class="prettyprint lang-html">
+      The lang-* class specifies the language file extensions.
+      File extensions supported by default include
+      "bsh", "c", "cc", "cpp", "cs", "csh", "cyc", "cv", "htm", "html",
+      "java", "js", "m", "mxml", "perl", "pl", "pm", "py", "rb", "sh",
+      "xhtml", "xml", "xsl".
+      </pre>
+
+[1.05.2009] 
+  Add support for unobtrustive Code Highlighter By Dan Webb 11/2005

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 5
+:major: 0
+:minor: 1

data/lib/rack/codehighlighter.rb

@@ -14,7 +14,9 @@ module Rack
       @app = app
       @highlighter = highlighter
       
-      @opts = { :element => "//pre/code", :pattern => /\A:::(\w+)\s*\n/ }
+      @opts = { :element => "//pre/code",
+        :pattern => /\A:::(\w+)\s*\n/,
+        :reason => "[...ugly code removed...]" }
       
       @opts.merge! opts
     end
@@ -69,6 +71,10 @@ module Rack
       ]
     end
     
+    def censor(string)
+      "<pre>#{@opts[:reason]}</pre>"
+    end
+
     def syntax(string)
       translate = {
         'html' => 'xml',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wbzyl-rack-codehighlighter
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Wlodek Bzyl
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-31 00:00:00 -07:00
+date: 2009-06-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,10 @@ extra_rdoc_files:
 - LICENSE
 - README.markdown
 files: 
+- LICENSE
+- Rakefile
+- TODO
+- VERSION.yml
 - examples/app.rb
 - examples/config.ru
 - examples/public/javascripts/lang-css.js
@@ -80,7 +84,6 @@ files:
 - examples/views/index.rdiscount
 - examples/views/layout.rdiscount
 - lib/rack/codehighlighter.rb
-- LICENSE
 - README.markdown
 has_rdoc: false
 homepage: http://github.com/wbzyl/rack-codehighlighter