sequel-from_csv 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c509d23016e8e8322ca15d6698fc264dd2742455
-  data.tar.gz: fa28138de74f186e4629d4805b629a06149794df
+SHA256:
+  metadata.gz: 3706abc5bcbc730c436d702292e8a7ace38ad3419c73ae9deb82f6b6cc0e3b56
+  data.tar.gz: 759e60fa7eec0007d63df5eef240917dad0174ee9b86f5a4ebba5b7d8b8fb09e
 SHA512:
-  metadata.gz: 470ee8941735710910d0ae3161b92736de5132f1ec7427b2bb18a7adeb6a6c70f5e35fcd8088aece5bf107028aa3af68d885e8ea5c49bc3d062611adb71b7b76
-  data.tar.gz: a9d03c786efa839139f7e965cb579145b9beec4c10a828116061271842531ff7417f57de19dae8b03bb20454db1e74a841ef79d18fd9469962663e0aa6f6fa25
+  metadata.gz: 8dfbd463ee485c63aba9e405d9b3fed23fa4578bf5ff9109d3521af5162dc531c8c6f3a4ea4a2be6480e2dd7737a43c53c23c9e1e0a667f0f3cf2903cc707574
+  data.tar.gz: f148140f6ad0c12deb8ec902e415cf5575f6226d7d617e2c5a2a67454a2b0598295a1a9dc3c82bf43d9b7f020eb853173fefb9eb9a134d18ecd1803efc6576ce

data/lib/sequel-from_csv.rb

@@ -0,0 +1,2 @@
+require "sequel/extensions/from_csv"
+require "sequel/plugins/from_csv"

data/lib/sequel/extensions/from_csv.rb

@@ -2,7 +2,21 @@ module Sequel
   module Extensions
     module FromCsv
 
-      # Finds all CSV files in a directory and synchronizes with their respective DB tables
+      # Finds all CSV files recursively within a directory and calls #seed_from_csv on their respective models
+      #
+      # Calling #seed_from_csv with a directory contaning:
+      # - artists.csv
+      # - artist/has_albums.csv
+      #
+      # Would be equivalent to calling:
+      #   Artist.seed_from_csv "artists.csv"
+      #   Artist::HasAlbum.seed_from_csv "artist/has_albums.csv"
+      #
+      # *Options:*
+      # :delete_missing :: whether to remove rows from the table that were not found in the CSV file
+      # :reset_sequence :: whether to update the primary key's sequence to reflect the max primary key value
+      #
+      # :reset_sequence only works on PostgreSQL tables that auto-increment their primary keys using sequences
       def seed_from_csv directory, **opts
 
         Dir.glob("#{directory}/**/*.csv").each do |filename|
@@ -22,7 +36,6 @@ module Sequel
       end
 
     end
-
   end
-  Database.register_extension(:from_csv, Extensions::FromCsv)
+  Database.register_extension :from_csv, Extensions::FromCsv
 end

data/lib/sequel/plugins/from_csv.rb

@@ -3,17 +3,48 @@ require 'csv'
 module Sequel
   module Plugins
     module FromCsv
+
+      class MissingDataException < StandardError; end
+      class MissingFieldException < StandardError; end
+      class NotYetImplementedException < StandardError; end
+
       module ClassMethods
 
-        # Synchronizes a table's data with a CSV file
-        def seed_from_csv csv_path, delete_missing: false, reset_sequence: true
+        # Synchronizes a table's data with a CSV file. Returns self.
+        #
+        # The table being synchronized must contain exactly one primary key column, and the CSV file used
+        # must contain the primary key column as one of its fields.
+        #
+        # *Options:*
+        # :delete_missing :: whether to remove rows from the table that were not found in the CSV file
+        # :reset_sequence :: whether to update the primary key's sequence to reflect the max primary key value
+        #
+        # :reset_sequence only works on PostgreSQL tables that auto-increment their primary keys using sequences
+        #
+        # *Usage:*
+        #    class Artist < Sequel::Model
+        #      plugin :from_csv
+        #    end
+        #    Artist.seed_from_csv "seeds/artists.csv", reset_sequence: true
+        def seed_from_csv csv_path, delete_missing: false, reset_sequence: false
 
           # Read the source CSV file
-          data = CSV.table csv_path
+          data = CSV.table csv_path, converters: :date_time
+
+          # Guard against CSV files that have headers but not data (to handle a quirk in Ruby's CSV parser)
+          if data.headers.empty?
+            raise MissingDataException, "CSV file #{csv_path} did not contain any data rows"
+          end
+
+          # Check that all primary key columns are present
+          pk = self.primary_key
+          if Array === pk
+            raise NotYetImplementedException, "Sequel::Plugins::FromCsv does not yet support composite primary keys."
+          end
 
           # Ensure the ID column exists
-          unless data.first[:id]
-            raise "CSV file #{csv_path} must contain an id column"
+          unless data.headers.include? pk
+            raise MissingFieldException, "CSV file #{csv_path} must contain a column named '#{pk}'"
           end
 
           self.db.transaction do
@@ -21,12 +52,12 @@ module Sequel
             # UPSERT
             data.each do |row|
               row = row.to_h # Convert CSV::Row to Hash
-              self.dataset.insert_conflict(target: :id, update: row).insert row
+              self.dataset.insert_conflict(target: pk, update: row).insert row
             end
 
             # DELETE old rows
             if delete_missing
-              self.exclude("id IN ?", data.map{|row| row[:id]}).delete
+              self.exclude(pk => data.map{|row| row[pk]}).delete
             end
 
             # Update the table's sequence
@@ -35,7 +66,7 @@ module Sequel
               when :postgres
                 self.db.run <<~SQL
                   SELECT
-                    setval(pg_get_serial_sequence('#{self.simple_table}', 'id'), coalesce(max(id), 1), true)
+                    setval(pg_get_serial_sequence('#{self.simple_table}', '#{pk}'), greatest(max(#{pk}), 1), true)
                   FROM
                     #{self.simple_table}
                 SQL
@@ -44,9 +75,13 @@ module Sequel
 
           end
 
+          # Should return itself
+          self
+
         end
 
       end
+
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-from_csv
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Kenaniah Cerny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-22 00:00:00.000000000 Z
+date: 2018-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - kenaniah@gmail.com
@@ -73,6 +157,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/sequel-from_csv.rb
 - lib/sequel/extensions/from_csv.rb
 - lib/sequel/plugins/from_csv.rb
 homepage: https://github.com/kenaniah/sequel-from_csv
@@ -86,7 +171,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -94,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A simple way to seed and synchronize table data using CSV files