datashift_spree 0.1.0 → 0.2.0

data/README.markdown

@@ -2,7 +2,7 @@
 
 Specific loaders and command line tasks for Spree E-Commerce.
 
-Wiki here : **https://github.com/autotelik/datashift/wiki**
+Wiki here : **https://github.com/autotelik/datashift_spree/wiki**
 
 ### Features
 
@@ -21,35 +21,39 @@ Many example Spreadsheets/CSV files in spec/fixtures, fully documented with comm
 
 ## Installation
 
-Add gem 'datashift' to your Gemfile/bundle, or install the latest gem as usual :
 
-    gem install datashift
+Add to bundle :
 
-To use :
+    gem 'datashift_spree'
 
-    gem 'datashift'
-    require 'datashift'
+Create a high level .thor file - e.g mysite.thor - in your applications root directory 
 
 
-To use the Thor command line applications :
-
-    Create a high level .thor file - e.g mysite.thor - in your applications root directory 
-
-Edit the file and add the following to pull in the thor commands :
-
 ```ruby
-    require 'thor'
-    require 'datashift'
-
-    DataShift::load_commands
+require 'datashift_spree'
+DataShift::SpreeHelper::load_commands
 ```
+
 To check the available tasks run
 
     bundle exc thor list datashift
 
 To get usage information use thor help <command>, for example
 
-    bundle exec thor help datashift:generate:excel
+    bundle exec thor help datashift:spree:products
+
+```ruby
+Usage:
+  thor datashift:spree:products -i, --input=INPUT
+
+Options:
+  -i, --input=INPUT              # The import file (.xls or .csv)
+  -s, [--sku-prefix=SKU_PREFIX]  # Prefix to add to each SKU before saving Product
+  -v, [--verbose]                # Verbose logging
+  -c, [--config=CONFIG]          # Configuration file containg defaults or over rides in YAML
+
+Populate Spree Product/Variant data from .xls (Excel) or CSV file
+```
 
 
 ## License
@@ -58,7 +62,7 @@ Copyright:: (c) Autotelik Media Ltd 2012
 
 Author ::   Tom Statter
 
-Date ::     Dec 2012
+Date ::     Oct 2012
 
 The MIT License
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/datashift_spree.gemspec

@@ -14,8 +14,8 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Thomas Statter"]
-  s.date = "2012-09-10"
-  s.description = "Comprehensive tools to import/export between Excel/CSV and ActiveRecord databases, Rails apps, and any Ruby project"
+  s.date = "2012-09-25"
+  s.description = "Comprehensive Excel/CSV import/export for Spree, Products,Images, any model with full associations"
   s.email = "rubygems@autotelik.co.uk"
   
   s.files = FileList["datashift_spree.thor", 
@@ -25,12 +25,12 @@ Gem::Specification.new do |s|
     "LICENSE.txt", 
     "{lib,spec}/**/*"].exclude("rdoc").exclude("nbproject").exclude("fixtures").exclude(".log").exclude(".contrib").to_a
   
-  s.homepage = "http://github.com/autotelik/datashift"
+  s.homepage = "http://github.com/autotelik/datashift_spree"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.15"
   s.summary = "Shift data betwen Excel/CSV and Ruby"
   
-  s.add_dependency(%q<datashift>, [">= 0.9.0"])
+  s.add_dependency(%q<datashift>, [">= 0.10.1"])
 end
 

data/datashift_spree.thor

@@ -4,10 +4,9 @@
 #
 # License::   MIT - Free, OpenSource
 #
-# Details::   Gem::Specification for DataShift Spree gem.
-#
-#             Provides support for moving data between .xls (Excel/OpenOffice)
-#             Spreedsheets and CSV files specifically tailored for uploading or exporting
+# Details::   General tools related to DataShiftSpree Gem : specification, build, deploy
+# 
+#             Provides specifically tailored support for uploading or exporting
 #             Spree Products, associations and Images
 
 

data/lib/helpers/spree_helper.rb

@@ -50,6 +50,10 @@ module DataShift
       end
     end
     
+    def self.get_image_owner(product)
+      (SpreeHelper::version.to_f > 1) ? product.master : product
+    end
+    
     def self.version
       Gem.loaded_specs['spree'] ? Gem.loaded_specs['spree'].version.version : "0.0.0"
     end

data/lib/loaders/spree/image_loader.rb

@@ -8,67 +8,44 @@ require 'loader_base'
 
 module DataShift
 
-
   module SpreeHelper
      
     # TODO - extract this out of SpreeHelper to create  a general paperclip loader
-    class ImageLoader < LoaderBase
-
-#      include DataShift::SpreeImageLoading
-      include DataShift::CsvLoading
-      include DataShift::ExcelLoading
-      
+    class ImageLoader < SpreeBaseLoader
+  
       def initialize(image = nil, options = {})
         
         opts = options.merge(:load => false)  # Don't need operators and no table Spree::Image
 
         super( DataShift::SpreeHelper::get_spree_class('Image'), image, opts )
         
-        if(DataShift::SpreeHelper::version.to_f > 1.0 )
-          @attachment_klazz  = DataShift::SpreeHelper::get_spree_class('Variant' )
+        puts "Attachment Class is #{ImageLoader::attachment_klazz}" if(@verbose)
+      end
+      
+      def self.attachment_klazz
+        @attachment_klazz  ||= if(DataShift::SpreeHelper::version.to_f > 1.0 )
+          DataShift::SpreeHelper::get_spree_class('Variant' )
         else
-          @attachment_klazz  = DataShift::SpreeHelper::get_spree_class('Product' )
+          DataShift::SpreeHelper::get_spree_class('Product' )
         end
-        
-        puts "Attachment Class is #{@attachment_klazz}" if(@verbose)
-          
-        raise "Failed to create Image for loading" unless @load_object
+        @attachment_klazz
       end
       
       def process()
 
-        if(current_value && @current_method_detail.operator?('attachment') )
-          
-          # assign the image file data as an attachment
-          @load_object.attachment = get_file(current_value)
-          
-          puts "Image attachment created : #{@load_object.inspect}"
-              
-        elsif(current_value && @current_method_detail.operator )    
+        if(current_value && @current_method_detail.operator )    
           
           # find the db record to assign our Image to
-          add_record( get_record_by(@attachment_klazz, @current_method_detail.operator, current_value) )
-                
-        end
-          
-      end
-    
-      def add_record(record)
-        if(record)
-          if(SpreeHelper::version.to_f > 1 )
-            @load_object.viewable = record
-          else
-            @load_object.viewable = record.product   # SKU stored on Variant but we want it's master Product
-          end
-          @load_object.save
-          puts "Image viewable set : #{record.inspect}"
-          
-        else
-          puts "WARNING - Cannot set viewable - No matching record supplied"
-          logger.error"Failed to find a matching record"
+          @load_object = get_record_by(@@product_klass, @current_method_detail.operator, current_value)
+             
+          @load_object = (SpreeHelper::version.to_f > 1) ? @load_object.master : @load_object
+        
+        elsif(current_value && @current_method_detail.operator?('attachment') )
+         
+          add_images( @load_object )  
         end
+      
       end
-    end
-          
+    end      
   end
 end

data/lib/loaders/spree/product_loader.rb

@@ -5,42 +5,27 @@
 #
 # Details::   Specific over-rides/additions to support Spree Products
 #
-require 'loader_base'
-require 'csv_loader'
-require 'excel_loader'
-
-require 'image_loading'
+require 'spree_base_loader'
 
 module DataShift
 
   module SpreeHelper
 
-    class ProductLoader < LoaderBase
-
-      include DataShift::CsvLoading
-      include DataShift::ExcelLoading
-      include DataShift::ImageLoading
+    class ProductLoader < SpreeBaseLoader
 
       # depending on version get_product_class should return us right class, namespaced or not
 
       def initialize(product = nil)
         super( DataShift::SpreeHelper::get_product_class(), product, :instance_methods => true  )
      
-        @@image_klass ||= DataShift::SpreeHelper::get_spree_class('Image')
-        @@option_type_klass ||= DataShift::SpreeHelper::get_spree_class('OptionType')
-        @@option_value_klass ||= DataShift::SpreeHelper::get_spree_class('OptionValue')
-        @@property_klass ||= DataShift::SpreeHelper::get_spree_class('Property')
-        @@product_property_klass ||= DataShift::SpreeHelper::get_spree_class('ProductProperty')
-        @@taxonomy_klass ||= DataShift::SpreeHelper::get_spree_class('Taxonomy')
-        @@taxon_klass ||= DataShift::SpreeHelper::get_spree_class('Taxon')
-        @@variant_klass ||= DataShift::SpreeHelper::get_spree_class('Variant')
-        
         raise "Failed to create Product for loading" unless @load_object
         
         logger.debug "PRODUCT #{@load_object.inspect} MASTER: #{@load_object.master.inspect}"
       end
 
-      def perform_load( file_name, options = {} )
+      def perform_load( file_name, opts = {} )
+        options = opts.dup
+        
          # In >= 1.1.0 Image moved to master Variant from Product so no association called Images on Product anymore
         options[:force_inclusion] = options[:force_inclusion] ? ['images'] : [*options[:force_inclusion]] << 'images'
     
@@ -71,7 +56,7 @@ module DataShift
 
         elsif(@current_method_detail.operator?('images') && current_value)
 
-          add_images
+          add_images( (SpreeHelper::version.to_f > 1) ? @load_object.master : @load_object )
           
         elsif(current_value && (@current_method_detail.operator?('count_on_hand') || @current_method_detail.operator?('on_hand')) )
 
@@ -90,12 +75,12 @@ module DataShift
           # on_hand and on_hand=
           if(@load_object.variants.size > 0)
             
-            if(current_value.to_s.include?(LoaderBase::multi_assoc_delim))
+            if(current_value.to_s.include?(Delimiters::multi_assoc_delim))
 
               #puts "DEBUG: COUNT_ON_HAND PER VARIANT",current_value.is_a?(String),
           
               # Check if we processed Option Types and assign count per option
-              values = current_value.to_s.split(LoaderBase::multi_assoc_delim)
+              values = current_value.to_s.split(Delimiters::multi_assoc_delim)
 
               if(@load_object.variants.size == values.size)
                 @load_object.variants.each_with_index {|v, i| v.on_hand = values[i].to_i }
@@ -108,9 +93,9 @@ module DataShift
           # Can only set count on hand on Product if no Variants exist, else model throws
             
           elsif(@load_object.variants.size == 0) 
-            if(current_value.to_s.include?(LoaderBase::multi_assoc_delim))
+            if(current_value.to_s.include?(Delimiters::multi_assoc_delim))
               puts "WARNING: Multiple count_on_hand values specified but no Variants/OptionTypes created" 
-              load_object.on_hand = current_value.to_s.split(LoaderBase::multi_assoc_delim).first.to_i
+              load_object.on_hand = current_value.to_s.split(Delimiters::multi_assoc_delim).first.to_i
             else
               load_object.on_hand = current_value.to_i
             end
@@ -144,7 +129,7 @@ module DataShift
 
         # example : mime_type:jpeg;print_type:black_white|mime_type:jpeg|mime_type:png, PDF;print_type:colour
         
-        variants = get_each_assoc#current_value.split( LoaderBase::multi_assoc_delim )
+        variants = get_each_assoc#current_value.split( Delimiters::multi_assoc_delim )
 
         # 1) mime_type:jpeg;print_type:black_white  2) mime_type:jpeg  3) mime_type:png, PDF;print_type:colour
 
@@ -156,7 +141,7 @@ module DataShift
                       
           option_types.each do |ostr|
              
-            oname, value_str = ostr.split(LoaderBase::name_value_delim)
+            oname, value_str = ostr.split(Delimiters::name_value_delim)
     
             option_type = @@option_type_klass.find_by_name(oname)
 
@@ -229,31 +214,7 @@ module DataShift
         end
 
       end # each Variant
-
-      # Special case for Images
-      # A list of paths to Images with a optional 'alt' value - supplied in form :
-      #   path:alt|path2:alt2|path_3:alt3 etc
-      #
-      def add_images
-        # TODO smart column ordering to ensure always valid by time we get to associations
-        save_if_new
-
-        images = get_each_assoc#current_value.split(LoaderBase::multi_assoc_delim)
-
-        images.each do |image|
-          puts "Add Image #{image}"
-          img_path, alt_text = image.split(LoaderBase::name_value_delim)
-          
-          # moved from Prod to Variant in spree 1.x.x
-          attachment  = (SpreeHelper::version.to_f > 1) ? @load_object.master : @load_object
-          
-          image = create_image(@@image_klass, img_path, attachment, :alt => alt_text)
-          logger.debug("Product assigned an Image : #{image.inspect}")
-        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_name:value|property_name|property_name:value
@@ -264,7 +225,7 @@ module DataShift
         # TODO smart column ordering to ensure always valid by time we get to associations
         save_if_new
 
-        property_list = get_each_assoc#current_value.split(LoaderBase::multi_assoc_delim)
+        property_list = get_each_assoc#current_value.split(Delimiters::multi_assoc_delim)
 
         property_list.each do |pstr|
         
@@ -307,7 +268,7 @@ module DataShift
         # TODO smart column ordering to ensure always valid by time we get to associations
         save_if_new
 
-        chain_list = get_each_assoc  # potentially multiple chains in single column (delimited by LoaderBase::multi_assoc_delim)
+        chain_list = get_each_assoc  # potentially multiple chains in single column (delimited by Delimiters::multi_assoc_delim)
 
         chain_list.each do |chain|
   

data/lib/loaders/spree/spree_base_loader.rb

@@ -0,0 +1,64 @@
+# 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 'csv_loader'
+require 'excel_loader'
+require 'image_loading'
+
+module DataShift
+
+  class SpreeBaseLoader < LoaderBase
+
+    include DataShift::CsvLoading
+    include DataShift::ExcelLoading
+    include DataShift::ImageLoading
+
+    # depending on version get_product_class should return us right class, namespaced or not
+
+    def initialize(klass, loader_object = nil, options = {})
+      
+      super(klass, loader_object, options  )
+     
+      @@image_klass ||= DataShift::SpreeHelper::get_spree_class('Image')
+      @@option_type_klass ||= DataShift::SpreeHelper::get_spree_class('OptionType')
+      @@option_value_klass ||= DataShift::SpreeHelper::get_spree_class('OptionValue')
+      @@product_klass ||= DataShift::SpreeHelper::get_spree_class('Product')
+      @@property_klass ||= DataShift::SpreeHelper::get_spree_class('Property')
+      @@product_property_klass ||= DataShift::SpreeHelper::get_spree_class('ProductProperty')
+      @@taxonomy_klass ||= DataShift::SpreeHelper::get_spree_class('Taxonomy')
+      @@taxon_klass ||= DataShift::SpreeHelper::get_spree_class('Taxon')
+      @@variant_klass ||= DataShift::SpreeHelper::get_spree_class('Variant')
+    end
+
+    # Special case for Images
+    # 
+    # A list of entries for Images. Multiple entries delimited by Delimiters::multi_assoc_delim
+    # 
+    # Each entry can  with a optional 'alt' value - supplied in form :
+    #  
+    # => path_1:alt|path_2:alt|path_3:alt
+    #
+    def add_images( record )
+      # TODO smart column ordering to ensure always valid by time we get to associations
+      save_if_new
+
+      image_data = get_each_assoc
+
+      image_data.each do |image|
+          
+        path, alt_text = image.split(Delimiters::name_value_delim)
+   
+        create_attachment(@@image_klass, path, record, :viewable, :alt => alt_text)
+
+        logger.debug("Product assigned Image from : #{path.inspect}")
+      end
+      
+    end
+  end
+end

data/lib/thor/spree/products_images.thor

@@ -121,15 +121,15 @@ module Datashift
       puts "Using Product Name for lookup" unless(options[:sku])
       puts "Using SKU for lookup" if(options[:sku])
        
-      image_klazz = DataShift::SpreeHelper::get_spree_class('Image' )
+     # image_klazz = DataShift::SpreeHelper::get_spree_class('Image' )
        
-      attachment_klazz  = DataShift::SpreeHelper::get_spree_class('Product' )
-      attachment_field  = 'name'
+     # attachment_klazz  = DataShift::SpreeHelper::get_spree_class('Product' )
+    #  attachment_field  = 'name'
 
-      if(options[:sku] || SpreeHelper::version.to_f > 1)
-        attachment_klazz =  DataShift::SpreeHelper::get_spree_class('Variant' ) 
-        attachment_field = 'sku'
-      end
+     # if(options[:sku] || SpreeHelper::version.to_f > 1)
+      #  attachment_klazz =  DataShift::SpreeHelper::get_spree_class('Variant' ) 
+     #   attachment_field = 'sku'
+     # end
 
       image_loader = DataShift::SpreeHelper::ImageLoader.new(nil, options)
  

data/spec/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../datashift
   specs:
-    datashift (0.10.0)
+    datashift (0.10.1)
       rubyzip
       spreadsheet
 
@@ -64,7 +64,7 @@ GEM
       builder (>= 2.0.0)
     builder (3.0.3)
     cancan (1.6.7)
-    cocaine (0.3.0)
+    cocaine (0.3.1)
     deface (0.9.1)
       nokogiri (~> 1.5.0)
       rails (~> 3.1)
@@ -156,7 +156,7 @@ GEM
     rspec-core (2.11.1)
     rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.2)
+    rspec-mocks (2.11.3)
     rspec-rails (2.11.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)