spreadsheet_importer 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d394ba8cad7df71a772ef15e3011d6ae1966c9d
+  data.tar.gz: 431c1654b821b4a53537da0262d0a1c7256ca180
+SHA512:
+  metadata.gz: 5451b7aba04813c408a5204922bf8291f1211aec11a0b9add3397b6a738b28c858dec3f6ebcbbd9f0a316dae0a38f37387bcb2d15ea179400014e6a76366ad51
+  data.tar.gz: d5aa427e390905dcfe84b44d09b1414cc3665760b920c4c82a453c5edb444353592ebc95203dda35d1f35735d4909d367ae6927b270fa037bd7cc4a204eaee18

data/README.md

@@ -1,3 +1,32 @@
-= SpreadsheetImporter
+# SpreadsheetImporter
 
-This project rocks and uses MIT-LICENSE.
+```ruby
+gem 'spreadsheet_importer'
+```
+
+
+## Usage
+```ruby
+  SpreadsheetImporter::Import.from_spreadsheet(spreadsheet) do |row|
+    # Do some work on the row
+  end
+
+  # Starting at a custom offset
+  SpreadsheetImporter::Import.from_spreadsheet(spreadsheet, :start_row => 5) do |row|
+```
+
+### 2D Array
+```ruby
+  SpreadsheetImporter::Import.from_spreadsheet([["Bob", "Hoskins"], ["Roger", "Rabbit"]])
+```
+
+### CSV
+```ruby
+  SpreadsheetImporter::Import.from_csv("users.csv")
+```
+
+### .xlsx
+```
+  SpreadsheetImporter::Import.from_xlsx("users.xlsx")
+  SpreadsheetImporter::Import.from_xlsx("users.xlsx", :sheet_name => '2015') # Processing a single sheet
+```

data/lib/spreadsheet_importer.rb

@@ -1,6 +1,5 @@
 # GEMS
 require 'roo'
-require 'conformist'
 require 'charlock_holmes'
 
 # LIB

data/lib/spreadsheet_importer/import.rb

@@ -22,33 +22,81 @@ module SpreadsheetImporter
       # Determine whether the column separator is a tab or comma
       col_sep = csv.count("\t") > 0 ? "\t" : ","
 
-      spreadsheet = CSV.parse(csv, :col_sep => col_sep, :headers => true, :header_converters => :downcase)
+      spreadsheet = CSV.parse(csv, :col_sep => col_sep, :headers => true, :header_converters => :downcase).to_a
       from_spreadsheet(spreadsheet, options, &block)
     end
 
+    # Returns 2D array of the spreadsheet, rows by columns
+    # If a block is given, yields each row to the block
+    # Exceptions during the iteration will collected along with their row number
+    # and re-raised at the end of processing
     def self.from_spreadsheet(spreadsheet, options = {}, &block)
       options = {:start_row => 1, :schema => nil}.merge(options)
 
-      (options[:start_row] - 1).times { spreadsheet.shift } # Remove intro rows
-      spreadsheet = options[:schema].conform(spreadsheet) if options[:schema] # If a Conformist schema is provided, use that to prepare rows
+      # Remove intro rows
+      (options[:start_row] - 1).times { spreadsheet.shift }
 
+      headers = spreadsheet.first
+      if options[:required_columns]
+        assert_required_columns!(headers, options[:required_columns])
+      end
+
+      if options[:schema] # If a Conformist schema is provided, use that to prepare rows
+        rows = options[:schema].conform(spreadsheet, :skip_first => true)
+      else
+        rows = spreadsheet
+      end
+
+      # Create an enumerator the standardizes the output from conformist or 2D array spreadsheet
       errors = []
-      rowcount = 0
-      spreadsheet.each do |row|
-        rowcount += 1
-        begin
-          block.call(row)
-          print '.'
-        rescue => e
-          progress_indicator = '!'
-          errors << "Row #{rowcount}: #{e.message}"
-          print '!'
+      spreadsheet = Spreadsheet.new do |yielder|
+        row_number = options[:start_row]
+        rows.each_with_index do |row, index|
+          begin
+            yielder.yield row_to_attributes(row, headers), index, row_number
+          rescue => e
+            errors << "Row #{row_number}: #{e.message}\n#{e.backtrace.join("\n")}"
+          end
+          row_number += 1
         end
       end
+      spreadsheet.errors = errors
+      spreadsheet.each(&block) if block_given?
+
+      return spreadsheet
+    end
+
+    private
+
+    def self.assert_required_columns!(headers, required_columns)
+      required_columns.each do |column_name|
+        raise MissingRequiredColumn, "Spreadsheet must include a '#{column_name}' column" unless column_present?(headers, column_name)
+      end
+    end
 
-      rowcount += options[:start_row] if rowcount > 0
+    def self.column_present?(headers, column_name)
+      headers.collect{|c| c.downcase.squish}.include?(column_name.downcase.squish)
+    end
 
-      return {:imported => rowcount - errors.count, :errors => errors, :total => rowcount}
+    # Returns an attributes hash for the given row
+    def self.row_to_attributes(row, headers)
+      case row
+      when Array
+        Hash[ItemSchema.attribute_names(headers).zip(row)]
+      else # Handle Conformist::HashStruct rows
+        row.attributes
+      end
     end
+
   end
+
+  # Spreadsheet
+
+  class Spreadsheet < Enumerator
+    attr_accessor :errors
+  end
+
+  # EXCEPTIONS
+
+  class MissingRequiredColumn < StandardError; end
 end

data/lib/spreadsheet_importer/version.rb

@@ -1,3 +1,3 @@
 module SpreadsheetImporter
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spreadsheet_importer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - Nicholas Jakobsen
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: culturecode-roo
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -31,7 +28,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: charlock_holmes
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
@@ -39,7 +35,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
@@ -52,35 +47,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/spreadsheet_importer/import.rb
-- lib/spreadsheet_importer/version.rb
-- lib/spreadsheet_importer.rb
 - MIT-LICENSE
-- Rakefile
 - README.md
+- Rakefile
+- lib/spreadsheet_importer.rb
+- lib/spreadsheet_importer/import.rb
+- lib/spreadsheet_importer/version.rb
 homepage: https://github.com/culturecode/spreadsheet_importer
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.4.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Makes it easy to import spreadsheets.
 test_files: []