polites 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77e4ea7f1cdb7f6e662789c3c9a827d7cf1102794bbec1f487a327f6cafaff8c
-  data.tar.gz: 4ee0bd4606a2927e6a26face3b4e2decff2321b2ee6f1c7042bc4dea9f97bfc6
+  metadata.gz: da4fa3832c34102ae4f89153c51ba51052f7796294a83aa483047f00f404134f
+  data.tar.gz: cc046426373c0a37271b3e26d3677ccec42f69916df108dcb033da6d71fb7629
 SHA512:
-  metadata.gz: 4fb4491992bab118a0eb70282da7dda3835fce131f8d68b47a945afda47ff71411c0047ad1ce21810be18730082204daf328f07448a0da536cefe7de230fe219
-  data.tar.gz: a2e1c92b1fdcea5d02203e001564acc528605ca86b6813619522a0d01528af1552e13c7a702f7e677aa45a9559b5c9142fc61a58b51cdbcd59d698c94abd305e
+  metadata.gz: d07b0f5a9c11401c5bddab7bd82d253d8b75fae5fd40922a25a62f46a3421170a1a6421613ca32253f1e72d1b1b9d51c26e3d3607dcd4cef66872412b1f63a18
+  data.tar.gz: ac8ffa27cafcf07bb45eea77f51282c41b587bceb9eaf8021c91a9bca4958ee79ac2e0c6706268256e6b5f3a36c54d060bc9aee6cd27815f06b52af86ad94b0e

data/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+---
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake

data/.yardopts

@@ -1 +1 @@
---no-private lib/**/*.rb --readme README.md --markup markdown --markup-provider kramdown - LICENSE.txt CODE_OF_CONDUCT.md
+--no-private lib/**/*.rb --readme README.md --markup markdown --markup-provider kramdown - LICENSE.txt CODE_OF_CONDUCT.md CHANGELOG.md

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.3.0 - 2020-12-24
+
+- Collapse multiple consecutive code blocks into a single code block
+- Escape HTML entities in code blocks
+
 ## 0.2.0 - 2020-11-30
 
 - Fixed requirement of polites files in polites-nanoc

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    polites (0.2.0)
+    polites (0.3.0)
       nokogiri
       rubyzip
-    polites-nanoc (0.2.0)
+    polites-nanoc (0.3.0)
       nanoc (~> 4)
-      polites (~> 0.2.0)
+      polites (~> 0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -4,6 +4,8 @@ Polites allows you to work with files generated by the [Ulysses](https://ulysses
 
 Most importantly, this gem allows you to take Ulysses .ulyz files as input and transform them into HTML, all from Ruby. Additionally, you can extract embedded media files from the .ulyz file.
 
+See the [API docs](https://rubydoc.info/gems/polites).
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/polites/code_grouper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Polites
+  # Take a list of items and collapse a collection of subsequent code blocks
+  # into a single one separated by newlines.
+  class CodeGrouper
+    # @param [Array<Polites::Node>] items
+    # @return [Array<Polites::Node>]
+    def call(items)
+      items
+        .chunk { |i| i.is_a?(Block::CodeBlock) }.to_a
+        .inject([]) do |acc, (k, contents)|
+        acc + (k ? [combine(contents)] : contents)
+      end
+    end
+
+    private
+
+    def combine(items)
+      Block::CodeBlock.new(
+        items
+          .inject([]) { |acc, item| acc + item.children + [Text.new("\n")] }
+          .slice(0..-2),
+        items.first.syntax
+      )
+    end
+  end
+end

data/lib/polites/html_formatter.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require 'cgi'
+
 require_relative './block'
 require_relative './span'
 require_relative './text'
 require_relative './sheet'
 require_relative './list_indenter'
+require_relative './code_grouper'
 
 module Polites
   # Takes an AST as produced by {Parser} and generates HTML output from it.
@@ -16,6 +19,7 @@ module Polites
     def initialize
       @footnotes = []
       @indenter = ListIndenter.new
+      @code_grouper = CodeGrouper.new
     end
 
     # Apply formatting to the given AST.
@@ -38,7 +42,7 @@ module Polites
                    end
         nl + tag(tag_name, NL + call(obj.children, join: NL) + NL) + nl
       when Array
-        coll = indent ? @indenter.call(obj) : obj
+        coll = indent ? @code_grouper.call(@indenter.call(obj)) : obj
         coll.map { |c| call(c) }.join(join)
       when Block::UnorderedList, Block::OrderedList
         tag(:li, call(obj.children))
@@ -59,7 +63,7 @@ module Polites
       when Block::Blockquote
         tag(:blockquote, tag(:p, call(obj.children)))
       when Block::CodeBlock
-        tag(:pre, tag(:code, call(obj.children), class: "language-#{obj.syntax}"))
+        tag(:pre, tag(:code, CGI.escape_html(call(obj.children)), class: "language-#{obj.syntax}"))
       when Block::Divider
         tag(:hr)
       when Span::Strong

data/lib/polites/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Polites
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polites
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Arjan van der Gaag
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 2020-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -47,11 +47,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".tool-versions"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -80,6 +80,7 @@ files:
 - lib/polites/block/paragraph.rb
 - lib/polites/block/unordered_list.rb
 - lib/polites/cli.rb
+- lib/polites/code_grouper.rb
 - lib/polites/convert.rb
 - lib/polites/doc/_index.html
 - lib/polites/doc/class_list.html

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.2
-before_install: gem install bundler -v 2.1.4