middleman-syntax 3.4.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e10bda9e80f47020802183bad3a3849929d927afd99d2da43f0bf67547213028
-  data.tar.gz: f930e8d69b461e426ae8e3ad63b3111d6b2607df9b66cee73fcd7f88e5d9fda8
+  metadata.gz: 30c25881bfd1e91ef4958299d4e09fe9848a4581fe3b22bdaf9aad0ae13e2723
+  data.tar.gz: 8ed74ea53b6e515c01be63330170110d809f87bf48715fe386245c939cac8998
 SHA512:
-  metadata.gz: b7d960fc8adae60a7f21b67ba7ebbfd7c103121ac000ff94361fee9fcdb64e2df6c8a57161f125103c296c4c242943d5b5593e7f9b29b621d2a0b2c223ecaa52
-  data.tar.gz: 141ea649e0a810ecfde705d7072290a85377bc2d73194fed063da2adb5bd03e85a74b09c35f87fb9fef7aab40f74e5af501ae1c581b3063ae8e0f8108a3b76af
+  metadata.gz: 390e71b77bb6d00ebbc57b2702ba4731aa00a0778cfa2caa121d80296aa50b978a6a191620f93bcecf5127104128618e65987754d179a65c79a4675013e35717
+  data.tar.gz: df4eb1fec24e35e553d92e346d0b2dad4f368064a4926e3cc0a4a0bcb102eec2a17acfc652ee3151c057db75b76cb410c8452cd159202e340e3e1b8157455acb

data/.github/workflows/ci.yml

@@ -1,6 +1,10 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
 
 jobs:
   test:
@@ -9,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ["3.3", "3.2", "3.1", "3.0", "2.7", "2.6", "2.5"]
+        ruby-version: ["3.4", "3.3", "3.2", "3.1", "3.0", "2.7"]
     steps:
       - uses: actions/checkout@v4
       - name: Set up Ruby

data/.gitignore

@@ -2,16 +2,14 @@
 coverage
 rdoc
 pkg
-.sass-cache
-.sassc
 .tmp
 Gemfile.lock
 docs
-.rbenv-*
 .*.swp
 build
 doc
 .yardoc
 tmp
 Makefile
-.mm-pid-*
+.bundle
+vendor/bundle

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file.
 
+# 3.6.0
+
+- Lexer options don't get passed to lexer (#92).
+
+# 3.5.0
+
+- Remove official support for Ruby 2.5 and 2.6 (#89).
+- Add ability to add other classes to the :syntax plugin (#90).
+
 # 3.4.0
 
 - Haml 6 support (#82, #84).

data/Gemfile

@@ -10,15 +10,12 @@ gem 'rake', '~> 13.1', require: false
 gem 'yard', '~> 0.9', require: false
 
 # Test tools
-gem 'pry', '~> 0.10', group: :development
-gem 'aruba', '~> 1.0.0'
-gem 'rspec', '~> 3.0'
-gem 'cucumber', '~> 2.0'
-gem 'capybara', '~> 2.5.0'
+gem 'aruba'
+gem 'cucumber'
+gem 'capybara'
+
+# Optional dependencies, included for tests
 gem 'haml', RUBY_VERSION > '3.0' ? '< 7' : '< 6'
-gem 'slim', '>= 3', '< 5'
+gem 'slim'
 gem 'kramdown'
-gem "redcarpet"
-
-# For old Rubies
-gem 'nokogiri', '~> 1.12.0'
+gem 'redcarpet'

data/README.md

@@ -1,10 +1,10 @@
 # Middleman-Syntax
 
-`middleman-syntax` is an extension for the [Middleman] static site generator that adds syntax highlighting via [Rouge](https://github.com/jayferd/rouge).
+`middleman-syntax` is an extension for the [Middleman](https://middlemanapp.com) static site generator that adds syntax highlighting via [Rouge](https://github.com/jayferd/rouge).
 
-[![Gem Version](https://badge.fury.io/rb/middleman-syntax.svg)][gem]
+[![Gem Version](https://badge.fury.io/rb/middleman-syntax.svg)](https://rubygems.org/gems/middleman-syntax)
 [![CI](https://github.com/middleman/middleman-syntax/actions/workflows/ci.yml/badge.svg)](https://github.com/middleman/middleman-syntax/actions/workflows/ci.yml)
-[![Code Quality](https://codeclimate.com/github/middleman/middleman-syntax.svg)][codeclimate]
+[![Maintainability](https://qlty.sh/gh/middleman/projects/middleman-syntax/maintainability.svg)](https://qlty.sh/gh/middleman/projects/middleman-syntax)
 
 ## Installation
 
@@ -29,6 +29,18 @@ You can also pass options to Rouge:
 activate :syntax, :line_numbers => true
 ```
 
+You can add extra css classes to the pre tag elements:
+
+```ruby
+activate :syntax, :extra_css_classes => ["custom-class", "another-class"]
+```
+
+This will add the extra css classes to the `<pre>` element in the generated HTML:
+
+```html
+<div class="highlight"><pre class="highlight language-name custom-class another-class"><code>...</code></pre></div>
+```
+
 The full set of options can be seen on your preview server's `/__middleman/config/` page.
 
 ## Helper
@@ -47,7 +59,7 @@ end
 <% end %>
 ```
 
-*Note:* In Haml, use `=`, not `-`:
+**NOTE:** In Haml, use `=`, not `-`:
 
 ```haml
 = code('ruby') do
@@ -70,6 +82,7 @@ The `code` helper supports [Rouge](https://github.com/jayferd/rouge) instance fo
 * `start_line`
 * `css_class`
 * `wrap`
+* `extra_css_classes`
 
 To use these formatter options per code block, include them in a hash as the second argument. e.g.
 
@@ -81,19 +94,41 @@ end
 <% end %>
 ```
 
+You can also add extra css   classes to specific code blocks:
+
+```erb
+<% code("ruby", :extra_css_classes => ["custom-class", "special"]) do %>
+def my_cool_method(message)
+  puts message
+end
+<% end %>
+```
+
+This will produce HTML like:
+
+```html
+<div class="highlight"><pre class="highlight ruby custom-class special"><code>...</code></pre></div>
+```
+
 ## 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.
 
-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:
+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') %>
 ```
 
-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'`).
+And then include it in your layout or specific page by:
 
-Rouge has `ThankfulEyes`, `Colorful`, `Github`, `Base16`, `Base16::Solarized` (like Octopress), `Base16::Monokai`, and `Monokai` themes.
+```erb
+<%= stylesheet_link_tag "highlighting" %>
+```
+
+If you want to include this in a larger Sass stylesheet, include it in your main stylesheet with `@import 'highlighting.css'`.
+
+Rouge has `ThankfulEyes`, `Colorful`, `Github`, `Base16`, `Base16::Solarized`, `Base16::Monokai`, and `Monokai` themes.
 
 ## Markdown
 
@@ -108,7 +143,7 @@ set :markdown, :fenced_code_blocks => true, :smartypants => true
 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 with Redcarpet:
+Now your Markdown will work just like it does [on GitHub](https://docs.github.com/en/get-started/writing-on-github) - you can write something like this with Redcarpet:
 
 <pre>
 ```ruby
@@ -198,9 +233,4 @@ The best way to get quick responses to your issues and swift fixes to your bugs
 
 ## License
 
-Copyright (c) 2012-2014 Benjamin Hollis. MIT Licensed, see [LICENSE] for details.
-
-[middleman]: http://middlemanapp.com
-[gem]: https://rubygems.org/gems/middleman-syntax
-[codeclimate]: https://codeclimate.com/github/middleman/middleman-syntax
-[LICENSE]: https://github.com/middleman/middleman-syntax/blob/master/LICENSE.md
+Copyright (c) 2012-2014 Benjamin Hollis. MIT Licensed, see [LICENSE](LICENSE.md) for details.

data/Rakefile

@@ -2,9 +2,9 @@ require 'bundler/gem_tasks'
 require 'cucumber/rake/task'
 
 Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
-  exempt_tags = ""
-  exempt_tags << "--tags ~@nojava " if RUBY_PLATFORM == "java"
-  t.cucumber_opts = "--color --tags ~@wip #{exempt_tags} --strict --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}"
+  exempt_tags = ["--tags 'not @wip'"]
+  exempt_tags << "--tags 'not @nojava'" if RUBY_PLATFORM == "java"
+  t.cucumber_opts = "--require features --color #{exempt_tags.join(' ')} --strict --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}"
 end
 
 task :test => ["cucumber"]

data/features/extra_css_classes.feature

@@ -0,0 +1,55 @@
+Feature: Extra css classes for the pre tag
+
+  Scenario: Extra css classes from configuration
+    Given a fixture app "test-app-extra-css-classes"
+    And a file named "config.rb" with:
+      """
+      activate :syntax, :extra_css_classes => ["custom-class", "another-class"]
+      """
+    And a file named "source/index.html.erb" with:
+      """
+      <% code("ruby") do %>
+      def my_method
+        puts "Hello"
+      end
+      <% end %>
+      """
+    And the Server is running
+    When I go to "/index.html"
+    Then I should see '<pre class="highlight ruby custom-class another-class"><code>'
+
+  Scenario: Extra css classes as a string
+    Given a fixture app "test-app-extra-css-classes"
+    And a file named "config.rb" with:
+      """
+      activate :syntax, :extra_css_classes => "custom-class another-class"
+      """
+    And a file named "source/index.html.erb" with:
+      """
+      <% code("ruby") do %>
+      def my_method
+        puts "Hello"
+      end
+      <% end %>
+      """
+    And the Server is running
+    When I go to "/index.html"
+    Then I should see '<pre class="highlight ruby custom-class another-class"><code>'
+
+  Scenario: Extra css classes via helper options
+    Given a fixture app "test-app-extra-css-classes"
+    And a file named "config.rb" with:
+      """
+      activate :syntax
+      """
+    And a file named "source/index.html.erb" with:
+      """
+      <% code("ruby", :extra_css_classes => ["helper-class", "another-helper-class"]) do %>
+      def my_method
+        puts "Hello"
+      end
+      <% end %>
+      """
+    And the Server is running
+    When I go to "/index.html"
+    Then I should see '<pre class="highlight ruby helper-class another-helper-class"><code>' 

data/features/lexer_options.feature

@@ -0,0 +1,19 @@
+Feature: Lexer options configuration
+
+  Scenario: Lexer options are passed to Rouge lexer
+    Given a fixture app "test-app"
+    And a file named "config.rb" with:
+      """
+      activate :syntax, :lexer_options => { :prompt => 'myshell>>>' }
+      """
+    And a file named "source/console_code.html.erb" with:
+      """
+      <% code("console") do %>
+      myshell>>> echo "hello world"
+      myshell>>> echo "test"
+      <% end %>
+      """
+    And the Server is running
+    When I go to "/console_code.html"
+    Then I should see '<span class="gp">myshell&gt;&gt;&gt;</span>'
+    And I should not see '<span class="o">&gt;&gt;</span>'

data/features/support/env.rb

@@ -3,4 +3,3 @@ ENV['TEST'] = 'true'
 require "middleman-core"
 require "middleman-core/step_definitions"
 require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-syntax')
-

data/features/support/step_definitions.rb

@@ -2,3 +2,13 @@
 Then(/^I should not see line numbers markup$/) do
   expect(page).not_to have_selector("pre.lineno")
 end
+
+# step definition for testing that specific content is not present
+Then(/^I should not see "([^"]*)"$/) do |content|
+  expect(page.body).not_to include(content)
+end
+
+# step definition for testing that specific content is not present (new format)
+Then('I should not see {string}') do |content|
+  expect(page.body).not_to include(content)
+end

data/fixtures/test-app-extra-css-classes/config.rb

@@ -0,0 +1 @@
+activate :syntax, :extra_css_classes => ["custom-class", "another-class"] 

data/fixtures/test-app-extra-css-classes/source/index.html.erb

@@ -0,0 +1,5 @@
+<% code("ruby") do %>
+def my_method
+  puts "Hello"
+end
+<% end %> 

data/lib/middleman-syntax/extension.rb

@@ -14,6 +14,7 @@ module Middleman
       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.'
+      option :extra_css_classes, [], 'Additional CSS classes to add to the pre tag.'
 
       def after_configuration
         Middleman::Syntax::Highlighter.options = options

data/lib/middleman-syntax/formatters.rb

@@ -16,7 +16,16 @@ module Middleman
           @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'))
+            css_class = opts.fetch(:css_class, 'codehilite')
+            
+            # Add custom classes to the pre element
+            if opts[:extra_css_classes] && !opts[:extra_css_classes].empty?
+              extra_css_classes = opts[:extra_css_classes].is_a?(Array) ? opts[:extra_css_classes] : opts[:extra_css_classes].to_s.split
+              # Include the custom classes in the css_class parameter
+              css_class = [css_class].concat(extra_css_classes).join(' ')
+            end
+            
+            @formatter = Rouge::Formatters::HTMLPygments.new(@formatter, css_class)
           end
         end
 

data/lib/middleman-syntax/highlighter.rb

@@ -7,14 +7,15 @@ module Middleman
 
       # 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)
+        
+        lexer = Rouge::Lexer.find_fancy(language, code, lexer_options) || Rouge::Lexers::PlainText
+
+        highlighter_options[:css_class] = [ highlighter_options[:css_class], lexer.tag ].join(' ')
 
         formatter = Middleman::Syntax::Formatters::HTML.new(highlighter_options)
-        formatter.format(lexer.lex(code, lexer_options))
+        formatter.format(lexer.lex(code))
       end
     end
   end

data/lib/middleman-syntax/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Syntax
-    VERSION = "3.4.0"
+    VERSION = "3.6.0"
   end
 end

data/middleman-syntax.gemspec

@@ -12,12 +12,6 @@ Gem::Specification.new do |s|
   s.license = "MIT"
   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("rouge", ["~> 3.2"])
-  s.add_development_dependency("aruba")
-  s.add_development_dependency("cucumber")
-  s.add_development_dependency("haml")
-  s.add_development_dependency("kramdown")
-  s.add_development_dependency("slim")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-syntax
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Ben Hollis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-19 00:00:00.000000000 Z
+date: 2025-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -38,76 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: aruba
-  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: cucumber
-  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
@@ -115,8 +45,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".devcontainer/Dockerfile"
-- ".devcontainer/devcontainer.json"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - CHANGELOG.md
@@ -125,13 +53,17 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- features/extra_css_classes.feature
 - features/haml_filter.feature
 - features/helper.feature
+- features/lexer_options.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-extra-css-classes/config.rb
+- fixtures/test-app-extra-css-classes/source/index.html.erb
 - fixtures/test-app/config.rb
 - fixtures/test-app/source/code.html.markdown
 - fixtures/test-app/source/code_haml.html.haml
@@ -169,18 +101,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Code syntax highlighting plugin via rouge for Middleman
 test_files:
+- features/extra_css_classes.feature
 - features/haml_filter.feature
 - features/helper.feature
+- features/lexer_options.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-extra-css-classes/config.rb
+- fixtures/test-app-extra-css-classes/source/index.html.erb
 - fixtures/test-app/config.rb
 - fixtures/test-app/source/code.html.markdown
 - fixtures/test-app/source/code_haml.html.haml

data/.devcontainer/Dockerfile

@@ -1,19 +0,0 @@
-# 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

@@ -1,37 +0,0 @@
-// 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"
-
-}