beyond_canvas 0.22.0.pre → 0.23.0.pre

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module BeyondCanvas
+  module CustomStyles
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :check_custom_styles!, if: -> { BeyondCanvas.configuration.cockpit_app } # rubocop:disable Rails/LexicallyScopedActionFilter
+    end
+
+    private
+
+    #
+    # Checks if the custom styles url set on `custom_styles_url` cookie is valid. If it's not, it generates a new custom
+    # styles url and stores it on `custom_styles_url` cookie.
+    #
+    def check_custom_styles!
+      return if valid_custom_styles_stylesheet?(cookies[:custom_styles_url])
+
+      set_custom_styles_url
+    end
+
+    #
+    # Validates if the `custom_styles_url` cookie is set and if it's a valid url.
+    #
+    def valid_custom_styles_stylesheet?(custom_styles_url)
+      custom_styles_url.present? && existing_url?(custom_styles_url)
+    end
+
+    #
+    # Checks if the given url exists.
+    #
+    def existing_url?(url)
+      URI.open(url).status.first.to_i.between?(200, 299)
+    rescue
+      false
+    end
+
+    #
+    # Stores a newly generated custom_styles_url on the cookie.
+    #
+    def set_custom_styles_url(shop = nil)
+      shop ||= current_shop
+
+      return if shop.blank?
+
+      reseller = shop.to_session.shop.current[:reseller_name]
+
+      cookies[:custom_styles_url] = {
+        value: shop.url("cockpit/assets/reseller-styles/#{reseller}-variables.css")
+      }.merge COOKIES_ATTRIBUTES
+    end
+  end
+end

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

@@ -16,7 +16,9 @@ module BeyondCanvas
     #
     def switch_locale(&action)
       unless valid_locale?(cookies[:locale])
-        cookies[:locale] = { value: browser_compatible_locale, expires: 1.day.from_now }
+        cookies[:locale] = {
+          value: app_locale,
+        }.merge COOKIES_ATTRIBUTES
       end
 
       I18n.with_locale(cookies[:locale], &action)
@@ -24,6 +26,34 @@ module BeyondCanvas
       logger.debug "[BeyondCanvas] Locale set to: #{cookies[:locale]}".yellow if debug_mode?
     end
 
+    #
+    # Checks if the given locale parameter is included on +I18n.available_locales+
+    #
+    def valid_locale?(locale)
+      I18n.available_locales.map(&:to_s).include? locale
+    end
+
+    #
+    # If it is a cockpit app, it returns the shop default locale.
+    # Otherwise it returns the browser compatible locale.
+    #
+    # @return [String] the local that the app will use (e.g. +'en-GB'+)
+    #
+    def app_locale
+      BeyondCanvas.configuration.cockpit_app ? shop_locale : browser_compatible_locale
+    end
+
+    #
+    # Retrieves the shop default locale from the Beyond API.
+    #
+    # @return [String] the shop default locale (e.g. +'en-GB'+)
+    #
+    def shop_locale
+      BeyondApi::Session.new(api_url: current_shop.beyond_api_url).shop.current.default_locale
+    rescue
+      browser_compatible_locale
+    end
+
     #
     # Reads the +HTTP_ACCEPT_LANGUAGE+ header and searches a compatible locale
     # on +I18n.available_locales+. If no compatible language is found, it
@@ -44,12 +74,5 @@ module BeyondCanvas
     rescue
       I18n.default_locale
     end
-
-    #
-    # Checks if the given locale parameter is included on +I18n.available_locales+
-    #
-    def valid_locale?(locale)
-      I18n.available_locales.map(&:to_s).include? locale
-    end
   end
 end

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

@@ -33,5 +33,11 @@ module BeyondCanvas
       hmac = OpenSSL::HMAC.digest(digest, secret, data)
       URI.decode(signature) == Base64.encode64(hmac).chop
     end
+
+    def signature_params
+      data = URI.parse(request.original_url).to_s
+      data << ":#{request.body.read}" if request.body.read.present?
+      data
+    end
   end
 end

data/app/form_builders/beyond_canvas/form_builder.rb

@@ -2,38 +2,6 @@
 
 module BeyondCanvas
   class FormBuilder < ActionView::Helpers::FormBuilder # :nodoc:
-    def field_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(:label, label, class: 'input__label') +
-        @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
-
-    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_field text_field number_field password_field text_area].each do |method|
       define_method method do |attribute, args = {}|
         field_wrapper(attribute, args) do
@@ -42,39 +10,41 @@ module BeyondCanvas
       end
     end
 
-    def select(attribute, choices, options  = {}, args = {})
+    def select(attribute, choices, options = {}, args = {})
       field_wrapper(attribute, args) do
         super(attribute, choices, options, args)
       end
     end
 
-    def check_box(attribute, args = {})
-      inline_wrapper(attribute, args) do
-        filed_identifyer = filed_identifyer(attribute)
+    def check_box(attribute, args = {}, checked_value = '1', unchecked_value = '0')
+      filed_identifyer = filed_identifyer(attribute)
 
+      inline_wrapper(attribute, args, filed_identifyer) do
         args.merge!(id: filed_identifyer)
             .merge!(hidden: true)
+            .merge!(class: 'input__checkbox')
 
-        @template.content_tag(:div, class: 'input__checkbox') do
-          super(attribute, args) +
-            @template.content_tag(:label, nil, class: 'input__checkbox__control', for: filed_identifyer)
-        end
+        super(attribute, args, checked_value, unchecked_value) +
+          @template.content_tag(:label, class: 'input__checkbox__control', for: filed_identifyer) do
+            @template.inline_svg_tag('icons/checkbox_checked.svg', style: 'display: none;', class: 'input__checkbox--checked') +
+            @template.inline_svg_tag('icons/checkbox_unchecked.svg', style: 'display: none;', class: 'input__checkbox--unchecked')
+          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)
+      filed_identifyer = filed_identifyer(attribute)
 
+      inline_wrapper(attribute, args, filed_identifyer) do
         args.merge!(id: filed_identifyer)
             .merge!(hidden: true)
+            .merge!(class: 'input__radio')
 
-        @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
+        super(attribute, value, args) +
+          @template.content_tag(:label, class: 'input__radio__control', for: filed_identifyer) do
+            @template.inline_svg_tag('icons/radiobutton_checked.svg', style: 'display: none;', class: 'input__radio--checked') +
+            @template.inline_svg_tag('icons/radiobutton_unchecked.svg', style: 'display: none;', class: 'input__radio--unchecked')
+          end
       end
     end
 
@@ -83,7 +53,7 @@ module BeyondCanvas
         filed_identifyer = filed_identifyer(attribute)
 
         args.merge!(id: filed_identifyer)
-            .merge!(hidden: true)
+            .merge!(style: 'visibility: hidden; position: absolute;')
 
         custom_attributes = { data: { multiple_selection_text: '{count} files selected' } }
         args = custom_attributes.merge!(args)
@@ -104,6 +74,49 @@ module BeyondCanvas
 
     private
 
+    def field_wrapper(attribute, args, &block)
+      label = args.delete(:label)&.html_safe
+      hint = args.delete(:hint)&.html_safe
+      pre = args.delete(:pre)
+      post = args.delete(:post)
+
+      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') if label.present?),
+          (@template.content_tag(:div, class: 'relative', style: "#{'display: flex;' if pre || post}") do
+            [
+              (@template.content_tag(:span, pre, class: 'input__pre') if pre.present?),
+              (@template.content_tag(:span, post, class: 'input__post') if post.present?),
+              block.call,
+              (@template.content_tag(:label, errors, class: 'input__error') if errors.present?)
+            ].compact.inject(:+)
+          end),
+          (@template.content_tag(:div, hint, class: 'input__hint') if hint.present?)
+        ].compact.inject(:+)
+      end
+    end
+
+    def inline_wrapper(attribute, args, filed_identifyer, &block)
+      label = args.delete(:label)&.html_safe
+      hint = args.delete(:hint)&.html_safe
+      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", for: filed_identifyer) if label.present?),
+                (@template.content_tag(:label, hint, class: 'input__hint', for: filed_identifyer) if hint.present?)
+              ].compact.inject(:+)
+            end if label.present? || hint.present?) +
+            (@template.content_tag(:label, errors, class: 'input__error') if errors.present?)
+        end
+      end
+    end
+
     def filed_identifyer(attribute)
       "#{attribute}_#{DateTime.now.strftime('%Q') + rand(10_000).to_s}"
     end

data/app/helpers/beyond_canvas/application_helper.rb

@@ -28,11 +28,13 @@ module BeyondCanvas
       end
     end
 
-    def logo_image_tag(logo_path)
+    def logo_image_tag(logo_path, options = {})
+      html_options = { class: 'logo', alt: 'logo' }.merge options
+
       if File.extname(logo_path) == '.svg'
-        inline_svg_tag logo_path, class: 'logo', alt: 'logo'
+        inline_svg_tag logo_path, html_options
       else
-        image_tag logo_path, class: 'logo', alt: 'logo'
+        image_tag logo_path, html_options
       end
     end
 
@@ -44,7 +46,7 @@ module BeyondCanvas
       html_options.merge!(id: id)
 
       content_tag('div', class: 'collapse') do
-        content_tag('a', class: 'collapse__button', data: { toggle: 'collapse', target: "##{id}" }) do
+        content_tag('a', class: 'collapse__button', title: name, data: { toggle: 'collapse', target: "##{id}" }) do
           (inline_svg_tag('icons/arrow_right.svg', class: 'collapse__icon') + name).html_safe
         end +
         content_tag('div', html_options) do
@@ -53,6 +55,27 @@ module BeyondCanvas
       end
     end
 
+    def step_list(title, steps = [])
+      content_tag('div', class: 'step-list__container') do
+        content_tag('h4', title, class: 'step-list__title') +
+        content_tag('table', class: 'step-list__items') do
+          content_tag('tbody') do
+            steps.each_with_index.collect do |step, index|
+              content_tag('tr') do
+                content_tag('td', class: 'step-list__bubble-column') do
+                  content_tag('div', index + 1, class: 'step-list__bubble')
+                end +
+                content_tag('td') do
+                  content_tag('strong', step.dig(:headline)&.html_safe, class: 'step-list__headline') +
+                  content_tag('p', step.dig(:description)&.html_safe, class: 'step-list__description')
+                end
+              end
+            end.join.html_safe
+          end
+        end
+      end
+    end
+
     private
 
     def unique_id(attribute)

data/app/helpers/beyond_canvas/form_tag_helper.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module BeyondCanvas
+  module FormTagHelper
+    %i[email_field_tag text_field_tag password_field_tag text_area_tag].each do |method|
+      define_method method do |name, value = nil, options = {}|
+        field_wrapper(name, options) do
+          super(name, value, options)
+        end
+      end
+    end
+
+    def select_tag(name, option_tags = nil, options = {})
+      field_wrapper(name, options) do
+        super(name, option_tags, options)
+      end
+    end
+
+    def check_box_tag(name, value = 1, checked = false, options = {})
+      filed_identifyer = filed_identifyer(name)
+
+      inline_wrapper(name, options, filed_identifyer) do
+
+        options.merge!(id: filed_identifyer)
+               .merge!(hidden: true)
+               .merge!(class: 'input__checkbox')
+
+        super(name, value, checked, options) +
+          content_tag(:label, class: 'input__checkbox__control', for: filed_identifyer) do
+            inline_svg_tag('icons/checkbox_checked.svg', style: 'display: none;', class: 'input__checkbox--checked') +
+            inline_svg_tag('icons/checkbox_unchecked.svg', style: 'display: none;', class: 'input__checkbox--unchecked')
+          end
+      end
+    end
+
+    def radio_button_tag(name, value, checked = false, options = {})
+      filed_identifyer = filed_identifyer(name)
+
+      inline_wrapper(name, options, filed_identifyer) do
+
+        options.merge!(id: filed_identifyer)
+               .merge!(hidden: true)
+               .merge!(class: 'input__radio')
+
+        super(name, value, checked, options) +
+          content_tag(:label, class: 'input__radio__control', for: filed_identifyer) do
+            inline_svg_tag('icons/radiobutton_checked.svg', style: 'display: none;', class: 'input__radio--checked') +
+            inline_svg_tag('icons/radiobutton_unchecked.svg', style: 'display: none;', class: 'input__radio--unchecked')
+          end
+      end
+    end
+
+    def toggle_tag(name, value = 1, checked = false, options = {})
+      filed_identifyer = filed_identifyer(name)
+
+      inline_wrapper(name, options, filed_identifyer) do
+
+        options.merge!(id: filed_identifyer)
+               .merge!(hidden: true)
+               .merge!(class: 'input__toggle')
+
+        html_options = { type: 'checkbox', name: name, value: value }.update(options.stringify_keys)
+        html_options['checked'] = 'checked' if checked
+
+        tag(:input, html_options) +
+          content_tag(:label, class: 'input__toggle__control', for: filed_identifyer) do
+            inline_svg_tag('icons/toggle.svg')
+          end
+      end
+    end
+
+    def hidden_field_tag(name, value = nil, options = {})
+      tag :input, { type: :text, name: name, id: sanitize_to_id(name), value: value }.update(options.stringify_keys.merge(type: :hidden))
+    end
+
+    def number_field_tag(name, value = nil, options = {})
+      field_wrapper(name, options) do
+        options = options.stringify_keys
+        if (range = options.delete('in') || options.delete('within'))
+          options.update(min: range.min, max: range.max)
+        end
+        tag :input, { type: 'number', name: name, id: sanitize_to_id(name), value: value }.update(options.stringify_keys)
+      end
+    end
+
+    private
+
+    def field_wrapper(attribute, args, &block)
+      label = args.delete(:label)&.html_safe
+      hint = args.delete(:hint)&.html_safe
+      pre = args.delete(:pre)
+      post = args.delete(:post)
+
+      content_tag(:div, class: 'form__row') do
+        [
+          (content_tag(:label, label, class: 'input__label') if label.present?),
+          (content_tag(:div, class: 'relative', style: "#{'display: flex;' if pre || post}") do
+            [
+              (content_tag(:span, pre, class: 'input__pre') if pre.present?),
+              (content_tag(:span, post, class: 'input__post') if post.present?),
+              block.call
+            ].compact.inject(:+)
+          end),
+          (content_tag(:div, hint, class: 'input__hint') if hint.present?)
+        ].compact.inject(:+)
+      end
+    end
+
+    def inline_wrapper(attribute, args, filed_identifyer, &block)
+      label = args.delete(:label)&.html_safe
+      hint = args.delete(:hint)&.html_safe
+
+      content_tag(:div, class: 'form__row') do
+        content_tag(:div, class: 'relative', style: 'display: flex; align-items: center;') do
+          block.call +
+            (content_tag(:div) do
+              [
+                (content_tag(:label, label, class: "input__label", for: filed_identifyer) if label.present?),
+                (content_tag(:label, hint, class: 'input__hint', for: filed_identifyer) if hint.present?)
+              ].compact.inject(:+)
+            end if label.present? || hint.present?)
+        end
+      end
+    end
+
+    def filed_identifyer(attribute)
+      "#{attribute.to_s.delete('[]')}_#{DateTime.now.strftime('%Q') + rand(10_000).to_s}"
+    end
+  end
+end