polytexnic 0.9.9 → 0.9.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 821fd49a7e64e757649554fe43230066a4adabde
-  data.tar.gz: 691430267b60c4c687bb84f7ba6fb70e1a0ea9c6
+  metadata.gz: 7d1357e1fdbafae6d29c54a966649109ceaef92f
+  data.tar.gz: a15026b6f6b37bc2c37fe9d9fa81571b62e3bf59
 SHA512:
-  metadata.gz: d44043bfb3c04a58e30e1a85e5cf1c0a0046f92018c27e22310b22e145c2c1bceb23077d2cedabcdc7ec8db0802d9d7bbdcbae43a946edc7a2854cf33bda791e
-  data.tar.gz: d07ba71163b7acc22d019d4d7b798838512a092db4791e2d56a4a867ad07bb220b79e6454e20646f9e5c19b130bdcde3161d256ce1ab35e6ebbbc4f307334bb6
+  metadata.gz: a38508985733c163261cd035a86d60c793b22c4027d737dee582431859163765ace742a67649599aba8225739f672f3018104e7c06f0225d899aa2e592cc95f3
+  data.tar.gz: da175c2ed00d3b95b8ff7c849123ec76dc6fb4980e3fb445a96fff73f93b75e93918ba461998605d121217a807bf8abad75fb0b7aef2220c0b91a324c2007413

data/lib/polytexnic/code_inclusion.rb

@@ -0,0 +1,247 @@
+module CodeInclusion
+  class CodeInclusionException < Exception; end;
+
+  class Code
+    CODE_REGEX = /^\s*%=\s+<<\s*\(                # opening
+                   \s*([^\s]+?)                   # path to file
+                   (?:\[(.+?)\])?                 # optional section name
+                   (?:,\s*tag:\s*([\w\.\/\-]+?))? # optional git tag
+                   (?:,\s*lang:\s*(\w+))?         # optional lang
+                   (,\s*options:\s*.*)?           # optional options
+                   \s*\)                          # closing paren
+                   /x
+
+    DEFAULT_LANGUAGE = 'text'
+
+    # Returns an instance of CodeInclusion::Code or nil
+    def self.for(line)
+      if (line =~ CODE_REGEX)
+        opts = {}
+        opts[:tag]             = $3
+        opts[:custom_language] = $4
+        opts[:highlight]       = $5
+        new($1, $2, opts)
+      end
+    end
+
+    attr_reader :filename, :sectionname, :opts
+
+    def initialize(filename, sectionname, opts)
+      @filename    = filename
+      @sectionname = sectionname
+      @opts        = opts
+    end
+
+    # Returns the formatted code or an error message
+    def to_s
+      return unless filename
+
+      result = []
+      result << "%= lang:#{language}#{opts[:highlight]}"
+      result << '\begin{code}'
+      result.concat(raw_code)
+      result << '\end{code}'
+
+      rescue CodeInclusionException => e
+        code_error(e.message)
+    end
+
+    def raw_code
+      reader.read
+    end
+
+    private
+
+    # Manufacture a reader of the appriopriate type
+    def reader
+      @reader ||=
+        if opts[:tag]
+          GitTaggedFileReader.new(filename,
+                                  sectionname,
+                                  opts.delete(:tag),
+                                  opts)
+        elsif sectionname
+          SectionReader.new(filename, sectionname)
+        else
+          FileReader.new(filename)
+        end
+    end
+
+    def language
+      extension_array     = File.extname(filename).scan(/\.(.*)/).first
+      lang_from_extension = extension_array.nil? ? nil : extension_array[0]
+      (opts[:custom_language] || lang_from_extension || DEFAULT_LANGUAGE)
+    end
+
+    def code_error(details)
+      ["\\verb+ERROR: #{details}+"]
+    end
+  end
+
+
+  # GitTaggedFileReader retrieves code from a
+  # tagged file in your local git repository.
+  #
+  #  Example: <<(lib/polytexnic/literal.rb, tag: v0.9.4)
+  class GitTaggedFileReader
+
+    def self.git
+      Git.new
+    end
+
+    attr_reader :filename, :sectionname, :tagname, :opts, :git
+
+    def initialize(filename, sectionname, tagname, opts={}, git=self.class.git)
+      @filename    = filename
+      @sectionname = sectionname
+      @tagname     = tagname
+      @opts        = opts
+      @git         = git
+    end
+
+    def read
+      ensure_tag_exists!
+
+      Dir.mktmpdir {|tmpdir|
+        checkout_file!(tmpdir)
+        read_file(tmpdir)
+      }
+    end
+
+    private
+
+    def ensure_tag_exists!
+      unless git.tag_exists?(tagname)
+        raise(CodeInclusionException, "Tag '#{tagname}' does not exist.")
+      end
+    end
+
+    def checkout_file!(tmpdir)
+      output = git.checkout(tmpdir, filename, tagname)
+      unless git.checkout_succeeded?
+        raise(CodeInclusionException, improve_error_message(output, tmpdir))
+      end
+    end
+
+    def read_file(tmpdir)
+      tmpfilename = File.join(tmpdir, filename)
+      CodeInclusion::Code.new(tmpfilename, sectionname, opts).raw_code
+    end
+
+    def improve_error_message(msg, tmpdir)
+        msg.gsub(/#{tmpdir}/, '').chomp(".\n") + " in tag #{tagname}."
+    end
+
+
+    class Git
+      def checkout(tmpdir, filename, tagname)
+        `git --work-tree=#{tmpdir} checkout #{tagname} #{filename} 2>&1`
+      end
+
+      def checkout_succeeded?
+        $? == 0
+      end
+
+      def tags
+        `git tag`
+      end
+
+      def tag_exists?(tagname)
+        tags.split("\n").include?(tagname)
+      end
+    end
+  end
+
+
+  # FileReader retrieves code from a file on disk.
+  #
+  #  Example: <<(lib/polytexnic/literal.rb)
+  class FileReader
+    attr_reader :filename
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def read
+      ensure_file_exists!
+      File.read(filename).split("\n")
+    end
+
+    def ensure_file_exists!
+      unless File.exist?(filename)
+       raise(CodeInclusionException, "File '#{filename}' does not exist")
+      end
+    end
+  end
+
+
+  # SectionReader retrieves code from a marked section in a file on disk.
+  #
+  #  Example: <<(lib/polytexnic/literal.rb[my_section])
+  #
+  # Sections are delineated by '#// begin section_name' and '#// end',
+  # for example:
+  #
+  #   #// begin my_section
+  #   some code
+  #   #// end
+  class SectionReader < FileReader
+    attr_reader :lines, :sectionname
+
+    def initialize(filename, sectionname)
+      super(filename)
+      @sectionname = sectionname
+    end
+
+    def read
+      @lines = super
+      ensure_section_exists!
+      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 {|line| clean(line) == 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 { |line|
+        clean(line) == (section_end_text)
+      }
+    end
+
+    def marker
+      '#//'
+    end
+
+    def section_begin_text
+      "#{marker} begin #{sectionname}"
+    end
+
+    def section_end_text
+      "#{marker} end"
+    end
+
+    def clean(str)
+      str.strip.squeeze(" ")
+    end
+
+    def ensure_section_exists!
+      unless exist?
+        section_err = "Could not find section header '#{section_begin_text}'"
+        file_err    = " in file '#{filename}'"
+        raise(CodeInclusionException, section_err + file_err)
+      end
+    end
+  end
+end

data/lib/polytexnic/literal.rb

@@ -6,15 +6,6 @@ module Polytexnic
     # %= 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*([^\s]+?)             # path to file
-                             (?:\[(.+?)\])?           # optional section name
-                             (?:,\s*lang:\s*(\w+))?   # optional lang
-                             (,\s*options:\s*.*)?     # optional options
-                             \s*\)                    # closing paren
-                             /x
 
     # Makes the caches for literal environments.
     def cache_literal(polytex, format = :html)
@@ -74,7 +65,7 @@ module Polytexnic
         elsif line =~ /\s*\\end\{codelisting\}/ && !in_verbatim
           in_codelisting = false
           output << line
-        elsif line =~ CODE_INCLUSION_REGEX && !in_verbatim
+        elsif (included_code = CodeInclusion::Code.for(line)) && !in_verbatim
           # Reduce to a previously solved problem.
           # We transform
           # %= <<(/path/to/file.rb)
@@ -84,10 +75,7 @@ module Polytexnic
           # <content of file or section.rb>
           # \end{code}
           # and then prepend the code to the current `lines` array.
-          filename, sectionname, custom_language, highlight_options = $1, $2, $3, $4
-          if filename
-            lines.unshift(*include_code(filename, sectionname, custom_language, highlight_options))
-          end
+          lines.unshift(*included_code.to_s)
         elsif line.begin_literal?
           in_verbatim = true
           literal_type = line.literal_type
@@ -160,34 +148,6 @@ 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'
@@ -288,61 +248,9 @@ 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
 
-
 class String
   include Polytexnic::Literal
 
@@ -391,3 +299,4 @@ class String
       end.join('|')
     end
 end
+

data/lib/polytexnic/postprocessors/html.rb

@@ -27,6 +27,7 @@ module Polytexnic
         headings(doc)
         sout(doc)
         kode(doc)
+        coloredtext(doc)
         filepath(doc)
         backslash_break(doc)
         spaces(doc)
@@ -601,6 +602,14 @@ module Polytexnic
           end
         end
 
+        def coloredtext(doc)
+          doc.xpath('//coloredtext').each do |node|
+            node.name  = 'span'
+            node['style'] = "color: #{node['color']}"
+            clean_node node, 'color'
+          end
+        end
+
         # Converts filesystem path (\filepath) to the proper tag.
         def filepath(doc)
           doc.xpath('//filepath').each do |node|

data/lib/polytexnic/preprocessor.rb

@@ -1,5 +1,6 @@
 # encoding=utf-8
 require 'polytexnic/literal'
+require 'polytexnic/code_inclusion'
 require 'polytexnic/preprocessors/html'
 require 'polytexnic/preprocessors/latex'
 require 'polytexnic/preprocessors/polytex'

data/lib/polytexnic/utils.rb

@@ -112,6 +112,7 @@ module Polytexnic
 \newcommand{\codecaption}[1]{\xmlelt{heading}{#1}}
 \newcommand{\sout}[1]{\xmlelt{sout}{#1}}
 \newcommand{\kode}[1]{\xmlelt{kode}{#1}}
+\newcommand{\coloredtext}[2]{\xmlelt{coloredtext}{\AddAttToCurrent{color}{#1}#2}}
 \newcommand{\filepath}[1]{\xmlelt{filepath}{#1}}
 \newcommand{\image}[1]{\xmlelt{image}{#1}}
 \newcommand{\imagebox}[1]{\xmlelt{imagebox}{#1}}

data/lib/polytexnic/version.rb

@@ -1,3 +1,3 @@
 module Polytexnic
-  VERSION = "0.9.9"
+  VERSION = "0.9.10"
 end

data/spec/to_html/literal_environments/code_spec.rb

@@ -238,6 +238,140 @@ describe Polytexnic::Pipeline do
       end
       it { should include "ERROR: File 'foobar.rb' does not exist" }
     end
+
+
+
+    context "from a git tag" do
+      shared_examples "an inclusion" do
+        it "resembles the given output" do
+          allow(CodeInclusion::GitTaggedFileReader).to receive(:git).
+            and_return(FakeGit.new)
+          expect(processed_text).to resemble(output)
+        end
+      end
+
+      context "the tag and file exist" do
+        before(:all) do
+          class FakeGit < CodeInclusion::GitTaggedFileReader::Git
+            # Write fake data to location on disk where git _would_ have placed the file
+            def checkout(tmpdir, filename, tagname)
+              f = File.join(tmpdir, filename)
+              File.open(f, 'w') { |file| file.write("Fake data") }
+            end
+            def tag_exists?(tagname)
+              true
+            end
+            def checkout_succeeded?
+              true
+            end
+          end
+        end
+
+        context "with tag only" do
+          let(:polytex) do <<-'EOS'
+            %= <<(tagged_file.rb, tag: fake_tag.1.0)
+            EOS
+          end
+          let(:output) do <<-'EOS'
+            <div class="code">
+              <div class="highlight">
+                <pre>
+                  <span class="no">Fake</span> <span class="n">data</span>
+                </pre>
+            </div>
+            EOS
+          end
+          it_behaves_like "an inclusion"
+        end
+
+        context "with other params" do
+          let(:output) do <<-'EOS'
+            <div class="code">
+              <div class="highlight">
+                <pre>Fake data</pre>
+              </div>
+            </div>
+            EOS
+          end
+
+          context "with tag and lang" do
+            let(:polytex) do <<-'EOS'
+              %= <<(tagged_file.rb, tag: slashes/and-dashes-are/ok/too, lang: tex)
+              EOS
+            end
+            it_behaves_like "an inclusion"
+          end
+
+          context "with tag, lang and options" do
+            let(:polytex) do <<-'EOS'
+              %= <<(tagged_file.rb, tag: v0.9.4, lang: tex, options: "hl_lines": [5])
+              EOS
+            end
+            it_behaves_like "an inclusion"
+          end
+        end
+      end
+
+      context "the tag does not exist" do
+        before(:all) do
+          class FakeGit < CodeInclusion::GitTaggedFileReader::Git
+            def checkout(tmpdir, filename, tagname)
+            end
+            def tag_exists?(tagname)
+              false
+            end
+            def checkout_succeeded?
+              false
+            end
+          end
+        end
+
+        let(:polytex) do <<-'EOS'
+          %= <<(tagged_file.rb, tag: non_existent_tag)
+          EOS
+        end
+        let(:output) do <<-'EOS'
+          <p>
+             <span class="inline_verbatim">
+               ERROR: Tag 'non_existent_tag' does not exist.
+             </span>
+           </p>
+           EOS
+        end
+        it_behaves_like "an inclusion"
+      end
+
+      context "the file does not exist" do
+        before(:all) do
+          class FakeGit < CodeInclusion::GitTaggedFileReader::Git
+            def checkout(tmpdir, filename, tagname)
+              "pathspec #{tmpdir}/non_existent_file did not match any file(s) known to git.\n"
+            end
+            def tag_exists?(tagname)
+              true
+            end
+            def checkout_succeeded?
+              false
+            end
+          end
+        end
+
+        let(:polytex) do <<-'EOS'
+          %= <<(non_existent_file, tag: v0.9.4)
+          EOS
+        end
+        let(:output) do <<-'EOS'
+          <p>
+             <span class="inline_verbatim">
+               ERROR: pathspec /non_existent_file did not match any file(s) known to git in tag v0.9.4.
+             </span>
+           </p>
+           EOS
+        end
+        it_behaves_like "an inclusion"
+      end
+
+    end
   end
 end
 
@@ -254,4 +388,4 @@ end
 #// begin section_z
 "This is section_z; it's used by a test."
 "Section Z is your friend."
-#// end
+#// end

data/spec/to_html/text_formatting_spec.rb

@@ -46,5 +46,10 @@ describe 'Polytexnic::Pipeline#to_html' do
       let(:polytex) { '\kode{function\_name}' }
       it { should resemble '<code>function_name</code>' }
     end
+
+    describe "color command" do
+      let(:polytex) { '\coloredtext{red}{text}' }
+      it { should resemble '<span style="color: red">text</span>' }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polytexnic
 version: !ruby/object:Gem::Version
-  version: 0.9.9
+  version: 0.9.10
 platform: ruby
 authors:
 - Michael Hartl
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -212,6 +212,7 @@ files:
 - README.md
 - Rakefile
 - lib/polytexnic.rb
+- lib/polytexnic/code_inclusion.rb
 - lib/polytexnic/literal.rb
 - lib/polytexnic/postprocessor.rb
 - lib/polytexnic/postprocessors/html.rb