markdown_views 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf1dc33fd63dcb76e12249d77dd4759bd68060bf
+  data.tar.gz: 363c136ece7c0080001fb4f590bb01e70675064f
+SHA512:
+  metadata.gz: 6da7e5a2607fa43d2c177a78988f7cf811bc9a41b6494b9db4689676d19a5932d50a4b916a72ac4156514729c99b9d141f70a63f04a62c00d4e566a393595dab
+  data.tar.gz: 34a616a2c482cdabfcce8e0a9b7123ad4770111ef48056d205609214c1d45c5bd2f2d5ee9dcbe714da51af64a140134a29d08e64063b318296569d4947c0c2f7

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.ruby-*
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in markdown_views.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014-2017 thomas morgan
+
+MIT License
+
+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,60 @@
+# MarkdownViews
+
+Make Rails 4+ handle .md templates, with optional preprocessing of ERB, HAML, etc. Easily configurable; uses RedCarpet. Also performs syntax highlighting via CodeRay.
+
+## Usage
+
+Just create views as `some_action.html.md` instead of `some_action.html.erb`.
+
+
+By default also strips all HTML comments from the output. This can cause issues with inline Javascript or otherwise be undesired. To disable, add the following to an initializer:
+
+    MarkdownViews.strip_comments = false
+
+By default, all .md files are preprocessed with ERB (making them effectively .md.erb files). This can be changed or disabled by setting a different template handler or setting to nil, respectively.
+
+    MarkdownViews.preprocessor = :erb
+    MarkdownViews.preprocessor = nil
+
+RedCarpet's rendering can be configured. Both rendering options and markdown options can be set. See RedCarpet's documentation for available options.
+
+    MarkdownViews.markdown_opts.merge! fenced_code_blocks: false
+
+    MarkdownViews.rendering_opts.merge! link_attributes: {'data-popup'=> true}
+
+Likewise, CodeRay can be configured too:
+
+    MarkdownViews.coderay_opts.merge! line_numbers: true
+
+The default CSS from CodeRay is made available via the asset pipeline. To use it, add this to your `application.css`:
+
+    *= require coderay
+
+
+### Helper
+
+MarkdownViews also includes a simple Markdown rendering helper. It uses the app-wide config already defined (see above).
+
+    <%= markdown('## Some markdown text') %>
+
+    <%= markdown do %>
+    ## Some markdown text
+    <% end %>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'markdown_views'
+
+And then execute:
+
+    $ bundle
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/markdown_views/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :generate_stylesheet do
+  `coderay stylesheet > app/assets/stylesheets/coderay.css`
+end

data/app/assets/stylesheets/coderay.css

@@ -0,0 +1,131 @@
+.CodeRay {
+  background-color: hsl(0,0%,95%);
+  border: 1px solid silver;
+  color: black;
+}
+.CodeRay pre {
+  margin: 0px;
+}
+
+span.CodeRay { white-space: pre; border: 0px; padding: 2px; }
+
+table.CodeRay { border-collapse: collapse; width: 100%; padding: 2px; }
+table.CodeRay td { padding: 2px 4px; vertical-align: top; }
+
+.CodeRay .line-numbers {
+  background-color: hsl(180,65%,90%);
+  color: gray;
+  text-align: right;
+  -webkit-user-select: none;
+  -moz-user-select: none;
+  user-select: none;
+}
+.CodeRay .line-numbers a {
+  background-color: hsl(180,65%,90%) !important;
+  color: gray !important;
+  text-decoration: none !important;
+}
+.CodeRay .line-numbers pre {
+  word-break: normal;
+}
+.CodeRay .line-numbers a:target { color: blue !important; }
+.CodeRay .line-numbers .highlighted { color: red !important; }
+.CodeRay .line-numbers .highlighted a { color: red !important; }
+.CodeRay span.line-numbers { padding: 0px 4px; }
+.CodeRay .line { display: block; float: left; width: 100%; }
+.CodeRay .code { width: 100%; }
+
+.CodeRay .debug { color: white !important; background: blue !important; }
+
+.CodeRay .annotation { color:#007 }
+.CodeRay .attribute-name { color:#b48 }
+.CodeRay .attribute-value { color:#700 }
+.CodeRay .binary { color:#549 }
+.CodeRay .binary .char { color:#325 }
+.CodeRay .binary .delimiter { color:#325 }
+.CodeRay .char { color:#D20 }
+.CodeRay .char .content { color:#D20 }
+.CodeRay .char .delimiter { color:#710 }
+.CodeRay .class { color:#B06; font-weight:bold }
+.CodeRay .class-variable { color:#369 }
+.CodeRay .color { color:#0A0 }
+.CodeRay .comment { color:#777 }
+.CodeRay .comment .char { color:#444 }
+.CodeRay .comment .delimiter { color:#444 }
+.CodeRay .constant { color:#036; font-weight:bold }
+.CodeRay .decorator { color:#B0B }
+.CodeRay .definition { color:#099; font-weight:bold }
+.CodeRay .delimiter { color:black }
+.CodeRay .directive { color:#088; font-weight:bold }
+.CodeRay .docstring { color:#D42; }
+.CodeRay .doctype { color:#34b }
+.CodeRay .done { text-decoration: line-through; color: gray }
+.CodeRay .entity { color:#800; font-weight:bold }
+.CodeRay .error { color:#F00; background-color:#FAA }
+.CodeRay .escape  { color:#666 }
+.CodeRay .exception { color:#C00; font-weight:bold }
+.CodeRay .float { color:#60E }
+.CodeRay .function { color:#06B; font-weight:bold }
+.CodeRay .function .delimiter { color:#059 }
+.CodeRay .function .content { color:#037 }
+.CodeRay .global-variable { color:#d70 }
+.CodeRay .hex { color:#02b }
+.CodeRay .id  { color:#33D; font-weight:bold }
+.CodeRay .include { color:#B44; font-weight:bold }
+.CodeRay .inline { background-color: hsla(0,0%,0%,0.07); color: black }
+.CodeRay .inline-delimiter { font-weight: bold; color: #666 }
+.CodeRay .instance-variable { color:#33B }
+.CodeRay .integer  { color:#00D }
+.CodeRay .imaginary { color:#f00 }
+.CodeRay .important { color:#D00 }
+.CodeRay .key { color: #606 }
+.CodeRay .key .char { color: #60f }
+.CodeRay .key .delimiter { color: #404 }
+.CodeRay .keyword { color:#080; font-weight:bold }
+.CodeRay .label { color:#970; font-weight:bold }
+.CodeRay .local-variable { color:#950 }
+.CodeRay .map .content { color:#808 }
+.CodeRay .map .delimiter { color:#40A}
+.CodeRay .map { background-color:hsla(200,100%,50%,0.06); }
+.CodeRay .namespace { color:#707; font-weight:bold }
+.CodeRay .octal { color:#40E }
+.CodeRay .operator { }
+.CodeRay .predefined { color:#369; font-weight:bold }
+.CodeRay .predefined-constant { color:#069 }
+.CodeRay .predefined-type { color:#0a8; font-weight:bold }
+.CodeRay .preprocessor { color:#579 }
+.CodeRay .pseudo-class { color:#00C; font-weight:bold }
+.CodeRay .regexp { background-color:hsla(300,100%,50%,0.06); }
+.CodeRay .regexp .content { color:#808 }
+.CodeRay .regexp .delimiter { color:#404 }
+.CodeRay .regexp .modifier { color:#C2C }
+.CodeRay .reserved { color:#080; font-weight:bold }
+.CodeRay .shell { background-color:hsla(120,100%,50%,0.06); }
+.CodeRay .shell .content { color:#2B2 }
+.CodeRay .shell .delimiter { color:#161 }
+.CodeRay .string { background-color:hsla(0,100%,50%,0.05); }
+.CodeRay .string .char { color: #b0b }
+.CodeRay .string .content { color: #D20 }
+.CodeRay .string .delimiter { color: #710 }
+.CodeRay .string .modifier { color: #E40 }
+.CodeRay .symbol { color:#A60 }
+.CodeRay .symbol .content { color:#A60 }
+.CodeRay .symbol .delimiter { color:#740 }
+.CodeRay .tag { color:#070; font-weight:bold }
+.CodeRay .type { color:#339; font-weight:bold }
+.CodeRay .value { color: #088 }
+.CodeRay .variable { color:#037 }
+
+.CodeRay .insert { background: hsla(120,100%,50%,0.12) }
+.CodeRay .delete { background: hsla(0,100%,50%,0.12) }
+.CodeRay .change { color: #bbf; background: #007 }
+.CodeRay .head { color: #f8f; background: #505 }
+.CodeRay .head .filename { color: white; }
+
+.CodeRay .delete .eyecatcher { background-color: hsla(0,100%,50%,0.2); border: 1px solid hsla(0,100%,45%,0.5); margin: -1px; border-bottom: none; border-top-left-radius: 5px; border-top-right-radius: 5px; }
+.CodeRay .insert .eyecatcher { background-color: hsla(120,100%,50%,0.2); border: 1px solid hsla(120,100%,25%,0.5); margin: -1px; border-top: none; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; }
+
+.CodeRay .insert .insert { color: #0c0; background:transparent; font-weight:bold }
+.CodeRay .delete .delete { color: #c00; background:transparent; font-weight:bold }
+.CodeRay .change .change { color: #88f }
+.CodeRay .head .head { color: #f4f }

data/app/helpers/markdown_views_helper.rb

@@ -0,0 +1,12 @@
+module MarkdownViewsHelper
+
+  def markdown(source=nil)
+    if block_given?
+      source = capture do
+        yield
+      end.strip_heredoc
+    end
+    MarkdownViews::Renderer.render(source)
+  end
+
+end

data/lib/markdown_views.rb

@@ -0,0 +1,11 @@
+# require 'active_support/core_ext/module/attribute_accessors'
+require 'action_view'
+require 'cgi'
+require 'coderay'
+require 'redcarpet'
+
+%w(config engine handler renderer version).each do |f|
+  require "markdown_views/#{f}"
+end
+
+ActionView::Template.register_template_handler(:md, MarkdownViews::Handler)

data/lib/markdown_views/config.rb

@@ -0,0 +1,38 @@
+module MarkdownViews
+  mattr_accessor :strip_comments
+  self.strip_comments = true
+
+  mattr_accessor :preprocessor
+  self.preprocessor = :erb
+
+  mattr_accessor :rendering_opts
+  self.rendering_opts = {
+    # filter_html: true,
+    hard_wrap: true,
+    # link_attributes: {'data-popup'=> true},
+    # no_styles: true,
+    # safe_links_only: true,
+  }
+
+  mattr_accessor :markdown_opts
+  self.markdown_opts = {
+    autolink: true,
+    disable_indented_code_blocks: true,
+    fenced_code_blocks: true,
+    lax_spacing: true,
+    no_intra_emphasis: true,
+    space_after_headers: true,
+    strikethrough: true,
+    tables: true,
+  }
+
+  mattr_accessor :coderay_opts
+  self.coderay_opts = {
+    bold_every: false,
+    css: :class,
+    line_number_anchors: false,
+    line_numbers: false,
+  }
+
+end
+

data/lib/markdown_views/engine.rb

@@ -0,0 +1,4 @@
+module MarkdownViews
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/markdown_views/handler.rb

@@ -0,0 +1,22 @@
+module MarkdownViews
+  class Handler
+    class << self
+
+      def call(template)
+        source = preprocessor.call(template)
+
+        <<-R1
+          MarkdownViews::Renderer.render(begin;#{source};end)
+        R1
+      end
+
+      def preprocessor
+        @@preprocessor ||= begin
+          pp = MarkdownViews.preprocessor || :raw
+          ActionView::Template.registered_template_handler(pp) || raise('Unknown template handler')
+        end
+      end
+
+    end
+  end
+end

data/lib/markdown_views/renderer.rb

@@ -0,0 +1,52 @@
+module MarkdownViews
+  class Renderer
+    class << self
+
+      def render(template)
+        out = template.to_s
+        out = strip_comments(out) if MarkdownViews.strip_comments
+        out = renderer.render(out)
+        out = strip_comments(out) if MarkdownViews.strip_comments
+        out.html_safe
+      end
+
+      def renderer
+        @@renderer ||= begin
+          r = ExtendedMarkdownHtml.new MarkdownViews.rendering_opts
+          Redcarpet::Markdown.new r, MarkdownViews.markdown_opts
+        end
+      end
+
+      def strip_comments(input)
+        input.gsub(/[ \t\r\n\f]*<!--(.*?)-->*/m, '')
+      end
+
+    end
+  end
+
+  class ExtendedMarkdownHtml < Redcarpet::Render::HTML
+    include Redcarpet::Render::SmartyPants
+
+    def block_code(text, language)
+      language ||= 'text'
+      html = CGI::unescapeHTML(text).sub(/\A[ \t\n\r]+/, '').sub(/[ \t\n\r]+\Z/, '')
+      cr = CodeRay.scan(html, language).html(MarkdownViews.coderay_opts)
+      %Q{<pre class="lang-#{language.to_s.gsub(/[^a-z0-9]/,'')}"><code class="CodeRay">#{cr.chomp}</code></pre>}
+    end
+
+    def table(header, body)
+      <<-TBL
+        <div class="table-responsive">
+          <table class="table">
+            <thead>
+              #{header}
+            </thead>
+            <tbody>
+              #{body}
+            </tbody>
+          </table>
+        </div>
+      TBL
+    end
+  end
+end

data/lib/markdown_views/version.rb

@@ -0,0 +1,3 @@
+module MarkdownViews
+  VERSION = '0.4.0'
+end

data/markdown_views.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'markdown_views/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "markdown_views"
+  spec.version       = MarkdownViews::VERSION
+  spec.authors       = ["thomas morgan"]
+  spec.email         = ["tm@iprog.com"]
+  spec.summary       = %q{Add .md template handler to Rails.}
+  spec.description   = %q{Makes Rails handle .md templates, with optional preprocessing of ERB, HAML, etc. Easily configurable; uses RedCarpet & CodeRay.}
+  spec.homepage      = "https://github.com/zarqman/markdown_views"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'redcarpet', '~> 3.1'
+  spec.add_dependency 'coderay', '~> 1.1'
+  spec.add_dependency 'actionpack', '>= 4.0', '< 6'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: markdown_views
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- thomas morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Makes Rails handle .md templates, with optional preprocessing of ERB,
+  HAML, etc. Easily configurable; uses RedCarpet & CodeRay.
+email:
+- tm@iprog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/stylesheets/coderay.css
+- app/helpers/markdown_views_helper.rb
+- lib/markdown_views.rb
+- lib/markdown_views/config.rb
+- lib/markdown_views/engine.rb
+- lib/markdown_views/handler.rb
+- lib/markdown_views/renderer.rb
+- lib/markdown_views/version.rb
+- markdown_views.gemspec
+homepage: https://github.com/zarqman/markdown_views
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Add .md template handler to Rails.
+test_files: []