elabs 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 179fc820588cdbe7ae3de5e0c42a37a678fab8e0e190a173426e493302f23556
-  data.tar.gz: 7e720b16441c9044c6e9489f71a32b95e1e392e9d8ffb4de25ab3916d113c482
+  metadata.gz: 75bab8c8f62a2628529aab8f110eacd5fc1408bc94a7f595e7174f20028e715b
+  data.tar.gz: 1ba31dd537c39379523ae34aa4ed95b0557469d712af34b2d8ce422a75b51e32
 SHA512:
-  metadata.gz: 9983023566a96ad10c252882c4b05c68c719bb477127b6361f5364b70ff6359f9e35c59158f522ab6f24b9b554da544a319241e4281cb4d1dc1673bea0e25b79
-  data.tar.gz: 8f2474412043a4f25ac5277ef001b3b8ea06974da8500c4328de52839c3986416923cf70c250829388cbd600a15c111f033c89c4fcd0450daae8f31d8ee1e0d7
+  metadata.gz: 3eb92ccbf84c2a6c94c58cf7edc5c431fa46a6108233d60dd989771a5818a8a4ac1f3fda7d94960302861e9ebf21ddd03a848b1cc201516b0a3fd8ed7d5d396e
+  data.tar.gz: 04e89c6f2a90bef67578927f80087438f48f903e2263bdeadc43bceaf8bcdf9e7faaf5346f8803ae01572838fbb6c31cd1129304542a35e38c9b2ffc89f5e07b

data/CHANGELOG.md

@@ -1,6 +1,90 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [4.0.0] - 2018-10-11 - RSS, slugs ans shortcodes
+### Added
+
+  - RSS feeds for content and activity
+  - Added `sources_url` and `docs_url` fields in projects
+  - Support for shortcodes:
+    - In Elabs:
+        - `[<content>:<id>]` displays a link with an icon to the specified
+          content,
+        - `[<content>-card:<id>]` displays a card of the specified content
+        - `[user:<id>]`, `[user-card:<id>]` displays link with icon or a card
+          for the specified user
+    - Gitlab instances (_Only https, public data are handled for now.)_:
+        - `[gitlab-repo:<url>]`, will display a link with an icon to the
+          repository
+        - `[gitlab-repo-card:<url>]` displays a card for a repository
+        - `[gitlab-user-card:<url>]` displays a card for a gitlab user
+        - `[gitlab-group-card:<url>]` displays a card for a gitlab user
+    - Github:
+      - `[github-repo:<username/repo>]`, displays a link with an icon
+        to the repository
+      - `[github-repo-card:<username/repo>]` displays a card for a
+        repository
+      - `[github-user-card:<username>]` displays a card for a github user
+  - Added a `with_format` helper method to render a partial of a different
+    format in a view (i.e.: `with_format(:html){ markdown 'content' }` in
+    a json view.
+  - Added a `colored_good_or_bad_icon_tag` that colors the icon depending on
+    its value.
+  - Added classes for text based on the list of color variant.
+    `is-<variant>` colors the text with the background-color defined in
+    `$variants-list`
+  - Added ability to save content specifying a reason for the edition.
+    This reason will be saved in the corresponding act.
+  - Added ability to save content specifying the modification as "minor".
+    No act will be created in this case.
+  - Slug support added. This **is a breaking change** as it will change all
+    the links in the site. The following entities are now slugged:
+    - languages/licenses/tags/users classifiers and their nested
+      resources (i.e: `/languages/en/projects`)
+    - albums/articles/notes/projects/uploads and projects nested resources
+  - Customized datetime formats were added. Sadly, it' in yml files
+    located in `config/locales/<lng>.yml` until we can export this to
+    gettext.
+
+### Changed
+
+  - Markdown is now rendered with gem `commonmarker`. Markdown-it has
+    been removed, so content previews are done with an ajax request
+  - `boolean_icon_tag()` now takes two additional parameters:
+    - `false_class`: additional CSS class when value is `false`. Default is `nil`
+    - `true_class`: additional CSS class when value is `true`. Default is `nil`
+
+### Improved
+
+  - `Elabs::ActsHelper.act_notice_string` now have a second parameter,
+    `include_link`. Default is `true`; set it to false to generate
+    activity notice strings without link in it.
+  - Admin/member indexes: disabled "Show online" links when content is
+    not publicly visible.
+  - Improved thumbnails generation methods with a new
+    `thumbnail_center_crop(document, size)` which will return
+    the URL for processed document.
+  - Avatar and thumbnails possible dimensions are now
+    `THUMBNAILS_DIMENSIONS` and `AVATAR_DIMENSIONS` module constants.
+  - User cards are now larger and content is condensed on one line.
+  - Member and admin indexes now have colored status icons
+  - Visual enhancements:
+    - rendered content have more space between sections; titles are more
+      contrasted
+    - cards are more contrasted
+    - actions zones in forms are now standing out
+    - tabs for related content now have the count of related items in them
+    - `.field` classes now have a top margin, resulting in more airy forms
+  - `short_date` helper method now displays a ... date.
+  - `medium_datetime` helper method has been created to display a short
+    datetime with the year in it.
+
+### Removed
+
+### Fixed
+
+  - The permalink icon was missing on notes cards
+
 ## [3.0.0] - 2018-09-17 - Notifications and avatars
 ### Added
 
@@ -24,6 +108,9 @@ All notable changes to this project will be documented in this file.
 
   - Misc:
     - Date helper: new `short_date(date)` method
+    - Registrations can be closed by changing the `Elabs::users_can_register`
+      variable. All it does is to basically prevent `:registerable` in the
+      user model.
 
 ### Changed
 
@@ -38,6 +125,8 @@ All notable changes to this project will be documented in this file.
     `current_lock_action` and `current_update_action` to the
     `ContentEntity` concern, as they are now shared between "actable"
     and "notifiable" concerns
+  - `rails g elabs:install` now creates an user model template with devise
+    configured with conditional behavior.
 
 ### Improved
 

data/Gemfile

@@ -24,10 +24,10 @@ group :development, :test do
   gem 'pg'
   # Rails and plugins:
   gem 'active_link_to'
+  gem 'commonmarker'
   gem 'devise'
   gem 'haml-rails'
   gem 'kaminari'
-  # gem 'rails', '~> 5.2.1'
   gem 'sass-rails', '~> 5.0'
   # Translations
   gem 'gettext_i18n_rails'

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    elabs (3.0.0)
+    elabs (4.0.0)
       rails (~> 5.2.1)
 
 GEM
@@ -86,6 +86,8 @@ GEM
     chromedriver-helper (1.2.0)
       archive-zip (~> 0.10)
       nokogiri (~> 1.8)
+    commonmarker (0.17.13)
+      ruby-enum (~> 0.5)
     concurrent-ruby (1.0.5)
     crass (1.0.4)
     cucumber (3.1.2)
@@ -189,7 +191,7 @@ GEM
       nokogiri (>= 1.5.9)
     mail (2.7.0)
       mini_mime (>= 0.1.1)
-    marcel (0.3.2)
+    marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (0.9.0)
     mime-types (3.2.2)
@@ -281,6 +283,8 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-enum (0.7.2)
+      i18n
     ruby-progressbar (1.10.0)
     ruby_dep (1.5.0)
     ruby_parser (3.11.0)
@@ -350,6 +354,7 @@ DEPENDENCIES
   capybara (>= 2.15, < 4.0)
   capybara-screenshot
   chromedriver-helper
+  commonmarker
   cucumber-rails
   database_cleaner
   devise

data/README.md

@@ -1,34 +1,41 @@
 # README
+
 Rails engine adding CMS features to publish content related to projects.
 An online version can be tested on http://next.experimentslabs.com
+
 ## Features
 
 Manage various content types:
-  - Articles
-  - Notes
-  - Files
-  - Albums (files collections)
-  - Projects (may have everything above attached to them)
+
+- Articles
+- Notes
+- Files
+- Albums (files collections)
+- Projects (may have everything above attached to them)
 
 Classify content:
-  - Tags
-  - Language
-  - Licenses
+
+- Tags
+- Language
+- Licenses
 
 Generic features:
-  - Comments (only visible to author)
-  - Safe/not safe for work content flags
-  - Content reporting
-  - Site structure translations
 
-Features wishlist: check the [roadmap](ROADMAP.md#wonderland) to see
-what's coming.
+- Comments (only visible to author)
+- Safe/not safe for work content flags
+- Content reporting
+- Site structure translations
 
-## Known issues:
-JSON views are not created yet. They exists but were created using
-scaffolding and never touched again.
+Features wishlist: check the [roadmap](ROADMAP.md#wonderland) to see what's coming.
+
+## Status
+
+Elabs engine is not production ready. If the core feature are working,
+a lot of changes and improvements are still coming in. Use it in production
+only if you don't mind to update often.
 
 ## Documentation:
+
 - [Setup guide](docs/setup.md)
 - [Sample app](https://gitlab.com/experimentslabs/sample_app)
 - [How to override the app](docs/overriding.md)

data/ROADMAP.md

@@ -19,11 +19,11 @@ See the [issues](https://gitlab.com/experimentslabs/website/website/issues) for
 
 Note that the elements in this list may change during development; it' a
 general idea of what will be done next.
-  - [4.0.0] - Urls table to attach urls to content, share favorites
-  - [5.0.0] - Teams to attach user and distant people to projects
-  - [6.0.0] - Projects: commits aggregation
-  - [7.0.0] - Users: service status aggregation without storage for now
-  - [8.0.0] - Raw content for everything
+  - [5.0.0] - Urls table to attach urls to content, share favorites
+  - [6.0.0] - Teams to attach user and distant people to projects
+  - [7.0.0] - Projects: commits aggregation
+  - [8.0.0] - Users: service status aggregation without storage for now
+  - [9.0.0] - Raw content for everything
 
 ## Wonderland
   - ~~Rails engine~~ (since 2.0.0)
@@ -36,8 +36,9 @@ general idea of what will be done next.
   - Projects users
   - Urls management (lists of URLs, favorites, sources,...)
   - Content: code snippets
-  - Content references (reference others work in your own work)
-  - Better license support (i.e.: html tags for creative commons license)
+  - ~~Content references (reference others work in your own work)~~
+    (since 4.0.0, with shortcodes)
+  - Better license support (i.e.: html tags for creative commons licenses)
   - Widgets (to add custom content in created content)
   - Data aggregation from various VCS providers
   - Data aggregation for users profiles from various providers

data/app/assets/javascripts/elabs/application.js.erb

@@ -0,0 +1,42 @@
+"use strict";
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+<%
+require_asset 'rails-ujs'
+require_asset 'activestorage'
+# Node_modules files
+require_asset 'codemirror-5.39.2/lib/codemirror.js'
+require_asset 'codemirror-5.39.2/addon/mode/overlay.js'
+require_asset 'codemirror-5.39.2/mode/xml/xml.js'
+require_asset 'codemirror-5.39.2/mode/markdown/markdown.js'
+require_asset 'codemirror-5.39.2/mode/javascript/javascript.js'
+require_asset 'codemirror-5.39.2/mode/css/css.js'
+require_asset 'codemirror-5.39.2/mode/htmlmixed/htmlmixed.js'
+require_asset 'codemirror-5.39.2/mode/clike/clike.js'
+require_asset 'codemirror-5.39.2/mode/meta.js'
+require_asset 'codemirror-5.39.2/mode/gfm/gfm.js'
+require_asset 'highlight.js-9.12.0/highlight.pack.js'
+if Rails.env.development?
+    require_asset "vue/dist/vue"
+else
+    require_asset "vue/dist/vue.min"
+end
+# Current folder files
+require_asset './forms'
+require_asset './helpers'
+require_asset './helpers-codemirror'
+require_asset './helpers-markdown'
+require_asset './hljs'
+require_asset './modals'
+require_asset './tabs'
+%>

data/app/assets/javascripts/elabs/forms.js

@@ -0,0 +1,10 @@
+// eslint-disable-next-line no-unused-vars
+function toggleUpdateMessageField (event, element) {
+  var checked = event.target.checked
+  console.log(event, element, checked)
+  if (checked) {
+    document.getElementById(element).setAttribute('disabled', 'disabled')
+  } else {
+    document.getElementById(element).removeAttribute('disabled')
+  }
+}

data/app/assets/javascripts/elabs/helpers-markdown.js

@@ -1,42 +1,20 @@
 // eslint-disable-next-line no-unused-vars
 function createMDPreviewer (cmInstance) {
-  var md = window.markdownit()
-
   return function (event) {
     event.preventDefault()
+    var targetElement = document.getElementById('content-description-preview')
+    var data = new FormData()
+    data.append('text', cmInstance.getValue())
 
-    document.getElementById('content-description-preview').innerHTML = md.render(cmInstance.getValue())
+    // eslint-disable-next-line no-undef
+    ajax('POST', '/member/markdown_previewer', data, function (request) {
+      targetElement.innerHTML = JSON.parse(request.responseText).html_content
+    }, function () {
+      targetElement.innerHTML = 'Something bad happened on our side. Sorry for that...'
+    }, function () {
+      targetElement.innerHTML = 'Something bad happened on our side. Sorry for that...'
+    })
 
     openModal('content-preview-modal')
   }
 }
-
-/*
- * @author Wladimir Palant
- * @source https://stackoverflow.com/questions/1912501/unescape-html-entities-in-javascript/34064434#34064434
- */
-function htmlDecode (input) {
-  if (typeof DOMParser !== 'function') { return input }
-  var doc = new DOMParser().parseFromString(input, 'text/html')
-  return doc.documentElement.textContent
-}
-
-// eslint-disable-next-line no-unused-vars
-function renderMdFromId (areaId) {
-  var md = window.markdownit({
-    highlight: function (str, lang) {
-      // Unescape some chars
-      str = htmlDecode(str)
-      if (lang && hljs.getLanguage(lang)) {
-        try {
-          return hljs.highlight(lang, str).value
-        } catch (__) {}
-      }
-
-      return '' // use external default escaping
-    }
-  })
-  var value = document.getElementById('raw-' + areaId).innerHTML
-
-  document.getElementById('markdown-' + areaId).innerHTML = md.render(value)
-}

data/app/assets/javascripts/elabs/helpers.js

@@ -15,3 +15,31 @@ function addClass (element, className) {
     element.className += ' ' + className
   }
 }
+
+// eslint-disable-next-line no-unused-vars
+function documentReady (fn) {
+  if (document.attachEvent ? document.readyState === 'complete' : document.readyState !== 'loading') {
+    fn()
+  } else {
+    document.addEventListener('DOMContentLoaded', fn)
+  }
+}
+
+// eslint-disable-next-line no-unused-vars
+function ajax (method, url, data, success, failure, error) {
+  var request = new XMLHttpRequest()
+  request.open(method, url, true)
+  request.setRequestHeader('Accept', 'application/json')
+
+  request.onload = function () {
+    if (request.status >= 200 && request.status < 400) {
+      if (typeof success === 'function') success(request)
+    } else {
+      if (typeof failure === 'function') failure(request)
+    }
+  }
+  request.onerror = function () {
+    if (typeof error === 'function') error(request)
+  }
+  request.send(data)
+}

data/app/assets/javascripts/elabs/hljs.js

@@ -0,0 +1,4 @@
+// eslint-disable-next-line no-undef
+documentReady(function () {
+  hljs.initHighlighting()
+})

data/app/assets/stylesheets/elabs/_colors.scss

@@ -313,6 +313,11 @@ $color-background-base: $color-grey-200;
 $color-inverse: $color-grey-100;
 $color-background-inverse: $color-orange-300;
 
+// Cards
+$color-card-title: $color-grey-600;
+$color-card-content: $color-grey-500;
+$color-card-infos: $color-grey-400;
+
 // Information messages
 $color-error-background: $color-red-500;
 $color-error: $color-white;

data/app/assets/stylesheets/elabs/_fixes.scss

@@ -0,0 +1,6 @@
+// Various fixes for the libraries used
+
+textarea {
+  /* Fix for https://github.com/alsacreations/KNACSS/issues/288 */
+  white-space: pre-wrap;
+}

data/app/assets/stylesheets/elabs/_icons.scss

@@ -11,3 +11,7 @@
 .#{$fa-css-prefix}-experience:before { content: fa-content($fa-var-flask); }
 
 .#{$fa-css-prefix}-mime-type:before { content: fa-content($fa-var-wrench); }
+
+.#{$fa-css-prefix}-group:before { content: fa-content($fa-var-box); }
+
+.#{$fa-css-prefix}-permalink:before { content: fa-content($fa-var-link); }

data/app/assets/stylesheets/elabs/app/_acts.scss

@@ -53,6 +53,17 @@
       &--unlock:before {
         @include icon($fa-var-unlock, true);
       }
+
+      q {
+
+        &:before {
+          content: '';
+        }
+
+        &:after {
+          content: '';
+        }
+      }
     }
   }
 }