populate-me 0.8.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c47e2bdae6fcc97d34ec729a23107c4d7af9069d
-  data.tar.gz: 60b764c3d31de7c5c5853a1d2eec72af7404e80e
+SHA256:
+  metadata.gz: 87883ab18f9a959d6daf5cad99481133789cff2885c591fb40f949706d107791
+  data.tar.gz: c8940abefcdc04241dccd0e27eef54f8685c45b57e5e6ea5eeb32392657dcf0d
 SHA512:
-  metadata.gz: 563cb8b28cce6d5364b0e7588b2feaadeb472facec7127de93d14b7a64a34b81a17e66b7d819bceee5f7f785b40cbc7e205ec213817532612295b2bbade91f99
-  data.tar.gz: cf7f5c53a887d2cee9b64aee30f85125588fe8f16cdf2edd358acf05eb6f39f12e0113c3e5759b951d9b96b10f8a60b18b00d659f500e914af6d93cc38493e5f
+  metadata.gz: 5355320979fd0a372e4b9ce52fd02a1de06d7fb2ca5308f863c18ce649e5f16cf21c4e9f0f2553165fdbece27dc08fbab5e5549381755c1fcf8cba7dc2d5dd5e
+  data.tar.gz: 50bb43b8ff626e5d3a1232bc46f44f19ec126e23f3ceb3150d88ad1bdef3b7ea1cd19fc69ea1735c3920a741ffb80a11405ebf059c59a0ecbba8f2f83c2e7f64

data/README.md

@@ -190,8 +190,8 @@ a method instead of a block.
 
 The list of hooks is quite common but here it is as a reminder:
 
-- `before :validation`
-- `after :validation`
+- `before :validate`
+- `after :validate`
 - `before :create`
 - `after :create`
 - `before :update`

data/example/config.ru

@@ -36,6 +36,8 @@ class BlogPost < PopulateMe::Document
   field :content, type: :text
   field :authors, type: :list
   field :published, type: :boolean
+  field :date_now, type: :date, input_attributes: {type: :date}
+  field :datetime_now, type: :datetime, input_attributes: {type: :datetime}
   relationship :comments
   def validate
     error_on(:content,'Cannot be blank') if WebUtils.blank?(self.content)

data/lib/populate_me/admin.rb

@@ -25,10 +25,16 @@ class PopulateMe::Admin < Sinatra::Base
   # Load API helpers
   helpers PopulateMe::API::Helpers
   helpers do
+
     def user_name
       return 'Anonymous' if session.nil?||session[:populate_me_user].nil?
       session[:populate_me_user]
     end
+
+    def help_img desc, filename
+      "<img src='#{request.script_name}/__assets__/img/help/#{filename}' alt='#{desc}' />"
+    end
+
   end
 
   # Make all templates in admin/views accessible with their basename
@@ -56,7 +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", new_page: false})
     end
     {
       template: 'template_menu',
@@ -86,6 +95,11 @@ class PopulateMe::Admin < Sinatra::Base
     ).to_json
   end
 
+  get '/help' do
+    content_type :html
+    erb :help, layout: false
+  end
+
   not_found do
     response.headers['X-Cascade'] = 'pass'
     {'success'=>false,'message'=>'Not Found'}.to_json

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

@@ -31,13 +31,38 @@ body {
   margin-right: 20px;
 }
 
-.column > h1 {
+.column > h1,
+.column > .text-page h1 {
   font-size: 1.5em;
   font-weight: normal;
   margin-top: 1em;
   margin-bottom: 1.5em;
 }
 
+.column > .text-page {
+  padding: 0 20px 20px 20px;
+  overflow: hidden;
+  width: 50%; width: 50vw;
+  max-width: 600px;
+  background-color: #ffffff;
+}
+.column > .text-page h2 {
+  font-size: 1.5em;
+}
+.column > .text-page img {
+  width: 100%;
+}
+.column > .text-page a {
+  color: #268bd2;
+}
+.column > .text-page a:hover {
+  text-decoration: underline;
+}
+.column > .text-page .frame {
+  padding: 1em;
+  border: 1px solid #002b36;
+}
+
 ol {
   list-style: none;
   margin: 0;
@@ -115,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

@@ -202,6 +202,12 @@ PopulateMe.init_column = function(c) {
     link.attr('href', PopulateMe.update_query_parameter(link.attr('href'), 'data[polymorphic_type]', $this.val()));
   }).change();
 
+  // Warning when date input not supported
+  var dateFields = $('[type="date"]', c);
+  if ( dateFields.size()>0 && dateFields.prop('type') != 'date' ) {
+    alert('Your browser does not support date fields. You will have to enter dates manually. If you want a better experience and have a date picker, use a modern browser like Chrome.');
+  }
+
   // Possible callback from custom javascript file.
   // If you need to do something on init_column,
   // create this callback.

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

@@ -0,0 +1,94 @@
+<div class='text-page'>
+
+<h1>Help</h1>
+
+<h2>Overview</h2>
+
+<p>The screen is divided in columns and expands on the right as you go further down the hierarchy, a little bit like a file explorer. </p>
+
+<%= help_img 'Overview', 'overview.png' %>
+
+<p>The very first column displays your login name (e.g. admin). At the bottom you have a "Logout" button so that you can securely finish your working session.</p>
+
+<%= help_img 'Logout', 'logout.png' %>
+
+<p>And then the second column is your starting point which represents as close as possible the sections of your website.</p>
+
+<%= help_img 'Menu', 'menu.png' %>
+
+<p>The item you've selected is always blue in order to show you the path you've been through, again like a file explorer.</p>
+
+<%= help_img 'Subist', 'sublist.png' %>
+
+<h2>List pages</h2>
+
+<p>When you have reached a column like the last one on this image, it is a list page.</p>
+
+<%= help_img 'List', 'list.png' %>
+
+<p>This can be a list of blog articles, a list of images or a list of contact details. The presentation will always be similar. You will see a relevant title, a relevant image (if there is one), and buttons for actions.If you click the title of the item you'll be able to edit the information of this item.</p>
+
+<%= help_img 'Edit', 'edit.png' %>
+
+<p>The "delete" button allows you to delete the item.</p>
+
+<%= help_img 'Delete', 'delete.png' %>
+
+<p>While being irreversible and potentially dangerous, the Bureau will warn you and give you the opportunity to cancel before proceeding.</p>
+
+<p>When you rollover the top of the item, your cursor will turn into a hand which is a clue that you can re-order the items by drag-and-drop.</p>
+
+<%= help_img 'Sort', 'sort.png' %>
+
+<p>Sometimes this hand does not appear, it means that the items cannot be sorted manually, generally because they are sorted automatically, alphabetically or by date for example.</p>
+
+<p>When you want to create a new item, you can click the "plus" button.</p>
+
+<%= help_img 'Create', 'create.png' %>
+
+<p>Items will sometimes have other items attached to them. For example a blog article can have a list of images or an artist can have a list of social medias. These are called relationships.</p>
+
+<p>When this is the case, you will have links for each relationship at the bottom of the items and when you click on them, the system will bring you to another list column which follows the same structure.</p>
+
+<%= help_img 'Children', 'children.png' %>
+
+<h2>Form</h2>
+
+<p>Once you get to finally edit or create something, the page will be a form like the example below.</p>
+
+<%= help_img 'Form', 'form.png' %>
+
+<p>This page will probably be quite familiar to you. Field names within forms are meant to be as explicit as possible. For example they also include ideal image dimensions.</p>
+
+<p>Press "Save"/"Update" when you are finished editing the item.</p>
+
+<%= help_img 'Save', 'save.png' %>
+
+<h2>Image specifications</h2>
+
+<p>All images on the website should be exported for web in one of the following formats:</p>
+
+<p>&mdash; Jpeg<br/>&mdash; PNG (if it requires transparancy)<br/>&mdash; SVG (for logos and anything vector-based)<br/>&mdash; Gif (not recommended unless a short animation is required)</p>
+
+<p>You will not be able to upload images above a predifined maximum, usually 1MB. Typically most images saved for web can be compressed down to a file size between 150KB and 500KB.</p>
+
+<h2>Text formating</h2>
+
+<p>On most text fields, you can add links or make text bold or italic with a simple markup called <a href='https://en.wikipedia.org/wiki/Markdown' target='_blank'>markdown</a>. Here is an example of what you can do:</p>
+
+<div class='frame'>
+<p>Markdown is good for *making things look italic* or **making things look bold**. Your can also create links [like this which links to Google](https://www.google.com). Although if you write a URL or an email address, you don't have to do anything because it will be turned into a link automatically anyway.</p> 
+</div>
+
+<p>Which will be rendered like this:</p>
+
+<div class='frame'>
+  <p>Markdown is good for <em>making things look italic</em> or <strong>making things look bold</strong>. Your can also create links <a href="https://www.google.com" target='_blank'>like this which links to Google</a>. Although if you write a URL or an email address, you don't have to do anything because it will be turned into a link automatically anyway.</p> 
+</div>
+
+<p><em>*Surrounding with stars makes text italic*</em><br><strong>**Surrounding text with double stars makes it bold**</strong><br>Links look like: [<a href='javascript:void(0);'>text to link</a>](http://website.com)</p>
+
+<p>It should be self explanatory but you can do much more with markdown. If you are interrested, we encourage you to read the <a href='https://daringfireball.net/projects/markdown/syntax' target='_blank'>full documentation</a>.</p>
+
+</div>
+

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>

data/lib/populate_me/document_mixins/admin_adapter.rb

@@ -121,6 +121,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/typecasting.rb

@@ -38,6 +38,8 @@ module PopulateMe
       def typecast_date k, v
         if v[/\d\d(\/|-)\d\d(\/|-)\d\d\d\d/]
           Date.parse v
+        elsif v[/\d\d\d\d(\/|-)\d\d(\/|-)\d\d/]
+          Date.parse v
         else
           nil
         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

data/lib/populate_me/version.rb

@@ -1,4 +1,4 @@
 module PopulateMe
-  VERSION = '0.8.0'
+  VERSION = '0.10.1'
 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

@@ -132,11 +132,19 @@ describe PopulateMe::Admin do
           assert_predicate last_response, :ok?
           assert_json last_response
           assert_for_view json, 'template_menu', 'Menu'
-          assert_equal 2, json['items'].size
           expected_h = {
             'title'=> 'Home Details', 'href'=> '/admin/form/home-details/0'
           }
           assert_equal expected_h, json['items'][0]
+          expected_h = {
+            'title'=> 'Project Page', 'href'=> '/menu/project-page'
+          }
+          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)
         end
       end
       describe 'when url is nested' do
@@ -151,6 +159,10 @@ describe PopulateMe::Admin do
           }
           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)
+        end
       end
 
     end

data/test/test_document_typecasting.rb

@@ -98,10 +98,8 @@ describe PopulateMe::Document, 'Typecasting' do
     it "Parses the date with Date.parse" do
       assert_equal Date.parse('10/11/1979'), subject.typecast(:dob,'10/11/1979')
     end
-    describe "Delimiter is a dash" do
-      it "Replaces them with forward slash before parsing" do
-        assert_equal Date.parse('10/11/1979'), subject.typecast(:dob,'10-11-1979')
-      end
+    it "Works with yyyy-mm-dd date html input format" do
+      assert_equal Date.parse('10/11/1979'), subject.typecast(:dob,'1979-11-10')
     end
     describe "Value is malformed" do
       it "Returns nil" do

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 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: populate-me
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Mickael Riga
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2020-06-08 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.
@@ -198,12 +198,26 @@ 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/help/children.png
+- lib/populate_me/admin/__assets__/img/help/create.png
+- lib/populate_me/admin/__assets__/img/help/delete.png
+- lib/populate_me/admin/__assets__/img/help/edit.png
+- lib/populate_me/admin/__assets__/img/help/form.png
+- lib/populate_me/admin/__assets__/img/help/list.png
+- lib/populate_me/admin/__assets__/img/help/login.png
+- lib/populate_me/admin/__assets__/img/help/logout.png
+- lib/populate_me/admin/__assets__/img/help/menu.png
+- lib/populate_me/admin/__assets__/img/help/overview.png
+- lib/populate_me/admin/__assets__/img/help/save.png
+- lib/populate_me/admin/__assets__/img/help/sort.png
+- lib/populate_me/admin/__assets__/img/help/sublist.png
 - lib/populate_me/admin/__assets__/js/asmselect.js
 - lib/populate_me/admin/__assets__/js/columnav.js
 - lib/populate_me/admin/__assets__/js/jquery-ui.min.js
 - lib/populate_me/admin/__assets__/js/main.js
 - lib/populate_me/admin/__assets__/js/mustache.js
 - lib/populate_me/admin/__assets__/js/sortable.js
+- lib/populate_me/admin/views/help.erb
 - lib/populate_me/admin/views/page.erb
 - lib/populate_me/api.rb
 - lib/populate_me/attachment.rb
@@ -242,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
@@ -257,9 +271,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: PopulateMe is an admin system for web applications.
 test_files: