ar_loader 0.0.6 → 0.0.8

data/lib/helpers/jruby/jexcel_file.rb

@@ -0,0 +1,187 @@
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Aug 2010
+# License::   MIT
+#
+# An Excel file helper. Create and populate XSL files
+#
+# The maximum number of columns and rows in an Excel file is fixed at 256 Columns and 65536 Rows
+# 
+# POI jar location needs to be added to class path.
+#
+#  TODO -  Check out http://poi.apache.org/poi-ruby.html
+#
+if(Guards::jruby?)
+
+  class Object
+    def add_to_classpath(path)
+      $CLASSPATH << File.join( ArLoader.root_path, 'lib', path.gsub("\\", "/") )
+    end
+  end
+
+  require 'java'
+  require 'rubygems'
+
+  add_to_classpath 'java/poi-3.6.jar'
+
+  class JExcelFile
+    include_class 'org.apache.poi.poifs.filesystem.POIFSFileSystem'
+    include_class 'org.apache.poi.hssf.usermodel.HSSFCell'
+    include_class 'org.apache.poi.hssf.usermodel.HSSFWorkbook'
+    include_class 'org.apache.poi.hssf.usermodel.HSSFCellStyle'
+    include_class 'org.apache.poi.hssf.usermodel.HSSFDataFormat'
+
+    include_class 'java.io.ByteArrayOutputStream'
+    include_class 'java.util.Date'
+    include_class 'java.io.FileInputStream'
+
+    attr_accessor :book, :row, :current_sheet
+  
+    attr_reader   :sheet
+
+    MAX_COLUMNS = 256.freeze
+    MAX_ROWS = 65536.freeze
+
+    # The HSSFWorkbook uses 0 based indexes
+  
+    def initialize()
+      @book = nil
+    end
+
+    def open(filename)
+      inp = FileInputStream.new(filename)
+
+      @book = HSSFWorkbook.new(inp)
+
+      sheet(0)  # also sets @current_sheet
+    end
+  
+    def create(sheet_name)
+      @book = HSSFWorkbook.new()
+      @sheet = @book.createSheet(sheet_name.gsub(" ", ''))
+      date_style = @book.createCellStyle()
+      date_style.setDataFormat(HSSFDataFormat.getBuiltinFormat("m/d/yy h:mm"))
+    end
+
+    # Return the current or specified HSSFSheet
+    def sheet(i = nil)
+      @current_sheet = i if i
+      @sheet = @book.getSheetAt(@current_sheet)
+      @sheet
+    end
+
+    def num_rows
+      @sheet.getPhysicalNumberOfRows
+    end
+
+    # Process each row. (type is org.apache.poi.hssf.usermodel.HSSFRow)
+
+    def each_row
+      @sheet.rowIterator.each { |row| yield row }
+    end
+
+
+    # Create new row, bring index in line with POI usage (our 1 is their 0)
+    def create_row(index)
+      @row = @sheet.createRow(index)
+      @row
+    end
+  
+    def set_cell(row, column, data)
+      @row = @sheet.getRow(row) || create_row(row)
+      @row.createCell(column).setCellValue(data)
+    end
+
+    def value(row, column)
+      raise TypeError, "Expect row argument of type HSSFRow" unless row.is_a?(Java::OrgApachePoiHssfUsermodel::HSSFRow)
+      #puts "DEBUG - CELL VALUE : #{column} => #{ cell_value( row.getCell(column) ).inspect}"
+      cell_value( row.getCell(column) )
+    end
+  
+    def cell_value(cell)
+      return nil unless cell
+      #puts "DEBUG CELL TYPE : #{cell} => #{cell.getCellType().inspect}"
+      case (cell.getCellType())
+      when HSSFCell::CELL_TYPE_FORMULA  then return cell.getCellFormula()
+      when HSSFCell::CELL_TYPE_NUMERIC  then return cell.getNumericCellValue()
+      when HSSFCell::CELL_TYPE_STRING   then return cell.getStringCellValue()
+      when HSSFCell::CELL_TYPE_BOOLEAN  then return cell.getBooleanCellValue()
+      when HSSFCell::CELL_TYPE_BLANK    then return ""
+      end
+    end
+  
+    def save( filename )
+      File.open( filename, 'w') {|f| f.write(to_s) }
+    end
+
+
+    # The internal representation of a Excel File
+  
+    def to_s
+      outs = ByteArrayOutputStream.new
+      @book.write(outs);
+      outs.close();
+      String.from_java_bytes(outs.toByteArray)
+    end
+ 
+  end
+  
+  module ExcelHelper
+    require 'java'
+
+    include_class 'org.apache.poi.poifs.filesystem.POIFSFileSystem'
+    include_class 'org.apache.poi.hssf.usermodel.HSSFCell'
+    include_class 'org.apache.poi.hssf.usermodel.HSSFWorkbook'
+    include_class 'org.apache.poi.hssf.usermodel.HSSFCellStyle'
+    include_class 'org.apache.poi.hssf.usermodel.HSSFDataFormat'
+    include_class 'java.io.ByteArrayOutputStream'
+    include_class 'java.util.Date'
+
+    # ActiveRecord Helper - Export model data to XLS file format
+    #
+    def to_xls(items=[])
+
+      @excel = ExcelFile.new(items[0].class.name)
+    
+      @excel.create_row(0)
+  
+      sheet = @excel.sheet
+
+      # header row
+      if !items.empty?
+        row = sheet.createRow(0)
+        cell_index = 0
+        items[0].class.columns.each do |column|
+          row.createCell(cell_index).setCellValue(column.name)
+          cell_index += 1
+        end
+      end
+
+      # value rows
+      row_index = 1
+      items.each do |item|
+        row = sheet.createRow(row_index);
+
+        cell_index = 0
+        item.class.columns.each do |column|
+          cell = row.createCell(cell_index)
+          if column.sql_type =~ /date/ then
+            millis = item.send(column.name).to_f * 1000
+            cell.setCellValue(Date.new(millis))
+            cell.setCellStyle(dateStyle);
+          elsif column.sql_type =~ /int/ then
+            cell.setCellValue(item.send(column.name).to_i)
+          else
+            value = item.send(column.name)
+            cell.setCellValue(item.send(column.name)) unless value.nil?
+          end
+          cell_index += 1
+        end
+        row_index += 1
+      end
+      @excel.to_s
+    end
+  end
+else
+  raise "Bad Platform - Sorry can only access Excel files via JRuby"
+end

data/lib/{engine → helpers/jruby}/word.rb

@@ -1,70 +1,79 @@
-# Author::    Tom Statter
-# License::   MIT ?
-#
-# NOTES ON INVESTIGATING OLE METHODS in irb
-#
-# visible = @word_app.ole_method_help( 'Visible' )   # Get a Method Object
-
-# log( visible.return_type_detail.to_s )           # => ["BOOL"]
-# log( visible.invoke_kind.to_s )                  # => "PROPERTYGET"
-# log( visible.params.to_s )                       # => []
-
-# @fc.ole_method_help( 'Report' ).params[1].ole_type_detail
-#
-# prefs = @word_app.Preferences.Strings.ole_method_help( 'Set' ).params
-#   => [index, newVal]
-#
-# WORD_OLE_CONST.constants
-#
-# WORD_OLE_CONST.constants.sort.grep /CR/
-#   => ["ClHideCRLF", "LesCR", "LesCRLF"]
-#
-# WORD_OLE_CONST.const_get( 'LesCR' ) or WORD_OLE_CONST::LesCR
-#   => 1
-require 'win32ole'
-
-# Module for constants to be loaded int
-
-module WORD_OLE_CONST
-end
-
-class Word
-    
-  attr_reader :wd, :doc
-
-  def initialize( visible )
-    @wd = WIN32OLE.new('Word.Application')
-
-    WIN32OLE.const_load(@wd, WORD_OLE_CONST) if WORD_OLE_CONST.constants.empty?
-
-    @wd.Visible = visible
-  end
-
-  def open(file)
-    @doc = @wd.Documents.Open(file)
-    @doc
-  end
-
-  def save()
-    @doc.Save()
-    @doc
-  end
-
-  # Format : From WORD_OLE_CONST e.g WORD_OLE_CONST::WdFormatHTML
-  #
-  def save_as(name, format)
-    @doc.SaveAs(name, format)
-    return @doc
-  end
-
-  # WdFormatFilteredHTML
-  # WdFormatHTML
-  def save_as_html(name)
-    @doc.SaveAs(name, WORD_OLE_CONST::WdFormatHTML)
-    return @doc
-  end
-
-  def quit
-    @wd.quit()
-  end
-end
+# Author::    Tom Statter
+# License::   MIT ?
+#
+# NOTES ON INVESTIGATING OLE METHODS in irb
+#
+# visible = @word_app.ole_method_help( 'Visible' )   # Get a Method Object
+
+# log( visible.return_type_detail.to_s )           # => ["BOOL"]
+# log( visible.invoke_kind.to_s )                  # => "PROPERTYGET"
+# log( visible.params.to_s )                       # => []
+
+# @fc.ole_method_help( 'Report' ).params[1].ole_type_detail
+#
+# prefs = @word_app.Preferences.Strings.ole_method_help( 'Set' ).params
+#   => [index, newVal]
+#
+# WORD_OLE_CONST.constants
+#
+# WORD_OLE_CONST.constants.sort.grep /CR/
+#   => ["ClHideCRLF", "LesCR", "LesCRLF"]
+#
+# WORD_OLE_CONST.const_get( 'LesCR' ) or WORD_OLE_CONST::LesCR
+#   => 1
+
+if(Guards::windows?)
+
+require 'win32ole'
+
+# Module for constants to be loaded int
+
+module WORD_OLE_CONST
+end
+
+class Word
+    
+  attr_reader :wd, :doc
+
+  def initialize( visible )
+    @wd = WIN32OLE.new('Word.Application')
+
+    WIN32OLE.const_load(@wd, WORD_OLE_CONST) if WORD_OLE_CONST.constants.empty?
+
+    @wd.Visible = visible
+  end
+
+  def open(file)
+    @doc = @wd.Documents.Open(file)
+    @doc
+  end
+
+  def save()
+    @doc.Save()
+    @doc
+  end
+
+  # Format : From WORD_OLE_CONST e.g WORD_OLE_CONST::WdFormatHTML
+  #
+  def save_as(name, format)
+    @doc.SaveAs(name, format)
+    return @doc
+  end
+
+  # WdFormatFilteredHTML
+  # WdFormatHTML
+  def save_as_html(name)
+    @doc.SaveAs(name, WORD_OLE_CONST::WdFormatHTML)
+    return @doc
+  end
+
+  def quit
+    @wd.quit()
+  end
+end
+
+else
+
+  class Word
+  end
+end

data/lib/helpers/spree_helper.rb

@@ -0,0 +1,85 @@
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Aug 2011
+# License::   MIT
+#
+# Details::   Spree Helper mixing in Support for testing or loading Rails Spree e-commerce.
+# 
+#             Since ar_loader gem is not a Rails app or a Spree App, provides utilities to internally
+#             create a Spree Database, and to load Spree components, enabling standalone testing.
+#
+module Spree
+
+
+  def self.root
+    Gem.loaded_specs['spree_core'] ? Gem.loaded_specs['spree_core'].full_gem_path  : ""
+  end
+
+  def self.lib_root
+    File.join(root, 'lib')
+  end
+
+  def self.app_root
+    File.join(root, '/app')
+  end
+
+  def self.load
+    gem 'rails'
+    
+    gem 'spree'
+    require 'spree'
+
+    gem 'paperclip'
+    gem 'nested_set'
+
+    require 'nested_set'
+    require 'paperclip'
+    require 'acts_as_list'
+
+    CollectiveIdea::Acts::NestedSet::Railtie.extend_active_record
+    ActiveRecord::Base.send(:include, Paperclip::Glue)
+
+    gem 'activemerchant'
+    require 'active_merchant'
+    require 'active_merchant/billing/gateway'
+
+    ActiveRecord::Base.send(:include, ActiveMerchant::Billing)
+
+    $LOAD_PATH << lib_root << app_root << File.join(app_root, 'models')
+
+    load_models
+    
+    Dir[lib_root + '/*.rb'].each do |r|
+      begin
+        require r if File.file?(r)  
+      rescue => e
+      end
+    end
+
+    Dir[lib_root + '/**/*.rb'].each do |r|
+      begin
+        require r if File.file?(r) && ! r.include?('testing')  && ! r.include?('generators')
+      rescue => e
+      end
+    end
+
+    load_models
+  end
+
+  def self.load_models
+    puts 'load from', root
+    Dir[root + '/app/models/**/*.rb'].each {|r|
+      begin
+        require r if File.file?(r)
+      rescue => e
+        #puts 'failed to load', r, e.inspect
+      end
+    }
+  end
+
+  def self.migrate_up
+    load
+    ActiveRecord::Migrator.up( File.join(root, 'db/migrate') )
+  end
+
+end

data/lib/loaders/csv_loader.rb

@@ -0,0 +1,87 @@
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Aug 2011
+# License::   MIT
+#
+# Details::   Specific loader to support CSV files.
+# 
+#
+require 'loaders/loader_base'
+require 'ar_loader/exceptions'
+require 'ar_loader/method_mapper'
+
+module ARLoader
+     
+  class CsvLoader < LoaderBase
+  
+    def initialize(klass, object = nil, options = {})
+      super( klass, object, options )
+      raise "Cannot load - failed to create a #{klass}" unless @load_object
+    end
+
+
+    def load(file_name, options = {})
+
+      require "csv"
+
+      # TODO - abstract out what a 'parsed file' is - so a common object can represent excel,csv etc
+      # then  we can make load() more generic
+      
+      @parsed_file = CSV.read(file_name)
+
+
+      @headers = @parsed_file.shift
+
+      @method_mapper = ARLoader::MethodMapper.new
+
+      # Convert the list of headers into suitable calls on the Active Record class
+      @method_mapper.populate_methods( load_object_class, @headers )
+
+      unless(@method_mapper.missing_methods.empty?)
+        puts "WARNING: Following column headings could not be mapped : #{@method_mapper.missing_methods.inspect}"
+        raise MappingDefinitionError, "ERROR: Missing mappings for #{@method_mapper.missing_methods.size} column headings"
+      end
+
+      #if(options[:verbose])
+      puts "\n\n\nLoading from CSV file: #{file_name}"
+      puts "Processing #{@parsed_file.size} rows"
+      # end
+
+      load_object_class.transaction do
+        @loaded_objects =  []
+
+        @parsed_file.each do |row|
+      
+          # TODO - Smart sorting of column processing order ....
+          # Does not currently ensure mandatory columns (for valid?) processed first but model needs saving
+          # before associations can be processed so user should ensure mandatory columns are prior to associations
+
+          # as part of this we also attempt to save early, for example before assigning to
+          # has_and_belongs_to associations which require the load_object has an id for the join table
+
+          # Iterate over the columns method_mapper found in Excel,
+          # pulling data out of associated column
+          @method_mapper.method_details.each_with_index do |method_detail, col|
+
+            value = row[col]
+
+            process(method_detail, value)
+          end
+
+          # TODO - handle when it's not valid ?
+          # Process rest and dump out an exception list of Products ??
+
+          puts "SAVING ROW #{row} : #{load_object.inspect}" #if options[:verbose]
+
+          save
+
+          # don't forget to reset the object or we'll update rather than create
+          new_load_object
+
+        end
+      end
+
+    end
+
+  end
+end