middleman-syntax 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31ff85827507a7caad10ae8dccff687f547edced
-  data.tar.gz: d31823eb1983846b162e3de7bcea55f31499926a
+  metadata.gz: b4d472a90adef6ca025bcac82d3f00f6546d0083
+  data.tar.gz: 72e518ba6b0ee79bcbd16c9382bad88d3cffad25
 SHA512:
-  metadata.gz: d5d1a42e3270f30f5537293a0832daeddf3f0686199ca8eb5cfa006ced13d9d5cd4afae1a552286d5efa8c9eebd13c04d6c5572458e277cb2527a2b8576db5ed
-  data.tar.gz: fbcb4c67df6efac0c072f1033f15286cb3faf92501fdff115709956a472743be7041012ada7d98a07da2e291a7588f3f4295ee61ace1de319df7f7c94a4b3f11
+  metadata.gz: 854f1f201cf18fe0d765a3e20a6106466e2bd743475228aebcb32747a067daa0961442bfd1ffada7f0e64d6f3f9c38bf6785658c76a2992585074975db95fc82
+  data.tar.gz: 09db1d1c2d64c46ac851b5fd99595086a7f914ccdb192f54d95de7b8658501e7cafdb04c52a1ce6f9daa68df5cff70ff51f644a361cf24fa9d7cd9384bde080e

data/.travis.yml

@@ -1,15 +1,10 @@
 rvm:
   - 1.8.7
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
   - jruby-18mode
   - jruby-19mode
   
 script: "bundle exec rake test"
 
 env: TEST=true TRAVIS=true
-
-matrix:
-  allow_failures:
-    - rvm: jruby-18mode
-    - rvm: jruby-19mode

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+1.2.0
+------
+
+* Support Kramdown as Markdown engine in addition to Redcarpet.
+* Switch to Rouge from Pygments.rb
+* Fix bugs around setting language options.
+
+1.1.1
+-----
+
+* Properly merge language attribute for Markdown. #14
+
 1.1.0
 -----
 

data/Gemfile

@@ -1,23 +1,23 @@
-source :rubygems
+source 'https://rubygems.org'
 
 git "git://github.com/middleman/middleman.git" do
-  # gem "middleman"
   gem "middleman-core"
-  # gem "middleman-more"
 end
 
 # Specify your gem's dependencies in middleman-blog.gemspec
 gemspec
 
-group :development do
-  gem "rake",     "~> 0.9.2"
-  gem "rdoc",     "~> 3.9"
-  gem "yard",     "~> 0.8.0"
-end
+gem 'padrino-helpers'
+gem 'kramdown'
 
-group :test do
-  gem "cucumber", "~> 1.2.0"
-  gem "fivemat"
-  gem "aruba",    "~> 0.4.11"
-  gem "rspec",    "~> 2.7"
+platforms :ruby do
+  gem 'redcarpet'
 end
+
+gem "rake",     "~> 0.9.2"
+gem "rdoc",     "~> 3.9"
+gem "yard",     "~> 0.8.0"
+gem "cucumber", "~> 1.2.0"
+gem "fivemat"
+gem "aruba",    "~> 0.4.11"
+gem "rspec",    "~> 2.7"

data/README.md

@@ -1,6 +1,6 @@
 # middleman-syntax
 
-middleman-syntax is an extension for the [Middleman](http://middlemanapp.com) static site generator that adds syntax highlighting via [Pygments](http://pygments.org/).
+middleman-syntax is an extension for the [Middleman](http://middlemanapp.com) static site generator that adds syntax highlighting via [Rouge](https://github.com/jayferd/rouge).
 
 # Install
 If you're just getting started, install the `middleman` gem and generate a new project:
@@ -17,7 +17,7 @@ Add `middleman-syntax` to your `Gemfile`, run `bundle install`, then open your `
 activate :syntax
 ```
 
-You can also pass options to pygments:
+You can also pass options to Rouge:
 
 ```
 activate :syntax,
@@ -26,9 +26,7 @@ activate :syntax,
          :linenostart => 2
 ```
 
-See the [pygments documentation](http://pygments.org/docs/formatters/) for a full list of possible options.
-
-# Usage
+# Helper
 
 The extension adds a new `code` helper to Middleman that you can use from your templates:
 
@@ -40,18 +38,34 @@ end
 <% end %>
 ```
 
-That'll produce syntax-highlighted HTML wrapped in a `<pre>` tag, wrapped in `<div class="hightlight">`. You can style this with any CSS that works on Pygments output. 
+That'll produce syntax-highlighted HTML wrapped in `<pre class="highlight ruby">`.
+
+# CSS
+
+On a default (i.e. unstyled) Middleman project, it will appear as if `middleman-syntax` isn't working, since obviously no CSS has been applied to color your code. You can use any Pygments-compatible stylesheet to style your code.
 
-**Note** that on a default (i.e. unstyled) Middleman project, it will appear as if `middleman-syntax` isn't working, since none of the Pygments styles have any CSS applied! Open the browser Developer Tools to verify the code is being syntax highlighted.
+You can also let Rouge generate some CSS for you by creating a new stylesheet with a `.css.erb` extension in your Middleman project, and then including:
 
-The extension also makes code blocks in Markdown highlight code. Make sure you're using RedCarpet as your Markdown engine (in `config.rb`):
+```erb
+<%= Rouge::Themes::ThankfulEyes.render(:scope => '.highlight') %>
+```
+
+Rouge has `ThankfulEyes`, `Colorful`, `Base16`, `Solarized` (like Octopress), and `Monokai` themes.
+
+# Markdown
+
+The extension also makes code blocks in Markdown produce highlighted code. Make sure you're using RedCarpet or Kramdown as your Markdown engine (in `config.rb`):
 
 ```ruby
 set :markdown_engine, :redcarpet
 set :markdown, :fenced_code_blocks => true, :smartypants => true
+
+# OR
+
+set :markdown_engine, :kramdown
 ```
 
-Now your Markdown will work just like it does [on GitHub](http://github.github.com/github-flavored-markdown/) - you can write something like this:
+Now your Markdown will work just like it does [on GitHub](http://github.github.com/github-flavored-markdown/) - you can write something like this with Redcarpet:
 
 <pre>
 ```ruby
@@ -61,6 +75,16 @@ end
 ```
 </pre>
 
+or with Kramdown:
+
+<pre>
+~~~ ruby
+def my_cool_method(message)
+  puts message
+end
+~~~
+</pre>
+
 # Bug Reports
 
 GitHub Issues are used for managing bug reports and feature requests. If you run into issues, please search the issues and submit new problems:

data/Rakefile

@@ -4,11 +4,8 @@ Bundler::GemHelper.install_tasks
 require 'cucumber/rake/task'
 
 Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
-  ENV["TEST"] = "true"
-
   exempt_tags = ""
   exempt_tags << "--tags ~@nojava" if RUBY_PLATFORM == "java"
-
   t.cucumber_opts = "--color --tags ~@wip #{exempt_tags} --strict --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}"
 end
 
@@ -19,4 +16,4 @@ task :test => ["cucumber"]
 desc "Build HTML documentation"
 task :doc do
   sh 'bundle exec yard'
-end
+end

data/features/helper.feature

@@ -0,0 +1,7 @@
+Feature: Syntax highlighting with the "code" helper method
+
+  Scenario: Works from ERb
+    Given the Server is running at "test-app"
+    When I go to "/code_html.html"
+    Then I should see '<span class="k">def</span>'
+    Then I should see '<pre class="highlight text">This is some code'

data/features/markdown.feature

@@ -0,0 +1,22 @@
+Feature: Code blocks in markdown get highlighted
+
+  Scenario: Works with Kramdown
+    Given the Server is running at "test-app"
+    When I go to "/code.html"
+    Then I should see '<span class="k">def</span>'
+    Then I should see '<pre class="highlight text">This is some code'
+
+  @nojava
+  Scenario: Works with RedCarpet
+    Given a fixture app "test-app"
+    And a file named "config.rb" with:
+      """
+      set :markdown_engine, :redcarpet
+      set :markdown, :fenced_code_blocks => true
+      activate :syntax
+      """
+    Given the Server is running at "test-app"
+    When I go to "/code.html"
+    Then I should see '<span class="k">def</span>'
+    Then I should see '<pre class="highlight text">This is some code'
+    

data/features/support/env.rb

@@ -0,0 +1,6 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+ENV['TEST'] = 'true'
+require "middleman-core"
+require "middleman-core/step_definitions"
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-syntax')
+

data/fixtures/test-app/config.rb

@@ -0,0 +1 @@
+activate :syntax

data/fixtures/test-app/source/code.html.markdown

@@ -0,0 +1,13 @@
+# Ruby
+
+~~~ruby
+def foo(bar)
+  puts "baz"
+end
+~~~
+
+# Whatever
+
+~~~
+This is some code
+~~~

data/fixtures/test-app/source/code_html.html.erb

@@ -0,0 +1,14 @@
+
+<h1>Ruby</h1>
+
+<% code('ruby') do %>
+def foo(bar)
+  puts "baz"
+end
+<% end %>
+
+<h1>Whatever</h1>
+
+<% code do %>
+This is some code
+<% end %>

data/lib/middleman-syntax/extension.rb

@@ -7,19 +7,46 @@ module Middleman
       end
 
       def registered(app, options_hash={})
-        require 'pygments'
+        require 'rouge'
 
         @@options = options_hash
         yield @@options if block_given?
 
         app.send :include, Helper
 
-        require 'middleman-core/renderers/redcarpet'
-        Middleman::Renderers::MiddlemanRedcarpetHTML.send :include, MarkdownCodeRenderer
+        if app.markdown_engine == :redcarpet
+          begin
+            require 'middleman-core/renderers/redcarpet'
+            Middleman::Renderers::MiddlemanRedcarpetHTML.send :include, MarkdownCodeRenderer
+          rescue LoadError
+          end
+        else
+          begin
+            require 'kramdown'
+            Kramdown::Converter::Html.class_eval do
+              def convert_codeblock(el, indent)
+                attr = el.attr.dup
+                language = extract_code_language!(attr)
+                Middleman::Syntax::Highlighter.highlight(el.value, language)
+              end
+            end
+          rescue LoadError
+          end
+        end
       end
       alias :included :registered
     end
 
+    module Highlighter
+      # A helper module for highlighting code
+      def self.highlight(code, language)
+        opts = ::Middleman::Syntax.options.dup
+        lexer = Rouge::Lexer.find_fancy(language, code) || Rouge::Lexers::Text
+        formatter = Rouge::Formatters::HTML.new(opts.reverse_merge({ :css_class => "highlight #{lexer.tag}" }))
+        formatter.format(lexer.lex(code, opts))
+      end
+    end
+
     module Helper
 
       # Output highlighted code. Use like:
@@ -51,16 +78,13 @@ module Middleman
           @_out_buf = _buf_was
         end
 
-        options = ::Middleman::Syntax.options.merge :lexer => language
-        concat_content Pygments.highlight(code, :options => options)
+        concat_content Middleman::Syntax::Highlighter.highlight(content, language)
       end
     end
 
     module MarkdownCodeRenderer
       def block_code(code, language)
-        options = ::Middleman::Syntax.options
-        options.merge! :lexer => language if language
-        Pygments.highlight(code, :options => options)
+        Middleman::Syntax::Highlighter.highlight(code, language)
       end
     end
   end

data/lib/middleman-syntax/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Syntax
-    VERSION = "1.1.1"
+    VERSION = "1.2.0"
   end
 end

data/middleman-syntax.gemspec

@@ -16,5 +16,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency("middleman-core", "~> 3.0")
-  s.add_runtime_dependency("pygments.rb", "~> 0.3")
+  s.add_runtime_dependency("rouge", "~> 0.3.0")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-syntax
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Ben Hollis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-27 00:00:00.000000000 Z
+date: 2013-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: pygments.rb
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.3.0
 description: Syntax-highlighting helpers for Middleman
 email:
 - ben@benhollis.net
@@ -51,6 +51,12 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- features/helper.feature
+- features/markdown.feature
+- features/support/env.rb
+- fixtures/test-app/config.rb
+- fixtures/test-app/source/code.html.markdown
+- fixtures/test-app/source/code_html.html.erb
 - lib/middleman-syntax.rb
 - lib/middleman-syntax/extension.rb
 - lib/middleman-syntax/helper.rb
@@ -76,9 +82,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Syntax-highlighting helpers for Middleman
-test_files: []
+test_files:
+- features/helper.feature
+- features/markdown.feature
+- features/support/env.rb
+- fixtures/test-app/config.rb
+- fixtures/test-app/source/code.html.markdown
+- fixtures/test-app/source/code_html.html.erb
 has_rdoc: