polytexnic 1.5.16 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 366c5378205e1d46c56fd6c6e7cf506fa2b2937ebded2743a60e0af437e51259
-  data.tar.gz: 47bc5e5e8a67b75ec4bc183830083893be0c38c25ec627bee9aeec690ebfac8a
+  metadata.gz: 6d7799a38185640239ca691d3139570d4abbb14a35fbf9c900946bff62cc41eb
+  data.tar.gz: 513c2c37e46535fd6abdd66448f6593daee2329be52c4768146205d74c0f17e6
 SHA512:
-  metadata.gz: 5cd4a0ee09c5d5b5940d841ad38188b48a1c980dc3639c1a8c375349a18bfe2c7277e603ada6c7fd7be0435c987c44a91b80780ba562df8e4e2d5ae0424af74c
-  data.tar.gz: 0d5943cea55ffa09f092e0f3b13c030abe716a3d1eaaf177ed577c99a6ff3811e65b7d32ae1deeb4068835f9073360cae0ed32e1e846a42d0b65a078c215456b
+  metadata.gz: 79102ce8772b68e4a4d25a3b7ff3db533f06fff37804ba87ec347a5be785d5a290731232aa94849b17e725080f84863b1108a218550e70fffea224b2163993e4
+  data.tar.gz: 4f0dc0d6b4d507bdab09071011f3168043d27627fdbe030d6ad2046531d8a6b544284f7aede474d6c13dd0bd4a91b02a77bc7c4427348eebed0669e56d0f9987

data/Gemfile

@@ -24,4 +24,4 @@ end
 group :development do
   gem 'guard-rspec'
   gem 'rake'
-end
+end

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    polytexnic (1.5.16)
+    polytexnic (1.6.4)
       json (~> 2.3.0)
-      kramdown (~> 1.17)
+      kramdown (>= 2.0, < 3.0)
       msgpack (~> 1.2.0)
-      nokogiri (~> 1.10.8)
-      pygments.rb (~> 1.2.1)
+      nokogiri (>= 1.6.0, < 2.0)
+      pygments.rb (~> 2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
+    coderay (1.1.3)
     columnize (0.9.0)
     coveralls (0.7.2)
       multi_json (~> 1.3)
@@ -23,9 +23,9 @@ GEM
     debugger2 (1.0.0.beta2)
       columnize (>= 0.3.1)
       debugger-linecache (~> 1.2.0)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     docile (1.1.5)
-    ffi (1.12.2)
+    ffi (1.15.0)
     formatador (0.2.5)
     growl (1.0.3)
     guard (2.16.2)
@@ -42,36 +42,37 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    json (2.3.0)
-    kramdown (1.17.0)
-    listen (3.2.1)
+    json (2.3.1)
+    kramdown (2.3.1)
+      rexml
+    listen (3.5.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.4)
+    lumberjack (1.2.8)
     method_source (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
-    mini_portile2 (2.4.0)
+    mime-types-data (3.2021.0225)
     msgpack (1.2.10)
-    multi_json (1.14.1)
+    multi_json (1.15.0)
     nenv (0.3.0)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.11.3-x86_64-darwin)
+      racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pygments.rb (1.2.1)
-      multi_json (>= 1.0.0)
-    rake (13.0.1)
-    rb-fsevent (0.10.3)
+    pygments.rb (2.2.0)
+    racc (1.5.2)
+    rake (13.0.3)
+    rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rest-client (1.6.7)
       mime-types (>= 1.16)
+    rexml (3.2.5)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
       rspec-expectations (~> 2.99.0)
@@ -92,7 +93,7 @@ GEM
     tins (0.13.2)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
   coveralls
@@ -105,4 +106,4 @@ DEPENDENCIES
   simplecov (~> 0.15.1)
 
 BUNDLED WITH
-   2.1.4
+   2.2.13

data/bin/polytexnic

@@ -1,19 +1,84 @@
 #!/usr/bin/env ruby
 require "polytexnic"
+require 'optparse'
+require 'fileutils'
 
-def latex_to_html(latex)
-  Polytexnic::Pipeline.new(latex, article: true).to_html
+# polytexnic command-line script
+# The polytexnic script converts Markdown to HTML or LaTeX
+# using the PolyTeXnic HTML pipeline.
+
+examples = %(
+The polytexnic script converts Markdown to HTML or LaTeX
+using the PolyTeXnic HTML pipeline.
+
+Examples:
+    polytexnic example.md example.html
+    polytexnic example.md > example.html
+    polytexnic < example.md > example.html
+    cat example.md | polytexnic > example.html
+    polytexnic -i example.md > example.html
+    polytexnic -i example.md -o example.tex
+    polytexnic -f tex example.md)
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: polytexnic [options]\n#{examples}\n\n"
+
+  opts.on("-i", "--input=INPUT", "Use file input") do |infile|
+    options[:infile] = infile
+  end
+
+  opts.on("-o", "--output=OUTPUT", "Use file output") do |outfile|
+    options[:outfile] = outfile
+  end
+
+  opts.on("-f", "--format", "Use output format [html, tex]") do |format|
+    options[:format] = format
+  end
+end.parse!
+
+# Returns the file format based on extension.
+# Should be 'html' or 'tex'.
+def format(filename)
+  filename.split('.').last
+rescue
+  nil
+end
+
+# Defines a valid HTML template.
+def html_template(title, body)
+%(<!DOCTYPE html>
+<html>
+  <head>
+    <title>#{title}</title>
+    <meta charset="utf-8">
+  </head>
+  <body>
+    #{body}
+  </body>
+</html>
+)
 end
 
-if ARGV.empty?
-  puts latex_to_html(STDIN.read)
+if (infile = options[:infile] || ARGV.shift)
+puts infile
+  input = File.read(infile)
 else
-  filename = ARGV.shift
-  latex = File.read(filename)
-  html  = latex_to_html(latex)
-  if (outfile = ARGV.shift)
-    File.write(outfile, html)
-  else
-    puts html.strip
-  end
+  input = STDIN.read
+end
+outfile  = options[:outfile] || ARGV.shift
+puts outfile
+pipeline = Polytexnic::Pipeline.new(input, article: true)
+format   = options[:format] || format(outfile) || "html"
+if format == "html"
+  output = html_template("HTML output", pipeline.to_html)
+elsif format == "tex"
+  output = pipeline.to_polytex
+else
+  raise ArgumentError, "Invalid format: #{format}"
+end
+if outfile
+  File.write(outfile, output)
+else
+  puts output.strip
 end

data/lib/polytexnic/postprocessors/html.rb

@@ -95,7 +95,7 @@ module Polytexnic
         def small_caps(doc)
           doc.xpath('//hi[@rend="sc"]').each do |node|
             node.name = 'span'
-            node['class'] = 'sc'
+            node['class'] = 'smallcaps'
             node.remove_attribute('rend')
           end
         end

data/lib/polytexnic/preprocessors/html.rb

@@ -140,7 +140,7 @@ module Polytexnic
         # Removes commented-out lines.
         # Contents of the special sequence `%=` are converted to literal HTML.
         def remove_comments(output)
-          output.gsub!(/[^\\]%[^=].*$/, '')
+          output.gsub!(/([^\\])(%[^=].*$)/, '\1')
           output.gsub!(/[^\\]%=(.*)$/) do
             key = digest($1)
             literal_html_cache[key] = $1

data/lib/polytexnic/utils.rb

@@ -206,9 +206,17 @@ module Polytexnic
         # Inline numbers look much better in HTML but are invalid in LaTeX.
         options['linenos'] = 'inline'
       end
-      highlight_cache[key] ||= Pygments.highlight(content, lexer: language,
+      if (lines = options['hl_lines'])
+        content_lines = content.split("\n")
+        if lines.max > content_lines.length
+          err  = "\nHighlight line(s) out of range: #{lines.inspect}\n"
+          err += content
+          raise err
+        end
+      end
+      highlight_cache[key] ||= Pygments.highlight(content, lexer:     language,
                                                            formatter: formatter,
-                                                           options: options)
+                                                           options:   options)
     end
 
     # Adds some verbatim font info (including size).

data/lib/polytexnic/version.rb

@@ -1,3 +1,3 @@
 module Polytexnic
-  VERSION = "1.5.16"
+  VERSION = "1.6.4"
 end

data/polytexnic.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["michael@softcover.io"]
   gem.description   = %q{Core translation engine for the softcover gem}
   gem.summary       = %q{Convert from PolyTeX & Markdown to HTML & LaTeX}
-  gem.homepage      = "https://polytexnic.org/"
+  gem.homepage      = "https://github.com/softcover/polytexnic"
   gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($/)
@@ -18,10 +18,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'nokogiri', '~> 1.10.8'
-  gem.add_dependency 'pygments.rb', '~> 1.2.1'
+  gem.add_dependency 'nokogiri', '>= 1.6.0', '< 2.0'
+  gem.add_dependency 'pygments.rb', '~> 2.1'
   gem.add_dependency 'msgpack', '~> 1.2.0'
-  gem.add_dependency 'kramdown', '~> 1.17'
+  gem.add_dependency 'kramdown', '>= 2.0', '< 3.0'
   gem.add_dependency 'json', '~> 2.3.0'
 
   gem.add_development_dependency 'rspec', '~> 2.14'

data/spec/to_html/core_spec.rb

@@ -9,6 +9,15 @@ describe 'Polytexnic::Pipeline#to_html' do
     let(:polytex) { "% A LaTeX comment" }
     it { should eq '' }
 
+    context "occurring a the end of a line" do
+      let(:polytex) do <<-'EOS'
+        lorem ipsum
+        dolor sit amet.%this is a comment
+        EOS
+      end
+      it { should include("amet.") }
+    end
+
     context "with a section and label" do
       let(:polytex) do <<-'EOS'
         % \section{Foo}

data/spec/to_html/literal_environments/code_spec.rb

@@ -98,7 +98,7 @@ describe Polytexnic::Pipeline do
         <div class="code">
           <div class="highlight">
             <pre>
-              <span></span>            
+              <span></span>
               <span class="k">def</span> <span class="nf">foo</span>
               <span class="s2">"bar"</span>
               <span class="k">end</span>
@@ -126,15 +126,15 @@ describe Polytexnic::Pipeline do
           <div class="highlight">
             <pre>
               <span></span>
-              <span class="lineno">1</span>
               <span class="hll">
+              <span class="linenos">1</span>
                 <span class="k">def</span> <span class="nf">foo</span>
               </span>
-              <span class="lineno">2</span>
               <span class="hll">
+              <span class="linenos">2</span>
                 <span class="s2">"bar"</span>
               </span>
-              <span class="lineno">3</span>
+              <span class="linenos">3</span>
               <span class="k">end</span>
             </pre>
           </div>
@@ -143,9 +143,25 @@ describe Polytexnic::Pipeline do
     end
   end
 
+  context "when highlighting HTML" do
+    let(:polytex) do <<-'EOS'
+      %= lang:html, options: "hl_lines": [3], "linenos": true
+      \begin{code}
+      ---
+      layout: default
+      title: Gallery for Learn Enough JavaScript to Be Dangerous
+      ---
+
+      <div class="gallery col-three">
+        <div class="col col-nav gallery-thumbs" id="gallery-thumbs">
+      \end{code}
+    end
+    it should include('class="linenos"')
+  end
+
   context "with highlight line out of range" do
     let(:polytex) do <<-'EOS'
-      %= lang:ruby, options: "hl_lines": [17], "linenos": true
+      %= lang:ruby, options: "hl_lines": [4], "linenos": true
       \begin{code}
       def foo
         "bar"
@@ -155,7 +171,7 @@ describe Polytexnic::Pipeline do
     end
 
     it "should emit a warning" do
-
+      expect { processed_text }.to raise_error
     end
   end
 
@@ -238,7 +254,7 @@ describe Polytexnic::Pipeline do
 
       context "with custom options" do
         let(:polytex) do <<-'EOS'
-          %= <<(polytexnic_commands.sty, lang: tex, options: "hl_lines": [5])
+          %= <<(polytexnic_commands.sty, lang: tex, options: "hl_lines": [1])
           EOS
         end
         let(:output) do <<-'EOS'
@@ -377,7 +393,17 @@ describe Polytexnic::Pipeline do
 
           context "with repo, tag, lang and options" do
             let(:polytex) do <<-'EOS'
-              %= <<(tagged_file.rb, git: {tag: v0.9.4, repo:"repo_path/.git"}, lang: tex, options: "hl_lines": [5])
+              %= <<(tagged_file.rb, git: {tag: v0.9.4, repo:"repo_path/.git"}, lang: tex, options: "hl_lines": [2])
+              EOS
+            end
+            let(:output) do <<-'EOS'
+              <div class="code">
+                <div class="highlight">
+                  <pre><span></span>Fake data
+                  <span class="hll">second line
+                  </span></pre>
+                </div>
+              </div>
               EOS
             end
             it_behaves_like "an inclusion"

data/spec/to_html/text_formatting_spec.rb

@@ -29,7 +29,7 @@ describe 'Polytexnic::Pipeline#to_html' do
 
     describe "small caps" do
       let(:polytex) { '\textsc{small caps}' }
-      it { should resemble '<span class="sc">small caps</span>' }
+      it { should resemble '<span class="smallcaps">small caps</span>' }
     end
 
     describe "small text" do

data/spec/to_latex_spec.rb

@@ -29,7 +29,7 @@ Make a code listing as in Listing~\ref{code:hello}.
 \begin{codelisting}
 \label{code:hello}
 \codecaption{A hello program in Ruby.}
-%= lang:ruby, options: "hl_lines": [17]
+%= lang:ruby, options: "hl_lines": [2]
 \begin{code}
 def hello
   "hello, world!"
@@ -262,4 +262,4 @@ end
       it { should_not include 'xmlelement' }
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polytexnic
 version: !ruby/object:Gem::Version
-  version: 1.5.16
+  version: 1.6.4
 platform: ruby
 authors:
 - Michael Hartl
@@ -9,36 +9,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2021-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.10.8
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.10.8
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pygments.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
@@ -57,16 +63,22 @@ dependencies:
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -277,7 +289,7 @@ files:
 - tasks/bin/ruby_tests
 - tasks/run_tests_with_both_rubies.rake
 - tmp/.gitkeep
-homepage: https://polytexnic.org/
+homepage: https://github.com/softcover/polytexnic
 licenses:
 - MIT
 metadata: {}