middleman-syntax 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c40d443bb7ade438430edef6ea27fef606d2056b
-  data.tar.gz: 9c07e674417d80c403b3e6cfbf0ce0a15211f25a
+  metadata.gz: f4eb136031946fc9e1302df15f1158482e797ec3
+  data.tar.gz: 2b2e3b0abf60b2390a39dfa9c133b0fc780c0861
 SHA512:
-  metadata.gz: 27794aa28183988c42ea1074e305caaaa57cf756f50828682713d115fb0c9b93873107502a7adef19feb003e75fba2ab2aff6178e5d8c0f246c3d80c316e829f
-  data.tar.gz: b0e820698e90a582dcd0a0c12a8afd09e6150e267895cc9e6bb60a47d6d69611710092e3ecef07e133ed04a750f26084aca6e19b08557807f7eadb46079a41a6
+  metadata.gz: dd0bb555b69b28ec3e6dcf97e47c4ce932fde862513c06aa24f34d180b30f4e9271695179de0c0ca8fdc83477ece51a373a46dc008af080f79208f43bf5c0fba
+  data.tar.gz: 7a6f2f02432c48e1c0a89dbe0e45c26c4ce5bd848da62404ebada8b33b85489ba5b657793b76e9601fcaf73936ab879ce8f1532b96134be6efb24dda6daedcb3

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+3.0.0
+-----
+
+* Upgrade to Rouge 2.0. #66.
+* Added the ability to disable the line numbers on a specific code block when using Markdown and Redcarpet. #63.
+* Lexer options are properly passed down to the highlighter.
+
 2.1.0
 -----
 

data/README.md

@@ -2,10 +2,10 @@
 
 `middleman-syntax` is an extension for the [Middleman] static site generator that adds syntax highlighting via [Rouge](https://github.com/jayferd/rouge).
 
-[![Gem Version](https://badge.fury.io/rb/middleman-syntax.png)][gem]
-[![Build Status](https://travis-ci.org/middleman/middleman-syntax.png)][travis]
-[![Dependency Status](https://gemnasium.com/middleman/middleman-syntax.png?travis)][gemnasium]
-[![Code Quality](https://codeclimate.com/github/middleman/middleman-syntax.png)][codeclimate]
+[![Gem Version](https://badge.fury.io/rb/middleman-syntax.svg)][gem]
+[![Build Status](https://travis-ci.org/middleman/middleman-syntax.svg)][travis]
+[![Dependency Status](https://gemnasium.com/middleman/middleman-syntax.svg?travis)][gemnasium]
+[![Code Quality](https://codeclimate.com/github/middleman/middleman-syntax.svg)][codeclimate]
 
 ## Installation
 
@@ -121,6 +121,18 @@ end
 ```
 </pre>
 
+You can also disable the line numbers on a specific code block. However, this is Middleman-syntax specific feature, which only works when using Redcarpert.
+
+Disabling the line numbers on a code block:
+
+<pre>
+```ruby?line_numbers=false
+def my_cool_method(message)
+  puts message
+end
+```
+</pre>
+
 or with Kramdown:
 
 <pre>

data/features/markdown_line_numbers_disabled.feature

@@ -0,0 +1,13 @@
+Feature: Code blocks with line numbers in markdown
+  @nojava
+  Scenario: Disabled line numbers 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, :line_numbers => true
+      """
+    Given the Server is running at "test-app"
+    When I go to "/code_with_disabled_line_numbers.html"
+    Then I should not see line numbers markup

data/features/markdown_line_numbers_enabled.feature

@@ -0,0 +1,13 @@
+Feature: Code blocks with line numbers in markdown
+  @nojava
+  Scenario: Line numbers enabled 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, :line_numbers => true
+      """
+    Given the Server is running at "test-app"
+    When I go to "/code_with_enabled_line_numbers.html"
+    Then I should see '<pre class="lineno">'

data/features/support/step_definitions.rb

@@ -0,0 +1,4 @@
+# step definition for testing line number markup
+Then(/^I should not see line numbers markup$/) do
+  expect(page).not_to have_selector("pre.lineno")
+end

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

@@ -0,0 +1,7 @@
+# Ruby with no line numbers
+
+~~~ruby?line_numbers=false
+def foo(bar)
+  puts "baz"
+end
+~~~

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

@@ -0,0 +1,25 @@
+# Ruby with line numbers
+
+~~~ruby?line_numbers=
+def foo(bar)
+  puts "baz"
+end
+~~~
+
+~~~ruby?line_numbers
+def foo(bar)
+  puts "baz"
+end
+~~~
+
+~~~ruby?line_numbers=flase
+def foo(bar)
+  puts "baz"
+end
+~~~
+
+# Whatever
+
+~~~
+This is some code
+~~~

data/lib/middleman-syntax/extension.rb

@@ -2,6 +2,7 @@ require 'rouge'
 require 'middleman-syntax/highlighter'
 require 'middleman-syntax/redcarpet_code_renderer'
 require 'middleman-syntax/haml_monkey_patch'
+require 'middleman-syntax/language_parameter_parser.rb'
 
 module Middleman
   module Syntax
@@ -15,7 +16,6 @@ module Middleman
 
       def after_configuration
         Middleman::Syntax::Highlighter.options = options
-
         if app.config[:markdown_engine] == :redcarpet
           require 'middleman-core/renderers/redcarpet'
           Middleman::Renderers::MiddlemanRedcarpetHTML.send :include, RedcarpetCodeRenderer

data/lib/middleman-syntax/formatters.rb

@@ -0,0 +1,27 @@
+module Middleman
+  module Syntax
+    module Formatters
+      class HTML < Rouge::Formatter
+        tag 'html'
+
+        def initialize(opts={})
+          @formatter = if opts[:inline_theme]
+                         Rouge::Formatters::HTMLInline.new(opts[:inline_theme])
+                       else
+                         Rouge::Formatters::HTML.new
+                       end
+
+          @formatter = Rouge::Formatters::HTMLTable.new(@formatter, opts) if opts[:line_numbers]
+
+          if opts.fetch(:wrap, true)
+            @formatter = Rouge::Formatters::HTMLPygments.new(@formatter, opts.fetch(:css_class, 'codehilite'))
+          end
+        end
+
+        def stream(tokens, &block)
+          @formatter.stream(tokens, &block)
+        end
+      end
+    end
+  end
+end

data/lib/middleman-syntax/highlighter.rb

@@ -1,3 +1,5 @@
+require 'middleman-syntax/formatters'
+
 module Middleman
   module Syntax
     module Highlighter
@@ -11,8 +13,8 @@ module Middleman
         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))
+        formatter = Middleman::Syntax::Formatters::HTML.new(highlighter_options)
+        formatter.format(lexer.lex(code, lexer_options))
       end
     end
   end

data/lib/middleman-syntax/language_parameter_parser.rb

@@ -0,0 +1,17 @@
+module Middleman
+  module Syntax
+    module LanguageParameterParser
+      def self.parse_parameter_from_language(language = "")
+        language, params = language.to_s.split("?", 2)
+        if params and params.to_s.include? "="
+          attribute, value = params.to_s.split("=")
+          # if there are more arguments, refactor this
+          if attribute == "line_numbers" and value == "false"
+            return { line_numbers: false }
+          end
+        end
+        {}
+      end
+    end
+  end
+end

data/lib/middleman-syntax/redcarpet_code_renderer.rb

@@ -1,10 +1,13 @@
+require 'middleman-syntax/language_parameter_parser.rb'
+
 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)
+        opts = Middleman::Syntax::LanguageParameterParser.parse_parameter_from_language(language)
+        Middleman::Syntax::Highlighter.highlight(code, language, opts)
       end
     end
   end

data/lib/middleman-syntax/version.rb

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

data/middleman-syntax.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   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("rouge", ["~> 1.0"])
+  s.add_runtime_dependency("rouge", ["~> 2.0"])
   s.add_development_dependency("aruba", "~> 0.5.1")
   s.add_development_dependency("cucumber", "~> 1.3.1")
   s.add_development_dependency("fivemat")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-syntax
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Ben Hollis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-19 00:00:00.000000000 Z
+date: 2016-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -140,17 +140,24 @@ files:
 - features/haml_filter.feature
 - features/helper.feature
 - features/markdown.feature
+- features/markdown_line_numbers_disabled.feature
+- features/markdown_line_numbers_enabled.feature
 - features/support/env.rb
+- features/support/step_definitions.rb
 - fixtures/test-app/config.rb
 - fixtures/test-app/source/code.html.markdown
 - fixtures/test-app/source/code_haml.html.haml
 - fixtures/test-app/source/code_haml_filter.html.haml
 - fixtures/test-app/source/code_html.html.erb
 - fixtures/test-app/source/code_slim.html.slim
+- fixtures/test-app/source/code_with_disabled_line_numbers.html.markdown
+- fixtures/test-app/source/code_with_enabled_line_numbers.html.markdown
 - lib/middleman-syntax.rb
 - lib/middleman-syntax/extension.rb
+- lib/middleman-syntax/formatters.rb
 - lib/middleman-syntax/haml_monkey_patch.rb
 - lib/middleman-syntax/highlighter.rb
+- lib/middleman-syntax/language_parameter_parser.rb
 - lib/middleman-syntax/middleman_extension.rb
 - lib/middleman-syntax/redcarpet_code_renderer.rb
 - lib/middleman-syntax/version.rb
@@ -183,11 +190,16 @@ test_files:
 - features/haml_filter.feature
 - features/helper.feature
 - features/markdown.feature
+- features/markdown_line_numbers_disabled.feature
+- features/markdown_line_numbers_enabled.feature
 - features/support/env.rb
+- features/support/step_definitions.rb
 - fixtures/test-app/config.rb
 - fixtures/test-app/source/code.html.markdown
 - fixtures/test-app/source/code_haml.html.haml
 - fixtures/test-app/source/code_haml_filter.html.haml
 - fixtures/test-app/source/code_html.html.erb
 - fixtures/test-app/source/code_slim.html.slim
+- fixtures/test-app/source/code_with_disabled_line_numbers.html.markdown
+- fixtures/test-app/source/code_with_enabled_line_numbers.html.markdown
 has_rdoc: