output_mode 1.1.1 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5a9cfc28a765bc0e31db2d2247f346f127cf99c4f4e630048b4882a539c1a03
-  data.tar.gz: 168a9b20db06828042673f7b4826f77367a10d283d2212a20d88eca3232fcde4
+  metadata.gz: f4492bb6d42dfd55f9f83ba7a3fd7fa9b21a2712760272cbd1d3500dafc11dd4
+  data.tar.gz: 71068e9161e4219ab85508a6692046f2de51d19a83c685b40fa9212ac0d40c46
 SHA512:
-  metadata.gz: bbefcfef7c8d46b95113b0877e84de60f852b8c3bac4d74575414215235796195c4f8447044ee92db11029e9edbfc269f092776c69e714fc8d91fc43319230bd
-  data.tar.gz: 3ff9cc52f21ab132ae2a673100354ff7e84eee824388315abf5563aeb181b35f82920d778e7e89bfbaa1e832bd31d377ce2865e1f5c73d5e88f7d6bafcdbfe6f
+  metadata.gz: 05d68669d5abbb2ac911531c8709d4d44898fcaae4fced442d5bf8ffc2d935d5c2ef8319bc2b28cb5e33fb7b033b236c57992d449b1de4c69f667b3248c8d08f
+  data.tar.gz: c6aae6fc8496bb491b4213173c4fc7bd57499efd9f2ec1e4367f3ec46b849c6be41453f17065c44a0b687aa40c1b6d1c677fe9578ad3dea11f8a92e31722f78a

data/Gemfile

@@ -28,3 +28,10 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in output_mode.gemspec
 gemspec
+
+# NOTE: Checks out the openflight version of tty-table with the 'rotate' flag
+# fix. This should eventually become part of the mainline version of TTY::Table
+#
+# This is intentionally not part of the gemspec so older versions of TTY::Table
+# can still be used
+gem 'tty-table', github: 'openflighthpc/tty-table', branch: '9b326fcbe04968463da58c000fbb1dd5ce178243'

data/README.md

@@ -63,5 +63,5 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Willia
 
 ## Copyright and License
 
-See [LICENSE](LICENSE.txt) for dual licensing details.
+See [LICENSE](LICENSE.txt) for licensing details.
 

data/bin/demo

@@ -1,22 +1,57 @@
 #!/usr/bin/env ruby
 #==============================================================================
-# Refer to LICENSE.txt for licensing terms
+# 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 "bundler/setup"
 require "output_mode"
+require 'erb'
 
 module DemoIndex
   extend OutputMode::TLDR::Index
 
-  register_callable(header: 'Integer') { |i| i }
-  register_callable(header: 'Standard') { 'always visible' }
+  register_callable(header: 'Integer', row_color: [:yellow, :bold]) { |i| i }
+  register_callable(header: 'Standard', header_color: [:strikethrough] ) { 'always visible' }
   register_callable(header: 'Verbose', verbose: true) { 'verbose visible' }
   register_callable(header: 'Simplified', verbose: false) { 'simplified visible' }
+  register_callable(header: 'Interactive', interactive: true) { 'interactive visible' }
+  register_callable(header: 'Non Interactive', interactive: false) { 'non-interactive visible' }
   register_callable(header: 'Yes/True') { true }
-  register_callable(header: 'No/False') { false }
+  register_callable(header: 'No/False', row_color: [:clear]) { false }
   register_callable(header: 'Missing') { nil }
+  register_callable(header: 'Inline') do |interactive:, verbose:|
+    if interactive && verbose
+      'interactive-verbose'
+    elsif interactive
+      'interactive-simplified'
+    elsif verbose
+      'non-interactive-verbose'
+    else
+      'non-interactive-simplified'
+    end
+  end
 end
 
 module DemoShow
@@ -26,14 +61,42 @@ module DemoShow
   register_callable(header: 'Standard') { 'always visible' }
   register_callable(header: 'Verbose', verbose: true) { 'verbose visible' }
   register_callable(header: 'Simplified', verbose: false) { 'simplified visible' }
-  register_callable(header: 'Yes/True') { true }
-  register_callable(header: 'No/False') { false }
+  register_callable(header: 'Interactive', interactive: true) { 'interactive visible' }
+  register_callable(header: 'Non Interactive', interactive: false) { 'non-interactive visible' }
+  register_callable(header: 'Yes/True', section: :boolean) { true }
+  register_callable(header: 'No/False', section: :boolean) { false }
   register_callable(header: 'Missing') { nil }
+  register_callable(header: 'Tab') { "tab1\ttab2" }
+  register_callable(header: 'New line') { "line1\nline2" }
 end
 
 data = [1, 2, 3]
 
+other_template = ERB.new(<<~TEMPLATE, nil, '-')
+# Non boolean values
+<% each(:other) do |value, field:, padding:, **_| -%>
+<%= padding -%><%= pastel.blue.bold field -%><%= pastel.bold ':' -%> <%= pastel.green value %>
+<% end -%>
+
+# Boolean Values
+<% each(:boolean) do |value, field:, padding:, **_| -%>
+<%= padding -%><%= pastel.blue.bold field -%><%= pastel.bold ':' -%> <%= pastel.green value %>
+<% end -%>
+TEMPLATE
+
 puts <<~EOF
+#==============================================================================
+#==============================================================================
+# INDEX OUTPUTS
+#==============================================================================
+#==============================================================================
+
+#==============================================================================
+# Default Demo Index
+# Simplified in interactive shells, verbose in non-interactive
+#==============================================================================
+#{DemoIndex.build_output.render(*data)}
+
 #==============================================================================
 # Demo Verbose Index
 #==============================================================================
@@ -41,10 +104,38 @@ puts <<~EOF
 
 #==============================================================================
 # Demo "Simplified" Index
-# NOTE: Disabled for non-interactive shell, shows the verbose output instead
 #==============================================================================
 #{DemoIndex.build_output(verbose: false).render(*data)}
 
+#==============================================================================
+# Force Interactive
+# Always print as if the shell is interactive
+#==============================================================================
+#{DemoIndex.build_output(interactive: true).render(*data)}
+
+#==============================================================================
+# Force Non-Interactive
+# Always print as if the shell is non-interactive
+#==============================================================================
+#{DemoIndex.build_output(interactive: false).render(*data)}
+
+#==============================================================================
+# Demo ASCII Index
+#==============================================================================
+#{DemoIndex.build_output(ascii: true).render(*data)}
+
+#==============================================================================
+#==============================================================================
+# SHOW OUTPUTS
+#==============================================================================
+#==============================================================================
+
+#==============================================================================
+# Default Settings
+# Simplified in interactive shells, verbose in non-interactive
+#==============================================================================
+#{DemoShow.build_output.render(*data)}
+
 #==============================================================================
 # Demo Verbose Show
 #==============================================================================
@@ -52,9 +143,30 @@ puts <<~EOF
 
 #==============================================================================
 # Demo "Simplified" Show
-# NOTE: Disabled for non-interactive shell, shows the verbose output instead
 #==============================================================================
 #{DemoShow.build_output(verbose: false).render(*data)}
-EOF
 
+#==============================================================================
+# Force Interactive
+# Always print as if the shell is interactive
+#==============================================================================
+#{DemoShow.build_output(interactive: true).render(*data)}
+
+#==============================================================================
+# Force Non-Interactive
+# Always print as if the shell is non-interactive
+#==============================================================================
+#{DemoShow.build_output(interactive: false).render(*data)}
+
+#==============================================================================
+# Demo ASCII Index
+#==============================================================================
+#{DemoShow.build_output(ascii: true).render(*data)}
 
+#==============================================================================
+# Group the boolean value separately
+# NOTE: This only occurs in interactive mode
+#       Non-Interactive sessions have a fix order
+#==============================================================================
+#{DemoShow.build_output(template: other_template).render(*data)}
+EOF

data/lib/output_mode/builder_dsl.rb

@@ -36,7 +36,9 @@ module OutputMode
     # @param config Directly provided to {OutputMode::Callable#initialize}
     # @yield Directly provided to {OutputMode::Callable#initialize}
     def register_callable(**config, &b)
-      output_callables << Callable.new(**config, &b)
+      Callable.new(**config, &b).tap do |c|
+        output_callables << c
+      end
     end
 
     # Provides the base method signature

data/lib/output_mode/callable.rb

@@ -26,16 +26,17 @@
 
 module OutputMode
   # Internal array like object that will convert procs to Callable
-  class Callables < Array
+  class Callables
+    include Enumerable
+
     # @api private
     def initialize(callables = nil)
+      @callables = []
       case callables
-      when Array
-        super().tap do |all|
-          callables.each { |c| all << c }
-        end
+      when Array, Callables
+        callables.each { |c| @callables << c }
       when nil
-        super()
+        # NOOP
       else
         raise "Can not convert #{callables.class} into a #{self.class}"
       end
@@ -43,13 +44,55 @@ module OutputMode
 
     def <<(item)
       if item.is_a? Callable
-        super
+        @callables << item
       elsif item.respond_to?(:call)
-        super(Callable.new(&item))
+        @callables << Callable.new(&item)
       else
         raise Error, "#{item.class} is not callable"
       end
     end
+
+    def each(&block)
+      @callables.each(&block)
+    end
+
+    def pad_each(key = :header, *ctx)
+      fields = self.map do |callables|
+        field = callables.config[key]
+        if field.respond_to?(:call) && ctx.empty?
+          raise Error, 'Can not pad dynamic fields without a context'
+        elsif field.respond_to?(:call)
+          field.call(*ctx).to_s
+        else
+          field.to_s
+        end
+      end
+
+      max_length = fields.map(&:length).max
+      pads = self.each_with_index.map do |callable, idx|
+        field = fields[idx]
+        length = max_length - field.length
+        [callable, { padding: ' ' * length, field: field }]
+      end
+
+      if block_given?
+        pads.each { |*args|  yield(*args) }
+      else
+        pads.each
+      end
+    end
+
+    def config_select(key, *values)
+      selected = self.select do |callable|
+        conf = callable.config[key]
+        if conf.is_a? Array
+          !(conf & values).empty?
+        else
+          values.include?(conf)
+        end
+      end
+      Callables.new(selected)
+    end
   end
 
   class Callable
@@ -141,6 +184,29 @@ module OutputMode
     def call(*a)
       callable.call(*a)
     end
+
+    def generator(output)
+      ->(*a) do
+        # Implicitly determine which parts of the context can be passed through
+        ctx = if callable.parameters.any? { |type, _| type == :keyrest }
+                output.context
+              else
+                keys = callable.parameters.select { |type, _| [:key, :keyreq].include?(type) }
+                                      .map { |_, k| k }
+                output.context.slice(*keys)
+              end
+        raw = call(*a, **ctx)
+        if raw == true
+          config[:yes] || output.yes
+        elsif raw == false
+          config[:no] ||  output.no
+        elsif [nil, ''].include?(raw)
+          config[:default] || output.default
+        else
+          raw
+        end
+      end
+    end
   end
 end
 

data/lib/output_mode/output.rb

@@ -36,45 +36,41 @@ module OutputMode
     # @!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
+    #   @return either a static default
     # @!attribute [r] yes
-    #   @return either a static yes value or a column based array of values
+    #   @return either a static yes value
     # @!attribute [r] no
-    #   @return either a static no value or a column based array of values
-    attr_reader :procs, :config, :yes, :no, :default
+    #   @return either a static no value
+    # @!attribute [r] context
+    #   @return a hash of keys to be provided to the callables
+    attr_reader :procs, :config, :yes, :no, :default, :context
 
     # 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 context: [Hash] of keys to be provided to the callables
     # @param **config [Hash] a hash of additional keys to be stored
-    def initialize(*procs, default: nil, yes: 'true', no: 'false', **config)
-      @procs = procs
+    def initialize(*procs, default: nil, yes: 'true', no: 'false', context: {}, **config)
+      @procs = Callables.new(procs)
       @config = config
       @yes = yes
       @no = no
       @default = default
+      @context = context
+    end
+
+    def callables
+      procs
     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
+      procs.map do |callable|
+        callable.generator(self).call(object)
       end
     end
 
@@ -91,37 +87,5 @@ module OutputMode
     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/delimited.rb

@@ -40,7 +40,12 @@ module OutputMode
       def render(*data)
         io = StringIO.new
         csv = CSV.new(io, **config)
-        data.each { |d| csv << generate(d) }
+        data.each do |datum|
+          csv << generate(datum).map do |value|
+            next nil if value.nil?
+            value.to_s.dump[1...-1]
+          end
+        end
         io.tap(&:rewind).read
       end
     end

data/lib/output_mode/outputs/tabulated.rb

@@ -29,33 +29,40 @@ 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
+      # @!attribute [r] colorize
+      #   @return [Boolean] enable or disabled the colorization
+      # @!attribute [r] header_color
+      #   @return An optional header color or array of colors
+      # @!attribute [r] row_color
+      #   @return An optional data color or array of colors
+      attr_reader :renderer, :default, :block, :yes, :no,
+                  :header_color, :row_color, :colorize
 
       # @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)
+      # @overload initialize(*procs, renderer: 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,
+                     colorize: false,
+                     header_color: nil,
+                     row_color: nil,
                      **config,
                      &block)
-        @header = header
         @renderer =  renderer
         @block = block
+        @header_color = header_color
+        @row_color = row_color
+        @colorize = colorize
         super(*procs, **config)
       end
 
@@ -63,10 +70,48 @@ module OutputMode
       # @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 = TTY::Table.new header: processed_header
+        data.each { |d| table << process_row(d) }
         table.render(renderer, **config, &block) || ''
       end
+
+      private
+
+      # Colorizes the header when requested
+      def processed_header
+        callables.map do |callable|
+          header = callable.config.fetch(:header, '')
+          color = callable.config.fetch(:header_color) || header_color
+          case color
+          when nil
+            header.to_s
+          when Array
+            pastel.decorate(header.to_s, *color)
+          else
+            pastel.decorate(header.to_s, color)
+          end
+        end
+      end
+
+      # Colorizes the row when requested
+      def process_row(model)
+        callables.map do |callable|
+          d = callable.generator(self).call(model)
+          color = callable.config[:row_color] || row_color
+          case color
+          when NilClass
+            d.to_s
+          when Array
+            pastel.decorate(d.to_s, *color)
+          else
+            pastel.decorate(d.to_s, color)
+          end
+        end
+      end
+
+      def pastel
+        @pastel ||= Pastel::Color.new(enabled: colorize)
+      end
     end
   end
 end

data/lib/output_mode/outputs/templated.rb

@@ -38,13 +38,25 @@ module OutputMode
         # @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)
+        def each(section = nil, &block)
+          # Select the callable objects
+          callables = if section == nil
+                        output.callables
+                      elsif section == :default
+                        output.callables.config_select(:section, :default, nil)
+                      else
+                        output.callables.config_select(:section, section)
+                      end
+
+          # Yield each selected attribute
+          objs = callables.pad_each.map do |callable, padding:|
+            value = callable.generator(output).call(model)
+            field = callable.config[:header]
+            [value, {field: field, padding: padding }]
           end
+
+          # Runs the provided block
+          objs.each(&block)
         end
 
         # Renders an ERB object within the entry's context. This provides access to the
@@ -61,6 +73,12 @@ module OutputMode
         def pastel
           @pastel ||= Pastel.new(enabled: colorize)
         end
+
+        private
+
+        def generated
+          @generated ||= output.generate(model)
+        end
       end
 
       # @!attribute [r] erb
@@ -68,7 +86,8 @@ module OutputMode
       # @!attribute [r] separator
       # @!attribute [r] fields
       # @!attribute [r] colorize
-      attr_reader :erb, :fields, :separator, :colorize
+      # @!attribute [r] sections
+      attr_reader :erb, :fields, :separator, :colorize, :sections
 
       # 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).
@@ -84,23 +103,32 @@ module OutputMode
       #
       # @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 sections: An optional array that groups the procs into sections. This is ignored by default
       #   @param [Hash] **config see {OutputMode::Output#initialize}
       def initialize(*procs,
                      template: nil,
                      fields: nil,
                      separator: "\n",
                      colorize: false,
+                     sections: nil,
                      **config)
-        @erb = DEFAULT_ERB
+        @erb = case template
+        when String
+          ERB.new(template, nil, '-')
+        when ERB
+          template
+        else
+          DEFAULT_ERB
+        end
         @fields = fields
         @separator = separator
         @colorize = colorize
+        @sections = sections
         super(*procs, **config)
       end
 

data/lib/output_mode/tldr/index.rb

@@ -1,7 +1,31 @@
 #==============================================================================
-# Refer to LICENSE.txt for licensing terms
+# 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-color'
+
 module OutputMode
   module TLDR
     module Index
@@ -11,9 +35,18 @@ module OutputMode
       # @overload register_callable(header:, verbose: true)
       #   @param header: The column's header field when displaying to humans
       #   @param verbose: Whether the column will be shown in the verbose output
+      #   @param interactive: Whether the field will be show in the interactive output
+      #   @param header_color: Override the default color for the header
+      #   @param row_color: Override the default color for the row
+      #   @param modes: Additional modes flags for the callable
       #   @yieldparam model The subject the column is describing, some sort of data model
-      def register_callable(header:, verbose: nil, &b)
-        super(modes: { verbose: verbose }, header: header, &b)
+      def register_callable(modes: {}, header:, verbose: nil, interactive: nil, header_color: nil, row_color: nil, &b)
+        modes = modes.map { |m| [m, true] }.to_h if modes.is_a? Array
+        super(modes: modes.merge(verbose: verbose, interactive: interactive),
+              header: header,
+              header_color: header_color,
+              row_color: row_color,
+              &b)
       end
       alias_method :register_column, :register_callable
 
@@ -21,6 +54,12 @@ module OutputMode
       # +$stdout+ as part of it's output class discovery logic. It does not
       # print to the output directly
       #
+      # The +ascii+ flag disables the unicode formatting in interactive shells.
+      # Non interactive shells use ASCII by default.
+      #
+      # The +verbose+ flag toggles the simplified and verbose outputs in the
+      # interactive output. Non-interactive outputs are always verbose
+      #
       # If +$stdout+ is an interactive shell (aka a TTY), then it will display using
       # {OutputMode::Outputs::Tabulated}. This is intended for human consumption
       # and will obey the provided +verbose+ flag.
@@ -29,26 +68,57 @@ module OutputMode
       # {OutputMode::Outputs::Delimited} using tab delimiters. This is intended
       # for consumption by machines. This output ignores the provided +verbose+
       # flag as it is always verbose.
-      def build_output(verbose: false)
-        callables = if verbose || !$stdout.tty?
+      #
+      # An interative/ non-interactive output can be forced by setting the
+      # +interactive+ flag to +true+/+false+ respectively
+      def build_output(verbose: nil, ascii: nil, interactive: nil, header_color: [:blue, :bold], row_color: :green, context: {})
+        # Set the interactive and verbose flags if not provided
+        interactive = $stdout.tty?  if interactive.nil?
+        verbose =     !interactive  if verbose.nil?
+        ascii =       !interactive  if ascii.nil?
+
+        # Update the rendering context with the verbosity/interactive settings
+        context = context.merge(interactive: interactive, verbose: verbose, ascii: ascii)
+
+        callables = if verbose
           # Filter out columns that are explicitly not verbose
-          output_callables.select(&:verbose!)
+          output_callables.select { |o| o.verbose?(true) }
         else
           # Filter out columns that are explicitly verbose
           output_callables.reject(&:verbose?)
         end
 
-        if $stdout.tty?
+        callables = if interactive
+          # Filter out columns that are explicitly not interactive
+          callables.select { |o| o.interactive?(true) }
+        else
+          # Filter out columns that are explicitly interactive
+          callables.reject { |o| o.interactive? }
+        end
+
+        if interactive
           # Creates the human readable output
+          opts = if ascii
+                   { yes: 'yes', no: 'no', renderer: :ascii }
+                 else
+                   {
+                     yes: '✓', no: '✕', renderer: :unicode, colorize: TTY::Color.color?,
+                     header_color: header_color,
+                     row_color: row_color
+                   }
+                 end
+
           Outputs::Tabulated.new(*callables,
-                                 header: callables.map { |c| c.config.fetch(:header, 'missing') },
-                                 renderer: :unicode,
+                                 rotate: false,
                                  padding: [0,1],
                                  default: '(none)',
-                                 yes: '✓', no: '✕')
+                                 context: context,
+                                 **opts
+                                 )
         else
           # Creates the machine readable output
-          Outputs::Delimited.new(*callables, col_sep: "\t", yes: 'y', no: 'n', default: '')
+          Outputs::Delimited.new(*callables, col_sep: "\t", yes: 'yes', no: 'no', default: nil,
+                                context: context)
         end
       end
     end

data/lib/output_mode/tldr/show.rb

@@ -1,5 +1,27 @@
 #==============================================================================
-# Refer to LICENSE.txt for licensing terms
+# 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-color'
@@ -13,9 +35,16 @@ module OutputMode
       # @overload register_callable(header:, verbose: true)
       #   @param header: The human readable key to the field, uses the term 'header' for consistency
       #   @param verbose: Whether the field will be shown in the verbose output
+      #   @param interactive: Whether the field will be show in the interactive output
+      #   @param section: Define the grouping a callable belongs to. Ignored by default
+      #   @param modes: Additional modes flags for the callable
       #   @yieldparam model The subject the column is describing, some sort of data model
-      def register_callable(header:, verbose: nil, &b)
-        super(modes: { verbose: verbose }, header: header, &b)
+      def register_callable(modes: {}, header:, verbose: nil, interactive: nil, section: :other, &b)
+        modes = modes.map { |m| [m, true] }.to_h if modes.is_a? Array
+        super(modes: modes.merge(verbose: verbose, interactive: interactive),
+              header: header,
+              section: section,
+              &b)
       end
       alias_method :register_attribute, :register_callable
 
@@ -23,6 +52,12 @@ module OutputMode
       # +$stdout+ as part of it's output class discovery logic. It does not
       # print to the io directly
       #
+      # The +ascii+ flag disables the unicode formatting in interactive shells.
+      # Non interactive shells use ASCII by default.
+      #
+      # The +verbose+ flag toggles the simplified and verbose outputs in the
+      # interactive output. Non-interactive outputs are always verbose
+      #
       # If +$stdout+ is an interactive shell (aka a TTY), then it will display using
       # {OutputMode::Outputs::Templated}. This is intended for human consumption
       # and will obey the provided +verbose+ flag.
@@ -31,25 +66,57 @@ module OutputMode
       # {OutputMode::Outputs::Delimited} using tab delimiters. This is intended
       # for consumption by machines. This output ignores the provided +verbose+
       # flag as it is always verbose.
-      def build_output(verbose: false)
-        callables = if verbose || !$stdout.tty?
+      #
+      # The +template+ overrides the default erb template for the output
+      #
+      # An interative/ non-interactive output can be forced by setting the
+      # +interactive+ flag to +true+/+false+ respectively
+      def build_output(verbose: nil, ascii: nil, interactive: nil, template: nil, context: {})
+        # Set the interactive and verbose flags if not provided
+        interactive = $stdout.tty?  if interactive.nil?
+        verbose =     !interactive  if verbose.nil?
+        ascii =       !interactive  if ascii.nil?
+
+        # Update the rendering context with the verbosity/interactive settings
+        context = context.merge(interactive: interactive, verbose: verbose, ascii: ascii)
+
+        callables = if verbose
           # Filter out columns that are explicitly not verbose
-          output_callables.select(&:verbose!)
+          output_callables.select { |o| o.verbose?(true) }
         else
           # Filter out columns that are explicitly verbose
           output_callables.reject(&:verbose?)
         end
 
-        if $stdout.tty?
+        callables = if interactive
+          # Filter out columns that are explicitly not interactive
+          callables.select { |o| o.interactive?(true) }
+        else
+          # Filter out columns that are explicitly interactive
+          callables.reject { |o| o.interactive? }
+        end
+
+        if interactive
           # Creates the human readable output
+          opts =  if ascii
+                    { yes: 'yes', no: 'no', colorize: false }
+                  else
+                    { yes: '✓', no: '✕', colorize: TTY::Color.color? }
+                  end
+
+          sections = callables.map { |o| o.config[:section] }
+
           Outputs::Templated.new(*callables,
                                  fields: callables.map { |c| c.config.fetch(:header, 'missing') },
-                                 colorize: TTY::Color.color?,
                                  default: '(none)',
-                                 yes: '✓', no: '✕')
+                                 sections: sections,
+                                 template: template,
+                                 context: context,
+                                 **opts)
         else
           # Creates the machine readable output
-          Outputs::Delimited.new(*callables, col_sep: "\t", yes: 'y', no: 'n', default: '')
+          Outputs::Delimited.new(*callables, col_sep: "\t", yes: 'yes', no: 'no', default: nil,
+                                 context: context)
         end
       end
     end

data/lib/output_mode/version.rb

@@ -25,5 +25,5 @@
 #==============================================================================
 
 module OutputMode
-  VERSION = "1.1.1"
+  VERSION = "1.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: output_mode
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.5.1
 platform: ruby
 authors:
 - William McCumsite
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-table