xls_porter 0.0.7

data/lib/xls_porter.rb

@@ -0,0 +1,133 @@
+module XlsPorter
+
+  class XlsUploader < CarrierWave::Uploader::Base
+    include CarrierWave::MimeTypes
+    process :set_content_type
+
+    # Include the Sprockets helpers for Rails 3.1+ asset pipeline compatibility:
+    include Sprockets::Helpers::RailsHelper
+    include Sprockets::Helpers::IsolatedHelper
+
+    # Choose what kind of storage to use for this uploader:
+    storage :file
+    # storage :fog
+
+    # Override the directory where uploaded files will be stored.
+    # This is a sensible default for uploaders that are meant to be mounted:
+    def store_dir
+      "#{Rails.root}/tmp/upload/"
+    end
+
+    # Override the filename of the uploaded files:
+    # Avoid using model.id or version_name here, see uploader/store.rb for details.
+    # def filename
+    #   "something.jpg" if original_filename
+    # end
+
+    def extension_white_list
+      known=%w(xls xlsx)
+      known << /\w+/
+    end
+  end
+
+  def to_xls(list, columns, name)
+    book = Spreadsheet::Workbook.new
+    sheet = book.create_worksheet :name => name
+    row = sheet.row(0)
+    columns.each {|column| row.push(column)}
+    idx = 0
+    list.each do |it|
+      row = sheet.row(idx += 1)
+      columns.each {|column| row.push(it[column])}
+    end
+    return book
+  end
+
+  def model_to_xls(model)
+    to_xls(model.all, model.column_names, model.name)
+  end
+
+  # sanitize and prefix filename with timestamp
+  # store the uploaded file
+  def store_uploaded_file(uploaded_file)
+    uploaded_file.original_filename = "#{Time.now.to_i}_#{File.basename(uploaded_file.original_filename)}"
+    file = XlsUploader.new
+    file.store!(uploaded_file)
+    return file
+  end
+
+  def xls_to_model(xls_file_path, model, ignore=[])
+    #TODO exception handling
+
+    book = Spreadsheet.open(xls_file_path)
+    sheet = book.worksheet(0)
+    columns = sheet.row(0)
+    ignore_columns = (columns - model.column_names) + ignore
+    id_idx = columns.find_index("id")
+    updates = []
+    # Read each row, skip the first (column names)
+    sheet.each 1 do |row|
+      id = row[id_idx]
+      record = nil
+      if id.nil?
+        record = model.new
+        record["update"] = "new"
+      else
+        begin
+          record = model.find(id)
+          record["update"] = "exist"
+        rescue
+          record = model.new
+          record["update"] = "new"
+        end
+      end
+      (0..(columns.size - 1)).each do |i|
+        value = row[i]
+        value = value.strip if value.is_a?(String)
+        column = columns[i]
+        if column == "id" and record["update"] == "new"
+          record["id"] = value
+        elsif ignore_columns.include?(column)
+          #skip if column is ignored
+        elsif record[column].blank? and value.blank?
+          #skip if both are either nil or empty
+        elsif [DateTime, Time, Date].include?(value.class)
+          #puts "#{column} #{record[column]} == #{value} ? #{record[column].to_i == value.to_i}"
+          #TODO comparator and assigner for date types
+        else
+          if record[column] != value
+            record[column] = value
+            record["update"] = "updated" if record["update"] == "exist"
+            record["update_notes"] = [] if record["update_notes"].nil?
+            record["update_notes"] << column
+          end
+        end
+      end
+      #track all updates
+      updates << record if %w(new updated).include?(record["update"]) #not record.changed.empty?
+    end
+    #commit changes only after processing all updates
+    updates.each do |update|
+      begin
+        update.save
+      rescue Exception => exception
+        #track validation exception
+        update["update"] = "exception"
+        update["update_notes"] = exception.to_s
+      end
+    end
+    return {:columns => (%w(update update_notes) + columns), :updates => updates, :model => model.name}
+  end
+
+  def cleanup_tmp_file(file_path)
+    File.delete(file_path) if File.exist?(file_path)
+  end
+
+  def xls_upload_and_update_model(uploaded_file, model)
+    file_path = store_uploaded_file(uploaded_file).store_path
+    model_updates = xls_to_model(file_path, model)
+    cleanup_tmp_file(file_path)
+    return model_updates
+  end
+
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: xls_porter
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+  prerelease: 
+platform: ruby
+authors:
+- Michael Reyes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Export to and Import from XLS for Ruby and Rails apps
+email: mikereyes.kg77@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/xls_porter.rb
+homepage: http://rubygems.org/gems/xls_porter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Export to and Import from XLS
+test_files: []