output_mode 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ad0728b37cf092a7e009021655552acae2f4493b66bafa17509efc0e0740435
-  data.tar.gz: 96875c08fa06eb7b868e7d4069965d6704e75ac126917fba5fb7e0f78cf4ff2e
+  metadata.gz: 33db72e9e5872a974df80e11a0d4bae3735c13d49d3be4d4ab1366b7e461551f
+  data.tar.gz: f1ac7923d6cb9beda1f3af36ebaa41b84cdb6567d5fb71db4f2d1a2503ee731b
 SHA512:
-  metadata.gz: 8b104681823f3d151875c4ebfef4eac7c98f64657fe0f40fb49776bd969095da7310dbe7d3119a49e92c758e71521d8b84de52636766efdfbae4c8e5b3a19b78
-  data.tar.gz: 44f52488f5131c0c82df6ef4a272f75dd01f43c97c0c9e04c77f6e7df79968b04ef10af3d6ff2acc526fb7796782ab38b0ad7acc336de2868ff992314d70e4ac
+  metadata.gz: f12f87485cdad45ceb4fba9b9b26c405366009b1ad39e87c223fc246424bd0501421a75570caf48c351523d55483f4ea1d705659a3e6185ae8213c6147d9ad96
+  data.tar.gz: cafd82a58648d5e4900c91d242a1128b2b1c5d1123716385160801a3d85959324df691ecd7c8443e038612e4c2b2afb221745da598483e239a15a7ef9a701c0a

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/bin/demo

@@ -36,9 +36,22 @@ module DemoIndex
   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'
+    else
+      'non-interactive-simplified'
+    end
+  end
 end
 
 module DemoShow
@@ -48,9 +61,13 @@ 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: '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]

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,45 @@ 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)
+      max_length = self.map { |c| c.config[key].to_s.length }
+                       .max
+
+      pads = self.map do |callable|
+        length = max_length - callable.config[key].to_s.length
+        [callable, { padding: ' ' * length }]
+      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 +174,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

@@ -31,8 +31,6 @@ module OutputMode
     class Tabulated < Output
       # @!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
@@ -41,28 +39,25 @@ module OutputMode
       #   @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, :header, :default, :block, :yes, :no,
+      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,
                      colorize: false,
-                     header: nil,
                      header_color: nil,
                      row_color: nil,
                      **config,
                      &block)
-        @header = header
         @renderer =  renderer
         @block = block
         @header_color = header_color
@@ -76,7 +71,7 @@ module OutputMode
       # @see https://github.com/piotrmurach/tty-table
       def render(*data)
         table = TTY::Table.new header: processed_header
-        data.each { |d| table << process_row(generate(d)) }
+        data.each { |d| table << process_row(d) }
         table.render(renderer, **config, &block) || ''
       end
 
@@ -84,23 +79,25 @@ module OutputMode
 
       # Colorizes the header when requested
       def processed_header
-        header&.each_with_index&.map do |h, idx|
-          color = index_selector(:header_color, idx)
+        callables.map do |callable|
+          header = callable.config.fetch(:header, '')
+          color = callable.config.fetch(:header_color) || header_color
           case color
           when nil
-            h.to_s
+            header.to_s
           when Array
-            pastel.decorate(h.to_s, *color)
+            pastel.decorate(header.to_s, *color)
           else
-            pastel.decorate(h.to_s, color)
+            pastel.decorate(header.to_s, color)
           end
         end
       end
 
       # Colorizes the row when requested
-      def process_row(data)
-        data.each_with_index.map do |d, idx|
-          color = index_selector(:row_color, idx)
+      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

data/lib/output_mode/outputs/templated.rb

@@ -38,27 +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(section = nil)
-          # Select the indices for the relevant section
-          indices = (0...output.procs.length).to_a
-          if section
-            indices.select! do |idx|
-              output.index_selector(:sections, idx) == section
-            end
-          end
-
-          # Find the max field length
-          max = indices.map do |idx|
-            output.index_selector(:fields, idx).to_s.length
-          end.max
+        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
-          indices.each do |idx|
-            value = generated[idx]
-            field = output.index_selector(:fields, idx)
-            padding = ' ' * (max - field.to_s.length)
-            yield(value, field: field, padding: padding)
+          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

data/lib/output_mode/tldr/index.rb

@@ -35,12 +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, header_color: nil, row_color: nil, &b)
-        super(modes: { verbose: verbose }, header: header,
-              header_color: header_color, row_color: row_color, &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
 
@@ -65,10 +71,14 @@ module OutputMode
       #
       # An interative/ non-interactive output can be forced by setting the
       # +interactive+ flag to +true+/+false+ respectively
-      def build_output(verbose: nil, ascii: false, interactive: nil, header_color: [:blue, :bold], row_color: :green)
+      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
@@ -78,6 +88,14 @@ module OutputMode
           output_callables.reject(&:verbose?)
         end
 
+        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
@@ -85,20 +103,22 @@ module OutputMode
                  else
                    {
                      yes: '✓', no: '✕', renderer: :unicode, colorize: TTY::Color.color?,
-                     header_color: callables.map { |c| c.config[:header_color] || header_color },
-                     row_color: callables.map { |c| c.config[:row_color] || row_color }
+                     header_color: header_color,
+                     row_color: row_color
                    }
                  end
 
           Outputs::Tabulated.new(*callables,
-                                 header: callables.map { |c| c.config.fetch(:header, 'missing') },
+                                 rotate: false,
                                  padding: [0,1],
                                  default: '(none)',
+                                 context: context,
                                  **opts
                                  )
         else
           # Creates the machine readable output
-          Outputs::Delimited.new(*callables, col_sep: "\t", yes: 'yes', no: 'no', 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

@@ -35,10 +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, section: :other, &b)
-        super(modes: { verbose: verbose }, header: header, section: section, &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
 
@@ -65,10 +71,14 @@ module OutputMode
       #
       # An interative/ non-interactive output can be forced by setting the
       # +interactive+ flag to +true+/+false+ respectively
-      def build_output(verbose: nil, ascii: false, interactive: nil, template: nil)
+      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
@@ -78,6 +88,14 @@ module OutputMode
           output_callables.reject(&:verbose?)
         end
 
+        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
@@ -93,10 +111,12 @@ module OutputMode
                                  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: '')
+          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.4.0"
+  VERSION = "1.5.0"
 end

metadata

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