datashift 0.2.1 → 0.2.2

data/lib/datashift/model_mapper.rb

@@ -0,0 +1,27 @@
+class ModelMapper
+  
+  # Helper to deal with string versions of modules/namespaced classes
+  # Find and return the base class from a string.
+  # 
+  # e.g "Spree::Property" returns the Spree::Property class
+  # Raises exception if no such class found
+  def self.const_get_from_string(str)
+    str.split('::').inject(Object) do |mod, class_name| 
+      mod.const_get(class_name) 
+    end 
+  end 
+  
+  
+  # Similar to const_get_from_string except this version
+  # returns nil if no such class found
+  # Support modules e.g "Spree::Property"
+  # 
+  def self.class_from_string( str )
+      begin
+        ModelMapper::const_get_from_string(str)  #Kernel.const_get(model)
+      rescue NameError => e
+       return nil
+      end
+  end
+  
+end

data/lib/exporters/csv_exporter.rb

@@ -0,0 +1,36 @@
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Aug 2011
+# License::   MIT
+#
+# Details::   Export a model to CSV
+#
+#
+require 'exporter_base'
+
+module DataShift
+
+  class CsvExporter < ExporterBase
+
+    attr_accessor :excel, :filename
+  
+    def initialize(filename)
+      @excel = nil
+      @filename = filename
+    end
+
+    # Create CSV file representing supplied Model
+    
+    def generate(model, options = {})
+
+      @filename = options[:filename] if  options[:filename]
+    end
+
+  
+    # Create an Csv file representing supplied Model
+
+    def export(items, options = {})
+    end
+
+  end
+end

data/lib/exporters/excel_exporter.rb

@@ -0,0 +1,116 @@
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Aug 2011
+# License::   MIT
+#
+# Details::   Export a model to Excel '97(-2007) file format.
+#
+# TOD : Can we switch between .xls and XSSF (POI implementation of Excel 2007 OOXML (.xlsx) file format.)
+#
+#
+module DataShift
+
+  require 'exporter_base'
+      
+  if(Guards::jruby?)
+
+    require 'jruby/jexcel_file'
+
+    class ExcelExporter < ExporterBase
+
+      attr_accessor :filename
+  
+      def initialize(filename)
+        @filename = filename
+      end
+
+  
+      # Create an Excel file from list of ActiveRecord objects
+      def export(records, options = {})
+
+        excel = JExcelFile.new()
+
+        if(options[:sheet_name] )
+          excel.create_sheet( options[:sheet_name] ) 
+        else
+          excel.create_sheet( records.first.class.name )
+        end
+      
+        excel.ar_to_headers(records)
+        
+        excel.ar_to_xls(records)
+
+        excel.save( filename() )
+      end
+      
+      # Create an Excel file from list of ActiveRecord objects
+      # Specify which associations to export via :with or :exclude
+      # Possible values are : [:assignment, :belongs_to, :has_one, :has_many]
+      #
+      def export_with_associations(klass, items, options = {})
+
+        excel = JExcelFile.new()
+
+        if(options[:sheet_name] )
+          excel.create_sheet( options[:sheet_name] ) 
+        else
+          excel.create_sheet( items.first.class.name )
+        end
+        
+        MethodDictionary.find_operators( klass )
+         
+        MethodDictionary.build_method_details( klass )
+           
+        work_list = options[:with] || MethodDetail::supported_types_enum
+        
+        headers = []
+        puts "work_list :  [#{work_list.inspect}]"
+      
+        details_mgr = MethodDictionary.method_details_mgrs[klass]
+                  
+        work_list.each do |op_type|
+          list_for_class_and_op = details_mgr.get_list(op_type)
+       
+          next if(list_for_class_and_op.nil? || list_for_class_and_op.empty?)
+         #if(work_list.include?(md.operator_type))
+              #each do |mdtype|
+          #end
+          #if(MethodDictionary.respond_to?("#{mdtype}_for") )
+           # method_details = MethodDictionary.send("#{mdtype}_for", klass)
+        
+            list_for_class_and_op.each {|md| headers << "#{md.operator}" }
+          #else
+           # puts "ERROR : Unknown option in :with [#{mdtype}]"
+         
+        end
+        
+        excel.set_headers( headers )
+                
+        data = []
+        
+        items.each do |record|
+          
+          MethodMapper.method_details[klass].each do |method_detail|   
+            if(method_detail.operator_type == :assignment)
+              data << record.send( method_detail.operator )
+            end
+          end
+        end
+        
+        excel.set_row(2,1,items)
+
+        excel.save( filename() )
+      end
+    end # ExcelGenerator
+
+  else
+    class  ExcelExporter < ExcelBase
+      
+      def initialize(filename)
+        @filename = filename
+        raise DataShift::BadRuby, "Apologies but Datashift Excel facilities currently need JRuby. Please switch to, or install JRuby"
+      end
+    end
+  end # jruby
+  
+end # DataShift

data/lib/exporters/exporter_base.rb

@@ -0,0 +1,15 @@
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Aug 2010
+# License::   MIT
+#
+#  Details::  Base class for Exporters, which provide services to export a Model
+#             and it's data from database to an external format
+#
+module DataShift
+
+  class ExporterBase
+
+  end
+
+end

data/lib/generators/csv_generator.rb

@@ -1,36 +1,36 @@
-# Copyright:: (c) Autotelik Media Ltd 2011
-# Author ::   Tom Statter
-# Date ::     Aug 2011
-# License::   MIT
-#
-# Details::   Export a model to CSV
-#
-#
-require 'generator_base'
-
-module DataShift
-
-  class CsvGenerator < GeneratorBase
-
-    attr_accessor :excel, :filename
-  
-    def initialize(filename)
-      @excel = nil
-      @filename = filename
-    end
-
-    # Create CSV file representing supplied Model
-    
-    def generate(model, options = {})
-
-      @filename = options[:filename] if  options[:filename]
-    end
-
-  
-    # Create an Csv file representing supplied Model
-
-    def export(items, options = {})
-    end
-
-  end
-end
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Aug 2011
+# License::   MIT
+#
+# Details::   Export a model to CSV
+#
+#
+require 'generator_base'
+
+module DataShift
+
+  class CsvGenerator < GeneratorBase
+
+    attr_accessor :excel, :filename
+  
+    def initialize(filename)
+      @excel = nil
+      @filename = filename
+    end
+
+    # Create CSV file representing supplied Model
+    
+    def generate(model, options = {})
+
+      @filename = options[:filename] if  options[:filename]
+    end
+
+  
+    # Create an Csv file representing supplied Model
+
+    def export(items, options = {})
+    end
+
+  end
+end

data/lib/generators/excel_generator.rb

@@ -1,123 +1,107 @@
-# Copyright:: (c) Autotelik Media Ltd 2011
-# Author ::   Tom Statter
-# Date ::     Aug 2011
-# License::   MIT
-#
-# Details::   Export a model to Excel '97(-2007) file format.
-#
-# TOD : Can we switch between .xls and XSSF (POI implementation of Excel 2007 OOXML (.xlsx) file format.)
-#
-#
-module DataShift
-
-  require 'generator_base'
-      
-  if(Guards::jruby?)
-
-    require 'jruby/jexcel_file'
-
-    class ExcelGenerator < GeneratorBase
-
-      attr_accessor :filename
-  
-      def initialize(filename)
-        @filename = filename
-      end
-
-      # Create an Excel file template (header row) representing supplied Model
-    
-      def generate(model, options = {})
-        MethodDictionary.find_operators( model )
-
-        @filename = options[:filename] if  options[:filename]
-
-        excel = JExcelFile.new()
-
-        if(options[:sheet_name] )
-          excel.create_sheet( options[:sheet_name] ) 
-        else
-          excel.create_sheet( model.name )
-        end
-        
-        raise "Failed to create Excel WorkSheet for #{model.name}" unless excel.sheet
-
-        excel.set_headers(MethodDictionary.assignments[model])
-
-        excel.save( @filename )
-      end
-
-  
-      # Create an Excel file from list of ActiveRecord objects
-      def export(records, options = {})
-
-        excel = JExcelFile.new()
-
-        if(options[:sheet_name] )
-          excel.create_sheet( options[:sheet_name] ) 
-        else
-          excel.create_sheet( records.first.class.name )
-        end
-      
-        excel.ar_to_headers(records)
-        
-        excel.ar_to_xls(records)
-
-        excel.save( filename() )
-      end
-      
-      # Create an Excel file from list of ActiveRecord objects
-      # Specify which associations to export via :with or :exclude
-      # Possible values are : [:assignment, :belongs_to, :has_one, :has_many]
-      #
-      def export_with_associations(klass, items, options = {})
-
-        excel = JExcelFile.new()
-
-        if(options[:sheet_name] )
-          excel.create_sheet( options[:sheet_name] ) 
-        else
-          excel.create_sheet( items.first.class.name )
-        end
-        
-        MethodDictionary.find_operators( klass )
-         
-        MethodDictionary.build_method_details( klass )
-          
-        work_list = (options[:with]) ? options[:with] : [:assignments, :belongs_to, :has_one, :has_many]
-        
-        headers = []
-        
-        work_list.each do |mdtype|
-          method_details = MethodDictionary.send("#{mdtype}_for", klass)
-        
-          method_details.each {|md| headers << "#{md.operator}" }
-        end
-        
-        excel.set_headers( headers )
-                
-        data = []
-        
-        items.each do |record|
-          
-          MethodMapper.method_details[klass].each do |method_detail|   
-            if(method_detail.operator_type == :assignment)
-              data << record.send( method_detail.operator )
-            end
-          end
-        end
-        
-        excel.set_row(2,1,items)
-
-        excel.save( filename() )
-      end
-    end # ExcelGenerator
-
-  else
-    class  ExcelGenerator < GeneratorBase
-      def initialize
-        raise DataShift::BadRuby, "Please install and use JRuby for working with .xls files"
-      end
-    end
-  end # jruby
-  
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Aug 2011
+# License::   MIT
+#
+# Details::   Export a model to Excel '97(-2007) file format.
+#
+# TOD : Can we switch between .xls and XSSF (POI implementation of Excel 2007 OOXML (.xlsx) file format.)
+#
+#
+module DataShift
+
+  require 'generator_base'
+      
+  if(Guards::jruby?)
+
+    require 'jruby/jexcel_file'
+
+    class ExcelGenerator < GeneratorBase
+
+      attr_accessor :filename
+  
+      def initialize(filename)
+        @filename = filename
+      end
+
+      # Create an Excel file template (header row) representing supplied Model
+    
+      def generate(klass, options = {})
+        MethodDictionary.find_operators( klass )
+
+        @filename = options[:filename] if  options[:filename]
+
+        excel = JExcelFile.new()
+
+        if(options[:sheet_name] )
+          excel.create_sheet( options[:sheet_name] ) 
+        else
+          excel.create_sheet( klass.name )
+        end
+        
+        raise "Failed to create Excel WorkSheet for #{klass.name}" unless excel.sheet
+
+        excel.set_headers(MethodDictionary.assignments[klass])
+
+        excel.save( @filename )
+      end
+
+      
+      # Create an Excel file from list of ActiveRecord objects
+      # Specify which associations to export via :with or :exclude
+      # Possible values are : [:assignment, :belongs_to, :has_one, :has_many]
+      #
+      def generate_with_associations(klass, options = {})
+
+        excel = JExcelFile.new()
+
+        if(options[:sheet_name] )
+          excel.create_sheet( options[:sheet_name] ) 
+        else
+          excel.create_sheet( klass.name )
+        end
+        
+        MethodDictionary.find_operators( klass )
+         
+        MethodDictionary.build_method_details( klass )
+           
+        work_list = options[:with] || MethodDetail::supported_types_enum
+        
+        headers = []
+        puts "work_list :  [#{work_list.inspect}]"
+      
+        details_mgr = MethodDictionary.method_details_mgrs[klass]
+                  
+        work_list.each do |op_type|
+          list_for_class_and_op = details_mgr.get_list(op_type)
+       
+          next if(list_for_class_and_op.nil? || list_for_class_and_op.empty?)
+         #if(work_list.include?(md.operator_type))
+              #each do |mdtype|
+          #end
+          #if(MethodDictionary.respond_to?("#{mdtype}_for") )
+           # method_details = MethodDictionary.send("#{mdtype}_for", klass)
+        
+            list_for_class_and_op.each {|md| headers << "#{md.operator}" }
+          #else
+           # puts "ERROR : Unknown option in :with [#{mdtype}]"
+         
+        end
+        
+        excel.set_headers( headers )
+                
+        excel.save( filename() )
+      end
+    end # ExcelGenerator
+
+  else
+    class  ExcelGenerator < GeneratorBase
+      
+      def initialize(filename)
+        @filename = filename
+        raise DataShift::BadRuby, "Apologies but Datashift Excel facilities currently need JRuby. Please switch to, or install JRuby"
+      end
+    end
+  end # jruby
+  
 end # DataShift