ink 0.1.0

data/README.rdoc

@@ -0,0 +1,56 @@
+= Introduction
+
+Ink is a wrapper for Pygments[http://pygments.org/], a nice Python syntax highlighting library, and formatters like RDoc, Markdown and Textile.
+
+= Install
+
+  sudo gem install ink
+
+If you want the source go to http://github.com/fnando/ink
+
+= Usage
+
+  require "rubygems"
+  require "ink"
+
+  # Setting pygmentize when is not in your $PATH
+  Ink::Highlight.bin = "/other/path/pygmentize"
+
+  # Syntax highlighting
+  Ink::Highlight.highlight("Rakefile")
+  Ink::Highlight.highlight("Rakefile", :format => :terminal)
+  Ink::Highlight.highlight("Rakefile", :language => "rb")
+  Ink::Highlight.highlight("Rakefile", :guess => :filename)
+  Ink::Highlight.highlight("Rakefile", :guess => :content)
+
+  # Formatting
+  Ink::Formatter.format(@code, "Rakefile")
+
+== Ruby on Rails
+
+You can add the Ink::Helper module.
+
+  module ApplicationHelper
+    include Ink::Helper
+  end
+
+This module adds two methods.
+
+  <%= highlight @code, :file => "Rakefile" %>
+  <%= highlight @code, :language => :ruby %>
+
+  <%= format @code, "Rakefile" %>
+
+= License
+
+(The MIT License)
+
+Copyright © 2010:
+
+* Nando Vieira - http://simplesideias.com.br
+
+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/lib/ink.rb

@@ -0,0 +1,10 @@
+require "rdiscount"
+require "RedCloth"
+require "rdoc/markup"
+require "rdoc/markup/to_html"
+require "tempfile"
+require "open3"
+require "ink/version"
+require "ink/helper"
+require "ink/highlight"
+require "ink/formatter"

data/lib/ink/formatter.rb

@@ -0,0 +1,28 @@
+module Ink
+  module Formatter
+    extend Ink::Helper
+
+    # Format the specified content based on the
+    # filename. It can detect Markdown (<tt>*.{markdown,mkdn}</tt>),
+    # Textile (<tt>*.textile</tt>), RDoc (<tt>*.rdoc</tt>).
+    # Any other file will be highlighted by using Pygments and language detection
+    # based on filename.
+    #
+    #   Ink::Formatter.format(@code, "Rakefile")
+    #
+    def self.format(content, file)
+      basename = File.basename(file)
+
+      case basename
+      when /\.rdoc$/i
+        RDoc::Markup::ToHtml.new.convert(content)
+      when /\.(markdown|mkdn)$/i
+        RDiscount.new(content).to_html
+      when /\.textile$/i
+        RedCloth.new(content).to_html
+      else
+        highlight(content, :file => file)
+      end
+    end
+  end
+end

data/lib/ink/helper.rb

@@ -0,0 +1,43 @@
+module Ink
+  # The Ink::Helper module is great for shortcuts. On Rails applications,
+  # can be added to ApplicationHelper.
+  #
+  #   module ApplicationHelper
+  #     include InkHelper
+  #   end
+  #
+  module Helper
+    # Return a code snippet formatted by using
+    # the Ink::Formatter.format method.
+    #
+    #   <%= format @code, "Rakefile" %>
+    #
+    def format(code, file)
+      Ink::Formatter.format(code, file)
+    end
+
+    # Return a code snippet highlighted in the specified
+    # language. When a <tt>:file</tt> option is provided,
+    # then language will be guessed by the filename.
+    # If no language is specified will set to <tt>:text</tt>.
+    #
+    #   <%= highlight @code, :file => "Rakefile" %>
+    #   <%= highlight @code, :language => :ruby %>
+    #
+    def highlight(code, options = {})
+      file = Tempfile.new("highlight")
+      File.open(file.path, "w+") do |f|
+        f << "#{code}\n"
+      end
+
+      if options[:file]
+        language = Highlight.guess_by_filename(options[:file])
+      else
+        language = options[:language] || :text
+      end
+
+      code = Ink::Highlight.highlight(file.path, :language => language)
+      %[<div class="code #{language}">#{code}</div>]
+    end
+  end
+end

data/lib/ink/highlight.rb

@@ -0,0 +1,115 @@
+module Ink
+  # Pygments is a nice syntax highlighter for Python.
+  # This wrapper will call the +pygmentize+ bin and return
+  # a highlighted source code.
+  #
+  # If the +pygmentize+ bin is not available in your <tt>$PATH</tt>,
+  # you can set it:
+  #
+  #   Ink::Highlight.bin = "/other/path/pygmentize"
+  #
+  # To use it with Ruby on Rails, you can include it on +ApplicationHelper+.
+  #
+  #   module ApplicationHelper
+  #     include Ink::Highlight::Helper
+  #   end
+  #
+  # Then you can use it on views:
+  #
+  #   <%= highlight @code, :ruby %>
+  #
+  module Highlight
+    class << self
+      # Set the bin that should be ran. It assumes that
+      # the +pygmentize+ bin is available on <tt>$PATH</tt>.
+      attr_accessor :bin
+    end
+
+    # Set default binary path. It assumes that is
+    # present on <tt>$PATH</tt>.
+    self.bin = "pygmentize"
+
+    # Store all available formatters.
+    FORMATTERS = [:bbcode, :html, :latex, :rtf, :terminal, :text]
+
+    FILENAME_MATCHERS = {
+      :rb => [ "Rakefile", "Capfile", "Gemfile", /\.(rb|rbx|rxml|builder|rjs|rake|rbw|gemspec)$/i ],
+      :rhtml => [ /\.rhtml$/i ],
+      :erb => [ /\.erb$/i ],
+      :js => [ /\.js$/i ],
+      "html+php" => [ /\.(phtml|php)$/i ],
+      :yaml => [ /\.ya?ml$/i ],
+      :xml => [ /\.(xml|xsl|rss|atom|xslt|xsd|wsdl)$/i ],
+      :erlang => [ /\.(erl|hrl)$/i ],
+      :css => [ /\.css$/i ],
+      :cucumber => [ /\.feature$/i ],
+      :c => [ /\.(c|h)$/i ],
+      :coffeescript => [ /\.coffee$/i ],
+      :haml => [ /\.haml$/i ],
+      :html => [ /\.x?html?$/i ],
+      :sass => [ /\.sass$/i ],
+      "objective-c" => [ /\.m$/i ],
+      :python => [ /\.(pyw?|sc|SConstruct|SConscript|tac)$/i ],
+      :scala => [ /\.scala$/i ],
+    }
+
+    # Try to guess what's the file's language by checking its content.
+    # If no language is detected, returns :text.
+    #
+    #   Ink::Highlight.guess("Rakefile")
+    #   #=> "rb"
+    #
+    def self.guess(file)
+      execute("#{bin} -N #{file.inspect}").to_sym
+    end
+
+    # Try to guess what's the file's language by checking its filename.
+    # If no language is detected, returns :text.
+    #
+    #   Ink::Highlight.guess_by_filename("Rakefile")
+    #   #=> "rb"
+    #
+    def self.guess_by_filename(file)
+      basename = File.basename(file)
+
+      FILENAME_MATCHERS.each do |lexer, matchers|
+        matchers.each do |matcher|
+          case matcher
+          when String
+            return lexer.to_s if matcher == basename
+          when Regexp
+            return lexer.to_s if basename =~ matcher
+          end
+        end
+      end
+
+      "text"
+    end
+
+    # Return the highlighted code for the specified file.
+    # You can provide the language (try to guess by default) and format (defaults to <tt>:html</tt>).
+    # The available formatters are stored in Highlight::FORMATTERS.
+    # The available languages can be found by running <tt>pygmentize -L lexers</tt>.
+    #
+    #   Ink::Highlight.highlight("Rakefile")
+    #   Ink::Highlight.highlight("Rakefile", :format => :terminal)
+    #   Ink::Highlight.highlight("Rakefile", :language => "rb")
+    #   Ink::Highlight.highlight("Rakefile", :guess => :filename)
+    #   Ink::Highlight.highlight("Rakefile", :guess => :content)
+    #
+    def self.highlight(file, options = {})
+      options = {
+        :language => (options[:guess] == :filename ? guess_by_filename(file) : guess(file)),
+        :format => :html
+      }.merge(options)
+
+      execute("#{bin} -f #{options[:format]} -O nowrap=true -l #{options[:language]} #{file.inspect}")
+    end
+
+    def self.execute(command) # :nodoc:
+      stdin, stdout, stderr = Open3.popen3(command)
+      stdin.close
+      stdout.read.chomp
+    end
+  end
+end

data/lib/ink/version.rb

@@ -0,0 +1,8 @@
+module Ink
+  module Version # :nodoc: all
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/test/ink/formatter_test.rb

@@ -0,0 +1,20 @@
+require "test_helper"
+
+class Ink::FormatterTest < Test::Unit::TestCase
+  def test_markdown
+    assert_match %r{<h1>.*?</h1>}, Ink::Formatter.format("Hello\n=====", "file.markdown")
+    assert_match %r{<h1>.*?</h1>}, Ink::Formatter.format("Hello\n=====", "file.mkdn")
+  end
+
+  def test_textile
+    assert_match %r{<h1>.*?</h1>}, Ink::Formatter.format("h1. Hello", "file.textile")
+  end
+
+  def test_highlight
+    assert_match %r{<div class="code rb">(.*?)</div>}, Ink::Formatter.format("puts 'Hello world!'", "file.rb")
+  end
+
+  def test_rdoc
+    assert_match %r{<h1>.*?</h1>}, Ink::Formatter.format("= Hello", "file.rdoc")
+  end
+end

data/test/ink/helper_test.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+
+class Ink::HelperTest < Test::Unit::TestCase
+  def test_highlight_helper
+    helper = Object.extend(Ink::Helper)
+    html = helper.highlight(%[puts "Hello world!"], :language => :ruby)
+
+    assert_match /<div class="code ruby">(.*?)<\/div>/, html
+  end
+
+  def test_highlight_helper_using_defaults
+    helper = Object.extend(Ink::Helper)
+    html = helper.highlight(%[Hello world!])
+
+    assert_match /<div class="code text">(.*?)<\/div>/, html
+  end
+
+  def test_highlight_helper_using_guess
+    helper = Object.extend(Ink::Helper)
+    html = helper.highlight(%[puts "Hello world!"], :file => "hello.rb")
+
+    assert_match /<div class="code rb">(.*?)<\/div>/, html
+  end
+end

data/test/ink/highlight_test.rb

@@ -0,0 +1,133 @@
+require "test_helper"
+
+class Ink::HighlightTest < Test::Unit::TestCase
+  def setup
+    Ink::Highlight.bin = "pygmentize"
+  end
+
+  def test_set_different_bin
+    Ink::Highlight.bin = "/some/path/pygmentize"
+    assert_equal "/some/path/pygmentize", Ink::Highlight.bin
+  end
+
+  def test_guess_lexer
+    assert_equal :rb, Ink::Highlight.guess(__FILE__)
+  end
+
+  def test_highlight_file_using_defaults
+    Ink::Highlight.expects(:execute).with("pygmentize -N #{__FILE__.inspect}").returns("ruby")
+    Ink::Highlight.expects(:execute).with("pygmentize -f html -O nowrap=true -l ruby #{__FILE__.inspect}")
+    Ink::Highlight.highlight(__FILE__)
+  end
+
+  def test_highlight_file_using_specified_language
+    Ink::Highlight.expects(:execute).with("pygmentize -N #{__FILE__.inspect}").returns("sample")
+    Ink::Highlight.expects(:execute).with("pygmentize -f html -O nowrap=true -l sample #{__FILE__.inspect}")
+    Ink::Highlight.highlight(__FILE__, :language => "sample")
+  end
+
+  def test_highlight_file_using_specified_format
+    Ink::Highlight.expects(:execute).with("pygmentize -N #{__FILE__.inspect}").returns("rb")
+    Ink::Highlight.expects(:execute).with("pygmentize -f terminal -O nowrap=true -l rb #{__FILE__.inspect}")
+    Ink::Highlight.highlight(__FILE__, :format => "terminal")
+  end
+
+  def test_guess_lexer_by_filename_default
+    assert_equal "text", Ink::Highlight.guess_by_filename("file")
+  end
+
+  def test_guess_lexer_by_filename_ruby
+    assert_equal "rb", Ink::Highlight.guess_by_filename("Rakefile")
+    assert_equal "rb", Ink::Highlight.guess_by_filename("Gemfile")
+    assert_equal "rb", Ink::Highlight.guess_by_filename("Capfile")
+    assert_equal "rb", Ink::Highlight.guess_by_filename("file.rb")
+    assert_equal "rb", Ink::Highlight.guess_by_filename("file.rbx")
+    assert_equal "rb", Ink::Highlight.guess_by_filename("file.rxml")
+    assert_equal "rb", Ink::Highlight.guess_by_filename("file.builder")
+    assert_equal "rb", Ink::Highlight.guess_by_filename("file.rjs")
+    assert_equal "rb", Ink::Highlight.guess_by_filename("tasks.rake")
+    assert_equal "rb", Ink::Highlight.guess_by_filename("file.rbw")
+    assert_equal "rb", Ink::Highlight.guess_by_filename("file.gemspec")
+  end
+
+  def test_guess_lexer_by_filename_erb
+    assert_equal "erb", Ink::Highlight.guess_by_filename("show.html.erb")
+  end
+
+  def test_guess_lexer_by_filename_rhtml
+    assert_equal "rhtml", Ink::Highlight.guess_by_filename("show.rhtml")
+  end
+
+  def test_guess_lexer_by_filename_js
+    assert_equal "js", Ink::Highlight.guess_by_filename("jquery.js")
+  end
+
+  def test_guess_lexer_by_filename_php
+    assert_equal "html+php", Ink::Highlight.guess_by_filename("file.phtml")
+    assert_equal "html+php", Ink::Highlight.guess_by_filename("file.php")
+  end
+
+  def test_guess_lexer_by_filename_yaml
+    assert_equal "yaml", Ink::Highlight.guess_by_filename("file.yaml")
+    assert_equal "yaml", Ink::Highlight.guess_by_filename("file.yml")
+  end
+
+  def test_guess_lexer_by_filename_xml
+    assert_equal "xml", Ink::Highlight.guess_by_filename("file.xml")
+    assert_equal "xml", Ink::Highlight.guess_by_filename("file.xslt")
+    assert_equal "xml", Ink::Highlight.guess_by_filename("file.xsl")
+    assert_equal "xml", Ink::Highlight.guess_by_filename("file.rss")
+    assert_equal "xml", Ink::Highlight.guess_by_filename("file.atom")
+    assert_equal "xml", Ink::Highlight.guess_by_filename("file.xsd")
+    assert_equal "xml", Ink::Highlight.guess_by_filename("file.wsdl")
+  end
+
+  def test_guess_lexer_by_filename_erlang
+    assert_equal "erlang", Ink::Highlight.guess_by_filename("file.erl")
+    assert_equal "erlang", Ink::Highlight.guess_by_filename("file.hrl")
+  end
+
+  def test_guess_lexer_by_filename_css
+    assert_equal "css", Ink::Highlight.guess_by_filename("file.css")
+  end
+
+  def test_guess_lexer_by_filename_cucumber
+    assert_equal "cucumber", Ink::Highlight.guess_by_filename("file.feature")
+  end
+
+  def test_guess_lexer_by_filename_c
+    assert_equal "c", Ink::Highlight.guess_by_filename("file.c")
+    assert_equal "c", Ink::Highlight.guess_by_filename("file.h")
+  end
+
+  def test_guess_lexer_by_filename_coffeescript
+    assert_equal "coffeescript", Ink::Highlight.guess_by_filename("file.coffee")
+  end
+
+  def test_guess_lexer_by_filename_haml
+    assert_equal "haml", Ink::Highlight.guess_by_filename("file.haml")
+  end
+
+  def test_guess_lexer_by_filename_sass
+    assert_equal "sass", Ink::Highlight.guess_by_filename("file.sass")
+  end
+
+  def test_guess_lexer_by_filename_html
+    assert_equal "html", Ink::Highlight.guess_by_filename("file.html")
+    assert_equal "html", Ink::Highlight.guess_by_filename("file.htm")
+    assert_equal "html", Ink::Highlight.guess_by_filename("file.xhtml")
+  end
+
+  def test_guess_lexer_by_filename_objective_c
+    assert_equal "objective-c", Ink::Highlight.guess_by_filename("file.m")
+  end
+
+  def test_guess_lexer_by_filename_python
+    assert_equal "python", Ink::Highlight.guess_by_filename("file.py")
+    assert_equal "python", Ink::Highlight.guess_by_filename("file.pyw")
+    assert_equal "python", Ink::Highlight.guess_by_filename("file.sc")
+    assert_equal "python", Ink::Highlight.guess_by_filename("file.SConstruct")
+    assert_equal "python", Ink::Highlight.guess_by_filename("file.SConscript")
+    assert_equal "python", Ink::Highlight.guess_by_filename("file.tac")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require "rubygems"
+gem "test-unit"
+require "test/unit"
+require "mocha"
+require "ink"

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: ink
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-12 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Ink is a wrapper for Pygments, a nice Python syntax highlighting library and formatters like RDoc, Markdown and Textile.
+email: fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- lib/ink.rb
+- lib/ink/formatter.rb
+- lib/ink/helper.rb
+- lib/ink/highlight.rb
+- lib/ink/version.rb
+- test/ink/formatter_test.rb
+- test/ink/helper_test.rb
+- test/ink/highlight_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/fnando/ink
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ink is a wrapper for Pygments, a nice Python syntax highlighting library and formatters like RDoc, Markdown and Textile.
+test_files: 
+- test/ink/formatter_test.rb
+- test/ink/helper_test.rb
+- test/ink/highlight_test.rb
+- test/test_helper.rb