importer 0.3.2 → 0.4.0

data/lib/importer/import.rb

@@ -1,5 +1,43 @@
 module Importer
-  module Import
+  # Summary of import.
+  # Contains detailed information about import process, all imported objects,
+  # no matter if they were imported successfully or not.
+  #
+  # The importer builds it's Import instance by adding imported objects via
+  # +add_object+.
+  #
+  # If you want to have your own implementation of Import summary
+  # (f.e. activerecord-based), you can force the importer to use it with:
+  #
+  #    Product.import(path_to_xml_or_csv_file, :import => CustomImportClass)
+  #
+  # Just be sure to implement +add_object+ and +build_imported_object+
+  # methods in your custom class.
+  class Import
+    attr_reader :imported_objects
 
+    def initialize
+      @imported_objects = []
+    end
+
+    def add_object(imported_object)
+      imported_objects << imported_object
+    end
+
+    def build_imported_object
+      ImportedObject.new
+    end
+
+    def new_imported_objects
+      imported_objects.select { |object| object.state == 'new_object' }
+    end
+
+    def existing_imported_objects
+      imported_objects.select { |object| object.state == 'existing_object' }
+    end
+
+    def invalid_imported_objects
+      imported_objects.select { |object| object.state == 'invalid_object' }
+    end
   end
 end

data/lib/importer/imported_object.rb

@@ -1,5 +1,32 @@
 module Importer
-  module ImportedObject
+  # Instances of this class are created during import process and contain
+  # detailed information about imported objects.
+  #
+  # Attributes:
+  # * +state+ - an imported object can be in one of three states:
+  #   * new_object - new object was detected and successfully imported
+  #   * existing_object - already existing object was detected and successfully
+  #     imported
+  #   * invalid_object - detected object could not have been imported because of
+  #     validation errors
+  # * +object+ - pointer to actual object created or updated during import
+  # * +data+ - detected object's attributes hash
+  # * +validation_errors+ - list of validation errors for invalid object
+  #
+  # Instances of this class are built via Import's +build_imported_object+ method.
+  #
+  # If you need you can implement your own version of ImportedObject class
+  # (f.e. activerecord-based). To use it you must also implement custom version of
+  # +Import+ class that builds instances of CustomImportedObject with it's
+  # +build_imported_object+ method.
+  class ImportedObject
+    attr_accessor :state, :object, :data, :validation_errors
 
+    def initialize(attributes = {})
+      @state             = attributes[:state]
+      @object            = attributes[:object]
+      @data              = attributes[:data]
+      @validation_errors = attributes[:validation_errors]
+    end
   end
-end
+end

data/lib/importer/parser/base.rb

@@ -2,6 +2,10 @@ module Importer
   module Parser
     # Extend this class if you want to provide a custom parser.
     # You only need to implement +run+ instance method in subclasses.
+    #
+    # To force the importer to use your custom parser use:
+    #
+    #    Product.import(file, :parser => CustomParserClass)
     class Base
 
       class << self

data/lib/importer/parser/csv.rb

@@ -1,9 +1,9 @@
 require 'fastercsv'
 
-# CSV parser
-# It uses fastercsv lib to parse the files.
 module Importer
   module Parser
+    # CSV parser
+    # Uses fastercsv lib to parse the CSV files.
     class Csv < Base
       def run
         @data = []

data/lib/importer/parser/xml.rb

@@ -1,9 +1,9 @@
 require 'crack/xml'
 
-# XML parser
-# It uses crack/xml lib to parse the files.
 module Importer
   module Parser
+    # XML parser
+    # Uses crack/xml lib to parse the XML files.
     class Xml < Base
       def run
         @data = []

data/test/factories.rb

@@ -1,11 +1,2 @@
-Factory.define :active_record_import, :class => Importer::Import::ActiveRecord do |f|
-end
-
-Factory.define :active_record_imported_object, :class => Importer::ImportedObject::ActiveRecord do |f|
-end
-
-Factory.define :simple_import, :class => Importer::Import::Simple do |f|
-end
-
 Factory.define :product do |f|
 end

data/test/helper.rb

@@ -1,46 +1,23 @@
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
+require 'rr'
+require 'active_record'
+require 'mongo_mapper'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require 'importer'
 
 config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'database.yml')))
 ActiveRecord::Base.establish_connection(config['test'])
 
-require 'factory_girl'
-require 'factories'
+MongoMapper.connection = Mongo::Connection.new('127.0.0.1', 27017)
+MongoMapper.database = 'importer-test'
 
 class Test::Unit::TestCase
-  def setup
-    reset_tables
-  end
-
-  def reset_tables
-    ActiveRecord::Base.connection.create_table :products, { :force => true } do |t|
-      t.string  :customid
-      t.string  :name
-      t.string  :description
-      t.decimal :price
-    end
-
-    ActiveRecord::Base.connection.create_table :imports, { :force => true } do |t|
-      t.integer :new_objects_count,       :default => 0
-      t.integer :existing_objects_count,  :default => 0
-      t.integer :invalid_objects_count,   :default => 0
-      t.string  :workflow_state,          :default => "ready"
-    end
-
-    ActiveRecord::Base.connection.create_table :imported_objects, { :force => true } do |t|
-      t.integer :import_id
-      t.string  :object_type
-      t.integer :object_id
-      t.string  :data
-      t.string  :validation_errors
-      t.string  :state
-    end
-  end
+  include RR::Adapters::TestUnit
 
   # return path to a fixture file from test/fixtures dir
   def fixture_file(file)
@@ -48,24 +25,13 @@ class Test::Unit::TestCase
   end
 end
 
-class Product < ActiveRecord::Base
-  include Importer
-
-  validates_numericality_of :price
-
-  def self.find_on_import(import, attributes)
-    find_by_customid(attributes["customid"])
-  end
+def def_class(class_name, parent_class = Object, &blk)
+  undef_class(class_name)
+  klass = Object.const_set(class_name, Class.new(parent_class))
+  klass.module_eval(&blk)
+  klass
 end
 
-class InvalidProduct < Product
-  set_table_name "products"
-
-  def self.find_on_import(import, attributes)
-    if attributes["customid"] == "3"
-      raise ::Exception.new("An error occured.")
-    else
-      super
-    end
-  end
+def undef_class(class_name)
+  Object.send(:remove_const, class_name) rescue nil
 end

data/test/importer/adapters/active_record_adapter_test.rb

@@ -0,0 +1,114 @@
+require 'helper'
+
+class Importer::Adapters::ActiveRecordAdapterTest < Test::Unit::TestCase
+  def setup
+    ActiveRecord::Base.connection.create_table :products, { :force => true } do |t|
+      t.string  :customid
+      t.string  :name
+      t.string  :description
+      t.decimal :price
+    end
+
+    def_class("Product", ActiveRecord::Base) do
+      include Importer
+
+      validates_numericality_of :price
+
+      def self.find_on_import(import, attributes)
+        find_by_customid(attributes["customid"])
+      end
+    end
+  end
+
+  def teardown
+    undef_class("Product")
+  end
+
+  context "" do
+    setup do
+      @product = Product.create(:customid => "1", :name => "A pink ball", :description => "Round glass ball.", :price => 86)
+    end
+
+    context "importing objects" do
+      setup do
+        @new_object      = { "name" => "A red hat", "customid"=>"2", "price" => "114.00", "description" => "Party hat." }
+        @existing_object = { "name" => "A black ball", "customid"=>"1", "price" => "86.00", "description" => "Round glass ball." }
+        @invalid_object  = { "name" => "A white ribbon", "customid"=>"3", "price" => "oops", "description" => "A really long one." }
+
+        data = [ @new_object, @existing_object, @invalid_object ]
+
+        stub(Importer::Parser::Xml).run(fixture_file("products.xml")) { data }
+
+        @import = Product.import(fixture_file("products.xml"))
+      end
+
+      should_change("product's name", :from => "A pink ball", :to => "A black ball") { @product.reload.name }
+
+      should_change("products count", :by => 1) { Product.count }
+      should "correctly create new product" do
+        product = Product.last
+
+        assert_equal "A red hat", product.name
+        assert_equal "Party hat.", product.description
+        assert_equal 114, product.price
+        assert_equal "2", product.customid
+      end
+
+      should "correctly summarize the import process" do
+        assert_equal 1, @import.new_imported_objects.size
+        assert_equal 1, @import.existing_imported_objects.size
+        assert_equal 1, @import.invalid_imported_objects.size
+      end
+
+      should "correctly build imported objects" do
+        new_object      = @import.new_imported_objects.first
+        existing_object = @import.existing_imported_objects.first
+        invalid_object  = @import.invalid_imported_objects.first
+
+        assert_equal @new_object,       new_object.data
+        assert_equal 'new_object',      new_object.state
+        assert_equal Product.last,      new_object.object
+
+        assert_equal @existing_object,  existing_object.data
+        assert_equal 'existing_object', existing_object.state
+        assert_equal @product,          existing_object.object
+
+        assert_equal @invalid_object,   invalid_object.data
+        assert_equal 'invalid_object',  invalid_object.state
+        assert_equal ["Price is not a number"], invalid_object.validation_errors
+      end
+    end
+
+    context "when there is exception during import process" do
+      setup do
+        def_class("InvalidProduct", Product) do
+          set_table_name "products"
+
+          def self.find_on_import(import, attributes)
+            if attributes["customid"] == "3"
+              raise ::Exception.new("An error occured.")
+            else
+              super
+            end
+          end
+        end
+
+        begin
+          InvalidProduct.import(fixture_file("products.xml"))
+        rescue ::Exception => e
+          @exception = e
+        end
+      end
+
+      def teardown
+        undef_class("InvalidProduct")
+      end
+
+      should_not_change("product's name") { @product.reload.name }
+      should_not_change("products count") { InvalidProduct.count }
+      should "propagate exception" do
+        assert_equal "An error occured.", @exception.message
+      end
+    end
+  end
+end

data/test/importer/adapters/mongo_mapper_adapter_test.rb

@@ -0,0 +1,115 @@
+require 'helper'
+
+class Importer::Adapters::MongoMapperAdapterTest < Test::Unit::TestCase
+  def setup
+    def_class("Product") do
+      include MongoMapper::Document
+      include Importer
+
+      key :customid,    String
+      key :name,        String
+      key :description, String
+      key :price,       Float
+
+      validates_numericality_of :price
+
+      def self.find_on_import(import, attributes)
+        find_by_customid(attributes["customid"])
+      end
+    end
+  end
+
+  def teardown
+    MongoMapper.database.drop_collection("products")
+    undef_class("Product")
+  end
+
+  context "" do
+    setup do
+      @product = Product.create(:customid => "1", :name => "A pink ball", :description => "Round glass ball.", :price => 86)
+    end
+
+    context "importing objects" do
+      setup do
+        @new_object      = { "name" => "A red hat", "customid"=>"2", "price" => "114.00", "description" => "Party hat." }
+        @existing_object = { "name" => "A black ball", "customid"=>"1", "price" => "86.00", "description" => "Round glass ball." }
+        @invalid_object  = { "name" => "A white ribbon", "customid"=>"3", "price" => "oops", "description" => "A really long one." }
+
+        data = [ @new_object, @existing_object, @invalid_object ]
+
+        stub(Importer::Parser::Xml).run(fixture_file("products.xml")) { data }
+
+        @import = Product.import(fixture_file("products.xml"))
+      end
+
+      should_change("product's name", :from => "A pink ball", :to => "A black ball") { @product.reload.name }
+
+      should_change("products count", :by => 1) { Product.count }
+      should "correctly create new product" do
+        product = Product.find_by_customid("2")
+
+        assert_equal "A red hat", product.name
+        assert_equal "Party hat.", product.description
+        assert_equal 114, product.price
+        assert_equal "2", product.customid
+      end
+
+      should "correctly summarize the import process" do
+        assert_equal 1, @import.new_imported_objects.size
+        assert_equal 1, @import.existing_imported_objects.size
+        assert_equal 1, @import.invalid_imported_objects.size
+      end
+
+      should "correctly build imported objects" do
+        new_object      = @import.new_imported_objects.first
+        existing_object = @import.existing_imported_objects.first
+        invalid_object  = @import.invalid_imported_objects.first
+
+        assert_equal @new_object,       new_object.data
+        assert_equal 'new_object',      new_object.state
+        assert_equal Product.find_by_customid("2"), new_object.object
+
+        assert_equal @existing_object,  existing_object.data
+        assert_equal 'existing_object', existing_object.state
+        assert_equal @product,          existing_object.object
+
+        assert_equal @invalid_object,   invalid_object.data
+        assert_equal 'invalid_object',  invalid_object.state
+        assert_equal ["Price must be a number"], invalid_object.validation_errors
+      end
+    end
+
+    context "when there is exception during import process" do
+      setup do
+        def_class("InvalidProduct", Product) do
+          include MongoMapper::Document
+          include Importer
+
+          set_collection_name "products"
+
+          def self.find_on_import(import, attributes)
+            if attributes["customid"] == "3"
+              raise ::Exception.new("An error occured.")
+            else
+              super
+            end
+          end
+        end
+
+        begin
+          InvalidProduct.import(fixture_file("products.xml"))
+        rescue ::Exception => e
+          @exception = e
+        end
+      end
+
+      def teardown
+        undef_class("InvalidProduct")
+      end
+
+      should "propagate exception" do
+        assert_equal "An error occured.", @exception.message
+      end
+    end
+  end
+end

data/test/importer/import_test.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+class Importer::ImportTest < Test::Unit::TestCase
+  def setup
+    @import = Importer::Import.new
+  end
+
+  context "when sent #build_imported_object" do
+    setup do
+      @imported_object = @import.build_imported_object
+    end
+
+    should "correctly return instance of Importer::ImportedObject" do
+      assert @imported_object.is_a?(Importer::ImportedObject)
+    end
+  end
+
+  context "import with some imported_object" do
+    setup do
+      @new_object      = Importer::ImportedObject.new(:state => 'new_object')
+      @existing_object = Importer::ImportedObject.new(:state => 'existing_object')
+      @invalid_object  = Importer::ImportedObject.new(:state => 'invalid_object')
+
+      @import.add_object(@new_object)
+      @import.add_object(@existing_object)
+      @import.add_object(@invalid_object)
+    end
+
+    should "correctly return all imported objects" do
+      assert_same_elements [@new_object, @existing_object, @invalid_object], @import.imported_objects
+    end
+
+    should "correctly return new_imported_objects" do
+      assert_same_elements [@new_object], @import.new_imported_objects
+    end
+
+    should "correctly return existing_imported_objects" do
+      assert_same_elements [@existing_object], @import.existing_imported_objects
+    end
+
+    should "correctly return invalid_imported_objects" do
+      assert_same_elements [@invalid_object], @import.invalid_imported_objects
+    end
+  end
+end