middleman-syntax 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aaea147a35d96f79a1262dedd8cedf4f23e922b5
-  data.tar.gz: 3fa14ae2cfc06539e836fb4811b399fef247bfbc
+  metadata.gz: c40d443bb7ade438430edef6ea27fef606d2056b
+  data.tar.gz: 9c07e674417d80c403b3e6cfbf0ce0a15211f25a
 SHA512:
-  metadata.gz: 6077c385b77b2c272b4be65f0b5038101bdc89bf2360ec0c26b8f9ec084062ca783a6eb33f77a53b2d9e4181b18b0179a48940650a6c25bf97665d3b1256df19
-  data.tar.gz: bf1524cd553efb103bb8b2f7b9c51f0637c671f72629b82834eb47f30b7c41cd7a59619c433b1a634b66c7ac600c38529207dfefc9627dd2cf50b0cbea9e85f6
+  metadata.gz: 27794aa28183988c42ea1074e305caaaa57cf756f50828682713d115fb0c9b93873107502a7adef19feb003e75fba2ab2aff6178e5d8c0f246c3d80c316e829f
+  data.tar.gz: b0e820698e90a582dcd0a0c12a8afd09e6150e267895cc9e6bb60a47d6d69611710092e3ecef07e133ed04a750f26084aca6e19b08557807f7eadb46079a41a6

data/.travis.yml

@@ -1,14 +1,16 @@
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - jruby-19mode
-
-# Bug in jRuby w/ Rouge: https://github.com/jruby/jruby/issues/1392
+  - ruby-head
+  - 2.2.2
+  - 2.1
+  - 2.0
+os:
+  - linux
+  # - osx
 matrix:
+  fast_finish: true
   allow_failures:
-    - rvm: jruby-19mode
-
+    - rvm: ruby-head
 script: "bundle exec rake test"
 
-env: TEST=true
+env: TEST=true
+sudo: false

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-2.0.0 (master)
+2.1.0
+-----
+
+* Version compatibility with Middleman 4. #58
+* Allow passing Rouge formatter options from the `code` helper. #50.
+* Fixed tests and code reorganization.
+
+2.0.0
 -----
 
 * Update to a new-style Middleman extension, dropping compatibility with Middleman versions older than 3.2.x.

data/Gemfile

@@ -1,25 +1,23 @@
 source "https://rubygems.org"
 
-gem "middleman", :github => "middleman/middleman", :branch => 'v3-stable'
+gem "middleman-core", :github => "middleman/middleman", :branch => 'v3-stable'
 
 # Specify your gem's dependencies in middleman-syntax.gemspec
 gemspec
 
-gem "rake",     "~> 10.0.3", :require => false
-gem "yard",     "~> 0.8.0", :require => false
+# Build and doc tools
+gem 'rake', '~> 10.3', require: false
+gem 'yard', '~> 0.8', require: false
 
 # Test tools
-gem "cucumber", "~> 1.3.1"
-gem "fivemat"
-gem "aruba",    "~> 0.5.1"
-gem "rspec",    "~> 2.12"
+gem 'pry', '~> 0.10', group: :development
+gem 'aruba', '~> 0.10.0'
+gem 'rspec', '~> 3.0'
+gem 'cucumber', '~> 2.0'
 
 platforms :ruby do
   gem "redcarpet"
 end
 
-gem "kramdown"
-gem "slim"
-
 # Code Quality
 gem "cane", :platforms => [:mri_19, :mri_20], :require => false

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2013 Benjamin Hollis
+Copyright (c) 2012-2014 Benjamin Hollis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -36,7 +36,11 @@ The full set of options can be seen on your preview server's `/__middleman/confi
 
 ## Helper
 
-The extension adds a new `code` helper to Middleman that you can use from your templates:
+The extension adds a new `code` helper to Middleman that you can use from your
+templates. It will  produce syntax-highlighted HTML wrapped in `<pre
+class="highlight language-name"><code>...html...</code></pre>`.
+
+In Erb, use `<%` tags (not `<%=` tags):
 
 ```erb
 <% code("ruby") do %>
@@ -46,7 +50,39 @@ end
 <% end %>
 ```
 
-That'll produce syntax-highlighted HTML wrapped in `<pre class="highlight ruby">`.
+*Note:* In Haml, use `=`, not `-`:
+
+```haml
+= code('ruby') do
+  puts "hello"
+```
+
+For more on Haml syntax, see the "Haml" section below.
+
+In Slim:
+
+```slim
+= code('ruby') do
+  |
+    puts 'hello'
+```
+
+The `code` helper supports [Rouge](https://github.com/jayferd/rouge) instance formatter options. These override the defaults set in your `config.rb`. Example options include:
+
+* `line_numbers`
+* `start_line`
+* `css_class`
+* `wrap`
+
+To use these formatter options per code block, include them in a hash as the second argument. e.g.
+
+```erb
+<% code("ruby", :line_numbers => true, :start_line => 7) do %>
+def my_cool_method(message)
+  puts message
+end
+<% end %>
+```
 
 ## CSS
 
@@ -58,6 +94,8 @@ You can also let Rouge generate some CSS for you by creating a new stylesheet wi
 <%= Rouge::Themes::ThankfulEyes.render(:scope => '.highlight') %>
 ```
 
+To prevent the stylesheet from being recognized as a html page source when running `middleman build`, add an underscore at the beginning of the filename or add `ignore "/this/file/path.css.erb"` to config.rb.
+
 Rouge has `ThankfulEyes`, `Colorful`, `Github`, `Base16`, `Base16::Solarized` (like Octopress), `Base16::Monokai`, and `Monokai` themes.
 
 ## Markdown
@@ -151,7 +189,7 @@ The best way to get quick responses to your issues and swift fixes to your bugs
 
 ## License
 
-Copyright (c) 2012-2013 Benjamin Hollis. MIT Licensed, see [LICENSE] for details.
+Copyright (c) 2012-2014 Benjamin Hollis. MIT Licensed, see [LICENSE] for details.
 
 [middleman]: http://middlemanapp.com
 [gem]: https://rubygems.org/gems/middleman-syntax

data/Rakefile

@@ -26,6 +26,8 @@ rescue LoadError
   # warn "cane not available, quality task not provided."
 end
 
+task :default => :test
+
 desc "Build HTML documentation"
 task :doc do
   sh 'bundle exec yard'

data/features/haml_filter.feature

@@ -10,4 +10,4 @@ Feature: Haml :code filter.
     Given the Server is running at "test-app"
     When I go to "/code_haml_filter.html"
     Then I should see '<span class="k">def</span>'
-    Then I should see '<pre class="highlight plaintext">This is some code'
+    Then I should see '<pre class="highlight plaintext"><code>This is some code'

data/features/helper.feature

@@ -4,16 +4,31 @@ Feature: Syntax highlighting with the "code" helper method
     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 plaintext">This is some code'
+    Then I should see '<pre class="highlight plaintext"><code>This is some code'
 
   Scenario: Works from Haml
     Given the Server is running at "test-app"
     When I go to "/code_haml.html"
     Then I should see '<span class="k">def</span>'
-    Then I should see '<pre class="highlight plaintext">This is some code'
+    Then I should see '<pre class="highlight plaintext"><code>This is some code'
 
   Scenario: Works from Slim
     Given the Server is running at "test-app"
     When I go to "/code_slim.html"
     Then I should see '<span class="k">def</span>'
-    Then I should see '<pre class="highlight plaintext">This is some code'
+    Then I should see '<pre class="highlight plaintext"><code>This is some code'
+
+  Scenario: options start_line works from erb
+    Given the Server is running at "test-app"
+    When I go to "/code_html.html"
+    Then I should see '<pre class="lineno">7'
+
+  Scenario: options start_line works from Haml
+    Given the Server is running at "test-app"
+    When I go to "/code_haml.html"
+    Then I should see '<pre class="lineno">7'
+
+  Scenario: options start_line works from Slim
+    Given the Server is running at "test-app"
+    When I go to "/code_slim.html"
+    Then I should see '<pre class="lineno">7'

data/features/markdown.feature

@@ -10,7 +10,7 @@ Feature: Code blocks in markdown get highlighted
     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 plaintext">This is some code'
+    Then I should see '<pre class="highlight plaintext"><code>This is some code'
 
   @nojava
   Scenario: Works with RedCarpet
@@ -24,5 +24,4 @@ Feature: Code blocks in markdown get highlighted
     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 plaintext">This is some code'
-    
+    Then I should see '<pre class="highlight plaintext"><code>This is some code'

data/fixtures/test-app/source/code_haml.html.haml

@@ -1,6 +1,6 @@
 %h1 Ruby
 
-- code('ruby') do
+= code('ruby') do
   :preserve
     def foo(bar)
       puts "baz"
@@ -8,5 +8,13 @@
 
 %h1 Whatever
 
-- code do
+= code do
   This is some code
+
+%h1 Options
+
+= code('ruby', {:line_numbers => true, :start_line => 7}) do
+  :preserve
+    def foo(bar)
+      puts "baz"
+    end

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

@@ -12,3 +12,11 @@ end
 <% code do %>
 This is some code
 <% end %>
+
+<h1>Options</h1>
+
+<% code('ruby', {:line_numbers => true, :start_line => 7}) do %>
+def foo(bar)
+  puts "baz"
+end
+<% end %>

data/fixtures/test-app/source/code_slim.html.slim

@@ -1,6 +1,6 @@
 h1 Ruby
 
-- code('ruby') do
+= code('ruby') do
   |
     def foo(bar)
       puts "baz"
@@ -8,6 +8,14 @@ h1 Ruby
 
 h1 Whatever
 
-- code
+= code
   |
     This is some code
+
+h1 Options
+
+= code('ruby', {:line_numbers => true, :start_line => 7}) do
+  |
+    def foo(bar)
+      puts "baz"
+    end

data/lib/middleman-syntax/extension.rb

@@ -1,10 +1,14 @@
 require 'rouge'
+require 'middleman-syntax/highlighter'
+require 'middleman-syntax/redcarpet_code_renderer'
+require 'middleman-syntax/haml_monkey_patch'
 
 module Middleman
   module Syntax
     class SyntaxExtension < Extension
       option :css_class, 'highlight', 'Class name applied to the syntax-highlighted output.'
       option :line_numbers, false, 'Generate line numbers.'
+      option :start_line, 1, 'Start the line numbering (if enabled) at the desired integer'
       option :inline_theme, nil, 'A Rouge::CSSTheme that will be used to highlight the output with inline styles instead of using CSS classes.'
       option :wrap, true, 'Wrap the highlighted content in a container (<pre> or <div>, depending on whether :line_numbers is on).'
       option :lexer_options, {}, 'Options for the Rouge lexers.'
@@ -30,18 +34,19 @@ module Middleman
       helpers do
         # Output highlighted code. Use like:
         #
-        #    <% code('ruby') do %>
+        #    <% code('ruby', :line_numbers => true, :start_line => 7) do %>
         #      my code
         #    <% end %>
         #
         # To produce the following structure:
         #
-        #    <div class="highlight">
-        #      <pre>#{your code}
-        #      </pre>
-        #    </div>
+        #    <pre class="highlight ruby">
+        #      <code>#{your code}</code>
+        #    </pre>
         #
-        # @param [String] language the Rouge lexer to use
+        # If no language is provided, then the language name is `plaintext`.
+        #
+        # @param [String] language that the Rouge lexer should use
         # @param [Hash] Options to pass to the Rouge formatter & lexer, overriding global options set by :highlighter_options.
         def code(language=nil, options={}, &block)
           raise 'The code helper requires a block to be provided.' unless block_given?
@@ -57,55 +62,7 @@ module Middleman
           end
           content = content.encode(Encoding::UTF_8)
 
-          concat_content Middleman::Syntax::Highlighter.highlight(content, language).html_safe
-        end
-      end
-    end
-
-    # A mixin for the Redcarpet Markdown renderer that will highlight
-    # code.
-    module RedcarpetCodeRenderer
-      def block_code(code, language)
-        Middleman::Syntax::Highlighter.highlight(code, language)
-      end
-    end
-
-    module Highlighter
-      mattr_accessor :options
-
-      # A helper module for highlighting code
-      def self.highlight(code, language=nil, opts={})
-        lexer = Rouge::Lexer.find_fancy(language, code) || Rouge::Lexers::PlainText
-
-        highlighter_options = options.to_h.merge(opts)
-        highlighter_options[:css_class] = [ highlighter_options[:css_class], lexer.tag ].join(' ')
-        lexer_options = highlighter_options.delete(:lexer_options)
-
-        formatter = Rouge::Formatters::HTML.new(highlighter_options)
-        formatter.format(lexer.lex(code, options.lexer_options))
-      end
-    end
-  end
-end
-
-# If Haml is around, define a :code filter that can be used to more conveniently output highlighted code.
-if defined? Haml
-  module Haml
-    module Filters
-      module Code
-        include Base
-
-        def render(code)
-          code = code.encode(Encoding::UTF_8)
-
-          # Allow language to be specified via a special comment like:
-          #  # lang: ruby
-          if code.lines.first =~ /\A\s*#\s*lang:\s*(\w+)$/
-            language = $1
-            code = code.lines.to_a[1..-1].join # Strip first line
-          end
-
-          Middleman::Syntax::Highlighter.highlight(code, language)
+          concat_content Middleman::Syntax::Highlighter.highlight(content, language, options).html_safe
         end
       end
     end

data/lib/middleman-syntax/haml_monkey_patch.rb

@@ -0,0 +1,23 @@
+# If Haml is around, define a :code filter that can be used to more conveniently output highlighted code.
+if defined? Haml
+  module Haml
+    module Filters
+      module Code
+        include Base
+
+        def render(code)
+          code = code.encode(Encoding::UTF_8)
+
+          # Allow language to be specified via a special comment like:
+          #  # lang: ruby
+          if code.lines.first =~ /\A\s*#\s*lang:\s*(\w+)$/
+              language = $1
+            code = code.lines.to_a[1..-1].join # Strip first line
+          end
+
+          Middleman::Syntax::Highlighter.highlight(code, language)
+        end
+      end
+    end
+  end
+end

data/lib/middleman-syntax/highlighter.rb

@@ -0,0 +1,19 @@
+module Middleman
+  module Syntax
+    module Highlighter
+      mattr_accessor :options
+
+      # A helper module for highlighting code
+      def self.highlight(code, language=nil, opts={})
+        lexer = Rouge::Lexer.find_fancy(language, code) || Rouge::Lexers::PlainText
+
+        highlighter_options = options.to_h.merge(opts)
+        highlighter_options[:css_class] = [ highlighter_options[:css_class], lexer.tag ].join(' ')
+        lexer_options = highlighter_options.delete(:lexer_options)
+
+        formatter = Rouge::Formatters::HTML.new(highlighter_options)
+        formatter.format(lexer.lex(code, options.lexer_options))
+      end
+    end
+  end
+end

data/lib/middleman-syntax/redcarpet_code_renderer.rb

@@ -0,0 +1,11 @@
+module Middleman
+  module Syntax
+    # A mixin for the Redcarpet Markdown renderer that will highlight
+    # code.
+    module RedcarpetCodeRenderer
+      def block_code(code, language)
+        Middleman::Syntax::Highlighter.highlight(code, language)
+      end
+    end
+  end
+end

data/lib/middleman-syntax/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Syntax
-    VERSION = "2.0.0"
+    VERSION = "2.1.0"
   end
 end

data/middleman-syntax.gemspec

@@ -15,6 +15,12 @@ Gem::Specification.new do |s|
   s.files = `git ls-files -z`.split("\0")
   s.test_files = `git ls-files -z -- {fixtures,features}/*`.split("\0")
   s.require_paths = ["lib"]
-  s.add_runtime_dependency("middleman-core", ["~> 3.2"])
+  s.add_runtime_dependency("middleman-core", [">= 3.2"])
   s.add_runtime_dependency("rouge", ["~> 1.0"])
+  s.add_development_dependency("aruba", "~> 0.5.1")
+  s.add_development_dependency("cucumber", "~> 1.3.1")
+  s.add_development_dependency("fivemat")
+  s.add_development_dependency("haml")
+  s.add_development_dependency("kramdown")
+  s.add_development_dependency("slim")
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: middleman-syntax
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Ben Hollis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-11 00:00:00.000000000 Z
+date: 2015-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
@@ -38,6 +38,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: fivemat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Code syntax highlighting plugin via rouge for Middleman
 email:
 - ben@benhollis.net
@@ -65,7 +149,10 @@ files:
 - fixtures/test-app/source/code_slim.html.slim
 - lib/middleman-syntax.rb
 - lib/middleman-syntax/extension.rb
+- lib/middleman-syntax/haml_monkey_patch.rb
+- lib/middleman-syntax/highlighter.rb
 - lib/middleman-syntax/middleman_extension.rb
+- lib/middleman-syntax/redcarpet_code_renderer.rb
 - lib/middleman-syntax/version.rb
 - middleman-syntax.gemspec
 homepage: https://github.com/middleman/middleman-syntax
@@ -88,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.rc.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Code syntax highlighting plugin via rouge for Middleman