goodsheet 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aef27ae57a44343de4b43b8118c3a4dba7940021
-  data.tar.gz: ccd478aad49271a61e1e4278cbfd95ea9a226b17
+  metadata.gz: b602fb68bc8d91fbc2004a2fc5dc021e26ef25cc
+  data.tar.gz: 7ccf288b4183c2d84ecdc5f22afbdfd572824dd5
 SHA512:
-  metadata.gz: cf0b9d857e4eb5a66cbf72a6c205e1ab4f517fd93dbd40e42382e1b1f34d0b0e74813bdf8bb5e3e48c554933297ccc31160d39e83e2d4b311825ddf73c32d897
-  data.tar.gz: f866ccb2f33ffa9618f12c597a1ab4c9d88282eaf6ffd0485d0e262f78cc506c424a58cc97f2de569e385aa88e2f517b3ee85fd443a955c35e9fe4c808bd7e6e
+  metadata.gz: 81da028ed30bdd2e27616fcff01fe313e8eb38884e098121518eff2be24cad1ec538f5641442ec18d08f896bf756f640baec21352a898716555d236e0e6821b1
+  data.tar.gz: 0b85bba8e877f4907ec5a601ecb3fd482358d0cdb32d174467495a4334e0d8a138dbc8865abb3f901410f371b3a36bacca77bb4bad9f5320472774ba49fda363

data/README.md

@@ -30,7 +30,8 @@ Given a spreadsheet:
 ```ruby
 ss = Goodsheet::Spreadsheet.new("example.xls")
 res = ss.read do
-  column_names :filename => 0, :size => 1, :created_at => 3, :updated_at => 4 # ignore 'description' column
+  column_names :filename => 0, :size => 1, :created_at => 3, :updated_at => 4 # i want to ignore 'description' column
+  column_defaults :filename => "UNKNOWN"
   validates :filename, :presence => true
   validates :size, :presence => true, :numericality => { :greater_than_or_equal_to => 0.0 }
   validate :order_of_dates
@@ -126,14 +127,21 @@ ss.rows_wo_skipped # => except the skipped ones, aliased by `rows` method
 
 #### Reading and validate
 
-Use the `validate` and `read` methods to perform validation and reading. Note that the reading function include a validation call.
+Use the `validate` and `read` methods to perform validation and reading. Note that the reading function include the validation step.
 Pass the previously seen `options` hash and a block to `validate`/`read` method.
-Inside the block you define columns names and indexes you want to validate/read using the `column_names` method. You can use one of these 4 forms (and their effect is the same):
+Inside the block you define columns names and indexes you want to validate/read using the `column_names` method. You can use one of these 4 forms (and their effect is identical):
 - `column_names :a => 0, :b => 1, :c => 3`
 - `column_names 0 => :a, 1 => :b, 3 => :c`
 - `column_names [:a, :b, nil, :c]`
 - `column_names :a, :b, nil, :c`
 
+Use the `column_defaults` method to specify the value to set when the corresponding cell hold a nil value (is empty). Like the previous method, the following forms are identical:
+- `column_defaults :a => 0.0, :b => 0.0, :c => "UNKNOWN"`
+- `column_defaults 0 => 0.0, 1 => 0.0, 3 => "UNKNOWN"`
+- `column_defaults [0.0, 0.0, "UNKNOWN"]`
+- `column_defaults 0.0, 0.0, "UNKNOWN"`
+The `column_defaults` macro overwrite the read/validate `:force_nil` option.
+
 Aside from define the columns settings, into block you define the validation rules. 
 Refer to the [official guide](http://guides.rubyonrails.org/active_record_validations.html) and [ROR Api](http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html)
 

data/goodsheet.gemspec

@@ -2,6 +2,7 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'goodsheet/version'
+require 'date'
 
 Gem::Specification.new do |spec|
   spec.name          = "goodsheet"
@@ -12,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Extract and validate data from a spreadsheet"
   spec.homepage      = "https://github.com/iwan/goodsheet"
   spec.license       = "MIT"
-  spec.date          = '2013-07-19'
+  spec.date          = Date.today.to_s
   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)/})
@@ -23,6 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
 
   spec.add_dependency('roo', '>= 1.12.1') # https://github.com/Empact/roo
-  spec.add_dependency('activemodel', '>= 3.2.14')
+  spec.add_dependency('activemodel', '~> 3.2')
   spec.add_dependency('google_drive')
 end

data/lib/goodsheet/aux.rb

@@ -0,0 +1,10 @@
+class Object
+  def chrono(msg, &block)
+    puts "--------- starting #{msg} -------->"
+    t = Time.now
+    yield
+    delta_t = Time.now-t
+    puts "<-------- #{msg} takes #{delta_t}s"
+    return delta_t
+  end
+end

data/lib/goodsheet/row.rb

@@ -6,7 +6,7 @@ module Goodsheet
     include ActiveModel::Validations
 
     class << self
-      attr_accessor :keys, :defaults
+      attr_accessor :keys, :defaults, :defaults_attributes
     end
     # @keys = {} # idx => key: {0=>:name, 1=>:quantity, 2=>:price, 3=>:total, 6=>:password}
     # @defaults = {} # name => default_value
@@ -28,6 +28,7 @@ module Goodsheet
       c = Class.new(self) do
         @keys = {} # idx => key: {0=>:name, 1=>:quantity, 2=>:price, 3=>:total, 6=>:password}
         @defaults = {} # name => default_value
+        @defaults_attributes = nil # name => default_value
       end
       c.class_eval(&block)
       c
@@ -35,16 +36,29 @@ module Goodsheet
 
     # using indexes: defaults 1 => 0.0, 2 => ""
     # using names:   defaults :qty => 0.0, :name => ""
-
     def self.column_defaults(*attr)
       raise ArgumentError, 'You have to pass at least one attribute' if attr.empty?
-      if attr[0].is_a? Array
+      if self.keys.empty?
+        self.defaults_attributes = attr
+      else
+        self.defaults_attributes = nil
+        self.set_defaults(attr)
+      end
+    end
+
+    def self.set_defaults(attr)
+      if attr[0].is_a? Array # column_defaults [0.0, nil, "Unknown"]
+        # @defaults = Hash[attr[0].map.with_index{|v, i| [self.keys[i], v]}]
         @defaults = Hash[attr[0].map.with_index{|v, i| [self.keys[i], v]}]
 
-      elsif attr[0].is_a? Hash
+      elsif attr[0].is_a? Hash # column_defaults 0 => 0.0, 1 => nil, 2 => "Unknown"
+         # --or-- column_defaults :size => 0.0, :weight => nil, :name => "Unknown"
+
+        # @defaults = Hash[attr[0].to_a.collect{|a| [(a[0].is_a?(Fixnum)) ? (self.keys[a[0]]) : a[0], a[1]]}]
         @defaults = Hash[attr[0].to_a.collect{|a| [(a[0].is_a?(Fixnum)) ? (self.keys[a[0]]) : a[0], a[1]]}]
 
-      else
+      else # column_defaults 0.0, nil, "Unknown"
+        # @defaults = Hash[attr.map.with_index{|v, i| [self.keys[i], v]}]
         @defaults = Hash[attr.map.with_index{|v, i| [self.keys[i], v]}]
       end
     end
@@ -58,30 +72,21 @@ module Goodsheet
     # at the position, or simply put the list of names.
     # The positions are 0-based.
     def self.column_names(*attr)
-    # def self.column_names(param)
       @keys = {}
       raise ArgumentError, 'You have to pass at least one attribute' if attr.empty?
       if attr[0].is_a? Array
         attr[0].each_with_index do |name, idx|
           self.set_key_pair(idx, name) if name
-          # if name
-          #   self.keys[idx] = name
-          #   attr_accessor name        
-          # end
         end
         
       elsif attr[0].is_a? Hash
         if attr[0].first[0].is_a? Integer
           attr[0].each do |idx, name|
             self.set_key_pair(idx, name)
-            # self.keys[idx] = name
-            # attr_accessor name
           end
         else
           attr[0].each do |name, idx|
             self.set_key_pair(idx, name)
-            # self.keys[idx] = name
-            # attr_accessor name
           end
         end
 
@@ -90,12 +95,13 @@ module Goodsheet
           if name
             name = name.to_s.gsub(" ", "_").to_sym unless name.is_a? Symbol
             self.set_key_pair(idx, name)
-            # self.keys[idx] = name
-            # attr_accessor name        
           end
         end
       end
 
+      if !self.defaults_attributes.nil?
+        self.set_defaults(self.defaults_attributes)
+      end
     end
 
 

data/lib/goodsheet/version.rb

@@ -1,3 +1,3 @@
 module Goodsheet
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/test/test_defaults.rb

@@ -0,0 +1,147 @@
+require 'test/unit'
+require 'goodsheet'
+
+class TestDefaults < Test::Unit::TestCase
+
+  def setup
+    filepath = File.dirname(__FILE__) + "/fixtures/for_defaults.xls"
+    @ss = Goodsheet::Spreadsheet.new(filepath, :skip => 1)
+  end
+
+
+
+  def test_invalid
+    res = @ss.read do
+      column_names 0 => :name, 1 => :number
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res.invalid?)
+
+    res = @ss.read do
+      column_names 0 => :name, 1 => :number
+      column_defaults 0 => "UNKNOWN"
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res.invalid?)
+
+    res = @ss.read do
+      column_names 0 => :name, 1 => :number
+      column_defaults 1 => 0.0
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res.invalid?)
+  end
+
+
+
+  def test_force_nil_vs_defaults
+    res = @ss.read(:force_nil => 0.0) do
+      column_names 0 => :name, 1 => :number
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res.valid?)
+    assert_equal(["Joshua Baney", "Libby Meiers", "Dean Murdoch", 0.0, "Esmeralda Erben"], res.values[:name])
+    assert_equal([3.0, 2.0, 0.0, 8.0, 1.0], res.values[:number])
+
+    res = @ss.read(:force_nil => "foo") do
+      column_names 0 => :name, 1 => :number
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res.invalid?)
+    assert_equal(["Joshua Baney", "Libby Meiers", "Dean Murdoch", "foo", "Esmeralda Erben"], res.values[:name])
+    assert_equal([3.0, 2.0, "foo", 8.0, 1.0], res.values[:number])
+
+
+    res = @ss.read(:force_nil => 1.0) do
+      column_names 0 => :name, 1 => :number
+      column_defaults 0 => "UNKNOWN", 1 => 10.0
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res.valid?)
+    assert_equal(["Joshua Baney", "Libby Meiers", "Dean Murdoch", "UNKNOWN", "Esmeralda Erben"], res.values[:name])
+    assert_equal([3.0, 2.0, 10.0, 8.0, 1.0], res.values[:number])
+  end
+
+
+
+  def test_values_correctness
+    res = @ss.read do
+      column_names 0 => :name, 1 => :number
+      column_defaults 0 => "UNKNOWN", 1 => 0.0
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res.valid?)
+    assert_equal(["Joshua Baney", "Libby Meiers", "Dean Murdoch", "UNKNOWN", "Esmeralda Erben"], res.values[:name])
+    assert_equal([3.0, 2.0, 0.0, 8.0, 1.0], res.values[:number])
+  end
+
+
+
+  def test_not_existing_column
+    res = @ss.read do
+      column_names 0 => :name, 1 => :number, 2 => :fake
+      column_defaults 0 => "UNKNOWN", 1 => 0.0
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res.valid?)
+    assert_equal([nil, nil, nil, nil, nil], res.values[:fake])
+
+    res = @ss.read do
+      column_names 0 => :name, 1 => :number, 2 => :fake
+      column_defaults 0 => "UNKNOWN", 1 => 0.0
+      validates :name, :presence => true
+      validates :number, :numericality => true
+      validates :fake, :presence => true
+    end
+    assert(res.invalid?)
+
+    res1 = @ss.read do
+      column_names 0 => :name, 1 => :number, 2 => :fake
+      column_defaults 0 => "UNKNOWN", 1 => 0.0, 2 => "EMPTY"
+      validates :name, :presence => true
+      validates :number, :numericality => true
+      validates :fake, :presence => true
+    end
+    assert(res1.valid?)
+  end
+
+
+
+  def test_column_defaults_formats
+    res_1 = @ss.read do
+      column_names :name, :number
+      column_defaults ["UNKNOWN", 0.0]
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res_1.valid?)
+
+    res_2 = @ss.read do
+      column_names :name, :number
+      column_defaults "UNKNOWN", 0.0
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res_2.valid?)
+    assert_equal(res_1.values, res_2.values)
+
+    res_3 = @ss.read do
+      column_names 0 => :name, 1 => :number
+      column_defaults 1 => 0.0, 0 => "UNKNOWN"
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res_3.valid?)
+    assert_equal(res_1.values, res_3.values)
+  end
+
+
+end

data/test/test_defaults_2.rb

@@ -0,0 +1,130 @@
+require 'test/unit'
+require 'goodsheet'
+
+# test the functionality of column_defaults macro, when used before column_names macro
+class TestDefaults < Test::Unit::TestCase
+
+  def setup
+    filepath = File.dirname(__FILE__) + "/fixtures/for_defaults.xls"
+    @ss = Goodsheet::Spreadsheet.new(filepath, :skip => 1)
+  end
+
+
+  def test_values_correctness
+    res = @ss.read do
+      column_defaults 0 => "UNKNOWN", 1 => 0.0
+      column_names 0 => :name, 1 => :number
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res.valid?)
+    assert_equal(["Joshua Baney", "Libby Meiers", "Dean Murdoch", "UNKNOWN", "Esmeralda Erben"], res.values[:name])
+    assert_equal([3.0, 2.0, 0.0, 8.0, 1.0], res.values[:number])
+  end
+
+
+  def test_invalid
+    res = @ss.read do
+      column_names 0 => :name, 1 => :number
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res.invalid?)
+
+    res = @ss.read do
+      column_defaults 0 => "UNKNOWN"
+      column_names 0 => :name, 1 => :number
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res.invalid?)
+
+    res = @ss.read do
+      column_defaults 1 => 0.0
+      column_names 0 => :name, 1 => :number
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res.invalid?)
+  end
+
+
+
+  def test_force_nil_vs_defaults
+    res = @ss.read(:force_nil => 1.0) do
+      column_defaults 0 => "UNKNOWN", 1 => 10.0
+      column_names 0 => :name, 1 => :number
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res.valid?)
+    assert_equal(["Joshua Baney", "Libby Meiers", "Dean Murdoch", "UNKNOWN", "Esmeralda Erben"], res.values[:name])
+    assert_equal([3.0, 2.0, 10.0, 8.0, 1.0], res.values[:number])
+  end
+
+
+
+
+
+
+  def test_not_existing_column
+    res = @ss.read do
+      column_defaults 0 => "UNKNOWN", 1 => 0.0
+      column_names 0 => :name, 1 => :number, 2 => :fake
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res.valid?)
+    assert_equal([nil, nil, nil, nil, nil], res.values[:fake])
+
+    res = @ss.read do
+      column_defaults 0 => "UNKNOWN", 1 => 0.0
+      column_names 0 => :name, 1 => :number, 2 => :fake
+      validates :name, :presence => true
+      validates :number, :numericality => true
+      validates :fake, :presence => true
+    end
+    assert(res.invalid?)
+
+    res1 = @ss.read do
+      column_defaults 0 => "UNKNOWN", 1 => 0.0, 2 => "EMPTY"
+      column_names 0 => :name, 1 => :number, 2 => :fake
+      validates :name, :presence => true
+      validates :number, :numericality => true
+      validates :fake, :presence => true
+    end
+    assert(res1.valid?)
+  end
+
+
+
+  def test_column_defaults_formats
+    res_1 = @ss.read do
+      column_defaults ["UNKNOWN", 0.0]
+      column_names :name, :number
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res_1.valid?)
+
+    res_2 = @ss.read do
+      column_defaults "UNKNOWN", 0.0
+      column_names :name, :number
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res_2.valid?)
+    assert_equal(res_1.values, res_2.values)
+
+    res_3 = @ss.read do
+      column_defaults 1 => 0.0, 0 => "UNKNOWN"
+      column_names 0 => :name, 1 => :number
+      validates :name, :presence => true
+      validates :number, :numericality => true
+    end
+    assert(res_3.valid?)
+    assert_equal(res_1.values, res_3.values)
+  end
+
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goodsheet
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Iwan Buetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,16 @@ dependencies:
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.14
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.14
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: google_drive
   requirement: !ruby/object:Gem::Requirement
@@ -96,6 +96,7 @@ files:
 - goodsheet.gemspec
 - img/img_01.png
 - lib/goodsheet.rb
+- lib/goodsheet/aux.rb
 - lib/goodsheet/exceptions.rb
 - lib/goodsheet/read_result.rb
 - lib/goodsheet/row.rb
@@ -106,12 +107,15 @@ files:
 - notes.txt
 - test/fixtures/example.xls
 - test/fixtures/fixtures_template.xlsx
+- test/fixtures/for_defaults.xls
 - test/fixtures/ss_01.xls
 - test/fixtures/ss_02.csv
 - test/fixtures/ss_02.ods
 - test/fixtures/ss_02.xls
 - test/fixtures/ss_02.xlsx
 - test/fixtures/ss_04.xlsx
+- test/test_defaults.rb
+- test/test_defaults_2.rb
 - test/test_row.rb
 - test/test_spreadsheet_01.rb
 - test/test_spreadsheet_02.rb
@@ -143,12 +147,15 @@ summary: Extract and validate data from a spreadsheet
 test_files:
 - test/fixtures/example.xls
 - test/fixtures/fixtures_template.xlsx
+- test/fixtures/for_defaults.xls
 - test/fixtures/ss_01.xls
 - test/fixtures/ss_02.csv
 - test/fixtures/ss_02.ods
 - test/fixtures/ss_02.xls
 - test/fixtures/ss_02.xlsx
 - test/fixtures/ss_04.xlsx
+- test/test_defaults.rb
+- test/test_defaults_2.rb
 - test/test_row.rb
 - test/test_spreadsheet_01.rb
 - test/test_spreadsheet_02.rb