importable_attachments 0.0.13 → 0.0.14

data/lib/importable_attachments/base.rb

@@ -1,3 +1,4 @@
+require 'importable_attachments/importers/importer'
 module ImportableAttachments::Base
   module ClassMethods
 
@@ -20,6 +21,7 @@ module ImportableAttachments::Base
       install_importable_attachment_assignment_protection
 
       include InstanceMethods
+      include ImportableAttachments::Importers::Importer
 
       # for assigning attachment to new record
       after_create :import_attachment
@@ -52,6 +54,9 @@ module ImportableAttachments::Base
     def install_importable_attachment_validations
       validates :attachment, :associated => true
       validate do |record|
+        if @invalid_extension
+          invalid_attachment_error "invalid extension: .#{@invalid_extension}"
+        end
         if @columns_not_found
           invalid_attachment_error "column(s) not found: #{@columns_not_found}"
         end
@@ -61,10 +66,6 @@ module ImportableAttachments::Base
         end
       end
 
-      # These go in the class calling has_importable_attachment as they are
-      # dependent on mime-type expectations
-      #validates_with CsvValidator, :if => Proc.new {|model| model.attachment.present?}
-      #validates_with ExcelValidator, :if => Proc.new {|model| model.attachment.present?}
     end
 
     def install_importable_attachment_assignment_protection
@@ -76,29 +77,9 @@ module ImportableAttachments::Base
 
   module InstanceMethods
     # : call-seq:
-    # import_attachment
-    #
-    # imports an attachment of a given mime-type (data-stream to ruby),
-    # calls import_rows with a ruby data-store
-    #
-    # NOTE: this is a stub
-
-    def import_attachment
-      raise RuntimeError, '[importable_attachments] .import_attachment not implemented'
-    end
-
-    # : call-seq:
-    # import_rows params
-    #
-    # imports an attachment contents into :import_into association
+    # invalid_attachment_error msg
     #
-    # NOTE: this is a stub
-
-    def import_rows(*opts)
-      return unless self.attachment
-      logger.debug "[importable_attachments] .import_rows #{opts}"
-      raise RuntimeError, '[importable_attachments] .import_rows not implemented'
-    end
+    # adds errors to base record and attachment
 
     def invalid_attachment_error(msg)
       attachment.errors.add(:base, msg)

data/lib/importable_attachments/importers/{csv.rb → importer.rb}

@@ -1,12 +1,17 @@
+require 'roo'
+
 module ImportableAttachments
   module Importers
-    module Csv
+    module Importer
       attr_accessor :validate_headers, :destructive_import, :validate_on_import
 
       # ImportInto suitable attributes translated from a ImportInto::RECORD_HEADERS
       # inversion, based on RECORD_HEADERS
       attr_accessor :converted_headers
 
+      # stores the parsed-file for later processing
+      attr_accessor :attachment_as_ruby
+
       def initialize(attributes = nil, options = {})
         bootstrap
         super(attributes, options)
@@ -37,16 +42,18 @@ module ImportableAttachments
 
       def attachment=(params)
         super params
-        import_attachment if persisted? && attachment && attachment.valid?
+        import_attachment if persisted? && attachment.try(:valid?)
       end
 
-      # :call-seq:
-      # import_csv
+      # : call-seq:
+      # import_attachment
       #
-      # imports a comma-separated value file
+      # imports an attachment of a given mime-type (data-stream to ruby),
+      # calls import_rows with a ruby data-store
 
-      def import_csv
+      def import_attachment
         return unless attachment.present?
+        return unless read_spreadsheet
         return if validate_headers && !importable_class_headers_ok?
         transaction do
           send(association_symbol_for_rows).destroy_all if destructive_import
@@ -69,9 +76,9 @@ module ImportableAttachments
 
         # .dup else .import modifies converted_headers and spreadsheet
         if respond_to? :sanitize_data_callback
-          headers, sheet = sanitize_data_callback(converted_headers, spreadsheet)
+          headers, sheet = sanitize_data_callback(@converted_headers, spreadsheet)
         else
-          headers, sheet = converted_headers.dup, spreadsheet.dup
+          headers, sheet = @converted_headers.dup, spreadsheet.dup
         end
         results = @import_rows_to_class.import headers, sheet, importer_opts
         reload if persisted?
@@ -134,16 +141,36 @@ module ImportableAttachments
       # :call-seq:
       # read_spreadsheet
       #
-      # the "raw" file as processed by CSV
+      # sets @attachment_as_ruby to the raw file as processed by roo if the file can be read
 
       def read_spreadsheet
-        csv_klass = (defined? FasterCSV) ? FasterCSV : CSV
-        stream = attachment.io_stream
-        if stream.exists?
-          csv_klass.read stream.path
+        if !%w(xls xlsx ods xml csv).member?(stream_extension) # required for roo - it checks file extension
+          @invalid_extension = stream_extension
         else
-          csv_klass.read stream.queued_for_write[:original].path
+          @invalid_extension = nil
+          spreadsheet = Roo::Spreadsheet.open stream_path
+          @attachment_as_ruby = spreadsheet.parse
         end
+        @attachment_as_ruby
+      end
+
+      # :call-seq:
+      # stream_path
+      #
+      # yields path for a readable file, saved or not
+
+      def stream_path
+        @stream = attachment.io_stream
+        @stream.exists? ? @stream.path : @stream.queued_for_write[:original].path
+      end
+
+      # :call-seq:
+      # stream_extension
+      #
+      # yields extension for file
+
+      def stream_extension
+        stream_path.split('.').last
       end
 
       # :call-seq:
@@ -152,7 +179,7 @@ module ImportableAttachments
       # the rows of the file after the first row (headers)
 
       def spreadsheet
-        read_spreadsheet[1..-1]
+        @attachment_as_ruby[1..-1]
       end
 
       # :call-seq:
@@ -161,7 +188,7 @@ module ImportableAttachments
       # headers for the spreadsheet
 
       def headers
-        read_spreadsheet.first
+        @attachment_as_ruby.first
       end
 
       # :call-seq:
@@ -195,11 +222,14 @@ module ImportableAttachments
       # translates English date-ish and-or time-ish language into DateTime instances
 
       def convert_datetimes_intelligently!
-        dt_attrs = converted_headers.select { |obj| obj.match(/_(?:dt?|at|on)\z/) }
-        dt_idxs = dt_attrs.map { |obj| converted_headers.find_index(obj) }
+        dt_attrs = @converted_headers.select { |obj| obj.match(/_(?:dt?|at|on)\z/) }
+        dt_idxs = dt_attrs.map { |obj| @converted_headers.find_index(obj) }
 
         spreadsheet.map! { |row|
-          dt_idxs.each { |idx| row[idx] = row[idx].try(:to_datetime) || row[idx] }
+          dt_idxs.each { |idx|
+            to_convert = row[idx]
+            row[idx] = to_convert.try(:to_datetime) || to_convert
+          }
           row }
       end
 

data/lib/importable_attachments/version.rb

@@ -1,3 +1,3 @@
 module ImportableAttachments
-  VERSION = '0.0.13'
+  VERSION = '0.0.14'
 end

data/spec/dummy/app/models/library.rb

@@ -1,5 +1,3 @@
-require 'importable_attachments/importers'
-
 class Library < ActiveRecord::Base
   include SmarterDates if ::Configuration.for('smarter_dates').enabled
 
@@ -13,8 +11,6 @@ class Library < ActiveRecord::Base
     extend ImportableAttachments::Base::ClassMethods
     has_importable_attachment spreadsheet_columns: RECORD_HEADERS,
       import_into: :books
-    include ImportableAttachments::Importers::Csv
-    validates_with ImportableAttachments::CsvValidator, if: Proc.new { |model| model.attachment.present? && model.attachment.persisted? }
   end
 
   # --------------------------------------------------------------------------
@@ -35,16 +31,6 @@ class Library < ActiveRecord::Base
   # --------------------------------------------------------------------------
   # define: behaviors
 
-  # : call-seq:
-  # import_attachment
-  #
-  # imports an attachment of a given mime-type (data-stream to ruby),
-  # calls import_rows with a ruby data-store
-
-  def import_attachment
-    import_csv
-  end
-
   protected
 
   def sanitize_data_callback(headers, sheet) # :nodoc:

data/spec/models/importable_attachments/library_spec.rb

@@ -151,5 +151,19 @@ describe Library do
     end
   end
 
+  context 'importing excel file' do
+    before :each do
+      @attachment = Attachment.new io_stream: File.new(spec_file('books.xls'), 'rb')
+    end
+
+    subject { Library.create(name: 'XYZ Library', address: '123 Main St.') }
+
+    it 'should import a spreadsheet if it is in the right format' do
+        subject.books.should be_empty
+        lambda {
+          subject.attachment = @attachment
+        }.should change(subject.books, :count).by(5)
+    end
+  end
 end
 

metadata

@@ -2,14 +2,14 @@
 name: importable_attachments
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Paul Belt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-30 00:00:00.000000000 Z
+date: 2013-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml-rails
@@ -524,9 +524,6 @@ files:
 - app/models/importable_attachments/attachment.rb
 - app/models/importable_attachments/version.rb
 - app/validators/existing_class_validator.rb
-- app/validators/importable_attachments/csv_validator.rb
-- app/validators/importable_attachments/excel.rb
-- app/validators/importable_attachments/excel_validator.rb
 - app/views/importable_attachments/attachments/_attachment.html.haml
 - app/views/importable_attachments/attachments/_form.html.haml
 - app/views/importable_attachments/attachments/_nested_form.html.haml
@@ -566,14 +563,14 @@ files:
 - lib/importable_attachments/blueprints.rb
 - lib/importable_attachments/engine.rb
 - lib/importable_attachments/importers.rb
-- lib/importable_attachments/importers/csv.rb
-- lib/importable_attachments/importers/excel.rb
+- lib/importable_attachments/importers/importer.rb
 - lib/importable_attachments/version.rb
 - lib/paperclip_processors/save_upload.rb
 - lib/tasks/importable_attachments_tasks.rake
 - script/rails
 - spec/attachments/books.csv
 - spec/attachments/books.txt
+- spec/attachments/books.xls
 - spec/attachments/books2.csv
 - spec/attachments/empty.csv
 - spec/attachments/failed_instances.csv
@@ -669,6 +666,7 @@ summary: upload, save-to-disk, attach-to-model_instance, importing
 test_files:
 - spec/attachments/books.csv
 - spec/attachments/books.txt
+- spec/attachments/books.xls
 - spec/attachments/books2.csv
 - spec/attachments/empty.csv
 - spec/attachments/failed_instances.csv

data/app/validators/importable_attachments/csv_validator.rb

@@ -1,36 +0,0 @@
-require 'csv'
-
-# validate attachment is a CSV file
-module ImportableAttachments  # :nodoc:
-  class CsvValidator < ActiveModel::Validator
-
-    # :call-seq:
-    # validate :record
-    #
-    # ensures that the record's attachment file name has a .xls extension
-
-    def validate(record)
-      extension = record.attachment.io_stream_file_name.split('.').last
-      if extension.downcase != 'csv'
-        record.errors.add :attachment, 'invalid attachment'
-        record.attachment.errors.add :base, 'File must be a CSV (.csv) file'
-      end
-
-      if defined? FasterCSV
-        begin
-          FasterCSV.read record.attachment.io_stream
-        rescue FasterCSV::MalformedCSVError => err
-          record.errors.add :attachment, 'invalid attachment'
-          record.attachment.errors.add :base, err.messages.join(', ')
-        end
-      else
-        begin
-          CSV.read record.attachment.io_stream.path
-        rescue CSV::MalformedCSVError => err
-          record.errors.add :attachment, 'invalid attachment'
-          record.attachment.errors.add :base, err.messages.join(', ')
-        end
-      end
-    end
-  end
-end

data/app/validators/importable_attachments/excel.rb

@@ -1,18 +0,0 @@
-module ImportableAttachments  # :nodoc:
-  # validate attachment is an excel file
-  class ExcelValidator < ActiveModel::Validator
-
-    # :call-seq:
-    # validate :record
-    #
-    # ensures that the record's attachment file name has a .xls extension
-
-    def validate(record)
-      extension = record.attachment.io_stream_file_name.split('.').last
-      if extension != 'xls'
-        record.errors[:attachment] << 'File must be an Excel (.xls) file'
-      end
-    end
-
-  end
-end

data/app/validators/importable_attachments/excel_validator.rb

@@ -1,18 +0,0 @@
-module ImportableAttachments  # :nodoc:
-  # validate attachment is an excel file
-  class ExcelValidator < ActiveModel::Validator
-
-    # :call-seq:
-    # validate :record
-    #
-    # ensures that the record's attachment file name has a .xls extension
-
-    def validate(record)
-      extension = record.attachment.io_stream_file_name.split('.').last
-      if extension != 'xls'
-        record.errors[:attachment] << 'File must be an Excel (.xls) file'
-      end
-    end
-
-  end
-end

data/lib/importable_attachments/importers/excel.rb

@@ -1,37 +0,0 @@
-module ImportableAttachments
-  module Importers
-    module Excel
-
-      require 'iconv'
-
-      # :call-seq:
-      # import_csv
-      #
-      # imports an Excel (tm) file
-
-      def import_excel
-        column_names = self.class.spreadsheet_columns
-        assoc = self.class.import_into
-        import_method = self.class.import_method
-        return unless attachment.present?
-
-        stream = attachment.io_stream
-        stream_path = if stream.exists?
-          stream.path
-        else
-          stream.queued_for_write[:original].path
-        end
-        spreadsheet = Roo::Excel.new stream_path
-
-        spreadsheet.default_sheet = spreadsheet.sheets.first
-        headers = (1..column_names.length).map { |n| spreadsheet.cell(1, n).try(:downcase) }
-        return unless headers == column_names.map(&:downcase)
-        self.send(assoc).destroy_all
-        2.upto(spreadsheet.last_row) do |line|
-          self.send(import_method, *(1..column_names.length).map { |n| spreadsheet.cell(line, n) })
-        end
-      end
-
-    end
-  end
-end