grid-csv 0.1.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.irbrc

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p392@griddle.com --create

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in griddle.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 bjh
+
+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.markdown

@@ -0,0 +1,96 @@
+Griddle
+=======
+
+**note:** someone has the gem name **griddle** registered already so I am calling the gem **grid-csv**.
+
+This gem was created to help process CSV files that are not really the usual *[row, col]* data.
+I have lost many hours of my life in the black hole known as the *coporate intranet*, where windows documents multiply at an obscene rate.
+I came up with this idea to help someone handle this particular nastiness.
+
+This is one for my **windows brothers**, of course if it is useful to anyone else I would be delighted.
+
+On To Business
+==============
+
+An example of the source material in question would be parsing Excel data that comes from a formatted template. One where the structure is more like a document than a database table.
+The template in question may look like this  
+
+![](data/example.png)  
+
+If you exported the Excel data as CSV it may look something like [this](data/po.csv)
+
+Modus Operandi
+==============
+
+The main idea to keep in mind is that you are not processing rows and columns of data.
+You are cutting out **rectangles** or *grids* of data to process further.
+
+Let's say you have to process a bunch of excel files that captured form data.
+The template that was used has a section for the user's contact information.
+Instead of ripping through rows and columns you can either:  
+- search for a known string and use that as the starting point to cut out a  **rectangle**
+- cut out a rectangle from a know location, *i.e.* the contact info starts at row 4, column 3 and is 1 column wide and 4 rows high
+
+The hope is that you can access data in a more intuitive way than just doing a nested for loop and crossing your fingers.
+
+But Why?
+=======
+
+Because Microsoft has empowered business people to do **terrible, terrible** things with data.
+
+Small Examples
+==============
+
+```ruby
+$: << File.expand_path(File.dirname(__FILE__) + './lib')
+require 'griddle.rb'
+
+grid = Griddle::DataGrid.new.populate_from_csv('po.csv')
+
+# I know where the Vendor data is from looking at the Purchase Order
+#   so I cut a rectangle that contains that data
+puts "<Vendor>"
+candy = grid.cut(11, 1, 1, 5)
+puts candy.to_s
+puts
+
+# the Ship To data might move down a line or two
+# so search for it's location based off of it's column header
+puts "<Ship To>"
+shipto = grid.find("SHIP TO").last
+puts "ship to header location: #{shipto}"
+puts grid.cut(shipto.row+1, shipto.col, 1, 5).to_s
+puts
+
+# iterate over the line item rows returned in a Rectangle
+puts "<line items>"
+grid.cut(21, 1, 7, 2).each do |row|
+  puts row.join(":")
+end
+puts
+
+# search for two different points and use them to make a Rectangle
+puts "<rectangle from points>"
+tl = grid.find("TAX RATE").last
+br = grid.find("TOTAL").last
+puts grid.cut_rectangle(Griddle::Rectangle.create(tl, br)).to_s
+
+
+# try out the Point.move functionality
+# use the previous Ship To example
+puts
+puts "<Ship To with move>"
+shipto = grid.find("SHIP TO").last
+shipto.move(down:1)
+puts grid.cut(shipto.row, shipto.col, 1, 5).to_s
+
+
+# show cash money info
+puts
+puts "<want mo money!>"
+puts grid.cut(38, 6, 2, 4).to_s
+```
+
+
+**NOTE:** This code was originally written to accompany the article [here](http://pregnantfist.tumblr.com/post/42406731034/eating-glue-or-how-to-parse-csv-like-a-pre-schooler),
+It is no longer as up to date as the gem version but it does explain the **why** of it all.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task default: :spec
+
+desc 'load gem files into IRB'
+task :console do
+  exec 'irb -Ilib -rgriddle'
+end

data/data/griddle.rb

@@ -0,0 +1,47 @@
+$: << File.expand_path(File.dirname(__FILE__) + './lib')
+require 'griddle.rb'
+
+grid = Griddle::DataGrid.new.populate_from_csv('po.csv')
+
+# I know where the Vendor data is from looking at the Purchase Order
+#   so I cut a rectangle that contains that data
+puts "<Vendor>"
+candy = grid.cut(11, 1, 1, 5)
+puts candy.to_s
+puts
+
+# the Ship To data might move down a line or two
+# so search for it's location based off of it's column header
+puts "<Ship To>"
+shipto = grid.find("SHIP TO").last
+puts "ship to header location: #{shipto}"
+puts grid.cut(shipto.row+1, shipto.col, 1, 5).to_s
+puts
+
+# iterate over the line item rows returned in a Rectangle
+puts "<line items>"
+grid.cut(21, 1, 7, 2).each do |row|
+  puts row.join(":")
+end
+puts
+
+# search for two different points and use them to make a Rectangle
+puts "<rectangle from points>"
+tl = grid.find("TAX RATE").last
+br = grid.find("TOTAL").last
+puts grid.cut_rectangle(Griddle::Rectangle.create(tl, br)).to_s
+
+
+# try out the Point.move functionality
+# use the previous Ship To example
+puts
+puts "<Ship To with move>"
+shipto = grid.find("SHIP TO").last
+shipto.move(down:1)
+puts grid.cut(shipto.row, shipto.col, 1, 5).to_s
+
+
+# show cash money info
+puts
+puts "<want mo money!>"
+puts grid.cut(38, 6, 2, 4).to_s

data/data/po.csv

@@ -0,0 +1,49 @@
+[Company Name],,,PURCHASE ORDER,,,
+[Company Slogan],,,,,DATE:,2/1/2013
+,,,,,P.O. #,[123456]
+,,,,,,
+[Street Address],,,,,,
+"[City, ST  ZIP]",,,,,,
+Phone: [000-000-0000],,,,,,
+Fax: [000-000-0000],,,,,,
+,,,,,,
+VENDOR,,,SHIP TO,,,
+[Name],,,[Attn: Name],,,
+[Company Name],,,[Company Name],,,
+[Street Address],,,[Street Address],,,
+"[City, ST  ZIP]",,,"[City, ST  ZIP]",,,
+[Phone],,,[Phone],,,
+,,,,,,
+REQUISITIONER,SHIP VIA,,F.O.B.,SHIPPING TERMS,,
+,,,,,,
+,,,,,,
+ITEM #,DESCRIPTION,,,QTY,UNIT PRICE,TOTAL
+[23423423],Product XYZ,,,15,150.00,"2,250.00"
+[45645645],Product ABC,,,1,75.00,75.00
+,,,,,,0.00
+,,,,,,0.00
+,,,,,,0.00
+,,,,,,0.00
+,,,,,,0.00
+,,,,,,0.00
+,,,,,,0.00
+,,,,,,0.00
+,,,,,,0.00
+,,,,,,0.00
+,,,,,,0.00
+,,,,,,0.00
+,,,,,,0.00
+,,,,[42],SUBTOTAL,"$2,325.00"
+Other Comments or Special Instructions,,,,,TAX RATE,6.875%
+,,,,,TAX,$159.84
+,,,,,S & H,$0.00
+,,,,,OTHER,$0.00
+,,,,,TOTAL,"$2,484.84"
+,,,,,,
+,,,,,,
+,,,,,,
+,,,,,,
+,,,Authorized by,,,Date
+,,,,,,
+"If you have any questions about this purchase order, please contact",,,,,,
+"[Name, Phone #, E-mail, Phone, Fax]",,,,,,

data/griddle.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'griddle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grid-csv"
+  spec.version       = Griddle::VERSION
+  spec.authors       = ["bjh"]
+  spec.email         = ["fake@fake.com"]
+  spec.summary       = %q{treat CSV like a grid}
+  spec.description   = %q{access rectangles of data instead of rows and columns}
+  spec.homepage      = "https://github.com/bjh/griddle"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "terminal-table"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/griddle.rb

@@ -0,0 +1,4 @@
+require 'griddle/version'
+require 'griddle/point'
+require 'griddle/rectangle'
+require 'griddle/data_grid'

data/lib/griddle/data_grid.rb

@@ -0,0 +1,105 @@
+require 'csv'
+require 'terminal-table'
+require_relative 'point'
+
+module Griddle
+  class DataGrid
+    include Enumerable
+    attr_accessor :case_sensitive, :offset, :grid
+
+    def self.from_csv(csv)
+      DataGrid.new.populate_from_csv(csv)
+    end
+
+    def initialize(start_counting_at_zero=false)
+      @offset = start_counting_at_zero ? 0 : 1
+      @grid = []
+      @case_sensitive = false
+    end
+
+    def to_rectangle
+      Rectangle.new(0, 0, width, height)
+    end
+
+    def width
+      grid[0].size
+    end
+
+    def height
+      grid.size
+    end
+
+    # Enumerable
+    def each(&block)
+      grid.each do |row|
+        block.call(row)
+      end
+    end
+
+    def to_s
+      Terminal::Table.new(rows: grid)
+    end
+
+    def populate_from_csv(csv_file_path)
+      CSV.foreach(csv_file_path) {|row| self.grid << row}
+      self
+    end
+
+    def populate_from_data(data)
+      self.grid = data
+      self
+    end
+
+    def to_regex(query)
+      return query if query.is_a? Regexp
+
+      if case_sensitive
+        /#{Regexp.escape(query)}/
+      else
+        /#{Regexp.escape(query)}/i
+      end
+    end
+
+    def find(what)
+      what = to_regex(what)
+      matches = []
+
+      grid.each_with_index do |row, row_index|
+        row.each_index.select {|n| what.match(row[n])}.each do |column|
+          matches << Point.new(*offset_up(row_index, column))
+        end
+      end
+
+      matches
+    end
+
+    def cut(top, left, width, height)
+      top, left = offset_down(top, left)
+      selection = []
+
+      for row in top...(top+height)
+        row_data = []
+
+        for col in left...(left+width)
+          row_data << grid[row][col]
+        end
+
+        selection << row_data
+      end
+
+      DataGrid.new.populate_from_data(selection)
+    end
+
+    def cut_rectangle(rectangle)
+      cut(rectangle.top, rectangle.left, rectangle.width, rectangle.height)
+    end
+
+    def offset_down(*args)
+      args.collect {|n| n - offset}
+    end
+
+    def offset_up(*args)
+      args.collect {|n| n + offset}
+    end
+  end
+end

data/lib/griddle/point.rb

@@ -0,0 +1,74 @@
+require_relative 'rectangle'
+
+module Griddle
+  class Point < Struct.new(:row, :col)
+    include Comparable
+
+    # TODO: not sure this is really necessary,
+    #  it seemed like a good idea at the time
+    def <=>(point)
+      [row, col] <=> [point.row, point.col]
+    end
+
+    def to_s
+      "[#{row}, #{col}]"
+    end
+
+    def nil?
+      row.nil? && col.nil?
+    end
+
+    def zero?
+      row.zero? && col.zero?
+    end
+
+    def delta(point)
+      Point.new(
+        (self.row - point.row).abs,
+        (self.col - point.col).abs
+      )
+    end
+
+    # `point` is used to calculate the width and height
+    #    of the new rectangle
+    def to_rectangle(point)
+      d = delta(point)
+
+      Rectangle.new(
+        row,
+        col,
+        d.col + 1,
+        d.row + 1
+      )
+    end
+
+    def move(directions)
+      directions.each_pair do |direction, amount|
+        amount = amount.to_i
+
+        case direction.to_sym
+        when :up
+          self.row -= amount
+        when :down
+          self.row += amount
+        when :left
+         self.col -= amount
+        when :right
+         self.col += amount
+        end
+      end
+    end
+
+    # some sugar
+    [:up, :down, :left, :right].each do |direction|
+      define_method direction do |amount|
+        move(direction => amount)
+      end
+    end
+  end
+
+  # # return NullPoint instead of nil
+  # NullPoint = Point.new(nil, nil)
+  # # for no apparent reason
+  # ZeroPoint = Point.new(0, 0)
+end

data/lib/griddle/rectangle.rb

@@ -0,0 +1,15 @@
+module Griddle
+  class Rectangle < Struct.new(:top, :left, :width, :height)
+    # include Comparable
+
+    def self.create(top_left, bottom_right)
+      top_left.to_rectangle(bottom_right)
+    end
+
+    # TODO: what makes a rectangle less than another?
+    #  the width, the position, the height? the size?
+    # def <=>(rectangle)
+    #   [top, left, width, height] <=> [rectangle.top, rectangle.left, rectangle.width, rectangle.height]
+    # end
+  end
+end

data/lib/griddle/version.rb

@@ -0,0 +1,3 @@
+module Griddle
+  VERSION = "0.1.1"
+end

data/spec/lib/data_grid_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper.rb'
+require 'griddle'
+
+describe Griddle::DataGrid do
+  let(:grid) { Griddle::DataGrid.from_csv('data/po.csv') }
+
+  describe '#find' do
+    context 'using a regular expression' do
+      it 'uses the regexp to match against' do
+        expect(grid.find(/ship to/i)).to have(1).item
+      end
+    end
+
+    context 'when a single match is found' do
+      it 'returns an array with a single Point' do
+        expect(grid.find('SHIP TO')).to have(1).item
+      end
+
+      it 'the matched point has the row and column of the found item' do
+        p = grid.find('SHIP TO').last
+        expect(p.row).to eq 10
+        expect(p.col).to eq 4
+      end
+    end
+
+    context 'when multiple matches are found' do
+      it 'returns an array of Points' do
+        expect(grid.find('[Street Address]')).to have(3).items
+      end
+    end
+
+    context 'when a match is NOT found' do
+      it 'returns an empty array' do
+        expect(grid.find('SHAZAM!!!')).to have(0).items
+      end
+    end
+  end
+
+  describe '#width' do
+    it 'returns the width of the data grid' do
+      r = grid.cut(11, 1, 1, 5).to_rectangle
+      expect(r.width).to eq 1
+    end
+  end
+
+  describe '#height' do
+    it 'the height of the data grid' do
+      r = grid.cut(11, 1, 1, 5).to_rectangle
+      expect(r.height).to eq 5
+    end
+  end
+
+  describe '#to_rectangle' do
+    it 'returns a rectangle with the width and height of the data' do
+      r = grid.cut(11, 1, 1, 5).to_rectangle
+      expect(r.width).to eq 1
+      expect(r.height).to eq 5
+    end
+  end
+
+  describe '#cut' do
+    it 'returns a matrix/grid the size of the passed in parameters' do
+      data = grid.cut(11, 1, 1, 5)
+      expect(data.grid).to have(5).items
+    end
+  end
+
+  describe '#offset_up' do
+    it 'adds one to every value passed in' do
+      expect(grid.offset_up(4, 4)).to eq [5, 5]
+    end
+  end
+
+  describe '#offset_down' do
+    it 'subtract one from every value passed in' do
+      expect(grid.offset_down(4, 4)).to eq [3, 3]
+    end
+  end
+end

data/spec/lib/point_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper.rb'
+require 'griddle'
+
+describe Griddle::Point do
+  let(:point) { Griddle::Point.new(10, 10) }
+
+  describe '#delta' do
+    context 'when the points have the same values' do
+      it 'returns a point with [0,0]' do
+        p2 = Griddle::Point.new(10, 10)
+        expect(point.delta(p2).zero?).to be_true
+      end
+    end
+
+    context 'when the points have the different values' do
+      it 'returns a point with the difference' do
+        p2 = Griddle::Point.new(3, 3)
+        expect(point.delta(p2)).to eq Griddle::Point.new(7, 7)
+      end
+    end
+  end
+
+  # make sure the spaceship was implemented properly
+  describe '<=>' do
+    context 'when lhs == rhs' do
+      it 'returns true' do
+        rhs = Griddle::Point.new(10, 10)
+        expect(point == rhs).to be_true
+      end
+    end
+
+    context 'when lhs > rhs' do
+      it 'returns true' do
+        rhs = Griddle::Point.new(9, 0)
+        expect(point > rhs).to be_true
+      end
+    end
+
+    context 'when lhs < rhs' do
+      it 'returns true' do
+        rhs = Griddle::Point.new(11, 11)
+        expect(point < rhs).to be_true
+      end
+    end
+  end
+
+  describe 'movement methods' do
+    it 'can go up' do
+      expect(point).to respond_to :up
+    end
+
+    it 'can go down' do
+      expect(point).to respond_to :down
+    end
+
+    it 'can go left' do
+      expect(point).to respond_to :left
+    end
+
+    it 'can go right' do
+      expect(point).to respond_to :right
+    end
+
+    describe "#move" do
+      it "moves up" do
+        point.move(up: 2)
+        expect(point.row).to eq(8)
+      end
+
+      it "moves down" do
+        point.move(:down => 4)
+        expect(point.row).to eq(14)
+      end
+
+      it "moves up and right" do
+        point.move(up:5, right:3)
+        expect(point.row).to eq(5)
+        expect(point.col).to eq(13)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: grid-csv
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- bjh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: access rectangles of data instead of rows and columns
+email:
+- fake@fake.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- data/example.png
+- data/griddle.rb
+- data/po.csv
+- griddle.gemspec
+- lib/griddle.rb
+- lib/griddle/data_grid.rb
+- lib/griddle/point.rb
+- lib/griddle/rectangle.rb
+- lib/griddle/version.rb
+- spec/lib/data_grid_spec.rb
+- spec/lib/point_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bjh/griddle
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 434941054811727487
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 434941054811727487
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: treat CSV like a grid
+test_files:
+- spec/lib/data_grid_spec.rb
+- spec/lib/point_spec.rb
+- spec/spec_helper.rb