polytexnic 1.9.2 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fd013155e321745a2fa54c50bfc39826c9908e3cd6fa4aca280197c805cb6f3
-  data.tar.gz: cf219afa3a0f99c57536bbf9e5e75776515b56b3eec36b3ccd5f4a9adc63c597
+  metadata.gz: '08ef6b16e688ae517db09f1ccd14da9a9861fc14d0b7576267f2704ee28e2223'
+  data.tar.gz: 1d19e497423591bf533a01c7870e93fbff311639a35584c2fce4b2eb5fc70ce2
 SHA512:
-  metadata.gz: 916e1ed5f71cf96fa311426dd8e87bd52e3fd0a0884744085dc9400da972d9648c3216e2c45b33bb50c1a77cbc08322e11ad8f1b8fb6620cd25fa6f69ee62ec1
-  data.tar.gz: a14021cf2f3d7f1d5634bb81198490baab22116484207392841107b1bcb86e9d814d6dedc01fba3b1e58320e28dff459a0e621b0d85f7e4472231c15ce8dacdf
+  metadata.gz: 6fb7f765d2eb5ef17df271b165aa628def5742333e672dd8fa599321e9e550a07af902e914768a2c90123a41ddec53a529677ee84c932d919ce7ce5c99400f50
+  data.tar.gz: d69d4ccc81b47e6098462888862813f9a1164232a09b16c473d2f7821fa3a4c24f6f1a540d03147689630c7daf5ac42ff653e6d3ee1ccdea96c6cd2fb689ea68

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polytexnic (1.9.2)
+    polytexnic (1.10.1)
       json (= 2.3.1)
       kramdown (= 2.4.0)
       msgpack (= 1.2.10)

data/lib/polytexnic/postprocessors/html.rb

@@ -45,6 +45,8 @@ module Polytexnic
         restore_inline_verbatim(doc)
         codelistings(doc)
         asides(doc)
+        theorems_lemmas_etc(doc)
+        proofs(doc)
         make_cross_references(doc)
         hrefs(doc)
         graphics_and_figures(doc)
@@ -463,8 +465,6 @@ module Polytexnic
         # Returns true if node is inside section*.
         def section_star?(node)
           begin
-            # puts (val = node.parent.parent.attributes['class'].value) + '*******'
-            # puts node.parent.parent.parent.parent.children[1] if val == 'section-star'
             node.parent.parent.attributes['class'].value == 'section-star'
           rescue
             false
@@ -543,9 +543,6 @@ 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'
@@ -740,13 +737,42 @@ module Polytexnic
           end
         end
 
+        # Returns true if the environment type is a theorem, lemma, etc.
+        def theorem_environment?(css_classes)
+          return false if css_classes.nil?
+          css_classes.split.each do |css_class|
+            return true if @supported_theorem_types.include?(css_class)
+          end
+          return false
+        end
+
+        # Return the style class associated with an element.
+        # The only trick involves theorem environments.
+        # There are three defined in
+        # http://www.ams.org/arc/tex/amscls/amsthdoc.pdf:
+        # plain, definition, and remark
+        # So that this can be used without modification with other elements,
+        # if the element isn't a theorem we simply return the type itself.
+        def element_class(element_type)
+          return element_type unless theorem_environment?(element_type)
+          plain_styles = %w[theorem lemma corollary proposition conjecture]
+          definition_styles = %w[definition problem example exercise axiom]
+          remark_styles = %w[remark claim]
+          if plain_styles.include?(element_type)
+            "#{element_type} plain"
+          elsif definition_styles.include?(element_type)
+            "#{element_type} definition"
+          elsif remark_styles.include?(element_type)
+            "#{element_type} remark"
+          end
+        end
+
         # Builds the full heading for codelisting-like environments.
         # The full heading, such as "Listing 1.1: Foo bars." needs to be
         # extracted and manipulated to produce the right tags and classes.
         def build_heading(node, css_class)
           node.name  = 'div'
-          node['class'] = css_class
-
+          node['class'] = element_class(css_class)
           heading = node.at_css('p')
           heading.attributes.each do |key, value|
             node.set_attribute(key, value)
@@ -754,18 +780,55 @@ module Polytexnic
           end
           heading.name = 'div'
           heading['class'] = 'heading'
-
-          number = heading.at_css('strong')
-          number.content = number.content.sub!('0.', '') if article?
-          number.name = 'span'
-          number['class'] = 'number'
-          if css_class == 'codelisting'
+          full_number = heading.at_css('strong')
+          full_number.name = 'span'
+          full_number['class'] = 'number'
+          # E.g., "Theorem 1.1 (Fermat’s Last Theorem)"
+          # label = "Theorem"
+          # actual_number_etc = ["1.1", "Fermat’s Last Theorem"]
+          full_label_content = full_number.content.strip
+          full_number.content = ''
+          content_array = full_label_content.split
+          label, actual_number_etc = content_array.shift, content_array
+          element_label = Nokogiri::XML::Node.new('span', heading)
+          # Make span for element's style label.
+          # <span class="plain_label">Theorem</span>
+          element_label['class'] = "#{element_class(css_class)}_label"
+          if article?
+            actual_number = actual_number_etc.first.sub!('0.', '')
+          else
+            actual_number = actual_number_etc.first
+          end
+          element_label.content = label
+          full_number << element_label
+          full_number << Nokogiri::XML::Text.new(" #{actual_number}", heading)
+          # Handle optional argument to theorems.
+          # E.g., \begin{theorem}[Fermat's Last Theorem]
+          environment_type = label.downcase
+          if theorem_environment?(environment_type)
+            # Theorem headings should be paragraphs instead of divs.
+            heading.name = 'p'
+            # This will be nonempty only if there's an optional argument
+            # as in \begin{theorem}[optional argument].
+            optarg = actual_number_etc[1..-1].join(" ")
+            unless optarg.empty?
+              # Add a span to parenthetical content for styling purpsoes.
+              # This handles things like "Theorem 1.1 (Fermat’s Last Theorem)".
+              theorem_description = Nokogiri::XML::Node.new('span', heading)
+              theorem_description['class'] = 'theorem_description'
+              theorem_description.content = optarg
+              full_number << Nokogiri::XML::Text.new(' ', heading)
+              full_number << theorem_description
+            end
+            full_number << Nokogiri::XML::Text.new('.', heading)
+          elsif css_class == 'codelisting'
             description = node.at_css('.description').content
-            number.content += ':' unless description.empty?
+            unless description.empty?
+              full_number << Nokogiri::XML::Text.new(':', heading)
+            end
           else
-            number.content += '.'
+            full_number << Nokogiri::XML::Text.new('.', heading)
           end
-
           heading
         end
 
@@ -814,6 +877,23 @@ module Polytexnic
           end
         end
 
+        # Processes theorems, lemmas, etc.
+        def theorems_lemmas_etc(doc)
+          @supported_theorem_types.each do |theorem_type|
+            doc.xpath("//#{theorem_type}").each do |node|
+              build_heading(node, theorem_type)
+            end
+          end
+        end
+
+        # Processes proofs.
+        def proofs(doc)
+          doc.xpath('//proof').each do |node|
+            node.name = 'div'
+            node['class'] = 'proof'
+          end
+        end
+
         # Processes centered elements.
         def center(doc)
           doc.xpath('//center').each do |node|
@@ -912,11 +992,11 @@ module Polytexnic
 
         # Creates linked cross-references.
         def make_cross_references(doc)
-          # build numbering tree
+          # Build numbering tree.
           doc.xpath('//*[@data-tralics-id]').each do |node|
             node['data-number'] = formatted_number(node)
             clean_node node, 'id-text'
-            # Add number span
+            # Add number span.
             if (head = node.css('h1 a, h2 a, h3 a').first)
               el = doc.create_element 'span'
               el.content = section_label(node)
@@ -1003,6 +1083,7 @@ module Polytexnic
             @figure = 0
             @table = 0
             @aside = 0
+            @theorem = 0
             @cha = article? ? nil : node['id-text']
           elsif node['class'] == 'section'
             @sec = node['id-text']
@@ -1028,6 +1109,9 @@ module Polytexnic
           elsif node.name == 'figure'
             @figure = ref_number(node, @cha, @figure)
             label_number(@cha, @figure)
+          elsif theorem_environment?(node['class'])
+            @theorem = number_from_id(node['id-text'])
+            label_number(@cha, @theorem)
           end
         end
 

data/lib/polytexnic/postprocessors/polytex.rb

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

data/lib/polytexnic/preprocessors/html.rb

@@ -274,7 +274,7 @@ module Polytexnic
         end
 
         # Converts the alt table environments to simple tabular.
-        # This is was originaly because kramdown outputs longtables by default,
+        # This was originally because kramdown outputs longtables by default,
         # but as a side-effect you can also use longtables in PolyTeX
         # input documents. The latest update includes support for the tabularx
         # environment
@@ -317,6 +317,16 @@ module Polytexnic
             "#{s}\n\\end{xmlelement*}"
           end
 
+          # Wrap proofs in a 'proof' element.
+          string.gsub! /\\begin{proof}/ do |s|
+            "\\begin{xmlelement*}{proof}\n#{s}"
+          end
+          string.gsub! /\\end{proof}/ do |s|
+            "#{s}\n\\end{xmlelement*}"
+          end
+          string.gsub!(/\\begin{proof}/, '')
+          string.gsub!(/\\end{proof}/, '')
+
           # Wrap asides in an 'aside' element.
           string.gsub! /\\begin{aside}/ do |s|
             "\\begin{xmlelement*}{aside}\n#{s}"
@@ -325,6 +335,16 @@ module Polytexnic
             "#{s}\n\\end{xmlelement*}"
           end
 
+          # Wrap theorem, lemma, etc., in corresponding elements.
+          @supported_theorem_types.each do |th|
+            string.gsub! /\\begin{#{th}}/ do |s|
+              "\\begin{xmlelement*}{#{th}}\n#{s}"
+            end
+            string.gsub! /\\end{#{th}}/ do |s|
+              "#{s}\n\\end{xmlelement*}"
+            end
+          end
+
           # Replace quotations and verse with corresponding XML elements.
           string.gsub! /\\begin{quote}/ do |s|
             quotation = '\AddAttToCurrent{class}{quotation}'

data/lib/polytexnic/utils.rb

@@ -149,13 +149,16 @@ module Polytexnic
 \newcommand{\newunicodechar}[2]{}
 \newcommand{\extrafloats}[1]{}
       EOS
-      custom_commands = <<-EOS
+      custom = <<-EOS
 \\usepackage{amsthm}
-\\theoremstyle{definition}
 \\newtheorem{codelisting}{#{language_labels["listing"]}}[chapter]
 \\newtheorem{aside}{#{language_labels["aside"]}}[chapter]
+\\newtheorem{theorem}{#{language_labels["theorem"]}}[chapter]
       EOS
-      [base_commands, custom_commands].join("\n")
+      (@supported_theorem_types - ["theorem"]).each do |lab|
+        custom += "\\newtheorem{#{lab}}[theorem]{#{language_labels[lab]}}\n"
+      end
+      [base_commands, custom].join("\n")
     end
 
     # Highlights source code.

data/lib/polytexnic/version.rb

@@ -1,3 +1,3 @@
 module Polytexnic
-  VERSION = "1.9.2"
+  VERSION = "1.10.1"
 end

data/lib/polytexnic.rb

@@ -49,6 +49,10 @@ module Polytexnic
       @literal_html_cache = {}
       @maketitle_elements = {}
       @article = options[:article]
+      @supported_theorem_types = %w[theorem lemma corollary proposition
+                                    conjecture
+                                    definition problem example exercise axiom
+                                    remark claim]
       @language_labels = if (labels = options[:language_labels]).nil?
                             default_language_labels
                           else
@@ -109,11 +113,15 @@ module Polytexnic
 
       # Returns the default labels for 'Chapter', 'Figure', etc.
       def default_language_labels
+        theorem_labels = @supported_theorem_types.inject({}) do |labels, th|
+                           labels[th] = th.capitalize
+                           labels
+                         end
         {"part"=>"Part","chapter"=>{"word"=>"Chapter", "order"=>"standard"},
         "section"=>"Section", "appendix"=>"Appendix", "table"=>"Table",
         "figure"=>"Figure", "fig"=>"Fig", "aside"=>"Box", "listing"=>"Listing",
         "equation"=>"Equation", "eq"=>"Eq", "frontmatter"=>"Frontmatter",
-        "contents"=>"Contents"}
+        "contents"=>"Contents"}.merge(theorem_labels)
       end
 
       def markdown?

data/spec/articles_spec.rb

@@ -43,7 +43,7 @@ $ subl .gemrc
   let(:section)   { '<a href="#sec-foo" class="heading"><span class="number">1 </span>' }
   let(:figure)    { '<span class="header">Figure 1</span>' }
   let(:table)     { '<span class="header">Table 1</span>' }
-  let(:listing)   { '<span class="number">Listing 1:</span>' }
+  let(:listing)   { '<span class="number"><span class="codelisting_label">Listing</span> 1:' }
   let(:footnote)  { '<sup id="cha-0_footnote-ref-1" class="footnote"><a href="#cha-0_footnote-1">1</a></sup>' }
 
   let(:sref) { 'Section <span class="ref">1</span>' }

data/spec/to_html/asides_spec.rb

@@ -29,7 +29,7 @@ describe 'Polytexnic::Pipeline#to_html' do
         <div id="cid1" data-tralics-id="cid1" class="chapter" data-number="1"><h1><a href="#cid1" class="heading"><span class="number">Chapter 1 </span>Foo bar</a></h1>
         <div class="aside" id="aside-lorem" data-tralics-id="uid1" data-number="1.1">
           <div class="heading">
-            <span class="number">Box 1.1.</span>
+            <span class="number"><span class="aside_label">Box</span> 1.1.</span>
             <span class="description">Lorem ipsum.</span>
           </div>
           <p>lorem ipsum</p>
@@ -47,7 +47,7 @@ describe 'Polytexnic::Pipeline#to_html' do
                                              "order" => "standard" },
                               "aside" => "Cajón" })
       end
-      it { should include 'Cajón 1.1' }
+      it { should include '<span class="aside_label">Cajón</span> 1.1' }
     end
   end
 
@@ -67,7 +67,8 @@ describe 'Polytexnic::Pipeline#to_html' do
       EOS
     end
     context "in a chapter" do
-      let(:polytex) { '\chapter{Foo bar}' + "\n" + aside}
+      let(:prematerial) { "\\chapter{Foo}\n\n\\section{Bar}" }
+      let(:polytex) { prematerial + "\n" + aside}
       it { should include ">1.1<" }
     end
 

data/spec/to_html/codelistings_spec.rb

@@ -28,7 +28,7 @@ Listing~\ref{code:create_gemrc}
         <div id="cid1" data-tralics-id="cid1" class="chapter" data-number="1"><h1><a href="#cid1" class="heading"><span class="number">Chapter 1 </span>Foo bar</a></h1>
         <div class="codelisting" id="code-create_gemrc" data-tralics-id="uid1" data-number="1.1">
           <div class="heading">
-            <span class="number">Listing 1.1:</span>
+            <span class="number"><span class="codelisting_label">Listing</span> 1.1:</span>
             <span class="description">Creating a <code class="tt">gem</code> configuration file.<span class="intersentencespace"></span>
               <span class="break"></span>
               <code class="filepath">path/to/file</code>
@@ -72,8 +72,8 @@ Listing~\ref{code:create_gemrc}
         Listing~\ref{code:create_gemrc}
         EOS
       end
-      it { should     include 'Listing 1.1' }
-      it { should_not include 'Listing 1.1:' }
+      it { should     include 'Listing</span> 1.1' }
+      it { should_not include 'Listing</span> 1.1:' }
     end
 
     context "containing code inclusion with a hyphen and a leading dot" do

data/spec/to_html/proof_theorem_spec.rb

@@ -0,0 +1,185 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe 'Polytexnic::Pipeline#to_html' do
+
+  let(:pipeline) { Polytexnic::Pipeline.new(polytex) }
+  subject(:processed_text) { pipeline.to_html }
+
+  describe "proof" do
+    let(:polytex) do <<-'EOS'
+      \chapter{Foo bar}
+
+      \begin{proof}
+      Lorem ipsum.
+      \end{proof}
+      EOS
+    end
+    it { should include("Lorem ipsum.") }
+    it { should include('<div class="proof">')}
+  end
+
+  describe "chapter theorems" do
+    let(:polytex) do <<-'EOS'
+      \chapter{Foo bar}
+
+      \section{A section}
+      \label{sec:the_section}
+
+      \begin{theorem}
+      \label{th:lorem}
+      This is a theorem. It might have muliple lines.
+
+      Like this!
+      \end{theorem}
+
+      \begin{lemma}
+      \label{lemma:ipsum}
+      bar
+      \end{lemma}
+
+      \begin{corollary}
+      \label{cor:and_also}
+      quux
+      \end{corollary}
+
+      \begin{definition}
+      \label{def:a_definition}
+      foo
+      \end{definition}
+
+      \begin{remark}
+      able
+      \end{remark}
+
+      We'll see another theorem in Theorem~\ref{th:another},
+      and a lemma in Lemma~\ref{lemma:yet_another}.
+
+      \chapter{Another chapter}
+
+      We saw a theorem in Theorem~\ref{th:lorem} and a corollary
+      in Corollary~\ref{cor:and_also}.
+
+      \section{Another section}
+
+      \begin{theorem}
+      \label{th:another}
+      Another theorem
+      \end{end}
+
+      \begin{lemma}
+      \label{lemma:yet_another}
+      Yet another lemma.
+      \end{lemma}
+
+      EOS
+    end
+
+    it { should include("lorem") }
+    it { should include("Theorem</span> 1.1.</span>") }
+    it { should include("Lemma</span> 1.2") }
+    it { should include("Corollary</span> 1.3") }
+    it { should include("Definition</span> 1.4") }
+    it { should include("Remark</span> 1.5") }
+    it { should include("Theorem</span> 2.1") }
+    it { should include("Lemma</span> 2.2") }
+    it { should include('Theorem <a href="#th-lorem" class="hyperref"><span class="ref">1.1</span></a>')}
+    it { should include('Theorem <a href="#th-another" class="hyperref"><span class="ref">2.1</span></a>')}
+    it { should include('Lemma <a href="#lemma-yet_another" class="hyperref"><span class="ref">2.2</span></a>')}
+  end
+
+  describe "articles theorems" do
+    before do
+      pipeline.stub(:article?).and_return(true)
+    end
+
+    let(:polytex) do <<-'EOS'
+      \section{A section}
+      \label{sec:the_section}
+
+      \begin{theorem}
+      \label{th:lorem}
+      This is a theorem. It might have muliple lines.
+
+      Like this!
+      \end{theorem}
+
+      \begin{lemma}
+      \label{lemma:ipsum}
+      bar
+      \end{lemma}
+
+      \begin{corollary}
+      \label{cor:and_also}
+      quux
+      \end{corollary}
+
+      \begin{definition}
+      \label{def:a_definition}
+      foo
+      \end{definition}
+
+      \begin{remark}
+      able
+      \end{remark}
+
+      We'll see another theorem in Theorem~\ref{th:another},
+      and a lemma in Lemma~\ref{lemma:yet_another}.
+
+      We saw a theorem in Theorem~\ref{th:lorem} and a corollary
+      in Corollary~\ref{cor:and_also}.
+
+      \section{Another section}
+
+      \begin{theorem}
+      \label{th:another}
+      Another theorem
+      \end{end}
+
+      \begin{lemma}
+      \label{lemma:yet_another}
+      Yet another lemma.
+      \end{lemma}
+
+      EOS
+    end
+
+    it { should include("lorem") }
+    it { should include("Theorem</span> 1") }
+    it { should include("Lemma</span> 2") }
+    it { should include("Corollary</span> 3") }
+    it { should include("Definition</span> 4") }
+    it { should include("Remark</span> 5") }
+    it { should include("Theorem</span> 6") }
+    it { should include("Lemma</span> 7") }
+    it { should include('Theorem <a href="#th-lorem" class="hyperref"><span class="ref">1</span></a>')}
+    it { should include('Theorem <a href="#th-another" class="hyperref"><span class="ref">6</span></a>')}
+    it { should include('Lemma <a href="#lemma-yet_another" class="hyperref"><span class="ref">7</span></a>')}
+  end
+
+  describe "optional argument" do
+    let(:polytex) do <<-'EOS'
+      \chapter{A chapter}
+
+      \section{A section}
+      \label{sec:the_section}
+
+      \begin{theorem}[Fermat's Last Theorem]
+      \label{th:fermat}
+      It's true, I swear it!
+      \end{theorem}
+
+      \begin{proof}
+      This test is too small to contain it.
+      \end{proof}
+      EOS
+    end
+
+    let(:theorem_span) do
+      s  = %(<span class="number"><span class="theorem plain_label">Theorem</span>)
+      s += %( 1.1 <span class="theorem_description">)
+      s += %((Fermat’s Last Theorem)</span>.</span>)
+    end
+    it { should include(theorem_span) }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polytexnic
 version: !ruby/object:Gem::Version
-  version: 1.9.2
+  version: 1.10.1
 platform: ruby
 authors:
 - Michael Hartl
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -214,7 +214,6 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- arm64-darwin21
 - bin/polytexnic
 - lib/polytexnic.rb
 - lib/polytexnic/code_inclusion.rb
@@ -271,6 +270,7 @@ files:
 - spec/to_html/literal_environments/math_spec.rb
 - spec/to_html/literal_environments/unicode_spec.rb
 - spec/to_html/literal_environments/verbatim_spec.rb
+- spec/to_html/proof_theorem_spec.rb
 - spec/to_html/quotations_and_verse_spec.rb
 - spec/to_html/table_of_contents_spec.rb
 - spec/to_html/table_spec.rb
@@ -335,6 +335,7 @@ test_files:
 - spec/to_html/literal_environments/math_spec.rb
 - spec/to_html/literal_environments/unicode_spec.rb
 - spec/to_html/literal_environments/verbatim_spec.rb
+- spec/to_html/proof_theorem_spec.rb
 - spec/to_html/quotations_and_verse_spec.rb
 - spec/to_html/table_of_contents_spec.rb
 - spec/to_html/table_spec.rb