goodsheet 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a61094f40016b3c32594b97b5d3e134c4b59016
-  data.tar.gz: 5fc1f3d8bbbdeaf1efafbceeb2610296004bce86
+  metadata.gz: 857c86e4b9ce1ab63a12d69a98a89194374731c8
+  data.tar.gz: 6bc6c520ab684b0933288c25db1d389c1aa221de
 SHA512:
-  metadata.gz: 0ff578441474684622d97d9e7481abb007783c6ee0fb302689377c081eff0662dda889766140dbe0d51e7b99d0e9ba0e0846deb7463c0df85994fe6a8c5a3d07
-  data.tar.gz: 50dcf983da1e79799d313366c47369d0b8569aad10ff6a9312ceae7c4eeae8d5b0229ef0b49dc30dda941434e315214450349a8c2723feb699272e5eb98c21dc
+  metadata.gz: 7e93e30871d1548a6f71fd969f1cde562ab99564045f29a79108ebfc191e73f53a23b830769d9c29a286028ba6c6d27c88cb3485f7846f86ddb3b61c709ce867
+  data.tar.gz: 8cbded3dfb2890d91799a872d7d3b0489aec4bfaa55abe549a89321c331f30c83ed7c11a8db6b5422958d2318c08db1dcee92aacb0a476538f0443d519cece94

data/README.md

@@ -39,6 +39,7 @@ res.values # => {:a => [1.0, 1.0, 1.4], :b => [0.0, 3.7, 10.9]}
 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.
 
@@ -81,7 +82,7 @@ end
 
 Get the content of header row:
 ```ruby
-ss.header_row # => ["year", "month", "day"]
+ss.get_header # => ["year", "month", "day"]
 ```
 
 Get the number of rows:
@@ -94,16 +95,17 @@ 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 3 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:
 - `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`
 
 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)
 
 
-Another example:
+Here another example:
 ```ruby
 ss = Goodsheet::Spreadsheet.new("my_data.xlsx")
 ss.sheet(1, :max_errors => 50, :force_nil => 0.0)
@@ -121,12 +123,49 @@ res = ss.read do
     end
   end
 end
+
+res.valid?
+```
+
+If validation fails you get `false` on `res.valid?` call, and you retrieve an array with errors by calling `errors` method on result object:
+If validation fails you can retrieve the errors array by calling `errors` method on result object:
+
+```ruby
+res.valid? # => false
+res.invalid? # => true
+res.errors # => a ValidationErrors object
+res.errors.size # => 1
+res.errors[0].to_s # => "Row 5 is invalid for the following reason(s): Year is not a number, Month is not a number"
+```
+
+If the validation ends successfully without errors, the result values are available using one of these three forms:
+- hash of columns (default)
+- array of rows, where the rows are array
+- array of rows, where the rows are hashes
+
+
+```
++------+-------+
+| year | month |
++------+-------+
+| 2012 |    1  |
++------+-------+
+| 2012 |    2  |
++------+-------+
+| 2012 |    3  |
++------+-------+
 ```
 
+```ruby
+res.values # => { :year => [2012, 2012, 2012], :month => [1, 2, 3]}
+res.values(:columns) # same as the previous 
+res.values(:rows_array) # => [[2012, 1], [2012, 2], [2012, 3]]
+res.values(:rows_hash) # => [{:year => 2012, :month => 1}, {:year => 2012, :month => 2}, {:year => 2012, :month => 3}]
+```
 
 
 
-Warning:
+Note:
 * integer numbers are converted to float numbers. Also don't pretend to obtain an integer in validation. This undesired behaviour depend on Roo gem
 * if you import data from a CSV spreadsheet keep in mind that numbers are readed as strings
 

data/lib/goodsheet/read_result.rb

@@ -1,11 +1,11 @@
 module Goodsheet
   
   class ReadResult
-    attr_reader :values
+    attr_reader :vv, :errors
 
     def initialize(errors=ValidationErrors.new)
       @errors = errors
-      @values = {}
+      @vv = {}
     end
 
     def valid?
@@ -18,11 +18,30 @@ module Goodsheet
 
     def add(attribute, row, force_nil=nil)
       attribute = attribute.to_sym
-      (@values[attribute] ||= []) << (row.send(attribute) || force_nil)
+      (@vv[attribute] ||= []) << (row.send(attribute) || force_nil)
     end
 
-    def errors
-      @errors.array
+    def values(format=:columns)
+      values_size = @vv.values.first.size
+
+      case format
+      when :columns
+        @vv
+
+      when :rows_array
+        Array.new(values_size) do |i1|
+          Array.new(@vv.size) do |i2|
+            @vv[@vv.keys[i2]][i1]
+          end
+        end
+
+      when :rows_hash
+        Array.new(values_size) do |i1|
+          hh = {}
+          @vv.keys.each{|k| hh[k] = @vv[k][i1] }
+          hh
+        end
+      end
     end
   end
 end

data/lib/goodsheet/row.rb

@@ -30,37 +30,47 @@ module Goodsheet
     end
 
     # Define the position (or index) and the name of columns.
-    # There are available three mode to define them:
-    # using an hash index to name (like { 0 => :year, 2 => :day }) 
-    # or name to index (like { :year => 0, :day => 2 }) or using an array
+    # You have four ways to define them: 
+    # using an hash index-to-name (like { 0 => :year, 2 => :day }) 
+    # or its reversed version name-to-index (like { :year => 0, :day => 2 }), using an array
     # with the names at desired positions (like [:year, nil, :day]), put a nil
-    # at the position 
+    # at the position, or simply put the list of names.
     # The positions are 0-based.
-    def self.column_names(param)
+    def self.column_names(*attr)
+    # def self.column_names(param)
       @keys = {}
-      if param.is_a? Hash
-        if param.first[0].is_a? Integer
-          param.each do |idx, name|
+      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|
+          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.keys[idx] = name
             attr_accessor name
           end
         else
-          param.each do |name, idx|
+          attr[0].each do |name, idx|
             self.keys[idx] = name
             attr_accessor name
           end
         end
-      elsif param.is_a? Array
-        param.each_with_index do |name, idx|
+
+      else
+        attr.each_with_index do |name, idx|
           if name
+            name = name.to_s.gsub(" ", "_").to_sym unless name.is_a? Symbol
             self.keys[idx] = name
             attr_accessor name        
           end
         end
-
-      else
-        raise "parameter non valid"
       end
+
     end
 
 

data/lib/goodsheet/spreadsheet.rb

@@ -4,7 +4,7 @@ module Goodsheet
 
   class Spreadsheet < Roo::Spreadsheet
     attr_reader :skip, :header_row, :max_errors, :row_limit
-    attr_reader :s_opts
+    attr_reader :s_opts, :ss
 
     # Initialize a Goodsheet object. The first sheet will be selected.
     #

data/lib/goodsheet/validation_error.rb

@@ -7,7 +7,7 @@ module Goodsheet
     end
     
     def to_s
-      "line #{@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(', ')}"
     end
   end
 end

data/lib/goodsheet/validation_errors.rb

@@ -22,5 +22,19 @@ module Goodsheet
     def to_s
       @array.to_s
     end
+
+    def [](i)
+      @array[i]
+    end
+    
+    def to_a
+      @array
+    end
+
+    def each(&block)
+      @array.each do |i|
+        yield(i)
+      end
+    end
   end
 end

data/lib/goodsheet/version.rb

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

data/test/test_row.rb

@@ -4,17 +4,22 @@ require 'goodsheet'
 class TestRow < Test::Unit::TestCase
 
   def test_column_names
-    assert_raise RuntimeError do
+    assert_raise ArgumentError do
+      Goodsheet::Row.column_names
+    end
+    assert_raise NameError do
       Goodsheet::Row.column_names(6)
     end
 
+    Goodsheet::Row.column_names(:a, nil, :b, :c)
+    assert_equal(Goodsheet::Row.keys, {0 => :a, 2 => :b, 3 => :c})
+
     Goodsheet::Row.column_names([:a, nil, :b, :c])
     assert_equal(Goodsheet::Row.keys, {0 => :a, 2 => :b, 3 => :c})
 
     Goodsheet::Row.column_names(:a => 0, :b => 2, :c => 3)
     assert_equal(Goodsheet::Row.keys, {0 => :a, 2 => :b, 3 => :c})
 
-
     Goodsheet::Row.column_names(0 => :a, 2 => :b, 3 => :c)
     assert_equal(Goodsheet::Row.keys, {0 => :a, 2 => :b, 3 => :c})
   end

data/test/test_spreadsheet_01.rb

@@ -168,4 +168,26 @@ class TestSpreadsheet_01 < Test::Unit::TestCase
 
   end
 
+  def test_result_formats
+    result = @ss.read do
+      column_names :a, :b, :c, :d
+    end
+    y = { 
+      :a=>[2012.0, 2012.0, 2012.0, 2013.0], 
+      :b=>["F", "F", "G", "F"], 
+      :c=>[3.1, 2.5, 0.0, 0.78], 
+      :d=>[4.1, 3.5, 1.0, 1.78]
+    }
+    values_size = y.values.first.size
+
+    assert_equal(y, result.values)
+    assert_equal(y, result.values(:columns))
+
+    y = [[2012.0, "F", 3.1, 4.1], [2012.0, "F", 2.5, 3.5], [2012.0, "G", 0.0, 1.0], [2013.0, "F", 0.78, 1.78]]
+    assert_equal(y, result.values(:rows_array))
+
+    y = [{:a=>2012.0, :b=>"F", :c=>3.1, :d=>4.1}, {:a=>2012.0, :b=>"F", :c=>2.5, :d=>3.5}, {:a=>2012.0, :b=>"G", :c=>0.0, :d=>1.0}, {:a=>2013.0, :b=>"F", :c=>0.78, :d=>1.78}]
+    assert_equal(y, result.values(:rows_hash))
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goodsheet
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Iwan Buetti