Add a CSV Result analyzer

Author: elia

README.md

@@ -22,7 +22,39 @@ bundle add shopify_toolkit
 
 ## Usage
 
-TODO
+### Analyzing a Matrixify CSV Result files
+
+Matrixify is a popular Shopify app that allows you to import/export data from Shopify using CSV files. The CSV files that Matrixify generates are very verbose and can be difficult to work with. This tool allows you to analyze the CSV files and extract the data you need.
+
+The tool will import the file into a local SQLite database
+and open a console for you to run queries against the data
+using ActiveRecord.
+
+```shell
+shopify-csv analyze products-result.csv --force-import
+==> Importing products-result.csv into /var/folders/hn/z7b7s1kj3js4k7_qk3lj27kr0000gn/T/shopify-toolkit-analyze-products_result_csv.sqlite3
+-- create_table(:results, {:force=>true})
+   -> 0.0181s
+-- add_index(:results, :import_result)
+   -> 0.0028s
+........................
+==> Starting console for products-result.csv
+>> comments
+=>
+["UPDATE: Found by Handle | Assuming MERGE for Variant Command | Assuming MERGE for Tags Command | Variants updated by SKU: 1",
+ "UPDATE: Found by Handle | Assuming MERGE for Variant Command | Assuming MERGE for Tags Command | Variants updated by SKU: 1 | Warning: The following media were not uploaded to Shopify: [https://mymedia.com/image.jpg: Error downloading from Web: 302 Moved Temporarily]",
+ ...]
+>> first
+#<ShopifyCSV::Result:0x0000000300bf1668
+ id: 1,
+ data: nil,
+ handle: "my-product",
+ title: "My Product",
+ import_result: "OK",
+ import_comment: "UPDATE: Found by Handle | Assuming MERGE for Varia...">
+>> count
+=> 116103
+```
 
 ## Development
 

exe/shopify-csv

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+require 'csv'
+require 'active_record'
+require 'thor'
+require 'tmpdir'
+
+class ShopifyCSV < Thor
+  RESERVED_COLUMN_NAMES = %w[select type id]
+
+  class Result < ActiveRecord::Base
+    def self.comments
+      distinct.pluck(:import_comment)
+    end
+
+    def self.with_comment(text)
+      where("import_comment LIKE ?", "%#{text}%")
+    end
+  end
+
+  desc "analyze CSV_PATH", "Analyze results file at path CSV_PATH"
+  method_option :force_import, type: :boolean, default: false
+  method_option :tmp_dir, type: :string, default: Dir.tmpdir
+  def analyze(csv_path)
+    csv_path = File.expand_path(csv_path)
+    underscore = ->(string) { string.downcase.gsub(/[^a-z0-9]+/, "_").gsub(/(^_+|_+$)/, "") }
+    csv = CSV.open(csv_path, liberal_parsing:true )
+    header_to_column = -> { RESERVED_COLUMN_NAMES.include?(_1.to_s) ? "#{_1}_1" : _1 }
+    headers = csv.shift.map(&underscore).map(&header_to_column)
+    basename = File.basename csv_path
+    database = "#{options[:tmp_dir]}/shopify-toolkit-analyze-#{underscore[basename]}.sqlite3"
+    should_import = options[:force_import] || !File.exist?(database)
+    to_record = ->(row) { headers.zip(row).to_h.transform_keys(&header_to_column) }
+
+    File.delete(database) if should_import && File.exist?(database)
+
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database:)
+
+    if should_import
+      puts "==> Importing #{csv_path}"
+      puts "-- database: #{database}"
+      ActiveRecord::Schema.define do
+        create_table :results, force: true do |t|
+          t.json :data
+          headers.each { |header| t.string header }
+        end
+        add_index :results, :import_result if headers.include?('import_result')
+      end
+      csv.each_slice(5000) { |rows| print "."; Result.insert_all(rows.map(&to_record)) }
+      puts
+    end
+
+    puts "==> Starting console for #{basename}"
+    require "irb"
+    IRB.conf[:IRB_NAME] = basename
+    Result.class_eval { binding.irb(show_code: false) }
+  end
+end
+
+ShopifyCSV.start(ARGV)