daru 0.1.3.1 → 0.1.4

data/spec/plotting/vector_spec.rb

@@ -0,0 +1,230 @@
+require 'spec_helper.rb'
+
+describe Daru::Vector, 'plotting' do
+  let(:vector) { Daru::Vector.new([11, 22, 33], index: [:a, :b, :c]) }
+  let(:plot) { instance_double('Nyaplot::Plot') }
+  let(:diagram) { instance_double('Nyaplot::Diagram') }
+
+  before do
+    Daru.plotting_library = :nyaplot
+    allow(Nyaplot::Plot).to receive(:new).and_return(plot)
+  end
+
+  it 'plots the vector' do
+    expect(plot).to receive(:add).with(:box, [11, 22, 33]).ordered
+    expect(plot).to receive(:show).ordered
+
+    vector.plot(type: :box)
+  end
+
+  context 'scatter' do
+    it 'is default type' do
+      expect(plot).to receive(:add).with(:scatter, instance_of(Array), instance_of(Array)).ordered
+      expect(plot).to receive(:show).ordered
+
+      vector.plot
+    end
+
+    it 'sets x_axis to 0...size' do
+      expect(plot).to receive(:add).with(:scatter, [0, 1, 2], [11, 22, 33]).ordered
+      expect(plot).to receive(:show).ordered
+
+      vector.plot(type: :scatter)
+    end
+  end
+
+  [:box, :histogram].each do |type|
+    context type.to_s do
+      it 'does not set x axis' do
+        expect(plot).to receive(:add).with(type, [11, 22, 33]).ordered
+        expect(plot).to receive(:show).ordered
+
+        vector.plot(type: type)
+      end
+    end
+  end
+
+  [:bar, :line].each do |type| # FIXME: what other types 2D plot could have?..
+    context type.to_s do
+      it 'sets x axis to index' do
+        expect(plot).to receive(:add).with(type, [:a, :b, :c], [11, 22, 33]).ordered
+        expect(plot).to receive(:show).ordered
+
+        vector.plot(type: type)
+      end
+    end
+  end
+
+  context 'with block provided' do
+    it 'yields plot and diagram' do
+      expect(plot).to receive(:add).with(:box, [11, 22, 33]).ordered.and_return(diagram)
+      expect(plot).to receive(:show).ordered
+
+      expect { |b| vector.plot(type: :box, &b) }.to yield_with_args(plot, diagram)
+    end
+  end
+end
+
+describe Daru::Vector, 'plotting category' do
+  let(:plot) { instance_double('Nyaplot::Plot') }
+  let(:diagram) { instance_double('Nyaplot::Diagram') }
+  let(:dv) do
+    Daru::Vector.new ['III']*10 + ['II']*5 + ['I']*5,
+      type: :category,
+      categories: ['I', 'II', 'III']
+  end  
+  before do
+    Daru.plotting_library = :nyaplot
+    allow(Nyaplot::Plot).to receive(:new).and_return(plot)
+  end
+  context 'bar' do
+    it 'plots bar graph taking a block' do
+      expect(plot).to receive(:add).with(:bar, ['I', 'II', 'III'], [5, 5, 10])
+      expect(plot).to receive :x_label
+      expect(plot).to receive :y_label
+      expect(plot).to receive(:show)
+      dv.plot(type: :bar) do |p|
+        p.x_label 'Categories'
+        p.y_label 'Frequency'
+      end
+    end
+
+    it 'plots bar graph without taking a block' do
+      expect(plot).to receive(:add).with(:bar, ["I", "II", "III"], [5, 5, 10])
+      expect(plot).to receive(:show)
+      dv.plot(type: :bar)
+    end
+
+    it 'plots bar graph with percentage' do
+      expect(plot).to receive(:add).with(:bar, ["I", "II", "III"], [25, 25, 50])
+      expect(plot).to receive(:yrange).with [0, 100]
+      expect(plot).to receive(:show)
+      dv.plot(type: :bar, method: :percentage)
+    end
+
+    it 'plots bar graph with fraction' do
+      expect(plot).to receive(:add).with(:bar, ["I", "II", "III"], [0.25, 0.25, 0.50])
+      expect(plot).to receive(:yrange).with [0, 1]
+      expect(plot).to receive(:show)
+      dv.plot(type: :bar, method: :fraction)
+    end    
+  end
+
+  context 'other type' do
+    it { expect { dv.plot(type: :scatter) }.to raise_error ArgumentError }
+  end
+end
+
+describe Daru::Vector, 'plotting vector with gruff' do
+  let(:dv) { Daru::Vector.new [1, 2, 3] }
+  before { Daru.plotting_library = :gruff }
+
+  context 'line' do
+    let(:plot) { instance_double 'Gruff::Line' }
+    before { allow(Gruff::Line).to receive(:new).and_return(plot) }
+    
+    it 'plots line graph without block' do
+      expect(plot).to receive(:labels=)
+      expect(plot).to receive(:data)
+      dv.plot type: :line
+    end
+    
+    it 'plots line graph with block' do
+      expect(plot).to receive :labels=
+      expect(plot).to receive :data
+      expect(plot).to receive :title=
+      dv.plot(type: :line) { |p| p.title = 'hello' }
+    end
+  end
+  
+  context 'bar' do
+    let(:plot) { instance_double 'Gruff::Bar' }
+    before { allow(Gruff::Bar).to receive(:new).and_return(plot) }
+    
+    it 'plots bar graph' do
+      expect(plot).to receive :labels=
+      expect(plot).to receive :data
+      dv.plot type: :bar
+    end
+  end
+  
+  context 'pie' do
+    let(:plot) { instance_double 'Gruff::Pie' }
+    before { allow(Gruff::Pie).to receive(:new).and_return(plot) }
+    
+    it 'plots pie graph' do
+      expect(plot).to receive(:data).exactly(3).times
+      dv.plot type: :pie
+    end
+  end
+  
+  context 'scatter' do
+    let(:plot) { instance_double 'Gruff::Scatter' }
+    before { allow(Gruff::Scatter).to receive(:new).and_return(plot) }
+
+    it 'plots scatter graph' do
+      expect(plot).to receive :data
+      dv.plot type: :scatter
+    end
+  end
+  
+  context 'sidebar' do
+    let(:plot) { instance_double 'Gruff::SideBar' }
+    before { allow(Gruff::SideBar).to receive(:new).and_return(plot) }
+
+    it 'plots sidebar' do
+      expect(plot).to receive :labels=
+      expect(plot).to receive(:data).exactly(3).times
+      dv.plot type: :sidebar
+    end
+  end
+  
+  context 'invalid type' do
+    it { expect { dv.plot type: :lol }.to raise_error ArgumentError }
+  end
+end
+
+describe Daru::Vector, 'plotting category vector with gruff' do
+  before { Daru.plotting_library = :gruff }
+  let(:dv) { Daru::Vector.new [1, 2, 3], type: :category }
+
+  context 'bar' do
+    let(:plot) { instance_double 'Gruff::Bar' }
+    before { allow(Gruff::Bar).to receive(:new).and_return(plot) }
+    it 'plots bar graph' do
+      expect(plot).to receive :labels=
+      expect(plot).to receive :data
+      dv.plot type: :bar
+    end
+    
+    it 'plots bar graph with block' do
+      expect(plot).to receive :labels=
+      expect(plot).to receive :data
+      expect(plot).to receive :title=
+      dv.plot(type: :bar) { |p| p.title = 'hello' }
+    end
+  end
+  
+  context 'pie' do
+    let(:plot) { instance_double 'Gruff::Pie' }
+    before { allow(Gruff::Pie).to receive(:new).and_return(plot) }
+    it 'plots pie graph' do
+      expect(plot).to receive(:data).exactly(3).times
+      dv.plot type: :pie
+    end
+  end
+  
+  context 'sidebar' do
+    let(:plot) { instance_double 'Gruff::SideBar' }
+    before { allow(Gruff::SideBar).to receive(:new).and_return(plot) }
+    it 'plots sidebar graph' do
+      expect(plot).to receive :labels=
+      expect(plot).to receive(:data).exactly(3).times
+      dv.plot type: :sidebar
+    end
+  end
+
+  context 'invalid type' do
+    it { expect { dv.plot type: :lol }.to raise_error ArgumentError }
+  end
+end

data/spec/shared/vector_display_spec.rb

@@ -0,0 +1,215 @@
+describe Daru::Vector do
+  # TODO: Add inspect specs for category
+  context '#inspect' do
+    context 'simple' do
+      subject(:vector) { Daru::Vector.new [1,2,3],
+        index: [:a, :b, :c], name: 'test'}
+      its(:inspect) { is_expected.to eq %Q{
+        |#<Daru::Vector(3)>
+        |      test
+        |    a    1
+        |    b    2
+        |    c    3
+      }.unindent }
+    end
+
+    context 'no name' do
+      subject(:vector) { Daru::Vector.new [1,2,3], index: [:a, :b, :c]}
+      its(:inspect) { is_expected.to eq %Q{
+        |#<Daru::Vector(3)>
+        |   a   1
+        |   b   2
+        |   c   3
+      }.unindent }
+    end
+
+    context 'with nils' do
+      subject(:vector) { Daru::Vector.new [1,nil,3],
+        index: [:a, :b, :c], name: 'test'}
+      its(:inspect) { is_expected.to eq %Q{
+        |#<Daru::Vector(3)>
+        |      test
+        |    a    1
+        |    b  nil
+        |    c    3
+      }.unindent }
+    end
+
+    context 'very large amount of data' do
+      subject(:vector) { Daru::Vector.new [1,2,3] * 100, name: 'test'}
+      its(:inspect) { is_expected.to eq %Q{
+        |#<Daru::Vector(300)>
+        |      test
+        |    0    1
+        |    1    2
+        |    2    3
+        |    3    1
+        |    4    2
+        |    5    3
+        |    6    1
+        |    7    2
+        |    8    3
+        |    9    1
+        |   10    2
+        |   11    3
+        |   12    1
+        |   13    2
+        |   14    3
+        |  ...  ...
+      }.unindent }
+    end
+
+    context 'really long name or data' do
+      subject(:vector) { Daru::Vector.new [1,2,'this is ridiculously long'],
+        index: [:a, :b, :c], name: 'and this is not much better faithfully'}
+      its(:inspect) { is_expected.to eq %Q{
+        |#<Daru::Vector(3)>
+        |                      and this is not much
+        |                    a                    1
+        |                    b                    2
+        |                    c this is ridiculously
+      }.unindent }
+    end
+
+    context 'with multiindex' do
+      subject(:vector) {
+        Daru::Vector.new(
+          [1,2,3,4,5,6,7],
+          name: 'test',
+          index: Daru::MultiIndex.from_tuples([
+              %w[foo one],
+              %w[foo two],
+              %w[foo three],
+              %w[bar one],
+              %w[bar two],
+              %w[bar three],
+              %w[baz one],
+           ]),
+        )
+      }
+
+      its(:inspect) { is_expected.to eq %Q{
+        |#<Daru::Vector(7)>
+        |              test
+        |   foo   one     1
+        |         two     2
+        |       three     3
+        |   bar   one     4
+        |         two     5
+        |       three     6
+        |   baz   one     7
+      }.unindent}
+    end
+
+    context 'threshold and spacing settings' do
+    end
+  end
+
+  [nil, :category].each do |type|
+    context '#to_html' do
+      let(:doc) { Nokogiri::HTML(vector.to_html) }
+      subject(:table) { doc.at('table') }
+      let(:header) { table.at('tr:first-child > th:first-child') }
+
+      context 'simple' do
+        let(:vector) { Daru::Vector.new [1,nil,3],
+          index: [:a, :b, :c], name: 'test', type: type }
+        it { is_expected.not_to be_nil }
+
+        describe 'header' do
+          subject { header }
+          it { is_expected.not_to be_nil }
+          its(['colspan']) { is_expected.to eq '2' }
+          its(:text) { is_expected.to eq "Daru::Vector(3)"\
+            "#{":category" if type == :category}" }
+        end
+
+        describe 'name' do
+          subject(:name) { table.at('tr:nth-child(2) > th:nth-child(2)') }
+          it { is_expected.not_to be_nil }
+          its(:text) { is_expected.to eq 'test' }
+
+          context 'withought name' do
+            let(:vector) { Daru::Vector.new [1,nil,3], index: [:a, :b, :c], type: type }
+
+            it { is_expected.to be_nil }
+          end
+        end
+
+        describe 'index' do
+          subject(:indexes) { table.search('tr > td:first-child').map(&:text) }
+          its(:count) { is_expected.to eq vector.size }
+          it { is_expected.to eq vector.index.to_a.map(&:to_s) }
+        end
+
+        describe 'values' do
+          subject(:indexes) { table.search('tr > td:last-child').map(&:text) }
+          its(:count) { is_expected.to eq vector.size }
+          it { is_expected.to eq vector.to_a.map(&:to_s) }
+        end
+      end
+
+      context 'large vector' do
+        subject(:vector) { Daru::Vector.new [1,2,3] * 100, name: 'test', type: type }
+        it 'has only 30 rows (+ 2 header rows, + 2 finishing rows)' do
+          expect(table.search('tr').size).to eq 34
+        end
+
+        describe '"skipped" row' do
+          subject(:row) { table.search('tr:nth-child(33) td').map(&:text) }
+          its(:count) { is_expected.to eq 2 }
+          it { is_expected.to eq ['...', '...'] }
+        end
+
+        describe 'last row' do
+          subject(:row) { table.search('tr:nth-child(34) td').map(&:text) }
+          its(:count) { is_expected.to eq 2 }
+          it { is_expected.to eq ['299', '3'] }
+        end
+      end
+
+      context 'multi-index' do
+        subject(:vector) {
+          Daru::Vector.new(
+            [1,2,3,4,5,6,7],
+            name: 'test',
+            type: type,
+            index: Daru::MultiIndex.from_tuples([
+                %w[foo one],
+                %w[foo two],
+                %w[foo three],
+                %w[bar one],
+                %w[bar two],
+                %w[bar three],
+                %w[baz one],
+             ]),
+          )
+        }
+
+        describe 'header' do
+          subject { header }
+          it { is_expected.not_to be_nil }
+          its(['colspan']) { is_expected.to eq '3' }
+          its(:text) { is_expected.to eq "Daru::Vector(7)"\
+            "#{":category" if type == :category}" }
+        end
+
+        describe 'name row' do
+          subject(:row) { table.at('tr:nth-child(2)').search('th') }
+          its(:count) { should == 2 }
+          it { expect(row.first['colspan']).to eq '2' }
+        end
+
+        describe 'first data row' do
+          let(:row) { table.at('tr:nth-child(3)') }
+          subject { row.inner_html.scan(/<t[dh].+?<\/t[dh]>/) }
+          it { is_expected.to eq [
+            '<th rowspan="3">foo</th>',
+            '<th rowspan="1">one</th>',
+            '<td>1</td>'
+          ]}
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,12 @@
 require 'rspec'
+require 'rspec/its'
 require 'matrix'
 require 'awesome_print'
 require 'distribution'
 require 'tempfile'
 require 'pry-byebug'
+require 'nokogiri'
+require 'gruff'
 
 def mri?
   RUBY_ENGINE == 'ruby'
@@ -21,6 +24,11 @@ end
 
 RSpec::Expectations.configuration.warn_about_potential_false_positives = false
 
+require 'simplecov'
+SimpleCov.start do
+ add_filter 'spec'
+ minimum_coverage_by_file 95
+end
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -42,4 +50,19 @@ def expect_correct_df_in_delta df1, df2, delta
   end
 end
 
+class String
+  # allows to pretty test agains multiline strings:
+  #   %Q{
+  #     |test
+  #     |me
+  #   }.unindent # =>
+  # "test
+  # me"
+  def unindent
+    gsub(/\n\s+?\|/, "\n")    # for all lines looking like "<spaces>|" -- remove this.
+    .gsub(/\|\n/, "\n")       # allow to write trailing space not removed by editor
+    .gsub(/^\n|\n\s+$/, '')   # remove empty strings before and after
+  end
+end
+
 Dir[File.expand_path('../support/**/*.rb', __FILE__)].each {|f| require f }