tty-table 0.1.0

data/spec/unit/row/equality_spec.rb

@@ -0,0 +1,73 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Table::Row, '#==' do
+  let(:attributes) { [:id] }
+  let(:data) { ['1'] }
+  let(:object) { described_class.new(data, attributes) }
+
+  subject { object == other }
+
+  context 'with the same object' do
+    let(:other) { object }
+
+    it { is_expected.to eql(true) }
+
+    it 'is symmetric' do
+      is_expected.to eql(other == object)
+    end
+  end
+
+  context 'with an equivalent object' do
+    let(:other) { object.dup }
+
+    it { is_expected.to eql(true) }
+
+    it 'is symmetric' do
+      is_expected.to eql(other == object)
+    end
+  end
+
+  context 'with an equivalent object of subclass' do
+    let(:other) { Class.new(described_class).new(data, attributes: attributes) }
+
+    it { is_expected.to eql(true) }
+
+    it 'is symmetric' do
+      is_expected.to eql(other == object)
+    end
+  end
+
+  context 'with an object having a different attributes' do
+    let(:other_attributes) { [:text] }
+    let(:other) { described_class.new(data, attributes: other_attributes) }
+
+    it { is_expected.to eql(true) }
+
+    it 'is symmetric' do
+      is_expected.to eql(other == object)
+    end
+  end
+
+  context 'with an object having a different attributes' do
+    let(:other_data) { [2] }
+    let(:other) { described_class.new(other_data, attributes: attributes) }
+
+    it { is_expected.to eql(false) }
+
+    it 'is symmetric' do
+      is_expected.to eql(other == object)
+    end
+  end
+
+  context 'with an equivalent object responding to_ary' do
+    let(:other) { data }
+
+    it { is_expected.to eql(true) }
+
+    it 'is symmetric' do
+      is_expected.to eql(other == object)
+    end
+  end
+end

data/spec/unit/row/height_spec.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Table::Row, '#height' do
+  let(:object) { described_class.new row }
+
+  subject { object.height }
+
+  context 'single row' do
+    let(:row) { ['a1', 'b1'] }
+
+    it { expect(subject).to eql(1) }
+  end
+
+  context 'non escaped multiline' do
+    let(:row) { ["a1\na2\na3", 'b1'] }
+
+    it { expect(subject).to eql(3)}
+  end
+
+  context 'escaped multiline' do
+    let(:row) { ["a1\\na2\\na3", 'b1'] }
+
+    it { expect(subject).to eql(1) }
+  end
+end

data/spec/unit/row/new_spec.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Table::Row, '#new' do
+  let(:object) { described_class }
+
+  subject { object.new data }
+
+  context 'with no arguments' do
+    let(:data) { [] }
+
+    it { is_expected.to be_instance_of(object) }
+
+    it { is_expected.to be_empty }
+
+    it { expect(subject.attributes).to eq([]) }
+
+    it { expect(subject.data).to eq({}) }
+  end
+
+  context 'with Array argument' do
+    let(:data) { ['a'] }
+
+    it { is_expected.to be_instance_of(object) }
+
+    it { expect(subject.attributes).to eq([0]) }
+
+    it { expect(subject.to_hash).to eq({0 => "a"}) }
+  end
+
+  context 'with Hash argument' do
+    let(:data) { {id: 'a'} }
+
+    it { should be_instance_of(object) }
+
+    it { expect(subject.attributes).to eq([:id]) }
+
+    it { expect(subject.to_hash).to eq({:id => 'a'}) }
+  end
+end

data/spec/unit/row/to_ary_spec.rb

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Table::Row, '#to_ary' do
+  let(:object) { described_class.new data }
+  let(:data) { ['a', 'b'] }
+
+  subject { object.to_ary }
+
+  it { is_expected.to be_instance_of(Array) }
+
+  it { is_expected.to eq(data) }
+end

data/spec/unit/to_s_spec.rb

@@ -0,0 +1,63 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Table, '#to_s' do
+  let(:header)   { ['h1', 'h2', 'h3'] }
+  let(:rows)     { [['a1', 'a2', 'a3'], ['b1', 'b2', 'b3']] }
+  let(:renderer) { :basic }
+
+  subject(:table) { described_class.new(header, rows) }
+
+  context 'without renderer' do
+    let(:renderer) { nil }
+
+    it 'displayes basic table' do
+      expect(table.to_s).to eq <<-EOS.normalize
+        h1 h2 h3
+        a1 a2 a3
+        b1 b2 b3
+      EOS
+    end
+  end
+
+  context 'without border' do
+    it 'displays table' do
+      expect(table.to_s).to eq <<-EOS.normalize
+        h1 h2 h3
+        a1 a2 a3
+        b1 b2 b3
+      EOS
+    end
+  end
+
+  context 'with ascii border' do
+    let(:renderer) { :ascii }
+
+    it 'displays table' do
+      expect(table.render(renderer)).to eq <<-EOS.normalize
+        +--+--+--+
+        |h1|h2|h3|
+        +--+--+--+
+        |a1|a2|a3|
+        |b1|b2|b3|
+        +--+--+--+
+      EOS
+    end
+  end
+
+  context 'with unicode border' do
+    let(:renderer) { :unicode}
+
+    it 'displays table' do
+      expect(table.render(renderer)).to eq <<-EOS.normalize
+        ┌──┬──┬──┐
+        │h1│h2│h3│
+        ├──┼──┼──┤
+        │a1│a2│a3│
+        │b1│b2│b3│
+        └──┴──┴──┘
+      EOS
+    end
+  end
+end # to_s

data/spec/unit/transformation/extract_tuples_spec.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Table::Transformation, '#extract_tuples' do
+  let(:object) { described_class }
+  let(:header) { ['Header1', 'Header2'] }
+  let(:rows) { [['a1', 'a2'], ['b1', 'b2']] }
+
+  subject { object.extract_tuples(value) }
+
+  context 'when rows' do
+    let(:value) { [rows] }
+
+    it { expect(subject[:header]).to be_nil }
+
+    it { expect(subject[:rows]).to eql(rows) }
+  end
+
+  context 'when header and rows' do
+    let(:value) { [header, rows] }
+
+    it { expect(subject[:header]).to eql(header) }
+
+    it { expect(subject[:rows]).to eql(rows) }
+  end
+
+  context 'when hash' do
+    let(:value) { [[{'Header1' => ['a1', 'a2'], 'Header2' => ['b1', 'b2'] }]] }
+
+    it { expect(subject[:header]).to eql(header) }
+
+    it { expect(subject[:rows]).to eql(rows) }
+  end
+end

data/spec/unit/validatable/validate_options_spec.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Table::Validatable, '#validate_options!' do
+  let(:described_class) { Class.new { include TTY::Table::Validatable } }
+
+  subject { described_class.new.validate_options! options }
+
+  context 'with empty rows' do
+    let(:options) { {rows: []} }
+
+    it { expect { subject }.not_to raise_error() }
+  end
+
+  context 'with invalid rows type' do
+    let(:options) { {rows: 1 } }
+
+    it { expect { subject }.to raise_error(TTY::Table::InvalidArgument) }
+  end
+
+  context 'with empty header' do
+    let(:options) { {header: []} }
+
+    it { expect { subject }.to raise_error(TTY::Table::InvalidArgument) }
+  end
+
+  context 'with invalid header type' do
+    let(:options) { {header: 1} }
+
+    it { expect { subject }.to raise_error(TTY::Table::InvalidArgument) }
+  end
+end

data/spec/unit/validatable_spec.rb

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Table::Validatable do
+  let(:described_class) { Class.new { include TTY::Table::Validatable } }
+  let(:rows) { [['a1', 'a2'], ['b1']] }
+
+  subject { described_class.new }
+
+  it 'raises no exception' do
+    rows[1] << ['b2']
+    expect { subject.assert_row_sizes(rows) }.not_to raise_error
+  end
+
+  it 'raises exception for mismatched rows' do
+    expect { subject.assert_row_sizes(rows) }.
+      to raise_error(TTY::Table::DimensionMismatchError)
+  end
+
+  it "raises exception when :header key has wrong data type" do
+    options = {header: 'h1'}
+    expect { subject.validate_options!(options) }.
+      to raise_error(TTY::Table::InvalidArgument)
+  end
+
+  it "raises exception when :rows key has wrong data type" do
+    options = {rows: 'a1'}
+    expect { subject.validate_options!(options) }.
+      to raise_error(TTY::Table::InvalidArgument)
+  end
+end

data/tasks/console.rake

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.join(__FILE__, '../../lib/tty-table')
+  ARGV.clear
+  IRB.start
+end

data/tasks/coverage.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Measure code coverage'
+task :coverage do
+  begin
+    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
+    Rake::Task['spec'].invoke
+  ensure
+    ENV['COVERAGE'] = original
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
+  end
+
+  namespace :spec do
+    desc 'Run unit specs'
+    RSpec::Core::RakeTask.new(:unit) do |task|
+      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    RSpec::Core::RakeTask.new(:integration) do |task|
+      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
+    end
+  end
+
+rescue LoadError
+  %w[spec spec:unit spec:integration].each do |name|
+    task name do
+      $stderr.puts "In order to run #{name}, do `gem install rspec`"
+    end
+  end
+end

data/tty-table.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tty/table/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tty-table'
+  spec.version       = TTY::Table::VERSION
+  spec.authors       = ["Piotr Murach"]
+  spec.email         = [""]
+  spec.summary       = %q{A flexible and intuitive table generator}
+  spec.description   = %q{A flexible and intuitive table generator}
+  spec.homepage      = "https://github.com/peter-murach/tty-table"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'equatable',   '~> 0.5'
+  spec.add_dependency 'necromancer', '~> 0.3'
+  spec.add_dependency 'pastel',      '~> 0.4'
+  spec.add_dependency 'tty-screen',  '~> 0.1'
+  spec.add_dependency 'verse',       '~> 0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+end