prawndown 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15f1c566a5138e7e6e6116a153a5322a37b82fdb95b3e6b729bf7b0e8911a782
+  data.tar.gz: 4fa94d709d3c05059c07690f76f1211519723c838b066336f78cd8162da5743e
+SHA512:
+  metadata.gz: a49b17d69baa959894f0457e91659007f868a61ad1dc54d9b8ffd1938b07adbf9263263f0ae4fd387236bc7014048ad161cd3031d8caceb3d593d582725a6c75
+  data.tar.gz: ba7ff76b1d419a9e69a86a563a432c82a5b3259079e0596ddfb2a001f23ac5739ee69050c057eeea398d64145b347bce5c1eb4fede190dc0d96647a30b166bb7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+coverage

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+For more information about changelogs, check
+[Keep a Changelog](http://keepachangelog.com) and
+[Vandamme](http://tech-angels.github.io/vandamme).
+
+## 0.1.1 - 2018.03.29
+
+* [ENHANCEMENT] Add generatable examples
+
+## 0.1.0 - 2018.03.29
+
+* [FEATURE] Add `#markdown` extension to `Prawn::Document`
+
+## 0.0.2 - 2018.03.16
+
+* [FEATURE] Add support for additional header sizes (header 4-6)
+
+## 0.0.1 - 2018.03.16
+
+* [FEATURE] Add basic support for parsing Markdown

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in prawndown.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    prawndown (0.1.1)
+      prawn (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (1.0.3)
+    afm (0.2.2)
+    docile (1.3.0)
+    hashery (2.1.2)
+    json (2.1.0)
+    minitest (5.11.3)
+    pdf-core (0.7.0)
+    pdf-inspector (1.3.0)
+      pdf-reader (>= 1.0, < 3.0.a)
+    pdf-reader (2.1.0)
+      Ascii85 (~> 1.0.0)
+      afm (~> 0.2.1)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    prawn (2.2.2)
+      pdf-core (~> 0.7.0)
+      ttfunk (~> 1.5)
+    rake (10.5.0)
+    ruby-rc4 (0.1.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    ttfunk (1.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  pdf-inspector (~> 1.3)
+  prawndown!
+  rake (~> 10.0)
+  simplecov (~> 0.16.1)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kasper Meyer
+
+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,55 @@
+# Prawndown
+
+A tiny Ruby gem to render a subset of Markdown in PDF files
+
+Prawn is a Ruby library to generate PDF files. It supports text formatting trough its own HTML-esque language, which has tags for different formatting options like **bold**, _italic_ and [links](https://github.com/kaspermeyer/prawndown). Read more about the supported tags in the [Prawn documentation](http://prawnpdf.org/api-docs/2.0/Prawn/Text.html#text-instance_method).
+
+## Usage
+
+Prawndown extends Prawn with the `markdown` method. Use it to render Markdown in the document:
+
+```ruby
+Prawn::Document.generate('markdown.pdf') do
+  markdown '# Welcome to Prawndown!'
+  markdown '**Important:** We _hope_ you enjoy your stay!'
+end
+```
+
+It accepts the same options as [`Prawn::Document#text`](http://prawnpdf.org/api-docs/2.0/Prawn/Text.html#text-instance_method)
+
+If you prefer, you can also use the parser directly:
+
+```ruby
+Prawndown::Parser.new('_Welcome_ to **Prawndown**').to_prawn #=> '<i>Welcome</i> to <b>Prawndown</b>'
+```
+
+More thorough examples can be found under the `examples` folder. Run `rake examples` to generate the examples PDF.
+
+*Note: Prawdown can't output the tags `<sub>`, `<sup>`, `<font>` and `<color>` as they lack native support in Markdown.*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prawndown'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prawndown
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`.
+
+## Credits
+
++ [Henrik Ny](https://github.com/henrik) for the [idea and name](https://gist.github.com/henrik/2775319) of the project.
++ [Johnny Broadway](https://github.com/jbroadway) for creating [Slimdown](https://gist.github.com/jbroadway/2836900) and coming up with great regular expressions to match Markdown tags with.

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test
+
+desc 'Generate the examples'
+task :examples do
+  puts 'Building markdown.pdf'
+  require_relative 'examples/markdown'
+  puts 'Done'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "prawndown"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/markdown.rb

@@ -0,0 +1,26 @@
+require 'prawndown'
+
+def sample_text
+  <<-HEREDOC
+# Header 1
+## Header 2
+### Header 3
+#### Header 4
+##### Header 5
+###### Header 6
+
+It is __really__ **really** important that you _use_ this gem for something ~~useful~~ fun!
+Visit the [Prawndown documentation](https://github.com/kaspermeyer/prawndown) *now*!
+
+Remember that it also supports paragraphs.
+
+
+
+
+It respects the number of new lines.
+  HEREDOC
+end
+
+Prawn::Document.generate('markdown.pdf') do
+  markdown sample_text
+end

data/lib/prawndown/parser.rb

@@ -0,0 +1,32 @@
+module Prawndown
+  # Markdown to Prawn parser
+  class Parser
+    MATCHERS = {
+      /^# (.+)/                  => '<font size="26"><b>\1</b></font>', # Header 1
+      /^## (.+)/                 => '<font size="24"><b>\1</b></font>', # Header 2
+      /^### (.+)/                => '<font size="22"><b>\1</b></font>', # Header 3
+      /^#### (.+)/               => '<font size="20"><b>\1</b></font>', # Header 4
+      /^##### (.+)/              => '<font size="18"><b>\1</b></font>', # Header 5
+      /^###### (.+)/             => '<font size="16"><b>\1</b></font>', # Header 6
+      /\[([^\[]+)\]\(([^\)]+)\)/ => '<link href="\2">\1</link>',        # Link
+      /(\*\*|__)(.*?)\1/         => '<b>\2</b>',                        # Bold
+      /(\*|_)(.*?)\1/            => '<i>\2</i>',                        # Italic
+      /\~\~(.*?)\~\~/            => '<strikethrough>\1</strikethrough>' # Strikethrough
+    }
+
+    # Initialize a new +Prawndown::Parser+.
+    # +text+ must a a valid Markdown string that only contains supported tags.
+    #
+    # Supported tags are: Header 1-6, bold, italic, strikethrough and link.
+    def initialize(text)
+      @text = text.to_s
+    end
+
+    # Parses the Markdown text and outputs a Prawn compatible string
+    def to_prawn
+      MATCHERS.inject(@text) do |final_string, (markdown_matcher, prawn_tag)|
+        final_string.gsub(markdown_matcher, prawn_tag)
+      end
+    end
+  end
+end

data/lib/prawndown/version.rb

@@ -0,0 +1,3 @@
+module Prawndown
+  VERSION = "0.1.1"
+end

data/lib/prawndown.rb

@@ -0,0 +1,22 @@
+require 'prawn'
+require "prawndown/version"
+require "prawndown/parser"
+
+module Prawndown
+  module Interface
+    # Renders Markdown in the current document
+    #
+    # It supports header 1-6, bold text, italic text, strikethrough and links
+    # It supports the same options as +Prawn::Document#text+
+    #
+    #   Prawn::Document.generate('markdown.pdf') do
+    #     markdown '# Welcome to Prawndown!'
+    #     markdown '**Important:** We _hope_ you enjoy your stay!'
+    #   end
+    def markdown(string, options = {})
+      text Prawndown::Parser.new(string).to_prawn, options.merge(inline_format: true)
+    end
+  end
+end
+
+Prawn::Document.extensions << Prawndown::Interface

data/prawndown.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "prawndown/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "prawndown"
+  spec.version       = Prawndown::VERSION
+  spec.authors       = ["Kasper Meyer"]
+  spec.email         = ["hi@kaspermeyer.com"]
+
+  spec.summary       = %q{A tiny Ruby gem to render a subset of Markdown in PDF files}
+  spec.homepage      = "https://github.com/kaspermeyer/prawndown"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency             "prawn",         "~> 2.0"
+  spec.add_development_dependency "pdf-inspector", "~> 1.3"
+  spec.add_development_dependency "simplecov",     "~> 0.16.1"
+  spec.add_development_dependency "bundler",       "~> 1.16"
+  spec.add_development_dependency "rake",          "~> 10.0"
+  spec.add_development_dependency "minitest",      "~> 5.0"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: prawndown
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kasper Meyer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  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: pdf-inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- hi@kaspermeyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/markdown.rb
+- lib/prawndown.rb
+- lib/prawndown/parser.rb
+- lib/prawndown/version.rb
+- prawndown.gemspec
+homepage: https://github.com/kaspermeyer/prawndown
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A tiny Ruby gem to render a subset of Markdown in PDF files
+test_files: []