elabs 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b290d73dc3d912c67d96bb1be6f003e3937379450feeb5d5fb10de85e8c2d152
-  data.tar.gz: 895e5179cadaf4ca0dc9cd616cfcae0df47955d0330cb803cd4d65d6cc3423c9
+  metadata.gz: 179fc820588cdbe7ae3de5e0c42a37a678fab8e0e190a173426e493302f23556
+  data.tar.gz: 7e720b16441c9044c6e9489f71a32b95e1e392e9d8ffb4de25ab3916d113c482
 SHA512:
-  metadata.gz: dfadce23c0741913e150116ae8388e78e2f39287604036231116163b29174e1510ebf40a62ae067a02012b3041528dfa5531aaf66cf06aa05ba2373d402165af
-  data.tar.gz: 971646fbaee841718146fd8161fc8429ef6fa40fac4b1659034232eee7a997ea0442e579db580e66ea39da38e3108dad35c2686af68a8a1012f1a8229b5edd26
+  metadata.gz: 9983023566a96ad10c252882c4b05c68c719bb477127b6361f5364b70ff6359f9e35c59158f522ab6f24b9b554da544a319241e4281cb4d1dc1673bea0e25b79
+  data.tar.gz: 8f2474412043a4f25ac5277ef001b3b8ea06974da8500c4328de52839c3986416923cf70c250829388cbd600a15c111f033c89c4fcd0450daae8f31d8ee1e0d7

data/.gitignore

@@ -47,3 +47,9 @@ yarn-error.log
 # Ignore installation-specific files
 /spec/dummy/config/database.yml
 /spec/dummy/db/schema.rb
+
+# Dev server files
+/tmp/pids/server.pid
+
+# Packaged gems
+/pkg

data/CHANGELOG.md

@@ -1,6 +1,89 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [3.0.0] - 2018-09-17 - Notifications and avatars
+### Added
+
+  - User model:
+    - new `admins` scope to find all admins
+    - new `display_name` method to return the real name or username as
+      fallback
+    - Experimental avatar support (ActiveStorage attachment `avatar`).
+      **NOTE** that there are issues with uploads validation
+      ([ActiveStorage validations are not supported for now](https://stackoverflow.com/questions/51872521/how-to-prevent-active-storage-updating-model-when-validation-fails)),
+      leading to the uploaded file being saved even if validation fails.
+      To prevent this, the attached file is deleted on failure,
+      resulting on avatar suppression.To disable avatar support, set
+      `Elabs::use_avatars` to false in the initializer.
+
+  - Notifications:
+    - MVC for simple notification system
+    - Updated reports/comments to use notifications on save. Updated
+      admin actions as "lock", "unlock", "delete" to notify the authors
+    - New `NotifiableEntity` concern for content models
+
+  - Misc:
+    - Date helper: new `short_date(date)` method
+
+### Changed
+
+  - Views:
+    - `members/layout/_empty`: button to create content is now optional
+    - Updated views to use `user.display_name` when needed
+    - License icon is now a balance-scale icon
+    - Short dates
+    - Separators between information types on "show" views
+    - Reordered menus
+  - `ActableEntity` concern: moved `current_publish_action`,
+    `current_lock_action` and `current_update_action` to the
+    `ContentEntity` concern, as they are now shared between "actable"
+    and "notifiable" concerns
+
+### Improved
+
+  - Factorized some helper methods from "admin_content_helper" and
+    "member_content_helper" in "content_helper"
+  - Methods for public controllers are now in a `ElabsPublicController`.
+    All custom public controller should extend this new controller instead
+    of `ElabsApplicationController`
+  - Improved `xxx_selector` methods to be able to specify the field name
+    and the `multiple` select variant.
+
+### Removed
+
+### Fixed
+
+  - Fixed `current_publish_action` and `current_lock_action`: they now
+    return `:nothing` if content is already unpublished or locked.
+  - Sort order in public views for users, tags, languages and licenses
+
+## Planned
+
+Note that the elements in this list may change during development; it' a
+general idea of what will be done next.
+  - [3.0.0] - Notifications
+  - [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
+
+## [2.0.1] - 2018-09-10 - JSON views
+### Added
+
+  - Added "Active" and "Password reset" columns in admin users list to
+    have a better understanding of the users statuses
+
+### Improved
+
+  - Reviewed and updated all JSON views for future use in ajax requests
+
+### Removed
+
+  - Removed the timestamps from the licenses table. You'll need to
+    create a migration that drops `created_at` and `updated_at` on the
+    `licenses` table
+
 ## [2.0.0] - 2018-09-08 - Rails engine
 Everything seems to run fine, it's enough for a major version.
 

data/Gemfile

@@ -15,6 +15,7 @@ group :development, :test do
   # -------------------------------------------------------
   # Gems needed for the dummy application
   # -------------------------------------------------------
+  gem 'jbuilder', '~> 2.5'
   # See https://github.com/rails/execjs#readme for more supported runtimes
   gem 'mini_racer', platforms: :ruby
   # Use ActiveStorage variant
@@ -26,10 +27,11 @@ group :development, :test do
   gem 'devise'
   gem 'haml-rails'
   gem 'kaminari'
-  gem 'rails', '~> 5.2.1'
+  # gem 'rails', '~> 5.2.1'
   gem 'sass-rails', '~> 5.0'
   # Translations
   gem 'gettext_i18n_rails'
+  gem 'rails-i18n'
 
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'byebug', platforms: %i[mri mingw x64_mingw]

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    elabs (2.0.0)
+    elabs (3.0.0)
       rails (~> 5.2.1)
 
 GEM
@@ -160,6 +160,9 @@ GEM
       concurrent-ruby (~> 1.0)
     io-like (0.3.0)
     jaro_winkler (1.5.1)
+    jbuilder (2.7.0)
+      activesupport (>= 4.2.0)
+      multi_json (>= 1.2)
     json (2.1.0)
     kaminari (1.1.1)
       activesupport (>= 4.1.0)
@@ -236,6 +239,9 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.4)
       loofah (~> 2.2, >= 2.2.2)
+    rails-i18n (5.1.1)
+      i18n (>= 0.7, < 2)
+      railties (>= 5.0, < 6)
     railties (5.2.1)
       actionpack (= 5.2.1)
       activesupport (= 5.2.1)
@@ -354,13 +360,14 @@ DEPENDENCIES
   gettext_i18n_rails
   haml-rails
   haml_lint
+  jbuilder (~> 2.5)
   kaminari
   listen (>= 3.0.5, < 3.2)
   mini_magick (~> 4.8)
   mini_racer
   pg
-  rails (~> 5.2.1)
   rails-controller-testing
+  rails-i18n
   rspec-rails
   rubocop
   ruby_parser

data/ROADMAP.md

@@ -19,26 +19,21 @@ 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.
-  - [2.0.0 (currently working on)] - Make an engine
-  - [1.1.0] - JSON views for everything
-  - [2.2.0] - Notifications
-  - [2.3.0] - Urls table to attach urls to content, share favorites
-  - [2.4.0] - Teams to attach user and distant people to projects
-  - [2.5.0] - Projects: commits aggregation
-  - [2.6.0] - Users: service status aggregation without storage for now
-  - [2.7.0] - Raw content for everything
+  - [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
 
 ## Wonderland
   - ~~Rails engine~~ (since 2.0.0)
-  - Avatars for authors
-  - Support for custom fields ?
   - Move HTML helpers to decorators (https://github.com/drapergem/draper)
     AND/OR use a better templating system, as [Cells](http://trailblazer.to/gems/cells/)
+  - Support for custom fields ?
   - Export raw content (markdown, files)
   - Content translations (community made)
   - Teams (people with common projects)
   - Projects users
-  - Sharing across instances
   - Urls management (lists of URLs, favorites, sources,...)
   - Content: code snippets
   - Content references (reference others work in your own work)

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

@@ -1,9 +1,13 @@
-/* stylelint-disable rule-empty-line-before */
-
 // Icons in this file are only fontawesome icons with a more semantic name
+
 .#{$fa-css-prefix}-amount:before { content: fa-content($fa-var-hashtag); }
+
 .#{$fa-css-prefix}-is-sfw:before { content: fa-content($fa-var-check); }
+
 .#{$fa-css-prefix}-is-nsfw:before { content: fa-content($fa-var-times); }
-.#{$fa-css-prefix}-license:before { content: fa-content($fa-var-copyright); }
 
-/* stylelint-enable rule-empty-line-before */
+.#{$fa-css-prefix}-license:before { content: fa-content($fa-var-balance-scale); }
+
+.#{$fa-css-prefix}-experience:before { content: fa-content($fa-var-flask); }
+
+.#{$fa-css-prefix}-mime-type:before { content: fa-content($fa-var-wrench); }

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

@@ -0,0 +1,11 @@
+.badge {
+
+  &--notification {
+    min: {
+      width: 2rem;
+      height: 1rem;
+    }
+    text-align: center;
+    font-size: $font-size-base - .4rem;
+  }
+}

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

@@ -1,6 +1,13 @@
 .page {
   background-color: $color-brand;
 
+  // Admin pages variation ------------
+
+  &--admin {
+    border: 5px solid $color-danger;
+    min-height: 100vh;
+  }
+
   // Page menu ------------------------
 
   &__menu {
@@ -66,8 +73,9 @@
     &--admin {
       background-color: $color-red-50;
       border-bottom-color: darken($color-red-50, 5%);
-      box-shadow: inset 0 3px 8px -4px $color-borders,
-      0 3px 8px -4px $color-borders;
+      box-shadow:
+        inset 0 3px 8px -4px $color-borders,
+        0 3px 8px -4px $color-borders;
 
       a {
         color: darken($color-red-50, 15%);

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

@@ -3,4 +3,11 @@
 .users-list {
   @include grid(4, $spacer-small);
   @include classifier-card('user', $el-user-bg);
+
+  .user-card {
+
+    header {
+      height: 64px;
+    }
+  }
 }

data/app/assets/stylesheets/elabs/app/admin-members/_indexes.scss

@@ -18,7 +18,8 @@
   .licenses-list,
   .tags-list,
   .reports-list,
-  .users-list {
+  .users-list,
+  .notifications-list{
     display: table;
     width: 100%;
     font-size: .8em;

data/app/assets/stylesheets/elabs/app/mixins/_content-card.scss

@@ -17,6 +17,10 @@
         padding: 0;
         flex: none;
         margin-right: $spacer-tiny;
+
+        img {
+          border-radius: $border-radius;
+        }
       }
 
       h3 {

data/app/assets/stylesheets/elabs/app/mixins/_content-full.scss

@@ -19,12 +19,24 @@
             padding-top: $spacer-tiny;
             border-top: 1px dashed $color-borders;
           }
-        }
-      }
 
-      .date,
-      .license {
-        margin-left: $spacer-small-plus;
+          &.image {
+            padding: 0;
+            margin: (-$spacer-tiny) (-$spacer-small) ($spacer-small) (-$spacer-small);
+
+            /* stylelint-disable max-nesting-depth */
+
+            img {
+              width: 100%;
+              border-top: {
+                left-radius: $border-radius-lg;
+                right-radius: $border-radius-lg;
+              }
+            }
+
+            /* stylelint-enable max-nesting-depth */
+          }
+        }
       }
     }
 

data/app/assets/stylesheets/elabs/lib/knacss/_knacss-variables.scss

@@ -193,21 +193,22 @@ $switch-border-radius: 3em;
 // Components: buttons, badges, alerts color variants list
 // Convention is: name - background-color - color - border
 $variants-list: (
-  (download,   $color-brand,      $white,    none),
-  (primary,    $color-primary,    $white,    none),
-  (new,        $color-primary,    $white,    none),
-  (save,       $color-success,    $white,    none),
-  (show,       $color-primary,    $white,    none),
-  (edit,       $color-primary,    $white,    none),
-  (success,    $color-success,    $white,    none),
-  (info,       $color-info,       $black,    none),
-  (notice,     $color-info,       $black,    none),
-  (warning,    $color-warning,    $black,    none),
-  (lock,       $color-warning,    $black,    none),
-  (danger,     $color-danger,     $white,    none),
-  (destroy,    $color-danger,     $white,    none),
-  (inverse,    $color-inverse,    $white,    none),
-  (ghost,      $color-ghost,      $white,    0 0 0 1px $white inset)
+  (download,     $color-brand,      $white,      none),
+  (primary,      $color-primary,    $white,      none),
+  (new,          $color-primary,    $white,      none),
+  (save,         $color-success,    $white,      none),
+  (show,         $color-primary,    $white,      none),
+  (edit,         $color-primary,    $white,      none),
+  (success,      $color-success,    $white,      none),
+  (info,         $color-info,       $black,      none),
+  (notice,       $color-info,       $black,      none),
+  (warning,      $color-warning,    $black,      none),
+  (lock,         $color-warning,    $black,      none),
+  (danger,       $color-danger,     $white,      none),
+  (destroy,      $color-danger,     $white,      none),
+  (inverse,      $color-inverse,    $white,      none),
+  (experimental, $color-brand,      $color-base, none),
+  (ghost,        $color-ghost,      $white,      0 0 0 1px $white inset)
 ) !default;
 
 // Component: tabs

data/app/assets/stylesheets/elabs/lib/knacss/_knacss.scss

@@ -53,7 +53,7 @@
 //@import "knacss/sass/components/tabs";       // tabs styles
 //@import "knacss/sass/components/arrows";     // arrows styles
 //@import "knacss/sass/components/tags";       // tags styles
-//@import "knacss/sass/components/badges";     // badges styles
+@import "knacss/sass/components/badges";     // badges styles
 @import "knacss/sass/components/alerts";     // alerts styles
 
 /* stylelint-enable */

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

@@ -37,6 +37,7 @@
 // App specific elements
 @import 'app/acts';
 @import 'app/alerts';
+@import 'app/badges';
 @import 'app/buttons';
 @import 'app/comments';
 @import 'app/content';

data/app/controllers/elabs/acts_controller.rb

@@ -1,5 +1,5 @@
 module Elabs
-  class ActsController < ElabsApplicationController
+  class ActsController < ElabsPublicController
     ALLOWED_ORDER_FROM = %w[created_at].freeze
     DEFAULT_ORDER = { created_at: :desc }.freeze
 

data/app/controllers/elabs/admin/admin_content_application_controller.rb

@@ -18,6 +18,7 @@ module Elabs
       # DELETE /<entity>/1
       # DELETE /<entity>/1.json
       def destroy
+        @entity.changed_by = current_user
         @entity.destroy
         respond_to do |format|
           format.html { redirect_to index_url, notice: format(_('%<model_name>s was successfully destroyed.'), model_name: self.class::SINGULAR_NAME.capitalize) }
@@ -25,21 +26,23 @@ module Elabs
         end
       end
 
+      # rubocop:disable Metrics/AbcSize
       # PUT /<entity>/1/toggle_lock
       def toggle_lock
-        if @entity.toggle(:locked).save
-          respond_to do |format|
+        @entity.changed_by = current_user
+        respond_to do |format|
+          if @entity.toggle(:locked).save
             format.html { redirect_to index_url, notice: lock_message(@entity) }
-            format.json { render :show, status: :ok }
-          end
-        else
-          respond_to do |format|
+            format.json { render partial_name, status: :ok, locals: { "#{self.class::SINGULAR_NAME}": @entity } }
+          else
             format.html { redirect_to index_url, error: 'An error prevented to update this entity' }
             format.json { render json: @entity.errors, status: :unprocessable_entity }
           end
         end
       end
 
+      # rubocop:enable Metrics/AbcSize
+
       private
 
       # Use callbacks to share common setup or constraints between actions.
@@ -53,6 +56,10 @@ module Elabs
         "admin_#{self.class::PLURAL_NAME}".to_sym
       end
 
+      def partial_name
+        "_#{self.class::SINGULAR_NAME}".to_sym
+      end
+
       def lock_message(entity)
         message = if entity.locked?
                     _('%<model_name>s was successfully locked.')