importer 0.3.0

data/test/importer/import/active_record_test.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+class Importer::Import::ActiveRecordTest < Test::Unit::TestCase
+  context "" do
+    setup do
+      @product = Factory(:product, :customid => "1", :name => "A pink ball", :description => "Round glass ball.", :price => 86)
+    end
+
+    context "importing from an XML file" do
+      setup do
+        @import = Product.import(fixture_file("products.xml"))
+      end
+
+      should "create one new product" do
+        assert_equal 1, @import.new_objects_count
+      end
+
+      should "modify one existing product" do
+        assert_equal 1, @import.existing_objects_count
+      end
+
+      should "not save one product because of errors" do
+        assert_equal 1, @import.invalid_objects_count
+      end
+    end
+  end
+end

data/test/importer/import/simple_test.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+class Importer::Import::SimpleTest < Test::Unit::TestCase
+  context "" do
+    setup do
+      @product = Factory(:product, :customid => "1", :name => "A pink ball", :description => "Round glass ball.", :price => 86)
+    end
+
+    context "importing from an XML file" do
+      setup do
+        @import = Product.import(fixture_file("products.xml"), :import => Factory(:simple_import))
+      end
+
+      should "create one new product" do
+        assert_equal 1, @import.new_objects_count
+      end
+
+      should "modify one existing product" do
+        assert_equal 1, @import.existing_objects_count
+      end
+
+      should "not save one product because of errors" do
+        assert_equal 1, @import.invalid_objects_count
+      end
+    end
+  end
+end

data/test/importer/imported_object/active_record_test.rb

@@ -0,0 +1,37 @@
+require 'helper'
+
+class Importer::ImportedObject::ActiveRecordTest < Test::Unit::TestCase
+  context "given an import" do
+    setup { @import = Factory(:active_record_import) }
+
+    context "creating a new imported object" do
+      setup { Factory(:active_record_imported_object, :import => @import, :state => "new_object") }
+
+      should_change("import's new_objects_count", :by => 1) { @import.reload.new_objects_count }
+    end
+
+    context "with an imported object" do
+      setup { @imported_object = Factory(:active_record_imported_object, :import => @import, :state => "new_object") }
+
+      context "destroying the imported object" do
+        setup { @imported_object.destroy }
+
+        should_change("import's new_objects_count", :by => -1) { @import.reload.new_objects_count }
+      end
+    end
+  end
+
+  context "creating new imported object" do
+    setup { @imported_object = Factory(:active_record_imported_object, :data => { "a" => "b" }, :validation_errors => { "c" => "d" }) }
+
+    should "serialize it's data" do
+      data = { "a" => "b" }
+      assert_equal data, @imported_object.data
+    end
+
+    should "serialize it's validation errors" do
+      validation_errors = { "c" => "d" }
+      assert_equal validation_errors, @imported_object.validation_errors
+    end
+  end
+end

data/test/importer/imported_object/simple_test.rb

@@ -0,0 +1,35 @@
+require 'helper'
+
+class Importer::ImportedObject::SimpleTest < Test::Unit::TestCase
+  context "given an import" do
+    setup { @import = Factory(:simple_import) }
+
+    context "creating a new imported object" do
+      setup do
+        imported_object       = Importer::ImportedObject::Simple.new(:import => @import)
+        imported_object.state = "new_object"
+        imported_object.save
+      end
+
+      should_change("import's new_objects_count", :by => 1) { @import.new_objects_count }
+    end
+
+    context "creating new imported object" do
+      setup do
+        @imported_object                   = Importer::ImportedObject::Simple.new(:import => @import)
+        @imported_object.data              = { "a" => "b" }
+        @imported_object.validation_errors = { "c" => "d" }
+      end
+
+      should "correctly set/get data" do
+        data = { "a" => "b" }
+        assert_equal data, @imported_object.data
+      end
+
+      should "correctly set/get validation errors" do
+        validation_errors = { "c" => "d" }
+        assert_equal validation_errors, @imported_object.validation_errors
+      end
+    end
+  end
+end

data/test/importer/imported_object_test.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+class Importer::ImportedObjectTest < Test::Unit::TestCase
+  should "return ActiveRecord imported object for ActiveRecord import" do
+    import = Factory(:active_record_import)
+    assert_equal Importer::ImportedObject::ActiveRecord, Importer::ImportedObject.get_klass(import)
+  end
+
+  should "return Simple imported object for Simple import" do
+    import = Factory(:simple_import)
+    assert_equal Importer::ImportedObject::Simple, Importer::ImportedObject.get_klass(import)
+  end
+end

data/test/importer/parser/csv_test.rb

@@ -0,0 +1,59 @@
+require 'helper'
+
+class Importer::Parser::CsvTest < Test::Unit::TestCase
+  context "parsing an CSV file with many objects defined" do
+    setup { @data = Importer::Parser::Csv.run(fixture_file("products.csv")) }
+
+    should "detect all objects" do
+      product1 = {
+        "customid"    => "1",
+        "name"        => "A black ball",
+        "description" => "Round glass ball.",
+        "price"       => "86.00"
+      }
+
+      product2 = {
+        "customid"    => "2",
+        "name"        => "A red hat",
+        "description" => "Party hat.",
+        "price"       => "114.00"
+      }
+
+      product3 = {
+        "customid"    => "3",
+        "name"        => "A white ribbon",
+        "description" => "A really long one.",
+        "price"       => "oops"
+      }
+
+      assert @data.include?(product1)
+      assert @data.include?(product2)
+      assert @data.include?(product3)
+      assert_equal 3, @data.size
+    end
+  end
+
+  context "parsing an CSV file with one object defined" do
+    setup { @data = Importer::Parser::Csv.run(fixture_file("product.csv")) }
+
+    should "detect one object" do
+      product1 = {
+        "customid"    => "1",
+        "name"        => "A black ball",
+        "description" => "Round glass ball.",
+        "price"       => "86.00"
+      }
+
+      assert_equal [product1], @data
+    end
+  end
+
+  context "parsing an CSV file with no objects defined" do
+    setup { @data = Importer::Parser::Csv.run(fixture_file("empty.csv")) }
+
+    should "detect no objects" do
+      assert_equal [], @data
+    end
+  end
+
+end

data/test/importer/parser/xml_test.rb

@@ -0,0 +1,58 @@
+require 'helper'
+
+class Importer::Parser::XmlTest < Test::Unit::TestCase
+  context "parsing an XML file with many objects defined" do
+    setup { @data = Importer::Parser::Xml.run(fixture_file("products.xml")) }
+
+    should "detect all objects" do
+      product1 = {
+        "customid"    => "1",
+        "name"        => "A black ball",
+        "description" => "Round glass ball.",
+        "price"       => "86.00"
+      }
+
+      product2 = {
+        "customid"    => "2",
+        "name"        => "A red hat",
+        "description" => "Party hat.",
+        "price"       => "114.00"
+      }
+
+      product3 = {
+        "customid"    => "3",
+        "name"        => "A white ribbon",
+        "description" => "A really long one.",
+        "price"       => "oops"
+      }
+
+      assert @data.include?(product1)
+      assert @data.include?(product2)
+      assert @data.include?(product3)
+      assert_equal 3, @data.size
+    end
+  end
+
+  context "parsing an XML file with one object defined" do
+    setup { @data = Importer::Parser::Xml.run(fixture_file("product.xml")) }
+
+    should "detect one object" do
+      product1 = {
+        "customid"    => "1",
+        "name"        => "A black ball",
+        "description" => "Round glass ball.",
+        "price"       => "86.00"
+      }
+
+      assert_equal [product1], @data
+    end
+  end
+
+  context "parsing an XML file with no objects defined" do
+    setup { @data = Importer::Parser::Xml.run(fixture_file("empty.xml")) }
+
+    should "detect no objects" do
+      assert_equal [], @data
+    end
+  end
+end

data/test/importer/parser_test.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+class Importer::ParserTest < Test::Unit::TestCase
+  should "return Xml parser for file with .xml extension" do
+    assert_equal Importer::Parser::Xml, Importer::Parser.get_klass("file.xml")
+  end
+
+  should "raise exception if no parser can be found for file" do
+    assert_raises Importer::ParserNotFoundError do
+      Importer::Parser.get_klass("file.unknown")
+    end
+  end
+end

data/test/importer_test.rb

@@ -0,0 +1,50 @@
+require 'helper'
+
+class ImporterTest < Test::Unit::TestCase
+  context "" do
+    setup do
+      @product = Factory(:product, :customid => "1", :name => "A pink ball", :description => "Round glass ball.", :price => 86)
+      @import = Importer::Import::ActiveRecord.create
+    end
+
+    context "importing from an XML file" do
+      setup do
+        Product.import(fixture_file("products.xml"), :import => @import)
+      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_change("imported objects counts", :by => 3) { Importer::ImportedObject::ActiveRecord.count }
+
+      should_change("import's workflow state", :to => "finished") { @import.reload.workflow_state }
+    end
+
+    context "when there is exception raised while importing from an XML file" do
+      setup do
+        begin
+          InvalidProduct.import(fixture_file("products.xml"), :import => @import)
+        rescue ::Exception => e
+          @exception = e
+        end
+      end
+
+      should_not_change("product's name") { @product.reload.name }
+      should_not_change("products count") { InvalidProduct.count }
+      should_not_change("imported objects count") { Importer::ImportedObject::ActiveRecord.count }
+      should_not_change("import's workflow state") { @import.reload.workflow_state }
+      should "propagate exception" do
+        assert_equal "An error occured.", @exception.message
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification 
+name: importer
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- "Micha\xC5\x82 Szajbe"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: crack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: workflow
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: factory_girl
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Define new objects or modifications of existing ones in XML file and import them to your application.
+email: michal.szajbe@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- importer.gemspec
+- lib/importer.rb
+- lib/importer/import.rb
+- lib/importer/import/active_record.rb
+- lib/importer/import/simple.rb
+- lib/importer/imported_object.rb
+- lib/importer/imported_object/active_record.rb
+- lib/importer/imported_object/simple.rb
+- lib/importer/parser.rb
+- lib/importer/parser/base.rb
+- lib/importer/parser/csv.rb
+- lib/importer/parser/xml.rb
+- rails/init.rb
+- rails_generators/importer/importer_generator.rb
+- rails_generators/importer/templates/imported_objects_migration.rb
+- rails_generators/importer/templates/imports_migration.rb
+- test/database.yml
+- test/factories.rb
+- test/fixtures/empty.csv
+- test/fixtures/empty.xml
+- test/fixtures/product.csv
+- test/fixtures/product.xml
+- test/fixtures/products.csv
+- test/fixtures/products.xml
+- test/helper.rb
+- test/importer/import/active_record_test.rb
+- test/importer/import/simple_test.rb
+- test/importer/imported_object/active_record_test.rb
+- test/importer/imported_object/simple_test.rb
+- test/importer/imported_object_test.rb
+- test/importer/parser/csv_test.rb
+- test/importer/parser/xml_test.rb
+- test/importer/parser_test.rb
+- test/importer_test.rb
+has_rdoc: true
+homepage: http://github.com/szajbus/importer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Import objects from XML files
+test_files: 
+- test/factories.rb
+- test/helper.rb
+- test/importer/import/active_record_test.rb
+- test/importer/import/simple_test.rb
+- test/importer/imported_object/active_record_test.rb
+- test/importer/imported_object/simple_test.rb
+- test/importer/imported_object_test.rb
+- test/importer/parser/csv_test.rb
+- test/importer/parser/xml_test.rb
+- test/importer/parser_test.rb
+- test/importer_test.rb