rails_csv_importer 0.1.3

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2012 Ben Li
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.rdoc

@@ -0,0 +1,123 @@
+= RailsCsvImporter
+
+Define configuration in a hash and then import Ruby on Rails model data from CSV with one method call.
+
+Both Rails 2 and 3 are supported.
+
+== Usage
+
+1. Add acts_as_rails_csv_importer to your model
+2. Call YourModel.get_csv_import_template to generate the CSV template.
+3. Call YourModel.import_from_csv in your controller to import data from a CSV file uploaded.
+
+=== In a Rails Model
+
+class Foo < ActiveRecord::Base
+  acts_as_rails_csv_importer
+end
+
+=== Generate CSV Template
+
+Call Foo.get_csv_import_template(import_config). See below for details on the parameter.
+
+=== Import From CSV
+
+Call Foo.import_from_csv(import_config, content, options = {})
+
+* import_config
+
+  A hash that defines what data are imported and how.
+
+  [:mapping] A hash that defines the columns in the csv. Each hash key is the model attribute name for the column.
+             Each value is a hash defining how the column is processed:
+
+             [:name] The heading that identify the column in the csv.
+                     If omitted, the heading will be the humanized form of the key.
+                     (_Optional_)
+
+             There are four different ways to specify how the column is processed:
+
+             [:value_method] A lambda to convert the column value from csv into the attribute value in the model.
+                             Class Acts::RailsCsvImporter::ValueMethods provides some pre-defined value methods.
+                             (_Optional_)
+
+             [:record_method] A lambda to find the associated record if this attribue is a foreign key.
+                              (_Optional_)
+
+             [:virtual] If set to true, the column is not mapped to a model attribute.
+                        Usually the column will be used together with other columns.
+
+             [None of the above options present] The column value will be used without any conversion.
+
+  [:find_existing] A lambda to find the existing record to update for a row.
+                   A new record is created if the lambda could not find an existing record and return nil.
+                   The row is passed as a hash to the lambda.
+                   If this parameter is omitted, a new record is created for each row.
+                   (_Optional_)
+
+* content
+
+  A string that contains the csv content to import from.
+
+* options
+
+  A hash of options for the import. (_Optional_)
+
+  [:partial_save] If true, any valid rows in the csv will be saved even if there are some invalid rows.
+                  Otherwise, data will be imported only when all rows are valid.
+
+Exception +Acts::RailsCsvImporter::RailsCsvImportError+ is thrown when there are errors duing the importing.
+
+== Example
+
+class Material < ActiveRecord::Base
+  acts_as_rails_csv_importer
+end
+
+class MaterialsController  < ApplicationController
+  IMPORT_CONFIG = {
+      :mapping => {
+        'name' => {},
+        'fragile' => {
+          :name => "Fragile?",
+          :value_method => Acts::RailsCsvImporter::ValueMethods.boolean_value_method
+        },
+        'category_id' =>  {:record_method => lambda { |v, row, mapping| Category.find_by_name(v) } },
+      },
+      :find_existing => lambda { |row| Material.find_by_name(row['name']) }
+  }
+
+  def download_template
+    headers["Content-Type"] = 'text/csv'
+    headers["Content-Disposition"] = 'attachment; filename="template.csv"'
+    render :text => Material.get_import_template(IMPORT_CONFIG)
+  end
+
+  def import
+    num_imported = Material.import_from_csv(IMPORT_CONFIG, params[:file_upload])
+    flash[:notice] = num_imported.to_s + " records imported successfully."
+  rescue  Acts::RailsCsvImporter::RailsCsvImportError => ex
+    @err_message = ex.errors.map { |err, row| err.is_a?(String) ? err : err.full_messages }.join(';')
+    render :template => :error
+  end
+end
+
+For more examples, refer to +test/rails_csv_importer_test.rb+
+
+== Download and installation
+
+The latest version of RailsCsvImporter can be installed with RubyGems:
+
+  % [sudo] gem install rails_csv_importer
+
+Source code can be downloaded on GitHub
+
+* https://github.com/benli/rails_csv_importer/tree/master
+
+
+== License
+
+RailsCsvImporter is released under the MIT license:
+
+* http://www.opensource.org/licenses/MIT
+

data/lib/rails_csv_importer.rb

@@ -0,0 +1,229 @@
+if RUBY_VERSION >= "1.9"
+  # CSV in ruby 1.9 is FasterCSV plus support for Ruby 1.9's m17n encoding engine
+  require 'csv'
+  FasterCSV = CSV
+else
+  require 'faster_csv'
+end
+require 'iconv'
+
+module Acts # :nodoc
+  module RailsCsvImporter
+    #
+    # This class is the placeholder of methods common used.
+    #
+    class ValueMethods
+      #
+      # A value method that can be used on boolean type columns.
+      # Accept 'yes' and 'no' instead of the default 'true" and 'false'
+      #
+      def self.yes_no_value_method
+        lambda { |v, row, mapping|
+          case v.downcase
+            when 'yes' then true
+            when 'no' then false
+            else
+              raise "Value must be Yes or No"
+          end
+        }
+      end
+    end
+
+    #
+    # The exception thrown when there are errors in the import.
+    #
+    class RailsCsvImportError < RuntimeError
+      #
+      # An array of errors occurred during the import.
+      #
+      # Each error is an array with two elements:
+      #  1. Either a string of error message or the ActiveRecord::Errors object.
+      #  2. An array of columns in the row that is associated with this error.
+      #
+      attr_reader :errors
+
+      # An array of column headings.
+      attr_reader :header_row
+
+      # Number of rows already imported.
+      attr_reader :num_imported
+
+      def initialize(errors, header_row, num_imported) # :nodoc:
+        @errors = errors
+        @header_row = header_row
+        @num_imported = num_imported
+      end
+    end
+
+    def self.included(base) # :nodoc:
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      #
+      # Called in a Rails model to bring it CSV Import funcationality provided in this gem.
+      #
+      def acts_as_rails_csv_importer
+        class_eval do
+          extend Acts::RailsCsvImporter::SingletonMethods
+        end
+      end
+    end
+
+    module SingletonMethods
+      #
+      # Import model data from csv content
+      #
+      # Options:
+      #
+      # * +import_config+ - specifies how the csv content is parsed.
+      # * +content+ - the csv content in a string that can be parsed by FasterCSV
+      # * +options+ - none for now
+      #
+      # Throws: +RailsCsvImportError+
+      #
+      # See +README.rdoc+ for details.
+      #
+      def import_from_csv(import_config, content, options = {})
+        ic = Iconv.new('UTF-8', 'UTF-8')
+
+        num_rows_saved=0
+        errors = []
+        header_row = []
+
+        mapping = import_config[:mapping]
+        # a hash for finding the key for a column heading quickly
+        name_to_column_hash = mapping.keys.inject({}) { |acc, key|
+           acc[translate_column(key, mapping).downcase] = key
+           acc
+        }
+
+        self.transaction do
+          all_rows = []
+          # the column keys in the order of the column headings
+          col_names = []
+          row_num = 0
+          col_num = 0
+
+          # first phase: parse the csv and store the result in all_rows
+
+          first_row = true
+          begin
+            FasterCSV.parse(content, :skip_blanks => true) do |row|
+              row_num += 1
+              col_num = 0
+              row = row.map { |col| col_num += 1; ic.iconv(col) }
+              if first_row == true
+                header_row = row
+                row.each { |column_name| col_names << name_to_column_hash[column_name.downcase] }
+                first_row = false
+              else
+                all_rows << row
+                row_hash = {}
+                row.each_with_index { |column, x| row_hash[col_names[x]] = column if col_names[x] }
+              end
+            end
+          rescue Iconv::IllegalSequence => ex
+            all_rows = header_row = []
+            errors << ["Invalid character encountered in row #{row_num}, column #{col_num} in the CSV file: #{ex.message}", []]
+          rescue FasterCSV::MalformedCSVError => ex
+            all_rows = header_row = []
+            errors << ["Invalid CSV format: #{ex.message}", []]
+          end
+
+          # second phase: process the rows
+
+          all_rows.each do |row|
+            row_hash = {}
+            row.each_with_index { |column, x| row_hash[col_names[x]] = column if col_names[x] }
+
+            find_existing = import_config[:find_existing]
+            if find_existing
+              record = find_existing.call(row_hash) || self.new
+            else
+              record = self.new
+            end
+
+            begin
+              row.each_with_index do |column, x|
+                col_name = col_names[x]
+                if col_name
+                  col_config = mapping[col_name]
+                  unless column.blank?
+                    begin
+                      # assign the correct value to the attribute according to the config
+                      record[col_name] = if col_config[:value_method]
+                        col_config[:value_method].call(column, row_hash, mapping)
+                      elsif col_config[:record_method]
+                        r = col_config[:record_method].call(column, row_hash, mapping)
+                        raise "Unable to find referred record of value #{column}" if r.nil?
+                        r.id
+                      else
+                        column
+                      end
+                    rescue Exception => e
+                      raise "Failed to import column '#{header_row[x]}': #{e.message}"
+                    end
+                  end
+                end
+              end
+            rescue Exception => e
+              errors << [e.message, row]
+              next
+            end
+            if record.save
+              num_rows_saved += 1
+            else
+              errors << [record.errors, row]
+            end
+          end # all_rows
+
+          raise RailsCsvImportError.new(errors, header_row, num_rows_saved) if errors.any? && !options[:partial_save]
+        end # transaction
+
+        raise RailsCsvImportError.new(errors, header_row, num_rows_saved) if errors.any? && options[:partial_save]
+
+        num_rows_saved
+      end
+
+      #
+      # Return the csv import template in a string.
+      #
+      # options:
+      #
+      # * +import_config+ - specifies how the csv content is parsed when importing from the template.
+      #                     See +README.rdoc+ for details
+      #
+      def get_csv_import_template(import_config)
+        mapping = import_config[:mapping]
+        FasterCSV.generate do |csv|
+          csv << mapping.keys.map { |key| translate_column(key, mapping) }
+        end
+      end
+
+      private
+
+      #
+      # Translate a column key into its heading
+      #
+      # options:
+      #
+      # * +col+ - the key of the column
+      # * +mapping+ - the mapping parameter in the config
+      #
+      def translate_column(col, mapping)
+        if mapping[col][:name]
+          mapping[col][:name]
+        else
+          if col[-3,3] == "_id"
+            col = col[0, col.length - 3]
+          end
+          col.humanize
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Acts::RailsCsvImporter) if defined?(ActiveRecord)
+

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'rails_csv_importer'
+

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: rails_csv_importer
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
+platform: ruby
+authors: 
+- Ben Li
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-25 00:00:00 Z
+dependencies: []
+
+description: Define configuration in a hash and then import Ruby on Rails model data from CSV with one method call.
+email: libin1231@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.rdoc
+- lib/rails_csv_importer.rb
+- rails/init.rb
+homepage: http://rubygems.org/gems/rails_csv_importer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A little gem to ease data importing in Ruby on Rails
+test_files: []
+