excel_walker 0.0.1

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,12 @@
+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"
+
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in excel_walker.gemspec
+gemspec
+
+group :test do
+  gem 'growl'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'redis', :require => false
+  gem 'simplecov', :require => false
+end

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+interactor :simple
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Shadab Ahmed
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# ExcelWalker
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'excel_walker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install excel_walker
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/excel_walker.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'excel_walker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'excel_walker'
+  spec.version       = ExcelWalker::VERSION
+  spec.authors       = ['Shadab Ahmed']
+  spec.email         = ['shadab.ansari@gmail.com']
+  spec.description   = %q{A declarative parser and builder for Excel Files}
+  spec.summary       = %q{This gem chooses a different approach to Excel Parsing since excel can contain many regions of interest.}
+  spec.homepage      = 'https://github.com/shadabahmed/excel_walker'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'creek', '~>1.0.4'
+  spec.add_dependency 'axlsx', '~>2.0.1'
+  spec.add_dependency 'activesupport', '> 3.0.0'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/excel_walker.rb

@@ -0,0 +1,9 @@
+require 'active_support/core_ext/module/delegation'
+require 'excel_walker/version'
+require 'excel_walker/errors'
+require 'excel_walker/reader'
+require 'excel_walker/writer'
+
+module ExcelWalker
+  # Your code goes here...
+end

data/lib/excel_walker/errors.rb

@@ -0,0 +1,7 @@
+module ExcelWalker
+  class StopIteration < ::StopIteration
+  end
+
+  class ArgumentError < ::ArgumentError
+  end
+end

data/lib/excel_walker/reader.rb

@@ -0,0 +1,11 @@
+require 'creek'
+require 'excel_walker/reader/hook'
+require 'excel_walker/reader/reader'
+
+module ExcelWalker
+  module Reader
+    def self.create(file_path)
+      Reader.new(file_path)
+    end
+  end
+end

data/lib/excel_walker/reader/hook.rb

@@ -0,0 +1,55 @@
+require 'set'
+module ExcelWalker
+  module Reader
+    class Hook
+      def initialize(condition)
+        @matcher = case true
+                     when condition.respond_to?(:call)
+                       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 }
+                   end
+      end
+
+      def columns(cols_condition = nil, &block)
+        cols_condition = 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] }
+            end
+        self
+      end
+
+      alias pluck_columns columns
+
+      def run(&block)
+        @run_block = block
+      end
+
+      def match?(row_num, sheet_num)
+        @matcher[row_num, sheet_num]
+      end
+
+      def call(row, row_num, sheet, sheet_num)
+        data = extract_columns(row, row_num, sheet, sheet_num)
+        @run_block[data, row_num, sheet, sheet_num]
+      end
+
+      protected
+
+      def extract_columns(*args)
+        @cols_extractor[*args]
+      end
+    end
+  end
+end

data/lib/excel_walker/reader/reader.rb

@@ -0,0 +1,76 @@
+module ExcelWalker
+  module Reader
+    class Reader
+      def initialize(file_path)
+        @xl = Creek::Book.new(file_path)
+        @hooks = {}
+        @max_rows = {}
+        @current_sheet = 1
+        @max_sheets = 1
+      end
+
+      def for_sheet(sheet_num)
+        @current_sheet = sheet_num
+        @max_sheets = sheet_num if sheet_num > @max_sheets
+        self
+      end
+
+      alias set_sheet for_sheet
+
+      def max_rows(max)
+        @max_rows[@current_sheet] = max
+        self
+      end
+
+      def on_row(condition = nil, &block)
+        condition = block if block_given?
+        Hook.new(condition).tap do |hook|
+          @hooks[@current_sheet] ||= []
+          @hooks[@current_sheet] << hook
+        end
+      end
+
+      alias on_rows on_row
+
+      def hooks
+        @hooks[@current_sheet]
+      end
+
+      def start
+        sheet_num = 0
+        sheets_done = []
+        begin
+          @xl.sheets.each do |sheet|
+            sheet_num += 1
+            break if sheet_num > @max_sheets
+            process_rows(sheet, sheet_num)
+            sheets_done << sheet.name
+          end
+        rescue StopIteration
+        end
+        sheets_done
+      ensure
+        @xl.close
+      end
+
+      alias walk start
+
+      def exit
+        raise StopIteration.new
+      end
+
+      protected
+
+      def process_rows(sheet, sheet_num)
+        row_num = 0
+        sheet.rows.each do |row|
+          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)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/excel_walker/version.rb

@@ -0,0 +1,3 @@
+module ExcelWalker
+  VERSION = "0.0.1"
+end

data/lib/excel_walker/writer.rb

@@ -0,0 +1,27 @@
+require 'axlsx'
+require 'excel_walker/writer/cells'
+require 'excel_walker/writer/hook'
+require 'excel_walker/writer/sheet_builder'
+
+module ExcelWalker
+  module Writer
+
+    def self.create(file_path)
+      Writer.new(file_path)
+    end
+
+    class Writer
+      def initialize(file_path)
+
+      end
+
+      def new_sheet(sheet_name)
+
+      end
+
+      def save
+
+      end
+    end
+  end
+end

data/lib/excel_walker/writer/cells.rb

@@ -0,0 +1,49 @@
+module ExcelWalker
+  module Writer
+
+    class Cells
+      attr_accessor :width, :default_style, :data, :styles
+
+      def initialize(default_style)
+        @default_style = default_style
+        @data, @styles, @width = [], [], 0
+      end
+
+      def set_data_at(range, cell_data)
+        range = [range] if range.is_a?(Fixnum)
+        range.each do |i|
+          data[i] = cell_data
+        end
+      end
+
+      def set_style_at(range, cell_style)
+        range = [range] if range.is_a?(Fixnum)
+        range.each do |i|
+          styles[i] = cell_style
+        end
+      end
+
+      def build
+        build_data
+        build_styles
+      end
+
+      private
+
+      def build_data
+        if data.empty? && @width > 0
+          @data = [nil]*@width
+        end
+      end
+
+      def build_styles
+        final_styles = [@default_style]*@data.length
+        0.upto(styles.length - 1).each do |idx|
+          final_styles[idx] = @styles[idx] if @styles[idx]
+        end
+        @styles = final_styles
+      end
+    end
+
+  end
+end

data/lib/excel_walker/writer/hook.rb

@@ -0,0 +1,45 @@
+module ExcelWalker
+  module Writer
+
+    class Hook
+      attr_reader :max, :offset
+      attr_accessor :style
+
+      def initialize(condition)
+        @matcher = case true
+                     when condition.is_a?(Range), condition.is_a?(Array)
+                       @max = condition.max
+                       proc { |row_num| condition.include?(row_num) }
+                     when condition.is_a?(Fixnum)
+                       @max = condition
+                       proc { |row_num| condition === row_num }
+                     else
+                       raise ArgumentException.new('Can only take Range, Integers or Arrays here')
+                   end
+        @row_index = 0
+      end
+
+      def match?(row_num)
+        @matcher[row_num]
+      end
+
+      def after_column(offset)
+        @offset = offset
+        self
+      end
+
+      def fill(&block)
+        @filler = block
+      end
+
+      def run(row_num)
+        cells = Cells.new(style)
+        @filler[cells, @row_index, row_num]
+        cells.build
+        @row_index += 1
+        cells
+      end
+    end
+
+  end
+end

data/lib/excel_walker/writer/sheet_builder.rb

@@ -0,0 +1,56 @@
+module ExcelWalker
+  module Writer
+    class SheetBuilder
+      def initialize(workbook, name)
+        @workbook = workbook
+        @name = name
+        @sheet = @workbook.add_worksheet(:name => @name)
+        @hooks = []
+        @max_rows = 0
+      end
+
+      delegate :add_style, to: '@workbook.styles'
+      delegate :pane, to: '@sheet.sheet_view'
+
+      def create_pane(x , y)
+        @sheet.sheet_view.pane do |pane|
+          pane.top_left_cell = "#{(64 + x).chr}#{y}"
+          pane.state = :frozen_split
+          pane.y_split = x - 1
+          pane.x_split = y - 1
+          pane.active_pane = :bottom_right
+        end
+      end
+
+      def on_rows(range, opts = {style: nil})
+        Hook.new(range).tap do |hook|
+          hook.style = opts[:style]
+          @max_rows = hook.max if hook.max > @max_rows
+          @hooks << hook
+        end
+      end
+
+      alias on_row on_rows
+
+      def merge_array(arr1, arr2, offset)
+        offset.upto(arr2.length - 1 + offset).with_index do |offset_idx, idx|
+          arr1[offset_idx] = arr2[idx]
+        end
+      end
+
+      def build
+        1.upto(@max_rows) do |row_num|
+          row, styles = [], []
+          @hooks.each do |hook|
+            if hook.match?(row_num)
+              cells = hook.run(row_num)
+              merge_array(row, cells.data, hook.offset)
+              merge_array(styles, cells.styles, hook.offset)
+            end
+          end
+          @sheet.add_row row, style: styles
+        end
+      end
+    end
+  end
+end