populate-me 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a92596c5ed11fb3d67f18b48fdc1011ecf423f26390c2f71c3587c3c2cae93cf
-  data.tar.gz: 70e4e6572ed7e98ace3444ee6c6c18ff937b0ed72aa35b80a5c5d2ad99865d91
+  metadata.gz: ab01b0340f42771cfda2e496e4dee387c3e098ee2757ee374f5fb9a95fda48b0
+  data.tar.gz: b74800276c349db0d4dcc74f46f36d5b6fb6a46cb4d727c5dbfb9e46d35d0aa4
 SHA512:
-  metadata.gz: cd01c21a0a760cb1691453ca86f22a75cbabd423134bd25c699fbd0ea96ef6a1845a88d130c61f62fcec9a2f77fb527759152307fb0fb762f0778a2f657bbe3d
-  data.tar.gz: fc764eb27f6c4dd76bde7b952432dc0a647872a061f564f3ac9104511b7baecd0a67866b9777726e329619cd6e1b3663e107f3e774d908e794cfe100592c44b4
+  metadata.gz: 7621910d4fec3622e2bad85742c0877fbe6bafdf9dcb28f804e40d5ae255b362de66cdf6d978a1d49fa27874527705d2cec80146e2624f71ac4783a4bd8b5554
+  data.tar.gz: c65c5db1c8361cb50ada68e63cc246325590a0e8ca00a2f6a3e90e047f73cbc4a0072293ab52a60317a9b0710e96d7439ac3efd1860d3d134edd848ae144670f

data/lib/populate_me/admin/__assets__/css/main.css

@@ -214,6 +214,14 @@ fieldset {
   color: #dc322f;
 }
 
+.error {
+  color: #dc322f;
+}
+
+.batch-upload-report {
+  margin: 20px;
+}
+
 /* asmSelect */
 
 .asmListItem {

data/lib/populate_me/admin/__assets__/js/main.js

@@ -117,13 +117,17 @@ PopulateMe.scroll_to = function(el, column) {
 // Mark errors for report after form validation.
 // It adds the .invalid class to invalid fields,
 // and adds the report after the label of the field.
-PopulateMe.mark_errors = function(context,report) {
+PopulateMe.mark_errors = function(context, report, isSubcontext) {
+  if (!isSubcontext) {
+    $('.invalid', context).removeClass('invalid');
+    $('.errors', context).remove();
+  }
   $.each(report,function(k,v) {
     var field = context.find('> [data-field-name='+k+']:first');
     if (field.is('fieldset')) {
       $.each(v, function(index,subreport) {
         var subcontext = field.find('> .nested-documents > li:nth('+index+')');
-        PopulateMe.mark_errors(subcontext, subreport);
+        PopulateMe.mark_errors(subcontext, subreport, true);
       });
     } else {
       field.addClass('invalid');
@@ -133,6 +137,54 @@ PopulateMe.mark_errors = function(context,report) {
   });
 };
 
+// Navigate columns back
+PopulateMe.navigate_back = function(target_id) {
+  // !!! Careful, it only works if we call this from the last column
+  var reloader = PopulateMe.finder.find('> li:nth-last-child(3) .selected');
+  if (reloader.size() > 0) {
+    var reloadee = PopulateMe.finder.find('> li:nth-last-child(2)');
+    var current_search = PopulateMe.copy_column_search(reloadee);
+    reloader.trigger('click.columnav',[function(cb_object) {
+      PopulateMe.restore_column_search(cb_object.column, current_search);
+      if (target_id) {
+        var target = $('[data-id=' + target_id + ']', cb_object.column);
+        if (target.size() > 0) {
+          PopulateMe.scroll_to(target, cb_object.column);
+        }
+      }
+    }]);
+  } else {
+    PopulateMe.finder.trigger('pop.columnav');
+  }
+}
+
+PopulateMe.fieldMaxSize = function(field) {
+  var maxSizeData = field.data('max-size');
+  if (!maxSizeData) {
+    return null;
+  }
+  return field.data('max-size');
+};
+
+PopulateMe.fieldHasFileTooBig = function(field, maybeFile) {
+  var file = maybeFile || field[0].files[0];
+  if (!file) {
+    return false;
+  }
+  var maxSize = PopulateMe.fieldMaxSize(field);
+  if (!maxSize) {
+    return false;
+  }
+  return file.size > maxSize;
+};
+
+PopulateMe.fileTooBigErrorMessage = function(fname, max_size) {
+  if (typeof max_size != 'number') {
+    max_size = PopulateMe.fieldMaxSize(max_size);
+  }
+  return 'File too big: ' + fname + ' should be less than ' + PopulateMe.display_file_size(max_size) + '.';
+};
+
 // JS Validations
 // This adds validations that could happen before sending
 // anything to the server and that cannot be done with 
@@ -146,18 +198,13 @@ PopulateMe.jsValidationsPassed = function(context) {
       var max_size_fields = $('input[type=file][data-max-size]', context);
       max_size_fields.each(function() {
         var field = $(this);
-        var max_size = parseInt(field.data('max-size'));
-        if (field[0].files[0]) {
-          var fsize = field[0].files[0].size;
-          var fname = field[0].files[0].name;
-          if (fsize>max_size) {
-            alert('File too big: '+fname+' should be less than '+PopulateMe.display_file_size(max_size)+'.');
-            throw "Validation error";
-          }
+        if (PopulateMe.fieldHasFileTooBig(field)) {
+          alert(PopulateMe.fileTooBigErrorMessage(file.name, field));
+          throw "Validation error";
         }
       });
     } catch(e) {
-      if (e==='Validation error') { 
+      if (e==='Validation error') {
         return false;
       } else {
         throw(e);
@@ -167,7 +214,7 @@ PopulateMe.jsValidationsPassed = function(context) {
   return true;
 };
 
-// Init column 
+// Init column
 // Bind events and init things that need to happen when 
 // a new column is added to the finder.
 // The callback `custom_init_column` is also called at the end
@@ -303,48 +350,111 @@ $(function() {
   });
 
   // Ajax form
+
+  var ajaxSubmitSuccess = function(res) {
+    if (res.success == true) {
+      PopulateMe.navigate_back(res.data._id);
+    }
+  };
+
+  var ajaxSubmitError = function(xhr, ctx) {
+    res = xhr.responseJSON;
+    if (res.success == false) {
+      PopulateMe.mark_errors(ctx, res.data);
+      PopulateMe.scroll_to(ctx.find('.invalid:first'));
+      $('input[type=submit]', ctx).show();
+      ctx.fadeTo("fast", 1);
+    }
+  };
+
   $('body').on('submit','form.admin-post, form.admin-put', function(e) {
     e.preventDefault();
     var self = $(this);
-    if (PopulateMe.jsValidationsPassed(self)) {
-
-      var submit_button = $('input[type=submit]',self);
-      submit_button.hide();
-      $.ajax({
-        url: self.attr('action'),
-        type: (self.is('.admin-put') ? 'put' : 'post'),
-        data: new FormData(this),
-        processData: false,
-        contentType: false,
-        success: function(res) {
-          if (res.success==true) {
-            var reloader = PopulateMe.finder.find('> li:nth-last-child(3) .selected');
-            if (reloader.size()>0) {
-              var reloadee = PopulateMe.finder.find('> li:nth-last-child(2)');
-              var current_search = PopulateMe.copy_column_search(reloadee);
-              reloader.trigger('click.columnav',[function(cb_object) {
-                var target = $('[data-id='+res.data._id+']', cb_object.column);
-                if (target.size()>0) {
-                  PopulateMe.restore_column_search(cb_object.column, current_search);
-                  PopulateMe.scroll_to(target, cb_object.column);
-                }
-              }]);
-            } else {
-              PopulateMe.finder.trigger('pop.columnav');
-            }
+    self.fadeTo("fast", 0.3);
+    var submit_button = $('input[type=submit]', self);
+    var formData = new FormData(this);
+    var batchField = self.data('batch-field');
+    var batchFieldEl = $("input[name='" + batchField + "']");
+    var isBatchUpload = self.is('.admin-post') &&
+                        batchField &&
+                        formData.getAll(batchField).length > 1;
+
+    if (isBatchUpload) {
+
+      if (confirm("You've selected multiple images. This will create an entry for each image. It may take a while to upload everything. Do you wish to proceed ?")) {
+        submit_button.hide();
+        var files = formData.getAll(batchField);
+        var report = $("<div class='batch-upload-report'></div>").insertAfter(self);
+        var latestSuccessfulId;
+        var errorSize = 0;
+        var successSize = 0;
+        var addCloseButtonIfDone = function() {
+          if (errorSize + successSize >= files.length) {
+            var closeButton = $("<button type='button'>Close</button>").click(function(e) {
+              e.preventDefault();
+              PopulateMe.navigate_back();
+            });
+            report.append(closeButton);
           }
-        },
-        error: function(xhr) {
-          res = xhr.responseJSON;
-          if (res.success==false) {
-            $('.invalid',self).removeClass('invalid');
-            $('.errors',self).remove();
-            PopulateMe.mark_errors(self,res.data);
-            PopulateMe.scroll_to(self.find('.invalid:first'));
-            submit_button.show();
+        };
+        for (var i = 0; i < files.length; i++) {
+          var file = files[i];
+          if (PopulateMe.fieldHasFileTooBig(batchFieldEl, file)) {
+            errorSize += 1;
+            var msg = PopulateMe.fileTooBigErrorMessage(file.name, batchFieldEl);
+            report.append("<div class='error'>" + msg + "</div>");
+            addCloseButtonIfDone();
+          } else {
+            formData.set(batchField, file, file.name);
+            $.ajax({
+              url: self.attr('action'),
+              type: (self.is('.admin-put') ? 'put' : 'post'), // Always post ?
+              data: formData,
+              successData: {filename: file.name, index: i+1},
+              processData: false,
+              contentType: false,
+              success: function(res, textStatus, xhr) {
+                successSize += 1;
+                if (res.success == true) {
+                  latestSuccessfulId = res.data._id;
+                  report.append("<div>Uploaded: " + this.successData.filename + "</div>");
+                }
+                if (successSize >= files.length) {
+                  PopulateMe.navigate_back(res.data._id);
+                } else {
+                  addCloseButtonIfDone();
+                }
+              },
+              error: function(xhr, textStatus, errorThrown) {
+                errorSize += 1;
+                report.append("<div class='error'>Error: " + this.successData.filename + "</div>");
+                res = xhr.responseJSON;
+                if (res.success == false) {
+                  PopulateMe.mark_errors(self, res.data);
+                }
+                addCloseButtonIfDone();
+              }
+            });
           }
         }
-      });
+      }
+
+    } else {
+
+      if (PopulateMe.jsValidationsPassed(self)) {
+        submit_button.hide();
+        $.ajax({
+          url: self.attr('action'),
+          type: (self.is('.admin-put') ? 'put' : 'post'),
+          data: formData,
+          processData: false,
+          contentType: false,
+          success: ajaxSubmitSuccess,
+          error: function(xhr, textStatus, errorThrown) {
+            ajaxSubmitError(xhr, self);
+          }
+        });
+      }
 
     }
   });

data/lib/populate_me/admin/views/page.erb

@@ -4,6 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <title><%= settings.meta_title %></title>
+    <link href="<%= request.script_name %>/__assets__/img/favicon.png" rel="icon" type="image/png">
     <link rel="stylesheet" href="<%= request.script_name %>/__assets__/css/jquery-ui.min.css" type="text/css" media='screen' />
     <link rel="stylesheet" href="<%= request.script_name %>/__assets__/css/asmselect.css" type="text/css" media='screen' />
     <link rel="stylesheet" href="<%= request.script_name %>/__assets__/css/main.css" type="text/css" media='screen' />
@@ -79,7 +80,7 @@
       {{#polymorphic_type}}
         <p>({{polymorphic_type}})</p>
       {{/polymorphic_type}}
-      <form action="<%= request.script_name %>/api/{{admin_url}}" method="POST" accept-charset="utf-8" class='admin-{{#is_new}}post{{/is_new}}{{^is_new}}put{{/is_new}}'>
+      <form action="<%= request.script_name %>/api/{{admin_url}}" method="POST" accept-charset="utf-8" class='admin-{{#is_new}}post{{/is_new}}{{^is_new}}put{{/is_new}}' {{#batch_field}}{{#is_new}}data-batch-field="{{batch_field}}"{{/is_new}}{{/batch_field}}>
         {{#custom_partial_or_default}}template_form_fields{{/custom_partial_or_default}}
         {{^is_new}}
           <input type="hidden" name="_method" value="PUT" />
@@ -156,7 +157,7 @@
         <button class='attachment-deleter'>x</button>
         <br />
       {{/url}}
-      <input type='file' name='{{input_name}}' {{#max_size}}data-max-size='{{max_size}}'{{/max_size}} {{{build_input_atrributes}}} />
+      <input type='file' name='{{input_name}}' {{#multiple}}multiple{{/multiple}} {{#max_size}}data-max-size='{{max_size}}'{{/max_size}} {{{build_input_atrributes}}} />
     </script>
 
     <script id="template-list-field" type="x-tmpl-mustache">

data/lib/populate_me/document.rb

@@ -27,7 +27,7 @@ module PopulateMe
     # It can be used on its own but it keeps everything
     # in memory. Which means it is only for tests and conceptual
     # understanding.
-    
+
     include DocumentMixins::Typecasting
     include DocumentMixins::Outcasting
     include DocumentMixins::Schema

data/lib/populate_me/document_mixins/admin_adapter.rb

@@ -48,12 +48,16 @@ module PopulateMe
         end
         page_title = self.new? ? "New #{self.class.to_s_short}" : self.to_s
         # page_title << " (#{self.polymorphic_type})" if self.class.polymorphic?
+        batch_field_item = items.find do |item|
+          item[:field_name] == self.class.batch_field
+        end
         {
           template: "template#{'_nested' if o[:nested]}_form",
           page_title: page_title,
           admin_url: self.to_admin_url,
           is_new: self.new?,
           polymorphic_type: self.class.polymorphic? ? self.polymorphic_type : nil,
+          batch_field: (not self.new? or batch_field_item.nil?) ? nil : batch_field_item[:input_name],
           fields: items
         }
       end

data/lib/populate_me/document_mixins/outcasting.rb

@@ -74,6 +74,7 @@ module PopulateMe
       def outcast_attachment field, item, o={}
         item = item.dup
         item[:url] = self.attachment(field).url
+        item[:multiple] = (self.new? and self.class.batch_field == field)
         item
       end
 

data/lib/populate_me/document_mixins/schema.rb

@@ -118,14 +118,21 @@ module PopulateMe
         def label sym # sets the label_field
           @label_field = sym.to_sym
         end
-        
+
         def label_field
           return @label_field if self.fields.empty?
-          @label_field || self.fields.find do |k,v| 
+          @label_field || self.fields.find do |k,v|
             not [:id,:polymorphic_type].include?(v[:type])
           end[0]
         end
 
+        def batch_on_field sym # sets the batch_field
+          @batch_field = sym.to_sym
+        end
+        def batch_field
+          @batch_field
+        end
+
         def sort_by f, direction=:asc
           raise(ArgumentError) unless [:asc,:desc].include? direction
           raise(ArgumentError) unless self.new.respond_to? f

data/lib/populate_me/version.rb

@@ -1,4 +1,4 @@
 module PopulateMe
-  VERSION = '0.16.0'
+  VERSION = '0.17.0'
 end
 

data/test/test_document_admin_adapter.rb

@@ -178,7 +178,7 @@ describe PopulateMe::Document, 'AdminAdapter' do
   describe '#to_admin_form' do
     class PolyForm < PopulateMe::Document
       field :name
-      field :image, only_for: 'Image'
+      field :image, only_for: 'Image', type: :attachment, class_name: PopulateMe::Attachment
       field :title, only_for: 'Article'
       field :content, only_for: 'Article'
       field :position
@@ -215,6 +215,29 @@ describe PopulateMe::Document, 'AdminAdapter' do
       form = obj.to_admin_form
       assert_nil form[:polymorphic_type]
     end
+
+    class WithBatchField < PopulateMe::Document
+      field :name
+      field :thumbnail, type: :attachment, class_name: PopulateMe::Attachment
+      batch_on_field :thumbnail
+    end
+    it 'Sets :batch_field if there is one' do
+      obj = PolyForm.new
+      form = obj.to_admin_form
+      assert_nil form[:batch_field]
+      obj = NotPolyForm.new
+      form = obj.to_admin_form
+      assert_nil form[:batch_field]
+      obj = WithBatchField.new
+      form = obj.to_admin_form
+      assert_equal 'data[thumbnail]', form[:batch_field]
+    end
+    it 'Does not add a batch field when updating' do
+      obj = WithBatchField.new
+      obj._is_new = false
+      form = obj.to_admin_form
+      assert_nil form[:batch_field]
+    end
   end
 
 end

data/test/test_document_outcasting.rb

@@ -20,10 +20,13 @@ class Outcasted < PopulateMe::Document
   field :tags, type: :select, select_options: ['art','sport','science'], multiple: true
   field :related_properties, type: :select, select_options: ['prop1','prop2','prop3'], multiple: true
   field :pdf, type: :attachment
+  field :image, type: :attachment
   field :authors, type: :list
   field :weirdo, type: :strange
   field :price, type: :price
 
+  batch_on_field :image
+
   def get_category_autocomplete_list
     ['Horse', 'Bear']
   end
@@ -42,6 +45,11 @@ class Outcasted::Author < PopulateMe::Document
   field :name
 end
 
+class OutcastedNoBatchField < PopulateMe::Document
+  set :default_attachment_class, PopulateMe::Attachment
+  field :image, type: :attachment
+end
+
 describe PopulateMe::Document, 'Outcasting' do
 
   parallelize_me!
@@ -276,6 +284,35 @@ describe PopulateMe::Document, 'Outcasting' do
       assert_equal outcasted.attachment(:pdf).url, output[:url]
     end
 
+    it 'Sets multiple if field is the batch field and document is new' do
+      original = Outcasted.fields[:image]
+      outcasted = Outcasted.new
+      output = outcasted.outcast(:image, original, {input_name_prefix: 'data'})
+      assert output[:multiple]
+    end
+
+    it 'Does not set multiple if there is no batch field' do
+      original = OutcastedNoBatchField.fields[:image]
+      outcasted = OutcastedNoBatchField.new
+      output = outcasted.outcast(:image, original, {input_name_prefix: 'data'})
+      refute output[:multiple]
+    end
+
+    it 'Does not set multiple if document is not new' do
+      original = Outcasted.fields[:image]
+      outcasted = Outcasted.new
+      outcasted._is_new = false
+      output = outcasted.outcast(:image, original, {input_name_prefix: 'data'})
+      refute output[:multiple]
+    end
+
+    it 'Does not set multiple if field not the batch field' do
+      original = Outcasted.fields[:pdf]
+      outcasted = Outcasted.new
+      output = outcasted.outcast(:pdf, original, {input_name_prefix: 'data'})
+      refute output[:multiple]
+    end
+
   end
 
 end

data/test/test_document_schema.rb

@@ -6,6 +6,26 @@ describe PopulateMe::Document, 'Schema' do
 
   parallelize_me!
 
+  describe "Batch field" do
+
+    class BatchFieldSet < PopulateMe::Document
+      field :name
+      field :image
+      batch_on_field :image
+    end
+
+    class NotBatchFieldSet < PopulateMe::Document
+      field :name
+      field :image
+    end
+
+    it 'Sets batch field correctly' do
+      assert_equal :image, BatchFieldSet.batch_field
+      assert_nil NotBatchFieldSet.batch_field
+    end
+
+  end
+
   describe "Relationships" do
 
     class Relative < PopulateMe::Document

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: populate-me
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Mickael Riga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-07 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: web-utils
@@ -198,6 +198,7 @@ files:
 - lib/populate_me/admin/__assets__/css/asmselect.css
 - lib/populate_me/admin/__assets__/css/jquery-ui.min.css
 - lib/populate_me/admin/__assets__/css/main.css
+- lib/populate_me/admin/__assets__/img/favicon.png
 - lib/populate_me/admin/__assets__/img/file.png
 - lib/populate_me/admin/__assets__/img/help/children.png
 - lib/populate_me/admin/__assets__/img/help/create.png