symphonia 4.2.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b1926adf23dfcc6193affda2c0eaf6edcf7729eba7ee21fde5d65d7ffe6fa64
-  data.tar.gz: 16cd15eb367b3f597e6fc67f60d8d8de7941010d08ec42b5b02baecf3fddf623
+  metadata.gz: 71cb8a41bead7977d784fbb826c54a059b74f9cc75f43de46e67bbb8fd547cea
+  data.tar.gz: aa49eb8c8b095422abd9bb3c65105c3bfc79bf3cb82d2e8ea6655751cc9f15a2
 SHA512:
-  metadata.gz: c3b96b59bd3014de2cd86cbf53a5c4bfe1c30f4f1ee6d1b9a60a71c98784c33c1a8b270471dfe8a5db35f80c00f02c931e3d54c98e712000737828e805226480
-  data.tar.gz: 31b3f194941fb8661419af1f52a1ab9c4423f40da86443846876f9996505127903002473ec7c1923f91891858851201bb134420feb1210f7ecf061f182ae11bb
+  metadata.gz: 98a480e8c8c1e1a31c887c313fc6bd682774cc397277ff7edf10da58583d59badca233903adb447d131d98b704573d2dbdd8fd90e61465ae146eb126a4e85c36
+  data.tar.gz: bc42c7d29dcb974fee96e7749315449c77f44843a2b8cde034a5964dc4aec0c9fdfa25a5224605165b75453e24a23b6ca53d35ef59b2e3c620e1b00f6fe11216

data/README.md

@@ -1,5 +1,6 @@
 # Symphonia
-> simple core toolkit for my rails apps
+
+simple core toolkit for my rails apps
 
 ## Installation
 
@@ -13,6 +14,7 @@ after `bundle install` run post-installation: `rails g symphonia:setup`
 
 > Setup prepare `config/initializers/settings.rb`, create `spec/spec_helper.rb`, add stylesheets and javascripts references and copy basic layout.
 
+## Configuration
 
 ## Upgrade to v4.0
 1. update Gemfile:
@@ -30,3 +32,27 @@ And `bundle update`
 export THOR_MERGE=vimdiff
 rails app:update
 ```
+## Upgrade to v5.0
+Version 5 remove sprockets bootstrap, font-awesome and others CSS/JS things. It expect that assets will be managed by webpacker (or similar) FE technology.
+
+Also remove `Role` model and whole permissions custom logic. Its replace standardized CanCanCan gem (https://github.com/CanCanCommunity/cancancan/tree/develop/docs)
+
+### Sprockets fallback
+For fallback add to Gemfile
+```ruby
+gem "bootstrap", "~> 4.6"
+gem "jquery-rails"
+gem "jquery-ui-rails"
+gem "listen"
+gem "sass-rails"
+gem "turbolinks"
+gem 'font-awesome-sass', '~> 6.2.0'
+```
+in your "app/assets/stylessheets/general.scss" make sure symphonia is imported
+```scss
+@import 'symphonia/basic';
+@import 'symphonia/layout';
+```
+
+### CanCanCan
+For user there is `Symphonia::UserAbility` which defined permissions for User model + for admin add basic CRUD operation for `:all`.

data/app/assets/javascripts/symphonia/application.js

@@ -7,8 +7,8 @@
 //= require symphonia/_core
 //= require symphonia/Sortable
 
-//= require bootstrap-datepicker/core
-//= require bootstrap-datepicker/locales/bootstrap-datepicker.cs.js
+// require bootstrap-datepicker/core
+// require bootstrap-datepicker/locales/bootstrap-datepicker.cs.js
 
 //= require_self
 //= require symphonia/symphonia_bootstrap_dialog
@@ -155,4 +155,4 @@ SymphoniaCheckboxes = {
 
     return input;
   }
-};
+};

data/app/assets/stylesheets/symphonia/_font_awesome.scss

@@ -1,25 +1,27 @@
-@import 'font-awesome';
+@import "font-awesome";
 /* Font awesome aliases */
 .fa-add {
-  @extend .fa-plus-circle !optional;
+  //@include fa-icon-solid($fa-var-circle-plus);
+  @extend .fa-circle-plus !optional;
 }
 .fa-delete, .fa-del {
-  @extend .fa-trash-o !optional;
+  @include fa-icon-solid($fa-var-trash-can);
 }
 .fa-back {
-  @extend .fa-chevron-left !optional;
+  @include fa-icon-solid($fa-var-chevron-left);
 }
 .fa-true {
   @extend .fa-check !optional;
+  @include fa-icon-solid($fa-var-check);
 }
 .fa-false {
-  @extend .fa-times !optional;
+  @include fa-icon-solid($fa-var-times);
 }
 .fa-notice {
   @extend .fa-check-circle !optional;
 }
 .fa-error {
-  @extend .fa-times-circle !optional;
+  @extend .circle-exclamation !optional;
 }
 .alert .fa-info {
   @extend .fa-info-circle !optional;

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

@@ -1,4 +1,4 @@
-@import "bootstrap";
+@import "/bootstrap";
 
 // fixed navbar
 body > .container {
@@ -38,3 +38,35 @@ footer.footer {
     @extend .d-print-none;
   }
 }
+
+/* TABLE */
+@mixin inactive-row {
+  opacity: 0.5
+}
+td.price {
+  text-align: right;
+}
+table.table {
+  th a.asc {
+    &:after {
+      content: "\2191";
+    }
+  }
+  th a.desc {
+    &:after {
+      content: "\2193";
+    }
+  }
+  tr.status {
+    &--lock, &--inactive, &--archived {
+      @include inactive-row;
+    }
+  }
+  .buttons {
+    text-align: right;
+  }
+}
+
+/* FORM */
+.required label, label[required], label.required, .has-error {color: red !important;}
+.required label:after, label[required]:after, label.required:after { content: '* '}

data/app/assets/stylesheets/symphonia/basic.scss

@@ -1,85 +1,13 @@
-@import "_font_awesome";
+@import "./_font_awesome";
 
 .page-header.title, .page-header.title h1 {
   margin-top: 0;
 }
-@mixin inactive-row {
-  opacity: 0.5
-}
+
 .reorder, .reorder label {
   cursor: move;
 }
 
-.flash {
-    border: 1px solid;
-    margin: 10px 0px;
-    padding:15px 10px 15px 10px;
-    background-repeat: no-repeat;
-    background-position: 10px center;
-    position:relative;
-    line-height: 30px;
-    &>i.icon:first-child {
-        font-family: FontAwesome;
-        font-size: 30px;
-
-        font-style: normal;
-        position:absolute;
-        top: 50%;
-        margin-top: -15px;
-    }
-    &>span.flash-content {
-        padding-left: 35px;
-
-    }
-}
-.info {
-    color: #00529B;
-    background-color: #BDE5F8;
-}
-.notice {
-    color: #4F8A10;
-    background-color: #DFF2BF;
-    &>i.icon:first-child:before {
-        content: "\f05d"
-    }
-}
-
-.nodata, .no-data {
-    @extend .flash;
-    @extend .info;
-    text-align: center;
-    border-width: 3px;
-}
-
-div.error_explanation {
-    color: #D63301;
-    background-color: #FFCCBA;
-    border: 1px solid rgba(255,0,0,0.5);
-    position: relative;
-    margin: 0 0 25px 0;
-    h2 {
-      display: none;
-    }
-    ul {
-      margin: 0;
-      li {
-        line-height: 25px;
-      }
-    }
-    &>p {
-      background-color: rgba(255,255,255,0.5);
-      margin: 0;
-      padding: 5px;
-      text-shadow: 0 0 5px #FFFFFF;
-    }
-    &>p:before {
-      font-family: FontAwesome;
-      margin-right: 5px;
-      font-size: 20px;
-      content: "\f071";
-    }
-}
-
 #account-extra-details {
   dt {
     width: 40%;
@@ -115,8 +43,6 @@ td.buttons {
 .contextual {@extend .pull-right !optional}
 .contextual input, .contextual select {font-size:0.9em;}
 
-.required label, label[required], label.required, .has-error {color: red !important;}
-.required label:after, label[required]:after, label.required:after { content: '* '}
 textarea {width: 99%;}
 
 #internal_static_page_sign {
@@ -142,29 +68,7 @@ textarea {width: 99%;}
     }
   }
 }
-td.price {
-  text-align: right;
-}
-table.table {
-  th a.asc {
-    &:after {
-      content: "\2191";
-    }
-  }
-  th a.desc {
-    &:after {
-      content: "\2193";
-    }
-  }
-  tr.status {
-    &--lock, &--inactive, &--archived {
-      @include inactive-row;
-    }
-  }
-  .buttons {
-    text-align: right;
-  }
-}
+
 
 .highlight {
   animation-duration: 1s;

data/app/assets/stylesheets/symphonia/filters.scss

@@ -1,13 +1,11 @@
 #symphonia_query_options_form {
   .filter-custom-date {
-    &>* {
+    & > * {
       width: 49%;
-      //&:last-child {
-      //  float:right;
-      //}
     }
   }
 }
+
 #query_data {
   table.table {
     .price {
@@ -16,4 +14,4 @@
       }
     }
   }
-}
+}

data/app/assets/stylesheets/symphonia/symphonia_bootstrap.scss

@@ -1,2 +1,2 @@
 @import "layout";
-@import "bootstrap-datepicker3";
+// @import "bootstrap-datepicker3";

data/app/controllers/symphonia/accounts_controller.rb

@@ -48,7 +48,7 @@ module Symphonia
       @user.attributes = user_params
       respond_to do |format|
         @user.edited_by = User.current.logged_in? && User.current
-        @user.edited_at = Time.now
+        @user.edited_at = Time.current
         if @user.save
           format.html { redirect_to({ action: 'show' }, notice: t(:text_updated)) }
           format.json { head :no_content }
@@ -104,7 +104,7 @@ module Symphonia
       @user = find_account_by_token(params.require(:id))
       return render_404 if @user.nil?
 
-      if params[:password] # && params[:password_confirmation]
+      if params[:password].present?
         @user.password = params[:password]
       end
 
@@ -147,8 +147,12 @@ module Symphonia
       User.current
     end
 
+    def current_ability
+      @current_ability ||= UserAbility.new current_user
+    end
+
     def find_account_by_mail(mail)
-      User.where(email: mail).first
+      User.find_by(email: mail)
     end
 
     def find_account_by_token(id)

data/app/controllers/symphonia/application_controller.rb

@@ -4,5 +4,6 @@ module Symphonia
     include ControllerExtensions
 
     helper Symphonia::BootstrapModalHelper
+
   end
-end
+end

data/app/controllers/symphonia/users_controller.rb

@@ -2,10 +2,10 @@ module Symphonia
   class UsersController < ApplicationController
 
     helper Symphonia::RendererHelper
+    include ::CanCan::ControllerAdditions
 
-    before_action :find_user, except: %i[index new create show]
+    before_action :user, except: %i[index new create show]
     before_action :authorize, except: [:show]
-    before_action -> { menu_item(:my_account) }, only: %i[current edit_current update_current]
 
     def index
       @query = Symphonia::User.query.new
@@ -22,8 +22,8 @@ module Symphonia
 
     def show
       @user = Symphonia::User.find(params[:id]) if params[:id]
-      @user ||= Symphonia::User.current
-      authorize
+      @user ||= current_user
+      authorize! :show, @user
       respond_to do |format|
         format.html
         format.json { render json: @user, except: %w[crypted_password password_salt persistence_token perishable_token] }
@@ -32,7 +32,6 @@ module Symphonia
 
     def new
       @user = Symphonia::User.new
-      @roles = Symphonia::Role.sorted
       respond_to do |format|
         format.html
       end
@@ -46,27 +45,18 @@ module Symphonia
           format.xml { render xml: @user, status: :created, location: @user }
           format.json { render json: @user, status: :created, location: @user }
         else
-          format.html do
-            @roles = Symphonia::Role.sorted
-            render action: 'new'
-          end
+          format.html { render action: 'new' }
           format.xml { render xml: @user.errors, status: :unprocessable_entity }
           format.json { render json: @user.errors, status: :unprocessable_entity }
         end
       end
     end
 
-    def edit
-      @roles = Role.all
-    end
+    def edit; end
 
     def update
       @user.attributes = user_params
-      @user.admin = params[:admin] if params[:admin] && Symphonia::User.current.admin?
-      if params[:role_id].present? && Symphonia::User.current.admin?
-        @role = Role.find(params[:role_id])
-        @user.role = @role
-      end
+      @user.admin = params[:admin] if params[:admin] && current_user.admin?
       respond_to do |format|
         @user.edited_by = current_user
         @user.edited_at = DateTime.now
@@ -74,10 +64,7 @@ module Symphonia
           format.html { redirect_back_or_default user_path(@user), notice: t(:text_updated) }
           format.any(:json, :xml) { head :no_content }
         else
-          format.html do
-            @roles = Symphonia::Role.sorted
-            render action: 'edit'
-          end
+          format.html { render action: 'edit' }
           format.xml { render xml: @user.errors, status: :unprocessable_entity }
           format.json { render json: @user.errors, status: :unprocessable_entity }
         end
@@ -114,22 +101,23 @@ module Symphonia
 
     private
 
-    def find_user
-      @user = Symphonia::User.find(params[:id])
+    def user
+      @user ||= Symphonia::User.find(params[:id])
     end
 
     def authorize
-      if User.current.logged_in? && User.current.id == @user&.id
-        true
-      else
-        super
-      end
+      authorize! action_name.to_sym, @user
     end
 
     def user_params
       allowed = [:login, :first_name, :last_name, :password, :password_confirmation, :email, :mail, preference_ids: []]
-      allowed.concat(%i[admin role_id]) if Symphonia::User.current.admin?
+      allowed << :admin if current_user.admin?
       params.require(:user).permit(allowed)
     end
+
+    def current_ability
+      @current_ability ||= UserAbility.new current_user
+    end
+
   end
 end

data/app/helpers/symphonia/application_helper.rb

@@ -1,7 +1,6 @@
-# require 'symphonia/bootstrap_link_render'
 module Symphonia
   module ApplicationHelper
-    include FontAwesome::Rails::IconHelper
+
     include FormHelper
 
     def bootstrap_class_for(flash_type)
@@ -23,8 +22,8 @@ module Symphonia
     def render_flash_messages(flash_messages = nil)
       s = ''
       Array(flash_messages || flash).each do |type, message|
-        s << content_tag(:div, class: "d-print-none alert #{bootstrap_class_for(type)}") do
-          content_tag(:button, '', class: 'fa fa-times-circle-o close', data: { dismiss: 'alert' }) + Array.wrap(message).collect { |m| fa_icon(type, text: m) }.join("<br>").html_safe
+        s << tag.div(class: "d-print-none alert #{bootstrap_class_for(type)}") do
+          tag.button('', class: 'fa fa-circle-xmark close', data: { dismiss: 'alert' }) + Array.wrap(message).collect { |m| icon(type, text: m) }.join("<br>").html_safe
         end
       end
 
@@ -38,11 +37,13 @@ module Symphonia
       end
       options[:container_class] ||= 'mr-auto'
 
-      content_tag(:ul, s.html_safe, itemscope: '', itemtype: 'http://schema.org/BreadcrumbList', class: "navbar-nav #{options[:container_class]}", id: menu.to_s)
+      tag.ul(s.html_safe, itemscope: '', itemtype: 'http://schema.org/BreadcrumbList', class: "navbar-nav #{options[:container_class]}", id: menu.to_s)
     end
 
     def render_menu_node(menu, item, options = {})
       condition = item[:if] ? item[:if].call : true
+      return nil unless condition
+
       selected = @menu_item.to_sym == menu
       label = case item[:label].class.name
               when 'NilClass'
@@ -57,16 +58,16 @@ module Symphonia
                 raise "MenuManager error: Label is unknown type: #{item[:label].class}"
               end
       if item[:children].blank?
-        return content_tag(:li, render_menu_link(item, label, options), class: "nav-item #{menu} #{'active' if selected} #{options[:class]}", id: item[:id]) if condition
+        tag.li(render_menu_link(item, label, options), class: "nav-item #{menu} #{'active' if selected} #{options[:class]}", id: item[:id])
       else
         children = ''
         item[:children].each do |child, subitem|
           children << render_menu_node(menu, subitem, class: 'dropdown-item').to_s
         end
-        unless children.blank?
-          return content_tag(:li, class: "nav-item dropdown #{menu}") do
+        if children.present?
+          tag.li(class: "nav-item dropdown #{menu}") do
             concat render_menu_link(item.merge({ class: 'dropdown-toggle', data: { toggle: 'dropdown' } }), label, { is_submenu: true })
-            concat content_tag(:ul, children.html_safe, class: 'dropdown-menu')
+            concat tag.ul(children.html_safe, class: 'dropdown-menu')
           end
         end
       end
@@ -87,7 +88,7 @@ module Symphonia
               item[:url]
             end
       link_to(
-        (content_tag(:i, '', class: "#{item[:icon]}") + "\n" + content_tag(:span, label, itemprop: 'title')).html_safe,
+        (tag.i('', class: "#{item[:icon]}") + "\n" + tag.span(label, itemprop: 'title')).html_safe,
         url,
         class: "nav-link #{item[:class]}",
         data: item[:data],
@@ -133,20 +134,21 @@ module Symphonia
         ''
       else
         html_title(header_text.dup)
-        header_text << "\n" + content_tag(:small, small, class: 'text-muted') if small.present?
+        header_text << ("\n" << tag.small(small, class: 'text-muted')) if small.present?
         s = ''
         if options[:back] && !request.xhr?
           back_url = options[:back] unless options[:back].is_a? TrueClass
           s << link_to_back(back_url)
         end
         s << capture(&block).to_s if block_given?
-        header_tag = content_tag request.xhr? && :h5 || :h1, id: 'page_header', class: s.present? && "col-6" || nil do
+        header_class = (s.present? && "col-6") || nil
+        header_tag = content_tag(((request.xhr? && :h5) || :h1), id: 'page_header', class: header_class) do
           header_text.html_safe
         end
         return header_tag if s.blank?
 
-        content_tag :div, class: "row" do
-          header_tag + content_tag(:div, s.html_safe, class: "col-6 text-right")
+        tag.div(class: "row") do
+          header_tag + tag.div(s.html_safe, class: "col-6 text-right")
         end
       end
     end
@@ -154,7 +156,7 @@ module Symphonia
     alias_method :page_header, :title
 
     def render_no_data(message = nil)
-      content_tag(:div, message || t(:text_no_data), class: 'nodata')
+      tag.div(icon("circle-info", text: message || t(:text_no_data)), class: 'alert alert-info text-center nodata')
     end
 
     def content_for(name, content = nil, &block)
@@ -175,7 +177,7 @@ module Symphonia
     end
 
     def format_html(text)
-      content_tag(:div, (defined?(Ckeditor) ? text.html_safe : format_text(text)), class: 'formatted-text')
+      tag.div((defined?(Ckeditor) ? text.html_safe : format_text(text)), class: 'formatted-text')
     end
 
     def format_price(value, options = {})
@@ -183,7 +185,7 @@ module Symphonia
     end
 
     def multiselect_toggler(id = nil)
-      link_to(fa_icon(:plus), 'javascript:void(0);', onclick: "toggleMultiSelect(#{id || 'this'});return false", class: 'btn fa fa-border')
+      link_to(icon('plus'), 'javascript:void(0);', onclick: "toggleMultiSelect(#{id || 'this'});return false", class: 'btn fa fa-border')
     end
 
     def link_to_back(url = nil)
@@ -191,14 +193,12 @@ module Symphonia
     end
 
     def link_to_new_entity(options = {})
-      return '' if !options.has_key?(:skip_permission_check) && !User.current.allowed_to?(:"manage_#{controller_name}")
-
       anchor = options.has_key?(:anchor) ? options.delete(:anchor) : 'page_header'
       label = options.delete(:label) || t("label_#{controller_name.singularize}_new")
       model = controller.try(:model) || controller_name.singularize
       url = options.delete(:url) || new_polymorphic_path(model, anchor: anchor)
 
-      link_to(fa_icon('add', text: label), url, { class: 'btn btn-primary' }.merge(options))
+      link_to(icon('square-plus', text: label), url, { class: 'btn btn-primary' }.merge(options))
     end
 
     # change the default link renderer for will_paginate
@@ -238,8 +238,30 @@ module Symphonia
       javascript_tag("$(document).ready(function() {#{js.html_safe}})".html_safe)
     end
 
-    def icon(fa, text = nil, **options)
-      fa_icon(fa, (text && { text: content_tag(:span, text, class: 'd-none d-sm-inline') } || {}).merge(options))
+    # prepend FontAwesome::Sass::Rails::ViewHelpers
+    def icon(icon, text = nil, html_options = {})
+      if text.is_a?(Hash)
+        html_options = text
+        text = nil
+      end
+
+      text_content = if text
+                       tag.span(text, class: 'd-none d-sm-inline')
+                     elsif html_options[:text]
+                       html_options.delete(:text)
+                     end
+      html_options[:title] ||= text
+      html_options[:class] = "fa-regular fa-#{icon}"
+      html_options['aria-hidden'] ||= true
+
+      html = tag.i(nil, **html_options)
+      html << ' ' << text_content.to_s if text_content.present?
+      html
+    end
+
+    def fa_icon(fa, options = {})
+      ActiveSupport::Deprecation.warn "use `icon` instead"
+      icon(fa, options.delete(:text), options)
     end
 
     # Render original template from engine
@@ -332,11 +354,11 @@ module Symphonia
 
       def to_html
         html = "<div id='#{@modal_id}' style='' class='modal fade' role='dialog'><div class='modal-dialog #{'modal-lg' if size.present?}'><div class='modal-content'>"
-        html << @c.content_tag(:div, class: 'modal-header') do
-          @c.content_tag(:button, '', class: 'close fa fa-times', data: { dismiss: 'modal' }, 'aria-hidden' => true) + @c.content_tag(:h4, @title, class: 'modal-title') + @header.to_s
+        html << @c.tag.div(class: 'modal-header') do
+          @c.tag.button('', class: 'close fa fa-times', data: { dismiss: 'modal' }, 'aria-hidden' => true) + @c.tag.h4(@title, class: 'modal-title') + @header.to_s
         end
-        content = @c.content_tag(:div, @c.content_tag(:div, body.html_safe, class: 'modal-content-inner-container container-fluid'), class: 'modal-body')
-        content << @c.content_tag(:div, footer.html_safe, class: 'modal-footer')
+        content = @c.tag.div(@c.tag.div(body.html_safe, class: 'modal-content-inner-container container-fluid'), class: 'modal-body')
+        content << @c.tag.div(footer.html_safe, class: 'modal-footer')
 
         html << content.html_safe
         html << '</div></div></div>'

data/app/models/symphonia/preference.rb

@@ -3,10 +3,10 @@ module Symphonia
     self.table_name = 'preferences'
 
     validates :name, uniqueness: true
-    # has_and_belongs_to_many :symphonia_units, association_foreign_key: 'user_id'
-    has_and_belongs_to_many :users, join_table: 'preferences_users', association_foreign_key: 'user_id', class_name: 'Symphonia::User'
+    has_and_belongs_to_many :users, join_table: 'preferences_users', association_foreign_key: 'user_id',
+                                    class_name: 'Symphonia::User'
 
-    scope :visible, ->(user = Symphonia::User.current) { user.admin? ? all : where(restrict: false)}
-  end
+    scope :visible, ->(user = Symphonia::User.current) { user.admin? ? all : where(restrict: false) }
 
-end
+  end
+end