polytexnic 0.6.11 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57bbac0600d61db44cc14762bacc2a24594ab2c9
-  data.tar.gz: fa73a4ee9071da8a1cd15c8bdc8224fd40368cee
+  metadata.gz: 6fefdba29706e24a266960f6a454f31341a88d94
+  data.tar.gz: 88c02fe48f01aa19d3ec84d18e3b4096a409fcc3
 SHA512:
-  metadata.gz: 1e8b902671181b3e01162ee6aa1a6f8882e1b72d02364c33854b97922803771d1e23d0e9137adc3f5a743fa8c9694601afa916ba20a5d673d0c7b3a839ba8960
-  data.tar.gz: 1e7f38cb586cce81529f9d3b29a5c732ad3176afa4bda9a56b834a0abcafc463e966173c0391de26cd31a69f70d87d9bc490357bab03d47091784e34de3ef69f
+  metadata.gz: d2f68541b94dda5f0a717bf6adeeb1df7d3ac2ff8a8908c1a0096eb126f5743e2e6e0f67b3654cbb685a3731089017e76f5221c4ccee15025b9354b904b073af
+  data.tar.gz: 10d075f42e1f407d3f7dda9843d16db013b267bad1e892c89831ce0d81ee554f5680124fc722466cbae783d21e2bd768ed0464e903065a6a6f3c14c84bf80afa

data/.gitignore

@@ -35,3 +35,4 @@ log
 .DS_Store
 .api_token
 .project_id
+.ruby-*

data/lib/polytexnic/literal.rb

@@ -9,7 +9,7 @@ module Polytexnic
     # Matches the line for code inclusion.
     # %= <</path/to/code.ext
     CODE_INCLUSION_REGEX = /^\s*%=\s+<<\s*\(          # opening
-                             \s*([\w\/-]+\.?(\w*))    # path
+                             \s*([^\s]+)              # path to file
                              (?:,\s*lang:\s*(\w+))?   # optional lang
                              (,\s*options:\s*.*)?     # optional options
                              \s*\)                    # closing paren
@@ -83,13 +83,14 @@ module Polytexnic
           # <content of file.rb>
           # \end{code}
           # and then prepend the code to the current `lines` array.
-          filename = $1
+          filename, custom_language, highlight_options = $1, $2, $3
+          extension_array = File.extname(filename).scan(/\.(.*)/).first
+          lang_from_extension = extension_array.nil? ? nil : extension_array[0]
           if File.exist?(filename)
-            language = $3 || $2 || 'text'
-            highlight_options = $4
+            language = custom_language || lang_from_extension || 'text'
             code = ["%= lang:#{language}#{highlight_options}"]
             code << '\begin{code}'
-            code.concat(File.read($1).split("\n"))
+            code.concat(File.read(filename).split("\n"))
             code << '\end{code}'
             lines.unshift(*code)
           else

data/lib/polytexnic/postprocessors/html.rb

@@ -425,10 +425,12 @@ module Polytexnic
 
         # Returns the node for a list item (li).
         def item(doc)
+          doc.xpath('//item/p[@noindent="true"]').each do |node|
+            node.replace(node.inner_html)
+          end
           doc.xpath('//item').each do |node|
             clean_node node, %w{id-text id label}
             node.name = 'li'
-            node.inner_html = node.at_css('p').inner_html
           end
         end
 
@@ -842,7 +844,7 @@ module Polytexnic
         def hrefs(doc)
           doc.xpath('//xref').each do |node|
             node.name = 'a'
-            node['href'] = literal_cache[node['url']]
+            node['href'] = unescape_underscores(literal_cache[node['url']])
             # Put a class on hrefs containing TeX to allow a style override.
             node.traverse do |descendant|
               if descendant['class'] == 'texhtml'
@@ -854,6 +856,11 @@ module Polytexnic
           end
         end
 
+        # Unescapes underscores, which are escaped by kramdown.
+        def unescape_underscores(url)
+          url.gsub(/\\_/, '_')
+        end
+
         # Handles both \includegraphics and figure environments.
         # The unified treatment comes from Tralics using the <figure> tag
         # in both cases.

data/lib/polytexnic/preprocessors/polytex.rb

@@ -32,6 +32,7 @@ module Polytexnic
           convert_code_inclusion(markdown, cache)
           cache_latex_literal(markdown, cache)
           cache_raw_latex(markdown, cache)
+          cache_image_locations(markdown, cache)
           puts markdown if debug?
           cache_math(markdown, math_cache)
         end
@@ -39,6 +40,9 @@ module Polytexnic
         # Override the header ordering, which starts with 'section' by default.
         lh = 'chapter,section,subsection,subsubsection,paragraph,subparagraph'
         kramdown = Kramdown::Document.new(cleaned_markdown, latex_headers: lh)
+        puts kramdown.inspect if debug?
+        puts kramdown.to_html if debug?
+        puts kramdown.to_latex if debug?
         @source = kramdown.to_latex.tap do |polytex|
                     remove_comments(polytex)
                     convert_includegraphics(polytex)
@@ -75,7 +79,7 @@ module Polytexnic
       # Caches raw LaTeX commands to be passed through the pipeline.
       def cache_raw_latex(markdown, cache)
         command_regex = /(
-                          ^\s*\\\w+.*\}[ \t]*$ # Command on line with arg
+                          ^[ \t]*\\\w+.*\}[ \t]*$ # Command on line with arg
                           |
                           ~\\ref\{.*?\}     # reference with a tie
                           |
@@ -90,6 +94,7 @@ module Polytexnic
                         /x
         markdown.gsub!(command_regex) do
           content = $1
+          puts content.inspect if debug?
           key = digest(content)
           cache[key] = content
 
@@ -102,6 +107,18 @@ module Polytexnic
         end
       end
 
+      # Caches the locations of images to be passed through the pipeline.
+      # This works around a Kramdown bug, which fails to convert images
+      # properly when their location includes a URL.
+      def cache_image_locations(text, cache)
+        # Matches '![Image caption](/path/to/image)'
+        text.gsub!(/^\s*(!\[.*?\])\((.*?)\)/) do
+          key = digest($2)
+          cache[key] = $2
+          "\n#{$1}(#{key})"
+        end
+      end
+
       # Restores raw code from the cache
       def restore_hashed_content(text, cache)
         cache.each do |key, value|

data/lib/polytexnic/version.rb

@@ -1,3 +1,3 @@
 module Polytexnic
-  VERSION = "0.6.11"
+  VERSION = "0.7.0"
 end

data/polytexnic.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'nokogiri', '~> 1.5.0'
+  gem.add_dependency 'nokogiri', '~> 1.6.0'
   gem.add_dependency 'pygments.rb', '~> 0.4.2'
   gem.add_dependency 'msgpack', '~> 0.4.2'
   gem.add_dependency 'kramdown'

data/spec/markdown_to_polytex_spec.rb

@@ -35,12 +35,9 @@ Lorem ipsum
     end
 
     describe "with math" do
-      subject do
-        Polytexnic::Pipeline.new(markdown, source: :markdown).polytex
-      end
 
       context "inline math" do
-        let(:markdown) do <<-'EOS'
+        let(:source) do <<-'EOS'
 This is inline math: {$$} x^2 {/$$}.
           EOS
         end
@@ -49,7 +46,7 @@ This is inline math: {$$} x^2 {/$$}.
       end
 
       context "block math" do
-        let(:markdown) do <<-'EOS'
+        let(:source) do <<-'EOS'
 This is block math:
 {$$}
 x^2
@@ -59,9 +56,27 @@ x^2
 
         it { should resemble '\[ x^2 \]' }
       end
+    end
 
-      describe "tables" do
-        let(:markdown) do <<-'EOS'
+    context "asides with internal lists" do
+      let(:source) do <<-'EOS'
+\begin{aside}
+\label{aside:softcover_uses}
+\heading{How to use Softcover}
+
+* Producing ebooks with `softcover` and giving them away
+* Producing ebooks with `softcover` and selling them from your own website
+
+\end{aside}
+
+        EOS
+      end
+      it { should include '\begin{aside}' }
+      it { should_not include "\\end{aside}\n\\end{itemize}" }
+    end
+
+    describe "tables" do
+      let(:source) do <<-'EOS'
 \begin{table}
 
 |**option**|**size**|**actual size**|
@@ -83,12 +98,11 @@ x^2
 \caption{A caption.}
 \end{table}
 
-          EOS
-        end
-        it { should include '\begin{table}' }
-        it { should include '\begin{longtable}' }
-        it { should_not include '\textbar' }
+        EOS
       end
+      it { should include '\begin{table}' }
+      it { should include '\begin{longtable}' }
+      it { should_not include '\textbar' }
     end
 
     describe "footnotes" do
@@ -122,7 +136,7 @@ That is it.  You can keep writing your text after the footnote content.
         Polytexnic::Pipeline.new(markdown, source: :markdown).polytex
       end
 
-      context "inclusion with a caption and a label" do
+      context "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
@@ -133,6 +147,22 @@ That is it.  You can keep writing your text after the footnote content.
         it { should_not include '\includegraphics' }
       end
 
+      context "using an example that failed" do
+        let(:markdown) do <<-'EOS'
+a screenshot from [Lowdown](http://lowdownapp.com/), a web
+application that developers use for organizing user stories.
+
+![Lowdown for user stories](https://tutorials.railsapps.org/assets/learn-rails-lowdown-partial.png)
+
+Just like Rails provides a structure for building a web application,
+user stories provide a structure for organizing your product plan.
+          EOS
+        end
+
+        it { should include '\caption{Lowdown for user stories}' }
+        it { should include '\image{https://tutorials.railsapps.org' }
+      end
+
     end
 
     context "with LaTeX containing" do

data/spec/to_html/codelistings_spec.rb

@@ -64,18 +64,19 @@ $ subl .gemrc
       it { should_not include 'Listing 1.1:' }
     end
 
-    context "containing code inclusion with a hyphen" do
+    context "containing code inclusion with a hyphen and a leading dot" do
+      let(:filename) { '.name-with-hyphens.txt' }
       before do
-        File.write(File.join('spec', 'fixtures', 'name-with-hyphens.txt'), '')
+        File.write(File.join('spec', 'fixtures', filename), '')
       end
       after do
-        FileUtils.rm(File.join('spec', 'fixtures', 'name-with-hyphens.txt'))
+        FileUtils.rm(File.join('spec', 'fixtures', filename))
       end
       let(:polytex) do <<-'EOS'
   \begin{codelisting}
   \codecaption{Foo}
   \label{code:foo}
-  %= <<(spec/fixtures/name-with-hyphens.txt, lang: text)
+  %= <<(spec/fixtures/.name-with-hyphens.txt, lang: text)
   \end{codelisting}
         EOS
       end

data/spec/to_html/core_spec.rb

@@ -185,6 +185,11 @@ describe 'Polytexnic::Pipeline#to_html' do
       let(:output) { '<a href="http://example.com/" class="tex">' }
       it { should resemble output }
     end
+
+    context "URL containing escaped text" do
+      let(:polytex) { '\href{http://example.com/escaped\_text}{Example Site}' }
+      it { should include '<a href="http://example.com/escaped_text">Example Site</a>' }
+    end
   end
 
   describe "centering" do

data/spec/to_html/lists_spec.rb

@@ -61,7 +61,7 @@ describe 'Polytexnic::Pipeline#to_html' do
       end
     end
 
-    context "afollowed by text" do
+    context "followed by text" do
       let(:polytex) do <<-'EOS'
         \begin{itemize}
         \item Foo
@@ -81,6 +81,44 @@ describe 'Polytexnic::Pipeline#to_html' do
         EOS
       end
     end
+
+    context "nested" do
+      let(:polytex) do <<-'EOS'
+\begin{itemize}
+\item foo
+
+
+\begin{itemize}
+\item bar
+\item baz
+\end{itemize}
+\item quux
+
+
+\begin{itemize}
+\item dude
+\end{itemize}
+\end{itemize}
+        EOS
+      end
+      it do
+       should resemble <<-'EOS'
+<ul>
+  <li>foo
+    <ul>
+      <li>bar</li>
+      <li>baz</li>
+    </ul>
+  </li>
+  <li>quux
+    <ul>
+      <li>dude</li>
+    </ul>
+  </li>
+</ul>
+        EOS
+      end
+    end
   end
 
   describe "enumerated list" do

data/spec/to_html/literal_environments/code_spec.rb

@@ -126,11 +126,7 @@ describe Polytexnic::Pipeline do
           %= <<(Rakefile)
           EOS
         end
-        let(:output) do <<-'EOS'
-          <span class="n">require</span>
-          EOS
-        end
-        it { should resemble output }
+        it { should include '<pre>require' }
       end
 
       context "with an extension" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polytexnic
 version: !ruby/object:Gem::Version
-  version: 0.6.11
+  version: 0.7.0
 platform: ruby
 authors:
 - Michael Hartl
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-30 00:00:00.000000000 Z
+date: 2013-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: pygments.rb
   requirement: !ruby/object:Gem::Requirement
@@ -185,9 +185,12 @@ files:
 - .pull_requests/1385598040
 - .pull_requests/1385601533
 - .pull_requests/1385778060
+- .pull_requests/1385928695
+- .pull_requests/1386022309
+- .pull_requests/1386036048
+- .pull_requests/1386105869
+- .pull_requests/1386184858
 - .rspec
-- .ruby-gemset
-- .ruby-version
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -266,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Convert from PolyTeX & Markdown to HTML & LaTeX

data/.ruby-gemset

@@ -1 +0,0 @@
-polytexnic

data/.ruby-version

@@ -1 +0,0 @@
-2.0.0-p247