command_line_reporter 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1024c56ad76f095c3f3778ec780c4427f184ab34
-  data.tar.gz: 60ddfd0b420dc8ce7692f7d1cd226ba437c4349f
+SHA256:
+  metadata.gz: d3c1e840f398d0d5b7b0d70fac041e025fa4440feabbd70a2e1a9aa4474c4d33
+  data.tar.gz: 4a026c69efdea559f58af48266110a44dcca52ffc96c7b39e5bcec90b3c567b1
 SHA512:
-  metadata.gz: 040a9a4fad99322164d8b42225f7c06335f1747d4e387ceb6ddc7a483dc7375717f3f442123e85a9c7bd75a3e4937da125a4651fc4148afdf9c20f9a0b11ad04
-  data.tar.gz: 9c0ba99f7fc2ba37cadcc3d8cf15eb10b94f8da4f5de036952344ebeea80917a3e9c389d5810a2f7019ba98ae608833a1dac8bf8f3058e106bfe230ff58886e3
+  metadata.gz: b3b5c827bdaeaa52e267353b66880fa375d91a6a828550716fecda236857b6f0824a0d05b1c81e25d5a0ec260cbe27bfa99f57cdfacdc93e620bb76237e85e34
+  data.tar.gz: 17a8df3c90eb2f0b6edb79843f3e95b97e121a2eda24d94875009c907596a793ea0ad96e8a5938858d55fbf8ec445cc61c394c08b031579a6a9da7c4624eb67d

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,7 +120,6 @@ 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
 

data/lib/command_line_reporter/column.rb

@@ -4,7 +4,7 @@ module CommandLineReporter
   class Column
     include OptionsValidator
 
-    VALID_OPTIONS = %i[width padding align color bold underline reversed span].freeze
+    VALID_OPTIONS = %i[width padding align color bold underline reversed span wrap].freeze
     attr_accessor :text, :size, *VALID_OPTIONS
 
     def initialize(text = nil, options = {})
@@ -13,6 +13,9 @@ module CommandLineReporter
       assign_color_defaults(options)
 
       self.text = text.to_s
+
+      self.wrap = (options.fetch(:wrap, :character).to_s)
+      raise(ArgumentError, ":wrap must be word or character (got #{options[:wrap].inspect})") unless %w(word character).include?(self.wrap)
     end
 
     def size
@@ -27,12 +30,32 @@ module CommandLineReporter
       if text.nil? || text.empty?
         [' ' * width]
       else
-        text.scan(/.{1,#{size}}/m).map { |s| to_cell(s) }
+        reformat_wrapped(text).map { |line| to_cell(line) }
       end
     end
 
     private
 
+    def reformat_wrapped(text)
+      lines = []
+      text.lines.each do |line|
+        line_words = (wrap == 'word') ? line.split(/\s+/) : [line]
+        line_words.each do |word|
+          current_line = lines.last
+          if current_line.nil? || current_line.size + word.size >= size
+            # word does not fit on current line. Add new line(s) handling the case where current
+            # word is longer than line width.
+            lines.concat(word.scan(/.{1,#{size}}/))
+          else
+            # Word fits on current line.
+            (current_line << ' ' << word).strip!
+          end
+        end
+        lines << ''
+      end
+      lines[0..-2]
+    end
+
     def assign_alignment_defaults(options)
       self.span = options[:span] || 1
 

data/lib/command_line_reporter/version.rb

@@ -1,3 +1,3 @@
 module CommandLineReporter
-  VERSION = '4.0.0'.freeze
+  VERSION = '4.0.1'.freeze
 end

data/spec/column_spec.rb

@@ -3,6 +3,10 @@ require 'spec_helper'
 describe CommandLineReporter::Column do
   subject { CommandLineReporter::Column }
 
+  def screen_rows(args = {})
+    described_class.new(text, {width: 5}.merge(args)).screen_rows
+  end
+
   context '#initialize' do
     it 'rejects invalid options' do
       expect do
@@ -287,36 +291,42 @@ describe CommandLineReporter::Column do
     context 'with wrapping' do
       context 'no padding' do
         context 'left justifies' do
-          let(:text) { 'x' * 25 }
-          let(:full_line) { 'x' * 10 }
-          let(:remainder) { 'x' * 5 }
-          let(:filler) { ' ' * 5 }
+          let(:text) { "one cooperative\n\nbag copy" }
 
-          it 'plain text' do
-            c = subject.new(text, width: 10)
-            expect(c.screen_rows).to eq([full_line, full_line, remainder + filler])
+          describe 'line-breaks' do
+            it 'do not break output' do
+              expect(screen_rows(width: 20)).to eq(['one cooperative     ', ' ' * 20, 'bag copy            '])
+            end
           end
 
-          it 'outputs red' do
-            c = subject.new(text, width: 10, color: 'red')
-            expect(c.screen_rows).to eq(
-              [
-                controls[:red] + full_line + controls[:clear],
-                controls[:red] + full_line + controls[:clear],
-                controls[:red] + remainder + filler + controls[:clear]
-              ]
-            )
+          describe 'wrap: word' do
+            it 'tries to break lines between words' do
+              expect(screen_rows(wrap: :word)).to eq(['one  ', 'coope', 'rativ', 'e    ', '     ', 'bag  ', 'copy '])
+            end
+          end
+
+          describe 'wrap: character' do
+            it 'uses "character"-based wrapping by default' do
+              expect(screen_rows).to eq(screen_rows(wrap: :character))
+            end
+
+            it 'ignores word-breaks' do
+              expect(screen_rows).to eq(['one c', 'ooper', 'ative', '     ', '     ', 'bag c', 'opy  '])
+            end
+          end
+
+          it 'outputs color' do
+            screen_rows(color: 'red').each do |row|
+              expect(row).to start_with(controls[:red])
+              expect(row).to end_with(controls[:clear])
+            end
           end
 
           it 'outputs bold' do
-            c = subject.new(text, width: 10, bold: true)
-            expect(c.screen_rows).to eq(
-              [
-                controls[:bold] + full_line + controls[:clear],
-                controls[:bold] + full_line + controls[:clear],
-                controls[:bold] + remainder + filler + controls[:clear]
-              ]
-            )
+            screen_rows(bold: true).each do |row|
+              expect(row).to start_with(controls[:bold])
+              expect(row).to end_with(controls[:clear])
+            end
           end
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_line_reporter
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Wes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-20 00:00:00.000000000 Z
+date: 2019-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - lib/command_line_reporter.rb
 - lib/command_line_reporter/column.rb
@@ -83,19 +84,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A tool for providing interactive command line applications
 test_files:
-- spec/column_spec.rb
-- spec/command_line_reporter_spec.rb
+- spec/spec_helper.rb
 - spec/nested_formatter_spec.rb
-- spec/options_validator_spec.rb
-- spec/progress_formatter_spec.rb
 - spec/row_spec.rb
-- spec/spec_helper.rb
-- spec/support/helpers/stdout.rb
+- spec/progress_formatter_spec.rb
+- spec/command_line_reporter_spec.rb
 - spec/support/matchers/argument.rb
+- spec/support/helpers/stdout.rb
+- spec/options_validator_spec.rb
+- spec/column_spec.rb
 - spec/table_spec.rb