premonition 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c6cb2b3b2a0a1819165e8f659d5155283ea02b2
+  data.tar.gz: 93837406183c136e70a64481b8d7c6c1b8c5a3e9
+SHA512:
+  metadata.gz: 2bd2fade3e41a00033f9e08f12884284aa2abb2d9e7162ace82f73b9b2c27d17f23a9a4866ca135bfced8391ee3406aadd150c2e9f8d9fd0660a8f686e7355cf
+  data.tar.gz: 2d8cc1b674470ed803e03d22ef67ed6f730a24a6cc3461f7d7d9a93c2a6420de9e48c9f52a23bc7011e4c5715da07feae2406258405ce3f46f1e5b8abadb228e

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Amedia Utvikling AS
+
+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,128 @@
+# Premonition
+Premonition is a [Jekyll](https://jekyllrb.com/) extension that makes it possible to add block-styled Markdown side content to your documentation, for example summaries, notes, hints or warnings.
+
+It recognizes a special header in [block quotes](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#blockquotes) and converts then into html before the Markdown parser
+are run. As of now it only supports the [RedCarpet Markdown parser](https://github.com/vmg/redcarpet), but Kramdown support might be added in the future if requested.
+
+## Features
+
+ * Highly customizable
+ * Non-intrusive - Content are rendered as block-quotes by any other parser
+ * Easy to install
+
+## Requirements
+
+ * Redcarpet
+ * Jekyll 3.7.x or higher
+
+## Installation
+
+Add the following line to your `Gemfile` inside your Jekyll project. It should look something like this, depending on your Jekyll version:
+
+```
+gem "redcarpet"
+group :jekyll_plugins do
+  gem "premonition", "~> 1.0.0"
+end
+```
+As Premonition depends on Redcarpet, you must make sure this dependency is added as well.
+
+Then add Premonition to `plugins` inside the Jekyll config file (`_config.yml`):
+
+```yaml
+plugins:
+    - premonition
+```
+
+## Usage
+
+Premonition blocks are really just standard Markdown block quote where the first line must follow a
+special format to activate the transformation.
+
+`> [type] "Title"`
+
+The type can be any letter string. It is used to map a block to type configuration. This enables
+you to customize the look of different types. Like *Info*, *Warning* and *Error* boxes for example.
+By default the type will be added to the surrounding `<div>` block of the generated html code.
+
+The *Title* is as you might have guessed the title that will be added to the block.
+
+Example:
+
+~~~markdown
+> warning "I am a warning"
+> The body of the warning goes here. Premonition also allow you to write Markdown inside the block.
+~~~
+
+This will be converted into something like this bu Premonition
+
+~~~html
+<div class="premonition warning">
+  <span class="header">Info</span>
+  <p>The body of the warning goes here. Premonition also allow you to write Markdown inside the block.</p>
+~~~
+
+The title can be omitted by providing an empty string . Like this:
+
+~~~markdown
+> warning ""
+> No headers in here
+~~~
+
+Now you can add some CSS styling.
+
+## Configuration
+
+If you don't like the markup that Premonition produces, then you can change it in two ways.
+Either by replacing the default template, or by configuring templates for each type.
+
+All this are done inside your `_config.yml`
+
+### Replacing the default template
+
+```yaml
+premonition:
+  default:
+    template: '<div></i>%{header}%{content}</div>'
+    header_template: '<span class="header">%{title}</span>'
+```
+
+Please be aware of the placeholders inside the template. These placeholders will be replaced with
+the actual content of your block.
+
+Available placeholders are
+
+* *header* This is where the content from the header_template will be added if the title is not empty.
+* *content* This is where the rendered content of your block quote are added.
+* *title* This is where you block title will be added.
+* *type* The type name of the block.
+
+### Adding custom types
+
+Sometimes you might want to have different markup for different block types. This can easily be done
+by adding types to your Premonition configuration inside `_config.yml`
+
+~~~yaml
+premonition:
+  default:
+    template: '<div></i>%{header}%{content}</div>'
+    header_template: '<span class="header %{type}">%{title}</span>'
+  types:
+    - id: tip
+      template: '<div class="alert alert-success" role=""><i class="fa fa-check-square-o"></i>%{header}%{content}</div>'
+    - id: note
+      template: '<div class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i>%{header}%{content}</div>'
+~~~
+
+NOTE: You cannot add a custom header_template to types at the moment. This will be fixed soon.
+
+#### Default titles
+
+You can add a default title to a type.
+
+~~~yaml
+- id: tip
+      template: '<div class="alert alert-success" role=""><i class="fa fa-check-square-o"></i>%{header}%{content}</div>'
+      default_title: 'TIP!'
+~~~
+

data/lib/premonition/hook.rb

@@ -0,0 +1,100 @@
+module Jekyll
+  module Premonition
+    class Hook < Generator
+      safe true
+      priority :low
+      attr_reader :resources
+
+      def initialize(p)
+        super(p)
+        unless defined?(Redcarpet)
+          Jekyll::External.require_with_graceful_fail(
+            "redcarpet (in #{__FILE__})"
+          )
+        end
+      end
+
+      def generate(site)
+        @resources = Resources.new site
+        Hooks.register :documents, :pre_render do |doc|
+          adder(doc)
+        end
+        Hooks.register :pages, :pre_render do |page|
+          adder(page)
+        end
+        Hooks.register :posts, :pre_render do |page|
+          adder(page)
+        end
+      end
+
+      def adder(doc)
+        o = []
+        b = nil
+        doc.content.each_line do |l|
+          if blockquote?(l) && empty_block?(b)
+            if (m = l.match(/^\>\s+([a-z]+)\s+\"(.*)\"$/i))
+              y, t = m.captures
+              b = { title: t.strip, type: y.strip.downcase, content: [] }
+            else
+              o << l
+            end
+          elsif blockquote?(l) && !empty_block?(b)
+            b[:content] << l.match(/^\>(.*)$/i).captures[0].strip
+          else
+            if !blockquote?(l) && !empty_block?(b)
+              o << render_block(b)
+              b = nil
+            end
+            o << l
+          end
+        end
+        o << render_block(b) unless empty_block?(b)
+        doc.content = o.join
+      end
+
+      def blockquote?(l)
+        l.strip.start_with?('>')
+      end
+
+      def empty_block?(b)
+        b.nil?
+      end
+
+      def render_block(b)
+        t = create_templ(b)
+        c = "#{@resources.renderer.render(b[:content].join("\n"))}\n\n"
+        v = {
+          title: t[:title],
+          content: c,
+          type: b[:type]
+        }
+        v[:header] = header(t[:title]) % v
+        clean_markup(t[:template] % v)
+      end
+
+      def clean_markup(r)
+        br = '<br>' * 2
+        r = r.gsub('<p>', '').gsub('</p>', br).strip
+        r = r.gsub(br, '') if r.scan(/<br><br>/m).size == 1
+        r
+      end
+
+      def header(t)
+        t.empty? ? '' : @resources.config[:default][:header_template]
+      end
+
+      def create_templ(b)
+        c = {
+          template: @resources.config[:default][:template],
+          title: @resources.config[:default][:title]
+        }
+        @resources.config[:types].each do |t|
+          next unless t[:id] == b[:type]
+          c[:title] = b[:title].empty? ? t[:default_title] : b[:title]
+          c[:template] = t[:template]
+        end
+        c
+      end
+    end
+  end
+end

data/lib/premonition/resources.rb

@@ -0,0 +1,68 @@
+module Jekyll
+  module Premonition
+    class Resources
+      attr_reader :config
+      attr_reader :renderer
+
+      def initialize(site)
+        @config = load_config site
+        @renderer = create_renderer site
+      end
+
+      def create_renderer(site)
+        hsh = {}
+        ext_lookup(site).each { |a| hsh[a] = true }
+        Redcarpet::Markdown.new(Redcarpet::Render::HTML, hsh)
+      end
+
+      def ext_lookup(site)
+        ((site.config['redcarpet'] || {})['extensions'] || [])
+      end
+
+      def load_config(site)
+        cfg = create_default_config
+        prem = site.config['premonition'] || {}
+        df = prem['default'] || {}
+        cfg[:default][:template] = df['template'].strip unless df['template'].nil?
+        cfg[:default][:header_template] = df['header_template'].strip unless df['header_template'].nil?
+        cfg[:default][:title] = df['title'].strip unless df['title'].nil?
+        unless prem['types'].nil?
+          fail('types configuration must be an array') unless prem['types'].is_a?(Array)
+          prem['types'].each { |t| cfg[:types] << load_config_type(t) }
+        end
+        cfg
+      end
+
+      def load_config_type(t)
+        validate_config_type(t)
+        {
+          id: t['id'],
+          template: t['template'].strip,
+          default_title: (t['default_title'].nil? ? '' : t['default_title'].strip)
+        }
+      end
+
+      def validate_config_type(t)
+        fail('id missing from type') if t['id'].nil?
+        fail("id can only be lowercase letters: #{t['id']}") unless t['id'][/[a-z]+/] == t['id']
+        fail('template missing from type') if t['template'].nil?
+      end
+
+      def create_default_config
+        {
+          default: {
+            template: '<div class="premonition %{type}">%{header}%{content}</div>',
+            header_template: ' <span class="header">%{title}</span>',
+            title: 'Info'
+          },
+          types: []
+        }
+      end
+
+      def fail(msg)
+        Jekyll.logger.error 'Fatal (Premonition):', msg
+        raise LoadError, msg
+      end
+    end
+  end
+end

data/lib/premonition/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Premonition
+    VERSION = '1.0.2'.freeze
+  end
+end

data/lib/premonition.rb

@@ -0,0 +1,10 @@
+require 'redcarpet'
+require 'jekyll'
+require 'premonition/version'
+require 'premonition/resources'
+require 'premonition/hook'
+
+module Jekyll
+  module Premonition
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: premonition
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Jakob Vad Nielsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-06 00:00:00.000000000 Z
+dependencies:
+- !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: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- jakob.nielsen@amedia.no
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE
+- README.md
+- lib/premonition.rb
+- lib/premonition/hook.rb
+- lib/premonition/resources.rb
+- lib/premonition/version.rb
+homepage: http://github.com/amedia/premonition
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- 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.5.1
+signing_key: 
+specification_version: 4
+summary: Jekyll generator that will convert special block quotes into message boxes.
+test_files: []