command_line_reporter 3.3.4 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d6a50a82965011fe248f827a38ebd74334b3010f
-  data.tar.gz: 01835a6b108b5064c59ab06f92f9177443f38a37
+SHA256:
+  metadata.gz: de307764d95f4c6c49780cf624ce49bf9d3e20cbce8864f8ef14b332f4d21ecb
+  data.tar.gz: 989e14c78c92946ad09d6256ea1d0a7746fe47aff72c8c2ae5cf5bc3b9af0e21
 SHA512:
-  metadata.gz: 6f6a66faac50b478a1c795d8f499ae19c577e5776e2129c71f3a84ab6b1b01786ed68083311dd672b46ea57fefd90bc3d4bce07578526dc96a0435082dea1b98
-  data.tar.gz: 352c1e3725cf969e02c54d3767366116f252cbcaca582bef677e484435c87c0a4d0ff2368a0b5648f36774a67e1bd5989a5398fd5ff886278df8e8152252563f
+  metadata.gz: 819cb85516aca9c6d94e242ba4d7dc214da52d6b471ad33c2c1edb90c2ff55cde37849d0aa1e7aa9a68fa574dbfc3b6965c06e4f00360408cc7c0b33a135472c
+  data.tar.gz: d96302796e98b04617b545ecade441d46172ab817ddf4fbc21f66627da39cedb896fee400e1b707b593e9c31a255768ba5e0ebdb7a9a5e399b652f2296e5f059

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -106,11 +106,13 @@ There are several methods the mixin provides that do not depend on the formatter
 * _column(string, hash)_
   * _text_ - String to display in the table cell
   * _options_ - The options to define the column
+    * :span - defines the number of columns to span across in the table
     * :width - defines the width of the column
     * :padding - The number of spaces to put on both the left and right of the text.
     * :align - Allowed values are left|right|center
     * :color - The color to use for the terminal output i.e. 'red' or 'blue' or 'green'
     * :bold - true|false to boldface the font
+    * :wrap - character|word to break multi-line cells on character or word boundary.
 * _suppress_output_ - Suppresses output stream that goes to STDOUT
 * _capture_output_ - Captures all of the output stream to a string and restores output to STDOUT
 * _restore_output_ - Restores the output stream to STDOUT
@@ -118,10 +120,11 @@ There are several methods the mixin provides that do not depend on the formatter
 ### To Do
 
 * Add a formatter that supports html output
-* Add the ability for a column to span across others in a table
 
 ### Contributors
 
+* [Dennis Ideler](https://github.com/dideler) submitted pull requests getting CLR up to date and
+  fixing issues with border colors
 * [Josh Brown](https://github.com/tobijb) added the ability to encode tables in either ascii or utf8
 * [Stefan Frank](https://github.com/mugwump) for raising the issue that he could not capture report
   output in a variable as a string
@@ -132,7 +135,7 @@ There are several methods the mixin provides that do not depend on the formatter
 
 ### License
 
-Copyright (c) 2011-2014 Wes Bailey
+Copyright (c) 2011-2017 Wes Bailey
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
 associated documentation files (the "Software"), to deal in the Software without restriction,

data/lib/command_line_reporter.rb

@@ -8,17 +8,18 @@ require 'command_line_reporter/column'
 require 'command_line_reporter/table'
 require 'command_line_reporter/version'
 
+# rubocop:disable Metrics/ModuleLength
 module CommandLineReporter
   include OptionsValidator
 
   attr_reader :formatter
 
   DEFAULTS = {
-    :width => 100,
-    :align => 'left',
-    :formatter => 'nested',
-    :encoding => :unicode,
-  }
+    width: 100,
+    align: 'left',
+    formatter: 'nested',
+    encoding: :unicode
+  }.freeze
 
   def capture_output
     $stdout.rewind
@@ -36,8 +37,9 @@ module CommandLineReporter
   end
 
   def formatter=(type = 'nested')
+    return type if type.class != String
     name = type.capitalize + 'Formatter'
-    klass = %W{CommandLineReporter #{name}}.inject(Kernel) {|s,c| s.const_get(c)}
+    klass = %W[CommandLineReporter #{name}].inject(Kernel) { |a, e| a.const_get(e) }
 
     # Each formatter is a singleton that responds to #instance
     @formatter = klass.instance
@@ -71,52 +73,41 @@ module CommandLineReporter
     char = options[:char].is_a?(String) ? options[:char] : use_char
     width = options[:width] || DEFAULTS[:width]
 
-    aligned(char * width, :width => width, :color => options[:color], :bold => options[:bold])
+    aligned(char * width, width: width, color: options[:color], bold: options[:bold])
   end
 
   def vertical_spacing(lines = 1)
-    puts "\n" * lines
-  rescue
-    raise ArgumentError
+    lines = Integer(lines)
+
+    # because puts "\n" * 0 produces an unwanted newline
+    if lines.zero?
+      print "\0"
+    else
+      puts "\n" * lines
+    end
   end
 
   def datetime(options = {})
     validate_options(options, :align, :width, :format, :color, :bold)
 
-    format = options[:format] || '%Y-%m-%d - %l:%M:%S%p'
-    align = options[:align] || DEFAULTS[:align]
-    width = options[:width] || DEFAULTS[:width]
-
+    format = default_options_date_format(options[:format])
     text = Time.now.strftime(format)
 
-    raise Exception if text.size > width
-
-    aligned(text, :align => align, :width => width, :color => options[:color], :bold => options[:bold])
+    aligned(text, options)
   end
 
   def aligned(text, options = {})
-    validate_options(options, :align, :width, :color, :bold)
+    validate_options(options, :align, :width, :format, :color, :bold)
 
-    align = options[:align] || DEFAULTS[:align]
-    width = options[:width] || DEFAULTS[:width]
-    color = options[:color]
-    bold = options[:bold] || false
+    options[:align] = default_options_align(options[:align])
+    options[:width] = default_options_width(options[:width])
+    options[:bold] = default_options_bold(options[:bold])
 
-    line = case align
-           when 'left'
-             text
-           when 'right'
-             text.rjust(width)
-           when 'center'
-             text.rjust((width - text.size)/2 + text.size)
-           else
-             raise ArgumentError
-           end
+    raise Exception if text.size > options[:width]
 
-    line = line.send(color) if color
-    line = line.send('bold') if bold
+    line = align_line(text, options)
 
-    puts line
+    puts apply_color(line, options)
   end
 
   def table(options = {})
@@ -139,36 +130,98 @@ module CommandLineReporter
 
   private
 
+  def align_line(text, options)
+    case options[:align]
+    when 'left'
+      text
+    when 'right'
+      text.rjust(options[:width])
+    when 'center'
+      text.rjust((options[:width] - text.size) / 2 + text.size)
+    end
+  end
+
+  def apply_color(line, options)
+    line = line.send(options[:color]) if options[:color]
+    line = line.send('bold') if options[:bold]
+    line
+  end
+
+  # def default_datetime_options(options)
+  #   format = define_format(options)
+  #   align = default_options_align(options[:align])
+  #   width = default_options_width(options[:width])
+  #   [format, align, width]
+  # end
+
+  def default_options_date_format(format)
+    format || '%Y-%m-%d - %l:%M:%S%p'
+  end
+
   def section(type, options)
-    title, width, align, lines, color, bold = assign_section_properties(options)
+    options = define_section_values(options)
 
-    # This also ensures that width is a Fixnum
-    raise ArgumentError if title.size > width
+    raise ArgumentError if options[:title].size > options[:width]
 
-    if type == :footer
-      vertical_spacing(lines)
-      horizontal_rule(:char => options[:rule], :width => width, :color => color, :bold => bold) if options[:rule]
-    end
+    print_header(type, options)
+    print_body(options)
+    print_footer(type, options)
+  end
 
-    aligned(title, :align => align, :width => width, :color => color, :bold => bold)
-    datetime(:align => align, :width => width, :color => color, :bold => bold) if options[:timestamp]
+  def print_header(type, options)
+    return unless type == :header
+    vertical_spacing(options[:lines])
+    horizontal_rule(char: options[:rule], width: options[:width], color: options[:color], bold: options[:bold]) if options[:rule]
+  end
 
-    if type == :header
-      horizontal_rule(:char => options[:rule], :width => width, :color => color, :bold => bold) if options[:rule]
-      vertical_spacing(lines)
-    end
+  def print_body(options)
+    aligned(options[:title], align: options[:align], width: options[:width], color: options[:color], bold: options[:bold])
+    datetime(align: options[:align], width: options[:width], color: options[:color], bold: options[:bold]) if options[:timestamp]
   end
 
-  def assign_section_properties options
+  def print_footer(type, options)
+    return unless type == :footer
+    horizontal_rule(char: options[:rule], width: options[:width], color: options[:color], bold: options[:bold]) if options[:rule]
+    vertical_spacing(options[:lines])
+  end
+
+  def define_section_values(options)
     validate_options(options, :title, :width, :align, :spacing, :timestamp, :rule, :color, :bold)
 
-    title = options[:title] || 'Report'
-    width = options[:width] || DEFAULTS[:width]
-    align = options[:align] || DEFAULTS[:align]
-    lines = options[:spacing] || 1
-    color = options[:color]
-    bold = options[:bold] || false
+    options[:title] = default_options_title(options[:title])
+    options[:width] = default_options_width(options[:width])
+    options[:align] = default_options_align(options[:align])
+    options[:lines] = default_options_lines(options[:spacing])
+    options[:bold] = default_options_bold(options[:bold])
+
+    options
+  end
+
+  def default_options_title(title)
+    title || 'Report'
+  end
+
+  def default_options_width(width)
+    width ||= DEFAULTS[:width]
+    Integer(width)
+    width
+  end
+
+  def default_options_align(align)
+    align ||= DEFAULTS[:align]
+    validate_align(align)
+    align
+  end
+
+  def default_options_lines(lines)
+    lines || 1
+  end
+
+  def default_options_bold(bold)
+    bold || false
+  end
 
-    return [title, width, align, lines, color, bold]
+  def validate_align(align)
+    raise ArgumentError unless %i[left center right].include?(align.to_sym)
   end
 end