tty 0.0.9 → 0.0.10

data/spec/tty/table/orientation_spec.rb

@@ -5,10 +5,9 @@ require 'spec_helper'
 describe TTY::Table, 'orientation' do
   let(:header) { ['h1', 'h2', 'h3'] }
   let(:rows) { [['a1', 'a2', 'a3'], ['b1', 'b2', 'b3']] }
-  let(:renderer) { :basic }
-  let(:options) { { :orientation => orientation, :renderer => renderer } }
+  let(:options) { { :orientation => orientation } }
 
-  subject { described_class.new header, rows, options }
+  subject { described_class.new(header, rows, options) }
 
   context 'when illegal option' do
     let(:orientation) { :accross }
@@ -26,7 +25,7 @@ describe TTY::Table, 'orientation' do
     it { expect(subject.header).to eql header }
 
     it 'preserves original rows' do
-      expect(subject.to_a).to eql rows
+      expect(subject.to_a).to eql(subject.data)
     end
 
     context 'without border' do
@@ -43,7 +42,7 @@ describe TTY::Table, 'orientation' do
       let(:renderer) { :ascii }
 
       it 'diplays table' do
-        subject.to_s.should == <<-EOS.normalize
+        subject.render(renderer).should == <<-EOS.normalize
          +--+--+--+
          |h1|h2|h3|
          +--+--+--+
@@ -84,7 +83,7 @@ describe TTY::Table, 'orientation' do
       let(:renderer) { :ascii }
 
       it 'diplays table' do
-        subject.to_s.should == <<-EOS.normalize
+        subject.render(renderer).should == <<-EOS.normalize
          +--+--+--+
          |h1|a1|b1|
          |h2|a2|b2|

data/spec/tty/table/properties_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 describe TTY::Table, 'properties' do
   let(:rows) {[['a1', 'a2', 'a3'], ['b1', 'b2', 'c3']] }
-  subject { described_class.new :rows => rows, :renderer => :basic }
+  subject { described_class.new rows }
 
   its(:width) { should == 6 }
 
@@ -14,8 +14,6 @@ describe TTY::Table, 'properties' do
 
   its(:size) { should == [2,3] }
 
-  its(:width) { should == 6 }
-
   context 'no size' do
     let(:rows) { []  }
 
@@ -23,5 +21,4 @@ describe TTY::Table, 'properties' do
 
     its(:column_size) { should == 0 }
   end
-
 end

data/spec/tty/table/render_spec.rb

@@ -0,0 +1,57 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Table, '#render' do
+  let(:object) { described_class }
+  let(:header) { ['h1', 'h2'] }
+  let(:rows)   { [['a1', 'a2'], ['b1', 'b2']] }
+  let(:basic_renderer)   { TTY::Table::Renderer::Basic }
+  let(:ascii_renderer)   { TTY::Table::Renderer::ASCII }
+
+  subject(:table) { object.new header, rows }
+
+  it { should respond_to(:render) }
+
+  context 'with block' do
+    it 'allows to modify renderer in a block' do
+      expected = nil
+      block = lambda { |renderer| expected = renderer }
+      table.render(&block)
+      expect(expected).to be_kind_of(basic_renderer)
+    end
+
+    it 'sets renderer as block parameter' do
+      expected = nil
+      block = lambda { |renderer| expected = renderer }
+      table.render(:ascii, &block)
+      expect(expected).to be_kind_of(ascii_renderer)
+    end
+
+    it 'sets parameter on renderer' do
+      result = table.render :ascii do |renderer|
+        renderer.border.style = :red
+      end
+      result.should == <<-EOS.normalize
+        \e[31m+--+--+\e[0m
+        \e[31m|\e[0mh1\e[31m|\e[0mh2\e[31m|\e[0m
+        \e[31m+--+--+\e[0m
+        \e[31m|\e[0ma1\e[31m|\e[0ma2\e[31m|\e[0m
+        \e[31m|\e[0mb1\e[31m|\e[0mb2\e[31m|\e[0m
+        \e[31m+--+--+\e[0m
+      EOS
+    end
+  end
+
+  context 'with params' do
+    it 'sets params without renderer' do
+      TTY::Table::Renderer.should_receive(:render).with(table, {renderer: :basic})
+      table.render(:basic)
+    end
+
+    it 'sets params with renderer' do
+      TTY::Table::Renderer.should_receive(:render).with(table, {})
+      table.render
+    end
+  end
+end

data/spec/tty/table/{renders_with_spec.rb → render_with_spec.rb}

@@ -2,19 +2,19 @@
 
 require 'spec_helper'
 
-describe TTY::Table, '#renders_with' do
+describe TTY::Table, '#render_with' do
   let(:header) { ['h1', 'h2', 'h3'] }
-  let(:rows) { [['a1', 'a2', 'a3'], ['b1', 'b2', 'b3']] }
-  let(:table) { described_class.new header, rows }
+  let(:rows)   { [['a1', 'a2', 'a3'], ['b1', 'b2', 'b3']] }
+  let(:table)  { described_class.new header, rows }
 
   context 'with invalid border class' do
     it "doesn't inherit from TTY::Table::Border" do
-      expect { table.renders_with String }.to raise_error(TTY::TypeError)
+      expect { table.render_with String }.to raise_error(TTY::TypeError)
     end
 
     it "doesn't implement def_border" do
       klass = Class.new(TTY::Table::Border)
-      expect { table.renders_with klass }.to raise_error(TTY::NoImplementationError)
+      expect { table.render_with klass }.to raise_error(TTY::NoImplementationError)
     end
   end
 
@@ -42,8 +42,7 @@ describe TTY::Table, '#renders_with' do
     }
 
     it 'displays custom border' do
-      table.renders_with MyBorder
-      table.to_s.should == <<-EOS.normalize
+      table.render_with(MyBorder).should == <<-EOS.normalize
         *==*==*==*
         $h1$h2$h3$
         *==*==*==*
@@ -70,8 +69,7 @@ describe TTY::Table, '#renders_with' do
     }
 
     it 'displays border' do
-      table.renders_with MyBorder
-      table.to_s.should == <<-EOS.normalize
+      table.render_with(MyBorder).should == <<-EOS.normalize
         $h1$h2$h3$
         $a1$a2$a3$
         $b1$b2$b3$
@@ -80,4 +78,25 @@ describe TTY::Table, '#renders_with' do
     end
   end
 
-end # renders_with
+  context 'with renderer' do
+    before {
+      class MyBorder < TTY::Table::Border
+        def_border do
+          left  '|'
+          right '|'
+        end
+      end
+    }
+
+    it 'displays border' do
+      result = table.render_with MyBorder do |renderer|
+        renderer.border.style = :red
+      end
+      result.should == <<-EOS.normalize
+        \e[31m|\e[0mh1\e[31m\e[0mh2\e[31m\e[0mh3\e[31m|\e[0m
+        \e[31m|\e[0ma1\e[31m\e[0ma2\e[31m\e[0ma3\e[31m|\e[0m
+        \e[31m|\e[0mb1\e[31m\e[0mb2\e[31m\e[0mb3\e[31m|\e[0m
+      EOS
+    end
+  end
+end # render_with

data/spec/tty/table/renderer/ascii/render_spec.rb

@@ -0,0 +1,68 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Table::Renderer::ASCII, '#render' do
+  let(:header) { ['h1', 'h2', 'h3'] }
+  let(:rows) { [['a1', 'a2', 'a3'], ['b1', 'b2', 'b3']] }
+  let(:table) { TTY::Table.new header, rows }
+
+  subject { described_class.new(table) }
+
+  context 'only rows' do
+    let(:table) { TTY::Table.new rows }
+
+    it 'display table rows' do
+      subject.render.should == <<-EOS.normalize
+        +--+--+--+
+        |a1|a2|a3|
+        |b1|b2|b3|
+        +--+--+--+
+      EOS
+    end
+  end
+
+  context 'with header' do
+    it 'displays table with header' do
+      subject.render.should == <<-EOS.normalize
+        +--+--+--+
+        |h1|h2|h3|
+        +--+--+--+
+        |a1|a2|a3|
+        |b1|b2|b3|
+        +--+--+--+
+      EOS
+    end
+  end
+
+  context 'with short header' do
+    let(:header) { ['h1', 'h2'] }
+    let(:rows) { [['aaa1', 'a2'], ['b1', 'bb1']] }
+
+    it 'displays table according to widths' do
+      subject.render.should == <<-EOS.normalize
+        +----+---+
+        |h1  |h2 |
+        +----+---+
+        |aaa1|a2 |
+        |b1  |bb1|
+        +----+---+
+      EOS
+    end
+  end
+
+  context 'with long header' do
+    let(:header) { ['header1', 'header2', 'header3'] }
+
+    it 'header greater than row sizes' do
+      subject.render.should == <<-EOS.normalize
+      +-------+-------+-------+
+      |header1|header2|header3|
+      +-------+-------+-------+
+      |a1     |a2     |a3     |
+      |b1     |b2     |b3     |
+      +-------+-------+-------+
+      EOS
+    end
+  end
+end

data/spec/tty/table/renderer/ascii/separator_spec.rb

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Table::Renderer::ASCII, 'with separator' do
+  let(:header) { ['h1', 'h2', 'h3'] }
+  let(:rows)   { [['a1', 'a2', 'a3'], ['b1', 'b2', 'b3']] }
+  let(:table)  { TTY::Table.new(header, rows) }
+
+  let(:object) { described_class.new table }
+
+  subject(:renderer) { object }
+
+  context 'when ascii' do
+    it "renders each row" do
+      renderer.border.separator= :each_row
+      renderer.render.should == <<-EOS.normalize
+        +--+--+--+
+        |h1|h2|h3|
+        +--+--+--+
+        |a1|a2|a3|
+        +--+--+--+
+        |b1|b2|b3|
+        +--+--+--+
+      EOS
+    end
+  end
+end

data/spec/tty/table/renderer/basic/alignment_spec.rb

@@ -2,20 +2,22 @@
 
 require 'spec_helper'
 
-describe TTY::Table, 'alignment' do
+describe TTY::Table::Renderer::Basic, 'alignment' do
   let(:header) { ['h1', 'h2', 'h3'] }
   let(:rows)   { [['a1', 'a2', 'a3'], ['b1', 'b2', 'b3']] }
   let(:options) { { :renderer => :basic, :column_aligns => column_aligns }}
 
-  subject(:table) { described_class.new header, rows, options }
+  let(:table) { TTY::Table.new(header, rows) }
+
+  subject(:renderer) { described_class.new table, options }
 
   context 'with default' do
     let(:header) { ['h1', 'h2'] }
-    let(:rows) { [['aaaaa', 'a'], ['b', 'bbbbb']] }
+    let(:rows)   { [['aaaaa', 'a'], ['b', 'bbbbb']] }
     let(:column_aligns) { nil }
 
     it 'aligns left by default' do
-      table.to_s.should == <<-EOS.normalize
+      renderer.render.should == <<-EOS.normalize
         h1    h2   
         aaaaa a    
         b     bbbbb
@@ -28,7 +30,7 @@ describe TTY::Table, 'alignment' do
     let(:column_aligns) { [:left, :center, :right] }
 
     it 'aligns headers' do
-      table.to_s.should == <<-EOS.normalize
+      renderer.render.should == <<-EOS.normalize
         header1 head2 h3
         a1       a2   a3
         b1       b2   b3
@@ -42,7 +44,7 @@ describe TTY::Table, 'alignment' do
     let(:column_aligns)  { [:left, :right] }
 
     it 'aligns table rows' do
-      table.to_s.should == <<-EOS.normalize
+      renderer.render.to_s.should == <<-EOS.normalize
         aaaaa     a
         b     bbbbb
       EOS
@@ -52,15 +54,17 @@ describe TTY::Table, 'alignment' do
   context 'with individual field aligns' do
     let(:header) { ['header1', 'header2', 'header3'] }
     let(:column_aligns) { [:left, :center, :right] }
-
-    it "takes individual fields over global aligns" do
-      options = {:header => header, :column_aligns => column_aligns, :renderer => :basic}
-      table = described_class.new options do |t|
+    let(:options) { { :column_aligns => column_aligns, :renderer => :basic } }
+    let(:table) {
+      TTY::Table.new :header => header do |t|
         t << ['a1', 'a2', 'a3']
         t << ['b1', {:value => 'b2', :align => :right}, 'b3']
         t << ['c1', 'c2', {:value => 'c3', :align => :center}]
       end
-      table.to_s.should == <<-EOS.normalize
+    }
+
+    it "takes individual fields over global aligns" do
+      renderer.render.should == <<-EOS.normalize
         header1 header2 header3
         a1        a2         a3
         b1           b2      b3
@@ -71,17 +75,15 @@ describe TTY::Table, 'alignment' do
 
   context 'with aligned header' do
     let(:rows) { [['aaaaa1', 'a2', 'aaa3'], ['b1', 'bbbb2', 'bb3']] }
+    let(:header) {['h1', {:value => 'h2', :align => :right}, {:value => 'h3', :align => :center}] }
+    let(:options) { { :renderer => :basic } }
 
     it "aligns headres" do
-      header = ['h1', {:value => 'h2', :align => :right}, {:value => 'h3', :align => :center}]
-      options = {:header => header, :renderer => :basic, :rows => rows }
-      table = described_class.new options
-      table.to_s.should == <<-EOS.normalize
+      renderer.render.should == <<-EOS.normalize
         h1        h2  h3 
         aaaaa1 a2    aaa3
         b1     bbbb2 bb3 
       EOS
     end
-
   end
 end

data/spec/tty/table/renderer/basic/extract_column_widths_spec.rb

@@ -3,21 +3,26 @@
 require 'spec_helper'
 
 describe TTY::Table::Renderer::Basic, '#extract_column_widths' do
-  let(:rows) { [['a1', 'a2', 'a3'], ['b1', 'b2', 'b3']] }
+  let(:rows)   { [['a1', 'a2', 'a3'], ['b1', 'b2', 'b3']] }
+  let(:object) { described_class.new(table) }
 
-  subject { described_class.new }
+  subject { object.render }
 
-  it 'calculates column widths' do
-    rows = [['a1a', 'a2a2a2'], ['b1b1b', 'b2b2']]
-    table = TTY::Table.new rows, :renderer => :basic
-    subject.render(table)
-    table.column_widths.should == [5,6]
+  context 'with rows only' do
+    let(:rows)  { [['a1a', 'a2a2a2'], ['b1b1b', 'b2b2']] }
+    let(:table) { TTY::Table.new rows }
+
+    it 'calculates column widths' do
+      object.column_widths.should == [5,6]
+    end
   end
 
-  it 'calcualtes column widths with header' do
-    header = ['header1', 'head2', 'h3']
-    table = TTY::Table.new header, rows
-    subject.render(table)
-    table.column_widths.should == [7,5,2]
+  context 'with header' do
+    let(:header) { ['header1', 'head2', 'h3'] }
+    let(:table)  { TTY::Table.new header, rows }
+
+    it 'calcualtes column widths with header' do
+      object.column_widths.should == [7,5,2]
+    end
   end
 end

data/spec/tty/table/renderer/basic/filter_spec.rb

@@ -0,0 +1,53 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Table::Renderer::Basic, 'filter' do
+  let(:header) { ['h1', 'h2', 'h3'] }
+  let(:rows)   { [['a1', 'a2', 'a3'], ['b1', 'b2', 'b3']] }
+  let(:table)  { TTY::Table.new(header, rows) }
+
+  subject(:renderer) { described_class.new(table, {filter: filter}) }
+
+  context 'with header' do
+    context 'filtering only rows' do
+      let(:filter) { Proc.new { |val, row, col|
+          (col == 1 and row > 0) ? val.capitalize : val
+        }
+      }
+
+      it 'filters only rows' do
+        subject.render.should == <<-EOS.normalize
+          h1 h2 h3
+          a1 A2 a3
+          b1 B2 b3
+        EOS
+      end
+    end
+
+    context 'filtering header and rows' do
+      let(:filter) { Proc.new { |val, row, col| col == 1 ? val.capitalize : val }}
+
+      it 'filters only rows' do
+        subject.render.should == <<-EOS.normalize
+          h1 H2 h3
+          a1 A2 a3
+          b1 B2 b3
+        EOS
+      end
+    end
+  end
+
+  context 'without header' do
+    let(:header) { nil }
+
+    let(:filter) { Proc.new { |val, row, col| col == 1 ?  val.capitalize : val } }
+
+    it 'filters only rows' do
+      subject.render.should == <<-EOS.normalize
+        a1 A2 a3
+        b1 B2 b3
+      EOS
+    end
+  end
+end

data/spec/tty/table/renderer/basic/multiline_content_spec.rb

@@ -0,0 +1,135 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Table::Renderer::Basic, 'with multiline content' do
+  let(:header) { nil }
+  let(:object) { described_class }
+  let(:table) { TTY::Table.new header, rows }
+
+  subject(:renderer) { object.new table }
+
+  context 'with escaping' do
+    let(:rows) { [ ["First", '1'], ["Multiline\nContent", '2'], ["Third", '3']] }
+
+    context 'without border' do
+      it "renders single line" do
+        table.render(multiline: false).should == <<-EOS.normalize
+          First              1
+          Multiline\\nContent 2
+          Third              3
+        EOS
+      end
+    end
+
+    context 'with column widths' do
+      it "renders single line" do
+        table.render(multiline: false, column_widths: [8,1]).should == <<-EOS.normalize
+          First    1
+          Multili… 2
+          Third    3
+        EOS
+      end
+    end
+
+    context 'with border' do
+      it "renders single line" do
+        table.render(:ascii, multiline: false).should == <<-EOS.normalize
+         +------------------+-+
+         |First             |1|
+         |Multiline\\nContent|2|
+         |Third             |3|
+         +------------------+-+
+        EOS
+      end
+    end
+
+    context 'with header' do
+      let(:header) { ["Multi\nHeader", "header2"] }
+
+      it "renders header" do
+        table.render(:ascii, multiline: false).should == <<-EOS.normalize
+         +------------------+-------+
+         |Multi\\nHeader     |header2|
+         +------------------+-------+
+         |First             |1      |
+         |Multiline\\nContent|2      |
+         |Third             |3      |
+         +------------------+-------+
+        EOS
+      end
+    end
+  end
+
+  context 'without escaping' do
+    let(:rows) { [ ["First", '1'], ["Multi\nLine\nContent", '2'], ["Third", '3']] }
+
+    context 'without border' do
+      it "renders every line" do
+        table.render(multiline: true).should == <<-EOS.normalize
+          First   1
+          Multi   2
+          Line     
+          Content  
+          Third   3
+        EOS
+      end
+    end
+
+    context 'with column widths' do
+      it "renders multiline" do
+        table.render(multiline: true, column_widths: [8,1]).should == <<-EOS.normalize
+          First    1
+          Multi    2
+          Line      
+          Content   
+          Third    3
+        EOS
+      end
+
+      it 'wraps multi line' do
+        table.render(multiline: true, column_widths: [5,1]).should == <<-EOS.normalize
+          First 1
+          Multi 2
+          Line   
+          Conte  
+          nt     
+          Third 3
+        EOS
+      end
+    end
+
+    context 'with border' do
+      it "renders every line" do
+        table.render(:ascii, multiline: true).should == <<-EOS.normalize
+         +-------+-+
+         |First  |1|
+         |Multi  |2|
+         |Line   | |
+         |Content| |
+         |Third  |3|
+         +-------+-+
+        EOS
+      end
+    end
+
+    context 'with header' do
+      let(:header) { ["Multi\nHeader", "header2"] }
+
+      it "renders header" do
+        table.render(:ascii, multiline: true).should == <<-EOS.normalize
+         +-------+-------+
+         |Multi  |header2|
+         |Header |       |
+         +-------+-------+
+         |First  |1      |
+         |Multi  |2      |
+         |Line   |       |
+         |Content|       |
+         |Third  |3      |
+         +-------+-------+
+        EOS
+      end
+    end
+  end
+end

data/spec/tty/table/renderer/basic/new_spec.rb

@@ -3,9 +3,20 @@
 require 'spec_helper'
 
 describe TTY::Table::Renderer::Basic do
+  let(:header) { ['h1'] }
+  let(:rows)   { [['a1']] }
 
-  subject { described_class.new }
+  subject(:renderer) { described_class }
 
-  it { should respond_to(:render) }
+  context 'without table' do
+    let(:table) { nil }
 
+    it { expect { renderer.new(table) }.to raise_error(TTY::ArgumentRequired) }
+  end
+
+  context 'with table' do
+    let(:table)  { TTY::Table.new(header, rows) }
+
+    it { expect { renderer.new(table) }.not_to raise_error }
+  end
 end

data/spec/tty/table/renderer/basic/options_spec.rb

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Table::Renderer::Basic, 'options' do
+  let(:rows)   { [['a1', 'a2'], ['b1', 'b2']] }
+  let(:object) { described_class }
+  let(:table)  { TTY::Table.new(rows) }
+  let(:widths) { nil }
+  let(:aligns) { [] }
+  let(:options) {
+    {
+      :column_widths => widths,
+      :column_aligns  => aligns,
+      :renderer => :basic
+    }
+  }
+
+  subject { object.new table, options }
+
+  its(:border) { should be_kind_of TTY::Table::BorderOptions }
+
+  its(:column_widths) { should be_empty }
+
+  its(:column_aligns) { should eql(aligns) }
+
+  it { subject.column_aligns.to_a.should be_empty }
+
+  context '#column_widths' do
+    let(:widths) { [10, 10] }
+
+    its(:column_widths) { should == widths }
+  end
+
+  context '#column_widths empty' do
+    let(:widths) { [] }
+
+    it { expect { subject }.to raise_error(TTY::InvalidArgument) }
+  end
+
+  context '#column_aligns' do
+    let(:aligns) { [:center, :center] }
+
+    it 'unwraps original array' do
+      subject.column_aligns.to_a.should == aligns
+    end
+  end
+end