tty 0.0.3 → 0.0.4

data/lib/tty/table.rb

@@ -8,7 +8,7 @@ require 'tty/table/validatable'
 module TTY
   class Table
     include Comparable, Enumerable, Renderer, Conversion
-    include Validatable
+    include Validatable, Equatable
     extend Forwardable
 
     # The table header
@@ -26,9 +26,23 @@ module TTY
     attr_reader :rows
     private :rows
 
+    # The table enforced column widths
+    #
+    # @return [Array]
+    #
+    # @api public
+    attr_accessor :column_widths
+
+    # The table column alignments
+    #
+    # @return [Operation::AlignmentSet]
+    #
+    # @api private
+    attr_reader :alignments
+
     # Subset of safe methods that both Array and Hash implement
     def_delegators(:@rows, :[], :assoc, :flatten, :include?, :index,
-      :inspect, :length, :select, :to_a, :values_at, :pretty_print, :rassoc)
+                   :length, :select, :to_a, :values_at, :pretty_print, :rassoc)
 
     # The table orientation
     #
@@ -81,23 +95,25 @@ module TTY
     # @option options [String] :header
     #   column names to be displayed
     # @option options [String] :rows
-    #   Array of Arrays expressin the rows
+    #   Array of Arrays expressing the rows
     # @option options [String] :renderer
     #   used to format table output
-    # @option options [String] :alignments
+    # @option options [String] :column_aligns
     #   used to format table individual column alignment
     # @option options [String] :column_widths
     #   used to format table individula column width
     #
-    # @return [Table]
+    # @return [TTY::Table]
     #
     # @api private
     def initialize(options={}, &block)
-      @header        = options.fetch :header, []
+      @header        = options.fetch :header, nil
       @rows          = coerce(options.fetch :rows, [])
       @renderer      = pick_renderer options[:renderer]
-      @column_aligns = options.fetch :column_aligns, []
+      # TODO: assert that row_size is the same as column widths & aligns
       @column_widths = options.fetch :column_widths, []
+      @alignments    = Operation::AlignmentSet.new options[:column_aligns]
+
       assert_row_sizes @rows
       yield_or_eval &block if block_given?
     end
@@ -109,9 +125,10 @@ module TTY
       if i >= 0 && j >= 0
         rows.fetch(i){return nil}[j]
       else
-        raise IndexError.new("index #{index} not found")
+        raise IndexError.new("element at(#{i},#{j}) not found")
       end
     end
+    alias at        []
     alias element   []
     alias component []
 
@@ -178,11 +195,14 @@ module TTY
     #
     # @param [Array] row
     #
+    # @return [self]
+    #
     # @api public
     def <<(row)
       rows_copy = rows.dup
       assert_row_sizes rows_copy << row
       rows << row
+      self
     end
 
     # Iterate over each tuple in the set
@@ -247,7 +267,7 @@ module TTY
     #
     # @api public
     def width
-      extract_column_widths(rows)
+      render(self)
       total_width
     end
 
@@ -261,39 +281,13 @@ module TTY
       column_size == 0 || row_size == 0
     end
 
-    # Compare this table with other table for equality
-    #
-    # @param [TTY::Table] other
-    #
-    # @return [Boolean]
-    #
-    # @api public
-    def eql?(other)
-      instance_of?(other.class)
-    end
-
-    # Compare the table with other table for equivalency
-    #
-    # @example
-    #   table == other # => true or false
-    #
-    # @param [TTY::Table] other
-    #   the other table to compare with
-    #
-    # @return [Boolean]
-    def ==(other)
-      header == other.header &&
-      to_a == other.to_a
-    end
-
     # Return string representation of table
     #
     # @return [String]
     #
     # @api public
     def to_s
-      render(rows, :column_widths => @column_widths,
-                   :column_aligns => @column_aligns)
+      render(self)
     end
 
     # Coerce an Enumerable into a Table

data/lib/tty/version.rb

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

data/lib/tty.rb

@@ -6,6 +6,7 @@ require 'tty/support/utils'
 require 'tty/support/delegatable'
 require 'tty/support/conversion'
 require 'tty/support/coercion'
+require 'tty/support/equatable'
 
 require 'tty/color'
 require 'tty/terminal'
@@ -14,6 +15,7 @@ require 'tty/table'
 
 require 'tty/table/operation/alignment_set'
 require 'tty/table/operation/alignment'
+require 'tty/table/operation/truncation'
 
 module TTY
 

data/spec/tty/support/equatable_spec.rb

@@ -0,0 +1,206 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Equatable do
+  let(:name) { 'Value' }
+
+  context 'without attributes' do
+    let(:klass) { ::Class.new }
+
+    subject { klass.new }
+
+    before {
+      klass.stub(:name).and_return 'Value'
+      klass.send :include, described_class
+    }
+
+    it { should respond_to :compare? }
+
+    it { should be_instance_of klass }
+
+    describe '#eql?' do
+      context 'when objects are similar' do
+        let(:other) { subject.dup }
+
+        it { subject.eql?(other).should be_true }
+      end
+
+      context 'when objects are different' do
+        let(:other) { stub('other') }
+
+        it { subject.eql?(other).should be_false }
+      end
+    end
+
+    describe '#==' do
+      context 'when objects are similar' do
+        let(:other) { subject.dup }
+
+        it { (subject == other).should be_true }
+      end
+
+      context 'when objects are different' do
+        let(:other) { stub('other') }
+
+        it { (subject == other)}
+      end
+    end
+
+    describe '#inspect' do
+      it { subject.inspect.should eql('#<Value>') }
+    end
+
+    describe '#hash' do
+      it { subject.hash.should eql([klass].hash) }
+    end
+
+
+  end
+
+  context 'with attributes' do
+    let(:value) { 11 }
+    let(:klass) {
+      ::Class.new do
+        include TTY::Equatable
+
+        attr_reader :value
+
+        def initialize(value)
+          @value = value
+        end
+      end
+    }
+
+    before {
+      klass.stub(:name).and_return name
+    }
+
+    subject { klass.new(value) }
+
+    it 'dynamically defines #hash method' do
+      klass.method_defined?(:hash).should be_true
+    end
+
+    it 'dynamically defines #inspect method' do
+      klass.method_defined?(:inspect).should be_true
+    end
+
+    it { should respond_to :compare? }
+
+    it { should respond_to :eql? }
+
+    describe '#eql?' do
+      context 'when objects are similar' do
+        let(:other) { subject.dup }
+
+        it { subject.eql?(other).should be_true }
+      end
+
+      context 'when objects are different' do
+        let(:other) { stub('other') }
+
+        it { subject.eql?(other).should be_false }
+      end
+    end
+
+    describe '#==' do
+      context 'when objects are similar' do
+        let(:other) { subject.dup }
+
+        it { (subject == other).should be_true }
+      end
+
+      context 'when objects are different' do
+        let(:other) { stub('other') }
+
+        it { (subject == other).should be_false }
+      end
+    end
+
+    describe '#inspect' do
+      it { subject.inspect.should eql('#<Value value=11>') }
+    end
+
+    describe '#hash' do
+      it { subject.hash.should eql( ([klass] + [value]).hash) }
+    end
+
+    context 'equivalence relation' do
+      let(:other) { subject.dup }
+
+      it 'is not equal to nil reference' do
+         subject.eql?(nil).should be_false
+      end
+
+      it 'is reflexive' do
+        subject.eql?(subject).should be_true
+      end
+
+      it 'is symmetric' do
+        (subject.eql?(other)).should eql( other.eql?(subject) )
+      end
+
+      it 'is transitive'
+    end
+  end
+
+  context 'subclass' do
+    let(:value) { 11 }
+    let(:klass) {
+      ::Class.new do
+        include TTY::Equatable
+
+        attr_reader :value
+
+        def initialize(value)
+          @value = value
+        end
+      end
+    }
+    let(:subclass) { ::Class.new(klass) }
+
+    before {
+      klass.stub(:name).and_return name
+    }
+
+    subject { subclass.new(value) }
+
+    it { subclass.superclass.should == klass }
+
+    it { should respond_to :value }
+
+    describe '#inspect' do
+      it { subject.inspect.should eql('#<Value value=11>') }
+    end
+
+    describe '#eql?' do
+      context 'when objects are similar' do
+        let(:other) { subject.dup }
+
+        it { subject.eql?(other).should be_true }
+      end
+
+      context 'when objects are different' do
+        let(:other) { stub('other') }
+
+        it { subject.eql?(other).should be_false }
+      end
+    end
+
+    describe '#==' do
+      context 'when objects are similar' do
+        let(:other) { subject.dup }
+
+        it { (subject == other).should be_true }
+      end
+
+      context 'when objects are different' do
+        let(:other) { stub('other') }
+
+        it { (subject == other)}
+      end
+    end
+  end
+
+end

data/spec/tty/table/access_spec.rb

@@ -10,10 +10,17 @@ describe TTY::Table, 'access' do
 
   it { should respond_to(:component) }
 
+  it { should respond_to(:at) }
+
   its([0,0]) { should == 'a1'}
 
-  context '#row' do
+  its([5,5]) { should be_nil }
 
+  it 'raises error for negative indices' do
+    expect { subject[-5,-5] }.to raise_error(IndexError)
+  end
+
+  context '#row' do
     it 'returns nil for wrong index' do
       subject.row(11).should be_nil
     end

data/spec/tty/table/eql_spec.rb

@@ -3,8 +3,14 @@
 require 'spec_helper'
 
 describe TTY::Table, '#eql?' do
+  let(:rows)   { [['a1', 'a2'], ['b1', 'b2']] }
+  let(:object) { described_class.new rows }
+
   subject { object.eql?(other) }
-  let(:object) { described_class.new }
+
+  describe '#inspect' do
+    it { object.inspect.should =~ /#<TTY::Table/ }
+  end
 
   context 'with the same object' do
     let(:other) { object }

data/spec/tty/table/initialize_spec.rb

@@ -12,53 +12,61 @@ describe TTY::Table, '#initialize' do
 
   it { (Enumerable === subject).should be_true }
 
-  it 'initializes table header' do
-    table = TTY::Table.new :header => header
-    table.header.should == header
-  end
+  context 'with rows only' do
+    it 'initializes with rows as arguments' do
+      table = TTY::Table[*rows]
+      table.to_a.should == rows
+    end
 
-  it 'initializes table header as an option' do
-    table = TTY::Table.new :header => header
-    table.header.should == header
-  end
+    it 'initializes with rows' do
+      table = TTY::Table.new rows
+      table.to_a.should == rows
+    end
 
-  it 'initializes with rows as arguments' do
-    table = TTY::Table[*rows]
-    table.to_a.should == rows
-  end
+    it 'initializes table rows as an option' do
+      table = TTY::Table.new :rows => rows
+      table.to_a.should == rows
+    end
 
-  it 'initializes ' do
-    table = TTY::Table.new rows
-    table.to_a.should == rows
-  end
+    it 'initializes table rows in a block with param' do
+      table = TTY::Table.new  do |t|
+        t << rows[0]
+        t << rows[1]
+      end
+      table.to_a.should == rows
+    end
 
-  it 'initializes table rows as an option' do
-    table = TTY::Table.new :rows => rows
-    table.to_a.should == rows
-  end
+    it 'initializes table and adds rows' do
+      table = TTY::Table.new
+      table << rows[0]
+      table << rows[1]
+      table.to_a.should == rows
+    end
 
-  it 'initializes table rows as an argument' do
-    table = TTY::Table.new header, rows
-    table.to_a.should == rows
+    it 'chains rows' do
+      table = TTY::Table.new
+      table << rows[0] << rows[1]
+      table.to_a.should == rows
+    end
   end
 
-  it 'initializes table rows in a block with param' do
-    table = TTY::Table.new  do |t|
-      t << rows[0]
-      t << rows[1]
+  context 'with header and rows' do
+    it 'initializes header as an option' do
+      table = TTY::Table.new :header => header
+      table.header.should == header
     end
-    table.to_a.should == rows
-  end
 
-  it 'initializes table and adds rows' do
-    table = TTY::Table.new
-    table << rows[0]
-    table << rows[1]
-    table.to_a.should == rows
+    it 'initializes table rows as an argument' do
+      table = TTY::Table.new header, rows
+      table.header.should == header
+      table.to_a.should == rows
+    end
   end
 
-  it 'converts row arguments from hash to array' do
-    table = TTY::Table.new :rows => {:a => 1, :b => 2}
-    table.to_a.should include [:a, 1 ]
+  context 'coercion' do
+    it 'converts row arguments from hash to array' do
+      table = TTY::Table.new :rows => {:a => 1, :b => 2}
+      table.to_a.should include [:a, 1 ]
+    end
   end
 end

data/spec/tty/table/operation/alignment/format_spec.rb

@@ -4,21 +4,22 @@ require 'spec_helper'
 
 describe TTY::Table::Operation::Alignment, '#new' do
   let(:object) { described_class.new alignment }
-  let(:cell) { "aaaa"}
+  let(:field) { "aaaa"}
+  let(:space) { '' }
   let(:column_width) { 8 }
 
-  subject { object.format cell, column_width }
+  subject { object.format field, column_width, space }
 
   shared_examples_for 'lower column width' do
     let(:column_width) { 2 }
 
-    it { should == cell }
+    it { should == field }
   end
 
   context 'left aligend' do
     let(:alignment) { :left }
 
-    it { should == cell + '    ' }
+    it { should == field + '    ' }
 
     it_should_behave_like 'lower column width'
   end
@@ -26,7 +27,7 @@ describe TTY::Table::Operation::Alignment, '#new' do
   context 'center aligned' do
     let(:alignment) { :center }
 
-    it { should == '  ' + cell + '  ' }
+    it { should == '  ' + field + '  ' }
 
     it_should_behave_like 'lower column width'
   end
@@ -36,4 +37,11 @@ describe TTY::Table::Operation::Alignment, '#new' do
 
     it_should_behave_like 'lower column width'
   end
+
+  context 'with space' do
+    let(:alignment) { :center }
+    let(:space) { ' '}
+
+    it { should == '  ' + field + '   ' }
+  end
 end

data/spec/tty/table/operation/alignment_set/align_rows_spec.rb

@@ -14,7 +14,7 @@ describe TTY::Table::Operation::AlignmentSet, '#align_rows' do
 
     it { should be_instance_of(Array) }
 
-    it { should == ['a1   a2  ', 'b1   b2  '] }
+    it { should == [['a1   ', 'a2  '], ['b1   ', 'b2  ']] }
   end
 
   context 'aligned with column widths and alignments' do
@@ -23,7 +23,7 @@ describe TTY::Table::Operation::AlignmentSet, '#align_rows' do
 
     it { should be_instance_of(Array) }
 
-    it { should == ['  a1 a2  ', '  b1 b2  '] }
+    it { should == [['  a1 ', 'a2  '], ['  b1 ', 'b2  ']] }
   end
 
   context 'aligned with no column widths and no alignments' do
@@ -32,7 +32,7 @@ describe TTY::Table::Operation::AlignmentSet, '#align_rows' do
 
     it { should be_instance_of(Array) }
 
-    it { should == ['a1 a2', 'b1 b2'] }
+    it { should == [['a1 ', 'a2'], ['b1 ', 'b2']] }
   end
 
   context 'aligned with no column widths and alignments' do
@@ -41,6 +41,6 @@ describe TTY::Table::Operation::AlignmentSet, '#align_rows' do
 
     it { should be_instance_of(Array) }
 
-    it { should == ['a1 a2', 'b1 b2'] }
+    it { should == [['a1 ', 'a2'], ['b1 ', 'b2']] }
   end
 end

data/spec/tty/table/operation/truncation/truncate_spec.rb

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Table::Operation::Truncation, '#truncate' do
+  let(:instance) { described_class.new }
+  let(:text) { '太丸ゴシック体' }
+
+  subject { instance.truncate(text, width) }
+
+  context 'without shortening' do
+    let(:width) { 8 }
+
+    it { should == text }
+  end
+
+  context 'with shortening' do
+    let(:width) { 5 }
+
+    it { should == '太丸ゴシ…' }
+  end
+end

data/spec/tty/table/options_spec.rb

@@ -17,7 +17,11 @@ describe TTY::Table, 'options' do
 
   its(:column_widths) { should == [2,2] }
 
-  its(:column_aligns) { should == [] }
+  its(:alignments) { should be_kind_of TTY::Table::Operation::AlignmentSet }
+
+  it 'is empty' do
+    subject.alignments.to_a.should be_empty
+  end
 
   context '#column_widths' do
     let(:widths) { [10, 10] }
@@ -28,6 +32,8 @@ describe TTY::Table, 'options' do
   context '#column_aligns' do
     let(:aligns) { [:center, :center] }
 
-    its(:column_aligns) { should == aligns }
+    it 'unwraps original array' do
+      subject.alignments.to_a.should == aligns
+    end
   end
 end

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

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Table::Renderer::Basic, 'alignment' do
+  let(:header) { ['h1', 'h2', 'h3'] }
+  let(:rows) { [['a1', 'a2', 'a3'], ['b1', 'b2', 'b3']] }
+
+  it 'aligns left by default' do
+    header = ['h1', 'h2']
+    rows = [['aaaaa', 'a'], ['b', 'bbbbb']]
+    table = TTY::Table.new header, rows, :renderer => :basic
+    table.to_s.should == <<-EOS.normalize
+      h1    h2   
+      aaaaa a    
+      b     bbbbb
+    EOS
+  end
+
+  it 'aligns table headers' do
+    header = ['header1', 'head2', 'h3']
+    table = TTY::Table.new header, rows, :render => :basic,
+      :column_aligns => [:left, :center, :right]
+    table.to_s.should == <<-EOS.normalize
+      header1 head2 h3
+      a1       a2   a3
+      b1       b2   b3
+    EOS
+  end
+
+  it 'aligns table rows' do
+    rows = [['aaaaa', 'a'], ['b', 'bbbbb']]
+    table = TTY::Table.new rows, :renderer => :basic,
+                                  :column_aligns => [:left, :right]
+    table.to_s.should == <<-EOS.normalize
+      aaaaa     a
+      b     bbbbb
+    EOS
+  end
+end