middleman-syntax 2.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c40d443bb7ade438430edef6ea27fef606d2056b
-  data.tar.gz: 9c07e674417d80c403b3e6cfbf0ce0a15211f25a
+SHA256:
+  metadata.gz: '069a5916deb149f37860dd78cd181278367e1ae343d4053e619d902e2fb3f87e'
+  data.tar.gz: 3e3e12eef81c32dfc9d683f8925e65d1fc22ed714b869880a8719acaf1c8e50a
 SHA512:
-  metadata.gz: 27794aa28183988c42ea1074e305caaaa57cf756f50828682713d115fb0c9b93873107502a7adef19feb003e75fba2ab2aff6178e5d8c0f246c3d80c316e829f
-  data.tar.gz: b0e820698e90a582dcd0a0c12a8afd09e6150e267895cc9e6bb60a47d6d69611710092e3ecef07e133ed04a750f26084aca6e19b08557807f7eadb46079a41a6
+  metadata.gz: 98e67a62f908fa76c4588dbd32b39f1374831a944efd604794ee157a9693c45c87b657bcb7497d36c1d162fbd7928fd0e94549c3350b018685419554335222ce
+  data.tar.gz: 1e1c3c2dcf955bbe33b8ca8ffbacb77fcd96896123927971bba2fe3bdeb78a762bdaf53d5aae7ac799a1f5a7e19ea1c064438a3e15b3630d1390470133ce8f44

data/.devcontainer/Dockerfile

@@ -0,0 +1,19 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.241.1/containers/ruby/.devcontainer/base.Dockerfile
+
+# [Choice] Ruby version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.1, 3.0, 2, 2.7, 3-bullseye, 3.1-bullseye, 3.0-bullseye, 2-bullseye, 2.7-bullseye, 3-buster, 3.1-buster, 3.0-buster, 2-buster, 2.7-buster
+ARG VARIANT="3.1-bullseye"
+FROM mcr.microsoft.com/vscode/devcontainers/ruby:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+# RUN gem install <your-gem-names-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/devcontainer.json

@@ -0,0 +1,37 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.241.1/containers/ruby
+{
+	"name": "Ruby",
+	"build": {
+		"dockerfile": "Dockerfile",
+		"args": { 
+			// Update 'VARIANT' to pick a Ruby version: 3, 3.1, 3.0, 2, 2.7
+			// Append -bullseye or -buster to pin to an OS version.
+			// Use -bullseye variants on local on arm64/Apple Silicon.
+			"VARIANT": "2.7",
+			// Options
+			"NODE_VERSION": "lts/*"
+		}
+	},
+
+	// Configure tool-specific properties.
+	"customizations": {
+		// Configure properties specific to VS Code.
+		"vscode": {
+			// Add the IDs of extensions you want installed when the container is created.
+			"extensions": [
+				"rebornix.Ruby"
+			]
+		}
+	},
+	
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+
+}

data/.travis.yml

@@ -1,11 +1,9 @@
 rvm:
   - ruby-head
-  - 2.2.2
-  - 2.1
-  - 2.0
+  - 2.6.3
+  - 2.5.5
 os:
   - linux
-  # - osx
 matrix:
   fast_finish: true
   allow_failures:

data/CHANGELOG.md

@@ -1,49 +1,53 @@
-2.1.0
------
+- Fixed HAML :code filter to remove trailing blank lines
 
-* Version compatibility with Middleman 4. #58
-* Allow passing Rouge formatter options from the `code` helper. #50.
-* Fixed tests and code reorganization.
+# 3.2.0
 
-2.0.0
------
+- Prep for Middleman v5
 
-* Update to a new-style Middleman extension, dropping compatibility with Middleman versions older than 3.2.x.
-* Setting the :css_class option will no longer prevent the language tag from being added as a class as well.
-* Rouge lexer options should now be set via the :lexer_options option.
-* It is now possible to override options when calling the `code` helper by passing them as the second argument.
-* Using the `code` helper from Slim templates no longer escapes the output.
-* Added a `:code` filter for Haml as a more whitespace-friendly alternative to the `code` helper.
+# 3.0.0
 
-1.2.1
------
+- 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.
 
-* Restore compatibility with Middleman 3.0.x series.
+# 2.1.0
 
-1.2.0
------
+- Version compatibility with Middleman 4. #58
+- Allow passing Rouge formatter options from the `code` helper. #50.
+- Fixed tests and code reorganization.
 
-* Support Kramdown as Markdown engine in addition to Redcarpet.
-* Switch to Rouge from Pygments.rb
-* Fix bugs around setting language options.
+# 2.0.0
 
-1.1.1
------
+- Update to a new-style Middleman extension, dropping compatibility with Middleman versions older than 3.2.x.
+- Setting the :css_class option will no longer prevent the language tag from being added as a class as well.
+- Rouge lexer options should now be set via the :lexer_options option.
+- It is now possible to override options when calling the `code` helper by passing them as the second argument.
+- Using the `code` helper from Slim templates no longer escapes the output.
+- Added a `:code` filter for Haml as a more whitespace-friendly alternative to the `code` helper.
 
-* Properly merge language attribute for Markdown. #14
+# 1.2.1
 
-1.1.0
------
+- Restore compatibility with Middleman 3.0.x series.
 
-* Avoid errors when language is empty. #9
-* Allow passing options to Pygments. #5 & #7
+# 1.2.0
 
-1.0.1
------
+- Support Kramdown as Markdown engine in addition to Redcarpet.
+- Switch to Rouge from Pygments.rb
+- Fix bugs around setting language options.
 
-* Updated pygments.rb dependency.
+# 1.1.1
 
-1.0.0
------
+- Properly merge language attribute for Markdown. #14
 
-* Initial release, basic syntax highlighting.
+# 1.1.0
+
+- Avoid errors when language is empty. #9
+- Allow passing options to Pygments. #5 & #7
+
+# 1.0.1
+
+- Updated pygments.rb dependency.
+
+# 1.0.0
+
+- Initial release, basic syntax highlighting.

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-gem "middleman-core", :github => "middleman/middleman", :branch => 'v3-stable'
+gem "middleman-core", :git => "https://github.com/middleman/middleman.git", :branch => '4.x'
 
 # Specify your gem's dependencies in middleman-syntax.gemspec
 gemspec
@@ -14,6 +14,7 @@ gem 'pry', '~> 0.10', group: :development
 gem 'aruba', '~> 0.10.0'
 gem 'rspec', '~> 3.0'
 gem 'cucumber', '~> 2.0'
+gem 'capybara', '~> 2.5.0'
 
 platforms :ruby do
   gem "redcarpet"
@@ -21,3 +22,6 @@ end
 
 # Code Quality
 gem "cane", :platforms => [:mri_19, :mri_20], :require => false
+
+# For old rubies
+gem 'nokogiri', ['~> 1.5', '< 1.7']

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
 
@@ -88,19 +88,19 @@ end
 
 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.
 
-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:
+You can also let Rouge generate some CSS for you by creating a new stylesheet with a `.css.erb` extension in your Middleman project (at a path like `source/stylesheets/highlighting.css.erb` with the contents:
 
 ```erb
 <%= 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.
+If you want to include this in a larger Sass stylesheet, name it with an underscore (`source/stylesheets/_highlighting.css.erb`) and include it in your main stylesheet with `@import 'highlighting'`).
 
 Rouge has `ThankfulEyes`, `Colorful`, `Github`, `Base16`, `Base16::Solarized` (like Octopress), `Base16::Monokai`, 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`):
+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
@@ -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 Redcarpet.
+
+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/haml_filter.feature

@@ -11,3 +11,15 @@ Feature: Haml :code filter.
     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"><code>This is some code'
+
+  Scenario: Filter doesn't keep trailing blank lines
+    Given a fixture app "test-app"
+    And a file named "config.rb" with:
+      """
+      set :haml, { :ugly => false }
+      activate :syntax
+      """
+    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"><code>This is some code</code></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,12 +2,14 @@ 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
     class SyntaxExtension < Extension
       option :css_class, 'highlight', 'Class name applied to the syntax-highlighted output.'
       option :line_numbers, false, 'Generate line numbers.'
+      option :line_numbers_div, false, 'Generate line numbers with wrapping divs.'
       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).'
@@ -15,7 +17,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,29 @@
+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]
+        
+          @formatter = Rouge::Formatters::HTMLLinewise.new(@formatter, class:'line-%i') if opts[:line_numbers_div]
+
+          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/haml_monkey_patch.rb

@@ -6,6 +6,7 @@ if defined? Haml
         include Base
 
         def render(code)
+          code = code.rstrip
           code = code.encode(Encoding::UTF_8)
 
           # Allow language to be specified via a special comment like:

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,20 @@
+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
+          if attribute == "line_numbers_div" and value == "false"
+            return { line_numbers_div: 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.3.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", ["~> 3.2"])
   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.3.0
 platform: ruby
 authors:
 - Ben Hollis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-19 00:00:00.000000000 Z
+date: 2022-08-06 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: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +129,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -140,17 +142,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
@@ -174,20 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Code syntax highlighting plugin via rouge for Middleman
-test_files:
-- features/haml_filter.feature
-- 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_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
-has_rdoc: 
+test_files: []