act_as_importable 0.0.4 → 0.0.5

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+act_as_importable.db

data/lib/act_as_importable/base.rb

@@ -13,9 +13,8 @@ module ActAsImportable
 
       def import_csv_text(text, options = {})
         csv = ::CSV.parse(text, :headers => true)
-        results = csv.map do |row|
-          row = row.to_hash.with_indifferent_access
-          import_record(row, options)
+        csv.map do |row|
+          import_record(row.to_hash, options)
         end
       end
 
@@ -24,22 +23,22 @@ module ActAsImportable
       # 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)
+        options.reverse_merge!(@default_import_options)
+        row = row.with_indifferent_access
+        row.reverse_merge!(options[:default_values]) if options[:default_values]
+        convert_key_paths_to_values!(row)
         row = filter_columns(row, options)
-        record = find_or_create_by(uid_values(row, options))
+        record = find_or_create_by_uids(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!
+        record.save
       end
 
       def filter_columns(row, options = {})
-        row = row.reject { |key, value| Array(options[:except]).include? key } if options[:except]
-        row = row.select { |key, value| Array(options[:only]).include? key } if options[:only]
+        except = Array(options[:except]).map { |i| i.to_s }
+        only = Array(options[:only]).map { |i| i.to_s }
+        row = row.reject { |key, value| except.include? key.to_s } if except.present?
+        row = row.select { |key, value| only.include? key.to_s } if only.present?
         row
       end
 
@@ -53,36 +52,38 @@ module ActAsImportable
         end
       end
 
-      def update_associations(record, row)
-        row.each_key do |key|
-          key = key.to_s
-          if key.include?('.')
-            update_association(record, key, row[key])
-            row.delete(key)
-          end
-        end
+      def find_association_value_with_attribute(name, attribute)
+        association = self.reflect_on_association(name.to_sym)
+        association.klass.where(attribute).first
       end
 
-      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
+      def find_or_create_by_uids(attributes, &block)
+        find_by_uids(attributes) || create(attributes, &block)
       end
 
-      def find_association_value_with_attribute(name, attribute)
-        association = self.reflect_on_association(name.to_sym)
-        association.klass.where(attribute).first
+      def find_by_uids(attributes)
+        attributes.inject(self.scoped.readonly(false)) { |scope, key_value|
+          add_scope_for_field(scope, key_value[0].to_s, key_value[1])
+        }.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)
+      def add_scope_for_field(scope, field, value)
+        return scope unless value
+        if (association = self.reflect_on_association(field.to_sym))
+          field = association.foreign_key
+          value = value.id
+        end
+        scope.where("#{self.table_name}.#{field} = ?", value)
       end
 
-      # Note: This will by provided by default in rails 4
-      def find_by(attributes)
-        where(attributes).first
+      # TODO: update this to support finding the association value with multiple columns
+      def convert_key_paths_to_values!(row)
+        key_path_attributes = row.select { |k,v| k.to_s.include? '.' }
+        key_path_attributes.each do |key, value|
+          association_name, uid_field = key.to_s.split('.')
+          row[association_name.to_sym] = find_association_value_with_attribute(association_name, uid_field => value)
+          row.delete(key.to_sym)
+        end
       end
 
     end

data/lib/act_as_importable/version.rb

@@ -1,3 +1,3 @@
 module ActAsImportable
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/act_as_importable/act_as_importable_spec.rb

@@ -75,17 +75,53 @@ describe "an act_as_importable model" do
       expect { Item.import_record(row) }.to change{Item.count}.by(1)
     end
 
-    describe "unique identifier" do
-      before :each do
-        @existing_item = Item.create!(:name => 'Beer', :price => 1.0)
+    describe "unique identifier (uid) option" do
+
+      context "record exists with matching uid" do
+        before :each do
+          @existing_item = Item.create!(:name => 'Beer', :price => 1.0)
+        end
+        it "should update an existing record with matching uid" do
+          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, :uid => 'name') }.to change { Item.count }.by(0)
+        end
       end
-      it "should update an existing record with matching unique identifier" do
-        Item.import_record(row, :uid => 'name')
-        @existing_item.reload.price.should == 2.5
+
+      context "record doesn't exist with matching uid" do
+        it "should create a new record" do
+          expect { Item.import_record(row, :uid => :name) }.to change { Item.count }.by(1)
+        end
+        it "should assign the uid values to the record" do
+          Item.import_record(row, :uid => :name)
+          Item.first.name.should == 'Beer'
+        end
       end
-      it "should not create a new item" do
-        expect { Item.import_record(row, :uid => 'name') }.to change { Item.count }.by(0)
+
+      context "support for multiple uid columns" do
+        let(:category1) { Category.create!(:name => 'Beverage') }
+        let(:category2) { Category.create!(:name => 'Beers') }
+        let(:row) { { :name => 'Beer', :'category.name' => category2.name, :price => 3.2}}
+        before :each do
+          @existing1 = Item.create!(:name => 'Beer', :price => 1.0, :category => category1)
+          @existing2 = Item.create!(:name => 'Beer', :price => 2.5, :category => category2)
+        end
+
+        it "should match existing records with multiple uid columns" do
+          Item.import_record(row, :uid => [:name, :category])
+          @existing2.reload.price.should == 3.2
+        end
+
+        it "should allow uid column value to come from default values" do
+          row = { :name => 'Beer', :price => 3.2 }
+          Item.import_record(row, :uid => [:name, :category], :default_values => { :'category.name' => category2.name })
+          @existing2.reload.price.should == 3.2
+        end
+
       end
+
     end
   end
 
@@ -100,8 +136,52 @@ describe "an act_as_importable model" do
     end
   end
 
+  describe "default_values option" do
+    let(:row) { {:name => 'Beer'} }
+
+    it "should assign default values to new record" do
+      Item.import_record(row, :default_values => { :price => 3.2 })
+      Item.first.price.should == 3.2
+    end
+
+    it "should assign default values to updated record" do
+      Item.create!(:name => 'Beer', :price => 1.0)
+      Item.import_record(row, :uid => :name, :default_values => {:price => 3.2})
+      Item.first.price.should == 3.2
+    end
+
+    it "should not override row values" do
+      row[:price] = 4.1
+      Item.import_record(row, :default_values => {:price => 3.2})
+      Item.first.price.should == 4.1
+    end
+
+    describe "associations" do
+      let(:category) { Category.new(:name => 'Beverage') }
+
+      it "should assign default association value to new record" do
+        Item.import_record(row, :default_values => {:category => category})
+        Item.first.category.should == category
+      end
+
+      it "should assign default association value to updated record" do
+        Item.create!(:name => 'Beer', :price => 1.0)
+        Item.import_record(row, :uid => :name, :default_values => {:category => category})
+        Item.first.category.should == category
+      end
+
+      it "should not override row values" do
+        other_category = Category.create!(:name => 'Food & Beverage')
+        row['category.name'] = other_category.name
+        Item.import_record(row, :default_values => {'category.name' => category.name})
+        Item.first.category.should == other_category
+      end
+    end
+
+  end
+
   describe "#filter_columns" do
-    let(:row) { {:name => 'Beer', :price => 2.5} }
+    let(:row) { {:name => 'Beer', :price => 2.5}.with_indifferent_access }
 
     it 'should filter columns when importing each record' do
       Item.should_receive(:filter_columns).with(row, default_options).and_return(row)
@@ -109,15 +189,15 @@ describe "an act_as_importable model" do
     end
 
     it "should not modify row if no options provided" do
-      Item.filter_columns(row).should == {:name => 'Beer', :price => 2.5}
+      Item.filter_columns(row).should == row
     end
 
     it "should remove columns specified by the :except option" do
-      Item.filter_columns(row, :except => :price).should == {:name => 'Beer'}
+      Item.filter_columns(row, :except => :price).should == {'name' => 'Beer'}
     end
 
     it "should remove columns not specified by the :only option" do
-      Item.filter_columns(row, :only => :price).should == {:price => 2.5}
+      Item.filter_columns(row, :only => :price).should == {'price' => 2.5}
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: act_as_importable
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-07 00:00:00.000000000 Z
+date: 2013-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -89,7 +89,7 @@ files:
 - README.md
 - Rakefile
 - act_as_importable.gemspec
-- db/act_as_importable.db
+- db/.gitkeep
 - lib/act_as_importable.rb
 - lib/act_as_importable/base.rb
 - lib/act_as_importable/config.rb