polytexnic 1.6.1 → 1.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1f2eb8f0ea1afe5f4f09645beb2d38100c9bdafc097fcd5943ac222d41fc592
-  data.tar.gz: c0ea88d4a8fbdb470be081cd446b5f3d007d37e5a1df7eec8a3197a07ecc146a
+  metadata.gz: aa4a264539262673bc0a0436583a9ce31c3fc9ecbc2ef5cc138016873676ea58
+  data.tar.gz: 53fb1e2697742893dc61a1161296c26ae6f9b0bdde33b525528f3c5385e250cf
 SHA512:
-  metadata.gz: f6bb4ddcd578b51b1683f00fcfd78325964ccc0461a46c4ac98826fc73b22912448d9ec9fc12bda4877869b755a77dcf5cc0faf828f6ebd94ea5c15e1aa04389
-  data.tar.gz: e37c38285cab036bbabe23a8444587547ea63084f0f73171887d0ad8b512983be1704d2d4efe709796b37464c9155abf1167996913c6d97d0e24bbd624c2273e
+  metadata.gz: a90cd3b66b2ead91ced4337458ec2be79fb35d7991aa66b763f5ed5db7b49145cfe7e2ecfc28050731ebf689473264374ada7b5d7f4f99690fe73cd1782add30
+  data.tar.gz: b0b90e6906c207ffb355e591e07385fb57e5b5ee7d7acae42417fe331c4046e4f3f68e12a4cd793609b5677fe050980b872686dccc682283d245ce079167e961

data/Gemfile

@@ -22,6 +22,6 @@ group :test do
 end
 
 group :development do
-  gem 'guard-rspec'
+  gem 'guard-rspec', require: false
   gem 'rake'
 end

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    polytexnic (1.6.1)
+    polytexnic (1.6.5)
       json (~> 2.3.0)
-      kramdown (>= 1.17, < 3.0)
+      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/
@@ -25,16 +25,16 @@ GEM
       debugger-linecache (~> 1.2.0)
     diff-lcs (1.4.4)
     docile (1.1.5)
-    ffi (1.13.1)
-    formatador (0.2.5)
+    ffi (1.15.3)
+    formatador (0.3.0)
     growl (1.0.3)
-    guard (2.16.2)
+    guard (2.18.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
-      pry (>= 0.9.12)
+      pry (>= 0.13.0)
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
@@ -43,37 +43,40 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     json (2.3.1)
-    kramdown (2.3.0)
+    kramdown (2.3.1)
       rexml
-    listen (3.2.1)
+    listen (3.7.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.7)
+    lumberjack (1.2.8)
     method_source (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
-    mini_portile2 (2.4.0)
+    mime-types-data (3.2021.0704)
+    mini_portile2 (2.6.1)
     msgpack (1.2.10)
     multi_json (1.15.0)
     nenv (0.3.0)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.12.3)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    nokogiri (1.12.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.4)
+    pygments.rb (2.2.0)
+    racc (1.5.2)
+    rake (13.0.6)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
       rspec-expectations (~> 2.99.0)
@@ -95,6 +98,7 @@ GEM
 
 PLATFORMS
   ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
   coveralls
@@ -107,4 +111,4 @@ DEPENDENCIES
   simplecov (~> 0.15.1)
 
 BUNDLED WITH
-   2.1.4
+   2.2.13

data/Guardfile

@@ -1,15 +1,10 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
 
-guard :rspec do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { "spec" }
-  ## Uncomment & edit below (and comment out above) to watch particular specs.
-  # watch(%r{^lib/(.+)\.rb$}) do
-  #   [
-  #     "spec/to_html/asides_spec.rb",
-  #     "spec/to_html/codelistings_spec.rb"
-  #   ]
-  # end
   watch('spec/spec_helper.rb')  { "spec" }
 end

data/bin/polytexnic

@@ -40,23 +40,26 @@ end.parse!
 # Returns the file format based on extension.
 # Should be 'html' or 'tex'.
 def format(filename)
-  puts '***********'
-  puts '***********'
-  puts '***********'
-  puts '***********'
-  puts '***********'
-  p filename.split('.')
   filename.split('.').last
 rescue
   nil
 end
 
-puts '$$$$$$$$$$$'
-puts '$$$$$$$$$$$'
-puts '$$$$$$$$$$$'
-puts '$$$$$$$$$$$'
-puts '$$$$$$$$$$$'
-p options
+# 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 (infile = options[:infile] || ARGV.shift)
 puts infile
   input = File.read(infile)
@@ -68,7 +71,7 @@ puts outfile
 pipeline = Polytexnic::Pipeline.new(input, article: true)
 format   = options[:format] || format(outfile) || "html"
 if format == "html"
-  output = pipeline.to_html
+  output = html_template("HTML output", pipeline.to_html)
 elsif format == "tex"
   output = pipeline.to_polytex
 else

data/lib/polytexnic/literal.rb

@@ -209,6 +209,7 @@ module Polytexnic
     # For completeness, we handle the case where the author neglects to
     # use the nonbreak space ~.
     def hyperrefs(string)
+      part     = language_labels["part"]
       chapter  = language_labels["chapter"]["word"]
       section  = language_labels["section"]
       table    = language_labels["table"]
@@ -218,7 +219,7 @@ module Polytexnic
       listing  = language_labels["listing"]
       equation = language_labels["equation"]
       eq       = language_labels["eq"]
-      linked_item = "(#{chapter}|#{section}|#{table}|#{box}|#{figure}" +
+      linked_item = "(#{part}|#{chapter}|#{section}|#{table}|#{box}|#{figure}" +
                     "|#{fig}\.|#{listing}|#{equation}|#{eq}\.)"
       ref = /(?:#{linked_item}(~| ))*(\\(?:eq)*ref){(.*?)}/i
       string.gsub!(ref) do

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.6.1"
+  VERSION = "1.6.5"
 end

data/lib/polytexnic.rb

@@ -54,7 +54,7 @@ module Polytexnic
                           else
                             default_language_labels.merge(labels)
                           end
-      tempdir = 'tmp'                          
+      tempdir = 'tmp'
       FileUtils.mkdir(tempdir) unless File.directory?(tempdir)
       @highlight_cache_filename = File.join(tempdir, '.highlight_cache')
       if File.exist?(@highlight_cache_filename)
@@ -109,7 +109,7 @@ module Polytexnic
 
       # Returns the default labels for 'Chapter', 'Figure', etc.
       def default_language_labels
-        {"chapter"=>{"word"=>"Chapter", "order"=>"standard"},
+        {"part"=>"Part","chapter"=>{"word"=>"Chapter", "order"=>"standard"},
         "section"=>"Section", "table"=>"Table", "figure"=>"Figure",
         "fig"=>"Fig", "aside"=>"Box", "listing"=>"Listing",
         "equation"=>"Equation", "eq"=>"Eq", "frontmatter"=>"Frontmatter",

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', '< 3.0'
+  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/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_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!"
@@ -149,11 +149,17 @@ end
 
     describe "hyperref links" do
       let(:polytex) do <<-'EOS'
-        Chapter~\ref{cha:foo}
+        Part~\ref{prt:foo}
+        Chapter~\ref{cha:bar}
+        Section~\ref{sec:baz}
         EOS
       end
-      let(:output) { '\hyperref[cha:foo]{Chapter~\ref{cha:foo}' }
-      it { should resemble output }
+      let(:part_ref)    { '\hyperref[prt:foo]{Part~\ref{prt:foo}' }
+      let(:chapter_ref) { '\hyperref[cha:bar]{Chapter~\ref{cha:bar}' }
+      let(:section_ref) { '\hyperref[sec:baz]{Section~\ref{sec:baz}' }
+      it { should resemble part_ref }
+      it { should resemble chapter_ref }
+      it { should resemble section_ref }
     end
 
     describe "asides" do
@@ -262,4 +268,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.6.1
+  version: 1.6.5
 platform: ruby
 authors:
 - Michael Hartl
@@ -9,36 +9,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-08-24 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
@@ -59,7 +65,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -69,7 +75,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -283,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: {}
@@ -302,7 +308,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Convert from PolyTeX & Markdown to HTML & LaTeX