scribedown 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3493d9a579a7cb5cfb48987431d573d247f81e2e
+  data.tar.gz: f8c2f8412822c383ddc0064f319765dab602b796
+SHA512:
+  metadata.gz: 4c2f1a1d58274426b75f4a8af7010c6416a677af90ba9e07ce70ca20f48f77c192b0e22f88e9bea054d2c11251c7192d10830114df7fc09ea4a9f0c1ca354641
+  data.tar.gz: a2ddf98487a151031a8203533b69fcee56cb1ad4f1b5f66b3778fd78a2bfb42eaa82c1c4bbd5ada5e0d9f2bdf5f34a4e7ccbd1d9991a902d8c62f8a4153e96c1

data/bin/scribe

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'scribedown'
+
+primary_arg = ARGV[0]
+
+case primary_arg
+when 'i', 'init'
+  ScribeDown.init
+when 'g', 'generate'
+  ScribeDown.generate
+when 'c', 'create'
+  ARGV[1..-1].each do |name|
+    ScribeDown.new_section(name)
+  end
+end

data/lib/generate/helpers.rb

@@ -0,0 +1,19 @@
+require_relative '../res/resources'
+
+module ScribeDown
+  module Renderer
+    def self.link_to(text, url, options={})
+      extras = options.map {|k,v| "#{k}=\"#{v}\"" }.join ' '
+      "<a href=\"#{url}\" #{extras}>#{text}</a>"
+    end
+  
+    def self.stylesheet_tag(file_name)
+      "<style>\n" + Res.read_file(file_name) + "\n</style>"
+    end
+    
+    def self.image_tag(url, options={})
+      extras = options.map {|k,v| "#{k}=\"#{v}\"" }.join ' '
+      "<img src=\"#{url}\" #{extras}/>"
+    end
+  end
+end

data/lib/generate/renderer.rb

@@ -0,0 +1,55 @@
+require_relative '../res/resources'
+require_relative 'helpers'
+require 'pdfkit'
+
+module ScribeDown
+  module Renderer
+    @@settings = nil
+    @@sections = nil
+    @@templates = nil
+    
+    def self.head_tags
+      rendered = Array.new
+      @@settings[:styles].each do |style|
+        rendered.push(stylesheet_tag style)
+      end
+      rendered.join "\n\n"
+    end
+    
+    def self.content
+      rendered_sections = Array.new
+      @@sections.each do |section|
+        rendered_sections.push render_section(section)
+      end
+      rendered_sections.join "\n\n"
+    end
+    
+    def self.render_section(section)
+      if @@templates.has_key? section.container
+        template = @@templates[section.container]
+      else
+        template = Res.read_file(section.container, format: :plain)
+        @@templates[section.container] = template
+      end
+      content = Res.read_file(section.path, format: section.format.to_sym, binding: binding)
+      Res.erb_contents(template, binding)
+    end
+    
+    def self.add(file_name, options={})
+      options[:binding] = binding
+      Res.read_file(file_name, options)
+    end
+    
+    def self.to_html(sections, settings)
+      @@settings = settings
+      @@sections = sections
+      @@templates = Hash.new
+      title ||= settings[:title]
+      return Res.read_file(settings[:base], binding: binding)
+    end
+    
+    def self.to_pdf(html_content)
+      PDFKit.new(html_content).to_pdf
+    end
+  end
+end

data/lib/res/resources.rb

@@ -0,0 +1,89 @@
+require 'kramdown'
+require 'yaml'
+require 'erb'
+require 'csv'
+
+module ScribeDown
+  module Res
+    def self.root(file=nil)
+      path = File.expand_path '../..', File.dirname(__FILE__)
+      if file
+        path += '/' + file
+      end
+      return path
+    end
+  
+    def self.read_res(res_name)
+      File.open(self.root + '/resources/' + res_name).read()
+    end
+  
+    def self.read_file(file_name, options={})
+      binding = options[:binding]
+      format = options[:format]
+      only_in_fs = options[:in_fs]
+    
+      if File.exist? file_name
+        name = file_name
+      elsif File.exist?(root('resources/' + file_name)) && !only_in_fs
+        name = root('resources/' + file_name)
+      else
+        raise "File or resource does not exist: #{file_name}"
+      end
+    
+      contents = File.open(name).read()
+      if format == :plain
+        return contents
+      end
+      if binding && (name.end_with?('.erb') || format == :erb)
+        name = name.chomp('.erb')
+        contents = erb_contents(contents, binding)
+      end
+      if name.end_with?('.md') || name.end_with?('.markdown') || format == :markdown
+        contents = markdown_contents(contents)
+      end
+      if name.end_with?('.csv') || format == :csv
+        contents = csv_contents(contents)
+      end
+      return contents
+    end
+  
+    def self.markdown_contents(content)
+      Kramdown::Document.new(content, :auto_ids => true).to_html
+    end
+  
+    def self.erb_contents(contents, bind)
+      ERB.new(contents).result bind
+    end
+  
+    def self.yaml_contents(contents)
+      res = YAML.load(contents)
+      symbolize(res)
+      return res
+    end
+  
+    def self.csv_contents(contents)
+      all = CSV.parse(contents)
+      headers = all[0]
+      return if headers == nil
+      data = all[1..-1]
+      data_classes = headers.map {|h| h.gsub(/\W+/, '-') }
+    
+      read_file('csv_template.html.erb', binding: binding)
+    end
+  
+    def self.symbolize(hash)
+      hash.default_proc = proc do |h, k|
+       case k
+         when String then sym = k.to_sym; h[sym] if h.key?(sym)
+         when Symbol then str = k.to_s; h[str] if h.key?(str)
+       end
+      end
+    end
+  
+    def self.create_file(path, contents='')
+      File.open(path, 'w') do |file|
+        file.write(contents)
+      end
+    end
+  end
+end

data/lib/scribedown.rb

@@ -0,0 +1,92 @@
+require 'fileutils'
+require_relative 'res/resources'
+require_relative 'generate/helpers'
+require_relative 'generate/renderer'
+require_relative 'section'
+
+module ScribeDown
+  def self.generate(options={})
+    begin
+      settings = Res.yaml_contents(Res.read_file('scribe.yml', in_fs: true))
+    rescue Exception => e
+      abort "FATAL: Not a scribedown directory. Unable to read scribe.yml.\n" + e.message
+    end
+    sections_yaml = settings[:sections]
+    sections = Array.new
+    
+    lookup = lookup_files()
+    failed = Array.new
+    
+    glob_default = Res.yaml_contents(Res.read_file('default.yml'))[:default]
+    defaults = settings[:default] || {}
+    
+    if glob_default
+      defaults.merge! glob_default
+    end
+    Res.symbolize(defaults)
+    # Extra styles don't override the defaults
+    defaults[:styles] += defaults[:extra_styles] || []
+    
+    sections_yaml.each do |section|
+      name = section
+      ops = defaults.clone
+      if section.is_a? Hash
+        name = section.select {|k, v| v == nil }.first.first
+        ops = ops.merge(section)
+        ops.delete(name)
+      end
+      path = lookup[name.downcase]
+      if path
+        ops[:path] = path
+        ops[:name] = name
+        sections.push Section.new(ops)
+      else
+        failed.push section
+      end
+    end
+
+    output = defaults[:output]
+    type = output['default']
+    html = Renderer.to_html sections, defaults
+    if type == 'all' || type == 'html'
+      Res.create_file(defaults[:output]['html'], html)
+    end
+    if type == 'all' || type == 'pdf'
+      pdf = Renderer.to_pdf html
+      Res.create_file(defaults[:output]['pdf'], pdf)
+    end
+  end
+  
+  def self.lookup_files
+    file_lookup = Hash.new
+    Dir['**/*'].each do |file|
+      name = File.basename(file).split('.').first.downcase
+      file_lookup[name] = file
+    end
+    file_lookup
+  end
+  
+  def self.init
+    if File.exist? 'scribe.yml'
+      abort 'ScribeDown already initialised: scribe.yml exists'
+    end
+    FileUtils.cp_r(Res.root('resources/init/.'), '.')
+    # Res.create_file('scribe.yml', Res.read_res('scribe.yml'))
+    # Res.create_file('sections/default_section.md', Res.read_res('default_section.md'))
+  end
+  
+  def self.new_section(name)
+    begin
+      settings = Res.yaml_contents(Res.read_file('scribe.yml', in_fs: true))
+    rescue
+      abort 'FATAL: Not a scribedown directory. Unable to read scribe.yml.'
+    end
+    new_name = name.split('.').first
+    if new_name == name
+      name = name + '.md'
+    end
+    settings[:sections].push new_name
+    Res.create_file('sections/' + name, '# ' + new_name)
+    Res.create_file('scribe.yml', settings.to_yaml)
+  end
+end

data/lib/section.rb

@@ -0,0 +1,23 @@
+module ScribeDown
+  class Section
+    attr_accessor :options
+  
+    def initialize(options={})
+      self.options = options
+    end
+  
+    def to_s
+      "(#{path}: #{options})"
+    end
+    
+    def method_missing(method)
+      if options.has_key?(method.to_sym)
+        return self.options[method.to_sym]
+      elsif options.has_key?(method.to_s)
+        return self.options[method.to_s]
+      else
+        super.method_missing(method)
+      end
+    end
+  end
+end

data/resources/csv_template.html.erb

@@ -0,0 +1,20 @@
+<table id="<%= name.gsub(/\W+/, '-') %>">
+  <thead>
+    <tr>
+      <% headers.each do |header| %>
+        <th><%= header %></th>
+      <% end %>
+    </tr>
+  </thead>
+  <tbody>
+    <% data.each do |line| %>
+      <tr>
+        <% line.each_with_index do |el, idx| %>
+          <td class="<%= data_classes[idx] %>">
+            <%= el %>
+          </td>
+        <% end %>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/resources/default.yml

@@ -0,0 +1,12 @@
+default:
+  format: auto
+  base: index.html.erb
+  container: section.html.erb
+  styles:
+    - style.css
+  output:
+    default: all
+    html: index.html
+    pdf: document.pdf
+  classes: ''
+  

data/resources/index.html.erb

@@ -0,0 +1,9 @@
+<html>
+  <head>
+    <title><%= title %></title>
+    <%= head_tags %>
+  </head>
+  <body>
+    <%= content %>
+  </body>
+</html>

data/resources/init/scribe.yml

@@ -0,0 +1,3 @@
+sections:
+  - default_section
+  - info

data/resources/init/sections/default_section.md

@@ -0,0 +1,5 @@
+# Welcome to ScribeDown
+
+This is the default section. You can turn it into HTML or PDF by running `scribe generate`.
+
+You can add more files by adding to the  _sections_ folder and appending the name to _scribe.yml_. This config file defines the order of the sections and how they should appear.

data/resources/init/sections/info.csv

@@ -0,0 +1,3 @@
+Thing,Command
+Make a new ScribeDown document,scribe init
+Turn a ScribeDown doc into html,scribe generate

data/resources/section.html.erb

@@ -0,0 +1,3 @@
+<div id="<%= section.name %>" class="<%= section.classes.join(' ') rescue '' %>">
+  <%= content %>
+</div>

data/resources/style.css

@@ -0,0 +1,13 @@
+body {
+  width: 95%;
+  margin: auto;
+  font-family: sans-serif;
+}
+
+code {
+  font-family: "Anonymous Pro", "Menlo", monospace;
+}
+
+table {
+  width: 100%;
+}

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: scribedown
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Will Richardson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: pdfkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Markdown for report writing
+email: william.hamish@gmail.com
+executables:
+- scribe
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/scribe
+- lib/generate/helpers.rb
+- lib/generate/renderer.rb
+- lib/res/resources.rb
+- lib/scribedown.rb
+- lib/section.rb
+- resources/csv_template.html.erb
+- resources/default.yml
+- resources/index.html.erb
+- resources/init/scribe.yml
+- resources/init/sections/default_section.md
+- resources/init/sections/info.csv
+- resources/section.html.erb
+- resources/style.css
+homepage: http://javanut.net/scribedown
+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.8
+signing_key: 
+specification_version: 4
+summary: Markdown into a PDF
+test_files: []