polytexnic 0.8.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1423a3dd422cb364805b81b3d1b895ca1fc90aa6
-  data.tar.gz: fb5ac1f61afa117520566b9aafb1812994551cf0
+  metadata.gz: 74e29c2ae1ffea2e625b8aa215e4d13c26a00bb5
+  data.tar.gz: 4ec37eb99576de122d97e6101b7533a627dcd98c
 SHA512:
-  metadata.gz: c3f00576f1295d4cbf3cbfbe747bf4a2eace81c013045ce124e25a4939d445ee5457f32f2c6a3eb2aa84a5650915c655f9a6af8345b9c2e37d7765bef4f71d5c
-  data.tar.gz: 383d565f5bb1dd3257281a8f69da2321f9506db71c4901e496726ad32ad6686c50944c2d4faa9e8a995dd03a366141799f1bbadb67f899a9d50a9e5c7c30c93a
+  metadata.gz: bbeef507a3e651e40927185278dc54b7de2490bfe01da8cc125b24259f055d7db871f1f30fbb7c56af1dc13018a9a42abf0ffc19e16aad01c9df14b4494216c9
+  data.tar.gz: 2ab78e4d8307416c9f07ec5754ddaa3ee16465729df93a64f66c163948b1e88556d2c1ffbb299e398684b520dec64ce90ffc13e3aecc3c032c4fd5e478a4e925

data/lib/polytexnic.rb

@@ -34,12 +34,17 @@ module Polytexnic
 
     attr_accessor :literal_cache, :code_cache, :polytex, :xml, :html,
                   :math_label_cache, :highlight_cache, :maketitle_elements,
-                  :custom_commands
+                  :custom_commands, :language_labels
 
     def initialize(source, options = {})
       @literal_cache = options[:literal_cache] || {}
       @code_cache = {}
       @maketitle_elements = {}
+      @language_labels = if (labels = options[:language_labels]).nil?
+                            default_language_labels
+                          else
+                            default_language_labels.merge(labels)
+                          end
       @highlight_cache_filename = '.highlight_cache'
       if File.exist?(@highlight_cache_filename)
         content = File.read(@highlight_cache_filename)
@@ -70,8 +75,9 @@ module Polytexnic
       end
 
       preprocess(:html)
+      puts "\nafter preprocess:\n#{@xml}" if debug?
       postprocess(:html)
-      puts @html if debug?
+      puts "\nafter postprocess:\n#{@html}" if debug?
 
       if profiling?
         result = RubyProf.stop
@@ -89,6 +95,15 @@ module Polytexnic
 
     private
 
+      # Returns the default labels for 'Chapter', 'Figure', etc.
+      def default_language_labels
+        {"chapter"=>{"word"=>"Chapter", "order"=>"standard"},
+        "section"=>"Section", "table"=>"Table", "figure"=>"Figure",
+        "fig"=>"Fig", "aside"=>"Box", "listing"=>"Listing",
+        "equation"=>"Equation", "eq"=>"Eq", "frontmatter"=>"Frontmatter",
+        "contents"=>"Contents"}
+      end
+
       def markdown?
         @source_format == :markdown || @source_format == :md
       end

data/lib/polytexnic/literal.rb

@@ -9,7 +9,8 @@ module Polytexnic
     # Matches the line for code inclusion.
     # %= <</path/to/code.ext
     CODE_INCLUSION_REGEX = /^\s*%=\s+<<\s*\(          # opening
-                             \s*([^\s]+)              # path to file
+                             \s*([^\s]+?)             # path to file
+                             (?:\[(.+?)\])?           # optional section name
                              (?:,\s*lang:\s*(\w+))?   # optional lang
                              (,\s*options:\s*.*)?     # optional options
                              \s*\)                    # closing paren
@@ -80,21 +81,12 @@ module Polytexnic
           # to
           # %= lang:rb
           # \begin{code}
-          # <content of file.rb>
+          # <content of file or section.rb>
           # \end{code}
           # and then prepend the code to the current `lines` array.
-          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 = custom_language || lang_from_extension || 'text'
-            code = ["%= lang:#{language}#{highlight_options}"]
-            code << '\begin{code}'
-            code.concat(File.read(filename).split("\n"))
-            code << '\end{code}'
-            lines.unshift(*code)
-          else
-            lines.unshift("\\verb+ERROR: File '#{filename}' does not exist+")
+          filename, sectionname, custom_language, highlight_options = $1, $2, $3, $4
+          if filename
+            lines.unshift(*include_code(filename, sectionname, custom_language, highlight_options))
           end
         elsif line.begin_literal?
           in_verbatim = true
@@ -168,6 +160,34 @@ module Polytexnic
       end
     end
 
+    # Returns the marked up file or section to be included,
+    # or an error message if file or section does not exist.
+    def include_code(filename, sectionname, custom_language, highlight_options)
+      reader = (sectionname ? IncludedSectionReader : IncludedFileReader).new
+      lang = "#{code_language(filename, custom_language)}#{highlight_options}"
+      code = ["%= lang:#{lang}"]
+      code << '\begin{code}'
+      code.concat(reader.read(filename, sectionname))
+      code << '\end{code}'
+
+      rescue FileNotFound => e
+        code_error("File '#{e.message}' does not exist")
+      rescue SectionNotFound => e
+        msg = e.message
+        err = "Could not find section header '#{msg}' in file '#{filename}'"
+        code_error(err)
+    end
+
+    def code_error(details)
+      "\\verb+ERROR: #{details}+"
+    end
+
+    def code_language(filename, custom_language)
+      extension_array = File.extname(filename).scan(/\.(.*)/).first
+      lang_from_extension = extension_array.nil? ? nil : extension_array[0]
+      language = custom_language || lang_from_extension || 'text'
+    end
+
     # Returns a permanent salt for the syntax highlighting cache.
     def code_salt
       'fbbc13ed4a51e27608037365e1d27a5f992b6339'
@@ -229,8 +249,17 @@ module Polytexnic
     # For completeness, we handle the case where the author neglects to
     # use the nonbreak space ~.
     def hyperrefs(string)
-      linked_item = "(Chapter|Section|Table|Box|Figure|Fig\.|Listing" +
-                    "|Equation|Eq\.)"
+      chapter  = language_labels["chapter"]["word"]
+      section  = language_labels["section"]
+      table    = language_labels["table"]
+      box      = language_labels["aside"]
+      figure   = language_labels["figure"]
+      fig      = language_labels["fig"]
+      listing  = language_labels["listing"]
+      equation = language_labels["equation"]
+      eq       = language_labels["eq"]
+      linked_item = "(#{chapter}|#{section}|#{table}|#{box}|#{figure}" +
+                    "|#{fig}\.|#{listing}|#{equation}|#{eq}\.)"
       ref = /(?:#{linked_item}(~| ))*(\\(?:eq)*ref){(.*?)}/i
       string.gsub!(ref) do
         "\\hyperref[#{$4}]{#{$1}#{$2}#{$3}{#{$4}}}"
@@ -245,7 +274,7 @@ module Polytexnic
     # pipeline intact.
     def cache_unicode(string)
       non_ascii_unicode = /([^\x00-\x7F]+)/
-      string.gsub(non_ascii_unicode) do
+      string.gsub!(non_ascii_unicode) do
         key = digest($1)
         literal_cache[key] = $1
         xmlelement('unicode') { key }
@@ -259,6 +288,57 @@ module Polytexnic
         literal_type
       end
     end
+
+
+    class FileNotFound < Exception; end;
+    class IncludedFileReader
+      def read(filename, _)
+        raise(FileNotFound, filename) unless File.exist?(filename)
+        File.read(filename).split("\n")
+      end
+    end
+
+    class SectionNotFound < Exception; end;
+    class IncludedSectionReader < IncludedFileReader
+      attr_reader :lines, :sectionname
+
+      def read(filename, sectionname)
+        @lines        = super
+        @sectionname  = sectionname
+
+        raise(SectionNotFound, section_begin_text) unless exist?
+        lines.slice(index_of_first_line, length)
+      end
+
+      private
+        def exist?
+          !!index_of_section_begin
+        end
+
+        def index_of_section_begin
+          @section_begin_i ||= lines.index(section_begin_text)
+        end
+
+        def index_of_first_line
+          @first_line_i ||= index_of_section_begin + 1
+        end
+
+        def length
+          lines.slice(index_of_first_line, lines.size).index(section_end_text)
+        end
+
+        def marker
+          '#//'
+        end
+
+        def section_begin_text
+          "#{marker} begin #{sectionname}"
+        end
+
+        def section_end_text
+          "#{marker} end"
+        end
+      end
   end
 end
 
@@ -310,4 +390,4 @@ class String
         Regexp.escape(s)
       end.join('|')
     end
-end
+end

data/lib/polytexnic/postprocessors/html.rb

@@ -28,16 +28,16 @@ module Polytexnic
         sout(doc)
         kode(doc)
         filepath(doc)
-        codelistings(doc)
         backslash_break(doc)
         spaces(doc)
-        asides(doc)
         center(doc)
         title(doc)
         doc = smart_single_quotes(doc)
         tex_logos(doc)
         restore_literal(doc)
         restore_inline_verbatim(doc)
+        codelistings(doc)
+        asides(doc)
         make_cross_references(doc)
         hrefs(doc)
         graphics_and_figures(doc)
@@ -765,10 +765,7 @@ module Polytexnic
             # Add number span
             if (head = node.css('h1 a, h2 a, h3 a').first)
               el = doc.create_element 'span'
-              number = node['data-number']
-              is_section = number.match(/\./)
-              prefix = (@cha.nil? || is_section) ? '' : "#{chaptername} "
-              el.content = prefix + node['data-number'] + ' '
+              el.content = section_label(node)
               el['class'] = 'number'
               chapter_name = head.children.first
               if chapter_name.nil?
@@ -805,13 +802,32 @@ module Polytexnic
           end
         end
 
+        # Returns the section label for the node; e.g., "Chapter 2".
+        def section_label(node)
+          number = node['data-number']
+          if chapter?(node)
+            label = if language_labels["chapter"]["order"] == "reverse"
+                      number + ' ' + chaptername
+                    else
+                      chaptername + ' ' + number
+                    end
+          else
+            label = number
+          end
+          label + ' '
+        end
+
+        # Returns true if the node represents a chapter.
+        def chapter?(node)
+          is_section = node['data-number'].match(/\./)
+          !(@cha.nil? || is_section)
+        end
+
         # Returns the name to use for chapters.
         # The default is 'Chapter', of course, but this can be overriden
-        # using '\renewcommand', especially in books other than Engilsh.
+        # using 'language_labels', especially in books other than English.
         def chaptername
-          name_regex = /\\renewcommand\{\\chaptername\}\{(.*?)\}/
-          name = custom_commands.scan(name_regex).flatten.last
-          name || 'Chapter'
+          language_labels["chapter"]["word"]
         end
 
         # Returns the formatted number appropriate for the node.
@@ -967,7 +983,7 @@ module Polytexnic
         # Adds a caption to a node.
         # This works for figures and tables (at the least).
         def add_caption(node, options={})
-          name = options[:name].to_s.capitalize
+          name = language_labels[options[:name].to_s]
           doc = node.document
           full_caption = Nokogiri::XML::Node.new('div', doc)
           full_caption['class'] = 'caption'
@@ -1123,7 +1139,8 @@ module Polytexnic
         def table_of_contents(doc)
           toc = doc.at_css('tableofcontents')
           return if toc.nil?
-          toc.add_previous_sibling('<h1 class="contents">Contents</h1>')
+          label = language_labels["contents"]
+          toc.add_previous_sibling(%(<h1 class="contents">#{label}</h1>))
           toc.name = 'div'
           toc['id'] = 'table_of_contents'
           toc.remove_attribute 'depth'

data/lib/polytexnic/preprocessors/html.rb

@@ -34,6 +34,7 @@ module Polytexnic
             convert_longtable(output)
             mark_environments(output)
             make_tabular_alignment_cache(output)
+            cache_unicode(output)
           end
         end
 
@@ -43,7 +44,7 @@ module Polytexnic
         # The result is a document that can safely be transformed using
         # global substitutions.
         def clean_document(polytex)
-          doc = cache_unicode(cache_literal(add_commands(polytex)))
+          doc = cache_literal(add_commands(polytex))
           inline_verbatim(doc)
           cache_hrefs(doc)
           remove_comments(doc)

data/lib/polytexnic/preprocessors/latex.rb

@@ -3,16 +3,30 @@ module Polytexnic
     module Latex
 
       def to_processed_latex
-        @polytex = polish_tables(process_asides(clean_latex_document))
+        @polytex = convert_gifs(
+                     polish_tables(
+                     process_asides(clean_latex_document)))
       end
 
       # Returns LaTeX with hashed versions of literal environments.
       # Literal environments are hashed and passed through the pipeline
-      # so that we can process things like refs to hyperrefs using gsubs.
+      # so that we can process things like refs and hyperrefs using gsubs.
       def clean_latex_document
         cache_literal(@polytex, :latex)
       end
 
+      # Convert GIFs to PNGs.
+      # Unfortunately, xelatex doesn't support GIFs. This converts the included
+      # filenames to use '.png' in place of '.gif'. When used with the Softcover
+      # system, the correct PNG files are automatically created on the fly.
+      def convert_gifs(text)
+        text.tap do
+          text.gsub!(/\\(includegraphics|image|imagebox)\{(.*)\.gif\}/) do
+            "\\#{$1}{#{$2}.png}"
+          end
+        end
+      end
+
       def polish_tables(text)
         text.tap do
           text.gsub!(/^\s*(\\begin\{table\})/) do

data/lib/polytexnic/utils.rb

@@ -95,7 +95,7 @@ module Polytexnic
     # the commands with 'xmlelt' aren't even valid LaTeX; they're actually
     # pseudo-LaTeX that has special meaning to the Tralics processor.
     def tralics_commands
-      <<-'EOS'
+      base_commands = <<-'EOS'
 % Commands specific to Tralics
 \def\hyperref[#1]#2{\xmlelt{a}{\XMLaddatt{target}{#1}#2}}
 \newcommand{\heading}[1]{\xmlelt{heading}{#1}}
@@ -110,14 +110,14 @@ module Polytexnic
 % Ignore some other commands.
 \newcommand{\includepdf}[1]{}
 \newcommand{\newunicodechar}[2]{fdsfdas}
-
-
-% Code listings
-\usepackage{amsthm}
-\theoremstyle{definition}
-\newtheorem{codelisting}{Listing}[chapter]
-\newtheorem{aside}{Box}[chapter]
       EOS
+      custom_commands = <<-EOS
+\\usepackage{amsthm}
+\\theoremstyle{definition}
+\\newtheorem{codelisting}{#{language_labels["listing"]}}[chapter]
+\\newtheorem{aside}{#{language_labels["aside"]}}[chapter]
+      EOS
+      [base_commands, custom_commands].join("\n")
     end
 
     # Highlights source code.

data/lib/polytexnic/version.rb

@@ -1,3 +1,3 @@
 module Polytexnic
-  VERSION = "0.8.4"
+  VERSION = "0.9.0"
 end

data/spec/to_html/asides_spec.rb

@@ -3,9 +3,10 @@ require 'spec_helper'
 
 describe 'Polytexnic::Pipeline#to_html' do
 
-  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+  let(:pipeline) { Polytexnic::Pipeline.new(polytex) }
+  subject(:processed_text) { pipeline.to_html }
 
-  describe "code listings" do
+  describe "aside boxes" do
     let(:polytex) do <<-'EOS'
       \chapter{Foo bar}
 
@@ -38,5 +39,15 @@ describe 'Polytexnic::Pipeline#to_html' do
         </div>
       EOS
     end
+
+    context "with a custom language label" do
+      before do
+        pipeline.stub(:language_labels).
+                 and_return({ "chapter" => { "word" => "Chapter",
+                                             "order" => "standard" },
+                              "aside" => "Cajón" })
+      end
+      it { should include 'Cajón 1.1' }
+    end
   end
 end

data/spec/to_html/chapters_and_sections_spec.rb

@@ -38,9 +38,12 @@ describe 'Polytexnic::Pipeline#to_html' do
     end
 
     context "with an alternate to 'Chapter'" do
-      before do
-        pipeline.stub(:custom_commands).
-                 and_return('\renewcommand{\chaptername}{Chapitre}')
+      let(:language_labels) do
+        { "chapter" => {"word"  => "fejezet",
+                        "order" => "reverse"} }
+      end
+      let(:pipeline) do
+        Polytexnic::Pipeline.new(polytex, language_labels: language_labels)
       end
       let(:polytex) do <<-'EOS'
           \chapter{Foo \emph{bar}}
@@ -49,13 +52,58 @@ describe 'Polytexnic::Pipeline#to_html' do
       end
       let(:output) do <<-'EOS'
         <div id="cha-foo" data-tralics-id="cid1" class="chapter" data-number="1">
-          <h1><a href="#cha-foo" class="heading"><span class="number">Chapitre 1 </span>Foo <em>bar</em></a></h1>
+          <h1><a href="#cha-foo" class="heading"><span class="number">1 fejezet </span>Foo <em>bar</em></a></h1>
         </div>
         EOS
       end
+
       it { should resemble output }
-    end
 
+      context "chapter, etc., linking" do
+        let(:language_labels) do
+          { "chapter" => {"word"  => "Capítulo",
+                          "order" => "standard"},
+            "section" => "Sección",
+            "table"   => "Tabla",
+            "aside"   => "Caja",
+            "figure"   => "Figura",
+            "fig"   => "Fig",
+            "listing"   => "Listado",
+            "equation"   => "Ecuación",
+            "eq"   => "Ec",
+            }
+        end
+        let(:polytex) do <<-'EOS'
+          \chapter{Foo}
+          \label{cha:foo}
+
+          Capítulo~\ref{cha:foo}
+          Sección~\ref{sec:bar}
+          Tabla~\ref{table:bar}
+          Caja~\ref{aside:bar}
+          Figura~\ref{fig:bar}
+          Fig.~\ref{fig:bar}
+          Listado~\ref{code:bar}
+          Ecuación~\ref{eq:bar}
+          Ec.~\ref{eq:bar}
+          EOS
+        end
+        let(:capitulo) { 'Cap<span class="unicode">í</span>tulo' }
+        let(:seccion)  { 'Secci<span class="unicode">ó</span>n' }
+        let(:ecuacion) { 'Ecuaci<span class="unicode">ó</span>n' }
+
+        it { should include %(class="hyperref">#{capitulo}) }
+        it { should include %(class="hyperref">#{seccion}) }
+        it { should include %(class="hyperref">Tabla) }
+        it { should include %(class="hyperref">Figura) }
+        it { should include %(class="hyperref">Fig.) }
+        it { should include %(class="hyperref">Caja) }
+        it { should include %(class="hyperref">Listado) }
+        it { should include %(class="hyperref">#{ecuacion}) }
+        it { should include %(class="hyperref">Ec.) }
+
+      end
+    end
   end
 
   describe '\section' do

data/spec/to_html/codelistings_spec.rb

@@ -3,7 +3,8 @@ require 'spec_helper'
 
 describe 'Polytexnic::Pipeline#to_html' do
 
-  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+  let(:pipeline) { Polytexnic::Pipeline.new(polytex) }
+  subject(:processed_text) { pipeline.to_html }
 
   describe "code listings" do
     let(:polytex) do <<-'EOS'
@@ -44,6 +45,17 @@ $ subl .gemrc
       EOS
     end
 
+    context "with a custom language label" do
+      before do
+        pipeline.stub(:language_labels).
+                 and_return({ "chapter" => { "word" => "Chapter",
+                                             "order" => "standard" },
+                              "listing" => "Código" })
+      end
+      it { should include 'Código' }
+    end
+
+
     context "with an empty caption" do
       let(:polytex) do <<-'EOS'
         \chapter{Foo bar}

data/spec/to_html/literal_environments/code_spec.rb

@@ -167,6 +167,42 @@ describe Polytexnic::Pipeline do
         it { should_not include '<p></p>' }
       end
 
+      context "with a section" do
+        let(:polytex) do <<-'EOS'
+          %= <<(spec/to_html/literal_environments/code_spec.rb[section_z])
+          EOS
+        end
+        let(:output) do <<-'EOS'
+          <div class="code">
+            <div class="highlight">
+              <pre>
+                <span class="s2">"This is section_z; it's used by a test."</span>
+                <span class="s2">"Section Z is your friend."</span>
+              </pre>
+            </div>
+          EOS
+        end
+        it { should resemble output }
+        it { should_not include '<span class="c1">#// begin section_z</span>' }
+        it { should_not include '<span class="c1">#// end</span>' }
+
+        context "that does not exist" do
+          let(:polytex) do <<-'EOS'
+            %= <<(spec/to_html/literal_environments/code_spec.rb[section_that_does_not_exist])
+            EOS
+          end
+          let(:output) do <<-'EOS'
+            <p>
+              <span class="inline_verbatim">
+                ERROR: Could not find section header '#// begin section_that_does_not_exist' in file 'spec/to_html/literal_environments/code_spec.rb'
+              </span>
+            </p>
+            EOS
+          end
+          it { should resemble output }
+        end
+      end
+
       context "with a custom language override" do
         let(:polytex) do <<-'EOS'
           %= <<(polytexnic_commands.sty, lang: tex)
@@ -203,4 +239,19 @@ describe Polytexnic::Pipeline do
       it { should include "ERROR: File 'foobar.rb' does not exist" }
     end
   end
-end
+end
+
+
+###################################################
+'The following lines are used to test code sections'
+
+#// begin section_a
+"This is the code inside of section_a."
+"Sections begin with a line containing only '#// begin section_name' and end with '#// end'"
+"You many divide a file into multiple sections and include them individually in your book."
+#// end
+
+#// begin section_z
+"This is section_z; it's used by a test."
+"Section Z is your friend."
+#// end

data/spec/to_latex_spec.rb

@@ -204,5 +204,18 @@ end
 
       it { should resemble output }
     end
+
+    describe "images with GIFs" do
+      let(:polytex) do <<-'EOS'
+        \includegraphics{foo.gif}
+        \image{bar.gif}
+        \imagebox{baz.gif}
+        EOS
+      end
+
+      it { should include '\includegraphics{foo.png}' }
+      it { should include '\image{bar.png}' }
+      it { should include '\imagebox{baz.png}' }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polytexnic
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.9.0
 platform: ruby
 authors:
 - Michael Hartl
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri