cm-admin 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fef403882161b778959795eb4ee4b340a471913582710ed998d3d0c3c6d809eb
-  data.tar.gz: 4f083b865564092997f8a959c22b05675c07bd2973f959a357cf0ee132295fcc
+  metadata.gz: 5f00ed8703bf0c8f35c6b9d5f403bc8db0804888e02b2036c23c0d610413cfc2
+  data.tar.gz: 18ff830bd0ca02cd53b31ca03c9012f575e2b90b098d80df02a05f1193f97023
 SHA512:
-  metadata.gz: 444abf2ad421b1db1bdba4b506a7645e1d5e1653b78c6610c434f45999acc0b7b7ae11017df43f82f37058ec1cdff0aeb5b2a0a3ea0dc08e25c22b713d1cf6c0
-  data.tar.gz: b3475419d75358580b07914f988183071b95ad7a2f891811a8dce9a89aa2b1d90237a0b7b8340619142f90ab62de50e3b50f0ffa626a948a09f306c12601acc5
+  metadata.gz: 0f2704eaff88ff0d98cdbae358d9cab8274b155f4ae522a31816316bfafac14771d695eb0ca9f8ea4e8eccb474953533ccccc58ddb39c1acf872143da16861f5
+  data.tar.gz: f380015428b39a3b6ea4666f23de193f192b8b88932b08d90048f18387de44712c8c9188f12f8d2931c775bebd4f3fa5d4b1b5b57cb27afd693080646558c20f

data/.github/workflows/linters.yml

@@ -23,8 +23,12 @@ jobs:
         uses: reviewdog/action-reek@v1
         with:
           reek_version: 6.1.1
-      - name: runner / stylelint
-        run: npx stylelint **/*.scss
+      - uses: actions/checkout@v3
+      - name: stylelint
+        uses: reviewdog/action-stylelint@v1
+        with:
+         reporter: github-pr-review # Change reporter.
+         stylelint_input: '**/*.scss'
       - name: coffeelint
         uses: reviewdog/action-coffeelint@v1
         with:

data/.gitignore

@@ -5,7 +5,7 @@
 /doc/
 /pkg/
 /spec/reports/
-/tmp/
+tmp/
 node_modules/
 public/cm-admin-packs/
 # rspec failure tracking

data/.stylelintrc.json

@@ -0,0 +1,3 @@
+{
+"extends": "stylelint-config-standard-scss"
+}

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cm-admin (1.0.2)
+    cm-admin (1.0.3)
       caxlsx_rails
       cocoon (~> 1.2.15)
       csv-importer (~> 0.8.2)
@@ -106,8 +106,8 @@ GEM
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.4.4)
-    erubi (1.11.0)
-    globalid (1.0.0)
+    erubi (1.12.0)
+    globalid (1.1.0)
       activesupport (>= 5.0)
     htmlentities (4.3.4)
     i18n (1.11.0)
@@ -118,10 +118,10 @@ GEM
       railties (>= 6.0.0)
     json (2.6.2)
     local_time (2.1.0)
-    loofah (2.19.1)
+    loofah (2.20.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mail (2.8.0)
+    mail (2.8.1)
       mini_mime (>= 0.1.1)
       net-imap
       net-pop
@@ -130,7 +130,7 @@ GEM
     method_source (1.0.0)
     mini_mime (1.1.2)
     minitest (5.16.2)
-    net-imap (0.3.3)
+    net-imap (0.3.4)
       date
       net-protocol
     net-pop (0.1.2)
@@ -139,8 +139,8 @@ GEM
       timeout
     net-smtp (0.3.3)
       net-protocol
-    nio4r (2.5.8)
-    nokogiri (1.13.10-arm64-darwin)
+    nio4r (2.5.9)
+    nokogiri (1.14.3-arm64-darwin)
       racc (~> 1.4)
     pagy (4.11.0)
     parallel (1.22.1)
@@ -148,11 +148,11 @@ GEM
       ast (~> 2.4.1)
     pundit (2.2.0)
       activesupport (>= 3.0.0)
-    racc (1.6.1)
-    rack (2.2.4)
-    rack-proxy (0.7.4)
+    racc (1.6.2)
+    rack (2.2.6.4)
+    rack-proxy (0.7.6)
       rack
-    rack-test (2.0.2)
+    rack-test (2.1.0)
       rack (>= 1.3)
     rails (7.0.3.1)
       actioncable (= 7.0.3.1)
@@ -171,7 +171,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.4)
+    rails-html-sanitizer (1.5.0)
       loofah (~> 2.19, >= 2.19.1)
     railties (7.0.3.1)
       actionpack (= 7.0.3.1)
@@ -226,7 +226,7 @@ GEM
     thor (1.2.1)
     thread_safe (0.3.6)
     tilt (2.0.10)
-    timeout (0.3.1)
+    timeout (0.3.2)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
@@ -234,7 +234,7 @@ GEM
       axiom-types (~> 0.1)
       coercible (~> 1.0)
       descendants_tracker (~> 0.0, >= 0.0.3)
-    webpacker (5.4.3)
+    webpacker (5.4.4)
       activesupport (>= 5.2)
       rack-proxy (>= 0.6.1)
       railties (>= 5.2)
@@ -242,10 +242,11 @@ GEM
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.6.6)
+    zeitwerk (2.6.7)
 
 PLATFORMS
-  ruby
+  arm64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   cm-admin!

data/app/assets/javascripts/cm_admin/scaffolds.js

@@ -41,4 +41,8 @@ $(document).on('turbolinks:load', function () {
   flatpickr("[data-behaviour='date-only']", {
     dateFormat: "d-m-Y"
   })
-})
+})
+
+$(document).on('click', '.menu-item', function(e) {
+  $('.profile-popup').toggleClass('hidden');
+});

data/app/assets/stylesheets/cm_admin/base/auth.scss

@@ -71,3 +71,116 @@
     }
   }
 }
+
+.sidebar__footer {
+  position: absolute;
+  bottom: 0;
+  z-index: 100;
+  width: 100%;
+  padding: 16px 0;
+  box-shadow: inset 0px 1px 0px rgba(255, 255, 255, 0.15);
+  .menu-item {
+    @include font($size: $t4-text, $color: $ink-lightest-clr);
+    padding: 8px 24px;
+    @include transition-linear();
+    cursor: pointer;
+    &:hover {
+      color: $white;
+      background: rgba(255, 255, 255, 0.1);
+    }
+  }
+  .profile-name {
+    @include flex($align: center);
+    position: relative;
+    line-height: 22px;
+    @include font($size: $t4-text, $color: $ink-lightest-clr);
+    cursor: pointer;
+    .profile-avatar {
+      @include flex($justify: center, $align: center);
+      width: 22px;
+      height: 22px;
+      margin-right: 8px;
+      @include font($size: 10px, $color: $white, $weight: 900);
+      background-color: $brand-color;
+      vertical-align: middle; 
+      border-radius: 50%;
+      img {
+        width: 22px;
+        border-radius: $circle;
+      }
+    }
+  }
+  .profile-popup {
+    position: absolute;
+    left: 228px;
+    bottom: 10px;
+    width: 268px;
+    min-height: 100px;
+    overflow: hidden;
+    background-color: $white;
+    box-shadow: 0px 4px 16px rgba(0, 0, 0, 0.16);
+    border-radius: $radius-4;
+    animation: fadeIn 0.2s linear;
+    .profile-info {
+      display: grid;
+      grid-template-columns: 1fr 32px;
+      grid-gap: 9px;
+      padding: 8px 16px;
+      box-shadow: inset 0px -1px 0px rgba(148, 151, 155, 0.15);
+      &__left {
+        .name-text {
+          @include font($size: $t4-text);
+          line-height: 22px;
+          margin: 0;
+        }
+        .email-text {
+          @include font($size: $t4-text, $color: $ink-lightest-clr);
+          line-height: 22px;
+          margin: 0;
+          width: 200px;
+        }
+      }
+      &__right {
+        @include flex($justify: center, $align: center);
+        width: 32px;
+        height: 32px;
+        @include font($color: $white, $weight: 600);
+        background-color: $brand-color;
+        vertical-align: middle;
+        border-radius: 50%;
+        img {
+          width: 32px;
+          border-radius: $circle;
+        }
+      }
+    }
+    .page-options {
+      padding: 8px 0;
+      box-shadow: inset 0px -1px 0px rgba(148, 151, 155, 0.15);
+      .page-link {
+        display: block;
+        @include font($size: $t4-text);
+        line-height: 22px;
+        padding: 4px 16px;
+        border: none;
+        @include transition-linear();
+        &:hover {
+          background-color: $grey-lighter-clr;
+        }
+      }
+    }
+    .auth-option {
+      padding: 8px 0;
+      .auth-link {
+        display: block;
+        @include font($size: $t4-text);
+        line-height: 22px;
+        padding: 4px 16px;
+        @include transition-linear();
+        &:hover {
+          background-color: $grey-lighter-clr;
+        }
+      }
+    }
+  }
+}

data/app/assets/stylesheets/cm_admin/base/common.scss

@@ -16,8 +16,8 @@
   border-radius: $radius-4;
   z-index: 1;
   &.table-export-popup {
-    top: 50px;
-    right: 10px;
+    top: 40px;
+    right: 30px;
     width: 156px;
     padding: 8px 0;
     animation: fadeIn .2s ease-in-out;

data/app/assets/stylesheets/cm_admin/base/form.scss

@@ -16,6 +16,10 @@
   }
   .form-wrapper {
     .form-container {
+      margin-top: 32px;
+      &:nth-child(1) {
+        margin-top: 0;
+      }
       .form-title {
         @include font($size: $t3-text, $color: $primary-text-clr, $weight: bold);
         line-height: 24px;

data/app/assets/stylesheets/cm_admin/base/table.scss

@@ -149,6 +149,7 @@
             background: $gradient-one;
             display: none;
             transition: all 0.1s linear;
+            z-index: 3;
             .row-action-tool {
               display: flex;
               align-items: center;
@@ -175,7 +176,7 @@
       position: sticky;
       top: 0;
       background-color: $white;
-      z-index: 3;
+      z-index: 4;
     }
   }
 

data/app/assets/stylesheets/cm_admin/cm_admin.css.scss

@@ -11,6 +11,7 @@
  * It is generally better to create a new file per style scope.
  *
  *= require 'cm_admin/pages/import_page'
+ *= require 'cm_admin/pages/history_page'
  *= require 'cm_admin/base/table'
  *= require 'cm_admin/base/navbar'
  *= require 'cm_admin/base/sidebar'

data/app/assets/stylesheets/cm_admin/helpers/_mixins.scss

@@ -1,6 +1,6 @@
 @import "variable";
 
-@mixin flex($direction, $justify, $align, $wrap) {
+@mixin flex($direction: row, $justify: normal, $align: normal, $wrap: nowrap) {
   display: flex;
   flex-direction: $direction;
   justify-content: $justify;

data/app/assets/stylesheets/cm_admin/pages/history_page.scss

@@ -0,0 +1,49 @@
+@import "../helpers/index.scss";
+
+// History page styles
+.history-box {
+  width: 752px;
+  padding: 24px;
+  background: #ffffff;
+  border: 1px solid $grey-light-clr;
+  border-radius: 4px;
+  .history-item {
+    display: grid;
+    grid-template-columns: 32px 1fr;
+    grid-gap: 8px;
+    align-items: center;
+    margin-bottom: 32px;
+    &:nth-last-child(1) {
+      margin-bottom: 0;
+    }
+    .profile-pic {
+      img {
+        width: 32px;
+        height: 32px;
+        object-fit: cover;
+        border-radius: 50%;
+      }
+    }
+    .history-info {
+      display: inline-flex;
+      font-family: 'Open Sans', sans-serif;
+      font-size: 14px;
+      line-height: 22px;
+      .bold-text {
+        font-weight: 600;
+        color: #1d21d9;
+        margin-right: 4px;
+      }
+      .normal-text {
+        font-weight: 400;
+        color: #1d21d9;
+        margin-right: 4px;
+      }
+      .light-text {
+        font-weight: 400;
+        color: $ink-lighter-clr;
+        margin-right: 4px;
+      }
+    }
+  }
+}

data/app/controllers/cm_admin/resource_controller.rb

@@ -8,7 +8,9 @@ module CmAdmin
     def cm_index(params)
       @current_action = CmAdmin::Models::Action.find_by(@model, name: 'index')
       # Based on the params the filter and pagination object to be set
-      @ar_object = filter_by(params, nil, @model.filter_params(params))
+      records = "CmAdmin::#{@model.name}Policy::Scope".constantize.new(Current.user, @model.name.constantize).resolve
+      records = apply_scopes(records)
+      @ar_object = filter_by(params, records, @model.filter_params(params))
       # resource_identifier
       respond_to do |format|
         if request.xhr?
@@ -91,6 +93,14 @@ module CmAdmin
       end
     end
 
+    def cm_history(params)
+      @current_action = CmAdmin::Models::Action.find_by(@model, name: 'history')
+      resource_identifier
+      respond_to do |format|
+        format.html { render '/cm_admin/main/history' }
+      end
+    end
+
     def cm_custom_method(params)
       scoped_model = "CmAdmin::#{@model.name}Policy::Scope".constantize.new(Current.user, @model.name.constantize).resolve
       resource_identifier
@@ -126,8 +136,8 @@ module CmAdmin
       authorize controller_name.classify.constantize, policy_class: "CmAdmin::#{controller_name.classify}Policy".constantize if defined? "CmAdmin::#{controller_name.classify}Policy".constantize
       aar_model = request.url.split('/')[-2].classify.constantize  if params[:aar_id]
       @associated_ar_object = aar_model.find(params[:aar_id]) if params[:aar_id]
-      nested_tables = @model.available_fields[:new].except(:fields).keys
-      nested_tables += @model.available_fields[:edit].except(:fields).keys
+      nested_tables = @model.available_fields[:new].map(&:nested_table_fields).map(&:keys).flatten
+      nested_tables += @model.available_fields[:edit].map(&:nested_table_fields).map(&:keys).flatten
       @reflections = @model.ar_model.reflect_on_all_associations
       nested_tables.each do |table_name|
         reflection = @reflections.select {|x| x if x.name == table_name}.first
@@ -162,6 +172,7 @@ module CmAdmin
       return @ar_object unless @current_action.child_records
 
       child_records = @ar_object.send(@current_action.child_records)
+      child_records = apply_scopes(child_records)
       @reflection = @model.ar_model.reflect_on_association(@current_action.child_records)
       @associated_model = if @reflection.klass.column_names.include?('type')
                             CmAdmin::Model.find_by(name: @reflection.plural_name.classify)
@@ -176,6 +187,13 @@ module CmAdmin
       return @ar_object, @associated_model, @associated_ar_object
     end
 
+    def apply_scopes(records)
+      @current_action.scopes.each do |scope|
+        records = records.send(scope)
+      end
+      records
+    end
+
     def filter_by(params, records, filter_params={}, sort_params={})
       filtered_result = OpenStruct.new
       cm_model = @associated_model || @model
@@ -211,8 +229,8 @@ module CmAdmin
           Hash[x.name.to_s.gsub('_attachment', ''), []]
         end
       }.compact
-      nested_tables = @model.available_fields[:new].except(:fields).keys
-      nested_tables += @model.available_fields[:edit].except(:fields).keys
+      nested_tables = @model.available_fields[:new].map(&:nested_table_fields).map(&:keys).flatten
+      nested_tables += @model.available_fields[:edit].map(&:nested_table_fields).map(&:keys).flatten
       nested_fields = nested_tables.uniq.map {|table|
         Hash[
           table.to_s + '_attributes',

data/app/views/cm_admin/main/_nested_fields.html.slim

@@ -1,4 +1,4 @@
-- fields = @model.available_fields[ action(action_name) ][assoc_name]
+- fields = section.nested_table_fields[assoc_name]
 - if fields.count == 1
   .nested-single-field.nested-fields
     - fields.each do |field|

data/app/views/cm_admin/main/_nested_table_form.html.slim

@@ -3,7 +3,7 @@
   .accordion.nested-form-accordion
     = f.fields_for table_name do |record|
       - if record.object.persisted?
-        = render partial: '/cm_admin/main/nested_fields', locals: { f: record, assoc_name: table_name }
+        = render partial: '/cm_admin/main/nested_fields', locals: { f: record, assoc_name: table_name, section: section }
     - if @reflections.select {|x| x if x.name == table_name}.first.macro == :has_many
       .links
-        = link_to_add_association "+ Add #{table_name.to_s.titleize}", f, table_name, partial: '/cm_admin/main/nested_fields', render_options:  {locals: { assoc_name: table_name }}, class: 'd-inline-block secondary-btn mt-2'
+        = link_to_add_association "+ Add #{table_name.to_s.titleize}", f, table_name, partial: '/cm_admin/main/nested_fields', render_options:  {locals: { assoc_name: table_name, section: section }}, class: 'd-inline-block secondary-btn mt-2'

data/app/views/cm_admin/main/_tabs.html.slim

@@ -4,4 +4,8 @@ ul.nav.nav-pills
       - if nav_item.custom_action.empty? || (nav_item.custom_action.present? && policy([:cm_admin, @model.name.classify.constantize]).send(:"#{nav_item.custom_action}?"))
         li.nav-item
           - nav_item_action_name = nav_item.custom_action.present? ? nav_item.custom_action : 'show'
-          = link_to tab_display_name(nav_item.nav_item_name), cm_admin.send("#{@ar_object.model_name.singular}_#{nav_item_action_name}_path", @ar_object.id), class: "nav-link #{ nav_item_action_name == action_name ? 'active' : ''}"
+          = link_to tab_display_name(nav_item.nav_item_name), cm_admin.send("#{@ar_object.model_name.singular}_#{nav_item_action_name}_path", @ar_object.id), class: "nav-link #{ nav_item_action_name == action_name ? 'active' : ''}"
+  // current_action_name is defined when action trail is added to that model
+  - if defined?(@ar_object.current_action_name)
+    li.nav-item
+      = link_to 'History', cm_admin.send("#{@ar_object.model_name.singular}_history_path", @ar_object.id), class: "nav-link #{ action_name == 'history' ? 'active' : ''}"

data/app/views/cm_admin/main/associated_show.html.slim

@@ -2,5 +2,5 @@
   .info-section
     p.section-heading = section.section_name
     .paper
-      - section.available_section_fields.each do |field|
+      - section.section_fields.each do |field|
         = show_field(@associated_ar_object, field)

data/app/views/cm_admin/main/history.html.slim

@@ -0,0 +1,17 @@
+.show-page.cm-page-container
+  .show-page__tabs.sticky-container.page-top-bar
+    .cm-tabs-bar
+      == render 'cm_admin/main/top_navbar'
+      == render 'cm_admin/main/tabs'
+  .show-page__inner.scrollable
+    .history-box
+      - @ar_object.action_trails.each do |at|
+        .history-item
+          .profile-pic 
+            img alt=("profile") src="https://www.pngitem.com/pimgs/m/264-2647677_avatar-icon-human-user-avatar-svg-hd-png.png"
+          .history-info
+            span.bold-text = at.actor.first_name
+            span.normal-text = at.trail_type.titleize
+            span.normal-text the
+            span.bold-text = at.entity_type
+            span.light-text = at.created_at.strftime("%B")

data/app/views/cm_admin/main/new.html.slim

@@ -15,8 +15,5 @@
               ul
                 - @ar_object.errors.full_messages.each do |error_message|
                   li = error_message
-      .form-container
-        p.form-title 
-          | Section heading
-        .form-container__inner
-          = generate_form(@ar_object.class.name.constantize.new, @model)
+
+      = generate_form(@ar_object.class.name.constantize.new, @model)

data/app/views/cm_admin/main/show.html.slim

@@ -12,5 +12,5 @@
           .info-section
             p.section-heading = section.section_name
             .paper
-              - section.available_section_fields.each do |field|
+              - section.section_fields.each do |field|
                 = show_field(@ar_object, field)

data/app/views/layouts/_left_sidebar_nav.html.slim

@@ -12,23 +12,19 @@
 
     .sidebar-menu__tabs-wrapper
 
-
-  .sidebar__footer
-    .profile-name
-      span.profile-avatar J
-      | John Doe
-    .profile-popup.hidden
-      .profile-info
-        .profile-info__left
-          p.name-text John Doe
-          p.email-text johndoe@commutatus.com
-        .profile-info__right J   
-      .page-options 
-        = link_to '/', class: 'page-link'
-          | Profile
-        = link_to '', class: 'page-link'
-          | Settings
-      .auth-option
-        = link_to '/sign-out', method: :delete, class: 'auth-link'
-          | Logout
+  - if defined?(user_full_name)
+    .sidebar__footer
+      .menu-item
+        .profile-name
+          span.profile-avatar J
+          | #{user_full_name}
+      .profile-popup.hidden
+        .profile-info
+          .profile-info__left
+            p.name-text = user_full_name
+            p.email-text = current_user.email
+          .profile-info__right
+        .auth-option
+          = link_to destroy_user_session_path, method: :delete, class: 'auth-link', data: { turbo_method: :delete }
+            | Logout
 = render 'layouts/quick_links'

data/config/routes.rb

@@ -16,9 +16,17 @@ CmAdmin::Engine.routes.draw do
         send(:post, 'import', to: "#{model.name.underscore}#import", as: "#{model.name.underscore}_import")
       end
     end
+    
     model.available_actions.sort_by {|act| act.name}.each do |act|
       scope model.name.tableize do
-        send(act.verb, act.path.present? ? act.path : act.name, to: "#{model.name.underscore}##{act.name}", as: "#{model.name.underscore}_#{act.name}")
+        # Define route only when action trail related field is present
+        if act.name == 'history'
+          if defined?(model.ar_model.new.current_action_name)
+            send(:get, ':id/history', to: "#{model.name.underscore}#history", as: "#{model.name.underscore}_history")
+          end
+        else
+          send(act.verb, act.path.present? ? act.path : act.name, to: "#{model.name.underscore}##{act.name}", as: "#{model.name.underscore}_#{act.name}")
+        end
       end
     end
   end

data/lib/cm_admin/constants.rb

@@ -28,6 +28,10 @@ module CmAdmin
       verb: :delete,
       path: ':id'
     },
+    history: {
+      verb: :get,
+      path: ':id/history'
+    },
     custom_action: {
       verb: :post
     }

data/lib/cm_admin/model.rb

@@ -8,7 +8,7 @@ require_relative 'models/blocks'
 require_relative 'models/column'
 require_relative 'models/filter'
 require_relative 'models/export'
-require_relative 'models/cm_show_section'
+require_relative 'models/section'
 require_relative 'models/tab'
 require_relative 'models/dsl_method'
 require 'pagy'
@@ -36,7 +36,7 @@ module CmAdmin
       @additional_permitted_fields ||= []
       @current_action = nil
       @available_tabs ||= []
-      @available_fields ||= {index: [], show: [], edit: {fields: []}, new: {fields: []}}
+      @available_fields ||= {index: [], show: [], edit: [], new: []}
       @params = nil
       @filters ||= []
       instance_eval(&block) if block_given?

data/lib/cm_admin/models/action.rb

@@ -6,7 +6,7 @@ module CmAdmin
       include Actions::Blocks
       attr_accessor :name, :display_name, :verb, :layout_type, :layout, :partial, :path, :page_title, :page_description,
         :child_records, :is_nested_field, :nested_table_name, :parent, :display_if, :route_type, :code_block,
-        :display_type, :action_type, :redirection_url, :sort_direction, :sort_column, :icon_name
+        :display_type, :action_type, :redirection_url, :sort_direction, :sort_column, :icon_name, :scopes
 
       VALID_SORT_DIRECTION = Set[:asc, :desc].freeze
 
@@ -34,6 +34,7 @@ module CmAdmin
         self.action_type = :default
         self.sort_column = :created_at
         self.sort_direction = :desc
+        self.scopes ||= []
         self.icon_name = 'fa fa-th-large'
       end