markover 0.6.0

data/lib/markover/markup.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+# This file is based on the markup class in gollum - https://github.com/github/gollum
+# (The MIT License)
+#
+# Copyright (c) Tom Preston-Werner, Rick Olson
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+require 'digest/sha1'
+
+require 'github/markup'
+require 'nokogiri'
+
+require 'markover/markup/yaml_frontmatter_remover'
+require 'markover/markup/code'
+require 'markover/markup/code_block'
+require 'markover/markup/renderer'
+
+module Markover
+  module Markup
+  end
+end

data/lib/markover/markup/code.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module Markover
+
+  module Markup
+
+    # Class that knows how to extract code blocks and render them with syntax highlightning
+    class Code
+
+      def initialize
+        @code_blocks = []
+      end
+
+      # Extract all code blocks into the codemap and replace with placeholders.
+      #
+      # @return [String] Returns the placeholder'd String data.
+      def extract(data)
+        data.gsub!(/^``` ?([^\r\n]+)?\r?\n(.+?)\r?\n```\r?$/m) do
+          id = Digest::SHA1.hexdigest($2)
+          @code_blocks << CodeBlock.new(id, $1, $2)
+          id
+        end
+        data
+      end
+
+      # Process all code from the codemap and replace the placeholders with the
+      # final HTML.
+      #
+      # @return [String] Returns the marked up String data.
+      def process(data)
+        return data if data.nil? || data.size.zero? || @code_blocks.size.zero?
+        @code_blocks.each do |block|
+          data.gsub!(block.id, block.highlighted)
+        end
+        data
+      end
+    end
+  end
+end
+

data/lib/markover/markup/code_block.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'coderay'
+
+module Markover
+
+  module Markup
+
+    # Class that contains data for a code block
+    class CodeBlock
+      attr_reader :id, :language, :code
+
+      def initialize(id, language, code)
+        @id, @language, @code = id, language, code
+      end
+
+      # Returns the code with syntax highlightning
+      # @return [String]
+      def highlighted
+        if @language
+          CodeRay.scan(@code, @language).html(:line_numbers => :table)
+        else
+          CodeRay.scan(@code, :text).div
+        end
+      end
+    end
+  end
+end
+
+

data/lib/markover/markup/renderer.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+module Markover
+
+  module Markup
+
+    # Contains functionality to render html from a markup file
+    class Renderer
+      # Initialize a new Markup object.
+      #
+      # @param [Markover::File] file  The Markover::File to process
+      # @param [Boolean] do_remove_yaml_front_matter Should we remove the front matter?
+      # @return [Markover::Markup]
+      def initialize(file, do_remove_yaml_front_matter = false)
+        @file = file
+        @do_remove_yaml_front_matter = do_remove_yaml_front_matter
+
+        @data = file.data
+        @code = Code.new
+        @yaml_frontmatter_remover = YamlFrontmatterRemover.new
+      end
+
+      # Render the content with Gollum wiki syntax on top of the file's own
+      # markup language.
+      #
+      # @return [String] The formatted data
+      def render
+        prepare_data
+        render_data
+        post_process_data
+
+        return @data
+      end
+
+      private
+
+      # Prepare data for rendering
+      def prepare_data
+        @data = @yaml_frontmatter_remover.process(@data) if @do_remove_yaml_front_matter
+        @data = @code.extract(@data)
+      end
+
+      # Do the markup to html rendering
+      def render_data
+        begin
+          @data = @data.force_encoding('utf-8') if @data.respond_to? :force_encoding
+          @data = GitHub::Markup.render(@file.filename, @data)
+          if @data.nil?
+            raise "There was an error converting #{@file.name} to HTML."
+          end
+        rescue Object => e
+          @data = %{<p class="markover-error">#{e.message}</p>}
+        end
+      end
+
+      # Do post processing on data
+      def post_process_data
+        @data = @code.process(@data)
+        doc  = Nokogiri::HTML::DocumentFragment.parse(@data, 'UTF-8')
+        @data = doc.to_xhtml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XHTML, :encoding => 'UTF-8')
+        @data.gsub!(/<p><\/p>/, '')
+      end
+    end
+  end
+end
+
+

data/lib/markover/markup/yaml_frontmatter_remover.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Markover
+
+  module Markup
+
+    # Class that knows how to remove yaml front matter
+    class YamlFrontmatterRemover
+
+      # Removes YAML Front Matter
+      # Useful if you want to PDF your Jekyll site.
+      def process(data)
+        data.gsub /^(---\s*\n.*?\n?)^(---\s*$\n?)/m, ''
+      end
+    end
+  end
+end

data/lib/markover/markupfile.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+module Markover
+
+  # Class used to load files and determine if they are valid
+  class MarkupFile
+    attr_reader :filename, :name, :data, :format
+
+    # Accepted formats
+    FORMATS = [:markdown, :textile, :rdoc, :org, :creole, :rest, :asciidoc, :pod, :roff, :mediawiki]
+
+    # Initializes the file object. Only reads contents if it's a valid file
+    def initialize(filename)
+      @filename = filename
+      extension = ::File.extname(@filename)
+      @format = load_format(extension)
+      @name = ::File.basename(@filename, extension)
+      @data = ::File.open(@filename, 'rb') { |f| f.read } if valid? && ::File.exists?(@filename)
+    end
+
+    # Is the file valid
+    # @return [Boolean]
+    def valid?
+      valid_format? @format
+    end
+
+    # Converts the format to a symbol if it's a valid format nil otherwise
+    # @param [String] format
+    # @return [Symbol|nil]
+    def load_format(format)
+      case format.to_s
+        when /(md|mkdn?|mdown|markdown)$/i
+          :markdown
+        when /(textile)$/i
+          :textile
+        when /(rdoc)$/i
+          :rdoc
+        when /(org)$/i
+          :org
+        when /(creole)$/i
+          :creole
+        when /(re?st(\.txt)?)$/i
+          :rest
+        when /(asciidoc)$/i
+          :asciidoc
+        when /(pod)$/i
+          :pod
+        when /(\d)$/i
+          :roff
+        when /(media)?wiki$/i
+          :mediawiki
+        else
+          nil
+      end
+    end
+
+    # Checks if the format is a valid one
+    # @param [String] format
+    # @return [Boolean]
+    def valid_format?(format)
+      return false if format.nil?
+
+      FORMATS.include? format.to_sym
+    end
+  end
+end
+

data/lib/markover/optionparser.rb

@@ -0,0 +1,93 @@
+require 'optparse'
+require 'markover/version'
+
+module Markover
+  class Parser
+    def self.parse!(args)
+      new.parse!(args)
+    end
+
+    def parse!(args)
+      return {} if args.empty?
+      options = {
+        outputdir: nil,
+        stylesheet: nil,
+        recursive: false,
+        merge: false,
+        filename: nil,
+        debug: false,
+        wkhtmltopdfparameters: '',
+        removefrontmatter: false,
+        table_of_contents: false
+      }
+      parser(options).parse!(args)
+      options
+    end
+
+    def parser(options)
+      OptionParser.new do |parser|
+        parser.banner = 'Usage: markover [options] [files or directories]'
+        parser.separator ''
+        parser.separator 'Options'
+
+        parser.on('-o', '--output-dir', '=OUTDIR',
+         'Save parsed files to OUTDIR.  Defaults to working directory.') do |value|
+
+          options[:outputdir] = value
+        end
+
+        parser.on('-s', '--stylesheet', '=SHEET',
+          'Override standard stylesheet with SHEET') do |value|
+
+          options[:stylesheet] = value
+        end
+
+        parser.on('-r', '--recursive',
+          'Recurse current or target directory and convert all valid markup files') do
+
+          options[:recursive] = true
+        end
+
+        parser.on('-m', '--merge', '=FILENAME',
+          'Merge any and all passed markup files into single file of the specified name') do |value|
+
+          options[:merge] = true
+          options[:filename] = value
+        end
+
+        parser.on('-d', '--debug', 'Dumps HTML output to stdout') do |value|
+          options[:debug] = true
+        end
+
+        parser.on('-w', '--wkhtmltopdf-params', '=PARAMS',
+          'Parameters to be passed on to wkhtmltopdf. Use "" if more than one parameter. See wkhtmltopdf usage for possible parameters.') do |value|
+          options[:wkhtmltopdfparameters] = value
+        end
+
+        parser.on('-o', '--remove-front-matter', 'Remove yaml frontmatter from your files.') do
+          options[:removefrontmatter] = true
+        end
+
+        parser.on('-n', '--output-filename', '=FILENAME',
+          'Sets the name of the output file. Only used with single file and in merge mode.') do |value|
+
+          options[:filename] = value
+        end
+
+        parser.on('-t', '--toc', 'Generate a table of contents') do
+          options[:table_of_contents] = true
+        end
+
+        parser.on('-v', '--version', 'Show version information and quit') do
+          puts Markover::Version
+          exit
+        end
+
+        parser.on('-?', '-h', '--help', 'Show this message') do
+          puts parser
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/markover/path.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+module Markover
+
+  # Class used to interact with directory structure
+  class Path
+
+    # Return an array of paths to valid markup file matching the passed pattern
+    # @param [String] target
+    # @param [Bool] recursive
+    # @return [Array] an array of valid files
+    def self.list_valid(target, recursive = false)
+      if recursive
+        target ||= Dir.pwd
+        if File.directory?(target)
+          target = File.join(target, '**', '*')
+        end
+      else
+        target ||= Dir.pwd
+        if File.directory?(target)
+          target = File.join(target, '*')
+        end
+      end
+
+      # Use select to support ruby 1.8
+      Dir.glob(target).select { |file| MarkupFile.new(file).valid? }
+    end
+  end
+end

data/lib/markover/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+module Markover
+  VERSION = "0.6.0"
+end
+

data/lib/markover/wkhtmltopdf.rb

@@ -0,0 +1,39 @@
+module Markover
+
+  # The class that communicates with wkhtmltopdf
+  class Wkhtmltopdf
+
+    # Set up options for wkhtmltopdf
+    # @param [String] parameters
+    def initialize(parameters = nil)
+      @parameters = parameters
+    end
+
+    # Convert the html to pdf and write it to file
+    # @param [String] html the html input
+    # @param [String] filename the name of the output file
+    def output_pdf(html, filename)
+      args = command(filename)
+      invoke = args.join(' ')
+
+      IO.popen(invoke, "wb+") do |pdf|
+        pdf.puts(html)
+        pdf.close_write
+        pdf.gets(nil)
+      end
+    end
+
+    # Assemble the command to run
+    # @param [String] filename the outputed pdf's filename
+    # @return [Array] a list of strings that make out the call to wkhtmltopdf
+    def command(filename)
+      [bin, @parameters, '--quiet', '-', "\"#{filename}\""].compact
+    end
+
+    # Find the wkhtmltopdf binary
+    # @return [String] the path to the binary
+    def bin
+      @bin ||= "\"#{(`which wkhtmltopdf`).chomp}\""
+    end
+  end
+end

data/spec/fixtures/autolink_url.md

@@ -0,0 +1,3 @@
+# Autolink url
+
+Autolink this https://github.com url.

data/spec/fixtures/code_block.textile

@@ -0,0 +1,8 @@
+a
+
+```ruby
+x = 1
+```
+
+b
+

data/spec/fixtures/code_block_with_utf8.textile

@@ -0,0 +1,7 @@
+Abcåäö
+
+```html
+<h1>Abcåäö</h1>
+<img src="åäö.png" alt="ÅÄÖ" />
+```
+