bjeanes-harsh 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.1.0 / 2009-04-11
+
+* Gemified

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/harsh.rb
+tasks/harsh_tasks.rake
+test/harsh_test.rb
+test/test_helper.rb

data/README.txt

@@ -0,0 +1,149 @@
+== Harsh
+
+* http://www.carboni.ca/
+
+== DESCRIPTION:
+
+"Harsh: Another Rails Syntax Highlighter," is just that - it highlights code
+in Rails, much like Radiograph or tm_syntax_highlighting. However, it does it well, _better_.
+Oh, and it also supports Haml, as well as ERb. And it comes with rake tasks.
+
+Firstly, it allows block form:
+    <% harsh :theme => :dawn do %>
+      class Testing
+        def initialize(str)
+          puts str
+        end
+      end
+    <% end %>
+as well as the form the other plugins offer, which is text as a parameter:
+    <% harsh %Q{
+      class Testing
+        def initialize(str)
+          puts str
+        end
+      end
+    }, :theme => :dawn
+    
+For haml, harsh is implemented as a filter. First, add this to the bottom of your environment.rb:
+    Harsh.enable_haml
+    
+Then, to use harsh in Haml:
+    :harsh
+      class Foo < Bar
+      end
+
+However, haml's filters can't take options. So how on earth are we going to customize it to our
+heart's delight? Easily, my friend, fret not! Enter the BCL (Bootleg Configuration Line):
+
+    :harsh
+      #!harsh theme = all_hallows_eve lines=true syntax=css
+      h1 {
+        float:left;
+        clear:left;
+        position:relative;
+      }
+
+It has to be the first line in the filter. You don't need the config line, though. Also, notice
+that you can have spaces between the arguments and the little = sign.
+
+Harsh also offers rake tasks for what tm_syntax_highlighting provides in generators,
+and a :harsh as a stylesheet-includer to load all syntax-highlighting files, as such:
+    <%= stylesheet_include_tag :harsh %>
+
+The rake tasks for setting up your stylesheets are these:
+    rake harsh:theme:list # lists available themes
+    rake harsh:theme:install[twilight] # installs the twilight theme into /public/stylesheets/harsh/
+    rake harsh:theme:install THEME=twilight # also installs the twilight theme (for *csh shells)
+    rake harsh:theme:uninstall[twilight] # removes the twilight theme
+    rake harsh:theme:uninstall THEME=twilight # also uninstalls the twilight theme (for *csh shells)
+    
+While purely informative, you can find out the available syntaxes as follows:
+    rake harsh:syntax:list
+
+== FEATURES/PROBLEMS
+
+* Syntax highlighting with text as a parameter AND block form!
+* Rake tasks for setting up your stylesheets!
+* Free hat!
+
+== SYNOPSIS
+
+You can pass any of these parameters to tweak things:
+    <% harsh :theme => :dawn, :lines => true, :format => :css do %>
+      h1 {
+        float:left;
+        clear:left;
+        position:relative;
+      }
+    <% end %>
+    
+In its default form though, harsh will use the twilight theme, no lines, and
+will expect Ruby code.
+
+    <% harsh %Q{
+      class Testing
+        def initialize(str)
+          puts str
+        end
+      end
+    }, :theme => :dawn
+    
+For Haml:
+
+    :harsh
+      #!harsh theme = all_hallows_eve lines=true syntax=css
+      h1 {
+        float:left;
+        clear:left;
+        position:relative;
+      }
+      
+The #!harsh line is a configuration line that is optional. Notice that the parameter is "syntax=css",
+not "format" as is the case with the ERb helper.
+
+== REQUIREMENTS
+
+* oniguruma - a regex library. See installation.
+* ultraviolet gem - this does the highlighting. See installation.
+* haml - if you want to use the haml filter. duh.
+
+== INSTALL
+
+First, you'll need oniguruma - a regex library. If you don't think you have this, you probably don't.
+To install it, do the following:
+    wget http://www.geocities.jp/kosako3/oniguruma/archive/onig-5.8.0.tar.gz
+    tar zxvf onig-5.8.0.tar.gz
+    cd onig-5.8.0/
+    ./configure && make && sudo make install
+
+ultraviolet gem - do this AFTER oniguruma!
+    sudo gem install ultraviolet
+    
+Then, install this plugin:
+    script/plugin install git://github.com/michaeledgar/harsh.git
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2009 Michael J. Edgar
+
+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/Rakefile

@@ -0,0 +1,42 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'hoe'
+require File.join(File.dirname(__FILE__), "lib", "harsh")
+
+
+class Hoe 
+   # Dirty hack to eliminate Hoe from gem dependencies
+   def extra_deps 
+      @extra_deps.delete_if{ |x| x.first == 'hoe' }
+   end
+end
+
+Hoe.new('harsh', Harsh::Version * ".") do |p|
+  p.author = "Michael J Edgar"
+  p.email = "adgar@carboni.ca"
+  p.summary = "Harsh: Another Rails Syntax Highlighter"
+  p.extra_deps << ['bjeanes-ultraviolet', '>= 0.10.0']
+  p.extra_deps << ['textpow', '>= 0.10.0']
+end
+
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the harsh plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the harsh plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Harsh'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/harsh.rb

@@ -0,0 +1,74 @@
+# Harsh
+module Harsh
+  Version = [0, 1, 0]
+  
+  module ErbMethods
+    def syntax_highlight(*args, &block)
+      require 'uv'
+      default_options = {:format => "ruby", :theme => "twilight", :lines => false}
+      case args.size
+      when 0
+        opts = default_options
+      when 1
+        if args[0].is_a? String
+          text = args[0]
+          opts = default_options
+        elsif args[0].is_a? Hash
+          opts = default_options.merge(args[0])
+        else
+          raise ArgumentError.new("Must pass either a string or a hash to syntax_highlight()/harsh()")
+        end
+      when 2
+        text = args[0]
+        text = text.sub(/\n/,"") if text =~ /^(\s*)\n/
+        opts = default_options.merge(args[1])
+      end
+      if block_given?
+        text = capture(&block)
+        text = text.sub(/\n/,"") if text =~ /^(\s*)\n/
+        concat(Uv.parse( text, "xhtml", opts[:format].to_s, opts[:lines], opts[:theme].to_s))
+        ""
+      else
+        concat(Uv.parse( text, "xhtml", opts[:format].to_s, opts[:lines], opts[:theme].to_s))
+        ""
+      end
+    end
+    alias_method :harsh, :syntax_highlight
+  end
+  
+  def enable_haml
+    eval <<-EOF
+      module ::Haml
+        module Filters
+          module Harsh
+            include Haml::Filters::Base
+            lazy_require 'uv'
+            def initialize(text)
+              @text = highlight_text(text)
+            end
+            def highlight_text(text, opts = {:format => "ruby", :theme => "twilight", :lines => false})
+              Uv.parse( text, "xhtml", opts[:format], opts[:lines], opts[:theme])
+            end
+            def render(text)
+              all_lines = text.split(/\\n/)
+              if all_lines.first =~ /#!harsh/
+                line = all_lines.first
+                syntax = (line =~ /syntax\\s*=\\s*([\\w-]+)/) ? $1 : "ruby"
+                theme = (line =~ /theme\\s*=\\s*(\\w+)/) ? $1 : "twilight"
+                lines = (line =~ /lines\\s*=\\s*(\\w+)/) ? ($1 == 'true') : false
+                text = all_lines[1..-1].join("\\n")
+                puts({:format => syntax, :theme => theme, :lines => lines}.inspect)
+                Haml::Helpers.preserve(highlight_text(text.rstrip, :format => syntax, :theme => theme, :lines => lines))
+              else
+                Haml::Helpers.preserve(highlight_text(text.rstrip))
+              end
+            end
+          end
+        end
+      end
+    EOF
+  end
+  module_function :enable_haml
+end
+
+

data/tasks/harsh_tasks.rake

@@ -0,0 +1,39 @@
+namespace :harsh do
+  namespace :theme do
+    desc 'List available themes'
+    task :list do
+      puts `uv -l themes`
+    end
+    desc 'Install a theme - either use install[themename] or install THEME=themename'
+    task :install, :theme do |task, args|
+      require 'uv'
+      args.with_defaults(:theme => ENV['THEME'])
+      
+      unless Uv.themes.include?(args[:theme])
+        puts "Error: #{args[:theme]} is not a valid theme."
+        next
+      end
+      
+      tmpfolder = File.join(File.dirname(__FILE__),["..","tmp"])
+      FileUtils.mkdir_p tmpfolder
+      FileUtils.mkdir File.join(RAILS_ROOT,"/public/stylesheets/harsh/") unless File.exists?(File.join(RAILS_ROOT,"/public/stylesheets/harsh/"))
+      puts "Generating themes..."
+      `uv -s ruby --copy-files #{tmpfolder} #{File.dirname(__FILE__)+"/../README.markdown"}`
+      puts "Copying #{args[:theme]}.css..."
+      FileUtils.cp File.join(tmpfolder, ["css","#{args[:theme]}.css"]), File.join(RAILS_ROOT,["public","stylesheets","harsh"])
+      puts "Cleaning up..."
+      FileUtils.rm_rf Dir.glob("#{tmpfolder}/*")
+    end
+    desc 'Uninstall a theme - either use uninstall[themename] or uninstall THEME=themename'
+    task :uninstall, :theme do |task, args|
+      args.with_defaults(:theme => ENV['THEME'])
+      FileUtils.rm_rf File.join(RAILS_ROOT,"/public/stylesheets/harsh/#{args[:theme]}.css")
+    end
+  end
+  namespace :syntax do
+    desc 'List available syntaxes'
+    task :list do
+      puts `uv -l syntaxes`
+    end
+  end
+end

data/test/harsh_test.rb

@@ -0,0 +1,9 @@
+
+require 'test/unit'
+require 'test_helper'
+require File.join(File.dirname(__FILE__), ["..","lib","harsh.rb"])
+class HarshTest < ActiveSupport::TestCase
+  # Testing this is very tough due to the way that harsh works.
+  
+
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: bjeanes-harsh
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael J Edgar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bjeanes-ultraviolet
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: textpow
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.12.1
+    version: 
+description: "\"Harsh: Another Rails Syntax Highlighter,\" is just that - it highlights code in Rails, much like Radiograph or tm_syntax_highlighting. However, it does it well, _better_. Oh, and it also supports Haml, as well as ERb. And it comes with rake tasks.  Firstly, it allows block form: <% harsh :theme => :dawn do %> class Testing def initialize(str) puts str end end <% end %> as well as the form the other plugins offer, which is text as a parameter: <% harsh %Q{ class Testing def initialize(str) puts str end end }, :theme => :dawn  For haml, harsh is implemented as a filter. First, add this to the bottom of your environment.rb: Harsh.enable_haml  Then, to use harsh in Haml: :harsh class Foo < Bar end  However, haml's filters can't take options. So how on earth are we going to customize it to our heart's delight? Easily, my friend, fret not! Enter the BCL (Bootleg Configuration Line):  :harsh #!harsh theme = all_hallows_eve lines=true syntax=css h1 { float:left; clear:left; position:relative; }  It has to be the first line in the filter. You don't need the config line, though. Also, notice that you can have spaces between the arguments and the little = sign.  Harsh also offers rake tasks for what tm_syntax_highlighting provides in generators, and a :harsh as a stylesheet-includer to load all syntax-highlighting files, as such: <%= stylesheet_include_tag :harsh %>  The rake tasks for setting up your stylesheets are these: rake harsh:theme:list # lists available themes rake harsh:theme:install[twilight] # installs the twilight theme into /public/stylesheets/harsh/ rake harsh:theme:install THEME=twilight # also installs the twilight theme (for *csh shells) rake harsh:theme:uninstall[twilight] # removes the twilight theme rake harsh:theme:uninstall THEME=twilight # also uninstalls the twilight theme (for *csh shells)  While purely informative, you can find out the available syntaxes as follows: rake harsh:syntax:list"
+email: adgar@carboni.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/harsh.rb
+- tasks/harsh_tasks.rake
+- test/harsh_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://www.carboni.ca/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: harsh
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: "Harsh: Another Rails Syntax Highlighter"
+test_files: 
+- test/test_helper.rb