proforma-html-renderer 1.0.0.pre.alpha

data/spec/proforma/html_renderer/object_writer_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe Proforma::HtmlRenderer::ObjectWriter do
+  let(:string_name) { 'string.txt.erb' }
+
+  let(:string_template) { 'String Value: <%= object %>' }
+
+  let(:writer) do
+    Proforma::HtmlRenderer::Writer.new(
+      files: { string_name => string_template }
+    )
+  end
+
+  subject do
+    described_class.new(
+      names_by_class: {
+        String => 'string.txt.erb'
+      },
+      writer: writer
+    )
+  end
+
+  context 'when using cached files' do
+    it 'renders template for String object' do
+      object = 'ABC123'
+      expected = "String Value: #{object}"
+
+      expect(subject.render(object)).to eq(expected)
+    end
+  end
+end

data/spec/proforma/html_renderer/proforma_writer_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe Proforma::HtmlRenderer::ProformaWriter do
+  it 'should provide a singleton instance' do
+    first_call = described_class.instance
+    second_call = described_class.instance
+
+    expect(first_call).to eq(second_call)
+  end
+end

data/spec/proforma/html_renderer/writer_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe Proforma::HtmlRenderer::Writer do
+  let(:intro_name) { 'example.txt.erb' }
+  let(:aloha_name) { 'aloha.txt.erb' }
+
+  let(:intro_template) { 'My name is <%= first_name %>' }
+
+  subject do
+    described_class.new(
+      directory: File.join(__dir__, '..', '..', 'fixtures'),
+      files: { intro_name => intro_template }
+    )
+  end
+
+  describe '#initialize with no arguments' do
+    it 'should set directory to this libraries template dir' do
+      actual    = File.expand_path(described_class.new.send(:directory))
+      expected  = File.expand_path(File.join(__dir__, '..', '..', '..', 'templates'))
+
+      expect(actual).to eq(expected)
+    end
+  end
+
+  context 'when using cached files' do
+    it 'renders ERB template' do
+      expected = 'My name is Earl'
+
+      expect(subject.render(intro_name, first_name: 'Earl')).to eq(expected)
+    end
+  end
+
+  context 'when not using cached files' do
+    it 'renders ERB template' do
+      expected = 'Aloha, Matty Cakes!'
+
+      expect(subject.render(aloha_name, full_name: 'Matty Cakes')).to eq(expected)
+    end
+  end
+end

data/spec/proforma/html_renderer_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'rendering_helper'
+require 'spec_helper'
+
+describe Proforma::HtmlRenderer do
+  specify 'snapshot has been un-modified' do
+    snapshot_dir = File.expand_path(File.join(__dir__, '..', 'fixtures', 'snapshot'))
+    rendering_helper = RenderingHelper.new(snapshot_dir)
+
+    actual_output = rendering_helper.render.map.with_index do |output, index|
+      [
+        rendering_helper.output_filename(output, index),
+        output.contents
+      ]
+    end.to_h
+
+    output_glob = File.join(snapshot_dir, 'output', '*')
+
+    expected_output = Dir[output_glob].map do |filename|
+      [File.basename(filename), File.open(filename, 'rb').read]
+    end.to_h
+
+    expect(actual_output).to eq(expected_output)
+  end
+end

data/spec/rendering_helper.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require './lib/proforma/html_renderer'
+
+# This class can render based on a conventional directory structure of input files.
+class RenderingHelper
+  class << self
+    def folders(path)
+      Dir.entries(path).select do |entry|
+        File.directory?(File.join(path, entry)) && !%w[. ..].include?(entry)
+      end
+    end
+  end
+
+  attr_reader :path
+
+  def initialize(path)
+    @path = path
+  end
+
+  def render
+    images    = images_hash(images_dir)
+    config    = yaml_read(config_filename)
+    data      = data_merge(config['data'], images)
+    template  = config['template']  || {}
+    evaluator = config['evaluator'] || Proforma::HashEvaluator.new
+    renderer  = config['renderer']  || Proforma::HtmlRenderer.new
+
+    Proforma.render(
+      data,
+      template,
+      evaluator: evaluator,
+      renderer: renderer
+    )
+  end
+
+  def render_and_save
+    output_dir = File.join(path, 'output')
+
+    FileUtils.mkdir_p(output_dir)
+
+    render.each_with_index do |output, index|
+      name = output_filename(output, index)
+      full_path = File.join(output_dir, name)
+
+      IO.write(full_path, output.contents)
+    end
+  end
+
+  def output_filename(output, index)
+    name_without_extension = [
+      index.to_s,
+      output.title.to_s
+    ].reject(&:empty?).join('.')
+
+    "#{name_without_extension}#{output.extension}"
+  end
+
+  private
+
+  def images_dir
+    File.join(path, 'images')
+  end
+
+  def config_filename
+    File.join(path, 'config.yml')
+  end
+
+  def yaml_read(file)
+    YAML.safe_load(File.open(file))
+  end
+
+  def data_merge(data, hash)
+    if data.is_a?(Array)
+      data.map do |record|
+        record.merge(hash)
+      end
+    elsif data.is_a?(Hash)
+      data.merge(hash)
+    end
+  end
+
+  def images_hash(path)
+    images_glob = File.join(path, '*')
+
+    Dir[images_glob].map do |image_filename|
+      key = File.basename(image_filename, File.extname(image_filename))
+      [key, File.open(image_filename, 'rb')]
+    end.to_h
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'fileutils'
+require 'pry'
+require 'pry-byebug'
+require 'yaml'
+
+unless ENV['DISABLE_SIMPLECOV'] == 'true'
+  require 'simplecov'
+  require 'simplecov-console'
+
+  SimpleCov.formatter = SimpleCov::Formatter::Console
+  SimpleCov.start do
+    add_filter %r{\A/spec/}
+  end
+end
+
+require './lib/proforma/html_renderer'

data/templates/banner.html.erb

@@ -0,0 +1,33 @@
+<%
+  def image_style
+    [].tap do |style|
+      style << "width: #{object.image_width}px" if object.image_width
+      style << "height: #{object.image_height}px" if object.image_height
+    end.join(';')
+  end
+
+  def image_cell_style
+    ['padding-right: 5px'].tap do |style|
+      style << "width: #{object.image_width}px" if object.image_width && object.image
+    end.join(';')
+  end
+%>
+
+<table class="banner">
+  <tbody>
+    <tr>
+      <% if object.image -%>
+        <td style="<%= image_cell_style -%>">
+          <img style="<%= image_style -%>" src="data:image/jpeg;charset=utf-8;base64,<%= Base64.encode64(object.image.read) -%>" />
+        </td>
+      <% end -%>
+      <td>
+        <% if !object.title.empty? -%>
+          <strong><%= object.title -%></strong>
+          <br>
+        <% end -%>
+        <%= object.details -%>
+      </td>
+    </tr>
+  </tbody>
+</table>

data/templates/header.html.erb

@@ -0,0 +1,3 @@
+<% unless !object.value.to_s.empty? -%>
+  <h1><%= object.value %></h1>
+<% end -%>

data/templates/pane.html.erb

@@ -0,0 +1,36 @@
+<%
+  col_count = object.columns&.length || 0
+  row_count = object.columns&.map { |c| c.lines.length }&.max || 0
+
+  def label_cell_style(column)
+    return unless column
+
+    ["font-weight: #{options.bold_weight}"].tap do |styles|
+      styles << "width: #{column.label_width}%" if column.label_width
+    end.join(';')
+  end
+
+  def value_cell_style(column)
+    return unless column
+
+    [].tap do |styles|
+      styles << "text-align: #{column.align}"   if !column.align.to_s.empty?
+      styles << "width: #{column.value_width}%" if column.value_width
+    end.join(';')
+  end
+%>
+
+<table class="pane">
+  <tbody>
+    <% (0...row_count).each do |row_index| -%>
+      <tr>
+        <% (0...col_count).each do |col_index| -%>
+          <% column = object.columns[col_index] -%>
+          <% line = column&.lines[row_index] -%>
+          <td style="<%= label_cell_style(column) -%>"><%= line&.label %></td>
+          <td style="<%= value_cell_style(column) -%>"><%= line&.value %></td>
+        <% end -%>
+      <tr>
+    <% end -%>
+  </tbody>
+</table>

data/templates/prototype.html.erb

@@ -0,0 +1,73 @@
+<!doctype html>
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <style>
+      * {
+        box-sizing: border-box;
+        font-family: <%= options.font_family %>;
+        font-size: <%= options.text_font_size %>px;
+        line-height: <%= options.text_font_size + options.line_height_increase %>px;
+        font-weight: normal;
+        margin: 0;
+        padding: 0;
+      }
+
+      strong {
+        font-weight: <%= options.bold_weight %>;
+      }
+
+      p, h1, table {
+        margin: 8px 0;
+      }
+
+      hr {
+        border-top: 1px solid black;
+      }
+
+      h1 {
+        font-size: <%= options.header_font_size %>px;
+        font-weight: <%= options.bold_weight %>;
+      }
+
+      body {
+        margin: 15px;
+      }
+
+      table {
+        border-collapse: collapse;
+        border-spacing: 0;
+        width: 100%;
+      }
+
+      td, th {
+        vertical-align: top;
+        text-align: left;
+        padding: 5px;
+      }
+
+      table.table th {
+        border-bottom: 1px solid black;
+      }
+
+      table.table tbody td {
+        border-bottom: 1px solid black;
+      }
+
+      table.table tfoot td, table.table th {
+        background-color: #D3D3D3;
+        font-weight: <%= options.bold_weight %>;
+      }
+
+      table.pane td, table.pane th {
+        padding: 5px 5px 5px 0;
+      }
+    </style>
+  </head>
+  <body>
+    <% object.children.each do |child| -%>
+      <%= ProformaWriter.render(child, options) %>
+    <% end -%>
+  </body>
+</html>

data/templates/separator.html.erb

@@ -0,0 +1 @@
+<hr>

data/templates/spacer.html.erb

@@ -0,0 +1 @@
+<br>

data/templates/table.html.erb

@@ -0,0 +1,42 @@
+<%
+  def cell_style(cell)
+    [].tap do |styles|
+      styles << "text-align: #{cell.align}" if !cell.align.to_s.empty?
+      styles << "width: #{cell.width}%"      if cell.width
+    end.join(';')
+  end
+%>
+
+<% if object.body.rows.any? -%>
+  <table class="table">
+    <thead>
+      <% object.header.rows.each do |row| -%>
+        <tr>
+          <% row.cells.each do |cell| -%>
+            <th style="<%= cell_style(cell) %>"><%= cell.text %></th>
+          <% end -%>
+        </tr>
+      <% end -%>
+    </thead>
+    <tbody>
+      <% object.body.rows.each do |row| -%>
+        <tr>
+          <% row.cells.each do |cell| -%>
+            <td style="<%= cell_style(cell) %>"><%= cell.text %></td>
+          <% end -%>
+        </tr>
+      <% end -%>
+    </tbody>
+    <tfoot>
+      <% object.footer.rows.each do |row| -%>
+        <tr>
+          <% row.cells.each do |cell| -%>
+            <td style="<%= cell_style(cell) %>"><%= cell.text %></td>
+          <% end -%>
+        </tr>
+      <% end -%>
+    </tfoot>
+  </table>
+<% elsif !object.empty_message.to_s.empty? -%>
+  <p><%= object.empty_message %></p>
+<% end -%>

data/templates/text.html.erb

@@ -0,0 +1,3 @@
+<% if !object.value.to_s.empty? -%>
+  <p><%= object.value %></p>
+<% end -%>

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification
+name: proforma-html-renderer
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.alpha
+platform: ruby
+authors:
+- Matthew Ruggio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: proforma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+description: "    Proforma is a virtual document object model.  This library allows
+  you to output HTML for a virtual Proforma document.\n"
+email:
+- mruggio@bluemarblepayroll.com
+executables:
+- console
+- render
+- snapshot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/render
+- bin/snapshot
+- lib/proforma/html_renderer.rb
+- lib/proforma/html_renderer/object_writer.rb
+- lib/proforma/html_renderer/proforma_writer.rb
+- lib/proforma/html_renderer/version.rb
+- lib/proforma/html_renderer/writer.rb
+- proforma-html-renderer.gemspec
+- spec/fixtures/aloha.txt.erb
+- spec/fixtures/snapshot/config.yml
+- spec/fixtures/snapshot/images/logo.png
+- spec/fixtures/snapshot/output/0.User List.html
+- spec/proforma/html_renderer/object_writer_spec.rb
+- spec/proforma/html_renderer/proforma_writer_spec.rb
+- spec/proforma/html_renderer/writer_spec.rb
+- spec/proforma/html_renderer_spec.rb
+- spec/rendering_helper.rb
+- spec/spec_helper.rb
+- templates/banner.html.erb
+- templates/header.html.erb
+- templates/pane.html.erb
+- templates/prototype.html.erb
+- templates/separator.html.erb
+- templates/spacer.html.erb
+- templates/table.html.erb
+- templates/text.html.erb
+homepage: https://github.com/bluemarblepayroll/proforma-html-renderer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Proforma renderer plugin for generating HTML.
+test_files:
+- spec/fixtures/aloha.txt.erb
+- spec/fixtures/snapshot/config.yml
+- spec/fixtures/snapshot/images/logo.png
+- spec/fixtures/snapshot/output/0.User List.html
+- spec/proforma/html_renderer/object_writer_spec.rb
+- spec/proforma/html_renderer/proforma_writer_spec.rb
+- spec/proforma/html_renderer/writer_spec.rb
+- spec/proforma/html_renderer_spec.rb
+- spec/rendering_helper.rb
+- spec/spec_helper.rb