asciinurse 0.1.0

data/examples/charts/indicators.csv

@@ -0,0 +1,13 @@
+Month ,  Total
+Jan   ,  29.9
+Feb   ,  71.5
+Mar   ,  106.4
+Apr   ,  129.2
+May   ,  144.0
+Jun   ,  176.0
+Jul   ,  135.6
+Aug   ,  148.5
+Sep   ,  216.4
+Oct   ,  194.1
+Nov   ,  95.6
+Dec   ,  54.4

data/examples/convert.rb

@@ -0,0 +1,10 @@
+require 'asciidoctor'
+require 'asciidoctor-pdf'
+require_relative '../lib/asciinurse'
+
+@pdf = ARGV[0] == '--pdf'
+
+Dir['**/*.adoc'].each do |file|
+  Asciidoctor.convert_file file, header_footer: true, safe: :unsafe
+  Asciidoctor.convert_file file, backend: 'pdf', header_footer: true, safe: :unsafe if @pdf
+end

data/i18n/en_US.yml

@@ -0,0 +1,12 @@
+en_US:
+  document:
+    figure-caption: Figure
+    table-caption: Table
+    warning-caption: Warning
+    caution-caption: Caution
+    important-caption: Important
+    note-caption: Note
+    tip-caption: Tip
+    example-caption: Example
+    toc-title: Table of Contents
+    last-update-label: Last updated

data/i18n/pt_BR.yml

@@ -0,0 +1,12 @@
+pt_BR:
+  document:
+    figure-caption: Figura
+    table-caption: Tabela
+    warning-caption: Atenção
+    caution-caption: Cuidado
+    important-caption: Importante
+    note-caption: Nota
+    tip-caption: Dica
+    example-caption: Exemplo
+    toc-title: Índice
+    last-update-label: Atualizado em

data/lib/asciinurse.rb

@@ -0,0 +1,76 @@
+require 'asciidoctor'
+require 'yaml'
+require 'fileutils'
+require 'set'
+
+require_relative 'asciinurse/version'
+
+ENV['ASCIINURSE_USER_DIR'] ||= ('%s/.asciinurse' % ENV['HOME'])
+
+module Asciinurse
+
+  RESOURCE_PRECEDENCE = [
+      ENV['ASCIINURSE_USER_DIR'],
+      File.expand_path(File.dirname(__FILE__) + '/..')
+  ]
+
+  def self.add_custom_path(path)
+    RESOURCE_PRECEDENCE.insert 1, path
+  end
+
+  def self.find(path)
+    result = []
+    RESOURCE_PRECEDENCE.each do |basedir|
+      result += Dir["#{basedir}/#{path}"]
+    end
+    result
+  end
+
+  def self.find_resource(path)
+    find("resources/#{path}").first
+  end
+
+  def self.read_resource(path)
+    IO.read find_resource(path)
+  end
+
+  CONFIG = {}
+
+  def self.config(key)
+    result = CONFIG
+    key.to_s.split('.').each do |obj|
+      result = result[obj]
+    end
+    result
+  end
+
+  # reverse order so custom config can take precedence over built-in config
+  find('config/asciinurse.yml').reverse_each do |file|
+    CONFIG.merge! YAML::load_file(file)
+  end
+
+  TEMP_DIRS = Set::new
+
+  def self.tmp_dir(document)
+    basedir = document.attributes['docdir']
+    tmpdir = "#{basedir}/tmp"
+    FileUtils.mkpath tmpdir unless File.exist? tmpdir
+    TEMP_DIRS << tmpdir if document.attributes['backend'] == 'pdf'
+    tmpdir
+  end
+
+  at_exit do
+    TEMP_DIRS.each do |tmpdir|
+      FileUtils.rmtree tmpdir
+    end
+  end
+
+end
+
+require_relative 'asciinurse/extensions/charts/extension'
+require_relative 'asciinurse/extensions/i18n/extension'
+
+if File.exist? ENV['ASCIINURSE_USER_DIR']
+  custom_script = '%s/asciinurse.rb' % ENV['ASCIINURSE_USER_DIR']
+  require custom_script if File.exist? custom_script
+end

data/lib/asciinurse/extensions/charts/chart_data.rb

@@ -0,0 +1,57 @@
+require 'json'
+require 'csv'
+require 'erb'
+
+module Asciinurse
+  module Chart
+
+    class CSVData
+      def initialize(engine, attrs, csv_content)
+        defaults = Asciinurse.config "charts.#{engine}.defaults"
+        options = defaults.merge attrs if defaults
+        options ||= attrs
+        @engine = engine
+        @title = options['title']
+        @type = options['type']
+        @width = options['width']
+        @height = options['height']
+        @csv = CSV.parse(csv_content, :converters => :all)
+        parse_data
+      end
+
+      def to_chart_json
+        ERB.new(get_template).result binding
+      end
+
+      private
+
+      def get_template(default = 'generic.json.erb')
+        template = Asciinurse.find_resource "#{@engine}/templates/charts/#{@type}.json.erb"
+        template ||= Asciinurse.find_resource "#{@engine}/templates/charts/#{default}"
+        raise "Template not found for #{@engine}:#{@type}" unless template
+        IO.read template
+      end
+
+      def parse_data
+        @target = @csv[0][0]
+        @elements = @csv.size - 1
+        @series = []
+        @header = []
+        @elements.times do |n|
+          @header << @csv[n + 1].first
+        end
+        (@csv[0].size - 1).times do |n|
+          row = {
+              name: @csv[0][n + 1],
+              data: []
+          }
+          @elements.times do |el|
+            row[:data] << @csv[el + 1][n + 1]
+          end
+          @series << row
+        end
+      end
+
+    end
+  end
+end

data/lib/asciinurse/extensions/charts/extension.rb

@@ -0,0 +1,124 @@
+require 'asciidoctor/extensions'
+
+require_relative 'chart_data'
+
+module Asciinurse
+  module Chart
+    module ChartCreator
+
+      def get_engine(doc)
+        doc.attributes['charts'] || Asciinurse.config('charts.default')
+      end
+
+      def create_chart(parent, attrs, config)
+        document = parent.document
+        backend = document.attributes['backend']
+        if backend == 'html5'
+          html = create_from_json document, config
+          create_pass_block parent, html, attrs, subs: nil
+        else
+          attrs['target'] = create_image document, config, attrs
+          attrs['width'] ||= 480
+          attrs['height'] ||= 250
+
+          create_image_block parent, attrs
+        end
+      end
+
+      def create_from_json(document, config)
+        id = 'chart_%s' % document.counter(:chart_id)
+        engine = get_engine document
+        template = Asciinurse.read_resource "#{engine}/templates/chart.html.erb"
+        ERB.new(template).result binding
+      end
+
+      def create_from_csv(engine, data, attrs)
+        csv_data = CSVData::new engine, attrs, data
+        csv_data.to_chart_json
+      end
+
+      def create_image(document, config, attrs)
+        engine = get_engine document
+        converter_file = Asciinurse.config "charts.#{engine}.convert.file"
+        tmpdir = Asciinurse.tmp_dir document
+        id = document.counter(:chart_id)
+
+        config_file = "#{tmpdir}/config-#{id}.json"
+        image_file = "#{tmpdir}/chart-#{id}.png"
+
+        IO.write config_file, config
+
+        converter = Asciinurse.find_resource "#{engine}/converter/#{converter_file}"
+        command = Asciinurse.config("charts.#{engine}.convert.command") %
+            [converter, config_file, image_file]
+
+        `#{command}`
+        image_file
+      end
+
+    end
+
+    class ChartBlockMacro < Asciidoctor::Extensions::BlockMacroProcessor
+      include ChartCreator
+
+      use_dsl
+      named :chart
+      name_positional_attributes 'type', 'width', 'height'
+
+      def process(parent, target, attrs)
+        engine = get_engine parent.document
+        data_path = parent.normalize_asset_path(target, 'target')
+        data = parent.read_asset(data_path, warn_on_failure: true, normalize: true)
+        data = create_from_csv engine, data, attrs if data_path.end_with? '.csv'
+        create_chart parent, attrs, data
+      end
+
+    end
+
+    class ChartBlockProcessor < Asciidoctor::Extensions::BlockProcessor
+      include ChartCreator
+
+      use_dsl
+      named :chart
+      on_context :literal
+      name_positional_attributes 'type', 'width', 'height'
+      parse_content_as :raw
+
+      def process(parent, reader, attrs)
+        engine = get_engine parent.document
+        data = create_from_csv engine, reader.source, attrs
+        create_chart parent, attrs, data
+      end
+    end
+
+    class ChartAssetsDocinfoProcessor < Asciidoctor::Extensions::DocinfoProcessor
+      include ChartCreator
+
+      use_dsl
+      at_location :header
+
+      def process(doc)
+        engine = get_engine(doc)
+        scripts = Asciinurse.config "charts.#{engine}.include"
+        if doc.attributes['backend'] == 'html5'
+          (scripts.collect do |script|
+            if script.start_with? 'http'
+              "<script type='text/javascript' src='#{script}'></script>"
+            else
+              %(<script type="text/javascript">
+                #{Asciinurse.read_resource "#{engine}/javascripts/#{script}"}
+              </script>)
+            end
+          end).join $/
+        end
+      end
+
+    end
+  end
+end
+
+Asciidoctor::Extensions.register do |registry|
+  registry.block_macro Asciinurse::Chart::ChartBlockMacro
+  registry.block Asciinurse::Chart::ChartBlockProcessor
+  registry.docinfo_processor Asciinurse::Chart::ChartAssetsDocinfoProcessor
+end

data/lib/asciinurse/version.rb

@@ -0,0 +1,3 @@
+module Asciinurse
+  VERSION = '0.1.0'
+end

data/resources/googlecharts/converter/googlecharts-convert.js

@@ -0,0 +1,25 @@
+var fs = require('fs');
+var page = require('webpage').create();
+var system = require('system');
+
+var args = system.args;
+
+var scriptDir = args[0].replace(/googlecharts-convert\.js$/,'')
+var config = fs.read(args[1])
+var pageContent = fs.read(scriptDir + 'template.html')
+pageContent = pageContent.replace(/\$\{CONFIG}/g, config);
+
+var path = args[1] + '.html';
+fs.write(path, pageContent, 'w');
+
+page.viewportSize = {
+    width: 1024,
+    height: 768
+};
+
+page.open(args[1] + '.html', function() {
+    window.setTimeout(function () {
+        page.render(args[2]);
+        phantom.exit();
+    }, 1000);
+});

data/resources/googlecharts/converter/template.html

@@ -0,0 +1,24 @@
+<html>
+<head>
+    <meta charset="UTF-8">
+    <script type="text/javascript" src="https://www.google.com/jsapi"></script>
+    <script type="text/javascript">
+        google.load("visualization", "1.1", {packages: ["corechart", "bar", "line"]});
+        var drawChart = function (id, config) {
+            var div = document.getElementById(id)
+            div.style.width = config['style']['width']
+            div.style.height = config['style']['height']
+            var chart = new config['type'](div);
+            chart.draw(config['data'], config['options']);
+        }
+    </script>
+</head>
+<body>
+<div id="chart"></div>
+<script type="text/javascript">
+    google.setOnLoadCallback(function () {
+        drawChart('chart', ${CONFIG})
+    })
+</script>
+</body>
+</html>

data/resources/googlecharts/javascripts/global.js

@@ -0,0 +1,8 @@
+google.load("visualization", "1.1", {packages:["corechart", "bar", "line"]});
+var drawChart = function(id, config) {
+    var div = document.getElementById(id)
+    div.style.width = config['style']['width']
+    div.style.height = config['style']['height']
+    var chart = new config['type'](div);
+    chart.draw(config['data'], config['options']);
+}

data/resources/googlecharts/templates/chart.html.erb

@@ -0,0 +1,6 @@
+<div id='<%= id %>'></div>
+<script type="text/javascript">
+  google.setOnLoadCallback(function () {
+    drawChart('<%= id %>', <%= config %>)
+  })
+</script>

data/resources/googlecharts/templates/charts/bar.json.erb

@@ -0,0 +1,22 @@
+{
+  type: google.charts.Bar,
+  data: google.visualization.arrayToDataTable(<%= @csv.to_json %>),
+  options: {
+    chart: {
+      title: <%= @title.to_json %>
+    },
+    hAxis: {
+      title: <%= @header.first.to_json %>,
+      minValue: 0
+    },
+    vAxis: {
+      title: <%= @header.last.to_json %> ,
+      minValue: 0
+    },
+    bars: 'horizontal'
+  },
+  style: {
+    width: <%= @width.to_json %>,
+    height: <%= @height.to_json %>
+  }
+}

data/resources/googlecharts/templates/charts/column.json.erb

@@ -0,0 +1,22 @@
+{
+  type: google.charts.Bar,
+  data: google.visualization.arrayToDataTable(<%= @csv.to_json %>),
+  options: {
+    chart: {
+      title: <%= @title.to_json %>
+    },
+    hAxis: {
+      title: <%= @header.first.to_json %>,
+      minValue: 0
+    },
+    vAxis: {
+      title: <%= @header.last.to_json %> ,
+      minValue: 0
+    },
+    bars: 'vertical'
+  },
+  style: {
+    width: <%= @width.to_json %>,
+    height: <%= @height.to_json %>
+  }
+}

data/resources/googlecharts/templates/charts/donut.json.erb

@@ -0,0 +1,14 @@
+{
+  type: google.visualization.PieChart,
+  data: google.visualization.arrayToDataTable(<%= @csv.to_json %>),
+  options: {
+    chart: {
+      title: <%= @title.to_json %>
+    },
+    pieHole: 0.4
+  },
+  style: {
+    width: <%= @width.to_json %>,
+    height: <%= @height.to_json %>
+  }
+}