populate-me 0.9.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1018ecfc599e93df910787d00774153225b3cd0712f4f457117e8fe24bd97367
-  data.tar.gz: d6f45771022d5941be410d368933881689bfb9c9c5fe6f6ab4e76ce84f07a6b9
+  metadata.gz: b2770ba89bcfa96ad56baafdf141c67891317044051f44b117a8e6b438f7c432
+  data.tar.gz: f076278f23d91e5c59c141b39698c34a9083c5861ba01f41a3692d587bc0b73b
 SHA512:
-  metadata.gz: d841176c180c4b9effb1b30d7a4e4643f4be01ad2854dfbd74fafffe0cd9dac7b1b7817d2e9e8810fa1ff5935418875abb0d4bff694e2fdb1497a54f37d65a4e
-  data.tar.gz: 24dcc0e7770a04db79eaa342bc290539a3f11feca74ef2fe42d7be51c62eaab85c6cfaef9ba939298a0650a01b7dc765f433aa2303562663d5061d7f74c0e8e9
+  metadata.gz: f952a4160015147d54bab9a504f189613521e33342561e95ae33710cb2c3929a9a9512a96d6b0ed2812571a3faa7c972f3b550556884e44c9c0cd7df19922ed0
+  data.tar.gz: cd10b6ec3d88432f6255803150c6c1b129b0ffab6a6736d92243238976cfbf295413ea5a1cd9251029edfd798cdead3ac98fcbf51cd3f415a0011702ada41c5b

data/lib/populate_me/admin.rb

@@ -62,10 +62,10 @@ class PopulateMe::Admin < Sinatra::Base
     end
     items = current_level.map do |l|
       href = l[1].is_a?(String) ? l[1] : "#{request.script_name}/menu#{levels.map{|level|'/'+level}.join}/#{slugify(l[0])}" 
-      { title: l[0], href: href }
+      { title: l[0], href: href, new_page: (not href.start_with?('/')) }
     end
     if request.path_info=='/menu'
-      items.push({title: '?', href: "#{request.script_name}/help"})
+      items.push({title: '?', href: "#{request.script_name}/help", new_page: false})
     end
     {
       template: 'template_menu',

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

@@ -140,10 +140,25 @@ button.admin-delete:focus, button.admin-delete-nested:focus, .handle-button:focu
   -ms-user-select: none;
   user-select: none;
 }
+.documents.grid {
+  width: 90%; width: 90vw;
+}
 .documents > li, .nested-documents > li {
   display: block;
   margin-bottom: 1em;
 }
+.documents.grid > li {
+  display: inline-block;
+  vertical-align: top;
+  width: 200px;
+  margin-right: 1em;
+}
+.documents.grid > li > a {
+  word-break: break-word;
+}
+.documents.grid > li img {
+  width: 200px;
+}
 .documents > li:hover, .nested-documents > li:hover {
   background-color: #eee8d5;
   outline: 0.5em solid #eee8d5;

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

@@ -195,6 +195,30 @@ PopulateMe.init_column = function(c) {
   // Init multiple select with asmSelect
   $('select[multiple]', c).asmSelect({ sortable: true, removeLabel: '×' });
 
+  // Select with preview
+  $('select:not([multiple])', c).change(function() {
+    var $this = $(this);
+    var container;
+    if ($this.data('preview-container')) {
+      container = $($this.data('preview-container'), c);
+    } else {
+      container = $this.next('.preview-container');
+    }
+    if (container.size() == 0) return;
+    var path = $this.find(':selected:first').data('preview');
+    if (path) {
+      var img = container.find('img:first');
+      if (img.size() < 1) {
+        img = $("<img src='' alt='Preview' title='Preview' width='250' />");
+        container.html(img);
+      }
+      img.attr('src', path);
+    } else {
+      container.html('');
+    }
+  });
+  $('option:selected[data-preview]').parent().change();
+
   // Polymorphic selector
   $('select.polymorphic_type_values').change(function() {
     var $this = $(this);

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

@@ -26,7 +26,7 @@
       <h1>{{page_title}}</h1>
       <ol class='menu'>
         {{#items}}
-          <li><a href="{{href}}" class='column-push' title='Open'>{{title}}</a></li>
+          <li><a href="{{href}}" {{#new_page}}target='_blank'{{/new_page}}{{^new_page}}class='column-push'{{/new_page}} title='Open'>{{title}}</a></li>
         {{/items}}
       </ol>
     </script>
@@ -46,7 +46,7 @@
         {{/is_polymorphic}}
         <a href="<%= request.script_name %>/form/{{dasherized_class_name}}{{#new_data}}?{{new_data}}{{/new_data}}" class='column-push new-document-btn' title='Create'>+</a>
       </p>
-      <ol class='documents' data-sort-field='{{sort_field}}' data-sort-url='<%= request.script_name %>/api/{{dasherized_class_name}}'>
+      <ol class='documents {{#grid_view}}grid{{/grid_view}}' data-sort-field='{{sort_field}}' data-sort-url='<%= request.script_name %>/api/{{dasherized_class_name}}'>
         {{#items}}{{#custom_partial_or_default}}template_document{{/custom_partial_or_default}}{{/items}}
       </ol>
     </script>
@@ -134,9 +134,10 @@
       {{/multiple}}
       <select name='{{input_name}}' {{#multiple}}multiple title='?'{{/multiple}}{{{build_input_attributes}}}>
         {{#select_options}}
-          <option value='{{value}}' {{#selected}}selected{{/selected}}>{{description}}</option>
+          <option value='{{value}}' {{#selected}}selected{{/selected}} {{#preview_uri}}data-preview='{{preview_uri}}'{{/preview_uri}}>{{description}}</option>
         {{/select_options}}
       </select>
+      <div class='preview-container'></div>
     </script>
 
     <script id="template-attachment-field" type="x-tmpl-mustache">

data/lib/populate_me/document_mixins/admin_adapter.rb

@@ -76,11 +76,16 @@ module PopulateMe
         end
 
         def admin_get id
+          return self.admin_get_multiple(id) if id.is_a?(Array)
           self.cast do
-            documents.find{|doc| doc[id_string_key]==id }
+            documents.find{|doc| doc[id_string_key] == id }
           end
         end
 
+        def admin_get_multiple ids, o={sort: nil}
+          self.admin_find(o.merge(query: {id_string_key => {'$in' => ids.uniq.compact}}))
+        end
+
         def admin_find o={}
           o[:query] ||= {}
           docs = self.cast{documents}.find_all do |d|
@@ -121,6 +126,7 @@ module PopulateMe
           end
           {
             template: 'template_list',
+            grid_view: self.settings[:grid_view]==true,
             page_title: self.to_s_short_plural,
             dasherized_class_name: WebUtils.dasherize_class_name(self.name),
             new_data: new_data,

data/lib/populate_me/document_mixins/schema.rb

@@ -160,13 +160,20 @@ module PopulateMe
 
         def to_select_options o={}
           proc do
-            items = self.admin_find(query: (o[:query]||{}), fields: [self.id_string_key, self.label_field])
+            items = self.admin_find({
+              query: (o[:query]||{}), 
+              fields: [self.id_string_key, self.label_field, self.admin_image_field].compact.uniq
+            })
             output = items.sort_by do |i|
               i.to_s.downcase
             end.map do |i|
-              [i.to_s, i.id]
+              item = { description: i.to_s, value: i.id }
+              unless self.admin_image_field.nil?
+                item.merge! preview_uri: i.admin_image_url
+              end
+              item
             end
-            output.unshift(['?','']) if o[:allow_empty]
+            output.unshift(description: '?', value: '') if o[:allow_empty]
             output
           end
         end

data/lib/populate_me/mongo.rb

@@ -6,17 +6,43 @@ module PopulateMe
   class MissingMongoDBError < StandardError; end
 
   class Mongo < Document
+    
+    self.settings.instance_eval do
+      def collection_name
+        puts 'yo'
+        if self[:collection_name].respond_to? :call
+          self[:collection_name].call
+        else
+          self[:collection_name]
+        end
+      end
+    end
 
     class << self
 
       def inherited sub 
         super
-        sub.set :collection_name, WebUtils.dasherize_class_name(sub.name)
+        # self.inherited is not useful anymore because we use ::collection_name 
+        # so that the class name exist when this is run.
+        # Which is not the case with dynamically created classes.
+        #
+        # But we'll keep it for legacy code in the meantime.
+        # Decide if we want to keep it.
+        #
+        # If statment is here for dynamically created classes,
+        # because Class.new.name==nil and then it breaks (see tests).
+        unless sub.name.nil?
+          sub.set :collection_name, WebUtils.dasherize_class_name(sub.name)
+        end
+      end
+
+      def collection_name
+        self.settings.collection_name || WebUtils.dasherize_class_name(self.name) 
       end
 
       def collection
         raise MissingMongoDBError, "Document class #{self.name} does not have a Mongo database." if settings.db.nil?
-        settings.db[settings.collection_name]
+        settings.db[self.collection_name]
       end
 
       def set_id_field
@@ -62,11 +88,19 @@ module PopulateMe
       end
 
       def admin_get theid
+        return self.admin_get_multiple(theid) if theid.is_a?(Array)
         theid = string_or_object_id theid
         self.cast{ collection.find({id_string_key => theid}).first }
       end
       alias_method :[], :admin_get
 
+      def admin_get_multiple theids, o={sort: nil}
+        theids = theids.uniq.compact.map{|theid| string_or_object_id(theid) }
+        self.admin_find(o.merge({
+          query: {id_string_key => {'$in' => theids} }
+        }))
+      end
+
       def admin_find o={}
         query = o.delete(:query) || {}
         o[:sort] ||= @current_sort

data/lib/populate_me/version.rb

@@ -1,4 +1,4 @@
 module PopulateMe
-  VERSION = '0.9.1'
+  VERSION = '0.12.0'
 end
 

data/populate-me.gemspec

@@ -29,6 +29,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rack-grid-serve', '~> 0.0.8'
   s.add_development_dependency 'aws-sdk-s3', '~> 1'
   s.add_development_dependency 'racksh', '~> 1.0'
-  s.add_development_dependency 'rake', '~> 10.1'
+  s.add_development_dependency 'rake', '>= 12.3.3'
 end
 

data/test/test_admin.rb

@@ -124,6 +124,10 @@ describe PopulateMe::Admin do
 
   describe 'Handlers' do
 
+    let(:help_item) {
+      { 'title' => '?', 'href' => '/help', 'new_page' => false }
+    }
+
     describe '/menu' do
 
       describe 'when url is root' do
@@ -133,18 +137,22 @@ describe PopulateMe::Admin do
           assert_json last_response
           assert_for_view json, 'template_menu', 'Menu'
           expected_h = {
-            'title'=> 'Home Details', 'href'=> '/admin/form/home-details/0'
+            'title' => 'Home Details', 
+            'href' => '/admin/form/home-details/0', 
+            'new_page' => false
           }
           assert_equal expected_h, json['items'][0]
           expected_h = {
-            'title'=> 'Project Page', 'href'=> '/menu/project-page'
+            'title' => 'Project Page', 
+            'href' => '/menu/project-page',
+            'new_page' => false
           }
           assert_equal expected_h, json['items'][1]
         end
         it 'Adds help link' do
           get '/menu'
           assert_equal 3, json['items'].size
-          assert_equal({'title'=>'?', 'href'=>'/help'}, json['items'].last)
+          assert_equal(help_item, json['items'].last)
         end
       end
       describe 'when url is nested' do
@@ -155,13 +163,15 @@ describe PopulateMe::Admin do
           assert_for_view json, 'template_menu', 'Checks'
           assert_equal 2, json['items'].size
           expected_h = {
-            'title'=> 'Check 1', 'href'=> '/check/1'
+            'title' => 'Check 1', 
+            'href' => '/check/1', 
+            'new_page' => false
           }
           assert_equal expected_h, json['items'][0]
         end
         it 'Does not add help link' do
           get '/menu/project-page/checks'
-          refute_equal({'title'=>'?', 'href'=>'/help'}, json['items'].last)
+          refute_equal(help_item, json['items'].last)
         end
       end
 

data/test/test_document_outcasting.rb

@@ -11,6 +11,11 @@ class Outcasted < PopulateMe::Document
     {description: 'medium', value: 'm'},
     {description: 'large', value: 'l'}
   ]
+  field :availability, type: :select, select_options: [
+    {description: 'Available', value: 'yes', preview_uri: 'http://www.example.org/yes.jpg' },
+    {description: 'On offer', value: 'almost', preview_uri: 'http://www.example.org/almost.jpg' },
+    {description: 'Sold', value: 'no', preview_uri: 'http://www.example.org/no.jpg' }
+  ]
   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
@@ -98,6 +103,17 @@ describe PopulateMe::Document, 'Outcasting' do
       formated_options?(original, output)
     end
 
+    it 'Can have more fields when they are already formated' do
+      # Mainly for adding a preview_uri but also future tweaks
+      original = Outcasted.fields[:availability]
+      output = Outcasted.new.outcast(:availability, original, {input_name_prefix: 'data'})
+      assert(output[:select_options].all?{|o| o.key?(:preview_uri)})
+      last = output[:select_options].last
+      assert_equal 'Sold', last[:description]
+      assert_equal 'no', last[:value]
+      assert_equal 'http://www.example.org/no.jpg', last[:preview_uri]
+    end
+
     it 'Formats the options when it is a 2 strings array' do
       original = Outcasted.fields[:size].dup
       original[:select_options] = [

data/test/test_document_schema.rb

@@ -85,12 +85,22 @@ describe PopulateMe::Document, 'Schema' do
       label :slug
     end
 
+    class Selectpreviewable < PopulateMe::Document
+      set :default_attachment_class, PopulateMe::Attachment
+      field :name
+      field :img, type: :attachment, variations: [
+        PopulateMe::Variation.default
+      ]
+    end
+
     before do
       Selectoptionable.documents = []
       Selectoptionable.new(id: '1', name: 'Joe', slug: 'joe').save
       Selectoptionable.new(id: '2', name: 'William', slug: 'william').save
       Selectoptionable.new(id: '3', name: 'Jack', slug: 'jack').save
       Selectoptionable.new(id: '4', name: 'Averell', slug: 'averell').save
+      Selectpreviewable.documents = []
+      Selectpreviewable.new(id: '1', name: 'Project', img: 'project.jpg').save
     end
 
     after do
@@ -102,19 +112,27 @@ describe PopulateMe::Document, 'Schema' do
       assert output_proc.is_a?(Proc)
       output = output_proc.call
       assert_equal 4, output.size
-      assert output.all?{|o| o.is_a?(Array) and o.size==2}
-      assert_equal '1', output.find{|o|o[0]=='joe'}[1]
+      assert output.all?{|o| o.is_a?(Hash) and o.size==2}
+      assert_equal '1', output.find{|o|o.fetch(:description)=='joe'}.fetch(:value)
     end
 
     it 'Puts items in alphabetical order of their label' do
       output= Selectoptionable.to_select_options.call
-      assert_equal ['averell', '4'], output[0]
+      assert_equal({description: 'averell', value: '4'}, output[0])
     end
 
     it 'Has an option for prepending empty choice' do
       output= Selectoptionable.to_select_options(allow_empty: true).call
-      assert_equal ['?', ''], output[0]
-      assert_equal ['averell', '4'], output[1]
+      assert_equal({description: '?', value: ''}, output[0])
+      assert_equal({description: 'averell', value: '4'}, output[1])
+    end
+
+    it 'Adds a :preview_uri when there is a thumbnail' do
+      output= Selectpreviewable.to_select_options.call
+      assert output[0].key?(:preview_uri)
+      assert_equal 'Project', output[0][:description]
+      assert_equal '1', output[0][:value]
+      assert_equal '/attachment/selectpreviewable/project.populate_me_thumb.jpg', output[0][:preview_uri]
     end
 
   end

data/test/test_mongo.rb

@@ -65,14 +65,21 @@ describe 'PopulateMe::Mongo' do
     end
 
     it 'Should set DB collection to dasherized full class name by default' do 
-      assert_equal "cat-fish", CatFish.settings.collection_name
-      assert_equal "paradise--cat-fish", Paradise::CatFish.settings.collection_name
+      assert_equal "cat-fish", CatFish.collection_name
+      assert_equal "paradise--cat-fish", Paradise::CatFish.collection_name
     end
 
     it 'Finds collection in DB' do 
       assert_equal DB['cat-fish'].name, CatFish.collection.name
     end
 
+    it 'Should set DB and collection name even for dynamically created classes' do
+      # Happens when an included module automatically happens a class.
+      # e.g. Slides for a Slideshow
+      CatFish.const_set("Item", Class.new(CatFish.superclass))
+      assert_equal "cat-fish--item", CatFish::Item.collection.name
+    end
+
   end
 
   describe 'Low level CRUD' do 
@@ -119,6 +126,19 @@ describe 'PopulateMe::Mongo' do
       assert_equal "regular", LowFish.admin_get(regular_fish_id).name
     end
 
+    it "Should get multiple items" do
+      # Order is not respected
+      alpha_id = LowFish.new(name: "alpha").perform_create
+      beta_id = LowFish.new(name: "beta").perform_create
+      gamma_id = LowFish.new(name: "gamma").perform_create
+      items = LowFish.admin_get([alpha_id, beta_id, nil, alpha_id])
+      assert items.is_a?(Array)
+      assert_equal 2, items.count
+      refute_nil items.find{|i| i.id == alpha_id}
+      refute_nil items.find{|i| i.id == beta_id}
+      assert_nil items.find{|i| i.id == gamma_id}
+    end
+
     it 'Should have the [] shortcut for admin_get' do
       LowFish.collection.insert_one(_id: 42, name: "H2G2")
       assert_equal LowFish[42], LowFish.admin_get(42)
@@ -131,7 +151,7 @@ describe 'PopulateMe::Mongo' do
       LowFish.collection.insert_one(_id: 40, name: "Bran")
       items = LowFish.admin_find
       assert items.is_a?(Array)
-      assert 4, items.count
+      assert_equal 4, items.count
       assert_equal 10, items[0].id
       items = LowFish.admin_find query: {name: 'Bran'}
       assert items.is_a?(Array)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: populate-me
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Mickael Riga
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: web-utils
@@ -168,16 +168,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 12.3.3
 description: PopulateMe is an admin system for managing structured content of web
   applications. It is built on top of the Sinatra framework, but can be used along
   any framework using Rack.
@@ -256,7 +256,7 @@ homepage: https://github.com/mig-hub/populate-me
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -271,8 +271,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: PopulateMe is an admin system for web applications.
 test_files: