act_as_importable 0.0.1 → 0.0.2

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.3@act_as_importable

data/act_as_importable.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = ActAsImportable::VERSION
   gem.authors       = ["Colin Harris"]
   gem.email         = ["col.w.harris@gmail.com"]
-  gem.description   = %q{Helps import models from CSV files.}
-  gem.summary       = %q{Helps import models from CSV files.}
+  gem.description   = %q{Helps import records from CSV files.}
+  gem.summary       = %q{Helps import records from CSV files.}
   gem.homepage      = "https://github.com/Col/act_as_importable"
 
   gem.files         = `git ls-files`.split($/)

data/lib/act_as_importable/base.rb

@@ -5,29 +5,31 @@ module ActAsImportable::Base
 
   module ClassMethods
 
-    ##
-    # Imports a data file into a model
-    # Existing records are found by the :uid.
-    # This can be changed by providing the :unique_identifier option or overriding the default_unique_identifier class method.
-    def import_file(file, options = {})
-      import_text(File.read(file), options)
+    def import_csv_file(file, options = {})
+      import_csv_text(File.read(file), options)
     end
 
-    ##
-    # Imports csv text into a model
-    def import_text(text, options = {})
+    def import_csv_text(text, options = {})
       csv = ::CSV.parse(text, :headers => true)
-      csv.each do |row|
+      results = csv.map do |row|
         row = row.to_hash.with_indifferent_access
         import_record(row, options)
       end
     end
 
+    # Creates or updates a model record
+    # Existing records are found by the column(s) specified by the :uid option (default 'id').
+    # If the values for the uid columns are not provided the row will be ignored.
+    # If uid is set to nil it will import the row data as a new record.
     def import_record(row, options = {})
+      options = options.reverse_merge!(@default_import_options)
       row = filter_columns(row, options)
-      record = find_existing_record(row, options)
-      remove_unique_identifiers(row, options) if record
-      record ||= self.new()
+      record = find_or_create_by(uid_values(row, options))
+      remove_uid_values_from_row(row, options)
+      update_record(record, row)
+    end
+
+    def update_record(record, row)
       update_associations(record, row)
       record.update_attributes(row)
       record.save!
@@ -39,55 +41,46 @@ module ActAsImportable::Base
       row
     end
 
-    def remove_unique_identifiers(row, options = {})
-      Array(options[:unique_identifier]).each do |field|
+    def uid_values(row, options)
+      Hash[Array(options[:uid]).map { |k| [k, row[k.to_sym]] }]
+    end
+
+    def remove_uid_values_from_row(row, options = {})
+      Array(options[:uid]).each do |field|
         row.delete(field)
       end
     end
 
-    ##
-    # Updates any associations specified in the import data.
-    # Associations are specified in the header by separating the association and the field by a '.'
-    def update_associations(existing, row)
+    def update_associations(record, row)
       row.each_key do |key|
         key = key.to_s
         if key.include?('.')
-          association_name = key.split('.').first
-          field = key.split('.').last
-          association = self.reflect_on_association(association_name.to_sym)
-          association_value = association.klass.where("#{field} = ?", row[key]).first
-          existing.send("#{association_name}=", association_value) if association_value
+          update_association(record, key, row[key])
           row.delete(key)
         end
       end
     end
 
-    ##
-    # Fetches the existing record based on the identifier field(s) specified by the :unique_identifier option.
-    # Defaults to the field specified by 'default_unique_identifier'
-    def find_existing_record(row, options = {})
-      return unless options[:unique_identifier]
-      fields = Array(options[:unique_identifier])
-      fields.inject(self.scoped.readonly(false)) { |scope, field|
-        add_scope_for_field(scope, field.to_s, row)
-      }.first
+    def update_association(record, key, value)
+      association_name = key.split('.').first
+      uid_field = key.split('.').last
+      value = find_association_value_with_attribute(association_name, uid_field => value)
+      record.send("#{association_name}=", value) if value
     end
 
-    ##
-    # Refines an existing scope to include a new field
-    # The field can traverse 'belongs_to' associations by joining the association and field with a '.'
-    # The query value should be found within the hash with the field as the key.
-    # Notes: currently only supports field paths through one association.
-    def add_scope_for_field(scope, field, hash)
-      value = hash[field]
-      return scope unless value
-      if field.include?('.')
-        association = field.split('.').first
-        field_name = field.split('.').last
-        scope.joins(association.to_sym).where("#{association.pluralize}.#{field_name} = ?", value)
-      else
-        scope.where("#{field} = ?", value)
-      end
+    def find_association_value_with_attribute(name, attribute)
+      association = self.reflect_on_association(name.to_sym)
+      association.klass.where(attribute).first
+    end
+
+    # Note: This will be available by default in rails 4
+    def find_or_create_by(attributes, &block)
+      find_by(attributes) || create(attributes, &block)
+    end
+
+    # Note: This will by provided by default in rails 4
+    def find_by(attributes)
+      where(attributes).first
     end
 
   end

data/lib/act_as_importable/config.rb

@@ -4,8 +4,16 @@ module ActAsImportable::Config
   extend ActiveSupport::Concern
 
   module ClassMethods
-    def act_as_importable
+    def act_as_importable(options = {})
       include ActAsImportable::Base
+
+      @default_import_options = options
+      @default_import_options[:uid] ||= :id
+
+      # create a reader on the class to access the field name
+      class << self;
+        attr_reader :default_import_options
+      end
     end
   end
 end

data/lib/act_as_importable/railtie.rb

@@ -0,0 +1,12 @@
+require 'act_as_importable'
+require 'rails'
+
+module ActAsImportable
+  class Railtie < ::Rails::Railtie
+    initializer "act_as_importable.active_record" do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send :include, ActAsImportable::Config
+      end
+    end
+  end
+end

data/lib/act_as_importable/version.rb

@@ -1,3 +1,3 @@
 module ActAsImportable
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/act_as_importable/act_as_importable_spec.rb

@@ -18,7 +18,7 @@ ActiveRecord::Base.connection.create_table(:items) do |t|
 end
 
 class Item < ActiveRecord::Base
-  act_as_importable
+  act_as_importable :uid => 'name'
 
   belongs_to :category
 end
@@ -37,15 +37,22 @@ describe "an act_as_importable model" do
 
   subject { Item }
 
-  it { should respond_to :import_file }
-  it { should respond_to :import_text }
+  it { should respond_to :import_csv_file }
+  it { should respond_to :import_csv_text }
   it { should respond_to :import_record }
+  it { should respond_to :default_import_options }
+
+  let(:default_options) { {:uid => 'name'} }
+
+  it "should have the correct default import options" do
+    Item.default_import_options.should == default_options
+  end
 
   describe "import csv file" do
     let(:file) { 'spec/fixtures/items.csv' }
-    it 'should call import_text with context of file' do
-      Item.should_receive(:import_text).with(File.read(file), {})
-      Item.import_file(file)
+    it 'should call import_text with contents of file' do
+      Item.should_receive(:import_csv_text).with(File.read(file), {})
+      Item.import_csv_file(file)
     end
   end
 
@@ -54,7 +61,7 @@ describe "an act_as_importable model" do
     it 'should call import_record with row hashes' do
       Item.should_receive(:import_record).with({'name' => 'Beer', 'price' => '2.5'}, {}).once
       Item.should_receive(:import_record).with({'name' => 'Apple', 'price' => '0.5'}, {}).once
-      Item.import_text(text)
+      Item.import_csv_text(text)
     end
   end
 
@@ -70,11 +77,11 @@ describe "an act_as_importable model" do
         @existing_item = Item.create!(:name => 'Beer', :price => 1.0)
       end
       it "should update an existing record with matching unique identifier" do
-        Item.import_record(row, :unique_identifier => 'name')
+        Item.import_record(row, :uid => 'name')
         @existing_item.reload.price.should == 2.5
       end
       it "should not create a new item" do
-        expect { Item.import_record(row, :unique_identifier => 'name') }.to change { Item.count }.by(0)
+        expect { Item.import_record(row, :uid => 'name') }.to change { Item.count }.by(0)
       end
     end
   end
@@ -94,7 +101,7 @@ describe "an act_as_importable model" do
     let(:row) { {:name => 'Beer', :price => 2.5} }
 
     it 'should filter columns when importing each record' do
-      Item.should_receive(:filter_columns).with(row, {}).and_return(row)
+      Item.should_receive(:filter_columns).with(row, default_options).and_return(row)
       Item.import_record(row)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: act_as_importable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2013-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -75,7 +75,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Helps import models from CSV files.
+description: Helps import records from CSV files.
 email:
 - col.w.harris@gmail.com
 executables: []
@@ -83,14 +83,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - act_as_importable.gemspec
+- db/act_as_importable.db
 - lib/act_as_importable.rb
 - lib/act_as_importable/base.rb
 - lib/act_as_importable/config.rb
+- lib/act_as_importable/railtie.rb
 - lib/act_as_importable/version.rb
 - spec/act_as_importable/act_as_importable_spec.rb
 - spec/fixtures/items.csv
@@ -118,7 +121,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Helps import models from CSV files.
+summary: Helps import records from CSV files.
 test_files:
 - spec/act_as_importable/act_as_importable_spec.rb
 - spec/fixtures/items.csv