excel_templating 0.3.2

data/spec/cell_validation_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+describe 'cell validation' do
+  context "rendered to the data sheet" do
+    class SimpleCellValidatedDocument < ExcelTemplating::Document
+      template "spec/assets/valid_cell.mustache.xlsx"
+      title "Valid cell test"
+      organization "Unimportant"
+      default_styling(
+        text_wrap: 0,
+        font: "Calibri",
+        size: 10,
+        align: :left,
+      )
+      list_source :valid_foos, title: "Foos", list: ["foo", "bar"]
+      sheet 1 do
+        validate_cell row: 2, column: 1, with: :valid_foos
+      end
+    end
+
+    subject { SimpleCellValidatedDocument.new(data) }
+
+    let(:data) {
+      {
+        all_sheets:
+          {
+            valid_value: "foo",
+          }
+      }
+    }
+
+    describe "#render" do
+      it do
+        expect do
+          subject.render do |path|
+            expect(path).to match_excel_content('spec/assets/valid_cell_expected.xlsx')
+          end
+        end.not_to raise_error
+      end
+    end
+  end
+
+  context "list taken from the data" do
+    class SimpleFromDataValidatedDocument < ExcelTemplating::Document
+      template "spec/assets/valid_cell.mustache.xlsx"
+      title "Valid cell test"
+      organization "Unimportant"
+      default_styling(
+        text_wrap: 0,
+        font: "Calibri",
+        size: 10,
+        align: :left,
+      )
+      list_source :valid_foos, title: "Foos"
+      sheet 1 do
+        validate_cell row: 2, column: 1, with: :valid_foos
+      end
+    end
+
+    subject { SimpleFromDataValidatedDocument.new(data) }
+
+    let(:data) {
+      {
+        all_sheets:
+          {
+            valid_foos: ["foo","bar"],
+            valid_value: "foo",
+          }
+      }
+    }
+
+    describe "#render" do
+      it do
+        expect do
+          subject.render do |path|
+            expect(path).to match_excel_content('spec/assets/valid_cell_expected.xlsx')
+          end
+        end.not_to raise_error
+      end
+    end
+  end
+
+  context "rendered inline" do
+    class InlineCellValidatedDocument < ExcelTemplating::Document
+      template "spec/assets/valid_cell.mustache.xlsx"
+      title "Valid cell test"
+      list_source :valid_foos, title: "Foos", list: ["foo", "bar"], inline: true
+      sheet 1 do
+        validate_cell row: 2, column: 1, with: :valid_foos
+      end
+    end
+
+    subject { InlineCellValidatedDocument.new(data) }
+
+    let(:data) {
+      {
+        all_sheets:
+          {
+            valid_value: "foo",
+          }
+      }
+    }
+
+    describe "#render" do
+      it do
+        expect do
+          subject.render do |path|
+            expect(path).to match_excel_content('spec/assets/valid_cell_expected_inline.xlsx')
+          end
+        end.not_to raise_error
+      end
+    end
+  end
+end

data/spec/column_validation_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe 'column validation' do
+  context "rendered to the data sheet" do
+    class SimpleColumnValidatedDocument < ExcelTemplating::Document
+      template "spec/assets/valid_cell.mustache.xlsx"
+      title "Valid cell test"
+      organization "Unimportant"
+      default_styling(
+        text_wrap: 0,
+        font: "Calibri",
+        size: 10,
+        align: :left,
+      )
+      list_source :valid_foos, title: "Foos", list: ["foo", "bar"]
+      sheet 1 do
+        repeat_row 2, with: :foo_data do
+          validate_column 1, with: :valid_foos
+        end
+      end
+    end
+
+    subject { SimpleColumnValidatedDocument.new(data) }
+
+    let(:data) {
+      {
+        all_sheets: {},
+        1 => {
+          foo_data: [
+            { valid_value: 'foo'},
+            { valid_value: 'bar'}
+          ]
+        }
+      }
+    }
+
+    describe "#render" do
+      it do
+        expect do
+          subject.render do |path|
+            expect(path).to match_excel_content('spec/assets/valid_column_expected.xlsx')
+          end
+        end.not_to raise_error
+      end
+    end
+  end
+end

data/spec/excel_abstraction/active_cell_reference_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe ExcelAbstraction::ActiveCellReference do
+  subject { described_class.new(row: 2, col: 3) }
+
+  describe "#up" do
+    it "moves to the cell above" do
+      expect(subject.up).to eq(ExcelAbstraction::CellReference.new(row: 1, col: 3))
+    end
+  end
+
+  describe "#down" do
+    it "moves to the cell above" do
+      expect(subject.down).to eq(ExcelAbstraction::CellReference.new(row: 3, col: 3))
+    end
+  end
+
+  describe "#left" do
+    it "moves to the cell above" do
+      expect(subject.left).to eq(ExcelAbstraction::CellReference.new(row: 2, col: 2))
+    end
+  end
+
+  describe "#right" do
+    it "moves to the cell above" do
+      expect(subject.right).to eq(ExcelAbstraction::CellReference.new(row: 2, col: 4))
+    end
+  end
+
+  describe "#move" do
+    context "when the movement commands are supported" do
+      it "moves to the cell position specified" do
+        expect(subject.move(right: 2)).to eq(ExcelAbstraction::CellReference.new(row: 2, col: 5))
+      end
+    end
+
+    context "when the movement commands are not supported" do
+      it "moves to the cell above" do
+        expect { subject.move(diagonal: 2) }.to raise_exception(ArgumentError)
+      end
+    end
+  end
+
+  describe "#carriage_return" do
+    it "moves to the cell at the beginning of the row" do
+      expect(subject.carriage_return).to eq(ExcelAbstraction::CellReference.new(row: 2, col: 0))
+    end
+  end
+
+  describe "#linefeed" do
+    it "moves to the cell in the next row" do
+      expect(subject.linefeed).to eq(ExcelAbstraction::CellReference.new(row: 3, col: 3))
+    end
+  end
+
+  describe "#newline" do
+    it "moves to the cell above" do
+      expect(subject.newline).to eq(ExcelAbstraction::CellReference.new(row: 3, col: 0))
+    end
+  end
+
+  describe "#goto" do
+    it "moves to the cell above" do
+      expect(subject.goto(5, 5)).to eq(ExcelAbstraction::CellReference.new(row: 5, col: 5))
+    end
+  end
+
+  describe "#reset" do
+    it "moves to the cell above" do
+      expect(subject.reset).to eq(ExcelAbstraction::CellReference.new(row: 0, col: 0))
+    end
+  end
+end

data/spec/excel_abstraction/cell_range_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe ExcelAbstraction::CellRange do
+  subject { described_class.new }
+
+  describe "enumeration" do
+    before :each do
+      subject << {row: 1, col: 0}
+      subject << {row: 1, col: 1}
+      subject << {row: 1, col: 2}
+    end
+
+    it "enumerates over the cell references in the range" do
+      expect(subject.inject(0) { |sum, cell| sum + (cell.row * cell.col) }).to eq 3
+    end
+  end
+
+  describe "#<<" do
+    before :each do
+      subject << {row: 1, col: 0}
+    end
+
+    context "when the cell to be inserted is not in the same row" do
+      it "raises an exception" do
+        expect { subject << {row: 2, col: 1} }.to raise_exception(ArgumentError)
+      end
+    end
+
+    context "when the cell to be inserted is in the same row" do
+      it "inserts the cell" do
+        subject << {row: 1, col: 1}
+        expect(subject.last).to eq(ExcelAbstraction::CellReference.new(row: 1, col: 1))
+      end
+    end
+  end
+end

data/spec/excel_abstraction/cell_reference_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe ExcelAbstraction::CellReference do
+  subject { described_class.new(row: 1, col: 1) }
+
+  describe "#<=>" do
+    context "when the row of the other cell reference is same" do
+      context "when the other cell reference is before" do
+        let(:other){ described_class.new(row: 1, col: 0) }
+
+        it "returns 1" do
+          expect(subject <=> other).to eq 1
+        end
+      end
+
+      context "when the other cell reference is same" do
+        let(:other){ described_class.new(row: 1, col: 1) }
+
+        it "returns 0" do
+          expect(subject <=> other).to eq 0
+        end
+      end
+
+      context "when the other cell reference is after" do
+        let(:other){ described_class.new(row: 1, col: 2) }
+
+        it "returns -1" do
+          expect(subject <=> other).to eq -1
+        end
+      end
+    end
+
+    context "when the row of the other cell reference is before" do
+      let(:other){ described_class.new(row: 0, col: 0) }
+
+      it "returns 1" do
+        expect(subject <=> other).to eq 1
+      end
+    end
+
+    context "when the row of the other cell reference is after" do
+      let(:other){ described_class.new(row: 2, col: 0) }
+
+      it "returns -1" do
+        expect(subject <=> other).to eq -1
+      end
+    end
+  end
+
+  describe "#succ" do
+    its(:succ){ is_expected.to eq described_class.new(row: 1, col: 2) }
+  end
+
+  describe "#to_s" do
+    its(:to_s){ is_expected.to eq "B2"}
+  end
+
+  describe "#to_cell_reference" do
+    its(:to_cell_reference){ is_expected.to eq subject }
+  end
+
+  describe "#to_ary" do
+    its(:to_ary){ is_expected.to eq [1, 1] }
+  end
+
+  describe "#to_a" do
+    its(:to_a){ is_expected.to eq [1, 1] }
+  end
+end

data/spec/excel_abstraction/cell_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe ExcelAbstraction::Cell do
+  subject { described_class.new(position: 1, val: "CellValue", style: {bold: true}) }
+
+  describe "#<=>" do
+    context "when the other position is before" do
+      let(:other){ described_class.new(position: 0, val: nil) }
+
+      it "return 1" do
+        expect(subject <=> other).to eq 1
+      end
+    end
+
+    context "when the other position is same" do
+      let(:other){ described_class.new(position: 1, val: nil) }
+
+      it "return 0" do
+        expect(subject <=> other).to eq 0
+      end
+    end
+
+    context "when the other position is after" do
+      let(:other){ described_class.new(position: 2, val: nil) }
+
+      it "return -1" do
+        expect(subject <=> other).to eq -1
+      end
+    end
+  end
+
+  describe "#==" do
+    context "when the cells are equal" do
+      let(:other){ described_class.new(position: 1, val: "CellValue", style: {bold: true}) }
+
+      it "returns true" do
+        expect(subject == other).to be_truthy
+      end
+    end
+
+    context "when the cells are not equal" do
+      let(:other){ described_class.new(position: 1, val: "OtherCellValue", style: {bold: true}) }
+
+      it "returns false" do
+        expect(subject == other).to be_falsey
+      end
+    end
+  end
+
+  describe "#to_cell" do
+    its(:to_cell){ is_expected.to eq subject }
+  end
+
+end

data/spec/excel_abstraction/date_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe ExcelAbstraction::Date do
+  context "when date is before REFERENCE date" do
+    subject { described_class.new(Date.parse("1900-01-01")) }
+
+    it "returns 1.0" do
+      expect(subject).to eq 1.0
+    end
+  end
+
+  context "when date is after REFERENCE date" do
+    subject { described_class.new(Date.parse("2000-01-19")) }
+
+    it "should return 36544.50 for Jan 19, 2000 12:00" do
+      expect(subject).to eq 36544.0
+    end
+  end
+
+  describe "#to_excel_date" do
+    subject { described_class.new(Date.parse("2012-01-23")) }
+
+    it "returns the same object" do
+      expect(subject.to_excel_date).to eq(subject)
+    end
+  end
+end

data/spec/excel_abstraction/row_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe ExcelAbstraction::Row do
+  subject { described_class.new }
+
+  describe "enumeration" do
+    before :each do
+      subject << {position: 0, val: "foo"}
+      subject << {position: 1, val: "bar"}
+      subject << {position: 2, val: "baz"}
+    end
+
+    it "enumerates over the cell references in the range" do
+      expect(subject.reduce(""){ |str, cell| str += cell.val }).to eq "foobarbaz"
+    end
+  end
+
+  describe "#[]" do
+    before :each do
+      subject << {position: 0, val: "foo"}
+      subject << {position: 1, val: "bar"}
+      subject << {position: 2, val: "baz"}
+    end
+
+    it "returns the cell with the given position" do
+      expect(subject[1].val).to eq("bar")
+    end
+  end
+
+  describe "#<<" do
+    before :each do
+      subject << {position: 0, val: "foo"}
+    end
+
+    context "when the cell to be inserted is in the same row" do
+      it "inserts the cell" do
+        subject << {position: 1, val: "bar"}
+        expect(subject.count).to eq 2
+      end
+    end
+  end
+end

data/spec/excel_abstraction/sheet_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe ExcelAbstraction::Sheet do
+  let(:spreadsheet) { ExcelAbstraction::SpreadSheet.new }
+
+  subject { spreadsheet.workbook.active_sheet }
+
+  describe "#header" do
+    it "sets the header" do
+      test_excel_file do |file|
+        excel = create_excel(file, spreadsheet) do
+          subject.header("Foo")
+        end
+
+        expect(excel.cell("A", 1)).to eq "Foo"
+        expect(excel.font("A", 1)).to be_bold
+      end
+    end
+  end
+
+  describe "#headers" do
+    it "sets the headers" do
+      test_excel_file do |file|
+        excel = create_excel(file, spreadsheet) do
+          subject.header(["Foo", "Bar"])
+        end
+
+        expect(excel.cell("A", 1)).to eq "Foo"
+        expect(excel.font("A", 1)).to be_bold
+        expect(excel.cell("B", 1)).to eq "Bar"
+        expect(excel.font("B", 1)).to be_bold
+      end
+    end
+  end
+
+  describe "#cell" do
+    it "sets the cell value" do
+      test_excel_file do |file|
+        excel = create_excel(file, spreadsheet) do
+          subject.cell("Foo")
+        end
+
+        expect(excel.cell("A", 1)).to eq "Foo"
+      end
+    end
+  end
+
+  describe "#cells" do
+    it "sets the cell values" do
+      test_excel_file do |file|
+        excel = create_excel(file, spreadsheet) do
+          subject.cells(["Foo", "Bar"])
+        end
+
+        expect(excel.cell("A", 1)).to eq "Foo"
+        expect(excel.cell("B", 1)).to eq "Bar"
+      end
+    end
+  end
+
+  describe "#merge" do
+    it "merges the cells" do
+      test_excel_file do |file|
+        excel = create_excel(file, spreadsheet) do
+          subject.merge(1, "Foo")
+          subject.cell("Bar")
+        end
+
+        expect(excel.cell("A", 1)).to eq "Foo"
+        expect(excel.cell("B", 1)).to be_nil
+        expect(excel.cell("C", 1)).to eq "Bar"
+      end
+    end
+  end
+
+  describe "#style_row" do
+    # hard to test; already tested manually
+  end
+
+  describe "#style_col" do
+    # hard to test; already tested manually
+  end
+end

data/spec/excel_abstraction/spread_sheet_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'roo'
+
+describe ExcelAbstraction::SpreadSheet do
+  describe "#close" do
+    it "closes the excel file" do
+      subject.close
+      expect(subject).to be_closed
+    end
+
+    context "when a block is passed" do
+      it "executes the block before closing the excel file" do
+        test = 0
+        subject.close { test += 1 }
+        expect(test).to eq(1)
+        expect(subject).to be_closed
+      end
+    end
+  end
+
+  describe "#to_s" do
+    it "closes the file and returns it's data" do
+      file = Tempfile.new('xls')
+      file.write subject.to_s
+      file.close
+
+      expect {
+        Roo::Excel.new(file.path, packed: nil, file_warning: :ignore)
+      }.to_not raise_exception
+
+      File.unlink(file.path)
+      expect(subject).to be_closed
+    end
+  end
+end

data/spec/excel_abstraction/time_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe ExcelAbstraction::Time do
+  context "when date is before REFERENCE date" do
+    subject { described_class.new(Time.parse("1900-01-01 00:00 +00:00")) }
+
+    it "returns 1.0" do
+      expect(subject).to eq 1.0
+    end
+  end
+
+  context "when date is after REFERENCE date" do
+    subject { described_class.new(Time.parse("2000-01-19 12:00 +00:00")) }
+
+    it "should return 36544.50 for Jan 19, 2000 12:00" do
+      expect(subject).to eq 36544.5
+    end
+  end
+
+  describe "#to_excel_time" do
+    subject { described_class.new(Time.parse("2012-01-23 14:00")) }
+
+    it "returns the same object" do
+      expect(subject.to_excel_time).to eq(subject)
+    end
+  end
+end

data/spec/excel_abstraction/work_book_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'roo'
+
+describe ExcelAbstraction::WorkBook do
+  let(:spreadsheet) { ExcelAbstraction::SpreadSheet.new }
+
+  subject { spreadsheet.workbook }
+
+  describe "#title" do
+    it "sets the title property" do
+      expect(subject).to receive(:set_properties).with(title: 'Foo')
+      subject.title('Foo')
+    end
+  end
+
+  describe "#organization" do
+    it "sets the company property" do
+      expect(subject).to receive(:set_properties).with(company: 'Foo')
+      subject.organization('Foo')
+    end
+  end
+end

data/spec/excel_helper.rb

@@ -0,0 +1,16 @@
+require 'tempfile'
+
+module ExcelHelper
+  def create_excel(file, spreadsheet)
+    yield if block_given?
+    file.puts spreadsheet.to_s
+    file.close
+    Roo::Excel.new(file.path, packed: nil, file_warning: :ignore)
+  end
+
+  def test_excel_file
+    file = Tempfile.new('test_xls')
+    yield(file) if block_given?
+    file.unlink
+  end
+end