kramdown-syntax-coderay 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9ff914162352505548ed4030c8459dc662f703bac13db5c018d4509a8f3abab
+  data.tar.gz: fca3f23ba27c5fc0ed3e8312c771997bcc8fd6f2cd648ff161c20dc164c32026
+SHA512:
+  metadata.gz: 8adb57e22b44fba6df4702d9bb30b714ab7b4e2a89a6c42d83f7708e22ecce634dd7263a63e1389691f60fb76e0c618ac96b92865d2b1b1c4cd9ca54bed2f3ba
+  data.tar.gz: 1963926f4d89f97a39b99f98b208ac4b09007ab944710e443d211c10c0019da9cbdc9233a318f8ed61c0ada9d4583195fdcb215aabeb46520b654789692a6de5

data/CONTRIBUTERS

@@ -0,0 +1,3 @@
+  Count Name
+======= ====
+      1 Thomas Leitner <t_leitner@gmx.at>

data/COPYING

@@ -0,0 +1,21 @@
+kramdown-syntax-coderay
+Copyright (C) 2019 Thomas Leitner <t_leitner@gmx.at>
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/kramdown-syntax-coderay.rb

@@ -0,0 +1,10 @@
+# -*- coding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# Copyright (C) 2019 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown-syntax-coderay which is licensed under the MIT.
+#++
+#
+
+require 'kramdown/converter/syntax_highlighter/coderay'

data/lib/kramdown/converter/syntax_highlighter/coderay.rb

@@ -0,0 +1,169 @@
+# -*- coding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# Copyright (C) 2019 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown-syntax-coderay which is licensed under the MIT.
+#++
+#
+
+require 'kramdown/options'
+require 'kramdown/converter'
+require 'coderay'
+
+module Kramdown #:nodoc:
+
+  module Options #:nodoc:
+
+    define(:enable_coderay, Boolean, true, <<EOF)
+Use coderay for syntax highlighting
+
+If this option is `true`, coderay is used by the HTML converter for
+syntax highlighting the content of code spans and code blocks.
+
+Default: true
+Used by: HTML converter
+EOF
+
+    define(:coderay_wrap, Symbol, :div, <<EOF)
+Defines how the highlighted code should be wrapped
+
+The possible values are :span, :div or nil.
+
+Default: :div
+Used by: HTML converter
+EOF
+
+    define(:coderay_line_numbers, Symbol, :inline, <<EOF)
+Defines how and if line numbers should be shown
+
+The possible values are :table, :inline or nil. If this option is
+nil, no line numbers are shown.
+
+Default: :inline
+Used by: HTML converter
+EOF
+
+    define(:coderay_line_number_start, Integer, 1, <<EOF)
+The start value for the line numbers
+
+Default: 1
+Used by: HTML converter
+EOF
+
+    define(:coderay_tab_width, Integer, 8, <<EOF)
+The tab width used in highlighted code
+
+Used by: HTML converter
+EOF
+
+    define(:coderay_bold_every, Object, 10, <<EOF) do |val|
+Defines how often a line number should be made bold
+
+Can either be an integer or false (to turn off bold line numbers
+completely).
+
+Default: 10
+Used by: HTML converter
+EOF
+      if val == false || val.to_s == 'false'
+        false
+      else
+        Integer(val.to_s) rescue raise Kramdown::Error, "Invalid value for option 'coderay_bold_every'"
+      end
+    end
+
+    define(:coderay_css, Symbol, :style, <<EOF)
+Defines how the highlighted code gets styled
+
+Possible values are :class (CSS classes are applied to the code
+elements, one must supply the needed CSS file) or :style (default CSS
+styles are directly applied to the code elements).
+
+Default: style
+Used by: HTML converter
+EOF
+
+    define(:coderay_default_lang, Symbol, nil, <<EOF)
+Sets the default language for highlighting code blocks
+
+If no language is set for a code block, the default language is used
+instead. The value has to be one of the languages supported by coderay
+or nil if no default language should be used.
+
+Default: nil
+Used by: HTML converter
+EOF
+
+  end
+
+  module Converter #:nodoc:
+    module SyntaxHighlighter #:nodoc:
+
+      # Uses Coderay to highlight code blocks and code spans.
+      module Coderay
+
+        VERSION = '1.0.0'
+
+        def self.call(converter, text, lang, type, call_opts)
+          return nil unless converter.options[:enable_coderay]
+          if type == :span && lang
+            ::CodeRay.scan(text, lang.to_sym).html(options(converter, :span)).chomp
+          elsif type == :block && (lang || options(converter, :default_lang))
+            lang ||= call_opts[:default_lang] = options(converter, :default_lang)
+            ::CodeRay.scan(text, lang.to_s.tr('-', '_').to_sym).html(options(converter, :block)).chomp << "\n"
+          else
+            nil
+          end
+        rescue StandardError
+          converter.warning("There was an error using CodeRay: #{$!.message}")
+          nil
+        end
+
+        def self.options(converter, type)
+          prepare_options(converter)
+          converter.data[:syntax_highlighter_coderay][type]
+        end
+
+        def self.prepare_options(converter)
+          return if converter.data.key?(:syntax_highlighter_coderay)
+
+          cache = converter.data[:syntax_highlighter_coderay] = {}
+
+          opts = converter.options[:syntax_highlighter_opts].dup
+          span_opts = (opts.delete(:span) || {}).dup
+          block_opts = (opts.delete(:block) || {}).dup
+          [span_opts, block_opts].each do |hash|
+            hash.keys.each do |k|
+              hash[k.kind_of?(String) ? ::Kramdown::Options.str_to_sym(k) : k] = hash.delete(k)
+            end
+          end
+
+          cache[:default_lang] = converter.options[:coderay_default_lang] || opts.delete(:default_lang)
+          cache[:span] = {
+            css: converter.options[:coderay_css],
+          }.update(opts).update(span_opts).update(wrap: :span)
+          cache[:block] = {
+            wrap: converter.options[:coderay_wrap],
+            line_numbers: converter.options[:coderay_line_numbers],
+            line_number_start: converter.options[:coderay_line_number_start],
+            tab_width: converter.options[:coderay_tab_width],
+            bold_every: converter.options[:coderay_bold_every],
+            css: converter.options[:coderay_css],
+          }.update(opts).update(block_opts)
+
+          [:css, :wrap, :line_numbers].each do |key|
+            [:block, :span].each do |type|
+              cache[type][key] = cache[type][key].to_sym if cache[type][key].kind_of?(String)
+            end
+          end
+        end
+
+      end
+    end
+
+    add_syntax_highlighter(:coderay, SyntaxHighlighter::Coderay)
+
+  end
+
+end

data/test/test_files.rb

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2019 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown-syntax-coderay which is licensed under the MIT.
+#++
+#
+
+require 'minitest/autorun'
+require 'kramdown'
+require 'kramdown-syntax-coderay'
+require 'yaml'
+require 'tmpdir'
+
+Encoding.default_external = 'utf-8'
+
+class TestFiles < Minitest::Test
+
+  Dir[File.dirname(__FILE__) + '/testcases/**/*.text'].each do |text_file|
+    basename = text_file.sub(/\.text$/, '')
+
+    html_file = basename + '.html'
+    define_method('test_' + text_file.tr('.', '_') + "_to_html") do
+      opts_file = basename + '.options'
+      opts_file = File.join(File.dirname(html_file), 'options') if !File.exist?(opts_file)
+      options = File.exist?(opts_file) ? YAML::load(File.read(opts_file)) : {auto_ids: false, footnote_nr: 1}
+      doc = Kramdown::Document.new(File.read(text_file), options)
+      assert_equal(File.read(html_file), doc.to_html)
+    end
+  end
+
+end

data/test/testcases/highlighting-opts.html

@@ -0,0 +1,6 @@
+<div class="language-ruby highlighter-coderay"><span class="CodeRay">x = <span class="constant">Class</span>.new
+</span>
+</div>
+<div class="language-html highlighter-coderay"><span class="CodeRay"><span class="tag">&lt;a&gt;</span>href<span class="tag">&lt;/a&gt;</span>
+</span>
+</div>

data/test/testcases/highlighting-opts.options

@@ -0,0 +1,8 @@
+:syntax_highlighter: :coderay
+:syntax_highlighter_opts:
+  block:
+    css: class
+  default_lang: ruby
+  wrap: span
+  line_numbers: null
+

data/test/testcases/highlighting-opts.text

@@ -0,0 +1,4 @@
+    x = Class.new
+^
+    <a>href</a>
+{: .language-html}

data/test/testcases/highlighting-span.html

@@ -0,0 +1 @@
+<p>You can say <code class="language-ruby highlighter-coderay"><span class="CodeRay">x = <span style="color:#036;font-weight:bold">Class</span>.new</span></code>, for example.</p>

data/test/testcases/highlighting-span.options

@@ -0,0 +1 @@
+:syntax_highlighter: :coderay

data/test/testcases/highlighting-span.text

@@ -0,0 +1 @@
+You can say `x = Class.new`{:.language-ruby}, for example.

data/test/testcases/highlighting.html

@@ -0,0 +1,6 @@
+<div class="language-ruby highlighter-coderay"><span class="CodeRay">x = <span class="constant">Class</span>.new
+</span>
+</div>
+<div class="language-html highlighter-coderay"><span class="CodeRay"><span class="tag">&lt;a&gt;</span>href<span class="tag">&lt;/a&gt;</span>
+</span>
+</div>

data/test/testcases/highlighting.options

@@ -0,0 +1,6 @@
+:syntax_highlighter: :coderay
+:coderay_default_lang: ruby
+:coderay_wrap: span
+:coderay_line_numbers: ~
+:coderay_css: class
+

data/test/testcases/highlighting.text

@@ -0,0 +1,4 @@
+    x = Class.new
+^
+    <a>href</a>
+{: .language-html}

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: kramdown-syntax-coderay
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Thomas Leitner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: 
+email: t_leitner@gmx.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTERS
+- COPYING
+- VERSION
+- lib/kramdown-syntax-coderay.rb
+- lib/kramdown/converter/syntax_highlighter/coderay.rb
+- test/test_files.rb
+- test/testcases/highlighting-opts.html
+- test/testcases/highlighting-opts.options
+- test/testcases/highlighting-opts.text
+- test/testcases/highlighting-span.html
+- test/testcases/highlighting-span.options
+- test/testcases/highlighting-span.text
+- test/testcases/highlighting.html
+- test/testcases/highlighting.options
+- test/testcases/highlighting.text
+homepage: https://github.com/kramdown/syntax-coderay
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: kramdown-syntax-coderay uses coderay to highlight code blocks/spans
+test_files: []