command_line_reporter 4.0.3 → 5.0.0

data/spec/command_line_reporter_spec.rb

@@ -1,693 +0,0 @@
-require 'spec_helper'
-
-describe CommandLineReporter do
-  let :use_class do
-    Class.new do
-      include CommandLineReporter
-    end
-  end
-
-  let(:timestamp_regex) { /\d{4}-\d{2}-\d{2} - (\d| )\d:\d{2}:\d{2}[AP]M/ }
-
-  let :controls do
-    {
-      clear: "\e[0m",
-      bold: "\e[1m",
-      red: "\e[31m"
-    }
-  end
-
-  let(:linechar) { "\u2501" == 'u2501' ? '-' : "\u2501" }
-
-  subject { use_class.new }
-
-  describe '#formatter=' do
-    it 'only allows allowed formatters' do
-      expect do
-        subject.formatter = 'asfd'
-      end.to raise_error ArgumentError
-    end
-
-    it 'specifies the progress formatter' do
-      subject.formatter = 'progress'
-      expect(subject.formatter.class).to eq(CommandLineReporter::ProgressFormatter)
-    end
-
-    it 'specifies the nested formatter' do
-      subject.formatter = 'nested'
-      expect(subject.formatter.class).to eq(CommandLineReporter::NestedFormatter)
-    end
-  end
-
-  describe '#report' do
-    it 'uses the nested formatter as default' do
-      capture_stdout do
-        subject.report {}
-      end
-
-      expect(subject.formatter.class).to eq(CommandLineReporter::NestedFormatter)
-    end
-
-    it 'uses the progress formatter' do
-      capture_stdout do
-        subject.formatter = 'progress'
-        subject.report {}
-      end
-
-      expect(subject.formatter.class).to eq(CommandLineReporter::ProgressFormatter)
-    end
-
-    it 'does not mask other application errors when a formatter is not set' do
-      capture_stdout do
-        subject.report do
-          # rubocop:disable Style/RedundantSelf
-          expect { self.some_method_that_does_not_exist }.to raise_error(NoMethodError)
-        end
-      end
-    end
-  end
-
-  describe '#header' do
-    context 'argument validation' do
-      it 'does not accept an invalid option' do
-        expect do
-          subject.header(asdf: 'tests')
-        end.to raise_error ArgumentError
-      end
-
-      it 'accepts a title' do
-        expect do
-          allow(subject).to receive(:puts)
-          subject.header(title: 'test')
-        end.to_not raise_error Exception
-      end
-
-      it 'does not allow a title > width' do
-        expect do
-          subject.header(title: 'xxxxxxxxxxx', width: 5)
-        end.to raise_error ArgumentError
-      end
-
-      it 'accepts width' do
-        expect do
-          allow(subject).to receive(:puts)
-          subject.header(width: 100)
-        end.to_not raise_error Exception
-      end
-
-      it 'ensure width is a number' do
-        expect do
-          subject.header(width: 'adf')
-        end.to raise_error ArgumentError
-      end
-
-      it 'accepts align' do
-        expect do
-          allow(subject).to receive(:puts)
-          subject.header(align: 'center')
-        end.to_not raise_error Exception
-      end
-
-      it 'ensure align is a valid value' do
-        expect do
-          subject.header(align: :asdf)
-        end.to raise_error ArgumentError
-      end
-
-      it 'accepts spacing' do
-        expect do
-          allow(subject).to receive(:puts)
-          subject.header(spacing: 2)
-        end.to_not raise_error Exception
-      end
-
-      it 'accepts timestamp' do
-        expect do
-          allow(subject).to receive(:puts)
-          subject.header(timestamp: true)
-        end.to_not raise_error Exception
-      end
-
-      it 'accepts color' do
-        expect do
-          allow(subject).to receive(:puts)
-          subject.header(color: 'red')
-        end.to_not raise_error Exception
-      end
-
-      it 'accepts bold' do
-        expect do
-          allow(subject).to receive(:puts)
-          subject.header(bold: true)
-        end.to_not raise_error Exception
-      end
-    end
-
-    context 'alignment' do
-      before :each do
-        @title = 'test11test'
-      end
-
-      it 'left aligns title by default' do
-        expect(subject).to receive(:puts).with(@title)
-        expect(subject).to receive(:puts).with("\n")
-        subject.header(title: @title) {}
-      end
-
-      it 'left aligns title' do
-        expect(subject).to receive(:puts).with(@title)
-        expect(subject).to receive(:puts).with("\n")
-        subject.header(title: @title, align: 'left') {}
-      end
-
-      it 'right aligns title using default width' do
-        expect(subject).to receive(:puts).with(' ' * 90 + @title)
-        expect(subject).to receive(:puts).with("\n")
-        subject.header(title: @title, align: 'right')
-      end
-
-      it 'right aligns title using specified width' do
-        expect(subject).to receive(:puts).with(' ' * 40 + @title)
-        expect(subject).to receive(:puts).with("\n")
-        subject.header(title: @title, align: 'right', width: 50)
-      end
-
-      it 'center aligns title using default width' do
-        expect(subject).to receive(:puts).with(' ' * 45 + @title)
-        expect(subject).to receive(:puts).with("\n")
-        subject.header(title: @title, align: 'center')
-      end
-
-      it 'center aligns title using specified width' do
-        expect(subject).to receive(:puts).with(' ' * 35 + @title)
-        expect(subject).to receive(:puts).with("\n")
-        subject.header(title: @title, align: 'center', width: 80)
-      end
-    end
-
-    context 'spacing' do
-      it 'defaults to a single line of spacing between report' do
-        expect(subject).to receive(:puts).with('title')
-        expect(subject).to receive(:puts).with("\n")
-        subject.header(title: 'title')
-      end
-
-      it 'uses the defined spacing between report' do
-        expect(subject).to receive(:puts).with('title')
-        expect(subject).to receive(:puts).with("\n" * 3)
-        subject.header(title: 'title', spacing: 3)
-      end
-    end
-
-    context 'timestamp subheading' do
-      it 'is added with default alignment' do
-        expect(subject).to receive(:puts).with('title')
-        expect(subject).to receive(:puts).with(/^#{timestamp_regex}/)
-        expect(subject).to receive(:puts).with("\n")
-        subject.header(title: 'title', timestamp: true)
-      end
-
-      it 'added with right alignment' do
-        expect(subject).to receive(:puts).with(/^ *title$/)
-        expect(subject).to receive(:puts).with(/^ *#{timestamp_regex}$/)
-        expect(subject).to receive(:puts).with("\n")
-        subject.header(title: 'title', align: 'right', timestamp: true, width: 80)
-      end
-
-      it 'added with center alignment' do
-        expect(subject).to receive(:puts).with(/^ *title *$/)
-        expect(subject).to receive(:puts).with(/^ *#{timestamp_regex} *$/)
-        expect(subject).to receive(:puts).with("\n")
-        subject.header(title: 'title', align: 'center', timestamp: true, width: 80)
-      end
-    end
-
-    context 'horizontal rule' do
-      it 'uses dashes by default' do
-        expect(subject).to receive(:puts)
-        expect(subject).to receive(:puts).with(linechar * 100)
-        expect(subject).to receive(:puts)
-        subject.header(rule: true)
-      end
-
-      it 'uses = as the rule character' do
-        expect(subject).to receive(:puts)
-        expect(subject).to receive(:puts).with('=' * 100)
-        expect(subject).to receive(:puts)
-        subject.header(rule: '=')
-      end
-    end
-
-    context 'color' do
-      it 'single red line' do
-        expect(subject).to receive(:puts).with(controls[:red] + 'Report' + controls[:clear])
-        expect(subject).to receive(:puts)
-        subject.header(color: 'red')
-      end
-
-      it 'multimple red lines' do
-        expect(subject).to receive(:puts).with(controls[:red] + 'Report' + controls[:clear])
-        expect(subject).to receive(:puts).with(controls[:red] + linechar * 100 + controls[:clear])
-        expect(subject).to receive(:puts)
-        subject.header(color: 'red', rule: true)
-      end
-    end
-
-    context 'bold' do
-      it 'single line' do
-        expect(subject).to receive(:puts).with(controls[:bold] + 'Report' + controls[:clear])
-        expect(subject).to receive(:puts)
-        subject.header(bold: true)
-      end
-
-      it 'multimple lines' do
-        expect(subject).to receive(:puts).with(controls[:bold] + 'Report' + controls[:clear])
-        expect(subject).to receive(:puts).with(controls[:bold] + linechar * 100 + controls[:clear])
-        expect(subject).to receive(:puts)
-        subject.header(bold: true, rule: true)
-      end
-    end
-  end
-
-  describe '#horizontal_rule' do
-    context 'argument validation' do
-      it 'does not allow invalid options' do
-        expect do
-          subject.horizontal_rule(asdf: true)
-        end.to raise_error ArgumentError
-      end
-
-      it 'accepts char' do
-        expect do
-          expect(subject).to receive(:puts)
-          subject.horizontal_rule(char: '*')
-        end.to_not raise_error Exception
-      end
-
-      it 'accepts width' do
-        expect do
-          expect(subject).to receive(:puts)
-          subject.horizontal_rule(width: 10)
-        end.to_not raise_error Exception
-      end
-    end
-
-    context 'drawing' do
-      it 'writes a 100 yard dash by default' do
-        expect(subject).to receive(:puts).with(linechar * 100)
-        subject.horizontal_rule
-      end
-
-      it 'writes a 100 yard asterisk' do
-        expect(subject).to receive(:puts).with('*' * 100)
-        subject.horizontal_rule(char: '*')
-      end
-
-      it 'writes a 50 yard equals' do
-        expect(subject).to receive(:puts).with('=' * 50)
-        subject.horizontal_rule(char: '=', width: 50)
-      end
-    end
-
-    it 'outputs color' do
-      expect(subject).to receive(:puts).with(controls[:red] + linechar * 100 + controls[:clear])
-      subject.horizontal_rule(color: 'red')
-    end
-
-    it 'outputs bold' do
-      expect(subject).to receive(:puts).with(controls[:bold] + linechar * 100 + controls[:clear])
-      subject.horizontal_rule(bold: true)
-    end
-  end
-
-  describe '#vertical_spacing' do
-    it 'accepts a fixnum as a valid argument' do
-      expect do
-        subject.vertical_spacing('asdf')
-      end.to raise_error ArgumentError
-    end
-
-    it 'prints carriage returns for the number of lines' do
-      expect(subject).to receive(:print).with("\0").and_return(nil)
-      expect(subject).to receive(:puts).with("\n" * 3).and_return("\n\n\n")
-      subject.vertical_spacing(0)
-      subject.vertical_spacing(3)
-    end
-  end
-
-  describe '#datetime' do
-    context 'argument validation' do
-      it 'does not allow invalid options' do
-        expect do
-          subject.datetime(asdf: true)
-        end.to raise_error ArgumentError
-      end
-
-      it 'accepts align' do
-        expect do
-          expect(subject).to receive(:puts)
-          subject.datetime(align: 'left')
-        end.to_not raise_error Exception
-      end
-
-      it 'accepts width' do
-        expect do
-          expect(subject).to receive(:puts)
-          subject.datetime(width: 70)
-        end.to_not raise_error Exception
-      end
-
-      it 'accepts format' do
-        expect do
-          expect(subject).to receive(:puts)
-          subject.datetime(format: '%m/%d/%Y')
-        end.to_not raise_error Exception
-      end
-
-      it 'does not allow invalid width' do
-        expect do
-          subject.datetime(align: 'right', width: 'asdf')
-        end.to raise_error Exception
-      end
-
-      it 'does not allow invalid align' do
-        expect do
-          subject.datetime(align: 1234)
-        end.to raise_error Exception
-      end
-
-      it 'does not allow a timestamp format larger than the width' do
-        expect do
-          subject.datetime(width: 8)
-        end.to raise_error Exception
-      end
-    end
-
-    context 'display' do
-      it 'a default format - left aligned' do
-        expect(subject).to receive(:puts).with(/^#{timestamp_regex} *$/)
-        subject.datetime
-      end
-
-      it 'a default format - right aligned' do
-        expect(subject).to receive(:puts).with(/^ *#{timestamp_regex}$/)
-        subject.datetime(align: 'right')
-      end
-
-      it 'a default format - center aligned' do
-        expect(subject).to receive(:puts).with(/^ *#{timestamp_regex} *$/)
-        subject.datetime(align: 'center')
-      end
-
-      it 'a modified format' do
-        expect(subject).to receive(:puts).with(%r/^\d{2}\/\d{2}\/\d{2} *$/)
-        subject.datetime(format: '%y/%m/%d')
-      end
-    end
-
-    it 'outputs color' do
-      expect(subject).to receive(:puts).with(/^\e\[31m#{timestamp_regex}\e\[0m/)
-      subject.datetime(color: 'red')
-    end
-
-    it 'outputs bold' do
-      expect(subject).to receive(:puts).with(/^\e\[1m#{timestamp_regex}\e\[0m/)
-      subject.datetime(bold: true)
-    end
-  end
-
-  describe '#aligned' do
-    context 'argument validation' do
-      it 'accepts align' do
-        expect do
-          allow(subject).to receive(:puts)
-          subject.aligned('test', align: 'left')
-        end.to_not raise_error Exception
-      end
-
-      it 'does not allow invalid align values' do
-        expect do
-          subject.aligned('test', align: 1234)
-        end.to raise_error NoMethodError
-      end
-
-      it 'accepts width' do
-        expect do
-          allow(subject).to receive(:puts)
-          subject.aligned('test', width: 40)
-        end.to_not raise_error Exception
-      end
-
-      it 'does not allow invalid width values' do
-        expect do
-          subject.aligned('test', align: 'right', width: 'asdf')
-        end.to raise_error Exception
-      end
-    end
-
-    it 'outputs color' do
-      expect(subject).to receive(:puts).with(controls[:red] + 'x' * 10 + controls[:clear])
-      subject.aligned('x' * 10, color: 'red')
-    end
-
-    it 'outputs bold' do
-      expect(subject).to receive(:puts).with(controls[:bold] + 'x' * 10 + controls[:clear])
-      subject.aligned('x' * 10, bold: true)
-    end
-  end
-
-  describe '#footer' do
-    context 'argument validation' do
-      it 'accepts title' do
-        expect do
-          allow(subject).to receive(:puts)
-          subject.footer(title: 'test')
-        end.to_not raise_error Exception
-      end
-
-      it 'accepts align' do
-        expect do
-          allow(subject).to receive(:puts)
-          subject.footer(align: 'right')
-        end.to_not raise_error Exception
-      end
-
-      it 'does not accept invalid align' do
-        expect do
-          subject.header(align: 1234)
-        end.to raise_error NoMethodError
-      end
-
-      it 'accepts width' do
-        expect do
-          allow(subject).to receive(:puts)
-          subject.footer(width: 50)
-        end.to_not raise_error Exception
-      end
-
-      it 'does not accept invalid width' do
-        expect do
-          subject.footer(width: 'asdf')
-        end.to raise_error ArgumentError
-      end
-
-      it 'does not allow title > width' do
-        expect do
-          subject.footer(title: 'testtesttest', width: 6)
-        end.to raise_error ArgumentError
-      end
-
-      it 'accepts spacing' do
-        expect do
-          allow(subject).to receive(:puts)
-          subject.footer(spacing: 3)
-        end.to_not raise_error Exception
-      end
-    end
-
-    context 'alignment' do
-      before :each do
-        @title = 'test12test'
-      end
-
-      it 'left aligns the title by default' do
-        expect(subject).to receive(:puts).with("\n")
-        expect(subject).to receive(:puts).with(@title)
-        subject.footer(title: @title)
-      end
-
-      it 'left aligns the title' do
-        expect(subject).to receive(:puts).with("\n")
-        expect(subject).to receive(:puts).with(@title)
-        subject.footer(title: @title, align: 'left')
-      end
-
-      it 'right aligns the title' do
-        expect(subject).to receive(:puts).with("\n")
-        expect(subject).to receive(:puts).with(' ' * 90 + @title)
-        subject.footer(title: @title, align: 'right')
-      end
-
-      it 'right aligns the title using width' do
-        expect(subject).to receive(:puts).with("\n")
-        expect(subject).to receive(:puts).with(' ' * 40 + @title)
-        subject.footer(title: @title, align: 'right', width: 50)
-      end
-
-      it 'center aligns the title' do
-        expect(subject).to receive(:puts).with("\n")
-        expect(subject).to receive(:puts).with(' ' * 45 + @title)
-        subject.footer(title: @title, align: 'center')
-      end
-
-      it 'center aligns the title using width' do
-        expect(subject).to receive(:puts).with("\n")
-        expect(subject).to receive(:puts).with(' ' * 35 + @title)
-        subject.footer(title: @title, align: 'center', width: 80)
-      end
-    end
-
-    context 'spacing' do
-      it 'defaults to a single line of spacing between report' do
-        expect(subject).to receive(:puts).with("\n")
-        expect(subject).to receive(:puts).with('title')
-        subject.footer(title: 'title')
-      end
-
-      it 'uses the defined spacing between report' do
-        expect(subject).to receive(:puts).with("\n" * 3)
-        expect(subject).to receive(:puts).with('title')
-        subject.footer(title: 'title', spacing: 3)
-      end
-    end
-
-    context 'timestamp subheading' do
-      it 'is added with default alignment' do
-        expect(subject).to receive(:puts).with("\n")
-        expect(subject).to receive(:puts).with('title')
-        expect(subject).to receive(:puts).with(/^#{timestamp_regex}/)
-        subject.footer(title: 'title', timestamp: true)
-      end
-
-      it 'added with right alignment' do
-        expect(subject).to receive(:puts).with("\n")
-        expect(subject).to receive(:puts).with(/^ *title$/)
-        expect(subject).to receive(:puts).with(/^ *#{timestamp_regex}$/)
-        subject.footer(title: 'title', align: 'right', timestamp: true, width: 80)
-      end
-
-      it 'added with center alignment' do
-        expect(subject).to receive(:puts).with("\n")
-        expect(subject).to receive(:puts).with(/^ *title *$/)
-        expect(subject).to receive(:puts).with(/^ *#{timestamp_regex} *$/)
-        subject.footer(title: 'title', align: 'center', timestamp: true, width: 80)
-      end
-    end
-
-    context 'horizontal rule' do
-      it 'uses dashes by default' do
-        expect(subject).to receive(:puts)
-        expect(subject).to receive(:puts).with(linechar * 100)
-        expect(subject).to receive(:puts)
-        subject.footer(rule: true)
-      end
-
-      it 'uses = as the rule character' do
-        expect(subject).to receive(:puts)
-        expect(subject).to receive(:puts).with('=' * 100)
-        expect(subject).to receive(:puts)
-        subject.footer(rule: '=')
-      end
-    end
-
-    it 'outputs red' do
-      expect(subject).to receive(:puts).with("\n")
-      expect(subject).to receive(:puts).with(controls[:red] + 'title' + controls[:clear])
-      expect(subject).to receive(:puts).with(/^\e\[31m#{timestamp_regex}\e\[0m/)
-      subject.footer(title: 'title', timestamp: true, color: 'red')
-    end
-
-    it 'outputs bold' do
-      expect(subject).to receive(:puts).with("\n")
-      expect(subject).to receive(:puts).with(controls[:bold] + 'title' + controls[:clear])
-      expect(subject).to receive(:puts).with(/^\e\[1m#{timestamp_regex}\e\[0m/)
-      subject.footer(title: 'title', timestamp: true, bold: true)
-    end
-  end
-
-  describe '#table' do
-    it 'instantiates the table class' do
-      allow(subject).to receive(:puts)
-      expect(subject).to receive(:table).once
-      subject.table {}
-    end
-
-    it 'requires a row to be defined' do
-      expect do
-        subject.table
-      end.to raise_error LocalJumpError
-    end
-
-    it 'accepts valid options' do
-      expect do
-        subject.table(border: true) {}
-      end.to_not raise_error Exception
-    end
-
-    it 'rejects invalid options' do
-      expect do
-        allow(subject).to receive(:puts)
-        subject.table(asdf: '100') {}
-      end.to raise_error ArgumentError
-    end
-  end
-
-  describe '#row' do
-    it 'instantiates a row class' do
-      expect(subject).to receive(:row).once
-      allow(subject).to receive(:puts)
-
-      subject.table do
-        subject.row do
-        end
-      end
-    end
-  end
-
-  describe '#column' do
-    it 'instantiates multiple columns' do
-      expect(subject).to receive(:column).exactly(3).times
-      allow(subject).to receive(:puts)
-
-      subject.table do
-        subject.row do
-          subject.column('asdf')
-          subject.column('qwer')
-          subject.column('zxcv')
-        end
-      end
-    end
-
-    it 'accepts valid options' do
-      expect(subject).to receive(:column).once
-      allow(subject).to receive(:puts)
-
-      subject.table do
-        subject.row do
-          subject.column('asdf', width: 30)
-        end
-      end
-    end
-
-    it 'rejects invalid options' do
-      allow(subject).to receive(:puts)
-      expect do
-        subject.table do
-          subject.row do
-            subject.column('asdf', asdf: 30)
-          end
-        end
-      end.to raise_error ArgumentError
-    end
-  end
-end