tty 0.0.10 → 0.0.11

data/lib/tty/text/wrapping.rb

@@ -13,6 +13,8 @@ module TTY
 
       attr_reader :indent
 
+      attr_reader :padding
+
       # Initialize a Wrapping
       #
       # @param [String] text
@@ -31,11 +33,12 @@ module TTY
       #
       # @api private
       def initialize(text, *args)
-        options = Utils.extract_options!(args)
-        @text   = text
-        @length = options.fetch(:length) { DEFAULT_WIDTH }
-        @indent = options.fetch(:indent) { 0 }
-        @length = args[0] unless args.empty?
+        options  = Utils.extract_options!(args)
+        @text    = text
+        @length  = options.fetch(:length) { DEFAULT_WIDTH }
+        @indent  = options.fetch(:indent) { 0 }
+        @padding = options.fetch(:padding) { [] }
+        @length  = args[0] unless args.empty?
       end
 
       # Wrap a text into lines no longer than length
@@ -47,9 +50,8 @@ module TTY
         return text unless length && length > 0
 
         as_unicode do
-          text.split(NEWLINE).map do |line|
-            modified_line = wrap_line line
-            indent_line modified_line
+          text.split(NEWLINE, -1).map do |line|
+            pad_line(indent_line(wrap_line(line)))
           end * NEWLINE
         end
       end
@@ -74,8 +76,9 @@ module TTY
       # @api private
       def wrap_line(line)
         wrap_at = actual_length line
-        line.strip.gsub(/\n/,' ').squeeze(' ').
-          gsub(/(.{1,#{wrap_at}})(?:\s+|$\n?)|(.{1,#{wrap_at}})/, "\\1\\2\n").strip
+        line.strip.gsub(/\n/, ' ').squeeze(' ')
+          .gsub(/(.{1,#{wrap_at}})(?:\s+|$\n?)|(.{1,#{wrap_at}})/, "\\1\\2\n")
+          .strip
       end
 
       # Indent string by given value
@@ -91,6 +94,24 @@ module TTY
         end
       end
 
+      # Add padding to each line in wrapped text
+      #
+      # @param [String] text
+      #   the wrapped text
+      #
+      # @return [String]
+      #
+      # @api private
+      def pad_line(text)
+        return text if text.empty? || padding.empty?
+
+        padding_left  = ' ' * padding[3].to_i
+        padding_right = ' ' * padding[1].to_i
+        text.map! do |part|
+          part.insert(0, padding_left).insert(-1, padding_right)
+        end
+      end
+
     end # Wrapping
   end # Text
 end # TTY

data/lib/tty/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
 
 module TTY
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/spec/tty/shell/question/argument_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe TTY::Shell::Question, '#argument' do
   let(:input)  { StringIO.new }
   let(:output) { StringIO.new }
-  let(:shell) { TTY::Shell.new(input, output) }
+  let(:shell)  { TTY::Shell.new(input, output) }
 
   it 'requires value to be present with helper' do
     input << ''

data/spec/tty/shell/question/modify_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe TTY::Shell::Question, '#modify' do
   let(:input)  { StringIO.new }
   let(:output) { StringIO.new }
-  let(:shell) { TTY::Shell.new(input, output) }
+  let(:shell)  { TTY::Shell.new(input, output) }
 
   it 'preserves answer for unkown modification' do
     input << 'piotr'
@@ -32,7 +32,7 @@ describe TTY::Shell::Question, '#modify' do
     input << " Some   white\t   space\t \there!   \n"
     input.rewind
     q = shell.ask("Enter some text: ").modify(:collapse)
-    expect(q.read_string).to eql " Some white space here! "
+    expect(q.read_string).to eql "Some white space here!"
   end
 
   it 'strips and collapses whitespace' do

data/spec/tty/shell/response/read_email_spec.rb

@@ -39,5 +39,4 @@ describe TTY::Shell::Question, '#read_email' do
       expect(output.string).to eql "What is your email?\nWhat is your email?\n"
     end
   end
-
 end

data/spec/tty/table/border/ascii/rendering_spec.rb

@@ -49,15 +49,42 @@ describe TTY::Table::Border::ASCII, '#rendering' do
   end
 
   context 'with multiline row' do
-    let(:row) { TTY::Table::Row.new(["a1\nb1\nc1", 'a2', 'a3']) }
     let(:column_widths) { [2,2,2]}
 
-    it 'draws row line' do
-      subject.row_line(row).should == <<-EOS.normalize
-        |a1|a2|a3|
-        |b1|  |  |
-        |c1|  |  |
-      EOS
+    context 'with mixed data' do
+      let(:row) { TTY::Table::Row.new(["a1\nb1\nc1", 'a2', 'a3']) }
+
+      it 'draws row line' do
+        subject.row_line(row).should == <<-EOS.normalize
+          |a1|a2|a3|
+          |b1|  |  |
+          |c1|  |  |
+        EOS
+      end
+    end
+
+    context 'with sparse data' do
+      let(:row) { TTY::Table::Row.new(["a1\n\n", "\na2\n", "\n\na3"]) }
+
+      it 'draws row line' do
+        subject.row_line(row).should == <<-EOS.normalize
+          |a1|  |  |
+          |  |a2|  |
+          |  |  |a3|
+        EOS
+      end
+    end
+
+    context 'with empty data' do
+      let(:row) { TTY::Table::Row.new(["\na1\n", "\na2\n", "\na3\n"]) }
+
+      it 'draws row line' do
+        subject.row_line(row).should == <<-EOS.normalize
+          |  |  |  |
+          |a1|a2|a3|
+          |  |  |  |
+        EOS
+      end
     end
   end
 end

data/spec/tty/table/border/null/rendering_spec.rb

@@ -50,15 +50,42 @@ describe TTY::Table::Border::Null, '#rendering' do
   end
 
   context 'with multiline row' do
-    let(:row) { TTY::Table::Row.new(["a1\nb1\nc1", 'a2', 'a3']) }
     let(:column_widths) { [2,2,2] }
 
-    it 'draws row line' do
-      subject.row_line(row).should == <<-EOS.normalize
-        a1 a2 a3
-        b1      
-        c1      
-      EOS
+    context 'with mixed data' do
+      let(:row) { TTY::Table::Row.new(["a1\nb1\nc1", 'a2', 'a3']) }
+
+      it 'draws row line' do
+        subject.row_line(row).should == <<-EOS.normalize
+          a1 a2 a3
+          b1      
+          c1      
+        EOS
+      end
+    end
+
+    context 'with sparse data' do
+      let(:row) { TTY::Table::Row.new(["a1\n\n", "\na2\n", "\n\na3"]) }
+
+      it 'draws row line' do
+        subject.row_line(row).should == <<-EOS.chomp
+a1      
+   a2   
+      a3
+        EOS
+      end
+    end
+
+    context 'with empty data' do
+      let(:row) { TTY::Table::Row.new(["\na1\n", "\na2\n", "\na3\n"]) }
+
+      it 'draws row line' do
+        subject.row_line(row).should == <<-EOS.chomp
+        
+a1 a2 a3
+        
+        EOS
+      end
     end
   end
 

data/spec/tty/table/column_set/extract_widths_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe TTY::Table::ColumnSet, '#extract_widths!' do
+describe TTY::Table::ColumnSet, '#extract_widths' do
   let(:header) { ['h1', 'h2', 'h3'] }
   let(:rows)   { [['a1', 'a2', 'a3'], ['b1', 'b2', 'b3']] }
   let(:table)  { TTY::Table.new header, rows }

data/spec/tty/table/column_set/widths_from_spec.rb

@@ -0,0 +1,52 @@
+
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Table::ColumnSet, '#widths_from' do
+  let(:header) { ['h1', 'h2', 'h3'] }
+  let(:rows)   { [['a1', 'a2', 'a3'], ['b1', 'b2', 'b3']] }
+  let(:table)  { TTY::Table.new header, rows }
+
+  subject { described_class.widths_from(table, column_widths) }
+
+  context 'when empty array' do
+    let(:column_widths) { [] }
+
+    it 'raises an error' do
+      expect { subject }.to raise_error(TTY::InvalidArgument)
+    end
+  end
+
+  context 'when invalid size array' do
+    let(:column_widths) { [3,3] }
+
+    it 'raises an error' do
+      expect { subject }.to raise_error(TTY::InvalidArgument)
+    end
+  end
+
+  context 'when valid array' do
+    let(:column_widths) { [3,3,3] }
+
+    it 'converts into numbers' do
+      expect(subject).to eql(column_widths)
+    end
+  end
+
+  context 'when nil' do
+    let(:column_widths) { nil }
+
+    it 'extracts widths' do
+      expect(subject).to eql([2,2,2])
+    end
+  end
+
+  context 'when numeric' do
+    let(:column_widths) { 5 }
+
+    it 'generates widths' do
+      expect(subject).to eql([5,5,5])
+    end
+  end
+end

data/spec/tty/table/columns/enforce_spec.rb

@@ -0,0 +1,68 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Table::Columns, '#enforce' do
+  let(:header) { ['h1', 'h2', 'h3', 'h4'] }
+  let(:rows)   { [['a1', 'a2', 'a3', 'a4'], ['b1', 'b2', 'b3', 'b4']] }
+  let(:table)  { TTY::Table.new(header, rows) }
+  let(:object) { described_class.new(renderer) }
+
+  subject { object.enforce }
+
+  context 'with width contraint' do
+    let(:renderer) { TTY::Table::Renderer::Basic.new(table, options) }
+    let(:options) { { width: 5 }}
+
+    it 'raises error when table width is too small' do
+      expect { subject }.to raise_error(TTY::ResizeError)
+    end
+  end
+
+  context 'with width contraint matching natural width' do
+    let(:renderer) { TTY::Table::Renderer::Basic.new(table, options) }
+    let(:options) { { width: 11, resize: true }}
+
+    it 'raises error when table width is too small' do
+      expect(object).to receive(:expand)
+      subject
+    end
+  end
+
+  context 'with table larger than allowed width' do
+    let(:renderer) { TTY::Table::Renderer::Basic.new(table, options) }
+
+    context 'with resize' do
+      let(:options) { { width: 8, resize: true } }
+
+      it 'calls shrink' do
+        expect(object).to receive(:shrink)
+        subject
+      end
+    end
+
+    context 'without resize' do
+      let(:options) { { width: 8, resize: false }}
+
+      it 'changes table orientation to vertical' do
+        TTY.shell.should_receive(:warn)
+        expect(renderer.column_widths).to eql([2,2,2,2])
+        expect(renderer.table.orientation.name).to eql(:horizontal)
+        subject
+        expect(renderer.column_widths).to eq([2,2])
+        expect(renderer.table.orientation.name).to eql(:vertical)
+      end
+    end
+  end
+
+  context 'with table less than allowed width' do
+    let(:renderer) { TTY::Table::Renderer::Basic.new(table, options) }
+    let(:options) { { width: 15 }}
+
+    before { TTY.shell.stub(:warn) }
+
+    it "doesn't change original widths" do
+      expect(renderer.column_widths).to eq([2,2,2,2])
+    end
+  end
+end

data/spec/tty/table/columns/widths_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe TTY::Table::Columns, 'column widths' do
+  let(:header) { ['h1', 'h2', 'h3', 'h4'] }
+  let(:rows)   { [['a1', 'a2', 'a3', 'a4'], ['b1', 'b2', 'b3', 'b4']] }
+  let(:table)  { TTY::Table.new(header, rows) }
+
+  subject { described_class.new(renderer) }
+
+  context 'with basic renderer' do
+    let(:renderer) { TTY::Table::Renderer::Basic.new(table) }
+
+    it 'calculates columns natural width' do
+      expect(subject.natural_width).to eq(11)
+    end
+
+    it 'calculates miminimum columns width' do
+      expect(subject.minimum_width).to eq(7)
+    end
+  end
+
+  context 'with ascii renderer' do
+    let(:renderer) { TTY::Table::Renderer::ASCII.new(table) }
+
+    it 'calculates columns natural width' do
+      expect(subject.natural_width).to eq(13)
+    end
+
+    it 'calculates miminimum columns width' do
+      expect(subject.minimum_width).to eq(9)
+    end
+  end
+end

data/spec/tty/table/indentation/insert_indent_spec.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Table::Indentation, '#insert_indent' do
+  let(:indent) { 2 }
+  let(:renderer) { double(:renderer, indent: indent) }
+  let(:object)  { described_class.new(renderer) }
+
+  subject { object.insert_indent(part) }
+
+  context 'when enumerable' do
+    let(:part) { ['line1'] }
+
+    it 'inserts indentation for each element' do
+      expect(subject[0]).to eql('  line1')
+    end
+  end
+
+  context 'when string' do
+    let(:part) { 'line1' }
+
+    it 'inserts indentation' do
+      expect(subject).to eql('  line1')
+    end
+  end
+end

data/spec/tty/table/operation/wrapped/call_spec.rb

@@ -3,7 +3,8 @@
 require 'spec_helper'
 
 describe TTY::Table::Operation::Wrapped, '#call' do
-  let(:object) { described_class.new column_widths }
+  let(:padding) { TTY::Table::Padder.parse }
+  let(:object) { described_class.new(column_widths, padding) }
   let(:text)   { 'ラドクリフ、マラソン五輪代表に1万m出場にも含み' }
   let(:field)  { TTY::Table::Field.new(text) }
 

data/spec/tty/table/operation/wrapped/wrap_spec.rb

@@ -3,8 +3,9 @@
 require 'spec_helper'
 
 describe TTY::Table::Operation::Wrapped, '#wrap' do
-  let(:instance) { described_class.new [] }
-  let(:text) { 'ラドクリフ、マラソン五輪代表に1万m出場にも含み' }
+  let(:padding)  { TTY::Table::Padder.parse }
+  let(:instance) { described_class.new([], padding) }
+  let(:text)     { 'ラドクリフ、マラソン五輪代表に1万m出場にも含み' }
 
   subject { instance.wrap(text, width) }
 

data/spec/tty/table/operations/new_spec.rb

@@ -4,8 +4,8 @@ require 'spec_helper'
 
 describe TTY::Table::Operations, '#new' do
   let(:object) { described_class }
-  let(:row) { [1,2,3] }
-  let(:table) { TTY::Table.new :rows => [row] }
+  let(:row)    { [1,2,3] }
+  let(:table)  { TTY::Table.new :rows => [row] }
   let(:callable) {
     Class.new do
       def call(val, row, col)
@@ -17,9 +17,7 @@ describe TTY::Table::Operations, '#new' do
 
   subject { object.new table }
 
-  before {
-    subject.add_operation(:alignment, instance)
-  }
+  before { subject.add(:alignment, instance) }
 
   it 'stores away operations' do
     expect(subject.operations[:alignment]).to include(instance)