proforma 1.0.0.pre.alpha

data/lib/proforma/modeling/pane/column.rb

@@ -0,0 +1,68 @@
+# 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.
+#
+
+module Proforma
+  module Modeling
+    class Pane
+      # A Pane Column is a list of lines that understands how to compile itself against a
+      # data source.
+      class Column
+        extend Forwardable
+        include Types::Align
+        acts_as_hashable
+
+        attr_writer :align,
+                    :label_width,
+                    :lines,
+                    :value_width
+
+        def_delegator :lines, :length, :line_count
+
+        def initialize(
+          align: LEFT,
+          label_width: nil,
+          lines: [],
+          value_width: nil
+        )
+          @align        = align
+          @label_width  = label_width
+          @lines        = Line.array(lines)
+          @value_width  = value_width
+        end
+
+        def align
+          @align || LEFT
+        end
+
+        def label_width
+          @label_width ? @label_width.to_f : nil
+        end
+
+        def value_width
+          @value_width ? @value_width.to_f : nil
+        end
+
+        def lines
+          Array(@lines)
+        end
+
+        def compile(record, evaluator)
+          compiled_lines = lines.map { |line| line.compile(record, evaluator) }
+
+          self.class.new(
+            align: align,
+            label_width: label_width,
+            lines: compiled_lines,
+            value_width: value_width
+          )
+        end
+      end
+    end
+  end
+end

data/lib/proforma/modeling/pane/line.rb

@@ -0,0 +1,42 @@
+# 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.
+#
+
+module Proforma
+  module Modeling
+    class Pane
+      # A line is a single label:value entry in a pane.
+      class Line
+        include Compiling::Compilable
+        acts_as_hashable
+
+        attr_writer :label, :value
+
+        def initialize(label: '', value: '')
+          @label = label
+          @value = value
+        end
+
+        def label
+          @label.to_s
+        end
+
+        def value
+          @value.to_s
+        end
+
+        def compile(record, evaluator)
+          self.class.new(
+            label: evaluator.text(record, label),
+            value: evaluator.text(record, value)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/proforma/modeling/separator.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.
+#
+
+module Proforma
+  module Modeling
+    # An object modeling of the notion of separation of two other models/sections.
+    class Separator
+      acts_as_hashable
+
+      def initialize(*); end
+    end
+  end
+end

data/lib/proforma/modeling/spacer.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.
+#
+
+module Proforma
+  module Modeling
+    # An object modeling of the notion of spacing between two other models/sections.
+    class Spacer
+      acts_as_hashable
+
+      def initialize(*); end
+    end
+  end
+end

data/lib/proforma/modeling/table.rb

@@ -0,0 +1,52 @@
+# 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_relative 'table/cell'
+require_relative 'table/row'
+require_relative 'table/section'
+
+module Proforma
+  module Modeling
+    # A basic table structure modeled off of an HTML table:
+    # A table has three sections: header, body, footer.
+    # Each section has rows.
+    # Each row has cells.
+    class Table
+      acts_as_hashable
+
+      attr_writer :body, :footer, :header
+
+      def initialize(body: Section.new, footer: Section.new, header: Section.new)
+        @body   = Section.make(body)
+        @footer = Section.make(footer)
+        @header = Section.make(header)
+      end
+
+      def body
+        @body || Section.new
+      end
+
+      def footer
+        @footer || Section.new
+      end
+
+      def header
+        @header || Section.new
+      end
+
+      def compile(data, evaluator)
+        self.class.new(
+          body: body.compile(data, evaluator),
+          footer: footer.compile(data, evaluator),
+          header: header.compile(data, evaluator)
+        )
+      end
+    end
+  end
+end

data/lib/proforma/modeling/table/cell.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.
+#
+
+module Proforma
+  module Modeling
+    class Table
+      # The lowest unit of a table.  Each row is comprised of zero or more cells.
+      class Cell
+        include Compiling::Compilable
+        include Types::Align
+        acts_as_hashable
+
+        attr_writer :align, :text, :width
+
+        def initialize(align: LEFT, text: '', width: nil)
+          @align  = align
+          @text   = text
+          @width  = width
+        end
+
+        def align
+          @align || LEFT
+        end
+
+        def text
+          @text.to_s
+        end
+
+        def width
+          @width ? @width.to_f : nil
+        end
+
+        def compile(data, evaluator)
+          self.class.new(
+            align: align,
+            text: evaluator.text(data, text),
+            width: width
+          )
+        end
+      end
+    end
+  end
+end

data/lib/proforma/modeling/table/row.rb

@@ -0,0 +1,24 @@
+# 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.
+#
+
+module Proforma
+  module Modeling
+    class Table
+      # The second lowest unit of a table.  A table's header, body, and footer is each
+      # composed of zero or more rows.
+      class Row < GenericContainer
+        acts_as_hashable
+
+        def initialize(cells: [])
+          super(:cells, Cell, cells)
+        end
+      end
+    end
+  end
+end

data/lib/proforma/modeling/table/section.rb

@@ -0,0 +1,23 @@
+# 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.
+#
+
+module Proforma
+  module Modeling
+    class Table
+      # A table section has zero or more rows.
+      class Section < GenericContainer
+        acts_as_hashable
+
+        def initialize(rows: [])
+          super(:rows, Row, rows)
+        end
+      end
+    end
+  end
+end

data/lib/proforma/modeling/text.rb

@@ -0,0 +1,37 @@
+# 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.
+#
+
+module Proforma
+  module Modeling
+    # Emit and render basic text against a record.
+    class Text
+      include Compiling::Compilable
+      extend Forwardable
+      acts_as_hashable
+
+      def_delegator :value, :empty?, :empty?
+
+      attr_writer :value
+
+      def initialize(value: '')
+        @value = value
+      end
+
+      def value
+        @value.to_s
+      end
+
+      def compile(data, evaluator)
+        self.class.new(
+          value: evaluator.text(data, value)
+        )
+      end
+    end
+  end
+end

data/lib/proforma/modeling/types.rb

@@ -0,0 +1,10 @@
+# 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_relative 'types/align'

data/lib/proforma/modeling/types/align.rb

@@ -0,0 +1,22 @@
+# 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.
+#
+
+module Proforma
+  module Modeling
+    module Types
+      # Abstract positioning. Describes how to position something (somewhere).
+      # Most likely use-case is for vertial/horizontal text alignment.
+      module Align
+        LEFT    = :left
+        CENTER  = :center
+        RIGHT   = :right
+      end
+    end
+  end
+end

data/lib/proforma/plain_text_renderer.rb

@@ -0,0 +1,106 @@
+# 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.
+#
+
+module Proforma
+  # A basic rendering engine that will output plain-text.  It is meant to serve as
+  # an example of how to create a rendering engine for this library.
+  class PlainTextRenderer
+    EXTENSION     = '.txt'
+    RENDER_PREFIX = 'render_'
+
+    private_constant :EXTENSION, :RENDER_PREFIX
+
+    attr_reader :column_separator, :line_length, :pane_separator
+
+    def initialize(column_separator: ', ', line_length: 40, pane_separator: ': ')
+      @column_separator = column_separator.to_s
+      @line_length      = line_length.to_i
+      @pane_separator   = pane_separator.to_s
+    end
+
+    def render(prototype)
+      @writer = StringIO.new
+
+      prototype.children.each do |child|
+        method_name = child_method_name(child)
+
+        raise ArgumentError, "Cannot render: #{method_name}" unless respond_to?(method_name, true)
+
+        send(method_name, child)
+      end
+
+      Document.new(
+        contents: writer.string,
+        extension: EXTENSION,
+        title: prototype.title
+      )
+    end
+
+    private
+
+    attr_reader :writer
+
+    def render_banner(banner)
+      write_line(line('='))
+      write_line(banner.title)
+      write_line(line('='))
+      write_line(banner.details)
+      write_line(line('='))
+    end
+
+    def render_header(header)
+      write_line(header.value.to_s.upcase)
+    end
+
+    def render_text(text)
+      write_line(text.value)
+    end
+
+    def render_separator(_separator)
+      write_line(line('-'))
+    end
+
+    def render_spacer(_separator)
+      write_line
+    end
+
+    def render_table(table)
+      write_section(table.header)
+      write_section(table.body)
+      write_section(table.footer)
+    end
+
+    def render_pane(pane)
+      pane.columns.each do |column|
+        column.lines.each do |line|
+          write_line("#{line.label}#{pane_separator}#{line.value}")
+        end
+      end
+    end
+
+    def child_method_name(child)
+      name = child.class.name.split('::').last.downcase
+      "#{RENDER_PREFIX}#{name}"
+    end
+
+    def write_line(text = '')
+      writer.puts(text)
+    end
+
+    def line(char)
+      char * line_length
+    end
+
+    def write_section(section)
+      section.rows.each do |row|
+        write_line(row.cells.map(&:text).join(column_separator))
+      end
+    end
+  end
+end