polytexnic 0.6.8 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de6a446d78432685757904722522835e26505704
-  data.tar.gz: 3a39439ee2a40bcf52f9ca967332feaa65af4941
+  metadata.gz: 0f50dc640b0a38892e9baa3045a4fee09d384b8e
+  data.tar.gz: 0a407157700ee14b3178cf40db2429aa2d5dbbce
 SHA512:
-  metadata.gz: a587872ddd1612030e5e3ccbe006daa6cf0782a07762e496858f05b556d62db003a0cec403f3239b66baa19fc533e4b44ef1b164ce1a38727142f64d6ad78661
-  data.tar.gz: 982fd0d2bcf7d04e92b69a06f805e58cf5dd321a793bb3c7eee8e8e6eb061f0a999499705ab840083b82b925d4fcb2ddb84caef0d65b1ca568a5f41ae9f991b1
+  metadata.gz: e0cd5456e8dd7e9bbb97272cce76a44d1b4030704e55256608e40dd35dc3dc7c20def048565ffe2025aa020606ccebccbbe939cf5a5a2aa90c8180389526a12e
+  data.tar.gz: d4c3ec0365163f7616e58e2c74f6fd883dc6252c489b3aa31207f23d730eb9bbb6c5ce84983b3c4f3e7392b2f835d5955d601e52b6aa22fbf6723428cb5f38ba

data/lib/polytexnic.rb

@@ -6,7 +6,6 @@ require "polytexnic/preprocessor"
 require 'tempfile'
 require 'nokogiri'
 require 'digest/sha1'
-require 'pygments'
 require 'msgpack'
 
 module Polytexnic

data/lib/polytexnic/literal.rb

@@ -3,14 +3,15 @@ module Polytexnic
     extend self
 
     # Matches the line for syntax highlighting.
-    # %= lang:<language>
-    LANG_REGEX = /^\s*%=\s+lang:\s*(\w+)/
+    # %= lang: <language>[, options: ...]
+    LANG_REGEX = /^\s*%=\s+lang:\s*(\w+)(?:,\s*options:(.*))?/
 
     # Matches the line for code inclusion.
     # %= <</path/to/code.ext
     CODE_INCLUSION_REGEX = /^\s*%=\s+<<\s*\(          # opening
-                             \s*([\w\/-]+\.?(\w*))     # path
+                             \s*([\w\/-]+\.?(\w*))    # path
                              (?:,\s*lang:\s*(\w+))?   # optional lang
+                             (,\s*options:\s*.*)?     # optional options
                              \s*\)                    # closing paren
                              /x
 
@@ -65,6 +66,7 @@ module Polytexnic
       while (line = lines.shift)
         if line =~ LANG_REGEX && !in_verbatim
           language = $1
+          highlight_options = $2
         elsif line =~ /\s*\\begin\{codelisting\}/ && !in_verbatim
           in_codelisting = true
           output << line
@@ -84,7 +86,9 @@ module Polytexnic
           filename = $1
           if File.exist?(filename)
             language = $3 || $2 || 'text'
+            highlight_options = $4
             code = ["%= lang:#{language}"]
+            code << highlight_options unless highlight_options.nil?
             code << '\begin{code}'
             code.concat(File.read($1).split("\n"))
             code << '\end{code}'
@@ -131,9 +135,9 @@ module Polytexnic
               tag = 'literal'
             else
               format = latex ? 'latex' : 'html'
-              id = "#{content}--#{language}--#{format}--#{in_codelisting}"
+              id = "#{content}--#{language}--#{format}--#{in_codelisting}--#{highlight_options}"
               key = digest(id, salt: code_salt)
-              code_cache[key] = [content, language, in_codelisting]
+              code_cache[key] = [content, language, in_codelisting, highlight_options]
               tag = 'code'
             end
             if latex || tag == 'code' || math

data/lib/polytexnic/postprocessors/polytex.rb

@@ -34,8 +34,9 @@ module Polytexnic
       # \end{code}
       # which reduces syntax highlighting to a previously solved problem.
       def write_polytex_code
-        code_cache.each do |key, (code, lang, in_codelisting)|
-          latex = "%= lang:#{lang}\n\\begin{code}\n#{code}\n\\end{code}"
+        code_cache.each do |key, (code, lang, in_codelisting, options)|
+          latex = "%= lang:#{lang}#{options}\n" +
+                  "\\begin{code}\n#{code}\n\\end{code}"
           @source.gsub!(key, latex)
         end
       end

data/lib/polytexnic/preprocessors/polytex.rb

@@ -41,6 +41,7 @@ module Polytexnic
         kramdown = Kramdown::Document.new(cleaned_markdown, latex_headers: lh)
         @source = kramdown.to_latex.tap do |polytex|
                     remove_comments(polytex)
+                    convert_includegraphics(polytex)
                     convert_tt(polytex)
                     restore_math(polytex, math_cache)
                     restore_hashed_content(polytex, cache)
@@ -134,15 +135,17 @@ module Polytexnic
               output << indentation + line
             end
             output << "\n"
-          elsif line =~ /^```(\w+)\s*$/   # syntax-highlighted code fences
+          elsif line =~ /^```(\w+)(,\s*options:.*)?$/  # highlighted fences
             language = $1
+            options  = $2
             code = []
             while (line = lines.shift) && !line.match(/^```\s*$/) do
               code << line
             end
             code = code.join("\n")
-            key = digest(code)
-            code_cache[key] = [code, language]
+            data = [code, language, false, options]
+            key = digest(data.join("--"))
+            code_cache[key] = data
             output << key
           else
             output << line
@@ -151,13 +154,13 @@ module Polytexnic
         output.join("\n")
       end
 
-      # # Removes comments.
-      # # The main reason for doing this is so that commented-out cached objects,
-      # # such as '% <hash of a code sample>', get removed.
-      # # Code like '%= lang:ruby' gets preserved.
-      # def strip_comments(text)
-      #   text.gsub!(/^%.*$/, '')
-      # end
+      # Converts \includegraphics to \image.
+      # The reason is that raw \includegraphics is almost always too wide
+      # in the PDF. Instead, we use the custom-defined \image command, which
+      # is specifically designed to fix this issue.
+      def convert_includegraphics(text)
+        text.gsub!('\includegraphics', '\image')
+      end
 
       # Converts {tt ...} to \kode{...}
       # This effectively converts `inline code`, which kramdown sets as

data/lib/polytexnic/utils.rb

@@ -88,10 +88,11 @@ module Polytexnic
       if document.is_a?(String) # LaTeX
         substitutions = {}
         document.tap do
-          code_cache.each do |key, (content, language, in_codelisting)|
-            code   = highlight(key, content, language, 'latex')
+          code_cache.each do |key, (content, language, in_codelisting, options)|
+            code   = highlight(key, content, language, 'latex', options)
             output = code.split("\n")
             horrible_backslash_kludge(add_font_info(output.first))
+            highlight_lines(output, options)
             code = output.join("\n")
             substitutions[key] = in_codelisting ? code : framed(code)
           end
@@ -101,22 +102,44 @@ module Polytexnic
         document.css('div.code').each do |code_block|
           key = code_block.content
           next unless (value = code_cache[key])
-          content, language = value
-          code_block.inner_html = highlight(key, content, language, 'html')
+          content, language, _, options = value
+          code_block.inner_html = highlight(key, content, language, 'html',
+                                            options)
         end
       end
     end
 
+    # Highlight lines (i.e., with a yellow backgroun).
+    # This is needed due to a Pygments bug that fails to highlight lines
+    # in the LaTeX output.
+    def highlight_lines(output, options)
+      highlighted_lines(options).each do |i|
+        output[i] = '\colorbox{hilightyellow}{' + output[i] + '}'
+      end
+    end
+
+    # Returns an array with the highlighted lines.
+    def highlighted_lines(options)
+      ActiveSupport::JSON.decode('{' + options.to_s + '}')['hl_lines'] || []
+    end
+
     # Puts a frame around code.
     def framed(code)
       "\\begin{framed_shaded}\n#{code}\n\\end{framed_shaded}"
     end
 
     # Highlights a code sample.
-    def highlight(key, content, language, formatter)
-      highlight_cache[key] ||= Pygments.highlight(content,
-                                                  lexer: language,
-                                                  formatter: formatter)
+    def highlight(key, content, language, formatter, options)
+      require 'pygments'
+      require 'active_support'
+      options = ActiveSupport::JSON.decode('{' + options.to_s + '}')
+      if options['linenos'] && formatter == 'html'
+        # Inline numbers look much better in HTML but are invalid in LaTeX.
+        options['linenos'] = 'inline'
+      end
+      highlight_cache[key] ||= Pygments.highlight(content, lexer: language,
+                                                           formatter: formatter,
+                                                           options: options)
     end
 
     # Adds some verbatim font info (including size).

data/lib/polytexnic/version.rb

@@ -1,3 +1,3 @@
 module Polytexnic
-  VERSION = "0.6.8"
+  VERSION = "0.6.9"
 end

data/polytexnic.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'pygments.rb', '~> 0.4.2'
   gem.add_dependency 'msgpack', '~> 0.4.2'
   gem.add_dependency 'kramdown'
+  gem.add_dependency 'active_support'
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'simplecov'

data/spec/markdown_to_polytex_spec.rb

@@ -91,8 +91,6 @@ x^2
       end
     end
 
-
-
     describe "footnotes" do
       subject do
         Polytexnic::Pipeline.new(markdown, source: :markdown).polytex
@@ -119,6 +117,24 @@ That is it.  You can keep writing your text after the footnote content.
       end
     end
 
+    describe "images" do
+      subject do
+        Polytexnic::Pipeline.new(markdown, source: :markdown).polytex
+      end
+
+      context "inclusion with a caption and a label" do
+        let(:markdown) do <<-'EOS'
+![Running the Softcover server in a separate tab.\label{fig:softcover_server}](images/figures/softcover_server.png)
+          EOS
+        end
+
+        it { should include '\caption{Running the Softcover server in a separate tab.\label{fig:softcover_server}}' }
+        it { should include '\image' }
+        it { should_not include '\includegraphics' }
+      end
+
+    end
+
     context "with LaTeX containing" do
 
       context "a normal command" do
@@ -298,9 +314,9 @@ lorem
         let(:source) { '<<(/path/to/code)' }
         it { should resemble '%= <<(/path/to/code)' }
 
-        context "with an alternate lang" do
-          let(:source) { '<<(/path/to/code.md, lang: text)' }
-          it { should resemble '%= <<(/path/to/code.md, lang: text)' }
+        context "with an alternate lang and options" do
+          let(:source) { '<<(/path/to/code.md, lang: text, options: "hl_lines": [1, 2], "linenos": true)' }
+          it { should resemble '%= <<(/path/to/code.md, lang: text, options: "hl_lines": [1, 2], "linenos": true)' }
         end
       end
 
@@ -329,9 +345,9 @@ lorem
           it { should resemble output }
         end
 
-        context "with highlighting" do
+        context "with highlighting and options" do
           let(:source) do <<-EOS
-```ruby
+```ruby, options: "hl_lines": [1, 2], "linenos": true
 def foo
   "bar"
 end
@@ -341,7 +357,7 @@ lorem
           end
 
           let(:output) do <<-'EOS'
-%= lang:ruby
+%= lang:ruby, options: "hl_lines": [1, 2], "linenos": true
 \begin{code}
 def foo
   "bar"

data/spec/to_html/codelistings_spec.rb

@@ -45,7 +45,7 @@ $ subl .gemrc
     end
 
     context "with an empty caption" do
-    let(:polytex) do <<-'EOS'
+      let(:polytex) do <<-'EOS'
         \chapter{Foo bar}
 
         \begin{codelisting}
@@ -63,6 +63,27 @@ $ subl .gemrc
       it { should     include 'Listing 1.1' }
       it { should_not include 'Listing 1.1:' }
     end
+
+    context "containing code inclusion with a hyphen" do
+      before do
+        File.write(File.join('spec', 'fixtures', 'name-with-hyphens.txt'), '')
+      end
+      after do
+        FileUtils.rm(File.join('spec', 'fixtures', 'name-with-hyphens.txt'))
+      end
+      let(:polytex) do <<-'EOS'
+  \begin{codelisting}
+  \codecaption{Foo}
+  \label{code:foo}
+  %= <<(spec/fixtures/name-with-hyphens.txt, lang: text)
+  \end{codelisting}
+        EOS
+      end
+
+      it "should not raise an error" do
+        expect { processed_text }.not_to raise_error
+      end
+    end
   end
 
   describe "metacode listings" do
@@ -87,25 +108,4 @@ $ subl .gemrc
       expect { processed_text }.not_to raise_error
     end
   end
-
-  describe "containing code inclusion with a hyphen" do
-    before do
-      File.write(File.join('spec', 'fixtures', 'name-with-hyphens.txt'), '')
-    end
-    after do
-      FileUtils.rm(File.join('spec', 'fixtures', 'name-with-hyphens.txt'))
-    end
-    let(:polytex) do <<-'EOS'
-\begin{codelisting}
-\codecaption{Foo}
-\label{code:foo}
-%= <<(spec/fixtures/name-with-hyphens.txt, lang: text)
-\end{codelisting}
-      EOS
-    end
-
-    it "should not raise an error" do
-      expect { processed_text }.not_to raise_error
-    end
-  end
 end

data/spec/to_html/literal_environments/code_spec.rb

@@ -84,6 +84,39 @@ describe Polytexnic::Pipeline do
     end
   end
 
+  context "with highlight and line numbering options" do
+    let(:polytex) do <<-'EOS'
+      %= lang:ruby, options: "hl_lines": [1, 2], "linenos": true
+      \begin{code}
+      def foo
+        "bar"
+      end
+      \end{code}
+      EOS
+    end
+
+    it do
+      should resemble <<-'EOS'
+        <div class="code">
+          <div class="highlight">
+            <pre>
+              <span class="lineno">1</span>
+              <span class="hll">
+                <span class="k">def</span> <span class="nf">foo</span>
+              </span>
+              <span class="lineno">2</span>
+              <span class="hll">
+                <span class="s2">"bar"</span>
+              </span>
+              <span class="lineno">3</span>
+              <span class="k">end</span>
+            </pre>
+          </div>
+        </div>
+      EOS
+    end
+  end
+
   describe "code inclusion" do
     context "for an existing file" do
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polytexnic
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.6.9
 platform: ruby
 authors:
 - Michael Hartl
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-28 00:00:00.000000000 Z
+date: 2013-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -67,6 +67,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -169,6 +183,8 @@ files:
 - .pull_requests/1384811507
 - .pull_requests/1385061501
 - .pull_requests/1385598040
+- .pull_requests/1385601533
+- .pull_requests/1385778060
 - .rspec
 - .ruby-gemset
 - .ruby-version