beyond_canvas 0.13.0.pre → 0.15.2.pre

data/app/assets/stylesheets/beyond_canvas/utilities/_functions.scss

@@ -0,0 +1,15 @@
+/// Replace `$search` with `$replace` in `$string`
+/// @author Hugo Giraudel
+/// @param {String} $string - Initial string
+/// @param {String} $search - Substring to replace
+/// @param {String} $replace ('') - New value
+/// @return {String} - Updated string
+@function str-replace($string, $search, $replace: '') {
+  $index: str-index($string, $search);
+
+  @if $index {
+    @return str-slice($string, 1, $index - 1) + $replace + str-replace(str-slice($string, $index + str-length($search)), $search, $replace);
+  }
+
+  @return $string;
+}

data/app/assets/stylesheets/beyond_canvas/utilities/_mixins.scss

@@ -0,0 +1,24 @@
+@mixin background-color-darken($color, $percent) {
+  background-color: $color;
+  transition: $main-transition;
+
+  &:hover {
+    background-color: darken($color, $percent);
+    transition: $main-transition;
+  }
+}
+
+@mixin color-darken($color, $percent) {
+  color: $color;
+  transition: $main-transition;
+
+  &:hover {
+    color: darken($color, $percent);
+    transition: $main-transition;
+  }
+}
+
+@mixin background-color-lighten($color, $percent) {
+  background-color: lighten($color, $percent);
+  transition: $main-transition;
+}

data/app/controllers/beyond_canvas/application_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module BeyondCanvas
-  class ApplicationController < ActionController::Base
+  class ApplicationController < ActionController::Base # :nodoc:
     protect_from_forgery with: :exception
 
     include ::BeyondCanvas::StatusCodes

data/app/controllers/beyond_canvas/system_controller.rb

@@ -3,7 +3,7 @@
 require_dependency 'beyond_canvas/application_controller'
 
 module BeyondCanvas
-  class SystemController < ApplicationController
+  class SystemController < ApplicationController # :nodoc:
     include ::BeyondCanvas::LocaleManagement
 
     def update_locale

data/app/controllers/concerns/beyond_canvas/locale_management.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module BeyondCanvas
-  module LocaleManagement
+  module LocaleManagement # :nodoc:
     extend ActiveSupport::Concern
 
     included do
-      around_action :switch_locale, except: :update_locale
+      around_action :switch_locale, except: :update_locale # rubocop:disable Rails/LexicallyScopedActionFilter
     end
 
     private
@@ -15,6 +15,9 @@ module BeyondCanvas
     # browser compatible locale, sets the value to the cookie and set that locale as default locale.
     #
     def switch_locale(&action)
+      # NOTE: Check the HTTP_ACCEPT_LANGUAGE header to identify if the request comes from a browser or a server
+      return I18n.with_locale(I18n.default_locale, &action) if request.headers['HTTP_ACCEPT_LANGUAGE'].blank?
+
       unless valid_locale?(cookies[:locale])
         cookies[:locale] = { value: browser_compatible_locale, expires: 1.day.from_now }
       end

data/app/controllers/concerns/beyond_canvas/request_validation.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module BeyondCanvas
-  module RequestValidation
+  module RequestValidation # :nodoc:
     extend ActiveSupport::Concern
 
     private
@@ -12,10 +14,10 @@ module BeyondCanvas
 
     def app_installation_params?
       if params[:code].nil? ||
-        params[:signature].nil? ||
-        params[:return_url].nil? ||
-        params[:api_url].nil? ||
-        params[:access_token_url].nil?
+         params[:signature].nil? ||
+         params[:return_url].nil? ||
+         params[:api_url].nil? ||
+         params[:access_token_url].nil?
         false
       else
         true

data/app/controllers/concerns/beyond_canvas/status_codes.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module BeyondCanvas
-  module StatusCodes
+  module StatusCodes # :nodoc:
     extend ActiveSupport::Concern
 
     private
 
     def bad_request
-      raise ActionController::BadRequest.new 'Bad Request'
+      raise ActionController::BadRequest, 'Bad Request'
     end
 
     def not_found
-      raise ActionController::RoutingError.new 'Not Found'
+      raise ActionController::RoutingError, 'Not Found'
     end
   end
 end

data/app/form_builders/beyond_canvas/form_builder.rb

@@ -1,23 +1,44 @@
 # frozen_string_literal: true
 
 module BeyondCanvas
-  class FormBuilder < ActionView::Helpers::FormBuilder
+  class FormBuilder < ActionView::Helpers::FormBuilder # :nodoc:
+    ############################################################################
+    # Wrappers
+    ############################################################################
+
     def field_wrapper(attribute, args, &block)
-      label = args[:label].present? ? args[:label] : attribute.to_s.humanize
+      label = args[:label] == false ? nil : args[:label].presence || attribute.to_s.humanize
 
       errors = object.errors[attribute].join(', ') if object.respond_to?(:errors) && object.errors.include?(attribute)
 
       @template.content_tag(:div, class: 'form__row') do
         @template.content_tag(:label, label, class: 'input__label') +
-          @template.content_tag(:div, class: 'relative') do
-            block.call +
-              (@template.content_tag(:label, errors, class: 'input__error') unless errors.blank?)
-          end +
-          (@template.content_tag(:div, args[:hint].html_safe, class: 'input__hint') if args[:hint].present?)
+        @template.content_tag(:div, class: 'relative') do
+          block.call +
+            (@template.content_tag(:label, errors, class: 'input__error') if errors.present?)
+        end +
+        (@template.content_tag(:div, args[:hint].html_safe, class: 'input__hint') if args[:hint].present?)
       end
     end
 
-    [:email, :text, :number, :password].each do |method|
+    def inline_wrapper(attribute, args, &block)
+      label = args[:label] == false ? nil : args[:label].presence || attribute.to_s.humanize
+
+      errors = object.errors[attribute].join(', ') if object.respond_to?(:errors) && object.errors.include?(attribute)
+
+      @template.content_tag(:div, class: 'form__row') do
+        @template.content_tag(:div, class: 'relative', style: 'display: flex; align-items: center;') do
+          block.call +
+            @template.content_tag(:div) do
+              @template.content_tag(:label, label, class: 'input__label') +
+              (@template.content_tag(:div, args[:hint].html_safe, class: 'input__hint') if args[:hint].present?)
+            end +
+            (@template.content_tag(:label, errors, class: 'input__error') if errors.present?)
+        end
+      end
+    end
+
+    %i[email text number password].each do |method|
       define_method :"#{method}_field" do |attribute, args = {}|
         field_wrapper(attribute, args) do
           super(attribute, args)
@@ -25,9 +46,39 @@ module BeyondCanvas
       end
     end
 
+    def check_box(attribute, args = {})
+      inline_wrapper(attribute, args) do
+        filed_identifyer = filed_identifyer(attribute)
+
+        args.merge!(id: filed_identifyer)
+            .merge!(hidden: true)
+
+        @template.content_tag(:div, class: 'input__checkbox') do
+          super(attribute, args) +
+            @template.content_tag(:label, nil, class: 'input__checkbox__control', for: filed_identifyer)
+        end
+      end
+    end
+
+    def radio_button(attribute, value, args = {})
+      args.merge!(label: value) unless args[:label]
+
+      inline_wrapper(attribute, args) do
+        filed_identifyer = filed_identifyer(attribute)
+
+        args.merge!(id: filed_identifyer)
+            .merge!(hidden: true)
+
+        @template.content_tag(:div, class: 'input__radio') do
+          super(attribute, value, args) +
+            @template.content_tag(:label, nil, class: 'input__radio__control', for: filed_identifyer)
+        end
+      end
+    end
+
     def file_field(attribute, args = {})
       field_wrapper(attribute, args) do
-        filed_identifyer = "#{attribute}_#{(Time.now.to_f * 1000).to_i.to_s}"
+        filed_identifyer = filed_identifyer(attribute)
 
         args.merge!(id: filed_identifyer)
             .merge!(hidden: true)
@@ -37,12 +88,22 @@ module BeyondCanvas
 
         @template.content_tag(:div, class: 'input__file') do
           super(attribute, args) +
-          @template.content_tag(:label, for: filed_identifyer, class: 'input__file__label button__transparent--primary') do
-            args[:data][:button_text] || 'Choose file'
-          end +
-          @template.content_tag(:span, args[:data][:no_file_text] || 'No file chosen', class: "input__file__text #{filed_identifyer}")
+            @template.content_tag(:label,
+                                  for: filed_identifyer,
+                                  class: 'input__file__control button__transparent--primary') do
+              args[:data][:button_text] || 'Choose file'
+            end +
+            @template.content_tag(:span,
+                                  args[:data][:no_file_text] || 'No file chosen',
+                                  class: "input__file__text #{filed_identifyer}")
         end
       end
     end
+
+    private
+
+    def filed_identifyer(attribute)
+      "#{attribute}_#{DateTime.now.strftime('%Q') + rand(10_000).to_s}"
+    end
   end
 end

data/app/helpers/beyond_canvas/application_helper.rb

@@ -1,14 +1,9 @@
 # frozen_string_literal: true
 
 module BeyondCanvas
-  module ApplicationHelper
+  module ApplicationHelper # :nodoc:
     def full_title(page_title = '')
-      if I18n.exists?('app_name')
-        base_title = I18n.t('app_name')
-      else
-        logger.debug "[BeyondCanvas] Missing translation: #{I18n.locale}.app_name".yellow
-        base_title = File.basename(Rails.root).humanize
-      end
+      base_title = BeyondCanvas.configuration.site_title
 
       page_title.empty? ? base_title : page_title + ' | ' + base_title
     end
@@ -27,7 +22,7 @@ module BeyondCanvas
       end
     end
 
-    [:success, :info, :warning, :error].each do |method|
+    %i[success info warning error].each do |method|
       define_method :"notice_#{method}" do |name = nil, html_options = nil, &block|
         notice_render(method, name, html_options, &block)
       end
@@ -45,29 +40,33 @@ module BeyondCanvas
 
     def get_flash_icon(key)
       case key
-      when 'success'
-        'fas fa-check'
+      when 'success', 'notice'
+        inline_svg_tag 'icons/flash_checkbox.svg'
       when 'info'
-        'fas fa-info-circle'
+        inline_svg_tag 'icons/flash_info.svg'
       when 'warning'
-        'fas fa-exclamation-circle'
+        inline_svg_tag 'icons/flash_warning.svg'
       when 'error'
-        'far fa-times-circle'
+        inline_svg_tag 'icons/flash_error.svg'
       else
-        'fas fa-info'
+        inline_svg_tag 'icons/flash_info.svg'
       end
     end
 
     def notice_render(method, name = nil, html_options = nil, &block)
-      html_options, name = name, block if block_given?
+      if block_given?
+        html_options = name
+        name = block
+      end
 
       html_options ||= {}
 
-      html_options.merge!(class: "notice notice--#{method}") { |key, old_val, new_val| [new_val, old_val].join(' ') }
+      html_options.merge!(class: "notice notice--#{method}") { |_key, old_val, new_val| [new_val, old_val].join(' ') }
 
       content_tag('div', html_options) do
-        content_tag('i', nil, class: "notice__icon #{get_flash_icon(method.to_s)}") +
-        content_tag('span', block_given? ? capture(&name) : name, class: 'notice__content')
+        content_tag('div', class: 'notice__icon') do
+          get_flash_icon(method.to_s)
+        end + content_tag('span', block_given? ? capture(&name) : name, class: 'notice__content')
       end
     end
   end

data/app/helpers/beyond_canvas/locale_switch_helper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module BeyondCanvas
-  module LocaleSwitchHelper
+  module LocaleSwitchHelper # :nodoc:
     def translate_locale(locale)
       if I18n.exists?("locales.#{locale}")
         I18n.t("locales.#{locale}")

data/app/javascript/beyond_canvas/base.js

@@ -0,0 +1,3 @@
+import './initializers/buttons';
+import './initializers/flash';
+import './initializers/inputs';

data/app/javascript/beyond_canvas/initializers/buttons.js

@@ -0,0 +1,54 @@
+import { disableActionElements, enableActionElements, hideSpinner, showSpinner } from './functions';
+
+(function ($) {
+  const onDOMReady = function () {
+    const inputs = $('input, textarea, select').not(':input[type=button], :input[type=submit], :input[type=reset]');
+
+    inputs.each(function () {
+      var input = $(this);
+
+      input.bind('invalid', function (e) {
+        if ($(input).is(':hidden')) {
+          e.preventDefault();
+        }
+        hideSpinner();
+        enableActionElements();
+      });
+    });
+
+    $('button[class^="button"]').each(function () {
+      var button = $(this);
+
+      // Add width attribute and save old width
+      button.width(button.width());
+      button.data('oldWidth', button.width());
+
+      // Add the spinner
+      button.prepend(`
+        <div class="spinner">
+          <div class="bounce1"></div>
+          <div class="bounce2"></div>
+          <div class="bounce3"></div>
+        </div>`);
+
+      // Bind ajax:success and ajax:error to the form the button belongs to
+      button
+        .closest('form')
+        .on('ajax:success', function () {
+          hideSpinner();
+          enableActionElements();
+        })
+        .on('ajax:error', function () {
+          hideSpinner();
+          enableActionElements();
+        });
+    });
+  };
+
+  $(document).on('click', '[class^="button"]', function () {
+    disableActionElements();
+    showSpinner($(this));
+  });
+
+  $(document).on('ready page:load turbolinks:load', onDOMReady);
+})(jQuery);

data/app/javascript/beyond_canvas/initializers/flash.js

@@ -0,0 +1,19 @@
+import { closeAlert } from './functions';
+
+(function ($) {
+  const onDOMReady = function () {
+    $('.flash').each(function () {
+      $(this).css('right', -$(this).width() + 'px');
+    });
+
+    setTimeout(function () {
+      $('.flash').addClass('flash--shown');
+    }, 100);
+  };
+
+  $(document).on('click', '.flash', function () {
+    closeAlert();
+  });
+
+  $(document).on('ready page:load turbolinks:load', onDOMReady);
+})(jQuery);

data/app/javascript/beyond_canvas/initializers/functions.js

@@ -0,0 +1,41 @@
+const SPINNER_ANIMATION_TIMEOUT = 125;
+
+export function showSpinner(button) {
+  // Adjust the width of the button
+  button.width(button.width() + $('.spinner').outerWidth(true));
+  // Show the spinner
+  setTimeout(function () {
+    button.find('.spinner').css('display', 'flex');
+  }, SPINNER_ANIMATION_TIMEOUT);
+}
+
+export function hideSpinner() {
+  $('button[class^="button"]').each(function (_, button) {
+    setTimeout(function () {
+      // Hide the spinner
+      $(button).find('.spinner').hide();
+      // Adjust the width of the button
+      $(button).width($(button).data('oldWidth'));
+    }, SPINNER_ANIMATION_TIMEOUT);
+  });
+}
+
+export function disableActionElements() {
+  $('a, input[type="submit"], input[type="button"], input[type="reset"], button').each(function (_, button) {
+    $(button).addClass('actions--disabled');
+  });
+}
+export function enableActionElements() {
+  $('a, input[type="submit"], input[type="button"], input[type="reset"], button').each(function (_, button) {
+    $(button).removeClass('actions--disabled');
+  });
+}
+
+export function closeAlert() {
+  $('.flash')
+    .removeClass('flash--shown')
+    .delay(700)
+    .queue(function () {
+      $(this).remove();
+    });
+}