output_mode 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec56475261c0c87de303f06bb9d5c046c71b39a5cdecaaab8c2a6ba0fc9d1602
-  data.tar.gz: 6912cc2ae659c9c1ea89c0d2fe38b03537f3de9f54d6b981fc958c4519f78bcd
+  metadata.gz: aba3d3f1c1ef5bd16dc8397b9500218ccc652af7dc6c11d85dfbb16cd7ec0ee0
+  data.tar.gz: 9568bee91c9a89576fa24a97e8d0fba2cbf86f28fb4d2f6ede3093b773bade17
 SHA512:
-  metadata.gz: 0e439ef9c8b4a68bc567d1d7b01d38b0582a85de7e08355c301a6012ef0c95c6c42af1f2c4ee4088cd2edd64566956d9b8e4a3ad94b48eded57f3cfafa0b987d
-  data.tar.gz: 321eed2286b0e87ef5f45b2336a8a4c95e477258a00744087bafd85fbd3dfad1a3ee2f8b220cddcaf0a9e6193301de1e708e1890aaf10a5497c08ea4f44e150e
+  metadata.gz: 409dc9ad72f0a1771ad325995905bde702dcae4d3839b983c7cf02a5ace8927ef9cecc70954666dbce3a634b144d0ee8e8bf3f7981a55edcc52c480545ce36eb
+  data.tar.gz: 8663a174778b268e3ea596a81856ff2f53b3a4d3387e68e329bddb38f6d3e002bfc8838d3634304a7680cf8a998db99468dc18b210356259522b1c69aea34d00

data/bin/demo

@@ -27,6 +27,7 @@
 
 require "bundler/setup"
 require "output_mode"
+require 'erb'
 
 module DemoIndex
   extend OutputMode::TLDR::Index
@@ -47,13 +48,25 @@ 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: 'Yes/True', section: :boolean) { true }
+  register_callable(header: 'No/False', section: :boolean) { false }
   register_callable(header: 'Missing') { nil }
 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
 #==============================================================================
 #==============================================================================
@@ -122,4 +135,11 @@ puts <<~EOF
 # 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/outputs/templated.rb

@@ -38,9 +38,23 @@ 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|
+        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
+
+          # 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)
@@ -61,6 +75,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 +88,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 +105,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/show.rb

@@ -35,9 +35,10 @@ 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 section: Define the grouping a callable belongs to. Ignored by default
       #   @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(header:, verbose: nil, section: :other, &b)
+        super(modes: { verbose: verbose }, header: header, section: section, &b)
       end
       alias_method :register_attribute, :register_callable
 
@@ -60,9 +61,11 @@ 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
+      #
       # An interative/ non-interactive output can be forced by setting the
       # +interactive+ flag to +true+/+false+ respectively
-      def build_output(verbose: false, ascii: false, interactive: nil)
+      def build_output(verbose: false, ascii: false, interactive: nil, template: nil)
         callables = if verbose || !$stdout.tty?
           # Filter out columns that are explicitly not verbose
           output_callables.select { |o| o.verbose?(true) }
@@ -73,15 +76,19 @@ module OutputMode
 
         if interactive || (interactive.nil? && $stdout.tty?)
           # Creates the human readable output
-          opts = if ascii
-                   { yes: 'yes', no: 'no', colorize: false }
-                 else
-                   { yes: '✓', no: '✕', colorize: TTY::Color.color? }
+          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') },
                                  default: '(none)',
+                                 sections: sections,
+                                 template: template,
                                  **opts)
         else
           # Creates the machine readable output

data/lib/output_mode/version.rb

@@ -25,5 +25,5 @@
 #==============================================================================
 
 module OutputMode
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: output_mode
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - William McCumsite