excel_walker 0.1.1 → 0.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDgzODY3NzdiOTA0NzdhMzgwMzY5YmM4NDcyNjUwODY3Zjg1ODNjMg==
+    M2Y0NTYwMjQyYTEwMzhjYjU5NGMxNTQzNTY1ZWY0ZjgzMmRhMDZlZg==
   data.tar.gz: !binary |-
-    Njg3MWMyNTVkNDM0OWRjMmUwM2I0MDZkNTRkNjJiN2U4Y2NiOTg5ZQ==
+    ODdiOWFhNmY0OGM4MjY0Y2IyZmE4YzRjYTQ0MjQ5OTcyMTMzYzBhOA==
 SHA512:
   metadata.gz: !binary |-
-    MjIzM2IyZDRhYWIzYjUwMmFlNTUxMjU3YjNhMjgxMGQyMjFmOWNkZjFkNTNh
-    OGU1ODEyMWM3MjIyNzM3NjkxZGNjZDMzNWY1Njg4NGQzM2FmN2NjNmRmNjBl
-    YzNhNmY4MmE2ZDJhNWE2ZjY2ZTgxZGZiNzA1M2IwNzBiMmM3YTA=
+    YjFiYjM3ZmQwYmE0MzA3YmM4YWMzZDIwOTNmYjFlYzRmZDUzNDRlYTQ3YTMx
+    YzU2M2U1ZjgyYmNjMjhjOWM1NzUwMjBiZGJlMTFkNDgyOWIxMGRjMTZhZTEy
+    YTgwOWRlNjkzY2FkNjM3MTc5ZmQ4NTQ2MWZiNWYzY2Y0OTZjNGQ=
   data.tar.gz: !binary |-
-    YmY4MzAzZTJiN2EzOTQ2YzQ5MWIzNGVjNTZlNjM5ZTg0YThlZjExYWE3NDEx
-    YjVjNTE2ZTE0ZmJjYjdmZTc0OTc1NWM0OTIwZWU5ZjZhNGIyYjk3Mzk5OTNl
-    YzhkYjg0NTVjZTFmMmYxOWJkOWUxMzVlOGY3ZDZhZDMxNjY3Y2E=
+    ZWY3YzU0Y2E3ZTg1NGZlNjVjZTQyZThhYjJlMWI5ZGJjY2NlMjZmZDVkNmRl
+    NjdhNDQwN2JiYzBkNzRkNDYyZWI4NDVlNDhlMzk4NTEzNzI3ZjNmM2EwMmVh
+    NGJlNWMzZTQyZTcyODc1YjA3OGQ4YWYwYmQwZGM1OWY2ZDRmNjU=

data/.travis.yml

@@ -2,11 +2,6 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-
-env:
-  - "RAILS_VERSION=4.0"
-  - "RAILS_VERSION=3.2"
-  - "RAILS_VERSION=3.1"
-  - "RAILS_VERSION=3.0"
+  - 2.1.0
 
 script: bundle exec rspec

data/README.md

@@ -1,14 +1,14 @@
-# ExcelWalker
+# ExcelWalker [![Gem Version](https://badge.fury.io/rb/excel_walker.png)](http://badge.fury.io/rb/excel_walker) [![Build Status](https://secure.travis-ci.org/shadabahmed/excel_walker.png)](https://secure.travis-ci.org/shadabahmed/excel_walker)
 
 Excel Walker is a declarative Microsoft Excel file parser and generator. It uses [Axlsx](https://github.com/randym/axlsx) to write and [Creek](https://github.com/pythonicrubyist/creek) to read.
 
 # Why I created this ?
 
-While dealing with Excel files recently, I noticed that excel files are never a set of homogenous data, which you can iterate over directly. Rather there are regions of interest whether in the same worksheet or across worksheets, which have different types of data you are interested in. For e.g. look at the spreadsheet below:
+While dealing with Excel files recently, I noticed that excel files are never a set of homogenous data, which you can iterate over directly. Rather there are regions of interest whether in the same worksheet or across worksheets, which you want to work upon differently. For e.g. look at the spreadsheet below:
 
 ![currency_excel](https://cloud.githubusercontent.com/assets/830679/2937625/d333658e-d8bf-11e3-9619-658e20c425a0.png)
 
-We are not interested in the top header, we just want the country, currency and USD exchange rate so that we can store that in our database in currencies table. The regions are marked in RED. If you were to go interatively over each row, then lot of custom logic would have to fit in.
+We are not interested in the top header, we just want the country, currency and USD exchange rate so that we can store that in our database in currencies table. The regions are marked in RED. If you were to go iteratively over each row, then lot of custom logic would have to fit in.
 
 What if you could just declare this - Start from row 3 and just give me 1st, 2nd and 4th column. Let's see this in code:
 

data/lib/excel_walker/reader/hook.rb

@@ -4,28 +4,32 @@ module ExcelWalker
     class Hook
       def initialize(condition)
         @matcher = case true
-                     when condition.respond_to?(:call)
+                     when condition.is_a?(Proc)
                        condition
                      when condition.is_a?(Array), condition.is_a?(Range)
                        proc { |row_num| condition.include?(row_num) }
                      when condition.is_a?(Fixnum)
                        proc { |row_num| condition === row_num }
+                     else
+                       raise ArgumentError.new('Can only take Array, Number, Range or a Block')
                    end
       end
 
-      def columns(cols_condition = nil, &block)
-        cols_condition = block if block_given?
+      def columns(cols_matcher = nil, &block)
+        cols_matcher = block if block_given?
         @cols_extractor =
-            case cols_condition.class.name
-              when 'Array'
-                cols_set = Set.new(cols_condition)
-                proc { |row| row.values.select.with_index { |_, idx| cols_set.include?(idx + 1) } }
-              when 'Fixnum'
-                proc { |row| row.values[cols_condition - 1] }
-              when 'Range'
-                proc { |row| row.values[(cols_condition.min - 1)..(cols_condition.max - 1)] }
-              when 'Proc'
-                proc { |row| cols_condition[row.values] }
+            case true
+              when cols_matcher.is_a?(Array)
+                cols_set = Set.new(cols_matcher)
+                proc { |row| row.select.with_index { |_, idx| cols_set.include?(idx + 1) } }
+              when cols_matcher.is_a?(Fixnum)
+                proc { |row| row[cols_matcher - 1] }
+              when cols_matcher.is_a?(Range)
+                proc { |row| row[(cols_matcher.min - 1)..(cols_matcher.max - 1)] }
+              when cols_matcher.is_a?(Proc)
+                proc { |row| cols_matcher[row] }
+              else
+                raise ArgumentError.new('Can only take Array, Number, Range or a Block')
             end
         self
       end
@@ -36,7 +40,7 @@ module ExcelWalker
         @run_block = block
       end
 
-      def match?(row_num, sheet_num)
+      def match?(row_num, sheet_num = nil)
         @matcher[row_num, sheet_num]
       end
 

data/lib/excel_walker/reader/reader.rb

@@ -67,7 +67,7 @@ module ExcelWalker
           row_num += 1
           break if @max_rows[sheet_num] && row_num > @max_rows[sheet_num]
           @hooks[sheet_num].each do |hook|
-            hook.call(row, row_num, sheet, sheet_num) if hook.match?(row_num, sheet_num)
+            hook.call(row.values, row_num, sheet, sheet_num) if hook.match?(row_num, sheet_num)
           end
         end
       end

data/lib/excel_walker/version.rb

@@ -1,3 +1,3 @@
 module ExcelWalker
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/excel_walker/writer/hook.rb

@@ -14,7 +14,7 @@ module ExcelWalker
                        @max = condition
                        proc { |row_num| condition === row_num }
                      else
-                       raise ArgumentException.new('Can only take Range, Integers or Arrays here')
+                       raise ArgumentError.new('Can only take Range, Integers or Arrays')
                    end
         @row_index = 0
       end

data/spec/excel_walker/reader/hook_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+module ExcelWalker::Reader
+  describe Hook do
+    subject(:hook) { Hook.new(proc { true }) }
+    it 'raises error on wrong initializaion' do
+      expect { Hook.new('string') }.to raise_error(ArgumentError, 'Can only take Array, Number, Range or a Block')
+    end
+
+    describe '#match?' do
+      context 'array condition for rows' do
+        subject(:hook) { Hook.new([1, 2, 3]) }
+        it 'gives correct output on match' do
+          expect(hook.match?(2)).to be_true
+          expect(hook.match?(0)).to be_false
+        end
+      end
+
+      context 'range condition for rows' do
+        subject(:hook) { Hook.new(1..3) }
+        it 'gives correct output on match' do
+          expect(hook.match?(2)).to be_true
+          expect(hook.match?(0)).to be_false
+        end
+      end
+
+      context 'number condition for rows' do
+        subject(:hook) { Hook.new(2) }
+        it 'gives correct output on match' do
+          expect(hook.match?(2)).to be_true
+          expect(hook.match?(3)).to be_false
+        end
+      end
+
+      context 'proc condition for rows' do
+        subject(:hook) { Hook.new(proc { |x, y| x == y && y == 2 }) }
+        it 'gives correct output on match' do
+          expect(hook.match?(2, 2)).to be_true
+          expect(hook.match?(2, 3)).to be_false
+        end
+      end
+    end
+
+    describe '#run' do
+      let(:hook_lambda) { proc {} }
+      it 'assigns the block to run when hook is executed' do
+        hook.run(&hook_lambda)
+        expect(hook.instance_variable_get('@run_block')).to eq hook_lambda
+      end
+    end
+
+    describe '#call' do
+      let(:collection) { (1..100).to_a }
+      let(:hook_block) { double }
+      before { subject.run { |a, b, c, d| hook_block.call(a, b, c, d) } }
+
+      context 'array column numbers matcher' do
+        subject { hook.columns([1, 2, 4]) }
+        it 'sends correct data to the hooked block' do
+          hook_block.should_receive(:call).with([1, 2, 4], 'b', 'c', 'd')
+          subject.call(collection, 'b', 'c', 'd')
+        end
+      end
+
+      context 'range column numbers matcher' do
+        subject { hook.columns(6..9) }
+        it 'sends correct data to the hooked block' do
+          hook_block.should_receive(:call).with([6, 7, 8, 9], 'b', 'c', 'd')
+          subject.call(collection, 'b', 'c', 'd')
+        end
+      end
+
+      context 'number column matcher' do
+        subject { hook.columns(11) }
+        it 'sends correct data to the hooked block' do
+          hook_block.should_receive(:call).with(11, 'b', 'c', 'd')
+          subject.call(collection, 'b', 'c', 'd')
+        end
+      end
+
+      context 'proc column matcher' do
+        subject { hook.columns {|row| row[96] }  }
+        it 'sends correct data to the hooked block' do
+          hook_block.should_receive(:call).with(97, 'b', 'c', 'd')
+          subject.call(collection, 'b', 'c', 'd')
+        end
+      end
+    end
+
+  end
+end

data/spec/excel_walker/writer/cells_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+module ExcelWalker::Writer
+  describe Cells do
+    subject(:cells) { Cells.new(:style) }
+
+    describe '#set_data_at' do
+      it 'sets data at specified position' do
+        cells.set_data_at(2, :data)
+        expect(cells.data).to eq [nil, nil, :data]
+      end
+
+      it 'sets data at specified range' do
+        cells.set_data_at(4..6, :data)
+        expect(cells.data).to eq [nil, nil, nil, nil, :data, :data, :data]
+      end
+    end
+
+    describe '#set_style_at' do
+      it 'sets style at specified position' do
+        cells.set_style_at(2, :style)
+        expect(cells.styles).to eq [nil, nil, :style]
+      end
+
+      it 'sets data at specified range' do
+        cells.set_style_at(4..6, :style)
+        expect(cells.styles).to eq [nil, nil, nil, nil, :style, :style, :style]
+      end
+    end
+
+    describe '#build' do
+
+      context 'when no data is set but width is set' do
+        it 'maps style for each data cell' do
+          cells.width = 4
+          cells.build
+          expect(cells.styles).to eq [:style, :style, :style, :style]
+        end
+      end
+
+      context 'when data is set' do
+        it 'maps style for each data cell' do
+          cells.set_data_at(3..5, :data)
+          cells.build
+          expect(cells.data).to eq [nil, nil, nil, :data, :data, :data]
+          expect(cells.styles).to eq [:style, :style, :style, :style, :style, :style]
+        end
+      end
+
+      context 'when both data and styles are set' do
+        it 'maps style for each data cell' do
+          cells.set_data_at(3..5, :data)
+          cells.set_style_at([2, 3, 5], :new_style)
+          cells.build
+          expect(cells.styles).to eq [:style, :style, :new_style, :new_style, :style, :new_style]
+        end
+      end
+    end
+  end
+end

data/spec/excel_walker/writer/hook_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+module ExcelWalker::Writer
+  describe Hook do
+    subject(:hook) { Hook.new(0..100) }
+    it 'raises error on wrong initializaion' do
+      expect { Hook.new('string') }.to raise_error(ArgumentError, 'Can only take Range, Integers or Arrays')
+    end
+
+    describe '#match?' do
+      context 'array condition for rows' do
+        subject(:hook) { Hook.new([1, 2, 3]) }
+        it 'gives correct output on match' do
+          expect(hook.match?(2)).to be_true
+          expect(hook.match?(0)).to be_false
+        end
+      end
+
+      context 'range condition for rows' do
+        subject(:hook) { Hook.new(1..3) }
+        it 'gives correct output on match' do
+          expect(hook.match?(2)).to be_true
+          expect(hook.match?(0)).to be_false
+        end
+      end
+
+      context 'number condition for rows' do
+        subject(:hook) { Hook.new(2) }
+        it 'gives correct output on match' do
+          expect(hook.match?(2)).to be_true
+          expect(hook.match?(3)).to be_false
+        end
+      end
+    end
+
+    describe '#max' do
+      it 'gives the correct value of max row number for the hook' do
+        expect(Hook.new(0..100).max).to eq 100
+        expect(Hook.new([0, 1, 110]).max).to eq 110
+        expect(Hook.new(200).max).to eq 200
+      end
+    end
+
+    describe '#after_column' do
+      it 'assigns the block to run when hook is executed' do
+        hook.after_column(10)
+        expect(hook.instance_variable_get('@offset')).to eq 10
+      end
+    end
+
+
+    describe '#fill' do
+      let(:hook_lambda) { proc {} }
+      it 'assigns the block to run when hook is executed' do
+        hook.fill(&hook_lambda)
+        expect(hook.instance_variable_get('@filler')).to eq hook_lambda
+      end
+    end
+
+    describe '#run' do
+      let(:hook_block) { double }
+      let(:cells) { double(build: nil) }
+      before { subject.fill { |a, b, c| hook_block.call(a, b, c) } }
+      subject { hook.after_column(10) }
+      it 'sends correct data to the hooked block' do
+        Cells.should_receive(:new).times.exactly(2).and_return(cells)
+        #first run
+        hook_block.should_receive(:call).with(cells, 0, 5)
+        expect(subject.run(5)).to eq cells
+        #second run
+        hook_block.should_receive(:call).with(cells, 1, 6)
+        expect(subject.run(6)).to eq cells
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: excel_walker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Shadab Ahmed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-11 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: creek