ar_loader 0.0.4 → 0.0.6

data/lib/engine/method_detail.rb

@@ -1,139 +1,140 @@
-# Copyright:: (c) Autotelik Media Ltd 2011
-# Author ::   Tom Statter
-# Date ::     Aug 2010
-# License::   MIT
-#
-# Details::   This class provides information and access to the individual methods
-#             on an AR model. Populated by, and coupled with MethodMapper,
-#             which does the model interrogation work.
-#             Enables 'loaders' to iterate over the MethodMapper results set,
-#             and assign values to AR object, without knowing anything about that receiving object.
-#
-# =>
-require 'to_b'
-
-class MethodDetail
-  
-  # When looking up an association, try each of these in turn till a match
-  #  i.e find_by_name .. find_by_title and so on
-  @@insistent_find_by_list ||= [:id, :name, :title]
-
-  attr_accessor :klass, :name, :assignment, :col_type
-  attr_accessor :has_many, :has_many_class_name, :has_many_class
-  attr_accessor :belongs_to, :belongs_to_class_name, :belongs_to_class
-
-  @@default_values = {}
-  @@prefixes = {}
-  
- 
-  def initialize(klass, name, assignment, belongs_to, has_many, col_type = nil)
-    @klass, @name, @assignment, @has_many, @belongs_to, @col_type = klass, name, assignment, has_many, belongs_to, col_type
-
-    if(@has_many)
-      begin
-        @has_many_class = Kernel.const_get(@has_many.classify)
-        @has_many_class_name = @has_many.classify
-      rescue
-      end
-    end
-
-    if(@belongs_to)
-      begin
-        @belongs_to_class = Kernel.const_get(@belongs_to.classify)
-        @belongs_to_class_name = @belongs_to.classify
-      rescue
-        # TODO - try other forms of the name, set to nil, or bomb out ?
-      end
-    end
-  end
-
-  def assign( record, value )
-    #puts "DEBUG: assign: [#{@name}]"
-
-    data = value
-
-    if(@@default_values[@name])
-      puts "WARNING nil value supplied for [#{@name}] - Using default : [#{@@default_values[@name]}]"
-      data = @@default_values[@name]
-    else
-      puts "WARNING nil value supplied for [#{@name}] - No default"
-    end if(data.nil?)
-    
-    data = "#{@@prefixes[@name]}#{data}" if(@@prefixes[@name])
-
-    if( @belongs_to )
-      
-      #puts "DEBUG : BELONGS_TO #{@belongs_to} - Lookup #{data} in DB"
-      insistent_belongs_to(record, data)
-
-    elsif( @assignment && @col_type )
-      #puts "DEBUG : COl TYPE defined for #{@name} : #{@assignment} => #{data} #{@col_type.inspect}"
-      record.send( @assignment, @col_type.type_cast( data ) )
-
-    elsif( @assignment )
-      #puts "DEBUG : No COL TYPE found for #{@name} : #{@assignment} => #{data}"
-      insistent_assignment(record, data)
-    end
-  end
-
-  # Attempt to find the associated object via id, name, title ....
-  def insistent_belongs_to( record, value )
-
-    @@insistent_find_by_list.each do |x|
-      begin
-        item = @belongs_to_class.send( "find_by_#{x}", value)
-        if(item)
-          record.send("#{@belongs_to}=", item)
-          break
-        end
-      rescue => e
-        puts e.inspect
-        if(x == @@insistent_method_list.last)
-          puts  "I'm sorry I have failed to assign [#{value}] to #{@assignment}"
-          raise "I'm sorry I have failed to assign [#{value}] to #{@assignment}" unless value.nil?
-        end
-      end
-    end
-  end
-
-  def insistent_assignment( record, value )
-    @@insistent_method_list ||= [:to_i, :to_f, :to_b]
-    begin
-      record.send(@assignment, value)
-    rescue => e
-      puts e.inspect
-      @@insistent_method_list.each do |f|
-        begin
-          record.send(@assignment, value.send( f) )
-          break
-        rescue => e
-          #puts "DEBUG: insistent_assignment: #{e.inspect}"
-          if f == @@insistent_method_list.last
-            puts  "I'm sorry I have failed to assign [#{value}] to #{@assignment}"
-            raise "I'm sorry I have failed to assign [#{value}] to #{@assignment}" unless value.nil?
-          end
-        end
-      end
-    end
-  end
-
-  def self.set_default_value( name, value )
-    @@default_values[name] = value
-  end
-
-  def self.default_value(name)
-    @@default_values[name]
-  end
-
-  def self.set_prefix( name, value )
-    @@prefixes[name] = value
-  end
-
-  def self.default_value(name)
-    @@prefixes[name]
-  end
-  
-  def pp
-    "#{@name} => #{@assignment} : #{@has_many}"
-  end
-end
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Aug 2010
+# License::   MIT
+#
+# Details::   This class provides information and access to the individual methods
+#             on an AR model. Populated by, and coupled with MethodMapper,
+#             which does the model interrogation work.
+#             Enables 'loaders' to iterate over the MethodMapper results set,
+#             and assign values to AR object, without knowing anything about that receiving object.
+#
+# =>
+require 'to_b'
+
+class MethodDetail
+  
+  # When looking up an association, try each of these in turn till a match
+  #  i.e find_by_name .. find_by_title and so on
+  @@insistent_find_by_list ||= [:id, :name, :title]
+
+  attr_accessor :klass, :name, :assignment, :col_type
+  attr_accessor :has_many, :has_many_class_name, :has_many_class
+  attr_accessor :belongs_to, :belongs_to_class_name, :belongs_to_class
+
+  @@default_values = {}
+  @@prefixes = {}
+  
+ 
+  def initialize(klass, name, assignment, belongs_to, has_many, col_type = nil)
+    @klass, @name, @assignment, @has_many, @belongs_to, @col_type = klass, name, assignment, has_many, belongs_to, col_type
+
+    if(@has_many)
+      begin
+        @has_many_class = Kernel.const_get(@has_many.classify)
+        @has_many_class_name = @has_many.classify
+      rescue
+      end
+    end
+
+    if(@belongs_to)
+      begin
+        @belongs_to_class = Kernel.const_get(@belongs_to.classify)
+        @belongs_to_class_name = @belongs_to.classify
+      rescue
+        # TODO - try other forms of the name, set to nil, or bomb out ?
+      end
+    end
+  end
+
+  def assign( record, value )
+    #puts "DEBUG: assign: [#{@name}]"
+
+    data = value
+
+    if(@@default_values[@name])
+      puts "WARNING nil value supplied for [#{@name}] - Using default : [#{@@default_values[@name]}]"
+      data = @@default_values[@name]
+    else
+      puts "WARNING nil value supplied for [#{@name}] - No default"
+    end if(data.nil?)
+    
+    data = "#{@@prefixes[@name]}#{data}" if(@@prefixes[@name])
+
+    if( @belongs_to )
+      
+      #puts "DEBUG : BELONGS_TO #{@belongs_to} - Lookup #{data} in DB"
+      insistent_belongs_to(record, data)
+
+    elsif( @assignment && @col_type )
+      puts "DEBUG : COl TYPE defined for #{@name} : #{@assignment} => #{data} #{@col_type.inspect}"
+      record.send( @assignment, @col_type.type_cast( data ) )
+
+    elsif( @assignment )
+      puts "DEBUG : No COL TYPE found for #{@name} : #{@assignment} => #{data}"
+      insistent_assignment(record, data)
+    end
+  end
+
+  # Attempt to find the associated object via id, name, title ....
+  def insistent_belongs_to( record, value )
+
+    @@insistent_find_by_list.each do |x|
+      begin
+        item = @belongs_to_class.send( "find_by_#{x}", value)
+        if(item)
+          record.send("#{@belongs_to}=", item)
+          break
+        end
+      rescue => e
+        puts "ERROR: #{e.inspect}"
+        if(x == @@insistent_method_list.last)
+          raise "I'm sorry I have failed to assign [#{value}] to #{@assignment}" unless value.nil?
+        end
+      end
+    end
+  end
+
+  def insistent_assignment( record, value )
+    puts "DEBUG: RECORD CLASS #{record.class}"
+    @@insistent_method_list ||= [:to_s, :to_i, :to_f, :to_b]
+    begin
+      record.send(@assignment, value)
+    rescue => e
+      puts e.inspect
+      @@insistent_method_list.each do |f|
+        begin
+
+          record.send(@assignment, value.send( f) )
+          break
+        rescue => e
+          #puts "DEBUG: insistent_assignment: #{e.inspect}"
+          if f == @@insistent_method_list.last
+            puts  "I'm sorry I have failed to assign [#{value}] to #{@assignment}"
+            raise "I'm sorry I have failed to assign [#{value}] to #{@assignment}" unless value.nil?
+          end
+        end
+      end
+    end
+  end
+
+  def self.set_default_value( name, value )
+    @@default_values[name] = value
+  end
+
+  def self.default_value(name)
+    @@default_values[name]
+  end
+
+  def self.set_prefix( name, value )
+    @@prefixes[name] = value
+  end
+
+  def self.default_value(name)
+    @@prefixes[name]
+  end
+  
+  def pp
+    "#{@name} => #{@assignment} : #{@has_many}"
+  end
+end

data/lib/engine/method_mapper.rb

@@ -1,157 +1,157 @@
-# Copyright:: (c) Autotelik Media Ltd 2011
-# Author ::   Tom Statter
-# Date ::     Aug 2010
-# License::   MIT
-#
-# Details::   A base class that stores details of all possible associations on AR classes and,
-#             given user supplied class and name, attempts to find correct attribute/association.
-#
-#             Derived classes define where the user supplied list of names originates from.
-#
-#             Example usage, load from a spreadsheet where the column names are only
-#             an approximation of the actual associations. Given a column heading of
-#             'Product Properties' on class Product,  find_method_detail() would search AR model,
-#             and return details of real has_many association 'product_properties'.
-#
-#             This real association can then be used to send spreadsheet row data to the AR object.
-#             
-require 'method_detail'
-
-class MethodMapper
-
-  attr_accessor :header_row, :headers
-  attr_accessor :methods
-  
-  @@has_many     = Hash.new
-  @@belongs_to   = Hash.new
-  @@assignments  = Hash.new
-  @@column_types = Hash.new
-
-  def initialize
-    @methods = []
-    @headers = []
-  end
-
-  # Build complete picture of the methods whose names listed in method_list
-  # Handles method names as defined by a user or in file headers where names may
-  # not be exactly as required e.g handles capitalisation, white space, _ etc
-  
-  def find_method_details( klass, method_list )
-    @methods = method_list.collect { |x| MethodMapper::find_method_detail( klass, x ) }
-  end
-
-  def method_names()
-    @methods.collect( &:name )
-  end
-
-  def check_mandatory( mandatory_list )
-    method_list = method_names()
-
-    mandatory_list.each { |x| raise "Mandatory column missing - need a '#{x}' column" unless(method_list.index(x)) }
-  end
-
-  # Create picture of the operators for assignment available on an AR model,
-  # including via associations (which provide both << and = )
-  #
-  def self.find_operators(klass, options = {} )
-
-    if( options[:reload] || @@has_many[klass].nil? )
-      @@has_many[klass] = klass.reflect_on_all_associations(:has_many).map { |i| i.name.to_s }
-      klass.reflect_on_all_associations(:has_and_belongs_to_many).inject(@@has_many[klass]) { |x,i| x << i.name.to_s }
-    end
-
-    # puts "DEBUG: Has Many Associations:", @@has_many[klass].inspect
-
-    if( options[:reload] || @@belongs_to[klass].nil? )
-      @@belongs_to[klass] = klass.reflect_on_all_associations(:belongs_to).map { |i| i.name.to_s }
-    end
-
-    # puts "DEBUG: Belongs To Associations:", @@belongs_to[klass].inspect
-
-    if( options[:reload] || @@assignments[klass].nil? )
-      @@assignments[klass] = (klass.column_names + klass.instance_methods.grep(/=/).map{|i| i.gsub(/=/, '')})
-      @@assignments[klass] = @@assignments[klass] - @@has_many[klass] if(@@has_many[klass])
-      @@assignments[klass] = @@assignments[klass] - @@belongs_to[klass] if(@@belongs_to[klass])
-      
-      @@assignments[klass].uniq!
-
-      @@assignments[klass].each do |assign|
-        found = klass.columns.find{ |col| col.name == assign }
-        @@column_types[column_key(klass, assign)] = found if found
-      end
-    end
-  end
-
-  # Find the proper format of name, appropriate call + column type for a given name.
-  # e.g Given users entry in spread sheet check for pluralization, missing underscores etc
-  #
-  # If not nil returned method can be used directly in for example klass.new.send( call, .... )
-  #
-  def self.find_method_detail( klass, name )
-    true_name, assign, belongs_to, has_many = nil, nil, nil, nil
-    
-    # TODO - check out regexp to do this work better plus Inflections ??
-    [
-      name,
-      name.gsub(' ', '_'),
-      name.gsub(' ', ''),
-      name.gsub(' ', '_').downcase,
-      name.gsub(' ', '').downcase,
-      name.gsub(' ', '_').underscore
-
-    ].each do |n|
-      has_many   = (@@has_many[klass]    && @@has_many[klass].include?(n))   ?  n : nil
-      belongs_to = (@@belongs_to[klass]  && @@belongs_to[klass].include?(n)) ?  n : nil
-      assign     = (@@assignments[klass] && @@assignments[klass].include?(n))?  n + '=' : nil
-
-      if(assign || has_many || belongs_to)
-        true_name = n
-        break
-      end
-    end
-
-    return MethodDetail.new(klass, true_name, assign, belongs_to, has_many, @@column_types[column_key(klass, true_name)])
-  end
-
-  def self.clear
-    @@has_many.clear
-    @@assignments.clear
-    @@column_types.clear
-  end
-
-  def self.column_key(klass, column)
-    "#{klass.name}:#{column}"
-  end
-
-  def self.has_many
-    @@has_many
-  end
-  def self.assignments
-    @@assignments
-  end
-  def self.column_types
-    @@column_types
-  end
-
-  def self.has_many_for(klass)
-    @@has_many[klass]
-  end
-  def self.assignments_for(klass)
-    @@assignments[klass]
-  end
-
-  def self.column_type_for(klass, column)
-    @@column_types[column_key(klass, column)]
-  end
-
-
-  def find_or_new( klass, condition_hash = {} )
-    @records[klass] = klass.find(:all, :conditions => condition_hash)
-    if @records[klass].any?
-      return @records[klass].first
-    else
-      return klass.new
-    end
-  end
-  
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Aug 2010
+# License::   MIT
+#
+# Details::   A base class that stores details of all possible associations on AR classes and,
+#             given user supplied class and name, attempts to find correct attribute/association.
+#
+#             Derived classes define where the user supplied list of names originates from.
+#
+#             Example usage, load from a spreadsheet where the column names are only
+#             an approximation of the actual associations. Given a column heading of
+#             'Product Properties' on class Product,  find_method_detail() would search AR model,
+#             and return details of real has_many association 'product_properties'.
+#
+#             This real association can then be used to send spreadsheet row data to the AR object.
+#             
+require 'method_detail'
+
+class MethodMapper
+
+  attr_accessor :header_row, :headers
+  attr_accessor :methods
+  
+  @@has_many     = Hash.new
+  @@belongs_to   = Hash.new
+  @@assignments  = Hash.new
+  @@column_types = Hash.new
+
+  def initialize
+    @methods = []
+    @headers = []
+  end
+
+  # Build complete picture of the methods whose names listed in method_list
+  # Handles method names as defined by a user or in file headers where names may
+  # not be exactly as required e.g handles capitalisation, white space, _ etc
+  
+  def find_method_details( klass, method_list )
+    @methods = method_list.collect { |x| MethodMapper::find_method_detail( klass, x ) }
+  end
+
+  def method_names()
+    @methods.collect( &:name )
+  end
+
+  def check_mandatory( mandatory_list )
+    method_list = method_names()
+
+    mandatory_list.each { |x| raise "Mandatory column missing - need a '#{x}' column" unless(method_list.index(x)) }
+  end
+
+  # Create picture of the operators for assignment available on an AR model,
+  # including via associations (which provide both << and = )
+  #
+  def self.find_operators(klass, options = {} )
+
+    if( options[:reload] || @@has_many[klass].nil? )
+      @@has_many[klass] = klass.reflect_on_all_associations(:has_many).map { |i| i.name.to_s }
+      klass.reflect_on_all_associations(:has_and_belongs_to_many).inject(@@has_many[klass]) { |x,i| x << i.name.to_s }
+    end
+
+    # puts "DEBUG: Has Many Associations:", @@has_many[klass].inspect
+
+    if( options[:reload] || @@belongs_to[klass].nil? )
+      @@belongs_to[klass] = klass.reflect_on_all_associations(:belongs_to).map { |i| i.name.to_s }
+    end
+
+    # puts "DEBUG: Belongs To Associations:", @@belongs_to[klass].inspect
+
+    if( options[:reload] || @@assignments[klass].nil? )
+      @@assignments[klass] = (klass.column_names + klass.instance_methods.grep(/=/).map{|i| i.gsub(/=/, '')})
+      @@assignments[klass] = @@assignments[klass] - @@has_many[klass] if(@@has_many[klass])
+      @@assignments[klass] = @@assignments[klass] - @@belongs_to[klass] if(@@belongs_to[klass])
+      
+      @@assignments[klass].uniq!
+
+      @@assignments[klass].each do |assign|
+        found = klass.columns.find{ |col| col.name == assign }
+        @@column_types[column_key(klass, assign)] = found if found
+      end
+    end
+  end
+
+  # Find the proper format of name, appropriate call + column type for a given name.
+  # e.g Given users entry in spread sheet check for pluralization, missing underscores etc
+  #
+  # If not nil returned method can be used directly in for example klass.new.send( call, .... )
+  #
+  def self.find_method_detail( klass, name )
+    true_name, assign, belongs_to, has_many = nil, nil, nil, nil
+    
+    # TODO - check out regexp to do this work better plus Inflections ??
+    [
+      name,
+      name.gsub(' ', '_'),
+      name.gsub(' ', ''),
+      name.gsub(' ', '_').downcase,
+      name.gsub(' ', '').downcase,
+      name.gsub(' ', '_').underscore
+
+    ].each do |n|
+      has_many   = (@@has_many[klass]    && @@has_many[klass].include?(n))   ?  n : nil
+      belongs_to = (@@belongs_to[klass]  && @@belongs_to[klass].include?(n)) ?  n : nil
+      assign     = (@@assignments[klass] && @@assignments[klass].include?(n))?  n + '=' : nil
+
+      if(assign || has_many || belongs_to)
+        true_name = n
+        break
+      end
+    end
+
+    return MethodDetail.new(klass, true_name, assign, belongs_to, has_many, @@column_types[column_key(klass, true_name)])
+  end
+
+  def self.clear
+    @@has_many.clear
+    @@assignments.clear
+    @@column_types.clear
+  end
+
+  def self.column_key(klass, column)
+    "#{klass.name}:#{column}"
+  end
+
+  def self.has_many
+    @@has_many
+  end
+  def self.assignments
+    @@assignments
+  end
+  def self.column_types
+    @@column_types
+  end
+
+  def self.has_many_for(klass)
+    @@has_many[klass]
+  end
+  def self.assignments_for(klass)
+    @@assignments[klass]
+  end
+
+  def self.column_type_for(klass, column)
+    @@column_types[column_key(klass, column)]
+  end
+
+
+  def find_or_new( klass, condition_hash = {} )
+    @records[klass] = klass.find(:all, :conditions => condition_hash)
+    if @records[klass].any?
+      return @records[klass].first
+    else
+      return klass.new
+    end
+  end
+  
 end

data/lib/engine/method_mapper_csv.rb

@@ -1,28 +1,28 @@
-# Copyright:: (c) Autotelik Media Ltd 2011
-# Author ::   Tom Statter
-# Date ::     Jan 2011
-# License::   MIT
-#
-# Details::   Extract the headings from a user supplied CSV file, and map heading names
-#             to the attributes and/or assocaiitons of an AR Model defined by supplied klass.
-#
-require 'method_mapper'
-
-class MethodMapperCsv < MethodMapper
-    
-  # Read the headers from CSV file and map to ActiveRecord members/associations
-
-  def initialize( file_name, klass, sheet_number = 0 )
-    super
-    
-    File.open(file_name) do
-      @headers =  @header_row.split(/,/)
-    end
-
-    # Gather list of all possible 'setter' methods on AR class (instance variables and associations)
-    self.find_operators( klass )
-
-    # Convert the list of headers into suitable calls on the Active Record class
-    find_method_details( klass, @headers )
-  end
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Jan 2011
+# License::   MIT
+#
+# Details::   Extract the headings from a user supplied CSV file, and map heading names
+#             to the attributes and/or assocaiitons of an AR Model defined by supplied klass.
+#
+require 'method_mapper'
+
+class MethodMapperCsv < MethodMapper
+    
+  # Read the headers from CSV file and map to ActiveRecord members/associations
+
+  def initialize( file_name, klass, sheet_number = 0 )
+    super
+    
+    File.open(file_name) do
+      @headers =  @header_row.split(/,/)
+    end
+
+    # Gather list of all possible 'setter' methods on AR class (instance variables and associations)
+    self.find_operators( klass )
+
+    # Convert the list of headers into suitable calls on the Active Record class
+    find_method_details( klass, @headers )
+  end
 end