tm_syntax_highlighting 0.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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

@@ -0,0 +1,68 @@
+TmSyntaxHighlighting
+====================
+** NOTE: You must install ultraviolet *before* installing this plugin. Follow the instructions below.
+
+This plugin allows you to add TextMate themed syntax highlighting to your views.
+
+It requires the Ultraviolet gem, which requires TextPow, which requires oniguruma (both the gem and the system library).
+
+Oniguruma is a regular expression library used by TextPow in order to properly parse TextMate syntax/language files.
+It's relatively easy to install, here is the URL for the library:
+  http://www.geocities.jp/kosako3/oniguruma/
+
+Then you need to do
+  $ gem install ultraviolet  
+which should install ultraviolet, textpow, and oniguruma.
+
+Lastly, in order for this plugin to properly copy the syntax CSS files from ultraviolet, ultraviolet must already be installed. In other words, you need to install ultraviolet before installing this plugin.
+
+The plugin comes with a generator for the stylesheets for the different themes.
+  
+  # to see a list of themes
+  $ script/generate syntax_css list
+  
+  # to copy all the themes to public/stylesheets/syntax
+  $ script/generate syntax_css all
+  
+  # to copy a single theme to public/stylesheets/syntax
+  $ script/generate syntax_css theme_name
+  
+Example
+=======
+
+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 (TextPow and/or Ultraviolet have some speed issues).
+
+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
+================================
+lastly, 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,45 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'uv'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "tm_syntax_highlighting"
+    #s.executables = "tm_syntax_highlighting"
+    s.summary = "a gem to get syntaxhilight via ultraviolet"
+    s.description = "a gem to get syntaxhilight via ultraviolet"
+    s.email = "seivan@kth.se"
+    s.homepage = "http://github.com/seivan"
+    #s.rubyforge_project = 'pickles'
+    s.authors = ["Seivan Heidari"]
+    #s.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*", 'lib/jeweler/templates/.gitignore']
+    s.add_development_dependency ["ultraviolet"]
+    Jeweler::GemcutterTasks.new
+  end
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    #rubyforge.doc_task = "yardoc"
+  end
+  rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+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

data/VERSION

@@ -0,0 +1,2 @@
+0.0.0
+0.0.1

data/generators/syntax_css/syntax_css_generator.rb

@@ -0,0 +1,49 @@
+class SyntaxCssGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      # This whole copy CSS files to the tamplates folder isn't very clean
+      # generator library doesn't let me specify an absolute path for m.file so this is a compromise
+      # FIXME: make this cleaner
+      theme = args[0]
+
+      themes = Uv.themes
+      
+      if theme == "all"
+        m.directory("public/stylesheets/syntax")
+        copy_theme_from_uv(*themes)
+        themes.each do |css|
+          m.file("/#{css}.css", "public/stylesheets/syntax/#{css}.css")
+        end
+      elsif theme == "list"
+        puts themes.sort.join("\n")
+      else
+        css = themes.detect do |s|
+          s.downcase.strip == theme.downcase.strip
+        end
+        
+        if css
+          m.directory("public/stylesheets/syntax")
+          m.file("#{css}.css", "public/stylesheets/syntax/#{css}.css")
+        else
+          usage_message
+          puts "Could not find theme named #{theme}."
+        end
+      end
+    end
+  end
+  
+  protected
+  def banner
+    puts "Copies Syntax CSS files to public/stylesheets/syntax/\n\n"
+  end  
+  
+  def usage_message
+    puts "Usage: #{$0} syntax_css [all | list | theme_name]"
+  end
+  
+  def copy_theme_from_uv(*args)
+    args.each do |theme|
+      FileUtils.cp(File.join(Uv.path, "render", "xhtml", "files", "css", "#{theme}.css"), source_path("/"))
+    end
+  end
+end

data/init.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'uv'
+
+# takes about a second to this, if we don't do it now, then the first call to highlight will take a little longer
+Uv.init_syntaxes 
+
+ActionView::Base.send(:include, TmSyntaxHighlighting::Helper)
+ActionController::Base.send(:extend, TmSyntaxHighlighting::Controller)
+

data/install.rb

@@ -0,0 +1 @@
+puts IO.read(File.join(File.dirname(__FILE__), 'README'))

data/lib/tm_syntax_highlighting.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,8 @@
+require 'test/unit'
+
+class TmSyntaxHighlightingTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: tm_syntax_highlighting
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Seivan Heidari
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-26 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ultraviolet
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: a gem to get syntaxhilight via ultraviolet
+email: seivan@kth.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- generators/syntax_css/syntax_css_generator.rb
+- generators/syntax_css/templates/.gitignore
+- init.rb
+- install.rb
+- lib/tm_syntax_highlighting.rb
+- test/tm_syntax_highlighting_test.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/seivan
+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: a gem to get syntaxhilight via ultraviolet
+test_files: 
+- test/tm_syntax_highlighting_test.rb