output_mode 1.0.0

data/lib/output_mode/default_erb.rb

@@ -0,0 +1,19 @@
+#==============================================================================
+# Refer to LICENSE.txt for licensing terms
+#==============================================================================
+
+require 'erb'
+
+module OutputMode
+  DEFAULT_ERB = ERB.new(<<~TEMPLATE, nil, '-')
+    <% each do |value, field:, padding:, **_| -%>
+    <%   if value.nil? && field.nil? -%>
+
+    <%   elsif field.nil? -%>
+     <%= pastel.bold '*' -%> <%= pastel.green value %>
+    <%   else -%>
+    <%= padding -%><%= pastel.blue.bold field -%><%= pastel.bold ':' -%> <%= pastel.green value %>
+    <%   end -%>
+    <% end -%>
+  TEMPLATE
+end

data/lib/output_mode/errors.rb

@@ -0,0 +1,30 @@
+#==============================================================================
+# Copyright 2020 William McCumstie
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#==============================================================================
+
+module OutputMode
+  class Error < StandardError; end
+end
+

data/lib/output_mode/output.rb

@@ -0,0 +1,127 @@
+#==============================================================================
+# Copyright 2020 William McCumstie
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#==============================================================================
+
+module OutputMode
+  # @abstract Defines the public interface to all subclasses
+  #
+  # Base outputting class that wraps an array of procs or other
+  # callable object. Each implementation must override the {#render} method
+  # so it returns an array.
+  class Output
+    # @!attribute [r] procs
+    #   @return [Array<#call>] the callable methods to generate output
+    # @!attribute [r] config
+    #   @return [Hash] additional key-values to modify the render
+    # @!attribute [r] default
+    #   @return either a static default or a column based array of defaults
+    # @!attribute [r] yes
+    #   @return either a static yes value or a column based array of values
+    # @!attribute [r] no
+    #   @return either a static no value or a column based array of values
+    attr_reader :procs, :config, :yes, :no, :default
+
+    # Creates a new outputting instance from an array of procs
+    #
+    # @param *procs [Array<#call>] an array of procs (or callable objects)
+    # @param default: [String] replaces _blanks_ with a static string
+    # @param default: [Array] replace _blanks_ on a per column basis. The last value is repeated if the +procs+ are longer.
+    # @param yes: [String] replaces +true+ with a static string
+    # @param yes: [Array] replaces +true+ on a per column basis. The last value is repeated if the +procs+ are longer.
+    # @param no: [String] replaces +false+ with a static string
+    # @param no: [Array] replaces +false+ on a per column basis. The last value is repeated if the +procs+ are longer.
+    # @param **config [Hash] a hash of additional keys to be stored
+    def initialize(*procs, default: nil, yes: 'true', no: 'false', **config)
+      @procs = procs
+      @config = config
+      @yes = yes
+      @no = no
+      @default = default
+    end
+
+    # Returns the results of the +procs+ for a particular +object+. It will apply the
+    # +default+, +yes+, and +no+ values.
+    def generate(object)
+      procs.each_with_index.map do |p, idx|
+        raw = p.call(object)
+        if raw == true
+          index_selector(:yes, idx)
+        elsif raw == false
+          index_selector(:no, idx)
+        elsif !default.nil? && (raw.nil? || raw == '')
+          index_selector(:default, idx)
+        else
+          raw
+        end
+      end
+    end
+
+    # @abstract It should be implemented by the subclass using the +generate+ method
+    # Renders the results of the procs into a string. Each data
+    # objects should be passed individual to each proc to generate the final
+    # output.
+    #
+    # The method must be overridden on all inherited classes
+    #
+    # @param *data [Array] a set of data to be rendered into the output
+    # @return [String] the output string
+    # @see #generate
+    def render(*data)
+      raise NotImplementedError
+    end
+
+    # A helper method for selecting elements from a source array or return
+    # a static value.
+    #
+    # @param [Symbol] method The source method on the +output+
+    # @param [Integer] index The index to lookup
+    #
+    # @overload index_selector(array_method, valid_index)
+    #   @param array_method A method that returns an array
+    #   @param valid_index An index that is less than the array's length
+    #   @return the value at the index
+    #
+    # @overload index_selector(array_method, out_of_bounds)
+    #   @param array_method A method that returns an array
+    #   @param out_of_bounds An index greater than the maximum array length
+    #   @return the last element of the array
+    #
+    # @overload index_selector(non_array_method, _)
+    #   @param non_array_method A method that does not return an array
+    #   @param _ The index is ignored
+    #   @return the result of the non_array_method
+    def index_selector(method, index)
+      source = public_send(method)
+      is_array = source.is_a? Array
+      if is_array && source.length > index
+        source[index]
+      elsif is_array
+        source.last
+      else
+        source
+      end
+    end
+  end
+end

data/lib/output_mode/outputs.rb

@@ -0,0 +1,36 @@
+#==============================================================================
+# Copyright 2020 William McCumstie
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#==============================================================================
+
+require 'output_mode/output'
+
+module OutputMode
+  module Outputs
+    Dir.glob(File.expand_path('outputs/*.rb', __dir__)).each do |path|
+      autoload File.basename(path).chomp('.rb').capitalize, path
+    end
+  end
+end
+

data/lib/output_mode/outputs/delimited.rb

@@ -0,0 +1,49 @@
+#==============================================================================
+# Copyright 2020 William McCumstie
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#==============================================================================
+
+require 'csv'
+
+module OutputMode
+  module Outputs
+    class Delimited < Output
+      # @return [Hash] additional options to CSV.new
+      # @see https://ruby-doc.org/stdlib-2.6.1/libdoc/csv/rdoc/CSV.html
+      def config; super; end
+
+      # Implements the render method using +CSV+
+      #
+      # @see OutputMode::Output#render
+      # @see CSV
+      def render(*data)
+        io = StringIO.new
+        csv = CSV.new(io, **config)
+        data.each { |d| csv << generate(d) }
+        io.tap(&:rewind).read
+      end
+    end
+  end
+end
+

data/lib/output_mode/outputs/tabulated.rb

@@ -0,0 +1,73 @@
+#==============================================================================
+# Copyright 2020 William McCumstie
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#==============================================================================
+
+require 'tty-table'
+
+module OutputMode
+  module Outputs
+    class Tabulated < Output
+      attr_reader :renderer, :header, :default, :block, :yes, :no
+
+      # @!attribute [r] renderer
+      #   @return [Symbol] the renderer type, see: https://github.com/piotrmurach/tty-table#32-renderer
+      # @!attribute [r] header
+      #   @return [Array] An optional header row for the table
+      # @!attribute [r] block
+      #   @return [#call] an optional block of code that configures the renderer
+
+      # @return [Hash] additional options to +TTY::Table+ renderer
+      # @see https://github.com/piotrmurach/tty-table#33-options
+      def config; super; end
+
+      # @overload initialize(*procs, renderer: nil, header: nil, **config)
+      #   @param [Array] *procs see {OutputMode::Outputs::Base#initialize}
+      #   @param [Symbol] :renderer override the default renderer
+      #   @param [Array<String>] :header the header row of the table
+      #   @param [Hash] **config additional options to the renderer
+      #   @yieldparam tty_table_renderer [TTY::Table::Renderer::Base] optional access the underlining TTY::Table renderer
+      def initialize(*procs,
+                     renderer: :unicode,
+                     header: nil,
+                     **config,
+                     &block)
+        @header = header
+        @renderer =  renderer
+        @block = block
+        super(*procs, **config)
+      end
+
+      # Implements the render method using +TTY::Table+
+      # @see OutputMode::Outputs::Base#render
+      # @see https://github.com/piotrmurach/tty-table
+      def render(*data)
+        table = TTY::Table.new header: header
+        data.each { |d| table << generate(d) }
+        table.render(renderer, **config, &block) || ''
+      end
+    end
+  end
+end
+

data/lib/output_mode/outputs/templated.rb

@@ -0,0 +1,128 @@
+#==============================================================================
+# Copyright 2020 William McCumstie
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#==============================================================================
+
+require 'pastel'
+
+require 'output_mode/default_erb'
+
+module OutputMode
+  module Outputs
+    class Templated < Output
+      Entry = Struct.new(:output, :model, :colorize) do
+        include Enumerable
+
+        # @yieldparam value An attribute to be rendered
+        # @yieldparam field: An optional field header for the value
+        # @yieldparam padding: A padding string which will right align the +field+
+        # @yieldparam **config TBA
+        def each
+          max = output.max_field_length
+          output.generate(model).each_with_index do |value, idx|
+            field = output.index_selector(:fields, idx)
+            padding = ' ' * (max - field.to_s.length)
+            yield(value, field: field, padding: padding)
+          end
+        end
+
+        # Renders an ERB object within the entry's context. This provides access to the
+        # +output+, +model+, and +enumerable+ methods
+        #
+        # @param [ERB] erb the ERB object which contains the template to be rendered
+        # @return [String] the result text
+        def render(erb)
+          erb.result(binding)
+        end
+
+        # Library for colorizing the output. It is automatically disabled when the
+        # +colorize+ flag is +false+
+        def pastel
+          @pastel ||= Pastel.new(enabled: colorize)
+        end
+      end
+
+      # @!attribute [r] erb
+      #   @return [ERB] The +erb+ object containing the template to be rendered.
+      # @!attribute [r] separator
+      # @!attribute [r] fields
+      # @!attribute [r] colorize
+      attr_reader :erb, :fields, :separator, :colorize
+
+      # Create a new +output+ which will render using +ERB+. The provided +template+ should
+      # only render the +output+ for a single +entry+ (aka model, record, data object, etc).
+      #
+      # The +template+ maybe either a +String+ or a +ERB+ object. Strings will automatically
+      # be converted to +ERB+ with the +trim_mode+ set to +-+.
+      #
+      # A default template will be used if one has not be provided.
+      #
+      # @see https://ruby-doc.org/stdlib-2.7.1/libdoc/erb/rdoc/ERB.html
+      # @see render
+      # @see DEFAULT_ERB
+      #
+      # @overload initialize(*procs, template: nil, fields: nil, seperator: "\n", yes: 'true', no: 'false', **config)
+      #   @param [Array] *procs see {OutputMode::Output#initialize}
+      #   @param [String] template: A string to be converted into +ERB+
+      #   @param [ERB] template: The +template+ object used by the renderer
+      #   @param [Array] fields: An optional array of field headers that map to the procs, repeating the last value if required
+      #   @param fields: A static value to use as all field headers
+      #   @param separator: The character(s) used to join the "entries" together
+      #   @param colorize: Flags if the caller wants the colorized version, this maybe ignored by +template+
+      #   @param [Hash] **config see {OutputMode::Output#initialize}
+      def initialize(*procs,
+                     template: nil,
+                     fields: nil,
+                     separator: "\n",
+                     colorize: false,
+                     **config)
+        @erb = DEFAULT_ERB
+        @fields = fields
+        @separator = separator
+        @colorize = colorize
+        super(*procs, **config)
+      end
+
+      # Implements the render method using the ERB +template+. The +template+ will
+      # be rendered within the context of an +Entry+. An +Entry+ object will be
+      # created/ rendered for each element of +data+
+      #
+      # @see OutputMode::Output#render
+      def render(*data)
+        data.map { |d| Entry.new(self, d, colorize).render(erb) }
+            .join(separator)
+      end
+
+      # Returns the length of the maximum field
+      def max_field_length
+        if fields.is_a? Array
+          fields.map { |f| f.to_s.length }.max
+        else
+          fields.to_s.length
+        end
+      end
+    end
+  end
+end
+