columns-matcher 0.0.2 → 0.0.2.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/README.md

@@ -0,0 +1,132 @@
+# Column Matcher
+
+When you work with spreadsheets and casual users things do not always go as you want.
+
+I worked on a project where users have to upload a spreadsheet with a lot of data about clients purchases.
+After 3 upload they call me because the system "did not work well".
+
+The files look like these followiong.
+
+File 1:
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Surname</th>
+    <th>Emails</th>
+  </tr>
+  <tr>
+    <td>John</td>
+    <td>Smith</td>
+    <td>john.smith@gmail.com</td>
+  </tr>
+  <tr>
+    <td>John</td>
+    <td>Doe</td>
+    <td>john.doe@hotmail.com</td>
+  </tr>
+</table>
+
+File 2:
+
+<table>
+  <tr>
+    <th>Surname</th>
+    <th>Name</th>
+    <th>E-mail</th>
+  </tr>
+  <tr>
+    <td>Smith</td>
+    <td>John</td>
+    <td>john.smith@gmail.com</td>
+  </tr>
+  <tr>
+    <td>Doe</td>
+    <td>John</td>
+    <td>john.doe@hotmail.com</td>
+  </tr>
+</table>
+
+File 3:
+
+<table>
+  <tr>
+    <th>Mail</th>
+    <th>Nombre</th>
+    <th>Apellido</th>
+  </tr>
+  <tr>
+    <td>john.smith@gmail.com</td>
+    <td>John</td>
+    <td>Smith</td>
+  </tr>
+  <tr>
+    <td>john.doe@hotmail.com</td>
+    <td>John</td>
+    <td>Doe</td>
+  </tr>
+</table>
+
+3 files, 3 different structures. 3 different headers. WTF!
+How can i guess the position of the columns i'm looking for?
+
+This gem try to solve the problem
+
+## Install
+
+Add to your Gemfile and run the `bundle` command to install it.
+
+```ruby
+gem "columns-matcher"
+```
+ 
+**N.B. Requires Ruby 1.9.2 or later.**
+
+## Use
+
+```ruby
+
+@matcher = ColumnsMatcher::Matcher.new
+
+# the column that contains the name can be lebeled with "NAME", "NOME" or "NOMBRE"
+@matcher.add_column("name", ["NAME", "NOME", "NOMBRE"])
+
+# the column that contains the surname can be lebeled with "SURNAME", "COGNOME" or "APELLIDOS"
+@matcher.add_column("cognome", ["SURNAME", "COGNOME", "APELLIDOS"])
+
+# We suppose the header is ["COGNOME", "NOME", "INDIRIZZO"]
+@matcher.set_header(header_loaded_from_spreadsheet)
+
+@matcher.column_of("name") # return 1
+@matcher.column_of("cognome") # return 0
+```
+
+First try is as exact match. If does not work it try with different case:
+
+```ruby
+
+@matcher = ColumnsMatcher::Matcher.new
+
+# the column that contains the name can be lebeled with "NAME", "NOME" or "NOMBRE"
+@matcher.add_column("name", ["name", "nome", "nombre"])
+
+# We suppose the header is ["APELLIDO", "NOMBRE", "ADDRESS"]
+@matcher.set_header(header_loaded_from_spreadsheet)
+
+@matcher.column_of("name") # return 1
+```
+
+If I can't find the column with exact match or different case match i can also use reg exp
+
+```ruby
+
+@matcher = ColumnsMatcher::Matcher.new
+
+# the column that contains the name can be lebeled with "NAME", "NOME" or "NOMBRE"
+@matcher.add_column("email", ["[Ee]?[\-]*mail[s]*"])
+
+# We suppose the header is ["Surname", "Name", "Emails"]
+@matcher.set_header(header_loaded_from_spreadsheet)
+
+@matcher.column_of("email") # return 2
+```

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/columns-matcher.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/columns-matcher/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrea Mostosi"]
+  gem.email         = ["andrea.mostosi@zenkay.net"]
+  gem.description   = %q{Given an hash of possibles header label find the correct position of a column in the real header. Useful when you don't know the structure of a spreadsheet.}
+  gem.summary       = %q{Column header label matcher}
+  gem.homepage      = "https://github.com/zenkay/columns-matcher"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "columns-matcher"
+  gem.require_paths = ["lib"]
+  gem.version       = ColumnsMatcher::VERSION
+  
+  gem.add_development_dependency "rspec", "~> 2.6.0"
+end

data/lib/columns-matcher/version.rb

@@ -0,0 +1,3 @@
+module ColumnsMatcher
+  VERSION = "0.0.2.1"
+end

data/lib/columns-matcher.rb

@@ -0,0 +1,102 @@
+require "columns-matcher/version"
+
+module ColumnsMatcher
+  class Matcher
+    
+    def initialize
+      @header = []
+      @matcher = {}
+      @columns = {}
+    end
+    
+    def add_column(name, labels)
+      begin
+        if labels.is_a? String
+          @matcher[name] = [labels]
+        elsif labels.is_a? Array
+          @matcher[name] = labels
+        end
+        self.match_columns
+        return true
+      rescue Exception => e
+        return false
+      end
+    end
+    
+    def add_columns(matches)      
+      if matches.is_a? Hash
+        matches.each do |name, labels|
+          begin
+            if labels.is_a? String
+              @matcher[name] = [labels]
+            elsif labels.is_a? Array
+              @matcher[name] = labels
+            end
+          rescue Exception => e
+            puts e.backtrace
+          end
+        end
+        self.match_columns
+      end
+    end
+    
+    def set_header(header)
+      begin
+        if header.is_a? String
+          @header = [header]
+        elsif header.is_a? Array
+          @header = header
+        end
+        self.match_columns
+      rescue Exception => e
+      end
+    end
+    
+    def match_columns
+      if not @matcher.empty? and not @header.empty?
+
+        @matcher.each do |name, labels|
+          labels.each do |label|
+            
+            # exact match
+            unless @header.index(label).nil?
+              @columns[name] = @header.index(label)
+              break
+            end
+            
+            # different case
+            @header.each_with_index do |head, index|
+              if head.downcase == label.downcase
+                @columns[name] = index
+                break
+              end
+            end
+            break unless @columns[name].nil?
+            
+            # reg-exp
+            @header.each_with_index do |head, index|
+              unless head.match(/^#{label}$/).nil?
+                @columns[name] = index
+                break
+              end
+            end
+            break unless @columns[name].nil?
+            
+            # multiple words search
+            # to-do
+            
+          end
+        end
+      end
+    end
+    
+    def column_of(name)
+      if @columns[name].nil?
+        return nil
+      else
+        return @columns[name]
+      end
+    end
+    
+  end
+end

data/spec/columns-matcher_spec.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+require 'spec_helper'
+describe ColumnsMatcher do
+  
+  describe "Matcher standard" do
+    
+    before do
+      @matcher = ColumnsMatcher::Matcher.new
+    end
+    
+    it "should can create the object" do
+      @matcher.should_not be_nil
+    end
+    
+    it "should recognize single column with a single description" do
+      @matcher.add_column("name", "NOME")
+      @matcher.set_header(["NOME"])
+      @matcher.column_of("name").should be(0)
+    end
+    
+    it "should recognize single column with multiple descriptions" do
+      @matcher.add_column("name", ["NAME", "NOME", "NOMBRE"])
+      @matcher.set_header(["NOME"])
+      @matcher.column_of("name").should be(0)
+    end
+    
+    it "should recognize single column within different fields" do
+      @matcher.add_column("name", ["NAME", "NOME", "NOMBRE"])
+      @matcher.set_header(["COGNOME", "NOME", "INDIRIZZO"])
+      @matcher.column_of("name").should be(1)
+    end
+    
+    it "should recognize multiple columns within different fields" do
+      @matcher.add_column("name", ["NAME", "NOME", "NOMBRE"])
+      @matcher.add_column("cognome", ["SURNAME", "COGNOME", "APELIDOS"])
+      @matcher.set_header(["COGNOME", "NOME", "INDIRIZZO"])
+      @matcher.column_of("name").should be(1)
+      @matcher.column_of("cognome").should be(0)
+    end
+    
+    it "should recognize multiple columns within different fields with a single definition" do
+      @matcher.add_columns(
+        "name" => ["NAME", "NOME", "NOMBRE"],
+        "cognome" => ["SURNAME", "COGNOME", "APELIDOS"]
+      )
+      @matcher.set_header(["COGNOME", "NOME", "INDIRIZZO"])
+      @matcher.column_of("name").should be(1)
+      @matcher.column_of("cognome").should be(0)
+    end
+    
+    it "should recognize single column with different case" do
+      @matcher.add_column("name", ["nome"])
+      @matcher.set_header(["NOME"])
+      @matcher.column_of("name").should be(0)
+    end
+    
+    it "should recognize multiple columns within different fields with different case" do
+      @matcher.add_column("name", ["name", "nome", "nombre"])
+      @matcher.add_column("cognome", ["surname", "cognome", "apelidos"])
+      @matcher.set_header(["COGNOME", "NOME", "INDIRIZZO"])
+      @matcher.column_of("name").should be(1)
+      @matcher.column_of("cognome").should be(0)
+    end
+    
+    it "should recognize single column with a reg exp" do
+      @matcher.add_column("name", ["N[AO]+ME"])
+      @matcher.set_header(["NOME"])
+      @matcher.column_of("name").should be(0)
+    end
+
+    it "should not find single column with a reg exp" do
+      @matcher.add_column("name", ["[AO]+ME"])
+      @matcher.set_header(["NOME"])
+      @matcher.column_of("name").should be_nil
+    end
+
+    it "should not find single column with a reg exp" do
+      @matcher.add_column("email", ["[Ee]?[\-]*mail[s]*"])
+      @matcher.set_header(["Emails"])
+      @matcher.column_of("email").should be(0)
+    end
+
+  end
+  
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'columns-matcher'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: columns-matcher
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-02 00:00:00.000000000Z
+date: 2012-04-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70095432524900 !ruby/object:Gem::Requirement
+  requirement: &70253209572420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70095432524900
+  version_requirements: *70253209572420
 description: Given an hash of possibles header label find the correct position of
   a column in the real header. Useful when you don't know the structure of a spreadsheet.
 email:
@@ -29,7 +29,17 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- columns-matcher.gemspec
+- lib/columns-matcher.rb
+- lib/columns-matcher/version.rb
+- spec/columns-matcher_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/zenkay/columns-matcher
 licenses: []
 post_install_message: 
@@ -54,4 +64,6 @@ rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Column header label matcher
-test_files: []
+test_files:
+- spec/columns-matcher_spec.rb
+- spec/spec_helper.rb