columnist 1.0.0

data/spec/nested_formatter_spec.rb

@@ -0,0 +1,301 @@
+require 'spec_helper'
+
+describe Columnist::NestedFormatter do
+  subject { Columnist::NestedFormatter.instance }
+
+  let(:controls) do
+    {
+      :clear => "\e[0m",
+      :bold => "\e[1m",
+      :red => "\e[31m",
+    }
+  end
+
+  describe '#method default values' do
+    describe '#message_string' do
+      subject { super().message_string }
+      it { should == 'working' }
+    end
+
+    describe '#complete_string' do
+      subject { super().complete_string }
+      it { should == 'complete' }
+    end
+
+    describe '#indent_size' do
+      subject { super().indent_size }
+      it { should eq 2 }
+    end
+  end
+
+  describe '#format' do
+    context 'argument validation' do
+      before :each do
+        @indent_size = subject.indent_size
+      end
+
+      # Restore the singleton to its original state to ensure clean tests
+      after :each do
+        subject.indent_size = @indent_size
+      end
+
+      it 'raises exception when there is an invalid argument' do
+        expect {
+          subject.format({:asdf => true}, lambda { })
+        }.to raise_exception ArgumentError
+      end
+
+      it 'raises an exception when a block is not given' do
+        expect {
+          subject.format({:message => 'test'})
+        }.to raise_exception
+      end
+
+      it 'accepts valid arguments' do
+        expect(subject).to receive(:puts).with('test')
+        expect(subject).to receive(:puts).with('complete')
+
+        expect {
+          subject.format({:message => 'test'}, lambda { }) do
+          end
+        }.not_to raise_exception
+      end
+    end
+
+    context 'not nested' do
+      before :each do
+        @complete_string = subject.complete_string
+        @indent_size = subject.indent_size
+      end
+
+      # Restore the singleton to its original state to ensure clean tests
+      after :each do
+        subject.complete_string = @complete_string
+        subject.indent_size = @indent_size
+      end
+
+      it 'performs a wrapped report' do
+        expect(subject).to receive(:puts).with('working')
+        expect(subject).to receive(:puts).with('complete')
+
+        subject.format({ }, lambda { })
+      end
+
+      it 'performs a wrapped report with color' do
+        expect(subject).to receive(:puts).with("#{controls[:red]}working#{controls[:clear]}")
+        expect(subject).to receive(:puts).with("#{controls[:red]}complete#{controls[:clear]}")
+
+        subject.format({:color => 'red'}, lambda { })
+      end
+
+      it 'performs a wrapped report with color' do
+        expect(subject).to receive(:puts).with("#{controls[:bold]}working#{controls[:clear]}")
+        expect(subject).to receive(:puts).with("#{controls[:bold]}complete#{controls[:clear]}")
+
+        subject.format({:bold => true}, lambda { })
+      end
+
+      it 'performs a wrapped report overriding the message' do
+        expect(subject).to receive(:puts).with('test')
+        expect(subject).to receive(:puts).with('complete')
+
+        subject.format({:message => 'test'}, lambda { })
+      end
+
+      it 'performs an inline report' do
+        expect(subject).to receive(:print).with('test...')
+        expect(subject).to receive(:puts).with('complete')
+        expect(subject).to receive(:print).with('test2...')
+        expect(subject).to receive(:puts).with('complete')
+
+        subject.format({:message => 'test', :type => 'inline'}, lambda { })
+        subject.format({:message => 'test2', :type => 'inline'}, lambda { })
+      end
+
+      it 'overrides the default for all invocations of a wrapped report' do
+        subject.complete_string = 'done'
+        expect(subject).to receive(:puts).with('test')
+        expect(subject).to receive(:puts).with('done')
+        expect(subject).to receive(:puts).with('test2')
+        expect(subject).to receive(:puts).with('done')
+
+        subject.format({:message => 'test'}, lambda { })
+        subject.format({:message => 'test2'}, lambda { })
+      end
+
+      it 'overrides the default complete string for a wrapped report' do
+        expect(subject).to receive(:puts).with('test')
+        expect(subject).to receive(:puts).with('done')
+        expect(subject).to receive(:puts).with('test2')
+        expect(subject).to receive(:puts).with('finally')
+
+        subject.format({:message => 'test', :complete => 'done'}, lambda { })
+        subject.format({:message => 'test2', :complete => 'finally'}, lambda { })
+      end
+
+      it 'overrides the default complete string for an inline report' do
+        expect(subject).to receive(:print).with('test...')
+        expect(subject).to receive(:puts).with('done')
+        expect(subject).to receive(:print).with('test2...')
+        expect(subject).to receive(:puts).with('finally')
+
+        subject.format({:message => 'test', :type => 'inline', :complete => 'done'}, lambda { })
+        subject.format({:message => 'test2', :type => 'inline', :complete => 'finally'}, lambda { })
+      end
+
+      it 'performs another wrapped report to ensure defaul behavior' do
+        expect(subject).to receive(:puts).with('test')
+        expect(subject).to receive(:puts).with('complete')
+        expect(subject).to receive(:puts).with('test2')
+        expect(subject).to receive(:puts).with('complete')
+
+        subject.format({:message => 'test'}, lambda { })
+        subject.format({:message => 'test2'}, lambda { })
+      end
+    end
+
+    context 'nested commands' do
+      before :each do
+        @indent_size = subject.indent_size
+      end
+
+      # Restore the singleton to its original state to ensure clean tests
+      after :each do
+        subject.indent_size = @indent_size
+      end
+
+      it 'indents the nested wrapped messages' do
+        expect(subject).to receive(:puts).with('test')
+        expect(subject).to receive(:puts).with('  test2')
+        expect(subject).to receive(:puts).with('  complete')
+        expect(subject).to receive(:puts).with('complete')
+
+        subject.format({:message => 'test'}, lambda {
+          subject.format({:message => 'test2'}, lambda {})
+        })
+      end
+
+      it 'indents the nested wrapped messages and outputs color' do
+        expect(subject).to receive(:puts).with("#{controls[:red]}test#{controls[:clear]}")
+        expect(subject).to receive(:puts).with("#{controls[:red]}  test2#{controls[:clear]}")
+        expect(subject).to receive(:puts).with("#{controls[:red]}  complete#{controls[:clear]}")
+        expect(subject).to receive(:puts).with("#{controls[:red]}complete#{controls[:clear]}")
+
+        subject.format({:message => 'test', :color => 'red'}, lambda {
+          subject.format({:message => 'test2', :color => 'red'}, lambda {})
+        })
+      end
+
+      it 'indents the nested wrapped messages and outputs bold' do
+        expect(subject).to receive(:puts).with("#{controls[:bold]}test#{controls[:clear]}")
+        expect(subject).to receive(:puts).with("#{controls[:bold]}  test2#{controls[:clear]}")
+        expect(subject).to receive(:puts).with("#{controls[:bold]}  complete#{controls[:clear]}")
+        expect(subject).to receive(:puts).with("#{controls[:bold]}complete#{controls[:clear]}")
+
+        subject.format({:message => 'test', :bold => true}, lambda {
+          subject.format({:message => 'test2', :bold => true}, lambda {})
+        })
+      end
+
+      it 'indents the multiple nested wrapped messages' do
+        expect(subject).to receive(:puts).with('test')
+        expect(subject).to receive(:puts).with('  test2')
+        expect(subject).to receive(:puts).with('    test3')
+        expect(subject).to receive(:puts).with('    complete')
+        expect(subject).to receive(:puts).with('  complete')
+        expect(subject).to receive(:puts).with('complete')
+
+        subject.format({:message => 'test'}, lambda {
+          subject.format({:message => 'test2'}, lambda {
+            subject.format({:message => 'test3'}, lambda { })
+          })
+        })
+      end
+
+      it 'indents the nested wrapped and inline messages' do
+        expect(subject).to receive(:puts).with('test')
+        expect(subject).to receive(:print).with('  test2...')
+        expect(subject).to receive(:puts).with('complete')
+        expect(subject).to receive(:puts).with('complete')
+
+        subject.format({:message => 'test'}, lambda {
+          subject.format({:message => 'test2', :type => 'inline'}, lambda { })
+        })
+      end
+
+      it 'indents the multiple nested wrapped messages' do
+        expect(subject).to receive(:puts).with('test')
+        expect(subject).to receive(:puts).with('  test2')
+        expect(subject).to receive(:print).with('    test3...')
+        expect(subject).to receive(:puts).with('complete')
+        expect(subject).to receive(:puts).with('  complete')
+        expect(subject).to receive(:puts).with('complete')
+
+        subject.format({:message => 'test'}, lambda {
+          subject.format({:message => 'test2'}, lambda {
+            subject.format({:message => 'test3', :type => 'inline'}, lambda { })
+          })
+        })
+      end
+
+      it 'overrides the indent spacing of all messages' do
+        expect(subject).to receive(:puts).with('test')
+        expect(subject).to receive(:puts).with('    test2')
+        expect(subject).to receive(:print).with('        test3...')
+        expect(subject).to receive(:puts).with('complete')
+        expect(subject).to receive(:puts).with('    complete')
+        expect(subject).to receive(:puts).with('complete')
+
+        subject.indent_size = 4
+
+        subject.format({:message => 'test'}, lambda {
+          subject.format({:message => 'test2'}, lambda {
+            subject.format({:message => 'test3', :type => 'inline'}, lambda { })
+          })
+        })
+      end
+
+      it 'overrides the indent spacing of specific message' do
+        expect(subject).to receive(:puts).with('test')
+        expect(subject).to receive(:puts).with('      test2')
+        expect(subject).to receive(:print).with('      test3...')
+        expect(subject).to receive(:puts).with('complete')
+        expect(subject).to receive(:puts).with('      complete')
+        expect(subject).to receive(:puts).with('complete')
+
+        subject.indent_size = 4
+
+        subject.format({:message => 'test'}, lambda {
+          subject.format({:message => 'test2', :indent_size => 6}, lambda {
+            subject.format({:message => 'test3', :type => 'inline', :indent_size => 3}, lambda { })
+          }) 
+        })
+      end
+
+      it 'performs the sums specified in the block' do
+        x,y,z = 0,0,0
+
+        expect(subject).to receive(:puts).with('sum x and 10')
+        expect(subject).to receive(:puts).with('  y is the difference of 20 and x')
+        expect(subject).to receive(:puts).with('    z = x + y')
+        expect(subject).to receive(:puts).with('    complete')
+        expect(subject).to receive(:puts).with('  complete')
+        expect(subject).to receive(:puts).with('complete')
+
+        subject.format({:message => 'sum x and 10'}, lambda {
+          x = x + 10
+          subject.format({:message => 'y is the difference of 20 and x'}, lambda {
+            y = 20 - x
+            subject.format({:message => 'z = x + y'}, lambda {
+              z = x + y
+            })
+          })
+        })
+
+        expect(x).to eq(10)
+        expect(y).to eq(10)
+        expect(z).to eq(20)
+      end
+    end
+  end
+end

data/spec/options_validator_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe OptionsValidator do
+  subject { Class.new.extend(OptionsValidator) }
+
+  it 'accepts single key options' do
+    expect {
+      subject.validate_options({:valid => true}, :valid)
+    }.to_not raise_error
+  end
+
+  it 'rejects invalid option hashes' do
+    expect {
+      subject.validate_options({:wrong => true}, :valid)
+    }.to raise_error ArgumentError
+  end
+
+  it 'accepts multi-key options' do
+    expect {
+      valid = [:valid, :another]
+      subject.validate_options({:valid => true, :another => true}, *valid)
+    }.to_not raise_error
+  end
+end

data/spec/progress_formatter_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Columnist::ProgressFormatter do
+  subject { Columnist::ProgressFormatter.instance }
+
+  describe '#method default values' do
+    describe '#indicator' do
+      subject { super().indicator }
+      it { should == '.' }
+    end
+  end
+
+  let :controls do
+    {
+      :clear => "\e[0m",
+      :bold => "\e[1m",
+      :red => "\e[31m",
+    }
+  end
+
+  describe '#format' do
+    it 'displays dots for the indicator' do
+      expect(subject).to receive(:print).exactly(10).times.with('.')
+      expect(subject).to receive(:puts).exactly(1).times
+
+      subject.format({}, lambda {
+        10.times {subject.progress}
+      })
+    end
+
+    it 'displays colored red dots for the indicator' do
+      expect(subject).to receive(:print).exactly(10).times.with("#{controls[:red]}.#{controls[:clear]}")
+      expect(subject).to receive(:puts).exactly(1).times
+
+      subject.format({:color => 'red'}, lambda {
+        10.times {subject.progress}
+      })
+    end
+
+    it 'displays BOLD dots for the indicator' do
+      expect(subject).to receive(:print).exactly(10).times.with("#{controls[:bold]}.#{controls[:clear]}")
+      expect(subject).to receive(:puts).exactly(1).times
+
+      subject.format({:bold => true}, lambda {
+        10.times {subject.progress}
+      })
+    end
+
+    it 'uses the defined indicator' do
+      subject.indicator = '+'
+      expect(subject).to receive(:print).exactly(10).times.with('+')
+      expect(subject).to receive(:puts)
+
+      subject.format({}, lambda {
+        10.times {subject.progress}
+      })
+
+    end
+
+    it 'allows override of the indicator' do
+      expect(subject).to receive(:print).exactly(10).times.with('=')
+      expect(subject).to receive(:puts)
+
+      subject.format({:indicator => '='}, lambda {
+        10.times {subject.progress}
+      })
+    end
+  end
+
+  describe '#progress' do
+    it 'allows override of the indicator' do
+      expect(subject).to receive(:print).exactly(10).times.with('+')
+      expect(subject).to receive(:puts)
+
+      subject.format({}, lambda {
+        10.times {subject.progress('+')}
+      })
+    end
+
+    it 'allows any indicator' do
+      expect(subject).to receive(:print).exactly(10).times
+      expect(subject).to receive(:puts)
+
+      subject.format({}, lambda {
+        10.times {|i| subject.progress("#{i}")}
+      })
+    end
+  end
+end

data/spec/row_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+describe Columnist::Row do
+  let(:cols) { 10.times.map {|v| Columnist::Column.new("test#{v}")} }
+
+  describe '#initialize' do
+    it 'accepts header' do
+      expect(Columnist::Row.new(:header => true).header).to be_true
+    end
+
+    it 'accepts color' do
+      expect(Columnist::Row.new(:color => 'red').color).to eq('red')
+    end
+
+    it 'accepts bold' do
+      expect(Columnist::Row.new(:bold => true).bold).to be_true
+    end
+
+    it 'output encoding should be ascii' do
+      expect(Columnist::Row.new(:encoding => :ascii).encoding).to eq(:ascii)
+    end
+
+    it 'output encoding should be unicode' do
+      expect(Columnist::Row.new.encoding).to eq(:unicode)
+    end
+
+  end
+
+  describe '#add' do
+    subject { Columnist::Row.new }
+
+    it 'columns' do
+      subject.add(cols[0])
+      expect(subject.columns.size).to eq(1)
+      expect(subject.columns[0]).to eq(cols[0])
+      subject.add(cols[1])
+      expect(subject.columns).to eq(cols[0,2])
+    end
+
+    it 'defaults colors on columns' do
+      row = Columnist::Row.new(:color => 'red')
+      row.add(cols[0])
+      expect(row.columns[0].color).to eq('red')
+      row.add(cols[1])
+      expect(row.columns[1].color).to eq('red')
+    end
+
+    it 'allows columns to override the row color' do
+      col = Columnist::Column.new('test', :color => 'blue')
+      row = Columnist::Row.new(:color => 'red')
+      row.add(col)
+      expect(row.columns[0].color).to eq('blue')
+    end
+
+    it 'supercedes bold on columns' do
+      row = Columnist::Row.new(:bold => true)
+      row.add(cols[0])
+      expect(row.columns[0].bold).to be_true
+      row.add(cols[1])
+      expect(row.columns[1].bold).to be_true
+    end
+  end
+
+  describe '#output' do
+    let :cols do
+      [
+        Columnist::Column.new('asdf'),
+        Columnist::Column.new('qwer', :align => 'center'),
+        Columnist::Column.new('zxcv', :align => 'right'),
+        Columnist::Column.new('x' * 25, :align => 'left', :width => 10),
+        Columnist::Column.new('x' * 25, :align => 'center', :width => 10),
+        Columnist::Column.new('x' * 35, :align => 'left', :width => 10),
+      ]
+    end
+
+    let(:one_space) { ' ' }
+    let(:three_spaces) { ' {3,3}' }
+    let(:six_spaces) { ' {6,6}' }
+    let(:nine_spaces) { ' {9,9}' }
+    let(:five_xs) { 'x{5,5}' }
+    let(:ten_xs) { 'x{10,10}' }
+
+    context 'no border' do
+      context 'no wrap' do
+        it 'outputs a single column' do
+          subject.add(cols[0])
+          expect(subject).to receive(:puts).with(/^asdf#{@six_pieces}/)
+          subject.output
+        end
+        it 'outputs three columns' do
+          subject.add(cols[0])
+          subject.add(cols[1])
+          subject.add(cols[2])
+          expect(subject).to receive(:puts).with(/^asdf#{six_spaces}#{one_space}#{three_spaces}qwer#{three_spaces}#{one_space}#{six_spaces}zxcv $/)
+          subject.output
+        end
+      end
+
+      context 'with wrapping' do
+        it 'outputs a single column' do
+          subject.add(cols[3])
+          expect(subject).to receive(:puts).with(/^#{ten_xs}#{one_space}$/)
+          expect(subject).to receive(:puts).with(/^#{ten_xs}#{one_space}$/)
+          expect(subject).to receive(:puts).with(/^#{five_xs}#{six_spaces}$/)
+          subject.output
+        end
+
+        it 'outputs multiple columns of the same size' do
+          subject.add(cols[3])
+          subject.add(cols[4])
+          expect(subject).to receive(:puts).with(/^#{ten_xs}#{one_space}#{ten_xs}#{one_space}$/)
+          expect(subject).to receive(:puts).with(/^#{ten_xs}#{one_space}#{ten_xs}#{one_space}$/)
+          expect(subject).to receive(:puts).with(/^#{five_xs}#{nine_spaces}#{five_xs}#{three_spaces}$/)
+          subject.output
+        end
+
+        it 'outputs multiple columns with different sizes' do
+          subject.add(cols[5])
+          subject.add(cols[3])
+          expect(subject).to receive(:puts).with(/^#{ten_xs}#{one_space}#{ten_xs}#{one_space}$/)
+          expect(subject).to receive(:puts).with(/^#{ten_xs}#{one_space}#{ten_xs}#{one_space}$/)
+          expect(subject).to receive(:puts).with(/^#{ten_xs}#{one_space}#{five_xs}#{six_spaces}$/)
+          expect(subject).to receive(:puts).with(/^#{five_xs} {5,17}$/)
+          subject.output
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'columnist'
+
+require_relative 'support/helpers/stdout'
+require_relative 'support/matchers/argument'

data/spec/support/helpers/stdout.rb

@@ -0,0 +1,8 @@
+require 'stringio'
+
+def capture_stdout
+  $stdout = StringIO.new
+  yield
+ensure
+  $stdout = STDOUT
+end

data/spec/support/matchers/argument.rb

@@ -0,0 +1,17 @@
+RSpec::Matchers.define :accepts_argument do |expected|
+  match do
+    expected.call.should raise_exception ArgumentError
+  end
+
+  # failure_message_for_should do |actual|
+  #   'should raise an ArgumentError'
+  # end
+
+  # failure_message_for_should_not do |actual|
+  #   'should not raise ArgumentError'
+  # end
+
+  # description do
+  #   'validates options argument'
+  # end
+end