prawn-markup 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2a68c2f0773fd3769437fcee6aed0cba929e95808c6618b8e36dc2f7624c8fe
-  data.tar.gz: d379eb9ed4e28cbdbeca6048b06019d5dd4d8e741cb41ebd304a65a3a05be034
+  metadata.gz: 3e42ddd575822d3805d7edb1525124617db37098e35ad139a2fed48824d08790
+  data.tar.gz: feb4ae593f40ebb09875ff2e4e9158ee4de7856980cf90e602103855d9bb47ad
 SHA512:
-  metadata.gz: 0da58a2bcd5b700753ae0f59f0c68c4014af194c74d2946e61e5028e29e8263fba91b255b023f2e9db5246a44a05cf5798b6808831309936091c7cdf53ff6c8f
-  data.tar.gz: 9129eaba7c308464c68c501dab041e2e54f79618734b0fd29c53554320b12cb6b2c18c25aa02bd77108eb3c17728720f95dce3412a4664f5fcc1d9c37beefccf
+  metadata.gz: c13137a43fb81062dd27fcc0492d9d910f7244bf8841cda87c690bc36ad8a17434e783a864874e56cdeea90e7a4eff49b242c9f62d72a318a869110d2a393848
+  data.tar.gz: f43d2499d55744f2e973a11ea9add7c254b283eee5639d29aa043f2b600d40a00fc52b4087c7bf7012d9eba502d9ab36a4da6b5f10484bdc9eb91e703dd1a23f

data/README.md

@@ -33,6 +33,27 @@ doc = Prawn::Document.new
 doc.markup('<p>Hello World</p><hr/><p>KTHXBYE</p>')
 ```
 
+## Supported HTML
+
+This gem parses the given HTML and layouts the following elements in a vertical order:
+
+* Text blocks: `p`, `div`, `ol`, `ul`, `li`, `hr`, `br`
+* Text semantics: `a`, `b`, `strong`, `i`, `em`, `u`, `s`, `del`, `sub`, `sup`
+* Headings: `h1`, `h2`, `h3`, `h4`, `h5`, `h6`
+* Tables: `table`, `tr`, `td`, `th`
+* Media: `img`, `iframe`
+* Inputs: `type=checkbox`, `type=radio`
+
+All other elements are ignored, their content is added to the parent element. With a few exceptions, no CSS is processed. One exception is the `width` property of `img`, `td` and `th`, which may contain values in `cm`, `mm`, `px`, `pt`, `%` or `auto`.
+
+If no explicit loader is given (see above), images are loaded from `http(s)` addresses or may be contained in the `src` attribute as base64 encoded data URIs. Prawn only supports `PNG` and `JPG`.
+
+## Example
+
+Have a look at [showcase.html](spec/fixtures/showcase.html), which is rendered by the corresponding [spec](spec/prawn/markup/showcase_spec.rb). Uncomment the `lookatit` call there to directly open the generated PDF when running the spec with `spec spec/prawn/markup/showcase_spec.rb`.
+
+## Formatting Options
+
 To customize element formatting, do:
 
 ```ruby
@@ -54,39 +75,40 @@ Tables and lists are rendered with [prawn-table](https://github.com/prawnpdf/pra
 
 Beside these options handled by Prawn / prawn-table, the following values may be customized:
 
-* `[:text][:preprocessor]`: A proc/callable that is called each time before a chunk of text is rendered.
-* `[:text][:margin_bottom]`: Margin after each `<p>`, `<ol>`, `<ul>` or `<table>`. Defaults to about half a line.
-* `[:heading1-6][:margin_top]`: Margin before a heading. Default is 0.
-* `[:heading1-6][:margin_bottom]`: Margin after a heading. Default is 0.
-* `[:table][:placeholder][:too_large]`: If the table content does not fit into the current bounding box, this text/callable is rendered instead. Defaults to '[table content too large]'.
-* `[:table][:placeholder][:subtable_too_large]`: If the content of a subtable cannot be fitted into the table, this text is rendered instead. Defaults to '[nested tables with automatic width are not supported]'.
-* `[:list][:vertical_margin]`: Margin at the top and the bottom of a list. Default is 5.
-* `[:list][:bullet][:char]`: The text used as bullet in unordered lists. Default is '•'.
-* `[:list][:bullet][:margin]`: Margin before the bullet. Default is 10.
-* `[:list][:content][:margin]`: Margin between the bullet and the content. Default is 10.
-* `[:list][:placeholder][:too_large]`: If the list content does not fit into the current bounding box, this text/callable is rendered instead. Defaults to '[list content too large]'.
-* `[:image][:loader]`: A callable that accepts the `src` attribute as an argument an returns a value understood by Prawn's `image` method. Loads `http(s)` URLs and base64 encoded data URIs by default.
-* `[:image][:placeholder]`: If an image is not supported, this text/callable is rendered instead. Defaults to '[unsupported image]'.
-* `[:iframe][:placeholder]`: If the HTML contains IFrames, this text/callable is rendered instead.
-A callable gets the URL of the IFrame as an argument. Defaults to ignore iframes.
-
-## Supported HTML
-
-This gem parses the given HTML and layouts the following elements in a vertical order:
-
-* Text blocks: `p`, `div`, `ol`, `ul`, `li`, `hr`, `br`
-* Text semantics: `a`, `b`, `strong`, `i`, `em`, `u`, `s`, `del`, `sub`, `sup`
-* Headings: `h1`, `h2`, `h3`, `h4`, `h5`, `h6`
-* Tables: `table`, `tr`, `td`, `th`
-* Media: `img`, `iframe`
-
-All other elements are ignored, their content is added to the parent element. With a few exceptions, no CSS is processed. One exception is the `width` property of `img`, `td` and `th`, which may contain values in `cm`, `mm`, `px`, `pt`, `%` or `auto`.
-
-If no explicit loader is given (see above), images are loaded from `http(s)` addresses or may be contained in the `src` attribute as base64 encoded data URIs. Prawn only supports `PNG` and `JPG`.
-
-## Example
-
-Have a look at [showcase.html](spec/fixtures/showcase.html), which is rendered by the corresponding [spec](spec/prawn/markup/showcase_spec.rb). Uncomment the `lookatit` call there to directly open the generated PDF when running the spec with `spec spec/prawn/markup/showcase_spec.rb`.
+* `:text`
+  * `:preprocessor`: A proc/callable that is called each time before a chunk of text is rendered.
+  * `:margin_bottom`: Margin after each `<p>`, `<ol>`, `<ul>` or `<table>`. Defaults to about half a line.
+* `:heading1-6`
+  * `:margin_top`: Margin before a heading. Default is 0.
+  * `:margin_bottom`: Margin after a heading. Default is 0.
+* `:table`
+  * `:placeholder`
+    * `:too_large`: If the table content does not fit into the current bounding box, this text/callable is rendered instead. Defaults to '[table content too large]'.
+    * `:subtable_too_large`: If the content of a subtable cannot be fitted into the table, this text is rendered instead. Defaults to '[nested tables with automatic width are not supported]'.
+* `:list`
+  * `:vertical_margin`: Margin at the top and the bottom of a list. Default is 5.
+  * `:bullet`
+    * `:char`: The text used as bullet in unordered lists. Default is '•'.
+    * `:margin`: Margin before the bullet. Default is 10.
+  * `:content`
+    * `:margin`: Margin between the bullet and the content. Default is 10.
+  * `:placeholder`
+    * `:too_large`: If the list content does not fit into the current bounding box, this text/callable is rendered instead. Defaults to '[list content too large]'.
+* `:image`
+  * `:loader`: A callable that accepts the `src` attribute as an argument an returns a value understood by Prawn's `image` method. Loads `http(s)` URLs and base64 encoded data URIs by default.
+  * `:placeholder`: If an image is not supported, this text/callable is rendered instead. Defaults to '[unsupported image]'.
+* `:iframe`
+  * `:placeholder`: If the HTML contains IFrames, this text/callable is rendered instead.
+  A callable gets the URL of the IFrame as an argument. Defaults to ignore iframes.
+* `:input`
+  * `:symbol_font`: A special font to print checkboxes and radios. Prawn's standard fonts do not support special unicode characters. Do not forget to update the document's `font_families`.
+  * `:symbol_font_size`: The size of the special font to print checkboxes and radios.
+  * `:checkbox`
+    * `:checked`: The char to print for a checked checkbox. Default is '☑'.
+    * `:unchecked`: The char to print for an unchecked checkbox. Default is '☐'.
+  * `:radio`
+    * `:checked`: The char to print for a checked radio. Default is '◉'.
+    * `:unchecked`: The char to print for an unchecked radio. Default is '○'.
 
 ## Development
 

data/lib/prawn/markup/processor.rb

@@ -26,6 +26,7 @@ module Prawn
       require 'prawn/markup/processor/blocks'
       require 'prawn/markup/processor/headings'
       require 'prawn/markup/processor/images'
+      require 'prawn/markup/processor/inputs'
       require 'prawn/markup/processor/tables'
       require 'prawn/markup/processor/lists'
 
@@ -33,6 +34,7 @@ module Prawn
       prepend Prawn::Markup::Processor::Blocks
       prepend Prawn::Markup::Processor::Headings
       prepend Prawn::Markup::Processor::Images
+      prepend Prawn::Markup::Processor::Inputs
       prepend Prawn::Markup::Processor::Tables
       prepend Prawn::Markup::Processor::Lists
 
@@ -128,7 +130,7 @@ module Prawn
       end
 
       def placeholder_value(keys, *args)
-        placeholder = dig_options(keys)
+        placeholder = dig_options(*keys)
         return if placeholder.nil?
 
         if placeholder.respond_to?(:call)
@@ -138,7 +140,7 @@ module Prawn
         end
       end
 
-      def dig_options(keys)
+      def dig_options(*keys)
         keys.inject(options) { |opts, key| opts ? opts[key] : nil }
       end
 

data/lib/prawn/markup/processor/inputs.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Prawn
+  module Markup
+    module Processor::Inputs
+
+      DEFAULT_CHECKABLE_CHARS = {
+        checkbox: {
+          checked: '☑',
+          unchecked: '☐'
+        },
+        radio: {
+          checked: '◉',
+          unchecked: '○'
+        }
+      }.freeze
+
+      def self.prepended(base)
+        base.known_elements.push('input')
+      end
+
+      def start_input
+        type = current_attrs['type'].to_sym
+        if DEFAULT_CHECKABLE_CHARS.keys.include?(type)
+          append_checked_symbol(type)
+        end
+      end
+
+      private
+
+      def append_checked_symbol(type)
+        char = checkable_symbol(type)
+        append_text(build_font_tag(char))
+      end
+
+      def checkable_symbol(type)
+        state = current_attrs.key?('checked') ? :checked : :unchecked
+        dig_options(:input, type, state) || DEFAULT_CHECKABLE_CHARS[type][state]
+      end
+
+      def symbol_font_options
+        @symbol_font_options ||= {
+          name: dig_options(:input, :symbol_font),
+          size: dig_options(:input, :symbol_font_size)
+        }.compact
+      end
+
+      def build_font_tag(content)
+        return content if symbol_font_options.empty?
+
+        out = +'<font'
+        symbol_font_options.each do |key, value|
+          out << " #{key}=\"#{value}\""
+        end
+        out << '>'
+        out << content
+        out << '</font>'
+      end
+    end
+  end
+end

data/lib/prawn/markup/version.rb

@@ -2,6 +2,6 @@
 
 module Prawn
   module Markup
-    VERSION = '0.2.2'
+    VERSION = '0.3.0'
   end
 end

data/prawn-markup.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(((spec|bin)/)|\.|Gemfile|Rakefile)})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-markup
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Pascal Zumkehr
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -159,18 +159,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/prawn/markup.rb
 - lib/prawn/markup/builders/list_builder.rb
 - lib/prawn/markup/builders/nestable_builder.rb
@@ -183,6 +174,7 @@ files:
 - lib/prawn/markup/processor/blocks.rb
 - lib/prawn/markup/processor/headings.rb
 - lib/prawn/markup/processor/images.rb
+- lib/prawn/markup/processor/inputs.rb
 - lib/prawn/markup/processor/lists.rb
 - lib/prawn/markup/processor/tables.rb
 - lib/prawn/markup/processor/text.rb
@@ -195,7 +187,7 @@ homepage: https://github.com/puzzle/prawn-markup
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -210,8 +202,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Parse simple HTML markup to include in Prawn PDFs
 test_files: []

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/spec/coverage/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,68 +0,0 @@
-AllCops:
-  DisplayCopNames: true
-  Exclude:
-    - '*.gemspec'
-    - spec/**/*
-    - vendor/**/*
-
-Metrics/AbcSize:
-  Severity: error
-
-Metrics/ClassLength:
-  Max: 250
-  Severity: error
-
-Metrics/CyclomaticComplexity:
-  Severity: error
-
-Metrics/MethodLength:
-  Max: 10
-  Severity: error
-
-Metrics/ModuleLength:
-  Max: 150
-  Severity: error
-
-Metrics/ParameterLists:
-  Max: 4
-  Severity: warning
-
-Layout/LineLength:
-  Max: 100
-  Severity: error
-
-# We thinks that's fine for specs
-Layout/EmptyLinesAroundBlockBody:
-  Enabled: false
-
-# We thinks that's fine
-Layout/EmptyLinesAroundClassBody:
-  Enabled: false
-
-# We thinks that's fine
-Layout/EmptyLinesAroundModuleBody:
-  Enabled: false
-
-# Keep for now, easier with superclass definitions
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-# The ones we use must exist for the entire class hierarchy.
-Style/ClassVars:
-  Enabled: false
-
-# Well, well, well
-Style/Documentation:
-  Enabled: false
-
-# Keep single line bodys for if and unless
-Style/IfUnlessModifier:
-  Enabled: false
-
-# We think that's the developers choice
-Style/GuardClause:
-  Enabled: false
-
-# Backwards compatibility
-Style/SafeNavigation:
-  Enabled: false

data/.travis.yml

@@ -1,21 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.5.7
-
-env:
-  global:
-    - CC_TEST_REPORTER_ID=d70fe39ffb8f2f7c5f837f0133d10a3a1c6784d0dd189153111577b60f74c603
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-
-script:
-  - bundle exec rake
-  - bundle exec rubocop
-
-after_script:
-  - ./cc-test-reporter format-coverage -t simplecov -o spec/coverage/codeclimate.json spec/coverage/.resultset.json
-  - if [[ "$TRAVIS_TEST_RESULT" == 0 ]]; then ./cc-test-reporter upload-coverage -i spec/coverage/codeclimate.json; fi

data/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in prawn-markup.gemspec
-gemspec

data/Gemfile.lock

@@ -1,87 +0,0 @@
-PATH
-  remote: .
-  specs:
-    prawn-markup (0.2.2)
-      nokogiri
-      prawn
-      prawn-table
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    Ascii85 (1.0.3)
-    afm (0.2.2)
-    ast (2.4.0)
-    byebug (11.1.1)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    hashery (2.1.2)
-    jaro_winkler (1.5.4)
-    mini_portile2 (2.4.0)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.19.1)
-    parser (2.7.0.4)
-      ast (~> 2.4.0)
-    pdf-core (0.7.0)
-    pdf-inspector (1.3.0)
-      pdf-reader (>= 1.0, < 3.0.a)
-    pdf-reader (2.4.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)
-    prawn-table (0.2.2)
-      prawn (>= 1.3.0, < 3.0.0)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rexml
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    ruby-rc4 (0.1.5)
-    simplecov (0.18.5)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    ttfunk (1.6.2.1)
-    unicode-display_width (1.6.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  byebug
-  pdf-inspector
-  prawn-markup!
-  rake
-  rspec
-  rubocop
-  simplecov
-
-BUNDLED WITH
-   1.17.3

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'prawn/markup'
-
-# 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

@@ -1,8 +0,0 @@
-#!/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