dasil003-tm_syntax_highlighting 1.9.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008, 2010 [Arya Asemanfar, Gabe da Silveira]
+
+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,71 @@
+# TmSyntaxHighlighting
+
+
+
+## Gems, Generators and Versions
+
+TextMate theme based highlighting for Ruby 1.9.2 and Rails 3.
+
+This plugin was originally written by Arya Asemanfar.  Rails 3 generator and 1.9.2 compatibility by Gabe da Silveira.
+
+I namespaced it as dasil003-tm_syntax_highlighting to avoid interference with the original. **This version is incompatible
+with Ruby 1.8.x**
+
+
+
+## Installation
+
+You may remember the setup for this plugin being complicated.  Well that was in Ruby 1.8 land.  Ruby 1.9 has oniguruma
+built-in and thus everything becomes much less painful:
+
+    $ gem install dasil003-tm_syntax_highlighting
+
+which will also install `spox-ultraviolet`, the covertly 1.9 compatible version of ultraviolet.
+
+
+
+## CSS Generator
+
+It just copies all the syntax files from ultraviolet into your stylesheets directory.  I haven't had time to figure out
+the Thor setup in Rails 3, so sue me.
+
+    # generate all the ultraviolet css theme files in public/stylesheets/syntax/*
+    $ rails generate syntax_css
+
+
+
+## Examples
+
+The plugin adds 2 view helper methods: `code` and `syntax_css`
+
+
+### code (helper method) usage
+
+    code(some_ruby_code, :theme => "twilight", :lang => "ruby", :line_numbers => true)
+
+`lang` and `line_numbers` are optional. `lang` will default to plain_text and `line_numbers` will default to true.
+
+It is *HIGHLY* recommended that you fragment cache or some other type of caching for code fragments because `ultraviolet` is fairly slow.
+
+Theme can be an array, and one will be chosen at random.
+
+You can set defaults in an initializer:
+
+    # config/initializers/tm_syntax_config.rb
+    TmSyntaxHighlighting.defaults = {:theme => "sunburst", :line_numbers => true, :lang => "ruby"}
+
+Again, theme can be an array and will be chosen at random.
+
+
+### syntax_css (helper_method) usage
+
+The syntax_css method will include the stylesheet tags for the themes. You can call it with a theme name
+
+    syntax_css("twilight")
+
+or if you call it with no options, it will include all the css files for the themes used in this request
+
+    code(some_ruby_code, :theme => "twilight")
+    code(some_more_ruby_code, :theme => "sunburst")
+    ...
+    syntax_css # yields stylesheet tags for both twilight and sunburst

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the tm_syntax_highlighting plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the tm_syntax_highlighting plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TmSyntaxHighlighting'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "dasil003-tm_syntax_highlighting"
+    gemspec.summary = "Ruby 1.9.2 / Rails 3 plugin to highlight code"
+    gemspec.description = "Uses the spox-ultraviolet gem to highlight any language that TextMate can highlight, and has a (Thor) generator to generate the relevant CSS files."
+    gemspec.email = "gabe@websaviour.com"
+    gemspec.homepage = "http://github.com/dasil003/tm_syntax_highlighting"
+    gemspec.authors = ["Arya Asemanfar", "Gabe da Silveira"]
+
+    gemspec.add_dependency('spox-ultraviolet')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+1.9.0

data/dasil003-tm_syntax_highlighting.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dasil003-tm_syntax_highlighting}
+  s.version = "1.9.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Arya Asemanfar", "Gabe da Silveira"]
+  s.date = %q{2010-11-17}
+  s.description = %q{Uses the spox-ultraviolet gem to highlight any language that TextMate can highlight, and has a (Thor) generator to generate the relevant CSS files.}
+  s.email = %q{gabe@websaviour.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "dasil003-tm_syntax_highlighting.gemspec",
+    "lib/generators/USAGE",
+    "lib/generators/syntax_css_generator.rb",
+    "lib/tm_syntax_highlighting.rb",
+    "lib/tm_syntax_highlighting/base.rb",
+    "test/tm_syntax_highlighting_test.rb",
+    "tm_syntax_highlighting.gemspec"
+  ]
+  s.homepage = %q{http://github.com/dasil003/tm_syntax_highlighting}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby 1.9.2 / Rails 3 plugin to highlight code}
+  s.test_files = [
+    "test/tm_syntax_highlighting_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<spox-ultraviolet>, [">= 0"])
+    else
+      s.add_dependency(%q<spox-ultraviolet>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<spox-ultraviolet>, [">= 0"])
+  end
+end
+

data/lib/generators/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates the TextMate theme CSS files from Ultraviolet
+
+Example:
+    rails generate syntax_css
+
+    This will create the files at:
+        public/stylesheets/syntax/*

data/lib/generators/syntax_css_generator.rb

@@ -0,0 +1,10 @@
+require 'rails/generators'
+
+class SyntaxCssGenerator < Rails::Generators::Base
+  def install_syntax_css
+    Uv.themes.each do |theme|
+      fullpath = File.join(Uv.path, "render", "xhtml", "files", "css", "#{theme}.css")
+      copy_file(fullpath, "public/stylesheets/syntax/#{theme}.css")
+    end
+  end
+end

data/lib/tm_syntax_highlighting.rb

@@ -0,0 +1,8 @@
+require 'uv'
+
+require 'action_controller'
+
+require 'tm_syntax_highlighting/base'
+
+ActionView::Base.send(:include, TmSyntaxHighlighting::Helper)
+ActionController::Base.send(:extend, TmSyntaxHighlighting::Controller)

data/lib/tm_syntax_highlighting/base.rb

@@ -0,0 +1,81 @@
+module TmSyntaxHighlighting
+  module Helper
+    def code(code, options = {})
+      options = TmSyntaxHighlighting.defaults.merge_with(options)
+      TmSyntaxHighlighting.defaults[:current_themes] << options[:theme]
+      options[:lang] = "plain_text" unless Uv.syntaxes.include?(options[:lang])
+      Uv.parse(code, "xhtml", options[:lang], options[:line_numbers], options[:theme])
+    end
+
+    def syntax_css(theme = nil)
+      themes = [theme || TmSyntaxHighlighting.defaults.options[:theme]].flatten
+      themes = (themes & TmSyntaxHighlighting.defaults[:current_themes]) if theme.nil? && TmSyntaxHighlighting.defaults[:current_themes]
+      themes.uniq.collect do |theme|
+        stylesheet_link_tag "syntax/#{theme}"
+      end.join("\n")
+    end
+  end
+
+  module Controller
+    def self.extended(base)
+      base.after_filter :reset_syntax_css_includes
+      base.send(:include, InstanceMethods)
+      TmSyntaxHighlighting.defaults.reset_current_themes
+    end
+
+    module ClassMethods
+    end
+
+    module InstanceMethods
+      def reset_syntax_css_includes
+        TmSyntaxHighlighting.defaults.reset_current_themes
+      end
+    end
+  end
+
+  def self.defaults
+    Config
+  end
+
+  def self.defaults=(options_hash)
+    options_hash.each do |key, value|
+      self.defaults.send("#{key}=", value)
+    end
+  end
+
+  class Config
+    @@attributes = [:theme, :lang, :line_numbers, :current_themes]
+    cattr_accessor *@@attributes
+
+    self.line_numbers = true
+    class << self
+      def [](key)
+        self.send(key)
+      end
+
+      def []=(key, value)
+        self.send("#{key}=", value)
+      end
+
+      def options
+        opts = {}
+        @@attributes.each do |attribute|
+          opts[attribute] = self.send(attribute)
+        end
+        opts
+      end
+
+      def merge_with(opts)
+        opts = self.options.merge(opts)
+        if opts[:theme].is_a?(Array)
+          opts[:theme] = opts[:theme][rand(opts[:theme].size)]
+        end
+        opts
+      end
+
+      def reset_current_themes
+        self.current_themes = []
+      end
+    end
+  end
+end

data/test/tm_syntax_highlighting_test.rb

@@ -0,0 +1,21 @@
+require 'tm_syntax_highlighting'
+require 'test/unit'
+
+class TmSyntaxHighlightingTest < Test::Unit::TestCase
+  def test_action_controller_methods_inclusion
+    assert ActionController::Base.instance_methods.include?(:reset_syntax_css_includes)
+  end
+
+  def test_action_view_methods_inclusion
+    assert ActionView::Base.instance_methods.include?(:code), ':code not included'
+    assert ActionView::Base.instance_methods.include?(:syntax_css), ':syntax_css not included'
+  end
+
+  def test_code_helper
+    @view = ActionView::Base.new
+    html = @view.code("def ruby_method(param)\n  return :foo\nend", :lang => 'ruby')
+    assert_match /span class="line-numbers"/, html, "no line number span found"
+    assert_match /span class="Keyword"/, html, "no keyword span found"
+    assert_match /span class="FunctionName"/, html, "no function name span found"
+  end
+end

data/tm_syntax_highlighting.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tm_syntax_highlighting}
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Arya Asemanfar", "Gabe da Silveira"]
+  s.date = %q{2010-01-21}
+  s.description = %q{Uses the Ultraviolet gem to highlight any language that TextMate can highlight, and has a (Thor) generator to generate the relevant CSS files.}
+  s.email = %q{gabe@websaviour.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "install.rb",
+     "lib/generators/USAGE",
+     "lib/generators/syntax_css_generator.rb",
+     "lib/tm_syntax_highlighting.rb",
+     "lib/tm_syntax_highlighting/base.rb",
+     "test/tm_syntax_highlighting_test.rb",
+     "tm_syntax_highlighting.gemspec",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/dasil003/tm_syntax_highlighting}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Gem plugin for Rails 3 to highlight code}
+  s.test_files = [
+    "test/tm_syntax_highlighting_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ultraviolet>, [">= 0"])
+    else
+      s.add_dependency(%q<ultraviolet>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ultraviolet>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: dasil003-tm_syntax_highlighting
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 9
+  - 0
+  version: 1.9.0
+platform: ruby
+authors: 
+- Arya Asemanfar
+- Gabe da Silveira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-17 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spox-ultraviolet
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Uses the spox-ultraviolet gem to highlight any language that TextMate can highlight, and has a (Thor) generator to generate the relevant CSS files.
+email: gabe@websaviour.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- dasil003-tm_syntax_highlighting.gemspec
+- lib/generators/USAGE
+- lib/generators/syntax_css_generator.rb
+- lib/tm_syntax_highlighting.rb
+- lib/tm_syntax_highlighting/base.rb
+- test/tm_syntax_highlighting_test.rb
+- tm_syntax_highlighting.gemspec
+has_rdoc: true
+homepage: http://github.com/dasil003/tm_syntax_highlighting
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby 1.9.2 / Rails 3 plugin to highlight code
+test_files: 
+- test/tm_syntax_highlighting_test.rb