datashift_spree 0.2.0 → 0.2.1

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/datashift_spree.gemspec

@@ -1,5 +1,5 @@
 lib = File.expand_path('../lib/', __FILE__)
-puts lib
+
 $:.unshift '.' 
 $:.unshift lib unless $:.include?(lib)
 

data/datashift_spree.thor

@@ -6,46 +6,45 @@
 #
 # Details::   General tools related to DataShiftSpree Gem : specification, build, deploy
 # 
-#             Provides specifically tailored support for uploading or exporting
-#             Spree Products, associations and Images
-
-
-class DatashiftSpree < Thor
+#
+module Datashift
+      
+  class Spree < Thor  
   
-  desc 'build', 'Build gem '
+    desc 'build', 'Build gem '
   
-  method_option :version, :required => true, :aliases => '-v', :desc => "YAML config containing static definitions"
-  method_option :push, :aliases => '-p', :desc => "Push most recent gem to rubygems"
-  method_option :install, :aliases => '-i', :desc => "Run gem install on the built gems"
+    method_option :version, :required => true, :aliases => '-v', :desc => "YAML config containing static definitions"
+    method_option :push, :aliases => '-p', :desc => "Push most recent gem to rubygems"
+    method_option :install, :aliases => '-i', :desc => "Run gem install on the built gems"
 
-  def build()
+    def build()
 
-    $:.unshift '.'  # 1.9.3 quite strict, '.' must be in load path for relative paths to work from here
+      $:.unshift '.'  # 1.9.3 quite strict, '.' must be in load path for relative paths to work from here
 
-    gemspec = 'datashift_spree.gemspec'
+      gemspec = 'datashift_spree.gemspec'
 
-    # Bump the VERSION file
+      # Bump the VERSION file
    
-    system("echo #{options[:version]} > VERSION ") if(options[:version])
+      system("echo #{options[:version]} > VERSION ") if(options[:version])
 
-    puts "Will build gem #{gemspec}"
+      puts "Will build gem #{gemspec}"
       
-    system("gem build #{gemspec}") 
+      system("gem build #{gemspec}") 
        
-    glob = options[:version] ? "datashift_spree-#{options[:version]}.gem" : "datashift_spree-*.gem"
+      glob = options[:version] ? "datashift_spree-#{options[:version]}.gem" : "datashift_spree-*.gem"
     
-    files = Dir[glob].sort_by { |f|File.mtime(f) }
-    files.reject! { |f| (File.file?(f) ? false : true) }
-    recent = files.reverse[0]
+      files = Dir[glob].sort_by { |f|File.mtime(f) }
+      files.reject! { |f| (File.file?(f) ? false : true) }
+      recent = files.reverse[0]
       
-    if(options[:install] && recent)         
-      puts recent
-      system("gem install --no-ri --no-rdoc #{recent}")
-    end
+      if(options[:install] && recent)         
+        puts recent
+        system("gem install --no-ri --no-rdoc #{recent}")
+      end
     
-     if(options[:push] && recent) 
-      system("gem push #{recent}")
-     end
+      if(options[:push] && recent) 
+        system("gem push #{recent}")
+      end
+    end
   end
-
 end

data/lib/loaders/spree/image_loader.rb

@@ -9,43 +9,101 @@ require 'loader_base'
 module DataShift
 
   module SpreeHelper
-     
-    # TODO - extract this out of SpreeHelper to create  a general paperclip loader
+    
+    # Version Helper - find the right class to attach Product images to
+      
+    def self.product_attachment_klazz
+      @product_attachment_klazz  ||= if(DataShift::SpreeHelper::version.to_f > 1.0 )
+        DataShift::SpreeHelper::get_spree_class('Variant' )
+      else
+        DataShift::SpreeHelper::get_spree_class('Product' )
+      end
+    end
+      
+    # Very specific Image Loading for existing Products in Spree. 
+    #
+    # Requirements : A CSV or Excel file which has 2+ columns
+    # 
+    #   1)  Identifies a Product via Name or SKU column
+    #   2+) The full path(s) to the Images to attach to Product from column 1
+    #
     class ImageLoader < SpreeBaseLoader
   
-      def initialize(image = nil, options = {})
+      def initialize(options = {})
         
-        opts = options.merge(:load => false)  # Don't need operators and no table Spree::Image
-
-        super( DataShift::SpreeHelper::get_spree_class('Image'), image, opts )
+        super( DataShift::SpreeHelper::get_spree_class('Image'), nil, options )
+         
+        unless(MethodDictionary.for?(@@product_klass))
+          MethodDictionary.find_operators( @@product_klass )
+          MethodDictionary.build_method_details( @@product_klass )
+        end
         
-        puts "Attachment Class is #{ImageLoader::attachment_klazz}" if(@verbose)
+        unless(MethodDictionary.for?(@@variant_klass))
+          MethodDictionary.find_operators( @@variant_klass )
+          MethodDictionary.build_method_details( @@variant_klass )
+        end
+    
+        puts "Attachment Class is #{SpreeHelper::product_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
-          DataShift::SpreeHelper::get_spree_class('Product' )
-        end
-        @attachment_klazz
+      # Load object not an Image - need to look it up via Name or SKU
+      def reset( object = nil)
+        super(object)
+        
+        @load_object = nil
       end
       
-      def process()
+      def perform_load( file_name, opts = {} )
+        options = opts.dup
+        
+        # force inclusion means add headers to operator list even not present on Image
+        options[:include_all] = true
 
-        if(current_value && @current_method_detail.operator )    
-          
-          # find the db record to assign our Image to
-          @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
+        super(file_name, options)
+      end
+
+      def self.acceptable_path_headers
+        @@path_headers ||= ['attachment', 'images', 'path']
+      end
+      
+      # Called from associated perform_xxxx_load 
+         
+      def process()
+        
+        # TODO - current relies on correct order - i.e lookup column must come before attachment
+        
+        @@path_headers ||= ['attachment', 'images', 'path']
+           
+        operator = @current_method_detail.operator
         
-        elsif(current_value && @current_method_detail.operator?('attachment') )
+        if(current_value && acceptable_path_headers.include?(operator) )
          
-          add_images( @load_object )  
+          add_images( @load_object ) if(@load_object)
+          
+        elsif(current_value && @current_method_detail.operator )    
+          
+          # find the db record to assign our Image usually expect either SKU (Variant) or Name (product)
+          if( MethodDictionary::find_method_detail_if_column(@@product_klass, operator) )
+            @load_object = get_record_by(@@product_klass, operator, current_value)
+            
+          elsif( MethodDictionary::find_method_detail_if_column(@@variant_klass, operator) )
+            puts "Find VARIANT with  #{operator} == #{current_value}"
+            @load_object = get_record_by(@@variant_klass, operator, current_value)
+          else
+            raise "No Spree class can be searched for by #{operator}"
+          end  
+          
+          unless(@load_object)
+            puts "WARNING: Could not find a record where #{operator} == #{current_value}"
+            return
+          else
+            puts "Image Attachment on record #{@load_object.inspect}"
+          end
+             
         end
-      
+        
       end
-    end      
-  end
+      
+    end
+  end      
 end

data/lib/loaders/spree/product_loader.rb

@@ -6,6 +6,7 @@
 # Details::   Specific over-rides/additions to support Spree Products
 #
 require 'spree_base_loader'
+require 'spree_helper'
 
 module DataShift
 

data/lib/loaders/spree/spree_base_loader.rb

@@ -52,8 +52,11 @@ module DataShift
 
       image_data.each do |image|
           
+        #TODO - make this Delimiters::attributes_start_delim and support {alt=> 'blah, :position => 2 etc}
+        
         path, alt_text = image.split(Delimiters::name_value_delim)
    
+        puts "Create  attachment #{path} on ", record.inspect
         create_attachment(@@image_klass, path, record, :viewable, :alt => alt_text)
 
         logger.debug("Product assigned Image from : #{path.inspect}")

data/lib/thor/spree/products_images.thor

@@ -12,6 +12,8 @@
 
 # Note, not DataShift, case sensitive, create namespace for command line : datashift
 
+require 'datashift_spree'
+
 module Datashift
       
   class Spree < Thor     
@@ -36,6 +38,7 @@ module Datashift
       require 'product_loader'
 
       loader = DataShift::SpreeHelper::ProductLoader.new
+      
 
       # YAML configuration file to drive defaults etc
 
@@ -62,7 +65,7 @@ module Datashift
     end
   
 
-    desc "attach_images", "Populate Products with images from Excel/CSV\nProvide column SKU or Name\nProvide column 'attachment' containing full path to image"
+    desc "attach_images", "Populate Products with images from Excel/CSV\nProvide column SKU or Name\nColumn containing full path to image can be named 'attachment', 'images' or 'path' "
     # :dummy => dummy run without actual saving to DB
     method_option :input, :aliases => '-i', :required => true, :desc => "The 2 column import file (.xls or .csv)"
     
@@ -72,26 +75,16 @@ module Datashift
       
       require 'image_loader'
       
-      image_klazz = DataShift::SpreeHelper::get_spree_class('Image' )
-      
-      # force inclusion means add to operator list even if not present
-      options = { :force_inclusion => ['sku', 'attachment'] } if(SpreeHelper::version.to_f > 1 )
-    
       loader = DataShift::SpreeHelper::ImageLoader.new(nil, options)
     
       loader.perform_load( options[:input], options )
     end
   
     
-    #
     # => thor datashift:spree:images input=vendor/extensions/site/fixtures/images
-    # => rake datashift:spree:images input=C:\images\photos large dummy=true
-    #
-    # => rake datashift:spree:images input=C:\images\taxon_icons skip_if_no_assoc=true klass=Taxon
     #
-    desc "images", "Populate the DB with images from a directory\nwhere image names contain somewhere the Product Sku/Name"
+    desc "images", "Populate the DB with images from a directory\nThe image name, must contain the Product Sku or Name, somewhere within it."
     
-    # :dummy => dummy run without actual saving to DB
     method_option :input, :aliases => '-i', :required => true, :desc => "The input path containing images "
     
     method_option :glob, :aliases => '-g',  :desc => 'The glob to use to find files e.g. \'{*.jpg,*.gif,*.png}\' '
@@ -111,139 +104,38 @@ module Datashift
     method_option :use_like, :type => :boolean, :desc => "Use sku/name LIKE 'string%' instead of sku/name = 'string' in where clauses to find Product"
   
     def images()
-
-      require File.expand_path('config/environment.rb')
-      
-      require 'spree/image_loader'
-            
-      @verbose = options[:verbose]
-       
-      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' )
-       
-     # 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
-
-      image_loader = DataShift::SpreeHelper::ImageLoader.new(nil, options)
- 
-      if(options[:config])
-        raise "Bad Config - Cannot find specified file #{options[:config]}" unless File.exists?(options[:config])
-        
-        image_loader.configure_from( options[:config] )
-      end
-
-      loader_config = image_loader.options
+  
+      attachment_options = options.dup
  
-      puts "CONFIG: #{loader_config.inspect}"
-      puts "OPTIONS #{options.inspect}"
-      
-      @image_path = options[:input]
+      @attachment_path = options[:input]
       
-      unless(File.exists?(@image_path))
-        puts "ERROR: Supplied Path [#{@image_path}] not accesible"
+      unless(File.exists?(@attachment_path))
+        puts "ERROR: Supplied Path [#{@attachment_path}] not accesible"
         exit(-1)
       end
       
-      logger.info "Loading Spree images from #{@image_path}"
-
-      missing_records = []
-         
-      # try splitting up filename in various ways looking for the SKU
-      split_on = loader_config['split_file_name_on'] || options[:split_file_name_on]
-             
-      image_cache = DataShift::ImageLoading::get_files(@image_path, options)
+      require File.expand_path('config/environment.rb')
       
-      puts "Found #{image_cache.size} image files - splitting names on delimiter : #{split_on}"
-         
-      image_cache.each do |image_name|
-
-        image_base_name = File.basename(image_name)
-
-        logger.info "Processing image file #{image_base_name} "
-          
-        base_name = File.basename(image_name, '.*')
-        base_name.strip!
+      require 'paperclip/attachment_loader'
             
-        record = nil
-                   
-        record = image_loader.get_record_by(attachment_klazz, attachment_field, base_name)
-         
-        # TODO move into the ImageLoading module 
-        # 
-        # try the seperate individual portions of the filename, front -> back
-        base_name.split(split_on).each do |x|
-          x = "#{options[:sku_prefix]}#{x}" if(options[:sku_prefix])
-         
-          record = image_loader.get_record_by(attachment_klazz, attachment_field, x)
-          break if record
-        end unless(record)
-            
-        # this time try sequentially and incrementally scanning
-        base_name.split(split_on).inject("") do |str, x|
-          z = (options[:sku_prefix]) ? "#{options[:sku_prefix]}#{str}#{x}": "#{str}#{x}"
-          puts z
-          record = image_loader.get_record_by(attachment_klazz, attachment_field, z)
-          break if record
-          x
-        end unless(record)
-        
-        # END TODO
-          
-        record = record.product if(record && record.respond_to?(:product))  # SKU stored on Variant but we want it's master Product
-      
-        if(record)
-          logger.info "Found record for attachment : #{record.inspect}"
-    
-          if(options[:skip_when_assoc])
-            
-            paper_clip_name = image_base_name.gsub(Paperclip::Attachment::default_options[:restricted_characters], '_')
-            
-            exists = record.images.detect {|i| puts "Check #{paper_clip_name} matches #{i.attachment_file_name}"; i.attachment_file_name == paper_clip_name }
-            if(exists)
-              rid = record.respond_to?(:name) ? record.name : record.id
-              puts "Skipping Image #{image_name} already loaded for #{rid}"
-              logger.info "Skipping - Image #{image_name} already loaded for #{attachment_klazz}"
-              next 
-            end
-          end
-        else
-          missing_records << image_name
-        end
-          
-        next if(options[:dummy]) # Don't actually create/upload to DB if we are doing dummy run
+      @verbose = options[:verbose]
 
-        # Check if Image must have an associated record
-        if(record || (record.nil? && options[:process_when_no_assoc]))
-          image_loader.reset()
+      # TOFOX - wont currently work for Product, need proper way to build, where clause
+      attachment_options[:attach_to_lookup_field] = options[:sku] ? :sku : :name
+      
+      puts "Using #{attachment_options[:attach_to_lookup_field]} for lookup" 
           
-          logger.info("Adding Image #{image_name} to Product #{record.name}")
-          image_loader.create_image(image_klazz, image_name, record)
-          puts "Added Image #{File.basename(image_name)} to Product #{record.sku} : #{record.name}" if(@verbose)
-        end
-
-      end
-
-      unless missing_records.empty?
-        FileUtils.mkdir_p('MissingRecords') unless File.directory?('MissingRecords')
+      image_klass = DataShift::SpreeHelper::get_spree_class('Image' )
+      raise "Cannot find Attachment Class" unless image_klass
         
-        puts "WARNING : #{missing_records.size} of #{image_cache.size} images could not be attached to a Product"
-        puts 'For your convenience a copy of images with MISSING Products will be saved to :  ./MissingRecords'
-        missing_records.each do |i|
-          puts "Copying #{i} to MissingRecords folder" if(options[:verbose])
-          FileUtils.cp( i, 'MissingRecords')  unless(options[:dummy] == 'true')
-        end
-      else
-        puts "All images (#{image_cache.size}) were succesfully attached to a Product"
-      end
+      attachment_options[:attach_to_klass] = SpreeHelper::product_attachment_klazz# Pass in real Ruby class not string class name
+      attachment_options[:attach_to_field] = 'images'
+         
+      loader = DataShift::Paperclip::AttachmentLoader.new(image_klass, nil, attachment_options)
+   
+      logger.info "Loading attachments from #{@attachment_path}"
 
-      puts "Dummy Run Complete- if happy run without -d" if(options[:dummy])
+      loader.process_from_filesystem(@attachment_path, attachment_options)
    
     end