canvas_sync 0.22.12.beta4 → 0.22.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc92f78b570ceb30606d3757b304a7a4091570bd62f8a7e534f6326f94105048
-  data.tar.gz: 75c4f6e0d78615da39ac766258ebde594589798af68626899452447214d15fcf
+  metadata.gz: f42b6a25ec5fc3e6c78c579e766d19e9c0ff7acec94fd7a9737bb6a0955b88a2
+  data.tar.gz: 228358cb249033c7d3a9791bad5107029b78dfc427ce56a1a020a354b3d7b7b7
 SHA512:
-  metadata.gz: 96d9e72e36e149f848769ab8e8b5fb397d222005ff1dc12b3c04563792e6c333f420cde4d792ce148d40745685eafa9b422a94fafcc6e7e021a0125f57544e58
-  data.tar.gz: e50fd5faf9f78b4d0fb0be7c5701eea7f774fe051b5fec3d1d9eab2d0b66a88eb6649761d44f91629f6866d9bae7076eab8c8aa2b7d4fbe2c0ca2d2e8f2124bc
+  metadata.gz: 033e9c71870c0e7c4436e98a2f8dfbfe72fa502fc3a976f2f7e0a8c9ca36e4a042323a539132575e56a10272eece7038ad8cfaf14d73c2e8bf501f17d2b1f4cc
+  data.tar.gz: f935ad7d973455ac77567dfac091158bff7cf0a69111eee16c77a677961d3330c7002f99547720743ef82da3c603306d5bfe3d6a82c107f5c0d87708223b9295

data/lib/canvas_sync/concerns/sync_mapping.rb

@@ -33,6 +33,7 @@ module CanvasSync::Concerns
         @map_def = map_def
         @map_def[:conflict_target] ||= []
         @map_def[:columns] ||= {}
+        @map_def[:row_alterations] ||= []
       end
 
       def self.normalize_model_name(model)
@@ -105,6 +106,10 @@ module CanvasSync::Concerns
         @map_def[:columns].delete(key)
       end
 
+      def alter_rows(&blk)
+        @map_def[:row_alterations] << blk
+      end
+
       def link_column(m = {}, type: nil, **kwargs, &blk)
         if m.is_a?(Hash)
           m = m.merge(kwargs)

data/lib/canvas_sync/generators/templates/models/context_module.rb

@@ -6,7 +6,14 @@
 class ContextModule < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
+
   # include CanvasSync::Concerns::LiveEventSync
+  # live_events_config event_prefix: :module
+  # def process_live_event(event_type, payload, metadata)
+  #   self.canvas_context_id = payload['context_id']
+  #   self.canvas_context_type = payload['context_type']
+  #   super
+  # end
 
   canvas_sync_features :defaults
 

data/lib/canvas_sync/importers/bulk_importer.rb

@@ -17,25 +17,35 @@ module CanvasSync
       #        Note: passing the key [:on_duplicate_key_ignore] will override the default behavior of [:on_duplicate_key_update]
       # @yieldparam [Array] row if a block is passed in it will yield the current row from the CSV.
       #   This can be used if you need to filter or massage the data in any way.
-      def self.import(report_file_path, mapping, klass, conflict_target, import_args: {}, &blk) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/LineLength
+
+      # NEW: (report_file_path, klass, mapping, import_args: {}, &blk)
+      # LEGACY: (report_file_path, columns, klass, conflict_target, import_args: {}, &blk)
+      def self.import(report_file_path, *args, import_args: {}, &blk) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/LineLength
+        if args.length == 2
+          klass = args[0]
+          mapping = args[1]
+        elsif args.length == 3
+          klass = args[1]
+          mapping = { columns: args[0], conflict_target: args[2] }
+        end
+
         ClassCallbackExecutor.run_if_defined(klass, :sync_import) do
-          perform_in_batches(report_file_path, mapping, klass, conflict_target, import_args: import_args, &blk)
+          perform_in_batches(report_file_path, klass, mapping, import_args: import_args, &blk)
         end
       end
 
-      def self.perform_in_batches(report_file_path, raw_mapping, klass, conflict_target, import_args: {}, &block)
-        mapping = {}.with_indifferent_access
-        raw_mapping.each do |db_col, opts|
+      def self.perform_in_batches(report_file_path, klass, mapping, import_args: {}, &block)
+        conflict_target = Array(mapping[:conflict_target]).map(&:to_s)
+
+        col_mapping = {}.with_indifferent_access
+        mapping[:columns].each do |db_col, opts|
           next if opts[:deprecated] && !klass.column_names.include?(db_col.to_s)
 
-          mapping[db_col] = opts
+          col_mapping[db_col] = opts
         end
 
-        csv_column_names = mapping.values.map { |value| value[:report_column].to_s }
-        database_column_names = mapping.keys
-
-        conflict_target = Array(conflict_target).map(&:to_s)
-        conflict_target_indices = conflict_target.map{|ct| database_column_names.index(ct) }
+        csv_column_names = col_mapping.values.map { |value| value[:report_column].to_s }
+        database_column_names = col_mapping.keys
 
         enumer = CSV.foreach(report_file_path, headers: true, header_converters: :symbol).lazy
 
@@ -48,6 +58,9 @@ module CanvasSync
           end
         end
 
+        # Convert rows to a hash that we can manipulate if desired
+        enumer = enumer.map {|row| row.to_h.with_indifferent_access }
+
         # Optionally chunk by a computed value. Mainly so we can group duplicate rows and choose one
         chunker = nil
         chunker = UserChunker.new if defined?(User) && klass == User && csv_column_names.include?('user_id')
@@ -55,9 +68,14 @@ module CanvasSync
           enumer = enumer.chunk{|row| chunker.key(row) }.flat_map{|key, rows| chunker.choose(key, rows) }
         end
 
+        # Pre-alter rows
+        (mapping[:row_alterations] || []).each do |alterer|
+          enumer = enumer.each {|r| alterer.call(r) }
+        end
+
         # Prepare the rows for import
         enumer = enumer.map do |row|
-          mapping.map do |db_col, col_def|
+          col_mapping.map do |db_col, col_def|
             value = nil
             value = row[col_def[:report_column]] if col_def[:report_column]
 
@@ -78,22 +96,23 @@ module CanvasSync
           end
         end
 
-        # Reject rows within a single batch that have the same ID
-        row_ids = nil
+        # Reject rows within a single batch that have the same ID (use indices so we can use the post-transformed values)
+        conflict_target_indices = conflict_target.map{|ct| database_column_names.index(ct) }
+        row_ids = Set.new
         if conflict_target.present?
           enumer = enumer.reject do |row|
             key = conflict_target_indices.map{|ct| row[ct] }
-            skip = row_ids[key]
-            row_ids[key] = true
-            skip
+            next true if row_ids.include?(key)
+
+            row_ids << key
+            false
           end
         end
 
         # Start importing
-        row_ids = {}
         enumer.each_slice(batch_size) do |batch|
           perform_import(klass, database_column_names, batch, conflict_target, import_args)
-          row_ids = {}
+          row_ids.clear
         end
       end
 

data/lib/canvas_sync/processors/report_processor.rb

@@ -13,12 +13,10 @@ module CanvasSync
       end
 
       def do_bulk_import(report_file_path, model, options: {}, mapping_key: nil, &blk)
-        m = mapping_for(model, mapping_key)
         CanvasSync::Importers::BulkImporter.import(
           report_file_path,
-          m[:columns],
           model,
-          m[:conflict_target],
+          mapping_for(model, mapping_key),
           import_args: options,
           &blk
         )

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.22.12.beta4".freeze
+  VERSION = "0.22.13".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.22.12.beta4
+  version: 0.22.13
 platform: ruby
 authors:
 - Instructure CustomDev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
+date: 2025-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -444,12 +444,10 @@ files:
 - lib/canvas_sync/concerns/account/ancestry.rb
 - lib/canvas_sync/concerns/account/base.rb
 - lib/canvas_sync/concerns/api_syncable.rb
-- lib/canvas_sync/concerns/auto_relations.rb
 - lib/canvas_sync/concerns/legacy_columns.rb
 - lib/canvas_sync/concerns/live_event_sync.rb
 - lib/canvas_sync/concerns/role/base.rb
 - lib/canvas_sync/concerns/sync_mapping.rb
-- lib/canvas_sync/concerns/user/sharded.rb
 - lib/canvas_sync/config.rb
 - lib/canvas_sync/engine.rb
 - lib/canvas_sync/generators/install_generator.rb
@@ -776,7 +774,6 @@ files:
 - spec/dummy/db/migrate/20250319194134_create_course_nicknames.rb
 - spec/dummy/db/migrate/20250319194135_create_rubrics.rb
 - spec/dummy/db/schema.rb
-- spec/dummy/tmp/local_secret.txt
 - spec/factories/account_factory.rb
 - spec/factories/admin_factory.rb
 - spec/factories/assignment_factory.rb
@@ -1039,7 +1036,6 @@ test_files:
 - spec/dummy/db/migrate/20250319194134_create_course_nicknames.rb
 - spec/dummy/db/migrate/20250319194135_create_rubrics.rb
 - spec/dummy/db/schema.rb
-- spec/dummy/tmp/local_secret.txt
 - spec/factories/account_factory.rb
 - spec/factories/admin_factory.rb
 - spec/factories/assignment_factory.rb

data/lib/canvas_sync/concerns/auto_relations.rb

@@ -1,11 +0,0 @@
-module CanvasSync::Concerns
-  module AutoRelations
-    extend ActiveSupport::Concern
-
-    # CanvasSync::Record.define_feature self, default: true
-
-    included do
-
-    end
-  end
-end

data/lib/canvas_sync/concerns/user/sharded.rb

@@ -1,18 +0,0 @@
-module CanvasSync::Concerns
-  module User
-    module CanvasSharded
-      extend ActiveSupport::Concern
-
-      CanvasSync::Record.define_feature self, default: false
-
-      included do
-
-      end
-
-      class_methods do
-
-      end
-
-    end
-  end
-end

data/spec/dummy/tmp/local_secret.txt

@@ -1 +0,0 @@
-851f946ee3fdb7c1b6265a8445cdcc0071988f43898ec1099500a655f28484d45fa06dd9628496983d323a058d72b6282782401cabcb8856c09378199ca2ab38