thredded-markdown_coderay 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e53bf20c59640b5e4c301e6d82c94b4de21a242
+  data.tar.gz: 0d13156754ec8bd8a6fe8217f148d7fc76564408
+SHA512:
+  metadata.gz: e31b62d8fa72c2b53fad286118a1102b7dc65cabba9a9ea560c59fb80f9781bbf6cdf2ca357936dcf4a975788be044a8adb15cdf3a7b45b3f46a55bfb33ac42c
+  data.tar.gz: 39a0204a0057dbb81c6459b0f6dd33bd469179cbae6ca94769aef1fa07ed91780e3b4c007b80912791d1a0bec45ff1c9609ca1fff9bd279182df64ca7916d1d3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gleb Mazovetskiy
+
+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/README.md

@@ -0,0 +1,65 @@
+# Thredded Plugin: Syntax Highlighting in Markdown via Coderay [![Build Status](https://travis-ci.org/thredded/thredded-markdown_coderay.svg?branch=master)](https://travis-ci.org/thredded/thredded-markdown_coderay) [![Test Coverage](https://codeclimate.com/github/thredded/thredded-markdown_coderay/badges/coverage.svg)](https://codeclimate.com/github/thredded/thredded-markdown_coderay/coverage)
+
+A Thredded plugin that Highlights code syntax in your Markdown posts via
+[Coderay](https://github.com/rubychan/coderay).
+
+The result with the default styles looks like this:
+
+![thredded-markdown_coderay](https://cloud.githubusercontent.com/assets/216339/20035926/46650068-a3b5-11e6-90b0-2530bf1d98f5.png)
+
+Code language is not inferred, and must be specified, e.g.:
+
+    ```ruby
+    puts 'hi'
+    ```
+    
+or
+
+    ~~~ ruby
+    puts 'hi'
+    ~~~
+
+Currently only supports the default Thredded markdown parser:
+[Kramdown](https://github.com/gettalong/kramdown).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thredded-markdown_coderay'
+```
+
+And then execute:
+
+```bash
+bundle
+rails g thredded:markdown_coderay:install
+```
+
+## Usage
+
+\-
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thredded/thredded-markdown_coderay. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+

data/lib/generators/thredded/markdown_coderay/install_generator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module Thredded
+  module MarkdownCoderay
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Installs Thredded Markdown Coderay plugin.'
+      source_root File.expand_path(
+        '../../../templates/thredded/markdown_coderay/install',
+        File.dirname(__FILE__)
+      )
+      public_task :install
+
+      def install
+        copy_file '_thredded-coderay.scss',
+                  'app/assets/stylesheets/_thredded-coderay.scss'
+        append_to_file 'app/assets/stylesheets/application.scss', <<~'SCSS'
+          @import "thredded-coderay";
+        SCSS
+      end
+
+      private
+
+      def coderay_css
+        require 'coderay'
+        CodeRay::Encoders[:html]::CSS.new(:default).stylesheet
+      end
+
+      def indent(multiplier, content)
+        spaces = ' ' * multiplier
+        content.each_line.map do |line|
+          line.blank? ? line : "#{spaces}#{line}"
+        end.join
+      end
+    end
+  end
+end

data/lib/templates/thredded/markdown_coderay/install/_thredded-coderay.scss

@@ -0,0 +1,139 @@
+.thredded--post--content {
+  .CodeRay {
+    margin: 1rem 0;
+  }
+
+  .CodeRay {
+    color: #333;
+  }
+
+  .CodeRay pre {
+    margin: 0;
+    padding: 1em;
+  }
+
+  div.CodeRay { }
+  span.CodeRay { white-space: pre; border: 0; padding: 2px }
+
+  table.CodeRay { border-collapse: collapse; width: 100%; padding: 2px }
+  table.CodeRay td {
+    padding: 1em 0.5em;
+    vertical-align: top;
+  }
+
+  .CodeRay .line-numbers {
+    color: #AAA;
+    text-align: right;
+    user-select: none;
+  }
+
+  .CodeRay .line-numbers pre {
+    word-break: normal;
+  }
+
+  .CodeRay .line-numbers a {
+    color: #AAA;
+  }
+
+  .CodeRay .line-numbers tt { font-weight: bold }
+  .CodeRay .line-numbers .highlighted { color: red }
+  .CodeRay .line { display: block; float: left; width: 100%; }
+  .CodeRay span.line-numbers { padding: 0 10px 0 0 }
+  .CodeRay .code { width: 100% }
+
+  ol.CodeRay { font-size: 10pt }
+  ol.CodeRay li { white-space: pre }
+
+  .CodeRay .code pre { overflow: auto }
+  .CodeRay .debug { color:white ! important; background:blue ! important; }
+
+  .CodeRay .annotation { color:#007 }
+  .CodeRay .attribute-name { color:#f08 }
+  .CodeRay .attribute-value { color:#700 }
+  .CodeRay .binary { color:#509; font-weight:bold }
+  .CodeRay .comment  { color:#998; font-style: italic;}
+  .CodeRay .char { color:#04D }
+  .CodeRay .char .content { color:#04D }
+  .CodeRay .char .delimiter { color:#039 }
+  .CodeRay .class { color:#458; font-weight:bold }
+  .CodeRay .complex { color:#A08; font-weight:bold }
+  .CodeRay .constant { color:teal; }
+  .CodeRay .color { color:#0A0 }
+  .CodeRay .class-variable { color:#369 }
+  .CodeRay .decorator { color:#B0B; }
+  .CodeRay .definition { color:#099; font-weight:bold }
+  .CodeRay .directive { color:#088; font-weight:bold }
+  .CodeRay .delimiter { color:black }
+  .CodeRay .doc { color:#970 }
+  .CodeRay .doctype { color:#34b }
+  .CodeRay .doc-string { color:#D42; font-weight:bold }
+  .CodeRay .escape  { color:#666; font-weight:bold }
+  .CodeRay .entity { color:#800; font-weight:bold }
+  .CodeRay .error { color:#F00; background-color:#FAA }
+  .CodeRay .exception { color:#C00; font-weight:bold }
+  .CodeRay .filename { color:#099; }
+  .CodeRay .function { color:#900; font-weight:bold }
+  .CodeRay .global-variable { color:teal; font-weight:bold }
+  .CodeRay .hex { color:#058; font-weight:bold }
+  .CodeRay .integer  { color:#099; }
+  .CodeRay .include { color:#B44; font-weight:bold }
+  .CodeRay .inline { color: black }
+  .CodeRay .inline .inline { background: #ccc }
+  .CodeRay .inline .inline .inline { background: #bbb }
+  .CodeRay .inline .inline-delimiter { color: #D14; }
+  .CodeRay .inline-delimiter { color: #D14; }
+  .CodeRay .important { color:#f00; }
+  .CodeRay .interpreted { color:#B2B; font-weight:bold }
+  .CodeRay .instance-variable { color:teal }
+  .CodeRay .label { color:#970; font-weight:bold }
+  .CodeRay .local-variable { color:#963 }
+  .CodeRay .octal { color:#40E; font-weight:bold }
+  .CodeRay .operator { }
+  .CodeRay .predefined-constant {  font-weight:bold }
+  .CodeRay .predefined { color:#369; font-weight:bold }
+  .CodeRay .preprocessor { color:#579; }
+  .CodeRay .pseudo-class { color:#00C; font-weight:bold }
+  .CodeRay .predefined-type { color:#074; font-weight:bold }
+  .CodeRay .reserved, .keyword  { color:#000; font-weight:bold }
+
+  .CodeRay .key { color: #808; }
+  .CodeRay .key .delimiter { color: #606; }
+  .CodeRay .key .char { color: #80f; }
+  .CodeRay .value { color: #088; }
+
+  .CodeRay .regexp { background-color:#fff0ff }
+  .CodeRay .regexp .content { color:#808 }
+  .CodeRay .regexp .delimiter { color:#404 }
+  .CodeRay .regexp .modifier { color:#C2C }
+  .CodeRay .regexp .function  { color:#404; font-weight: bold }
+
+  .CodeRay .string { color: #D20; }
+  .CodeRay .string .string { }
+  .CodeRay .string .string .string { background-color:#ffd0d0 }
+  .CodeRay .string .content { color: #D14; }
+  .CodeRay .string .char { color: #D14; }
+  .CodeRay .string .delimiter { color: #D14; }
+
+  .CodeRay .shell { color:#D14 }
+  .CodeRay .shell .content { }
+  .CodeRay .shell .delimiter { color:#D14 }
+
+  .CodeRay .symbol { color:#990073 }
+  .CodeRay .symbol .content { color:#A60 }
+  .CodeRay .symbol .delimiter { color:#630 }
+
+  .CodeRay .tag { color:#070 }
+  .CodeRay .tag-special { color:#D70; font-weight:bold }
+  .CodeRay .type { color:#339; font-weight:bold }
+  .CodeRay .variable  { color:#036 }
+
+  .CodeRay .insert { background: #afa; }
+  .CodeRay .delete { background: #faa; }
+  .CodeRay .change { color: #aaf; background: #007; }
+  .CodeRay .head { color: #f8f; background: #505 }
+
+  .CodeRay .insert .insert { color: #080; font-weight:bold }
+  .CodeRay .delete .delete { color: #800; font-weight:bold }
+  .CodeRay .change .change { color: #66f; }
+  .CodeRay .head .head { color: #f4f; }
+}

data/lib/thredded/markdown_coderay.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+require 'thredded/markdown_coderay/version'
+require 'thredded/markdown_coderay/railtie' if defined?(Rails)
+
+module Thredded
+  module MarkdownCoderay
+    class << self
+      attr_accessor :options
+
+      def setup!
+        assert_pipeline_contains! 'Thredded::HtmlPipeline::KramdownFilter'
+        Thredded::HtmlPipeline::KramdownFilter.options.update(options)
+        %w(div span code table td ol).each do |tag|
+          whitelist_attribute! tag, 'class'
+        end
+      end
+
+      private
+
+      def assert_pipeline_contains!(name)
+        return if pipeline_contains?(name)
+        raise "#{self.class.name} requires #{name} in" \
+              'Thredded::ContentFormatter.pipeline_filters'
+      end
+
+      def pipeline_contains?(name)
+        Thredded::ContentFormatter.pipeline_filters.map(&:name).include?(name)
+      end
+
+      def whitelist_attribute!(tag, attribute)
+        whitelist_attr = Thredded::ContentFormatter.whitelist[:attributes]
+        whitelist_attr[tag] ||= []
+        return if whitelist_attr[tag].include?(attribute)
+        whitelist_attr[tag] << attribute
+      end
+    end
+
+    self.options = {
+      enable_coderay: true,
+      syntax_highlighter: 'coderay',
+      # See
+      syntax_highlighter_opts: {
+        css: 'class',
+        line_number_anchors: false
+      }
+    }
+  end
+end

data/lib/thredded/markdown_coderay/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module Thredded
+  module MarkdownCoderay
+    class Railtie < Rails::Railtie
+      initializer 'thredded.markdown_coderay', after: 'thredded' do
+        Thredded::MarkdownCoderay.setup!
+      end
+    end
+  end
+end

data/lib/thredded/markdown_coderay/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Thredded
+  module MarkdownCoderay
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: thredded-markdown_coderay
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gleb Mazovetskiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: thredded
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: Highlights code syntax in your Markdown posts via Coderay.
+email:
+- glex.spb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/generators/thredded/markdown_coderay/install_generator.rb
+- lib/templates/thredded/markdown_coderay/install/_thredded-coderay.scss
+- lib/thredded/markdown_coderay.rb
+- lib/thredded/markdown_coderay/railtie.rb
+- lib/thredded/markdown_coderay/version.rb
+homepage: https://github.com/thredded/thredded-markdown_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.6.8
+signing_key: 
+specification_version: 4
+summary: Thredded Markdown code blocks highlighting via Coderay.
+test_files: []