importer 0.4.0 → 0.4.1

data/README.rdoc

@@ -25,10 +25,17 @@ Or the plugin
 
 Add to your model
 
+  # ActiveRecord
   class Product < ActiveRecord::Base
     include Importer
   end
 
+  # MongoMapper
+  class Product
+    include MongoMapper::Document
+    include Importer
+  end
+
 And start importing
 
   Product.import(path_to_xml_or_csv_file)
@@ -45,6 +52,27 @@ You can also create your custom versions of Import and ImportedObject classes. A
 
   Product.import(path_to_file, :import => CustomImportClass)
 
+== Updating objects
+
+Importer is smart enough to figure out whether it has to create a new object or just update existing one during import. By default it's tries to find existing object by detected id attribute. If the object is found Importer updates it, otherwise a new object is created. You can change the way how existing objects are searched for by overriding your model's +find_on_import+ class method.
+
+  class Product < ActiveRecord::Base
+    include Importer
+
+    def find_on_import(import, attributes)
+      find_by_name(attributes["custom_attribute"])
+    end
+  end
+
+== Building objects
+
+The default way to build new objects or update existing ones is to merge their attributes with detected ones. To provide custom building logic override your model's +merge_attributes_on_import+ instance method.
+
+  def merge_attributes_on_import(import, attributes)
+    self.attributes  = attributes
+    self.imported_at = Time.now
+  end
+
 == Note on Patches/Pull Requests
 
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/importer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{importer}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Micha\305\202 Szajbe"]
-  s.date = %q{2010-04-07}
+  s.date = %q{2010-04-16}
   s.description = %q{Define new objects or modifications of existing ones in external file (xml, csv, etc) and import them to your application. Importer will not only import all the objects but also will give you detailed summary of the import process.}
   s.email = %q{michal.szajbe@gmail.com}
   s.extra_rdoc_files = [
@@ -54,7 +54,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/szajbus/importer}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Import objects from external files}
   s.test_files = [
     "test/factories.rb",

data/lib/importer/adapters/active_record_adapter.rb

@@ -42,8 +42,9 @@ module Importer
         # * +import+ - by default importer returns instance of +Import+ class that contains
         #   detailed report of import process, you can implement your own Import class and force
         #   the importer to use it by passing it's class here
+        # * +import_options+ - options passed to Import instance on it's initialization
         def import(file, options = {})
-          import = (options[:import] || Importer::Import).new
+          import = (options[:import] || Importer::Import).new(options[:import_options])
           parser =  options[:parser] || Importer::Parser.get_klass(file)
           data   = parser.run(file)
 

data/lib/importer/adapters/mongo_mapper_adapter.rb

@@ -46,8 +46,9 @@ module Importer
         # * +import+ - by default importer returns instance of +Import+ class that contains
         #   detailed report of import process, you can implement your own Import class and force
         #   the importer to use it by passing it's class here
+        # * +import_options+ - options passed to Import instance on it's initialization
         def import(file, options = {})
-          import = (options[:import] || Importer::Import).new
+          import = (options[:import] || Importer::Import).new(options[:import_options])
           parser =  options[:parser] || Importer::Parser.get_klass(file)
           data   = parser.run(file)
 

data/lib/importer/import.rb

@@ -14,10 +14,11 @@ module Importer
   # Just be sure to implement +add_object+ and +build_imported_object+
   # methods in your custom class.
   class Import
-    attr_reader :imported_objects
+    attr_reader :options, :imported_objects
 
-    def initialize
+    def initialize(options = nil)
       @imported_objects = []
+      @options          = options
     end
 
     def add_object(imported_object)
@@ -40,4 +41,4 @@ module Importer
       imported_objects.select { |object| object.state == 'invalid_object' }
     end
   end
-end
+end

data/test/importer/adapters/active_record_adapter_test.rb

@@ -111,4 +111,17 @@ class Importer::Adapters::ActiveRecordAdapterTest < Test::Unit::TestCase
       end
     end
   end
+
+  context "passing import_options to #import method" do
+    setup do
+      stub(Importer::Parser::Xml).run(fixture_file("empty.xml")) { [] }
+
+      @options = { :key => 'value' }
+      @import = Product.import(fixture_file("empty.xml"), :import_options => @options)
+    end
+
+    should "pass the options to Import instance" do
+      assert_equal @options, @import.options
+    end
+  end
 end

data/test/importer/adapters/mongo_mapper_adapter_test.rb

@@ -112,4 +112,17 @@ class Importer::Adapters::MongoMapperAdapterTest < Test::Unit::TestCase
       end
     end
   end
+
+  context "passing import_options to #import method" do
+    setup do
+      stub(Importer::Parser::Xml).run("empty.xml") { [] }
+
+      @options = { :key => 'value' }
+      @import = Product.import(fixture_file("empty.xml"), :import_options => @options)
+    end
+
+    should "pass the options to Import instance" do
+      assert_equal @options, @import.options
+    end
+  end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: importer
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - "Micha\xC5\x82 Szajbe"
@@ -9,69 +14,87 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-07 00:00:00 +02:00
+date: 2010-04-16 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: crack
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 6
         version: 0.1.6
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: fastercsv
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 0
         version: 1.5.0
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: activerecord
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: mongo_mapper
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 0
         version: 0.7.0
-    version: 
+  type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: sqlite3-ruby
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id006
 description: Define new objects or modifications of existing ones in external file (xml, csv, etc) and import them to your application. Importer will not only import all the objects but also will give you detailed summary of the import process.
 email: michal.szajbe@gmail.com
 executables: []
@@ -128,18 +151,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Import objects from external files