burr 0.0.2

data/lib/burr/liquid_ext/block.rb

@@ -0,0 +1,58 @@
+# steal from https://github.com/silas/liquid-blocks
+
+module Burr
+  class BlockDrop < ::Liquid::Drop
+    def initialize(block)
+      @block = block
+    end
+
+    def super
+      @block.call_super(@context)
+    end
+  end
+
+  class BlockTag < ::Liquid::Block
+    Syntax = /(\w)+/
+
+    attr_accessor :parent
+    attr_reader :name
+
+    def initialize(tag_name, markup, tokens)
+      if markup =~ Syntax
+        @name = $1
+      else
+        raise Liquid::SyntaxError.new("Syntax Error in 'block' - Valid syntax: block [name]")
+      end
+
+      super if tokens
+    end
+
+    def render(context)
+      context.stack do
+        context['block'] = BlockDrop.new(self)
+
+        render_all(@nodelist, context)
+      end
+    end
+
+    def add_parent(nodelist)
+      if parent
+        parent.add_parent(nodelist)
+      else
+        self.parent = BlockTag.new(@tag_name, @name, nil)
+        parent.nodelist = nodelist
+      end
+    end
+
+    def call_super(context)
+      if parent
+        parent.render(context)
+      else
+        ''
+      end
+    end
+
+  end
+end
+
+Liquid::Template.register_tag(:block, Burr::BlockTag)

data/lib/burr/liquid_ext/extends.rb

@@ -0,0 +1,114 @@
+# steal from https://github.com/silas/liquid-blocks
+
+module Burr
+  class ExtendsTag < ::Liquid::Block
+    Syntax = /(#{Liquid::QuotedFragment}+)/
+
+    def initialize(tag_name, markup, tokens)
+      if markup =~ Syntax
+        @template_name = $1
+      else
+        raise Liquid::SyntaxError.new("Syntax Error in 'extends' - Valid syntax: extends [template]")
+      end
+
+      super
+
+      @blocks = @nodelist.inject({}) do |m, node|
+        m[node.name] = node if node.is_a?(Burr::BlockTag); m
+      end
+    end
+
+    def parse(tokens)
+      parse_all(tokens)
+    end
+
+    def render(context)
+      template = load_template(context)
+      parent_blocks = find_blocks(template.root)
+
+      @blocks.each do |name, block|
+        if pb = parent_blocks[name]
+          pb.parent = block.parent
+          pb.add_parent(pb.nodelist)
+          pb.nodelist = block.nodelist
+        else
+          if is_extending?(template)
+            template.root.nodelist << block
+          end
+        end
+      end
+
+      template.render(context)
+    end
+
+    private
+
+    def parse_all(tokens)
+      @nodelist ||= []
+      @nodelist.clear
+
+      while token = tokens.shift
+        case token
+        when /^#{Liquid::TagStart}/
+          if token =~ /^#{Liquid::TagStart}\s*(\w+)\s*(.*)?#{Liquid::TagEnd}$/
+            # fetch the tag from registered blocks
+            if tag = Liquid::Template.tags[$1]
+              @nodelist << tag.new($1, $2, tokens)
+            else
+              # this tag is not registered with the system
+              # pass it to the current block for special handling or error reporting
+              unknown_tag($1, $2, tokens)
+            end
+          else
+            raise Liquid::SyntaxError, "Tag '#{token}' was not properly terminated with regexp: #{Liquid::TagEnd.inspect}"
+          end
+        when /^#{Liquid::VariableStart}/
+          @nodelist << create_variable(token)
+        when ''
+          # pass
+        else
+          @nodelist << token
+        end
+      end
+    end
+
+    def load_template(context)
+      base = File.join('templates', context.registers[:book].format, "_#{ @template_name[1..-2] }.liquid")
+      default = File.join(context.registers[:book].gem_dir, 'resources', base)
+      custom = File.join(context.registers[:book].root_dir, base)
+
+      if File.exist?(custom)
+        path = custom
+      elsif !File.exist?(custom) && File.exist?(default)
+        path = default
+      else
+        raise "#{ @template_name[1..-2] } missing!"
+      end
+
+      Liquid::Template.parse(File.read(path))
+    end
+
+    def find_blocks(node, blocks={})
+      if node.respond_to?(:nodelist) && !node.nodelist.nil?
+        node.nodelist.inject(blocks) do |b, node|
+          if node.is_a?(Burr::BlockTag)
+            b[node.name] = node
+          else
+            find_blocks(node, b)
+          end
+
+          b
+        end
+      end
+
+      blocks
+    end
+
+    def is_extending?(template)
+      template.root.nodelist.any? { |node| node.is_a?(ExtendsTag) }
+    end
+
+  end
+end
+
+Liquid::Template.register_tag(:extends, Burr::ExtendsTag)

data/lib/burr/plugin.rb

@@ -0,0 +1,70 @@
+module Burr
+
+  # steal from jekyll: https://github.com/mojombo/jekyll/blob/master/lib/jekyll/plugin.rb
+  class Plugin
+
+    PRIORITIES = {
+      :lowest  => -100,
+      :low     => -10,
+      :normal  => 0,
+      :high    => 10,
+      :highest => 100
+    }
+
+    VALIDS = [:before_parse, :after_parse, :before_decorate, :after_decorate]
+
+    class << self
+
+      # Install a hook so that subclasses are recorded. This method is only
+      # ever called by Ruby itself.
+      def inherited(base)
+        subclasses << base
+        subclasses.sort!
+      end
+
+      # The list of Classes that have been subclassed.
+      #
+      # @return An array of Class objects.
+      def subclasses
+        @subclasses ||= []
+      end
+
+      # Get or set the priority of this plugin. When called without an
+      # argument it returns the priority. When an argument is given, it will
+      # set the priority.
+      #
+      # @param [Symbol] priority The priority (default: nil). Valid options are:
+      #                          :lowest, :low, :normal, :high, :highest
+      # @return The Symbol priority.
+      def priority(priority=nil)
+        @priority ||= nil
+        if priority && PRIORITIES.has_key?(priority)
+          @priority = priority
+        end
+        @priority || :normal
+      end
+
+      # Spaceship is priority [higher -> lower]
+      #
+      # other - The class to be compared.
+      #
+      # Returns -1, 0, 1.
+      def <=>(other)
+        PRIORITIES[other.priority] <=> PRIORITIES[self.priority]
+      end
+
+    end
+
+    attr_accessor :book
+
+    # Initialize a new plugin. This should be overridden by the subclass.
+    #
+    # book - The book object.
+    #
+    # Returns a new instance.
+    def initialize(book)
+      @book = book
+    end
+
+  end
+end

data/lib/burr/plugins/aside.rb

@@ -0,0 +1,44 @@
+module Burr
+  class AsidePlugin < Plugin
+
+    # Do something after parsed the item content.
+    def after_parse
+      add_label
+    end
+
+    private
+
+    # Adds label and id to Aside block.
+    #
+    def add_label
+      item = self.book.current_item
+      return unless self.book.config['formats']["#{self.book.format}"]['label']['elements'].include?('aside')
+
+      counter = 1
+      number = if item['number']
+        item['number']
+      else
+        item['element']
+      end
+
+      dom = ::Nokogiri::HTML::DocumentFragment.parse(item['content'])
+      dom.css('div.aside').each do |aside|
+        # add id
+        aside['id'] = "aside-#{number}-#{counter}"
+
+        # add label
+        caption = aside.css('h4').first
+        unless caption.blank?
+          label = self.book.render_label('aside', { 'item' => { 'number' => number, 'counter' => counter } })
+          caption_html = "<span>#{label}</span>#{caption.inner_html}"
+          caption.children = ::Nokogiri::HTML.fragment(caption_html, 'utf-8')
+        end
+
+        counter += 1
+      end
+
+      item['content'] = dom.to_xhtml
+    end
+
+  end
+end

data/lib/burr/plugins/codeblock.rb

@@ -0,0 +1,42 @@
+module Burr
+  class CodeblockPlugin < Plugin
+
+    # Do something after parsed the item content.
+    def after_parse
+      add_label
+    end
+
+    private
+
+    # Adds label and id to code block.
+    #
+    def add_label
+      item = self.book.current_item
+      return unless self.book.config['formats']["#{self.book.format}"]['label']['elements'].include?('codeblock')
+
+      counter = 1
+      number = if item['number']
+        item['number']
+      else
+        item['element']
+      end
+
+      dom = ::Nokogiri::HTML::DocumentFragment.parse(item['content'])
+      dom.css('.codeblock.has-caption').each do |codeblock|
+        # add id
+        codeblock.set_attribute('id', "codeblock-#{number}-#{counter}")
+
+        # add label
+        caption = codeblock.css('.caption').first
+        label = self.book.render_label('codeblock', { 'item' => { 'number' => number, 'counter' => counter } })
+        caption_html = "<span>#{label}</span>#{caption.inner_html}"
+        caption.children = ::Nokogiri::HTML.fragment(caption_html, 'utf-8')
+
+        counter += 1
+      end
+
+      item['content'] = dom.to_xhtml
+    end
+
+  end
+end

data/lib/burr/plugins/figure.rb

@@ -0,0 +1,62 @@
+module Burr
+  class FigurePlugin < Plugin
+
+    # Do something after parsed the item content.
+    def after_parse
+      fix_src_for_pdf if self.book.format == 'pdf'
+
+      add_label
+    end
+
+    private
+
+    # Replaces figure src for pdf.
+    #
+    # 'figures/sample.png' => '<root_dir>/figures/sample.png'
+    #
+    def fix_src_for_pdf
+      item = self.book.current_item
+      prefix = File.join(self.book.outputs_dir, 'site')
+      dom = ::Nokogiri::HTML::DocumentFragment.parse(item['content'])
+      dom.search('img').each do |img|
+        ori_src = img.get_attribute('src')
+        new_src = File.join(prefix, ori_src)
+        img.set_attribute('src', new_src)
+      end
+      item['content'] = dom.to_xhtml
+
+      nil
+    end
+
+    # Adds label and id to figure block.
+    #
+    def add_label
+      item = self.book.current_item
+      return unless self.book.config['formats']["#{self.book.format}"]['label']['elements'].include?('figure')
+
+      counter = 1
+      number = if item['number']
+        item['number']
+      else
+        item['element']
+      end
+
+      dom = ::Nokogiri::HTML::DocumentFragment.parse(item['content'])
+      dom.css('div.figure').each do |figure|
+        # add id
+        figure.set_attribute('id', "figure-#{number}-#{counter}")
+
+        # add label
+        caption = figure.css('.caption').first
+        label = self.book.render_label('figure', { 'item' => { 'number' => number, 'counter' => counter } })
+        caption_html = "<span>#{label}</span>#{caption.inner_html}"
+        caption.children = ::Nokogiri::HTML.fragment(caption_html, 'utf-8')
+
+        counter += 1
+      end
+
+      item['content'] = dom.to_xhtml
+    end
+
+  end
+end

data/lib/burr/plugins/link.rb

@@ -0,0 +1,47 @@
+module Burr
+  class LinkPlugin < Plugin
+
+    # Do something after parsed the item content.
+    def after_parse
+      extend_url if %w(site epub).include?(self.book.format)
+    end
+
+    private
+
+    # Extends cross link url.
+    #
+    def extend_url
+      item = self.book.current_item
+      dom = ::Nokogiri::HTML::DocumentFragment.parse(item['content'])
+      dom.css('a[href]').each do |link|
+        href = link['href']
+        next unless cross_link?(href)
+
+        parts = href.split('-')
+
+        next if parts[0].start_with?('#fn')
+
+        if href.start_with?('#chapter')
+          new_href = "chapter#{parts[1]}.html"
+        elsif href.start_with?('#section', '#figure', '#codeblock', '#table', '#aside')
+          new_href = "chapter#{parts[1]}.html#{parts.join('-')}"
+        else
+          new_href = "#{href[1..-1]}.html"
+        end
+
+        link['href'] = new_href
+      end
+
+      item['content'] = dom.to_xhtml
+
+      nil
+    end
+
+    def cross_link?(url)
+      return true if url.start_with?('#')
+
+      false
+    end
+
+  end
+end

data/lib/burr/plugins/parser_plugin.rb

@@ -0,0 +1,18 @@
+module Burr
+  class ParserPlugin < Plugin
+
+    # Do something after parsed the item content.
+    def after_parse
+      #replace_br
+    end
+
+    private
+
+    # Replace <br> by <br/> (it causes problems for epub books)
+    def replace_br
+      item = self.book.current_item
+      item['content'].gsub!('<br>', '<br />')
+    end
+
+  end
+end