goodsheet 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 857c86e4b9ce1ab63a12d69a98a89194374731c8
-  data.tar.gz: 6bc6c520ab684b0933288c25db1d389c1aa221de
+  metadata.gz: ba007929170fe7d6e80af781d6a20132018238f0
+  data.tar.gz: 97ae8e3fd6e1c83656d138a532cfa8177486da57
 SHA512:
-  metadata.gz: 7e93e30871d1548a6f71fd969f1cde562ab99564045f29a79108ebfc191e73f53a23b830769d9c29a286028ba6c6d27c88cb3485f7846f86ddb3b61c709ce867
-  data.tar.gz: 8cbded3dfb2890d91799a872d7d3b0489aec4bfaa55abe549a89321c331f30c83ed7c11a8db6b5422958d2318c08db1dcee92aacb0a476538f0443d519cece94
+  metadata.gz: d10c109430d18557c4fbd823755290ab1fc6361f2e9305de87e10896aa9bda9c5322e954969ec0991243e7921a45dc46d44f34485811ccc87506888921f006fd
+  data.tar.gz: 9ec851827a5c6a67e83dfadeb5036626b4f29aef8e5953a841860f5216275a453e690a81196d37e3dc10fe6eeb26e49a993e71bd43fe02aa0387c67e4a545e47

data/README.md

@@ -24,24 +24,56 @@ Or install it yourself as:
 
 ### Getting started
 
+Given a spreadsheet:
+![Spreadsheet](https://raw.github.com/iwan/goodsheet/master/img/img_01.png)
+
 ```ruby
-ss = Goodsheet::Spreadsheet.new("my_data.xlsx")
+ss = Goodsheet::Spreadsheet.new("example.xls")
 res = ss.read do
-  column_names :a => 0, :b => 1
-  validates :a, :presence => true, :numericality => { :greater_than_or_equal_to => 0.0, :less_than_or_equal_to => 10 }
-  validates :b, :presence => true, :numericality => { :greater_than_or_equal_to => 0.0, :less_than_or_equal_to => 100 }
+  column_names :filename => 0, :size => 1, :created_at => 3, :updated_at => 4 # ignore 'description' column
+  validates :filename, :presence => true
+  validates :size, :presence => true, :numericality => { :greater_than_or_equal_to => 0.0 }
+  validate :order_of_dates
+
+  def order_of_dates
+    if created_at > updated_at
+      errors.add(:updated_at, "cannot be before creation date")
+    end
+  end
 end
+```
 
+If validation is successfull the spreadsheet will be readed and his content retrieved:
+```ruby
 res.valid? # => true
-res.values # => {:a => [1.0, 1.0, 1.4], :b => [0.0, 3.7, 10.9]}
+res.values # => {:filename=>["img_01.jpg", "img_17.jpg", "img_56.jpg"], :size=>[123854.0, 278333.0, 529639.0], :created_at=>[#<Date: 2013-03-03 ((2456355j,0s,0n),+0s,2299161j)>, ...], ...}
+```
+
+Alternatively you can get the result values by rows:
+```ruby
+res.values(:rows_array) # => [["img_01.jpg", 123854.0, #<Date: 2013-03-03 ((2456355j,0s,0n),+0s,2299161j)>, #<Date: 2013-03-31 ((2456383j,0s,0n),+0s,2299161j)>], ["img_17.jpg", 278333.0, #<Date: 2013-05-03 ...], ...]
+
+res.values(:rows_hash) # => [{:filename=>"img_01.jpg", :size=>123854.0, :created_at=>#<Date: 2013-03-03 ((2456355j,0s,0n),+0s,2299161j)>, :updated_at=>#<Date: 2013-03-31 ((2456383j,0s,0n),+0s,2299161j)>}, {:filename=>"img_17.jpg", :size=>278333.0, ...}, ... ]
+```
+
+If validation fails the spreadsheet will not be readed:
+```ruby
+res.valid? # => false
+res.errors.size # => 1
+res.errors.to_a.first # => "Row 3 is invalid: Filename can't be blank"
+res.values # => {}
 ```
 
 By default:
 * the first sheet is selected
 * one line (the first) is skipped (i'm expeting that is the header line)
-* the content is returned as an hash of columns
 
-Pass your validation rules into the block passed to the read method, together with the column_names method that define the position (or index) and the name of the columns you want to read.
+You can also invoke `validate` instead of `read` method (see below).
+A validation will be always executed before the extraction (reading) of data. If validation fails the reading will not be performed.
+
+The definition of columns you want to read (through the `column_names` method) and the rules for validation are defined inside the block you pass to `read` or `validate` method.
+
+
 
 ### More on usage
 
@@ -58,16 +90,17 @@ ss.size # => 4
 ss.sheets # => ["Sheet1", "Sheet2", "Sheet3", "Sheet4"]
 ```
 
-When you init a new spreadsheet, you select a sheet or you invoke `validate` or `read` method, you can pass an hash of options.
+An hash of options can be passed to spreadsheet initializer `Goodsheet::Spreadsheet.new`, to `sheet` selection, to `validate` or `read` method. The first one define validation/reading rules for all sheets, but these can be overwritten by sheet and `validate`/`read`.
+
 ```ruby
 ss = Goodsheet::Spreadsheet.new("my_data.xlsx", :skip => 1, :header_row => 0, :max_errors => 0, :row_limit => 0, :force_nil => nil )
 ```
 These are the valid options with their default values:
-- `:skip` allow to skip a desired number of lines when you read or validate a sheet 
-- with `:header_row` you define the index of the header row
-- with `:max_errors` you define the maximum number of errors after the validation break
-- with `:row_limit` you define the maximum number of row you wanto to read or validate
-- with `:force_nil` you can specify the value to set when a cell hold a nil value (is empty)
+- `:skip` allow to skip a desired number of lines when you read or validate a sheet (1)
+- with `:header_row` you define the index of the header row (0)
+- with `:max_errors` you define the maximum number of errors after the validation break (0: no limit)
+- with `:row_limit` you define the maximum number of row you wanto to read or validate (0: no limit)
+- with `:force_nil` you can specify the value to set when a cell hold a nil value (is empty) (still nil)
 
 As said you can use the same option when selecting a sheet
 ```ruby
@@ -95,7 +128,7 @@ ss.rows_wo_skipped # => except the skipped ones, aliased by `rows` method
 
 Use the `validate` and `read` methods to perform validation and reading. Note that the reading function include a validation call.
 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:
+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):
 - `column_names :a => 0, :b => 1, :c => 3`
 - `column_names 0 => :a, 1 => :b, 3 => :c`
 - `column_names [:a, :b, nil, :c]`

data/lib/goodsheet.rb

@@ -4,9 +4,9 @@ module Goodsheet
   autoload :Row,                'goodsheet/row'
   autoload :SheetNotFoundError, 'goodsheet/exceptions'
   autoload :ReadResult,         'goodsheet/read_result'
-  autoload :Row,                'goodsheet/row'
   autoload :Spreadsheet,        'goodsheet/spreadsheet'
   autoload :ValidationError,    'goodsheet/validation_error'
   autoload :ValidationErrors,   'goodsheet/validation_errors'
   autoload :Version,            'goodsheet/version'
 end
+

data/lib/goodsheet/read_result.rb

@@ -16,13 +16,14 @@ module Goodsheet
       !valid?
     end
 
-    def add(attribute, row, force_nil=nil)
+    def add(attribute, row)
       attribute = attribute.to_sym
-      (@vv[attribute] ||= []) << (row.send(attribute) || force_nil)
+      (@vv[attribute] ||= []) << row.send(attribute)
     end
 
     def values(format=:columns)
-      values_size = @vv.values.first.size
+      values_size = 0
+      values_size = @vv.values.first.size if @vv.values.first
 
       case format
       when :columns

data/lib/goodsheet/row.rb

@@ -12,10 +12,10 @@ module Goodsheet
     end
     @keys = {} # idx => key
 
-    def initialize(arr)
+    def initialize(arr, nil_value=nil)
       arr.each_with_index do |v, idx|
         if k = self.class.keys[idx]
-          send("#{k}=", v)       
+          send("#{k}=", v || nil_value)       
         end
       end
       super()

data/lib/goodsheet/spreadsheet.rb

@@ -110,20 +110,18 @@ module Goodsheet
     # @yield Column settings and validation rules
     # @return [ValidationErrors] Validation errors
     def validate(options={}, &block)
-      # set_current_sheet_options(options)
       skip = options[:skip] || @s_opts[index][:skip]
       header_row = options[:header_row] || @s_opts[index][:header_row]
       max_errors = options[:max_errors] || @s_opts[index][:max_errors]
       row_limit = options[:row_limit] || @s_opts[index][:row_limit]
       force_nil = options[:force_nil] || @s_opts[index][:force_nil]
-
       validation_errors = ValidationErrors.new
 
       my_class = options[:my_custom_row_class] || build_my_class(block)
 
       line = @s_opts[index][:skip] # 0-based, from the top
       @ss.parse[@s_opts[index][:skip]..-1].each do |row| # row is an array of elements
-        validation_errors.add(line, my_class.new(row))
+        validation_errors.add(line, my_class.new(row, force_nil))
         break if max_errors>0 && validation_errors.size >= max_errors
         break if row_limit && row_limit>0 && line>=(row_limit+@s_opts[index][:skip]-1)
         line +=1
@@ -157,7 +155,7 @@ module Goodsheet
       line = skip # 0-based, from the top
       @ss.parse[skip..-1].each do |row| # row is an array of elements
         my_class.row_attributes.each do |attribute|
-          read_result.add(attribute, my_class.new(row), force_nil)
+          read_result.add(attribute, my_class.new(row, force_nil))
         end
         break if row_limit && row_limit>0 && line>=(row_limit + skip - 1)
         line +=1
@@ -169,7 +167,8 @@ module Goodsheet
     private
 
     def build_my_class(block)
-      Object.const_set get_custom_row_class_name, Row.inherit(block)
+      n = get_custom_row_class_name
+      Object.const_set n, Row.inherit(block)
     end
 
     def select_sheet_options(idx)
@@ -194,10 +193,6 @@ module Goodsheet
       "CustRow_#{(Time.now.to_f*(10**10)).to_i}"
     end
 
-    def set_current_sheet_options(options)
-      set_sheet_options(index, options)
-    end
-
     def set_sheet_options(idx, options)
       i = idx.is_a?(Integer) ? idx : @ss.sheets.index(idx)
       @s_opts[i] = {

data/lib/goodsheet/validation_error.rb

@@ -7,7 +7,8 @@ module Goodsheet
     end
     
     def to_s
-      "Row #{@line} is invalid for the following reason(s): #{@val_err.full_messages.join(', ')}"
+      # "Row #{@line} is invalid for the following reason(s): #{@val_err.full_messages.join(', ')}"
+      "Row #{@line} is invalid: #{@val_err.full_messages.join(', ')}"
     end
   end
 end

data/lib/goodsheet/validation_errors.rb

@@ -36,5 +36,9 @@ module Goodsheet
         yield(i)
       end
     end
+
+    def valid?
+      empty?
+    end
   end
 end

data/lib/goodsheet/version.rb

@@ -1,3 +1,3 @@
 module Goodsheet
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/test/test_spreadsheet_01.rb

@@ -9,12 +9,12 @@ class TestSpreadsheet_01 < Test::Unit::TestCase
   end
 
   def test_sheets
-    assert_equal(%w(Sheet1 Sheet2 Sheet3 Sheet4), @ss.sheets)
+    assert_equal(%w(Sheet1 Sheet2 Sheet3 Sheet4 Sheet5), @ss.sheets)
   end
 
   def test_failed_sheet_selection
     assert_raise Goodsheet::SheetNotFoundError do
-      @ss.sheet(4)
+      @ss.sheet(14)
     end
     assert_raise Goodsheet::SheetNotFoundError do
       @ss.sheet("Sheet999")
@@ -36,6 +36,9 @@ class TestSpreadsheet_01 < Test::Unit::TestCase
 
     @ss.sheet(3)
     assert_equal("Sheet4", @ss.name)    
+
+    @ss.sheet(4)
+    assert_equal("Sheet5", @ss.name)    
   end
 
   def test_get_header_wo_options
@@ -105,7 +108,7 @@ class TestSpreadsheet_01 < Test::Unit::TestCase
   end
 
   def test_size
-    assert_equal(4, @ss.size)
+    assert_equal(5, @ss.size)
   end
 
   def test_options_precedence
@@ -126,6 +129,8 @@ class TestSpreadsheet_01 < Test::Unit::TestCase
     assert_equal({:skip=>1, :header_row=>0, :max_errors=>0, :row_limit=>0, :force_nil=>nil}, @ss.options)
   end
 
+
+
   def test_read_sheet4
     @ss.sheet(3)
 
@@ -135,11 +140,11 @@ class TestSpreadsheet_01 < Test::Unit::TestCase
       validates :price, :presence => true, :numericality => { :greater_than_or_equal_to => 0.0 }
       validates :tot, :presence => true, :numericality => { :greater_than_or_equal_to => 0.0 }      
     end
+    assert_equal([:qty, :price, :tot], result.values.keys)
     assert_equal(3, result.values.size)
     result.values.each do |k, vv|
       assert_equal(5, vv.size)
     end
-    assert_equal([:qty, :price, :tot], result.values.keys)
 
 
 

data/test/test_spreadsheet_03.rb

@@ -1,9 +1,45 @@
-# test_spreadsheet_01.rb
+# test_spreadsheet_03.rb
+
+# ruby -I lib test/test_spreadsheet_03.rb
 
 require 'test/unit'
 require 'goodsheet'
 
 class TestSpreadsheet_03 < Test::Unit::TestCase
 
+  def setup
+    filepath = File.dirname(__FILE__) + "/fixtures/ss_01.xls"
+    @ss = Goodsheet::Spreadsheet.new(filepath)
+  end
+
+  def test_validation_with_nil_values
+    @ss.sheet(4) # "Sheet5"
+    result = @ss.validate do
+      column_names 0 => :qty, 1 => :price, 2 => :tot
+      validates :qty, :price, :tot, numericality: true
+    end
+    assert(!result.valid?)
+
+    result = @ss.validate(:force_nil => 0.0) do
+      column_names 0 => :qty, 1 => :price, 2 => :tot
+      validates :qty, :price, :tot, numericality: true
+    end
+    assert(result.valid?)
+  end
+
+  def test_reading_with_nil_values
+    @ss.sheet(4) # "Sheet5"
+    result = @ss.read do
+      column_names 0 => :qty, 1 => :price, 2 => :tot
+      validates :qty, :price, :tot, numericality: true
+    end
+    assert(!result.valid?)
+
+    result = @ss.read(:force_nil => 0.0) do
+      column_names 0 => :qty, 1 => :price, 2 => :tot
+      validates :qty, :price, :tot, numericality: true
+    end
+    assert(result.valid?)
+  end 
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goodsheet
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Iwan Buetti
@@ -94,6 +94,7 @@ files:
 - README.md
 - Rakefile
 - goodsheet.gemspec
+- img/img_01.png
 - lib/goodsheet.rb
 - lib/goodsheet/exceptions.rb
 - lib/goodsheet/read_result.rb
@@ -103,6 +104,7 @@ files:
 - lib/goodsheet/validation_errors.rb
 - lib/goodsheet/version.rb
 - notes.txt
+- test/fixtures/example.xls
 - test/fixtures/fixtures_template.xlsx
 - test/fixtures/ss_01.xls
 - test/fixtures/ss_02.csv
@@ -139,6 +141,7 @@ signing_key:
 specification_version: 4
 summary: Extract and validate data from a spreadsheet
 test_files:
+- test/fixtures/example.xls
 - test/fixtures/fixtures_template.xlsx
 - test/fixtures/ss_01.xls
 - test/fixtures/ss_02.csv