rack-pygmoku 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/CHANGELOG

@@ -0,0 +1,5 @@
+0.1.0
+* Initial version; basic implementation
+
+0.1.1
+* Add HTML unescaping to deal with the escaped output from Markdown

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+# Gem dependencies
+gem "nokogiri",     "~> 1.5.0"
+gem "pygments.rb",  "~> 0.2.0"
+gem "rack"
+
+# Development dependencies
+group :development do
+  gem "bundler",    "~> 1.1.0"
+  gem "rake",       "~> 0.9.0"
+  gem "rdoc",       "~> 3.12"
+  gem "rspec",      "~> 2.9.0"
+  gem "watchr",     "~> 0.7"
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    blankslate (2.1.2.4)
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    json (1.6.6)
+    nokogiri (1.5.2)
+    pygments.rb (0.2.11)
+      rubypython (~> 0.5.3)
+    rack (1.4.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    rubypython (0.5.3)
+      blankslate (>= 2.1.2.3)
+      ffi (~> 1.0.7)
+    watchr (0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.0)
+  nokogiri (~> 1.5.0)
+  pygments.rb (~> 0.2.0)
+  rack
+  rake (~> 0.9.0)
+  rdoc (~> 3.12)
+  rspec (~> 2.9.0)
+  watchr (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kevin Rohrbaugh
+
+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.markdown

@@ -0,0 +1,39 @@
+# rack-pygmoku
+
+`Rack::Pygmoku` is a middleware for generating code syntax highlighting using the
+[Pygments](http://pygments.org/) library in an environment where you cannot
+install Pygments directly.
+
+In other words, it's ideal for use on Heroku.
+
+## Usage
+
+First, of course, install the gem.
+
+Currently, `rack-pygmoku` only supports Markdown-style code blocks, like
+so:
+
+    <pre data-lang='ruby'>
+      <code>
+        def greeting
+          'Hello World!'
+        end
+      </code>
+    </pre>
+
+_Note:_ Put the short name of the
+[Pygments lexer](http://pygments.org/docs/lexers/) that you want to use in the
+`data-lang` or `data-lexer` attribute on the `pre` block.
+
+## Status
+
+This is mainly a _toy project_ that I put together for my Nesta-powered
+blog, and is likely to be maintained as such unless others find it
+useful.
+
+## Copyright
+
+Copyright (c) 2011 Kevin Rohrbaugh.
+
+See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'rack/pygmoku/version'
+
+def pkg_dir; @pkg_dir ||= File.expand_path('../pkg', __FILE__); end
+def gem_name;           'rack-pygmoku'; end
+def gemspec_file_name;  "#{gem_name}.gemspec"; end
+def gem_file_name;      "#{gem_name}-#{Rack::Pygmoku::Version::STRING}.gem"; end
+
+desc "Build gem"
+task :build do
+  system "gem build #{gemspec_file_name}"
+
+  FileUtils.mkdir_p(pkg_dir) unless Dir.exist?(pkg_dir)
+  FileUtils.mv gem_file_name, pkg_dir
+end
+
+desc "Release gem"
+task :release => :build do
+  system "gem push #{File.join(pkg_dir, gem_file_name)}"
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.markdown'
+  rdoc.rdoc_files.include('README*', 'lib/**/*.rb')
+end
+
+desc "Run watchr (auto-test)"
+task :watchr do
+  sh %{bundle exec watchr watchr.rb}
+end

data/lib/rack/pygmoku.rb

@@ -0,0 +1,72 @@
+require 'rack/utils'
+require 'nokogiri'
+
+module Rack
+  class Pygmoku
+    include Rack::Utils
+
+    def initialize(app, opts = {})
+      @app  = app
+      @opts = default_opts.merge(opts)
+    end
+
+    def call(env)
+      status, headers, response = @app.call(env)
+      headers = HeaderHash.new(headers)
+
+      if highlight?(status, headers)
+        content = highlight(response.join)
+        headers['Content-Length'] = bytesize(content).to_s
+        response = [content]
+      end
+
+      [status, headers, response]
+    end
+
+    private
+      def highlight?(status, headers)
+        status == 200 &&
+        !headers['Transfer-Encoding'] &&
+        headers['Content-Type'] =~ /html/
+      end
+
+      def highlight(content)
+        require 'pygments'
+
+        element = @opts[:element]
+
+        document = Nokogiri::HTML(content, nil, 'utf-8')
+        nodes = document.css(element)
+        nodes.each do |node|
+          parent_node = node.parent
+          lexer = get_lexer(parent_node)
+          content = unescape_html(node.content)
+
+          highlighted = Pygments.highlight(content, {:lexer => lexer })
+          parent_node.replace(highlighted)
+          parent_node.remove()
+        end
+
+        document.serialize
+      end
+
+      def get_lexer(node)
+        attribute = @opts[:lexer_attr]
+        lexer = 'html'
+        lexer = node[attribute] if node.has_attribute?(attribute)
+        lexer
+      end
+
+      def unescape_html(html)
+        html.to_s.gsub(/&#x000A;/i, "\n").gsub("&lt;", '<').gsub(
+          "&gt;", '>').gsub("&amp;", '&')
+      end
+
+      def default_opts
+        {
+          :element    => 'pre>code',
+          :lexer_attr => 'data-lang'
+        }
+      end
+  end
+end

data/lib/rack/pygmoku/version.rb

@@ -0,0 +1,12 @@
+module Rack
+  class Pygmoku
+    module Version
+      MAJOR = 0
+      MINOR = 1
+      FIX = 1
+      PRE = nil
+
+      STRING = [MAJOR, MINOR, FIX, PRE].compact.join('.')
+    end
+  end
+end

data/spec/lib/rack/pygmoku/version_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'rack/pygmoku/version'
+
+describe Rack::Pygmoku::Version do
+
+  describe "::STRING" do
+    it "is defined" do
+      defined?(subject::STRING).should be_true
+    end
+
+    it "is a String" do
+      subject::STRING.should be_a String
+    end
+
+    it "does not end in ." do
+      subject::STRING.end_with?('.').should be_false
+    end
+  end
+
+  describe "::MAJOR" do
+    it "is defined" do
+      defined?(subject::MAJOR).should be_true
+    end
+
+    it "is a Fixnum" do
+      subject::MAJOR.should be_a Fixnum
+    end
+  end
+
+  describe "::MINOR" do
+    it "is defined" do
+      defined?(subject::MINOR).should be_true
+    end
+
+    it "is a Fixnum" do
+      subject::MINOR.should be_a Fixnum
+    end
+  end
+
+  describe "::FIX" do
+    it "is defined" do
+      defined?(subject::FIX).should be_true
+    end
+
+    it "is a Fixnum" do
+      subject::FIX.should be_a Fixnum
+    end
+  end
+
+  describe "::PRE" do
+    it "is defined" do
+      defined?(subject::PRE).should be_true
+    end
+  end
+end

data/spec/lib/rack/pygmoku_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe Rack::Pygmoku do
+  let(:pygmoku) { Rack::Pygmoku.new(app) }
+  let(:app) do
+    rack_app = double('app').as_null_object
+    rack_app.stub(:call).and_return([status, headers, response])
+    rack_app
+  end
+  let(:status) { 500 }
+  let(:headers) { { 'Content-Length' => 0, 'Content-Type' => content_type } }
+  let(:content_type) { 'text/plain' }
+  let(:response) { Array.new }
+  let(:env) { Hash.new }
+
+  #*****************************************************************************
+  # Shared example groups
+  #*****************************************************************************
+  shared_examples_for "the status is immutable" do
+    it "does not alter the status" do
+      pygmoku.call(env)[0].should == status
+    end
+  end
+
+  shared_examples_for "Content-Length is set" do
+    include Rack::Utils
+
+    it "sets the Content-Length" do
+      status, headers, response = pygmoku.call(env)
+      content_length = bytesize(response.join).to_s
+      headers['Content-Length'] = content_length
+    end
+  end
+
+  shared_examples_for "pass-through middleware" do
+    it_should_behave_like "the status is immutable"
+
+    it "does not alter the headers" do
+      pygmoku.call(env)[1].should == headers
+    end
+
+    it "does not alter the response" do
+      pygmoku.call(env)[2].should == response
+    end
+  end
+
+  #*****************************************************************************
+  # Specs
+  #*****************************************************************************
+  describe "#call" do
+    it "responds to #call" do
+      pygmoku.should respond_to :call
+    end
+
+    context "when the response is 200" do
+      let(:status) { 200 }
+
+      context "and the content is HTML" do
+        include Specs::HtmlHelper
+
+        let(:content_type) { 'text/html' }
+
+        context "and there are matching elements" do
+          let(:response) do
+            html = html_doc_containing %Q{
+              <pre data-lang='ruby'>
+                <code>
+                  def hello
+                    "Hello World!"
+                  end
+                </code>
+              </pre>
+            }
+          end
+          it_should_behave_like "the status is immutable"
+          it_should_behave_like "Content-Length is set"
+
+          it "replaces the highlight element" do
+            response = pygmoku.call(env)[2]
+            document = Nokogiri::HTML(response.join)
+            document.css('pre>code').should be_empty
+          end
+
+          it "inserts marked-up div" do
+            response = pygmoku.call(env)[2]
+            document = Nokogiri::HTML(response.join)
+            document.css('div.highlight').should have(1).element
+          end
+        end
+
+        context "and there are no matching elements" do
+          let(:response) do
+            html = html_doc_containing %Q{
+              <h1>No Code Here!</h1>
+            }
+          end
+          it_should_behave_like "the status is immutable"
+          it_should_behave_like "Content-Length is set"
+
+          it "should not add any highlight markup" do
+            response = pygmoku.call(env)[2].join
+            document = Nokogiri::HTML(response, nil, 'utf-8')
+            document.css('div.highlight').should be_empty
+          end
+        end
+      end
+
+      context "and the content is not HTML" do
+        let(:content_type) { 'application/xml' }
+
+        it_should_behave_like "pass-through middleware"
+      end
+    end
+
+    context "when the response is not 200" do
+      let(:status) { 301 }
+
+      it_should_behave_like "pass-through middleware"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'rack/utils'
+require 'rack/pygmoku'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/spec/support/html_helper.rb

@@ -0,0 +1,16 @@
+module Specs
+  module HtmlHelper
+    def html_doc_containing(body)
+      html =
+%Q{<!DOCTYPE HTML>
+<html>
+<head><title>Test Markup</title></head>
+<body>
+#{body}
+</body>
+</html>
+}
+      [html]
+    end
+  end
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: rack-pygmoku
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Kevin Rohrbaugh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: pygments.rb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: watchr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: ! 'Rack middleware for Pygments use in environments you cannot install
+  Pygments
+
+  directly (e.g., Heroku).
+
+'
+email: kevin@rohrbaugh.us
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.markdown
+files:
+- .document
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- lib/rack/pygmoku.rb
+- lib/rack/pygmoku/version.rb
+- spec/lib/rack/pygmoku/version_spec.rb
+- spec/lib/rack/pygmoku_spec.rb
+- spec/spec_helper.rb
+- spec/support/html_helper.rb
+homepage: http://github.com/krohrbaugh/rack-pygmoku
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4299723835127314902
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.5.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Rack middleware for Pygments-based syntax highlighting
+test_files:
+- spec/lib/rack/pygmoku/version_spec.rb
+- spec/lib/rack/pygmoku_spec.rb
+- spec/spec_helper.rb
+- spec/support/html_helper.rb