RubyGems - riven - Versions diffs - 0.0.1 - Mend

riven 0.0.1

Files changed (19) hide show

checksums.yaml +7 -0
data/.gitignore +34 -0
data/Gemfile +3 -0
data/Gemfile.lock +21 -0
data/LICENSE +20 -0
data/README.md +130 -0
data/bin/riven +39 -0
data/css/style.css +757 -0
data/lib/riven.rb +3 -0
data/lib/riven/html_file.rb +17 -0
data/lib/riven/html_generator.rb +57 -0
data/lib/riven/markup/code.rb +44 -0
data/lib/riven/markup/code_block.rb +27 -0
data/lib/riven/markup_file.rb +40 -0
data/lib/riven/opt_parser.rb +77 -0
data/lib/riven/version.rb +3 -0
data/lib/riven/wkhtmltopdf.rb +27 -0
data/riven.gemspec +32 -0
metadata +118 -0

data/lib/riven.rb ADDED

@@ -0,0 +1,3 @@
+module Riven
+end

data/lib/riven/html_file.rb ADDED

@@ -0,0 +1,17 @@
+module Riven
+  class HTMLFile
+    attr_accessor :file_name
+    public def initialize(file_name)
+      @file_name = file_name
+    end
+    public def write(content)
+      File.open(@file_name, 'w') { |file| file.write(content) }
+    end
+    public def delete!
+      File.delete @file_name
+    end
+  end
+end

data/lib/riven/html_generator.rb ADDED

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'riven/html_file'
+require 'riven/markup/code'
+require 'redcarpet'
+module Riven
+  class HTMLGenerator
+    attr_accessor :html, :html_file
+    public def initialize(markup)
+      @html_file = Riven::HTMLFile.new('_riven_tmp_file.html')
+      @markup = markup
+      @html = generate_html
+      @html_file.write(@html)
+    end
+    public def generate_html
+      css = File.read(File.expand_path(File.dirname(__FILE__)) + '/../../css/style.css')
+      html =  '<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">'
+      html << '<style type="text/css">' + css + '</style></head><body>'
+      html << markup_to_html(@markup)
+      html << '</body></html>'
+    end
+    public def markup_to_html(markup)
+      code = Riven::Markup::Code.new
+      markup = code.extract(markup)
+      opts = {
+        no_intra_emphasis: true,
+        tables: true,
+        underline: true,
+        highlight: true,
+        filter_html: true,
+        with_toc_data: true,
+        lax_spacing: true,
+        xhtml: true,
+        fenced_code_blocks: true
+      }
+      redcarpet_markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, opts)
+      html = redcarpet_markdown.render(markup)
+      html = code.process(html)
+      return html
+    end
+    public def close!
+      @html_file.delete!
+    end
+  end
+end

data/lib/riven/markup/code.rb ADDED

@@ -0,0 +1,44 @@
+require 'digest/sha1'
+require 'riven/markup/code_block'
+module Riven
+  module Markup
+    # Class that knows how to extract code blocks and render them with syntax highlightning
+    class Code
+      public def initialize
+        @code_blocks = []
+      end
+      # Extract all code blocks into the codemap and replace with placeholders.
+      #
+      # @return [String] Returns the placeholder'd String data.
+      public 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
+        return data
+      end
+      # Process all code from the codemap and replace the placeholders with the
+      # final HTML.
+      #
+      # @return [String] Returns the marked up String data.
+      public 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/riven/markup/code_block.rb ADDED

@@ -0,0 +1,27 @@
+require 'coderay'
+module Riven
+  module Markup
+    # Class that contains data for a code block
+    class CodeBlock
+      attr_reader :id, :language, :code
+      public def initialize(id, language, code)
+        @id, @language, @code = id, language, code
+      end
+      # Returns the code with syntax highlightning
+      # @return [String]
+      public def highlighted
+        if @language
+          CodeRay.scan(@code, @language).div(tab_width: 4)
+        else
+          CodeRay.scan(@code, :text).div
+        end
+      end
+    end
+  end
+end

data/lib/riven/markup_file.rb ADDED

@@ -0,0 +1,40 @@
+module Riven
+  #
+  # Represents a MD File
+  #
+  class MarkupFile
+    attr_accessor :path
+    #
+    # Constructor
+    # Also checks if the file exists. If not, an exception will be thrown.
+    #
+    public def initialize(path)
+      @path = File.expand_path(path)
+      unless File.exists?(@path)
+        raise "File '#{path}' doesn't exist"
+      end
+      if File.directory?(@path)
+        raise "Mixing files and directories is not allowed, sorry"
+      end
+    end
+    class << self
+      public def read_all(markup_files)
+        markup = ''
+        markup_files.each do |file|
+          markup << "\n\n" + File.read(file.path)
+        end
+        return markup
+      end
+    end
+  end
+end

data/lib/riven/opt_parser.rb ADDED

@@ -0,0 +1,77 @@
+require 'optparse'
+require 'riven'
+require 'riven/markup_file'
+module Riven
+  #
+  # Utility class to parse the options and files passed to the riven command
+  #
+  class OptParser
+    class << self
+      #
+      # Returns an array of Riven::MarkupFile for each given markdown file
+      #
+      public def files
+        file_names = ARGV
+        if file_names.size === 1 && File.directory?(file_names[0])
+          file_names = Dir["#{file_names[0]}/*.md"].sort
+        end
+        file_names.map { |file| Riven::MarkupFile.new(file) }
+      end
+      #
+      # Parses the options and returns a map with the options and their values.
+      #
+      public def options
+        options = {
+          output_file: '',
+          cover_file: '',
+          css_file: '',
+          toc: false,
+          dump_html: false
+        }
+        opt_parser = OptionParser.new do |opts|
+          opts.banner = 'Usage: riven [OPTIONS] Markdown Files'
+          opts.separator ''
+          opts.separator 'Options'
+          opts.on("-o FILE", "--output=FILE", "File name of the output PDF file") do |output_file|
+            options[:output_file] = output_file
+          end
+          opts.on("-s FILE", "--css=FILE", "Path to the custom CSS file") do |css_file|
+            options[:css_file] = css_file
+          end
+          opts.on("-c FILE", "--cover=FILE", "Path to the cover MD file") do |cover_file|
+            options[:cover_file] = cover_file
+          end
+          opts.on("-t", "--toc", "Enabled the table of contents auto generation") do
+            options[:toc] = true
+          end
+          opts.on("-d", "--dump-html", "Dumps the HTML file to STDOUT") do
+            options[:dump_html] = true
+          end
+          opts.on('-V', '--version', 'Displays the version') do
+            puts Riven::VERSION.to_s
+            exit
+          end
+        end
+        opt_parser.parse!
+        return options
+      end
+    end
+  end
+end

data/lib/riven/version.rb ADDED

@@ -0,0 +1,3 @@
+class Riven
+  VERSION = '0.0.1'
+end

data/lib/riven/wkhtmltopdf.rb ADDED

@@ -0,0 +1,27 @@
+module Riven
+  class Wkhtmltopdf
+    class << self
+      public def check_installation
+        `wkhtmltopdf -V > /dev/null 2>&1`
+        unless $?.exitstatus == 0
+          puts "Seems like wkhtmltopdf is not correctly installed or set up"
+          exit
+        end
+      end
+      public def generate_pdf(html_file, output_file)
+        params = [
+          '--disable-smart-shrinking',
+          '--page-size A4',
+          '--margin-bottom 10mm',
+          '--margin-top 10mm',
+          '--margin-left 8mm',
+          '--margin-right 8mm'
+        ]
+        output = `wkhtmltopdf #{params.join(' ')} #{html_file.file_name} #{output_file} 2>&1`
+      end
+    end
+  end
+end

data/riven.gemspec ADDED

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'riven/version'
+Gem::Specification.new do |spec|
+  spec.name          = 'riven'
+  spec.version       = Riven::VERSION
+  spec.date          = Time.now.strftime('%Y-%m-%d')
+  spec.summary       = 'Converts Markdown to PDF'
+  spec.description   = 'Converts GitHub Flavored Markdown to awesome looking PDFs! Featuring: ' +
+                       'Syntax Highlighting, Custom CSS, Covers, Table of Contents and more'
+  spec.authors       = ['Benjamin Kammerl']
+  spec.email         = 'benny@itws.de'
+  spec.homepage      = 'https://github.com/phortx/riven'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_dependency 'redcarpet', '~> 3.2'
+  spec.add_dependency 'coderay', '~> 1.1'
+end

metadata ADDED

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: riven
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Benjamin Kammerl
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 'Converts GitHub Flavored Markdown to awesome looking PDFs! Featuring:
+  Syntax Highlighting, Custom CSS, Covers, Table of Contents and more'
+email: benny@itws.de
+executables:
+- riven
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/riven
+- css/style.css
+- lib/riven.rb
+- lib/riven/html_file.rb
+- lib/riven/html_generator.rb
+- lib/riven/markup/code.rb
+- lib/riven/markup/code_block.rb
+- lib/riven/markup_file.rb
+- lib/riven/opt_parser.rb
+- lib/riven/version.rb
+- lib/riven/wkhtmltopdf.rb
+- riven.gemspec
+homepage: https://github.com/phortx/riven
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.5
+signing_key:
+specification_version: 4
+summary: Converts Markdown to PDF
+test_files: []