ar_loader 0.0.6 → 0.0.8

data/lib/loaders/spree/product_loader.rb

@@ -1,92 +1,141 @@
-# Copyright:: (c) Autotelik Media Ltd 2010
-# Author ::   Tom Statter
-# Date ::     Aug 2010
-# License::   MIT ?
-#
-# Details::   Specific over-rides/additions to support Spree Products
-#
-require 'loader_base'
-
-class ProductLoader < LoaderBase
-
-  def initialize(klass = Product, product = nil)
-    super( klass, product )
-    raise "Failed to create Product for loading" unless @load_object
-  end
-
-  # What process a value string from a column, assigning value(s) to correct association on Product.
-  # Method map represents a column from a file and it's correlated Product association.
-  # Value string which may contain multiple values for a collection association.
-  # Product to assign that value to.
-  def process( method_map, value)
-    #puts "INFO: PRODUCT LOADER processing #{@load_object}"
-    @value = value
-
-    #puts "DEBUG : process #{method_map.inspect} : #{value.inspect}"
-    # Special case for OptionTypes as it's two stage process
-    # First add the possible option_types to Product, then we are able
-    # to define Variants on those options.
-    
-    if(method_map.name == 'option_types' && @value)
-
-      option_types = @value.split(@@multi_assoc_delim)
-      option_types.each do |ostr|
-        oname, value_str = ostr.split(@@name_value_delim)
-        option_type = OptionType.find_or_create_by_name(oname)
-        unless option_type
-          puts "WARNING: OptionType #{oname} NOT found - Not set Product"
-          next
-        end
-
-        @load_object.option_types << option_type unless @load_object.option_types.include?(option_type)
-
-        # Now get the value(s) for the option e.g red,blue,green for OptType 'colour'
-        ovalues = value_str.split(',')
-        ovalues.each_with_index do |ovname, i|
-          ovname.strip!
-          ov = OptionValue.find_by_name(ovname)
-          if ov
-            object = Variant.new( :sku => "#{@load_object.sku}_#{i}", :price => @load_object.price, :available_on => @load_object.available_on)
-            #puts "DEBUG: Create New Variant: #{object.inspect}"
-            object.option_values << ov
-            @load_object.variants << object
-          else
-            puts "WARNING: Option #{ovname} NOT FOUND - No Variant created"
-          end
-        end
-      end
-
-    # Special case for ProductProperties since it can have additional value applied.
-    # A list of Properties with a optional Value - supplied in form :
-    #   Property:value|Property2:value|Property3:value
-    #
-    elsif(method_map.name == 'product_properties' && @value)
-
-      property_list = @value.split(@@multi_assoc_delim)
-
-      property_list.each do |pstr|
-        pname, pvalue = pstr.split(@@name_value_delim)
-        property = Property.find_by_name(pname)
-        unless property
-          puts "WARNING: Property #{pname} NOT found - Not set Product"
-          next
-        end
-        @load_object.product_properties << ProductProperty.create( :property => property, :value => pvalue)
-      end
-
-    elsif(method_map.name == 'count_on_hand' && @load_object.variants.size > 0 &&
-          @value.is_a?(String) && @value.include?(@@multi_assoc_delim))
-      # Check if we processed Option Types and assign count per option
-      values = @value.split(@@multi_assoc_delim)
-      if(@load_object.variants.size == values.size)
-        @load_object.variants.each_with_index {|v, i| v.count_on_hand == values[i] }
-      else
-        puts "WARNING: Count on hand entries does not match number of Variants"
-      end
-
-    else
-      super(method_map, value)
-    end
-
-  end
+# Copyright:: (c) Autotelik Media Ltd 2010
+# Author ::   Tom Statter
+# Date ::     Aug 2010
+# License::   MIT ?
+#
+# Details::   Specific over-rides/additions to support Spree Products
+#
+require 'loader_base'
+require 'excel_loader'
+
+
+module ARLoader
+
+  class ProductLoader < ExcelLoader
+    
+    def initialize(product = nil)
+      super( Product, product )
+      raise "Failed to create Product for loading" unless @load_object
+    end
+
+    # What process a value string from a column, assigning value(s) to correct association on Product.
+    # Method map represents a column from a file and it's correlated Product association.
+    # Value string which may contain multiple values for a collection association.
+    # Product to assign that value to.
+    def process( method_detail, value)
+
+      @current_value = value
+      @current_method_detail = method_detail
+
+      #puts "DEBUG: process #{method_detail.inspect} : #{current_value.inspect}"
+      # Special case for OptionTypes as it's two stage process
+      # First add the possible option_types to Product, then we are able
+      # to define Variants on those options values.
+
+      if(method_detail.operator?('option_types') && current_value)
+
+        #puts "DEBUG: Special Case: VARIANTS: #{method_detail.inspect} : #{current_value.inspect}"
+
+        # TODO smart column ordering to ensure always valid by time we get to associations
+        save if(load_object.valid? && load_object.new_record?)
+
+        option_types = current_value.split(@@multi_assoc_delim)
+
+        option_types.each do |ostr|
+          oname, value_str = ostr.split(@@name_value_delim)
+          option_type = OptionType.find_or_create_by_name(oname)
+          unless option_type
+            puts "WARNING: OptionType #{oname} NOT found - Not set Product"
+            next
+          end
+
+          @load_object.option_types << option_type unless @load_object.option_types.include?(option_type)
+
+          # Now get the value(s) for the option e.g red,blue,green for OptType 'colour'
+          ovalues = value_str.split(',')
+
+          ovalues.each_with_index do |ovname, i|
+            ovname.strip!
+            ov = OptionValue.find_or_create_by_name(ovname)
+            if ov
+              object = Variant.new( :sku => "#{@load_object.sku}_#{i}", :price => @load_object.price, :available_on => @load_object.available_on)
+              #puts "DEBUG: Create New Variant: #{object.inspect}"
+              object.option_values << ov
+              @load_object.variants << object
+            else
+              puts "WARNING: Option #{ovname} NOT FOUND - No Variant created"
+            end
+          end
+        end
+
+      elsif(method_detail.operator?('taxons') && current_value)
+
+        # TODO smart column ordering to ensure always valid by time we get to associations
+        save if(load_object.valid? && load_object.new_record?)
+
+        name_list = current_value.split(@@multi_assoc_delim)
+
+        taxons = name_list.collect do |t|
+
+          taxon = Taxon.find_by_name(t)
+
+          unless taxon
+            parent = Taxonomy.find_by_name(t)
+
+            #puts "DEBUG: Taxonomy #{parent} for #{t}"
+            begin
+              parent = Taxonomy.create!( :name => t ) unless parent
+
+              taxon = Taxon.create(:name => t, :taxonomy_id => parent.id)
+            rescue => e
+              e.backtrace
+              e.inspect
+              puts "ERROR : Cannot assign Taxon ['#{t}'] to Product ['#{load_object.name}']"
+              next
+            end
+          end
+          taxon
+        end
+
+        taxons.compact!
+  
+        @load_object.taxons << taxons unless(taxons.empty?)
+
+        # Special case for ProductProperties since it can have additional value applied.
+        # A list of Properties with a optional Value - supplied in form :
+        #   Property:value|Property2:value|Property3:value
+        #
+      elsif(method_detail.operator?('product_properties') && current_value)
+
+        # TODO smart column ordering to ensure always valid by time we get to associations
+        save if(load_object.valid? && load_object.new_record?)
+
+        property_list = current_value.split(@@multi_assoc_delim)
+
+        property_list.each do |pstr|
+          pname, pvalue = pstr.split(@@name_value_delim)
+          property = Property.find_by_name(pname)
+          unless property
+            puts "WARNING: Property #{pname} NOT found - Not set Product"
+            next
+          end
+          @load_object.product_properties << ProductProperty.create( :property => property, :value => pvalue)
+        end
+
+      elsif(method_detail.operator?('count_on_hand') && @load_object.variants.size > 0 && current_value.is_a?(String) && current_value.include?(@@multi_assoc_delim))
+        # Check if we processed Option Types and assign count per option
+        values = current_value.split(@@multi_assoc_delim)
+        if(@load_object.variants.size == values.size)
+          @load_object.variants.each_with_index {|v, i| v.count_on_hand == values[i] }
+        else
+          puts "WARNING: Count on hand entries does not match number of Variants"
+        end
+
+      else
+        super(method_detail, value)
+      end
+
+    end
+  end
+
 end

data/lib/to_b.rb

@@ -1,24 +1,24 @@
-class Object
-  def to_b
-    case self
-    when true, false: self
-    when nil: false
-    else
-      to_i != 0
-    end
-  end
-end
-
-class String
-  TRUE_REGEXP = /^(yes|true|on|t|1|\-1)$/i.freeze
-  FALSE_REGEXP = /^(no|false|off|f|0)$/i.freeze
-
-  def to_b
-    case self
-    when TRUE_REGEXP: true
-    when FALSE_REGEXP: false
-    else
-      to_i != 0
-    end
-  end
-end
+class Object
+  def to_b
+    case self
+    when true, false: self
+    when nil: false
+    else
+      to_i != 0
+    end
+  end
+end
+
+class String
+  TRUE_REGEXP = /^(yes|true|on|t|1|\-1)$/i.freeze
+  FALSE_REGEXP = /^(no|false|off|f|0)$/i.freeze
+
+  def to_b
+    case self
+    when TRUE_REGEXP: true
+    when FALSE_REGEXP: false
+    else
+      to_i != 0
+    end
+  end
+end

data/spec/csv_loader_spec.rb

@@ -0,0 +1,27 @@
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Aug 2011
+# License::   MIT
+#
+# Details::   Specs for Excel aspect of Active Record Loader
+#
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'erb'
+require 'excel_loader'
+
+describe 'CSV Loader' do
+
+  before(:all) do
+    db_connect( 'test_file' )    # , test_memory, test_mysql
+    migrate_up
+    @klazz = Project
+  end
+  
+  before(:each) do
+    MethodMapper.clear
+    MethodMapper.find_operators( @klazz )
+    MethodMapper.find_operators( @assoc_klazz )
+  end
+
+end

data/spec/database.yml

@@ -1,6 +1,19 @@
-<% adapter = 'jdbcsqlite3' %>
-
-test:
-  adapter: <%= adapter %>
-  encoding: utf8
-  database: :memory
+<% adapter = 'sqlite3' %>
+<% adapter = 'jdbcsqlite3' if(Guards::jruby? ) %>
+
+test_mysql:
+  adapter: jdbcmysql
+  database: ar_loader_test
+  username: test
+  password: test
+  host: localhost
+
+test_memory:
+  adapter: <%= adapter %>
+  database: :memory
+
+test_file:
+  adapter: <%= adapter %>
+  database: 'ar_loader_test'
+  encoding: utf8
+  host: localhost

data/spec/db/migrate/20110803201325_create_test_bed.rb

@@ -0,0 +1,78 @@
+class CreateTestBed < ActiveRecord::Migration
+  
+  def self.up
+
+    # has many :milestones
+    create_table :projects do |t|
+      t.string   :title
+      t.string   :value_as_string
+      t.text     :value_as_text
+      t.boolean  :value_as_boolean, :default => false
+      t.datetime :value_as_datetime, :default => nil
+      t.integer  :value_as_integer, :default => 0
+      t.decimal  :value_as_double, :precision => 8, :scale => 2, :default => 0.0
+      t.timestamps
+    end
+
+    # belongs_to  :project, project => has_many
+    create_table :milestones do |t|
+      t.string     :name
+      t.datetime   :datetime, :default => nil
+      t.decimal    :cost, :precision => 8, :scale => 2, :default => 0.0
+      t.references :project
+      t.timestamps
+    end
+
+    # belongs_to  :project, project => has_one
+    create_table :owners do |t|
+      t.string   :name
+      t.references :project
+      t.timestamps
+    end
+
+    # has_belongs_to_many :project
+    create_table :categories do |t|
+      t.string   :reference
+      t.timestamps
+    end
+
+    # testing has_belongs_to_many (hence no id)
+    create_table :categories_projects, :id => false do |t|
+      t.references :category
+      t.references :project
+    end
+
+    create_table :versions do |t|
+      t.string   :name
+      t.timestamps
+    end
+
+    # testing project has_many release + versions :through
+    create_table :loader_releases do |t|
+      t.string   :name
+      t.references :project
+      t.references :version
+      t.timestamps
+    end
+
+
+    create_table :long_and_complex_table_linked_to_versions do |t|
+      t.references :version
+    end
+
+    create_table :empties do |t|
+    end
+
+  end
+
+  def self.down
+    drop_table :projects
+    drop_table :categories
+    drop_table :loader_releases
+    drop_table :versions
+    drop_table :categories_projectss
+    drop_table :milestones
+    drop_table :long_and_complex_table_linked_to_versions
+    drop_table :empties
+  end
+end

data/spec/excel_loader_spec.rb

@@ -1,99 +1,114 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-require 'erb'
-require File.dirname(__FILE__) + '/../lib/ar_loader'
-
-# We are not setup as a Rails project so need to mimic an active record database setup so
-# we have some  AR models top test against. Create an in memory database from scratch.
-# 
-def db_connect( env = 'test')
-
-  configuration = {:rails_env => env }
-
-  # Some active record stuff seems to rely on the RAILS_ENV being set ?
-
-  ENV['RAILS_ENV'] = configuration[:rails_env]
-
-  configuration[:database_configuration] = YAML::load(ERB.new(IO.read( File.dirname(__FILE__) + '/database.yml')).result)
-  db = configuration[:database_configuration][ configuration[:rails_env] ]
-
-  puts "Setting DB Config - #{db.inspect}"
-  ActiveRecord::Base.configurations = db
-
-  puts "Connecting to DB"
-  ActiveRecord::Base.establish_connection( db )
-
-  puts "Connected to DB Config - #{configuration[:rails_env]}"
-end
-
-def create_in_memory_database
-  ActiveRecord::Migrator.up('db/migrate')
-end
-
-
-class TestModel < ActiveRecord::Base
-  has_many :TestAssociationModel
-end
-
-class TestAssociationModel < ActiveRecord::Base
-  belongs_to :test_model
-end
-
-describe 'ExcelLoader' do
-
-  before do
-    db_connect
-    create_in_memory_database
-    @klazz = TestModel
-    MethodMapper.clear
-  end
-  
-  it "should populate operators for a given AR model" do
-    MethodMapper.find_operators( @klazz )
-
-    MethodMapper.has_many.should_not be_empty
-    MethodMapper.assignments.should_not be_empty
-
-    hmf = MethodMapper.has_many_for(@klazz)
-    arf = MethodMapper.assignments_for(@klazz)
-
-    (hmf & arf).should_not be_empty       # Associations provide << or =
-
-    MethodMapper.column_types.should be_is_a(Hash)
-    MethodMapper.column_types.should_not be_empty
-
-  end
-
-  it "should populate operators respecting unique option" do
-    MethodMapper.find_operators( @klazz, :unique => true )
-
-    hmf = MethodMapper.has_many_for(@klazz)
-    arf = MethodMapper.assignments_for(@klazz)
-
-    (hmf & arf).should be_empty
-  end
-
-  it "should populate assignment method and col type for different forms of a column name" do
-
-    MethodMapper.find_operators( @klazz )
-  end
-
-  it "should populate both methods for different forms of an association name" do
-
-    MethodMapper.find_operators( @klazz )
-  end
-
-  it "should not populate anything when  non existent column name" do
-    MethodMapper.find_operators( @klazz )
-  end
-
-  it "should enable correct assignment and sending of a value to AR model" do
-    MethodMapper.find_operators( @klazz )
-  end
-
-  it "should enable correct assignment and sending of association to AR model" do
-    MethodMapper.find_operators( @klazz )
-  end
-
-
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Aug 2011
+# License::   MIT
+#
+# Details::   Specs for Excel aspect of Active Record Loader
+#
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'erb'
+require 'excel_loader'
+
+include ARLoader
+
+describe 'Excel Loader' do
+
+  before(:all) do
+    db_connect( 'test_file' )    # , test_memory, test_mysql
+
+    db_clear()    # todo read up about proper transactional fixtures
+
+
+    @klazz = Project
+    @assoc_klazz = Category
+  end
+  
+  before(:each) do
+
+    Project.delete_all
+    
+    %w{category_001 category_002 category_003}.each do |cat|
+      @assoc_klazz.find_or_create_by_reference(cat)
+    end
+
+
+    MethodMapper.clear
+    MethodMapper.find_operators( @klazz )
+    MethodMapper.find_operators( @assoc_klazz )
+  end
+  
+  it "should be able to create a new excel loader and load object" do
+    loader = ExcelLoader.new( @klazz)
+    
+    loader.load_object.should_not be_nil
+    loader.load_object.should be_is_a(@klazz)
+    loader.load_object.new_record?.should be_true
+  end
+  
+  it "should process a simple .xls spreedsheet" do
+  
+    loader = ExcelLoader.new(@klazz)
+ 
+    count = @klazz.count
+    loader.load( $fixture_path + '/SimpleProjects.xls')
+  
+    loader.loaded_count.should == (@klazz.count - count)
+  
+  end
+
+  it "should process associations in .xls spreedsheet" do
+
+    @klazz.find_by_title('001').should be_nil
+    count = @klazz.count
+
+    loader = ExcelLoader.new(@klazz)
+    
+    loader.load( $fixture_path + '/DemoTestModelAssoc.xls')
+
+    loader.loaded_count.should be > 3
+    loader.loaded_count.should == (@klazz.count - count)
+
+    {'001' => 2, '002' => 1, '003' => 3, '004' => 0 }.each do|title, expected|
+      project = @klazz.find_by_title(title)
+
+      project.should_not be_nil
+      puts "#{project.inspect} [#{project.categories.size}]"
+      
+      project.should have(expected).categories
+    end
+  end
+
+  it "should process multiple associations in excel spreedsheet" do
+  
+    loader = ExcelLoader.new(Project)
+  
+    count = Project.count
+    loader.load( $fixture_path + '/ProjectsMultiCategories.xls')
+  
+    loader.loaded_count.should == (Project.count - count)
+  
+    {'004' => 3, '005' => 1, '006' => 0, '007' => 1 }.each do|title, expected|
+      project = @klazz.find_by_title(title)
+  
+      project.should_not be_nil
+      puts "#{project.inspect} [#{project.categories.size}]"
+
+      project.should have(expected).categories
+    end
+  
+  end
+  
+  it "should not process badly defined excel spreedsheet" do
+    loader = ExcelLoader.new(Project)
+    expect {loader.load( $fixture_path + '/BadAssociationName.xls')}.to raise_error(MappingDefinitionError)
+  end
+
+  #@pending
+  it "should raise an error when mandatory columns missing" do
+    #loader = ExcelLoader.new(Project)
+    #required = [:x, :. :z]
+    #expect {loader.load( $fixture_path + '/BadAssociationName.xls', { :mandatopry:=> required}) }.to raise_error(????????)
+  end
+
 end