output_mode 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33db72e9e5872a974df80e11a0d4bae3735c13d49d3be4d4ab1366b7e461551f
-  data.tar.gz: f1ac7923d6cb9beda1f3af36ebaa41b84cdb6567d5fb71db4f2d1a2503ee731b
+  metadata.gz: 4beed6d9f51548ef131e475bb68aa9c6d6fe079e39672b4691566ff80ffb65c2
+  data.tar.gz: df648ec5ee82875c189123dca55bfaabfa3bf4d5ba24e160be1d0f15bb1a624b
 SHA512:
-  metadata.gz: f12f87485cdad45ceb4fba9b9b26c405366009b1ad39e87c223fc246424bd0501421a75570caf48c351523d55483f4ea1d705659a3e6185ae8213c6147d9ad96
-  data.tar.gz: cafd82a58648d5e4900c91d242a1128b2b1c5d1123716385160801a3d85959324df691ecd7c8443e038612e4c2b2afb221745da598483e239a15a7ef9a701c0a
+  metadata.gz: 4e19a13c9e5b0b6e3fa497aadd4d1ed59bb6297fd8063f88d7f6a01bd4dd84f801baae9be8efe46a0e42e63024824d227fa51c0f7b84ad283baec7f5960fb2f6
+  data.tar.gz: b9ea560f3b42886ca8baaa04452cc5e4557c82ddf23068b095b544f2649b425b5b30a30212d6ef7955cd1fde41c624b4f9fbe73cfc32a3a2ddb1092f6d16fd54

data/.travis.yml

@@ -3,7 +3,6 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.5
   - 2.7.0
 before_install: gem install bundler -v 2.0.2
 script: bundle exec rspec --format documentation --order random

data/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/byebug

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'byebug' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("byebug", "byebug")

data/bin/coderay

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'coderay' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("coderay", "coderay")

data/bin/demo

@@ -29,61 +29,50 @@ require "bundler/setup"
 require "output_mode"
 require 'erb'
 
-module DemoIndex
-  extend OutputMode::TLDR::Index
-
-  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', 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'
+class DemoIndex < OutputMode::Formatters::Index
+  constructor do
+    register(header: 'Integer', row_color: [:yellow, :bold]) { |i| i }
+    register(header: 'Standard', header_color: [:strikethrough] ) { 'always visible' }
+    if verbose?
+      register(header: 'Verbose') { 'verbose visible' }
     else
-      'non-interactive-simplified'
+      register(header: 'Simplified') { 'simplified visible' }
     end
+    if interactive?
+      register(header: 'Interactive') { 'interactive visible' }
+    else
+      register(header: 'Non Interactive') { 'non-interactive visible' }
+    end
+    register(header: 'Yes/True') { true }
+    register(header: 'No/False', row_color: [:clear]) { false }
+    register(header: 'Missing') { nil }
   end
 end
 
-module DemoShow
-  extend OutputMode::TLDR::Show
-
-  register_callable(header: 'Integer') { |i| i }
-  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: '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" }
+class DemoShow < OutputMode::Formatters::Show
+  constructor do
+    register(header: 'Integer') { |i| i }
+    register(header: 'Standard') { 'always visible' }
+    if verbose?
+      register(header: 'Verbose') { 'verbose visible' }
+    else
+      register(header: 'Simplified') { 'simplified visible' }
+    end
+    if interactive?
+      register(header: 'Interactive') { 'interactive visible' }
+    else
+      register(header: 'Non Interactive') { 'non-interactive visible' }
+    end
+    register(header: 'Yes/True', section: :boolean) { true }
+    register(header: 'No/False', section: :boolean) { false }
+    register(header: 'Missing') { nil }
+    register(header: 'Tab') { "tab1\ttab2" }
+    register(header: 'New line') { "line1\nline2" }
+  end
 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
 #==============================================================================
 #==============================================================================
@@ -95,34 +84,34 @@ puts <<~EOF
 # Default Demo Index
 # Simplified in interactive shells, verbose in non-interactive
 #==============================================================================
-#{DemoIndex.build_output.render(*data)}
+#{DemoIndex.render(*data)}
 
 #==============================================================================
 # Demo Verbose Index
 #==============================================================================
-#{DemoIndex.build_output(verbose: true).render(*data)}
+#{DemoIndex.render(*data, verbose: true)}
 
 #==============================================================================
 # Demo "Simplified" Index
 #==============================================================================
-#{DemoIndex.build_output(verbose: false).render(*data)}
+#{DemoIndex.render(*data, verbose: false)}
 
 #==============================================================================
 # Force Interactive
 # Always print as if the shell is interactive
 #==============================================================================
-#{DemoIndex.build_output(interactive: true).render(*data)}
+#{DemoIndex.render(*data, interactive: true)}
 
 #==============================================================================
 # Force Non-Interactive
 # Always print as if the shell is non-interactive
 #==============================================================================
-#{DemoIndex.build_output(interactive: false).render(*data)}
+#{DemoIndex.render(*data, interactive: false)}
 
 #==============================================================================
 # Demo ASCII Index
 #==============================================================================
-#{DemoIndex.build_output(ascii: true).render(*data)}
+#{DemoIndex.render(*data, ascii: true)}
 
 #==============================================================================
 #==============================================================================
@@ -134,39 +123,32 @@ puts <<~EOF
 # Default Settings
 # Simplified in interactive shells, verbose in non-interactive
 #==============================================================================
-#{DemoShow.build_output.render(*data)}
+#{DemoShow.render(data.first)}
 
 #==============================================================================
 # Demo Verbose Show
 #==============================================================================
-#{DemoShow.build_output(verbose: true).render(*data)}
+#{DemoShow.render(data.first, verbose: true)}
 
 #==============================================================================
 # Demo "Simplified" Show
 #==============================================================================
-#{DemoShow.build_output(verbose: false).render(*data)}
+#{DemoShow.render(data.first, verbose: false)}
 
 #==============================================================================
 # Force Interactive
 # Always print as if the shell is interactive
 #==============================================================================
-#{DemoShow.build_output(interactive: true).render(*data)}
+#{DemoShow.render(data.first, interactive: true)}
 
 #==============================================================================
 # Force Non-Interactive
 # Always print as if the shell is non-interactive
 #==============================================================================
-#{DemoShow.build_output(interactive: false).render(*data)}
+#{DemoShow.render(data.first, interactive: false)}
 
 #==============================================================================
 # 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)}
+#{DemoShow.render(data.first, ascii: true)}
 EOF

data/bin/htmldiff

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "htmldiff")

data/bin/ldiff

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "ldiff")

data/bin/pry

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'pry' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("pry", "pry")

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/lib/output_mode/callable.rb

@@ -34,7 +34,9 @@ module OutputMode
       @callables = []
       case callables
       when Array, Callables
-        callables.each { |c| @callables << c }
+        callables.each do |c|
+          @callables << (c.is_a?(Callable) ? c : Callable.new(&c))
+        end
       when nil
         # NOOP
       else
@@ -56,20 +58,39 @@ module OutputMode
       @callables.each(&block)
     end
 
-    def pad_each(key = :header)
-      max_length = self.map { |c| c.config[key].to_s.length }
-                       .max
+    def pad_each(*ctx, **input_opts, &block)
+      fields = self.map do |callables|
+        field = callables.config[:header]
+        if field.respond_to?(:call)
+          opts =  if field.parameters.include?(:keyrest)
+                    input_opts.dup
+                  else
+                    keys = field.parameters
+                                 .select { |type, _| [:key, :keyreq].include?(type) }
+                                 .map { |_, k| k }
+                    input_opts.slice(*keys)
+                  end
+          opts.empty? ? field.call(*ctx) : field.call(*ctx, **opts)
+        else
+          field
+        end
+      end
 
-      pads = self.map do |callable|
-        length = max_length - callable.config[key].to_s.length
-        [callable, { padding: ' ' * length }]
+      max_length = fields.map { |f| f.to_s.length }.max
+      pads = self.each_with_index.map do |callable, idx|
+        field = fields[idx]
+        length = max_length - field.to_s.length
+        [callable, { padding: ' ' * length, field: field }]
       end
 
-      if block_given?
-        pads.each { |*args|  yield(*args) }
-      else
-        pads.each
+      # Generate an enum
+      # NOTE: This fixes the double splate deprecation warning
+      enum = Enumerator.new do |yielder|
+        pads.each do |callable, opts|
+          yielder.yield(callable, **opts)
+        end
       end
+      enum.each(&block)
     end
 
     def config_select(key, *values)
@@ -83,6 +104,10 @@ module OutputMode
       end
       Callables.new(selected)
     end
+
+    def length
+      @callables.length
+    end
   end
 
   class Callable
@@ -116,6 +141,8 @@ module OutputMode
 
     # Handles the dynamic +<query>?+ and +<explicit-negation>!+ methods
     #
+    # DEPRECATED: The explicit! negation operator should not be used
+    #
     # @return [Boolean] The result of the query or explicit-negation
     # @raise [NoMethodError] All other method calls
     def method_missing(s, *args, &b)
@@ -175,6 +202,7 @@ module OutputMode
       callable.call(*a)
     end
 
+    # DEPRECATED: Use a Formatter class
     def generator(output)
       ->(*a) do
         # Implicitly determine which parts of the context can be passed through

data/lib/output_mode/default_erb.rb

@@ -1,5 +1,27 @@
 #==============================================================================
-# Refer to LICENSE.txt for licensing terms
+# Copyright 2021 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 'erb'

data/lib/output_mode/formatter.rb

@@ -0,0 +1,146 @@
+#==============================================================================
+# Copyright 2021 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
+  class Formatter
+    def self.constructor(&block)
+      @constructor ||= block
+    end
+
+    def self.build(*objects, **opts)
+      new(*objects, **opts).tap do |policy|
+        next unless constructor
+        policy.instance_exec(&constructor)
+      end
+    end
+
+    def self.render(*objects, **opts)
+      build(*objects, **opts).render
+    end
+
+    def initialize(*objects, verbose: nil, ascii: nil, interactive: nil, color: nil)
+      @verbose = verbose
+      @ascii = ascii
+      @interactive = interactive
+      @color = color
+
+      # NOTE: This is intentionally not exposed on the base class
+      #       It is up to the individual implementations to expose it
+      @objects = objects
+    end
+
+    def callables
+      @callables ||= Callables.new
+    end
+
+    def register(**config, &block)
+      callables << Callable.new(**config) do |*args, **opts|
+        value = block.call(*args, **opts)
+        format(value, **config)
+      end
+    end
+
+    def format(value, **config)
+      case value
+      when TrueClass
+        config[:yes] || yes
+      when FalseClass
+        config[:no] || no
+      when NilClass
+        config[:default] || default
+      when Time
+        format = config[:time] || time
+        value.strftime(format)
+      else
+        value
+      end
+    end
+
+    def build_output
+      raise NotImplementedError
+    end
+
+    def render
+      build_output.render(*@objects)
+    end
+
+    def interactive?
+      if @interactive.nil?
+        $stdout.tty?
+      else
+        @interactive
+      end
+    end
+
+    def color?
+      if @color.nil? && (ascii? || !interactive?)
+        false
+      elsif @color.nil?
+        TTY::Color.color?
+      else
+        @color
+      end
+    end
+
+    def ascii?
+      if @ascii.nil?
+        !interactive?
+      else
+        @ascii
+      end
+    end
+
+    def verbose?
+      if @verbose.nil?
+        !interactive?
+      else
+        @verbose
+      end
+    end
+
+    def yes(value = nil)
+      @yes = value unless value.nil?
+      @yes ? @yes : (ascii? ? 'yes' : '✓')
+    end
+
+    def no(value = nil)
+      @no = value unless value.nil?
+      @no ? @no : (ascii? ? 'no' : '✕')
+    end
+
+    def default(value = nil)
+      @default = value unless value.nil?
+      @default ? @default : (interactive? ? '(none)' : '')
+    end
+
+    def time(value = nil)
+      @time = value unless value.nil?
+      @time ? @time : (verbose? ? "%Y-%m-%dT%H:%M:%S%:z" : "%d/%m/%y %H:%M")
+    end
+  end
+end

data/lib/output_mode/formatters/index.rb

@@ -0,0 +1,59 @@
+#==============================================================================
+# Copyright 2021 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
+  module Formatters
+    class Index < Formatter
+      attr_reader :objects
+
+      def header_color(value = nil)
+        @header_color = value unless value.nil?
+        @header_color ? @header_color : :bold
+      end
+
+      def row_color(value = nil)
+        @row_color = value unless value.nil?
+        @row_color ? @row_color : :cyan
+      end
+
+      def build_output
+        if interactive?
+          opts = {
+            renderer: ascii? ? :ascii : :unicode,
+            header_color: header_color,
+            row_color: row_color,
+            colorize: color?,
+            rotate: false,
+            padding: [0, 1]
+          }
+          Outputs::Tabulated.new(*callables, **opts)
+        else
+          Outputs::Delimited.new(*callables, col_sep: "\t")
+        end
+      end
+    end
+  end
+end

data/lib/output_mode/formatters/show.rb

@@ -0,0 +1,98 @@
+#==============================================================================
+# Copyright 2021 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/default_erb'
+require 'output_mode/non_interactive_erb'
+
+module OutputMode
+  module Formatters
+    class Show < Formatter
+      include Enumerable
+
+      # Limit the policy to a single object
+      def initialize(object, **opts)
+        super
+      end
+
+      def object
+        @objects.first
+      end
+
+      def template(value = nil)
+        @template = value unless value.nil?
+        @template ? @template : (interactive? ? DEFAULT_ERB : NON_INTERACTIVE_ERB)
+      end
+
+      def scope(value = nil)
+        @scope = value unless value.nil?
+        @scope ? @scope : self
+      end
+
+      def build_output
+        opts = {
+          template: template,
+          colorize: color?,
+          bind: scope.instance_exec { binding }
+        }
+        OutputMode::Outputs::Templated.new(*callables, **opts)
+      end
+
+      # @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(section = nil, &block)
+        # Select the callable objects
+        selected = if section == nil
+                     callables
+                   elsif section == :default
+                     callables.config_select(:section, :default, nil)
+                   else
+                     callables.config_select(:section, section)
+                   end
+
+        # Yield each selected attribute
+        objs = selected.pad_each(object).map do |callable, opts|
+          field = opts[:field]
+          padding = opts[:padding]
+          value = callable.call(object)
+          [value, { field: field, padding: padding }]
+        end
+
+        # Runs the provided block
+        objs.each do |model, opts|
+          block.call(model, **opts)
+        end
+      end
+
+      # Library for colorizing the output. It is automatically disabled when the
+      # +colorize+ flag is +false+
+      def pastel
+        @pastel ||= Pastel.new(enabled: color?)
+      end
+    end
+  end
+end

data/lib/output_mode/formatters.rb

@@ -0,0 +1,36 @@
+#==============================================================================
+# Copyright 2021 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
+  autoload 'Formatter', File.expand_path('formatter.rb', __dir__)
+
+  module Formatters
+    Dir.glob(File.expand_path('formatters/*.rb', __dir__)).each do |path|
+      autoload File.basename(path).chomp('.rb').capitalize, path
+    end
+  end
+end
+

data/lib/output_mode/non_interactive_erb.rb

@@ -0,0 +1,41 @@
+#==============================================================================
+# Copyright 2021 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 'erb'
+
+module OutputMode
+  NON_INTERACTIVE_ERB = ERB.new(<<~TEMPLATE, nil, '-')
+    <% each do |value, field:, padding:, **_| -%>
+    <%   if value.nil? && field.nil? -%>
+    \t
+    <%   elsif field.nil? -%>
+    \t<%= value %>
+    <%   else -%>
+    <%= field -%>\t<%= value.to_s.dump[1...-1] %>
+    <%   end -%>
+    <% end -%>
+  TEMPLATE
+end

data/lib/output_mode/outputs/tabulated.rb

@@ -77,11 +77,16 @@ module OutputMode
 
       private
 
+      def has_header?
+        callables.any? { |c| c.config.key?(:header) }
+      end
+
       # Colorizes the header when requested
       def processed_header
+        return nil unless has_header?
         callables.map do |callable|
           header = callable.config.fetch(:header, '')
-          color = callable.config.fetch(:header_color) || header_color
+          color = callable.config.fetch(:header_color, nil) || header_color
           case color
           when nil
             header.to_s

data/lib/output_mode/outputs/templated.rb

@@ -49,14 +49,15 @@ module OutputMode
                       end
 
           # Yield each selected attribute
-          objs = callables.pad_each.map do |callable, padding:|
+          objs = callables.pad_each(model, **output.context).map do |callable, padding:, field:|
             value = callable.generator(output).call(model)
-            field = callable.config[:header]
-            [value, {field: field, padding: padding }]
+            [value, { field: field, padding: padding }]
           end
 
           # Runs the provided block
-          objs.each(&block)
+          objs.each do |model, opts|
+            block.call(model, **opts)
+          end
         end
 
         # Renders an ERB object within the entry's context. This provides access to the
@@ -87,7 +88,8 @@ module OutputMode
       # @!attribute [r] fields
       # @!attribute [r] colorize
       # @!attribute [r] sections
-      attr_reader :erb, :fields, :separator, :colorize, :sections
+      # @!attribute [r] bind
+      attr_reader :erb, :fields, :separator, :colorize, :sections, :bind
 
       # 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).
@@ -105,10 +107,11 @@ module OutputMode
       #   @param [Array] *procs see {OutputMode::Output#initialize}
       #   @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 fields: DEPRECATED 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 sections: DEPRECATED An optional array that groups the procs into sections
+      #   @param bind: An optional execution context to render the template within
       #   @param [Hash] **config see {OutputMode::Output#initialize}
       def initialize(*procs,
                      template: nil,
@@ -116,6 +119,7 @@ module OutputMode
                      separator: "\n",
                      colorize: false,
                      sections: nil,
+                     bind: nil,
                      **config)
         @erb = case template
         when String
@@ -129,6 +133,7 @@ module OutputMode
         @separator = separator
         @colorize = colorize
         @sections = sections
+        @bind = bind
         super(*procs, **config)
       end
 
@@ -138,11 +143,17 @@ module OutputMode
       #
       # @see OutputMode::Output#render
       def render(*data)
-        data.map { |d| Entry.new(self, d, colorize).render(erb) }
-            .join(separator)
+        data.map do |datum|
+          if bind
+            erb.result(bind)
+          else
+            Entry.new(self, datum, colorize).render(erb)
+          end
+        end.join(separator)
       end
 
       # Returns the length of the maximum field
+      # DEPRECATED
       def max_field_length
         if fields.is_a? Array
           fields.map { |f| f.to_s.length }.max

data/lib/output_mode/tldr/show.rb

@@ -25,6 +25,8 @@
 #==============================================================================
 
 require 'tty-color'
+require 'output_mode/default_erb'
+require 'output_mode/non_interactive_erb'
 
 module OutputMode
   module TLDR
@@ -39,7 +41,7 @@ module OutputMode
       #   @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(modes: {}, header:, verbose: nil, interactive: nil, section: :other, &b)
+      def register_callable(modes: {}, header:, verbose: nil, interactive: nil, section: :default, &b)
         modes = modes.map { |m| [m, true] }.to_h if modes.is_a? Array
         super(modes: modes.merge(verbose: verbose, interactive: interactive),
               header: header,
@@ -67,11 +69,15 @@ module OutputMode
       # for consumption by machines. This output ignores the provided +verbose+
       # flag as it is always verbose.
       #
-      # The +template+ overrides the default erb template for the output
+      # The +template+ overrides the default erb template for interactive sessions.
+      # The +non_interactive_template+ overrides the template for non-interactive
+      # sessions.
       #
       # 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: {})
+      def build_output(verbose: nil, ascii: nil, interactive: nil, context: {},
+                       template: OutputMode::DEFAULT_ERB,
+                       non_interactive_template: OutputMode::NON_INTERACTIVE_ERB)
         # Set the interactive and verbose flags if not provided
         interactive = $stdout.tty?  if interactive.nil?
         verbose =     !interactive  if verbose.nil?
@@ -96,28 +102,22 @@ module OutputMode
           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
+        # Define the templating parameters
+        opts =  if ascii && interactive
+                  { yes: 'yes', no: 'no', colorize: false, default: '(none)', template: template }
+                elsif interactive
+                  { yes: '✓', no: '✕', colorize: TTY::Color.color?, default: '(none)', template: template }
+                else
+                  { yes: 'yes', no: 'no', colorize: false, default: '', template: non_interactive_template }
+                end
 
-          sections = callables.map { |o| o.config[:section] }
+        sections = callables.map { |o| o.config[:section] }
 
-          Outputs::Templated.new(*callables,
-                                 fields: callables.map { |c| c.config.fetch(:header, 'missing') },
-                                 default: '(none)',
-                                 sections: sections,
-                                 template: template,
-                                 context: context,
-                                 **opts)
-        else
-          # Creates the machine readable output
-          Outputs::Delimited.new(*callables, col_sep: "\t", yes: 'yes', no: 'no', default: nil,
-                                 context: context)
-        end
+        Outputs::Templated.new(*callables,
+                               fields: callables.map { |c| c.config.fetch(:header, 'missing') },
+                               sections: sections,
+                               context: context,
+                               **opts)
       end
     end
   end

data/lib/output_mode/version.rb

@@ -25,5 +25,5 @@
 #==============================================================================
 
 module OutputMode
-  VERSION = "1.5.0"
+  VERSION = "1.7.0"
 end

data/lib/output_mode.rb

@@ -29,6 +29,7 @@ require 'output_mode/errors'
 
 require 'output_mode/outputs'
 require 'output_mode/callable'
+require 'output_mode/formatters'
 require 'output_mode/builder_dsl'
 require 'output_mode/tldr'
 

data/output_mode.gemspec

@@ -57,4 +57,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", "> 0.11"
+  spec.add_development_dependency "pry-byebug", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: output_mode
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - William McCumsite
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-10 00:00:00.000000000 Z
+date: 2021-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-table
@@ -108,6 +108,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 
 email:
 - openlicense.williams@gmail.com
@@ -122,14 +136,27 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/bundle
+- bin/byebug
+- bin/coderay
 - bin/console
 - bin/demo
+- bin/htmldiff
+- bin/ldiff
+- bin/pry
+- bin/rake
+- bin/rspec
 - bin/setup
 - lib/output_mode.rb
 - lib/output_mode/builder_dsl.rb
 - lib/output_mode/callable.rb
 - lib/output_mode/default_erb.rb
 - lib/output_mode/errors.rb
+- lib/output_mode/formatter.rb
+- lib/output_mode/formatters.rb
+- lib/output_mode/formatters/index.rb
+- lib/output_mode/formatters/show.rb
+- lib/output_mode/non_interactive_erb.rb
 - lib/output_mode/output.rb
 - lib/output_mode/outputs.rb
 - lib/output_mode/outputs/delimited.rb