highlight 1.1.3

data/HISTORY.md

@@ -0,0 +1,9 @@
+v1.1.3
+------
+
+* fixed file permissions
+
+v1.1.2
+------
+
+* first gem version

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2010 Marco Otte-Witte
+
+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,132 @@
+Highlight
+=========
+
+Highlight is a simple syntax highlighting gem for Ruby and Rails. It's basically a
+wrapper around the popular [http://pygments.org](http://pygments.org) highlighter that's
+written in Python and supports an impressive number of languages.
+
+If pygments is installed on the machine and in the `PATH`, that binary is used, otherwise
+the plugin falls back to the web API at [http://pygments.appspot.com/](http://pygments.appspot.com/),
+created by Trevor Turk.
+
+See the API docs at [http://rdoc.info/projects/simplabs/highlight](http://rdoc.info/projects/simplabs/highlight).
+
+Usage
+-----
+
+Highlight can either be used standalone via
+
+    require 'simplabs/highlight'
+    Simplabs::Highlight.highlight(:ruby, 'class Test; end')
+
+or in Rails where it adds the `highlight_code` helper:
+
+    highlight_code(language, code = nil, &block)
+
+`language` may be either a Symbol or a String (see supported languages
+below). The code can be passed either as a string or inside a block, e.g.:
+
+    highlight_code(:ruby, 'class Test; end')
+
+or
+
+    highlight_code(:ruby) do
+      klass = 'class'
+      name  = 'Test'
+      _end  = 'end'
+      "#{klass} #{name}; #{_end}"
+    end
+
+Since highlighting the code takes a while, all highlighted source code
+should be cached, e.g.:
+
+    <%- code = 'class Test; end' -%>
+    <%- cache Digest::SHA1.hexdigest(code) do -%>
+      <%= highlight_code(:ruby, code) -%>
+    <%- end -%>
+
+
+Supported Languages
+-------------------
+
+The following languages are supported (there are probably more that are supported by `pygments`).
+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`)
+
+
+Installation
+------------
+
+Installation is as easy as
+
+    gem install highlight
+
+To use highlight in Rails apps, you have to define the dependency. For Rails 2.x this is done in the `environment.rb`:
+
+    config.gem 'highlight', :lib => 'simplabs/highlight'
+
+while for Rails 3 the dependency is defined in the application's Gemfile:
+
+    gem 'highlight', :require => 'simplabs/highlight'
+
+Highlight also comes with a default CSS file that defines styles for the highlighted code. This CSS file can be copied to
+your application's `public/stylesheets` directory via
+
+    ./script/generate highlight_styles
+
+for Rails 2.x or via
+
+    rails generate highlight_styles
+
+for Rails 3.
+
+If you don't have python and pygments installed, you will need that too.
+For instructions on installing pygments, refer to
+[http://pygments.org/docs/installation/](http://pygments.org/docs/installation/).
+
+
+Author
+------
+
+Copyright (c) 2008-2010 Marco Otte-Witte ([http://simplabs.com](http://simplabs.com)),
+released under the MIT license
+
+
+Acknowledgements
+----------------
+
+The actual highlighting is done by Pygments ([http://pygments.org](http://pygments.org)).
+
+The pygments web API at [http://pygments.appspot.com/](http://pygments.appspot.com/) was created by Trevor Turk.

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'bundler'
+ 
+Bundler.setup
+Bundler.require
+ 
+require 'spec/rake/spectask'
+require 'simplabs/excellent/rake'
+ 
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.rcov_opts  << '--exclude "gems/*,spec/*,init.rb"'
+  t.rcov       = true
+  t.rcov_dir   = 'doc/coverage'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate The Highlight documentation'
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = ['--no-private', '--title', 'Highlight Documentation']
+end
+
+desc 'Analyse the Highlight source with Excellent.'
+Simplabs::Excellent::Rake::ExcellentTask.new(:excellent) do |t|
+  t.paths = ['lib']
+end

data/generators/highlight_styles_generator/highlight_styles_generator.rb

@@ -0,0 +1,32 @@
+if Rails::VERSION::MAJOR >= 3
+
+  class HighlightStylesGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Actions
+
+    def create_stylesheet_file
+      empty_directory('public/stylesheets')
+      copy_file(
+        File.join(File.dirname(__FILE__), 'templates', 'highlight.css'),
+        'public/stylesheets/highlight.css'
+      )
+      readme(File.join(File.dirname(__FILE__), 'templates', 'NOTES'))
+    end
+
+  end
+
+else
+
+  class HighlightStylesGenerator < Rails::Generator::Base
+
+    def manifest
+      record do |m|
+        m.directory('public/stylesheets')
+        m.file('highlight.css', 'public/stylesheets/highlight.css')
+        m.readme('NOTES')
+      end
+    end
+
+  end
+
+end

data/generators/highlight_styles_generator/templates/NOTES

@@ -0,0 +1,3 @@
+
+  ** Don't forget to include highlight.css in your layout's head section.
+

data/generators/highlight_styles_generator/templates/highlight.css

@@ -0,0 +1,59 @@
+.c { color: #408080; font-style: italic }  /* Comment */
+.err { border: 1px solid #FF0000 }         /* Error */
+.k { color: #008000; font-weight: bold }   /* Keyword */
+.o { color: #666666 }                      /* Operator */
+.cm { color: #408080; font-style: italic } /* Comment.Multiline */
+.cp { color: #BC7A00 }                     /* Comment.Preproc */
+.c1 { color: #408080; font-style: italic } /* Comment.Single */
+.cs { color: #408080; font-style: italic } /* Comment.Special */
+.gd { color: #A00000 }                     /* Generic.Deleted */
+.ge { font-style: italic }                 /* Generic.Emph */
+.gr { color: #FF0000 }                     /* Generic.Error */
+.gh { color: #000080; font-weight: bold }  /* Generic.Heading */
+.gi { color: #00A000 }                     /* Generic.Inserted */
+.go { color: #808080 }                     /* Generic.Output */
+.gp { color: #000080; font-weight: bold }  /* Generic.Prompt */
+.gs { font-weight: bold }                  /* Generic.Strong */
+.gu { color: #800080; font-weight: bold }  /* Generic.Subheading */
+.gt { color: #0040D0 }                     /* Generic.Traceback */
+.kc { color: #008000; font-weight: bold }  /* Keyword.Constant */
+.kd { color: #008000; font-weight: bold }  /* Keyword.Declaration */
+.kp { color: #008000 }                     /* Keyword.Pseudo */
+.kr { color: #008000; font-weight: bold }  /* Keyword.Reserved */
+.kt { color: #B00040 }                     /* Keyword.Type */
+.m { color: #666666 }                      /* Literal.Number */
+.s { color: #BA2121 }                      /* Literal.String */
+.na { color: #7D9029 }                     /* Name.Attribute */
+.nb { color: #008000 }                     /* Name.Builtin */
+.nc { color: #0000FF; font-weight: bold }  /* Name.Class */
+.no { color: #880000 }                     /* Name.Constant */
+.nd { color: #AA22FF }                     /* Name.Decorator */
+.ni { color: #999999; font-weight: bold }  /* Name.Entity */
+.ne { color: #D2413A; font-weight: bold }  /* Name.Exception */
+.nf { color: #0000FF }                     /* Name.Function */
+.nl { color: #A0A000 }                     /* Name.Label */
+.nn { color: #0000FF; font-weight: bold }  /* Name.Namespace */
+.nt { color: #008000; font-weight: bold }  /* Name.Tag */
+.nv { color: #19177C }                     /* Name.Variable */
+.ow { color: #AA22FF; font-weight: bold }  /* Operator.Word */
+.w { color: #bbbbbb }                      /* Text.Whitespace */
+.mf { color: #666666 }                     /* Literal.Number.Float */
+.mh { color: #666666 }                     /* Literal.Number.Hex */
+.mi { color: #666666 }                     /* Literal.Number.Integer */
+.mo { color: #666666 }                     /* Literal.Number.Oct */
+.sb { color: #BA2121 }                     /* Literal.String.Backtick */
+.sc { color: #BA2121 }                     /* Literal.String.Char */
+.sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
+.s2 { color: #BA2121 }                     /* Literal.String.Double */
+.se { color: #BB6622; font-weight: bold }  /* Literal.String.Escape */
+.sh { color: #BA2121 }                     /* Literal.String.Heredoc */
+.si { color: #BB6688; font-weight: bold }  /* Literal.String.Interpol */
+.sx { color: #008000 }                     /* Literal.String.Other */
+.sr { color: #BB6688 }                     /* Literal.String.Regex */
+.s1 { color: #BA2121 }                     /* Literal.String.Single */
+.ss { color: #19177C }                     /* Literal.String.Symbol */
+.bp { color: #008000 }                     /* Name.Builtin.Pseudo */
+.vc { color: #19177C }                     /* Name.Variable.Class */
+.vg { color: #19177C }                     /* Name.Variable.Global */
+.vi { color: #19177C }                     /* Name.Variable.Instance */
+.il { color: #666666 }                     /* Literal.Number.Integer.Long */

data/lib/simplabs/highlight.rb

@@ -0,0 +1,187 @@
+require 'cgi'
+require 'net/http'
+require 'uri'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'simplabs/highlight/pygments_wrapper'
+
+module Simplabs
+
+  require 'simplabs/highlight/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3
+
+  # 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 an impressive
+  # number of languages. If pygments is installed on the machine and in
+  # the +PATH+, that binary is used, otherwise the plugin falls back
+  # to the web API at (http://pygments.appspot.com/), created by Trevor
+  # Turk.
+  #
+  # <b>Supported Languages</b>
+  #
+  # The following languages are supported. All of the paranthesized
+  # identifiers may be used as parameters for the +highlight+ method 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+)
+  # * NASM (+nasm+, +asm+)
+  # * 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+)
+  #
+  module Highlight
+
+    mattr_accessor :use_web_api
+
+    SUPPORTED_LANGUAGES = {
+      :as            => ['as', 'as3', 'actionscript'],
+      :applescript   => ['applescript'],
+      :bash          => ['bash', 'sh'],
+      :c             => ['c', 'h'],
+      :clojure       => ['clojure'],
+      :cpp           => ['c++', 'cpp', 'hpp'],
+      :csharp        => ['c#', 'csharp', 'cs'],
+      :css           => ['css'],
+      :diff          => ['diff'],
+      :dylan         => ['dylan'],
+      :erlang        => ['erlang'],
+      :html          => ['html', 'htm'],
+      :java          => ['java'],
+      :js            => ['javascript', 'js', 'jscript'],
+      :jsp           => ['jsp'],
+      :make          => ['make', 'basemake', 'makefile'],
+      :nasm          => ['nasm', 'asm'],
+      :'objective-c' => ['objective-c'],
+      :ocaml         => ['ocaml'],
+      :perl          => ['perl', 'pl'],
+      :php           => ['php'],
+      :python        => ['python', 'py'],
+      :rhtml         => ['erb', 'rhtml'],
+      :ruby          => ['ruby', 'rb'],
+      :scala         => ['scala'],
+      :scheme        => ['scheme'],
+      :smallralk     => ['smalltalk'],
+      :smarty        => ['smarty'],
+      :sql           => ['sql', 'mysql'],
+      :xml           => ['xml', 'xsd'],
+      :xslt          => ['xslt'],
+      :yaml          => ['yaml', 'yml']
+    }
+
+    WEB_API_URL = 'http://pygments.appspot.com/'
+
+    # Highlights the passed +code+ with the appropriate rules
+    # according to the specified +language+.
+    #
+    # @param [Symbol, String] language
+    #   the language the +code+ is in
+    # @param [String] code
+    #   the actual code to highlight
+    #
+    # @return [String]
+    #   the highlighted +code+ or simply the HTML-escaped code if +language+
+    #   is not supported.
+    #
+    def self.highlight(language, code)
+      language = get_language_sym(language)
+      return CGI.escapeHTML(code) unless language
+      if Simplabs::Highlight.use_web_api
+        highlight_with_web_api(language, code)
+      else
+        Simplabs::Highlight::PygmentsWrapper.new(code, language).highlight
+      end
+    end
+
+    # View Helpers for using {Highlight} in Ruby on Rails templates.
+    #
+    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 provided in a block.
+      #
+      # @param [Symbol, String] language
+      #   the language the +code+ is in
+      # @param [String] code
+      #   the actual code to highlight
+      # @yield
+      #   the +code+ can also be specified as result of a given block.
+      #
+      # @return [String]
+      #   the highlighted +code+ or simply the HTML-escaped code if +language+
+      #   is not supported.
+      #
+      # @example Specifying the code to highlight as a String
+      #
+      #  highlight_code(:ruby, 'class Test; end')
+      #
+      # @example Specifying the code to highlight in a block
+      #
+      #  highlight_code(:ruby) do
+      #    klass = 'class'
+      #    name  = 'Test'
+      #    _end  = 'end'
+      #    "#{klass} #{name}; #{_end}"
+      #  end 
+      #
+      # @raise [ArgumentError] if both the +code+ parameter and a block are given
+      # @raise [ArgumentError] if neither the +code+ parameter or a block are given
+      #
+      # @see Simplabs::Highlight.highlight
+      #
+      def highlight_code(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
+
+    private
+
+      def self.highlight_with_web_api(language, code)
+        request = Net::HTTP.post_form(URI.parse(WEB_API_URL), {
+          'lang' => language,
+          'code' => code
+        })
+        request.body.gsub(/\A\<div class=\"highlight\"\>\<pre\>/, '').gsub(/\n\<\/pre\>\<\/div\>\n/, '')
+      end
+
+      def self.get_language_sym(name)
+        SUPPORTED_LANGUAGES.each_pair do |key, value|
+          return key if value.any? { |lang| lang == name.to_s }
+        end
+        return false
+      end
+
+  end
+
+end

data/lib/simplabs/highlight/pygments_wrapper.rb

@@ -0,0 +1,49 @@
+module Simplabs
+
+  module Highlight
+
+    # Wraps the actual +pygments+ syntax highlighter and
+    # exposes its functionality to Ruby code.
+    #
+    class PygmentsWrapper
+
+      # The code the wrapper highlights
+      #
+      attr_reader :code
+
+      # The language the {Simplabs::Highlight::PygmentsWrapper#code} to highlight is in
+      #
+      attr_reader :language
+
+      # Initializes a new {Simplabs::Highlight::PygmentsWrapper}.
+      #
+      # @param [String] code
+      #   the actual code to highlight
+      # @param [String, Symbol] language
+      #   the language the +code+ to highlight is in
+      #
+      def initialize(code, language)
+        @code     = code
+        @language = language
+      end
+
+      # Highlights the {Simplabs::Highlight::PygmentsWrapper#code}.
+      #
+      # @return [String]
+      #   the highlighted code or simply the HTML-escaped code
+      #   if the language is not supported.
+      #
+      def highlight
+        command = "pygmentize -f html -O nowrap=true -l #{@language}"
+        IO.popen(command, mode = 'r+') do |pygments|
+          pygments << @code
+          pygments.close_write
+          pygments.read.strip.chomp
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/simplabs/highlight/railtie.rb

@@ -0,0 +1,24 @@
+require 'simplabs/highlight'
+require 'rails'
+
+module Simplabs
+
+  module Highlight
+
+    class Railtie < Rails::Railtie
+
+      GEM_ROOT = File.join(File.dirname(__FILE__), '..', '..', '..')
+
+      initializer 'simplabs.highlight.initialization' do
+        require File.join(GEM_ROOT, 'rails', 'init')
+      end
+
+      generators do
+        require File.join(GEM_ROOT, 'generators', 'highlight_styles_generator', 'highlight_styles_generator')
+      end
+
+    end
+
+  end
+
+end

data/rails/init.rb

@@ -0,0 +1,16 @@
+require 'action_view'
+require 'simplabs/highlight'
+
+if `which pygmentize`.blank?
+  puts ''
+  puts "  ** [Highlight] pygments cannot be found, falling back to #{Simplabs::Highlight::WEB_API_URL}! **"
+  puts '  **             If you have pygments installed, make sure it is in your PATH.           **'
+  puts ''
+  Simplabs::Highlight.use_web_api = true
+else
+  Simplabs::Highlight.use_web_api = false
+end
+
+ActionView::Base.class_eval do
+  include Simplabs::Highlight::ViewMethods
+end

data/spec/boot.rb

@@ -0,0 +1,14 @@
+plugin_root = File.join(File.dirname(__FILE__), '..')
+
+$:.unshift "#{plugin_root}/lib"
+
+Bundler.require
+require 'initializer'
+
+RAILS_ROOT = File.expand_path(File.dirname(__FILE__) + '/../')
+Rails::Initializer.run(:set_load_path)
+Rails::Initializer.run(:set_autoload_paths)
+
+require File.join(File.dirname(__FILE__), '/../rails/init.rb')
+
+FileUtils.mkdir_p(File.join(File.dirname(__FILE__), 'log'))

data/spec/lib/highlight_spec.rb

@@ -0,0 +1,90 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Simplabs::Highlight do
+
+  before do
+    @code = <<-EOC
+class Test
+  def method test
+  end
+end
+EOC
+  end
+
+  describe '#highlight' do
+
+    share_examples_for 'the highlight method' do
+
+      describe 'when the language is not supported' do
+
+        it 'should only escape HTML in the passed code' do
+          Simplabs::Highlight.highlight(:unsupported, @code).should == CGI.escapeHTML(@code)
+        end
+
+      end
+
+      describe 'when the language is supported' do
+
+        it 'should correctly highlight source code passed as parameter' do
+          Simplabs::Highlight.highlight(:ruby, @code).should == %Q(<span class="k">class</span> <span class="nc">Test</span>\n  <span class="k">def</span> <span class="nf">method</span> <span class="nb">test</span>\n  <span class="k">end</span>\n<span class="k">end</span>)
+        end
+
+      end
+
+    end
+
+    describe 'when pygments is used directly' do
+
+      before do
+        Simplabs::Highlight.use_web_api = false
+      end
+
+      it_should_behave_like 'the highlight method'
+
+      it 'should initialize a Simplabs::PygmentsWrapper.highlight with the language and code' do
+        wrapper = Simplabs::Highlight::PygmentsWrapper.new(@code, :ruby)
+
+        Simplabs::Highlight::PygmentsWrapper.should_receive(:new).once.with(@code, :ruby).and_return(wrapper)
+
+        Simplabs::Highlight.highlight(:ruby, @code)
+      end
+
+    end
+
+    describe 'when the web API is used' do
+
+      before do
+        Simplabs::Highlight.use_web_api = true
+      end
+
+      it_should_behave_like 'the highlight method'
+
+    end
+
+  end
+
+  describe '.get_language_sym' do
+
+    describe 'for an unsupported language' do
+
+      it 'should return false' do
+        Simplabs::Highlight.send(:get_language_sym, 'unsupported language').should == false
+      end
+
+    end
+
+    describe 'for a supported language' do
+
+      it 'should return the respective symbol when the languages was given as String' do
+        Simplabs::Highlight.send(:get_language_sym, 'ruby').should == :ruby
+      end
+
+      it 'should return the respective symbol when the languages was given as Symbol' do
+        Simplabs::Highlight.send(:get_language_sym, :rb).should == :ruby
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/pygments_wrapper_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Simplabs::Highlight::PygmentsWrapper do
+
+  before do
+    code = <<-EOC
+class Test
+  def method test
+  end
+end
+EOC
+    @wrapper = Simplabs::Highlight::PygmentsWrapper.new(code, :ruby)
+  end
+
+  describe '#highlight' do
+
+    it 'should correctly highlight source code passed as parameter' do
+      @wrapper.highlight.should == %Q(<span class="k">class</span> <span class="nc">Test</span>\n  <span class="k">def</span> <span class="nf">method</span> <span class="nb">test</span>\n  <span class="k">end</span>\n<span class="k">end</span>)
+    end
+
+  end
+
+end

data/spec/lib/view_methods_spec.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Simplabs::Highlight::ViewMethods do
+
+  include Simplabs::Highlight::ViewMethods
+
+  before do
+    @ruby_code = 'class Test; end'
+  end
+
+  describe '#highlight_code' do
+
+    describe 'when invoked with a language and a string' do
+
+      it 'should highlight the code' do
+        Simplabs::Highlight.should_receive(:highlight).once.with(:ruby, @ruby_code)
+
+        highlight_code(:ruby, @ruby_code)
+      end
+
+    end
+
+    describe 'when invoked with a language and a block' do
+
+      it 'should highlight the code' do
+        Simplabs::Highlight.should_receive(:highlight).once.with(:ruby, @ruby_code)
+
+        highlight_code(:ruby) do
+          @ruby_code
+        end
+      end
+
+    end
+
+    describe 'when invoked with both a string and a block' do
+
+      it 'should raise an ArgumentError' do
+        lambda { highlight_code(:ruby, @ruby_code) { @ruby_code } }.should raise_error(ArgumentError)
+      end
+
+    end
+
+    describe 'when invoked with neither a string nor a block' do
+
+      it 'should raise an ArgumentError' do
+        lambda { highlight_code(:ruby) }.should raise_error(ArgumentError)
+      end
+
+    end
+
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format specdoc
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$:.reject! { |e| e.include? 'TextMate' }
+
+ENV['RAILS_ENV'] = 'test'
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require File.join(File.dirname(__FILE__), 'boot')

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: highlight
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 1
+  - 1
+  - 3
+  version: 1.1.3
+platform: ruby
+authors: 
+- Marco Otte-Witte
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id001
+description: Highlight highlights code in more than 20 languages. It uses the Pygments syntax highlighter and adds a simple Ruby API over it. It also provides helpers for use in your Ruby on Rails views.
+email: info@simplabs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- HISTORY.md
+- Rakefile
+- MIT-LICENSE
+- generators/highlight_styles_generator/highlight_styles_generator.rb
+- generators/highlight_styles_generator/templates/highlight.css
+- generators/highlight_styles_generator/templates/NOTES
+- lib/simplabs/highlight/pygments_wrapper.rb
+- lib/simplabs/highlight/railtie.rb
+- lib/simplabs/highlight.rb
+- rails/init.rb
+- spec/boot.rb
+- spec/lib/highlight_spec.rb
+- spec/lib/pygments_wrapper_spec.rb
+- spec/lib/view_methods_spec.rb
+- spec/spec_helper.rb
+- spec/spec.opts
+homepage: http://github.com/simplabs/highlight
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 2
+summary: Syntax Higlighting plugin for Ruby on Rails
+test_files: []
+