promethee 3.0.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4dd94a544973da8049159835435db08a39398db7
-  data.tar.gz: 7a388c762c9f50e1654a0e8263bbe68887d622b4
+SHA256:
+  metadata.gz: 9919911b70d645a32c0cc7cb303e88e358964153829f76747dd62b2acbafc8f8
+  data.tar.gz: f72bac7ccb51c4c55686bdafe41997d8d6d366f0f00861127ed593786d90938a
 SHA512:
-  metadata.gz: 8cf7dde5e3e44eecce1a485107bcd9809db1da80968380bb636038c5e3fc5fb8f0ed9f6fa0a66e7ff0ff0f9db9eac78cbb817a5463343ebed583086fd79dac34
-  data.tar.gz: cca97c58406b7b5f32ce3a0b2c1203a3140fad8802077f995f3dbd3fef51997fa5abf4aeee56c70f87daf5b7479cac60acb74f6b7b94b3532a483afee8c78c35
+  metadata.gz: 53817f67399c99bd21ba4f2e01c276fc4ef0dc80c62f9c3f7a17e25bc6f73d6cb7758983e2990457672d35042623ddd7f476394be8be36249b552e39a7e76d5c
+  data.tar.gz: 6832ef6057efface08ee81ee0db720bf9534df96637b34b3cebd703f849b0c1b3d483b94417ae6ed27c66846e520593e0492e3d6d161e3d087ecd2eb81281bf0

data/UPGRADING

@@ -1,8 +1,8 @@
 ###################################
-#  NOTE FOR UPGRADING TO 3.x.x  #
+#  NOTE FOR UPGRADING TO 4.x.x  #
 ###################################
 
-In Prométhée 3.0, the access to ActiveStorage blobs is now with signed IDs instead of simple IDs.
+In Prométhée 4.0, to apply the correct sanitization process, every attribute has an explicit type.
 A rake task is available to upgrade your data.
 
 For more details, check the documentation:

data/app/assets/stylesheets/promethee-edit.sass

@@ -10,3 +10,4 @@ $promethee-color: #ff9900 !default
 @import 'promethee-edit/move'
 @import 'promethee-edit/preview'
 @import 'promethee-edit/summernote'
+@import 'promethee-edit/localizer'

data/app/assets/stylesheets/promethee-edit/_localizer.sass

@@ -0,0 +1,4 @@
+.promethee-localizer
+    .reference-choice
+        min-width: 200px
+        width: auto

data/app/models/concerns/promethee_data.rb

@@ -4,51 +4,57 @@ module PrometheeData
   # Setter to serialize data as JSON
   def data=(value)
     value = JSON.parse value if value.is_a? String
-    value = promethee_sanitize(value)
+
+    if value.has_key? 'components'
+      # For translations, contents are in components, not children
+      value['components'].map { |component| promethee_sanitize(component) }
+    else
+      # For masters, contents are in children
+      value = promethee_sanitize(value)
+    end
     super(value)
   end
 
   # Getters and setters to get PAGE Title, Description & Thumbnail
   def promethee_data_page_title
-    data['attributes']['searchable_title']
+    data['attributes']['title']['value']
   rescue
     ''
   end
 
   def promethee_data_page_title=(value)
-    self.data['attributes']['searchable_title'] = value
+    self.data['attributes']['title']['value'] = value
   end
 
   def promethee_data_page_description
-    data['attributes']['searchable_description']
+    data['attributes']['description']['value']
   rescue
     ''
   end
 
   def promethee_data_page_description=(value)
-    self.data['attributes']['searchable_description'] = value
+    self.data['attributes']['description']['value'] = value
   end
 
   def promethee_data_page_thumbnail
-    ActiveStorage::Blob.find_signed(data['attributes']['thumbnail']['id'])
+    ActiveStorage::Blob.find_signed(data['attributes']['thumbnail']['value']['id'])
   rescue
     nil
   end
 
   # Getters to get TRANSLATION Title & Description
   def promethee_data_translation_title
-    data['components'].first['attributes']['searchable_title']
+    data['components'].first['attributes']['title']['value']
   rescue
     ''
   end
 
   def promethee_data_translation_description
-    data['components'].first['attributes']['searchable_description']
+    data['components'].first['attributes']['description']['value']
   rescue
     ''
   end
 
-
   def promethee_data_searchable
     promethee_extract_searchable data
   end
@@ -62,20 +68,25 @@ module PrometheeData
     searchable = ' '
     searchable += promethee_extract_searchable_attributes component['attributes'] if component.include?('attributes')
     # For masters, contents are in children
-    searchable += promethee_extract_searchable_children component['children'] if component.include? 'children'
+    searchable += promethee_extract_searchable_children component['children'] if component.include?('children')
     # For translations, contents are in components, not children
-    searchable += promethee_extract_searchable_children component['components'] if component.include? 'components'
+    searchable += promethee_extract_searchable_children component['components'] if component.include?('components')
     searchable
   end
 
   def promethee_extract_searchable_attributes(attributes)
     searchable = ' '
-    attributes.each do |key, value|
-      if key.starts_with? 'searchable_'
-        clean_value = strip_tags value
+    attributes.each do |key, value_object|
+      if value_object['searchable']
+        clean_value = strip_tags value_object['value']
         searchable += "#{clean_value} "
-      elsif value.class == Hash
-        searchable += promethee_extract_searchable_attributes(value)
+      end
+      if value_object['type'] == 'array'
+        value_object['value'].each do |object|
+          searchable += promethee_extract_searchable_attributes(object)
+        end
+      elsif value_object['type'] == 'hash'
+        searchable += promethee_extract_searchable_attributes(value_object['value'])
       end
     end
     searchable
@@ -89,24 +100,36 @@ module PrometheeData
     searchable
   end
 
-  def promethee_sanitize(data)
-    return sanitize(data) if data.is_a? String
-
-    data.each do |key, value|
-      case value.class.to_s
-      when 'String'
-        data[key] = sanitize(value)
-      when 'Hash'
-        data[key] = promethee_sanitize(value)
-      when 'Array'
-        new_array = []
-        value.each do |element|
-          new_array << promethee_sanitize(element)
-        end
-        data[key] = new_array
-      end
-    end if data.respond_to? :each
+  def promethee_sanitize(component)
+    attributes = component['attributes']
+    attributes = promethee_sanitize_attributes(attributes)
+
+    children = component['children']
+    children.each do |child|
+      child = promethee_sanitize(child)
+    end unless children.nil?
+
+    component
+  end
 
-    data
+  def promethee_sanitize_attributes(attributes)
+    attributes.each do |key, value_object|
+      case value_object['type']
+      when 'string'
+        while value_object['value'] != Loofah.fragment(value_object['value']).text(encode_special_chars: false)
+          value_object['value'] = Loofah.fragment(value_object['value']).text(encode_special_chars: false)
+        end
+      when 'text'
+        value_object['value'] = sanitize(value_object['value'])
+      when 'hash'
+        value_object['value'] = promethee_sanitize_attributes(value_object['value'])
+      when 'array'
+        value_object['value'].each do |object|
+          object = promethee_sanitize_attributes(object)
+        end
+      end if value_object.has_key?('type')
+      attributes[key] = value_object
+    end unless attributes.nil?
+    attributes
   end
 end

data/app/services/promethee/structure_upgrader/components/aside.rb

@@ -0,0 +1,51 @@
+# Aside Component
+# ================
+#
+# V3
+# -----
+#
+# {
+#   searchable_visible_content: '<p>Edit me</p>',
+#   searchable_collapsed_content: '',
+#   searchable_open_label: 'See more',
+#   open_label_position: 'left'
+# }
+#
+
+module Promethee::StructureUpgrader::Components
+  class Aside < Base
+    def upgraded_attributes
+      {
+        'visible_content' => {
+          'searchable' => true,
+          'translatable' => true,
+          'type' => 'text',
+          'value' => attribute('searchable_visible_content')
+        },
+        'collapsed_content' => {
+          'searchable' => true,
+          'translatable' => true,
+          'type' => 'text',
+          'value' => attribute('searchable_collapsed_content')
+        },
+        'open_label' => {
+          'searchable' => true,
+          'translatable' => true,
+          'type' => 'string',
+          'value': string_attribute('searchable_open_label')
+        },
+        'open_label_position' => {
+          'collection' => [
+            { 'label' => 'Left', 'value' => 'left' },
+            { 'label' => 'Center', 'value' => 'center' },
+            { 'label' => 'Right', 'value' => 'right' }
+          ],
+          'searchable' => false,
+          'translatable' => false,
+          'type' => 'enum',
+          'value' => attribute('open_label_position')
+        }
+      }
+    end
+  end
+end

data/app/services/promethee/structure_upgrader/components/base.rb

@@ -0,0 +1,36 @@
+module Promethee::StructureUpgrader::Components
+  class Base
+    def initialize(data)
+      @data = data
+      # puts "<#{self.class}> Initialized."
+
+      upgrade
+    end
+
+    def upgraded_data
+      @upgraded_data
+    end
+
+    def upgrade
+      @upgraded_data = @data.deep_dup
+      return if @upgraded_data['attributes'].empty?
+
+      @upgraded_data['attributes'] = upgraded_attributes.deep_stringify_keys
+    end
+
+    def upgraded_attributes
+      raise NotImplementedError
+    end
+
+    protected
+
+    def string_attribute(*path)
+      text = attribute(*path)
+      Loofah.fragment(text).text(encode_special_chars: false)
+    end
+
+    def attribute(*path)
+      @data.dig('attributes', *path)
+    end
+  end
+end

data/app/services/promethee/structure_upgrader/components/blockquote.rb

@@ -0,0 +1,32 @@
+# Blockquote Component
+# ================
+#
+# V3
+# -----
+#
+# {
+#   searchable_body: '<p>Edit me</p>',
+#   searchable_author: ''
+# }
+#
+
+module Promethee::StructureUpgrader::Components
+  class Blockquote < Base
+    def upgraded_attributes
+      {
+        'body' => {
+          'searchable' => true,
+          'translatable' => true,
+          'type' => 'text',
+          'value' => attribute('searchable_body'),
+        },
+        'author' => {
+          'searchable' => true,
+          'translatable' => false,
+          'type' => 'string',
+          'value' => string_attribute('searchable_author')
+        }
+      }
+    end
+  end
+end

data/app/services/promethee/structure_upgrader/components/collection.rb

@@ -0,0 +1,31 @@
+# Collection Component
+# ================
+#
+# V3
+# -----
+#
+# {
+#   items_per_line: 6
+# }
+#
+
+module Promethee::StructureUpgrader::Components
+  class Collection < Base
+    def upgraded_attributes
+      {
+        'items_per_line' => {
+          'collection' => [
+            { 'label' => '2', 'value' => 2 },
+            { 'label' => '3', 'value' => 3 },
+            { 'label' => '4', 'value' => 4 },
+            { 'label' => '6', 'value' => 6 }
+          ],
+          'searchable' => false,
+          'translatable' => false,
+          'type' => 'enum',
+          'value' => attribute('items_per_line')
+        }
+      }
+    end
+  end
+end

data/app/services/promethee/structure_upgrader/components/collection_item.rb

@@ -0,0 +1,55 @@
+# Collection Item Component
+# ================
+#
+# V3
+# -----
+#
+# {
+#   searchable_caption: "",
+#   media_type: "image",
+#   image: {
+#     id: undefined,
+#     name: ""
+#   },
+#   video: {
+#     url: "https://vimeo.com/115082758"
+#   }
+# }
+#
+
+module Promethee::StructureUpgrader::Components
+  class CollectionItem < Base
+    def upgraded_attributes
+      {
+        'caption' => {
+          'searchable' => true,
+          'translatable' => true,
+          'type' => 'text',
+          'value' => attribute('searchable_caption')
+        },
+        'media_type' => {
+          'collection' => [
+            { 'label' => 'Image', 'value' => 'image' },
+            { 'label' => 'Video', 'value' => 'video' }
+          ],
+          'searchable' => false,
+          'translatable' => false,
+          'type' => 'enum',
+          'value' => attribute('media_type')
+        },
+        'image' => {
+          'searchable' => false,
+          'translatable' => false,
+          'type' => 'blob',
+          'value' => attribute('image')
+        },
+        'video' => {
+          'searchable' => false,
+          'translatable' => true,
+          'type' => 'video',
+          'value' => attribute('video', 'url')
+        }
+      }
+    end
+  end
+end

data/app/services/promethee/structure_upgrader/components/column.rb

@@ -0,0 +1,92 @@
+# Column Component
+# ================
+#
+# V3
+# -----
+#
+# {
+#   size: 4,
+#   offset: 0,
+#   mobile: {
+#     enabled: false,
+#     size: 12,
+#     offset: 0
+#   },
+#   tablet: {
+#     enabled: false,
+#     size: 12,
+#     offset: 0
+#   }
+# }
+#
+
+module Promethee::StructureUpgrader::Components
+  class Column < Base
+    def upgraded_attributes
+      {
+        'size' => {
+          'searchable' => false,
+          'translatable' => false,
+          'type' => 'integer',
+          'value' => attribute('size')
+        },
+        'offset' => {
+          'searchable' => false,
+          'translatable' => false,
+          'type' => 'integer',
+          'value' => attribute('offset')
+        },
+        'mobile' => {
+          'searchable' => false,
+          'translatable' => false,
+          'type' => 'hash',
+          'value' => {
+            'enabled' => {
+              'searchable' => false,
+              'translatable' => false,
+              'type' => 'boolean',
+              'value' => attribute('mobile', 'enabled')
+            },
+            'size' => {
+              'searchable' => false,
+              'translatable' => false,
+              'type' => 'integer',
+              'value' => attribute('mobile', 'size')
+            },
+            'offset' => {
+              'searchable' => false,
+              'translatable' => false,
+              'type' => 'integer',
+              'value' => attribute('mobile', 'offset')
+            }
+          }
+        },
+        'tablet' => {
+          'searchable' => false,
+          'translatable' => false,
+          'type' => 'hash',
+          'value' => {
+            'enabled' => {
+              'searchable' => false,
+              'translatable' => false,
+              'type' => 'boolean',
+              'value' => attribute('tablet', 'enabled')
+            },
+            'size' => {
+              'searchable' => false,
+              'translatable' => false,
+              'type' => 'integer',
+              'value' => attribute('tablet', 'size')
+            },
+            'offset' => {
+              'searchable' => false,
+              'translatable' => false,
+              'type' => 'integer',
+              'value' => attribute('tablet', 'offset')
+            }
+          }
+        }
+      }
+    end
+  end
+end