decidim-decidim_awesome 0.6.5 → 0.7.2

data/lib/decidim/decidim_awesome/custom_fields.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    class CustomFields
+      def initialize(fields)
+        @fields = if fields.respond_to? :map
+                    fields.map { |f| JSON.parse(f) }.flatten
+                  else
+                    JSON.parse(fields)
+                  end
+      end
+
+      attr_reader :fields, :xml, :errors, :data
+
+      def apply_xml(xml)
+        parse_xml(xml)
+        map_fields!
+      rescue StandardError => e
+        @errors = e.message
+      end
+
+      def to_json(*_args)
+        @fields
+      end
+
+      def translate!
+        translate_values!
+      end
+
+      private
+
+      def parse_xml(xml)
+        @xml = xml
+        @data = Nokogiri.XML(xml).xpath("//dl/dd")
+        return if @data.present?
+
+        apply_to_first_textarea
+      end
+
+      def map_fields!
+        return unless data
+
+        @fields.map! do |field|
+          if field["name"] # ignore headers/paragraphs
+            value = data.search("##{field["name"]} div")
+            field["userData"] = value.map { |v| v.attribute("alt")&.value || v.inner_html(encoding: "UTF-8") } if value.present?
+          end
+
+          field
+        end
+      end
+
+      # Finds the first textarea and applies non-xml compatible content
+      # when textarea has not wysiwyg assigned, strips html
+      def apply_to_first_textarea
+        # quill editor might leave html traces without any user content
+        # so we won't process it if there is no text (html free) result
+        text = Nokogiri.HTML(xml).html? ? Nokogiri.HTML(xml).text.strip : text.strip
+        return if text.blank?
+
+        textarea = @fields.find { |field| field["type"] == "textarea" }
+        @errors = I18n.t(".invalid_xml", scope: "decidim.decidim_awesome.custom_fields.errors")
+        return unless textarea
+
+        textarea["userData"] = [textarea["subtype"] == "textarea" ? text : xml]
+        @errors = I18n.t(".invalid_fields", scope: "decidim.decidim_awesome.custom_fields.errors", field: textarea["label"] || textarea["name"])
+      end
+
+      def translate_values!
+        deep_transform_values!(@fields) do |value|
+          next value unless value.is_a? String
+          next value unless (match = value.match(/^(.*\..*)$/))
+
+          I18n.t(match[1], raise: true)
+        rescue I18n::MissingTranslationData
+          value
+        end
+        @fields
+      end
+
+      def deep_transform_values!(object, &block)
+        case object
+        when Hash
+          object.transform_values! { |value| deep_transform_values!(value, &block) }
+        when Array
+          object.map! { |e| deep_transform_values!(e, &block) }
+        else
+          yield(object)
+        end
+      end
+    end
+  end
+end

data/lib/decidim/decidim_awesome/engine.rb

@@ -8,30 +8,86 @@ module Decidim
   module DecidimAwesome
     # This is the engine that runs on the public interface of decidim_awesome.
     class Engine < ::Rails::Engine
+      include AwesomeHelpers
+
       isolate_namespace Decidim::DecidimAwesome
 
       routes do
         post :editor_images, to: "editor_images#create"
       end
 
+      initializer "decidim.middleware" do |app|
+        app.config.middleware.insert_after Decidim::CurrentOrganization, Decidim::DecidimAwesome::CurrentConfig
+      end
+
+      # Prepare a zone to create overrides
+      # https://edgeguides.rubyonrails.org/engines.html#overriding-models-and-controllers
+      # overrides
+      config.to_prepare do
+        if DecidimAwesome.config[:scoped_admins] != :disabled
+          # override user's admin property
+          Decidim::User.include(UserOverride)
+          # redirect unauthorized scoped admins to allowed places
+          Decidim::ErrorsController.include(AdminNotFoundRedirect)
+        end
+
+        Decidim::Proposals::ApplicationHelper.include(Decidim::DecidimAwesome::Proposals::ApplicationHelperOverride)
+        Decidim::AmendmentsHelper.include(Decidim::DecidimAwesome::AmendmentsHelperOverride)
+
+        # TODO: move to include overrides
+        Dir.glob("#{Engine.root}/app/awesome_overrides/**/*_override.rb").each do |override|
+          require_dependency override
+        end
+      end
+
       initializer "decidim_awesome.view_helpers" do
-        ActionView::Base.send :include, AwesomeHelpers
+        ActionView::Base.include AwesomeHelpers
       end
 
       initializer "decidim_decidim_awesome.assets" do |app|
-        app.config.assets.precompile += %w(decidim_decidim_awesome_manifest.js decidim_decidim_awesome_manifest.css)
+        app.config.assets.precompile += if version_prefix == "v0.23"
+                                          %w(legacy_decidim_decidim_awesome_manifest.js decidim_decidim_awesome_manifest.css)
+                                        else
+                                          %w(decidim_decidim_awesome_manifest.js decidim_decidim_awesome_manifest.css)
+                                        end
         # add to precompile any present theme asset
-        Dir.glob(Rails.root.join("app", "assets", "themes", "*.*")).each do |path|
+        Dir.glob(Rails.root.join("app/assets/themes/*.*")).each do |path|
           app.config.assets.precompile << path
         end
       end
 
-      # Prepare a zone to create overrides
-      # https://edgeguides.rubyonrails.org/engines.html#overriding-models-and-controllers
-      config.to_prepare do
-        Dir.glob("#{Engine.root}/app/awesome_overrides/**/*_override.rb").each do |override|
-          require_dependency override
+      initializer "decidim_decidim_awesome.add_cells_view_paths" do
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::DecidimAwesome::Engine.root}/app/cells")
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::DecidimAwesome::Engine.root}/app/views")
+      end
+
+      initializer "decidim_decidim_awesome.content_blocks" do |_app|
+        # === Home Map block ===
+        Decidim.content_blocks.register(:homepage, :awesome_map) do |content_block|
+          content_block.cell = "decidim/decidim_awesome/content_blocks/map"
+          content_block.settings_form_cell = "decidim/decidim_awesome/content_blocks/map_form"
+          content_block.public_name_key = "decidim.decidim_awesome.content_blocks.map.name"
+
+          content_block.settings do |settings|
+            settings.attribute :title, type: :text, translated: true
+
+            settings.attribute :map_height, type: :integer, default: 500
+            settings.attribute :map_center, type: :string, default: ""
+            settings.attribute :map_zoom, type: :integer, default: 8
+            settings.attribute :truncate, type: :integer, default: 255
+            settings.attribute :collapse, type: :boolean, default: false
+            settings.attribute :menu_amendments, type: :boolean, default: true
+            settings.attribute :menu_meetings, type: :boolean, default: true
+            settings.attribute :menu_hashtags, type: :boolean, default: true
+
+            settings.attribute :show_not_answered, type: :boolean, default: true
+            settings.attribute :show_accepted, type: :boolean, default: true
+            settings.attribute :show_withdrawn, type: :boolean, default: false
+            settings.attribute :show_evaluating, type: :boolean, default: true
+            settings.attribute :show_rejected, type: :boolean, default: false
+          end
         end
+        # === TODO: processes groups map block ===
       end
     end
   end

data/lib/decidim/decidim_awesome/iframe_component/component.rb

@@ -43,7 +43,7 @@ Decidim.register_component(:awesome_iframe) do |component|
       published_at: Time.current,
       participatory_space: participatory_space,
       settings: {
-        announcement: { en: Faker::Lorem.paragraphs(2).join("\n") }
+        announcement: { en: Faker::Lorem.paragraphs(number: 2).join("\n") }
       }
     }
 

data/lib/decidim/decidim_awesome/map_component/component.rb

@@ -16,7 +16,13 @@ Decidim.register_component(:awesome_map) do |component|
     # Available types: :integer, :boolean
     settings.attribute :announcement, type: :text, translated: true, editor: true
     settings.attribute :map_height, type: :integer, default: 700
+    settings.attribute :map_center, type: :string, default: ""
+    settings.attribute :map_zoom, type: :integer, default: 8
+    settings.attribute :truncate, type: :integer, default: 255
     settings.attribute :collapse, type: :boolean, default: false
+    settings.attribute :menu_amendments, type: :boolean, default: true
+    settings.attribute :menu_meetings, type: :boolean, default: true
+    settings.attribute :menu_hashtags, type: :boolean, default: true
   end
 
   component.settings(:step) do |settings|
@@ -26,7 +32,7 @@ Decidim.register_component(:awesome_map) do |component|
     settings.attribute :show_evaluating, type: :boolean, default: true
     settings.attribute :show_accepted, type: :boolean, default: true
     # Not possible yet (needs graphql update):
-    # settings.attribute :show_rejected, type: :boolean, default: false
+    settings.attribute :show_rejected, type: :boolean, default: false
     settings.attribute :show_withdrawn, type: :boolean, default: false
   end
 
@@ -47,7 +53,7 @@ Decidim.register_component(:awesome_map) do |component|
       published_at: Time.current,
       participatory_space: participatory_space,
       settings: {
-        announcement: { en: Faker::Lorem.paragraphs(2).join("\n") }
+        announcement: { en: Faker::Lorem.paragraphs(number: 2).join("\n") }
       }
     }
 

data/lib/decidim/decidim_awesome/menu_hacker.rb

@@ -12,7 +12,7 @@ module Decidim
       end
 
       # returns a combined array of the Decidim defined menu and the hacked stored as config vars
-      def items(include_invisible = false)
+      def items(include_invisible: false)
         return @items if @items
 
         @items = default_items
@@ -22,9 +22,10 @@ module Decidim
             item.send("overrided?=", true)
             @items.reject! { |i| i.url.gsub(/\?.*/, "") == item.url }
           end
-          @items << item if include_invisible || visible?(item)
+          @items << item
         end
 
+        @items.select!(&:visible?) unless include_invisible
         @items.sort_by!(&:position)
       end
 
@@ -33,19 +34,6 @@ module Decidim
       attr_accessor :organization, :user
       attr_reader :name, :view
 
-      def visible?(item)
-        case item.visibility
-        when "hidden"
-          false
-        when "logged"
-          user.present?
-        when "non_logged"
-          user.blank?
-        else
-          true
-        end
-      end
-
       def default_items
         @default_items ||= build_menu.instance_variable_get(:@items).map do |item|
           item.instance_variable_set(:@active, method(:activate?)) unless item.active == :exact
@@ -69,6 +57,7 @@ module Decidim
             # see options in https://github.com/comfy/active_link_to
             active: method(:activate?),
             visibility: item["visibility"],
+            visible?: visible?(item),
             target: item["target"],
             overrided?: false
           )
@@ -80,6 +69,19 @@ module Decidim
         url == urls.find { |u| view.request.original_fullpath.start_with?(u) }
       end
 
+      def visible?(item)
+        case item["visibility"]
+        when "hidden"
+          false
+        when "logged"
+          user.present?
+        when "non_logged"
+          user.blank?
+        else
+          true
+        end
+      end
+
       def current_config
         @current_config ||= (AwesomeConfig.find_by(var: name, organization: organization)&.value || []).filter { |i| i.is_a? Hash }
       end

data/lib/decidim/decidim_awesome/system_checker.rb

@@ -14,7 +14,7 @@ module Decidim
           @overrides = checksums.map do |package, files|
             props = {
               spec: ::Gem::Specification.find_by_name(package),
-              files: files.map { |file, signatures| [file, signatures.values] }.to_h
+              files: files.transform_values(&:values)
             }
             [package, to_struct(props)]
           end

data/lib/decidim/decidim_awesome/test/shared_examples/box_label_editor.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+shared_examples "edits box label inline" do |test_case, key|
+  let(:data) { '[{"type":"text","label":"Short Name","subtype":"text","className":"form-control","name":"text-1476748004559"}]' }
+
+  it "updates the label when no changes" do
+    link = find("[data-key=#{key}] a.awesome-auto-edit", match: :first)
+    expect(page).not_to have_css("input.awesome-auto-edit")
+    link.click
+    expect(page).to have_css("input.awesome-auto-edit")
+    find("body").click
+    expect(page).not_to have_css("input.awesome-auto-edit")
+    link.click
+    input = find("[data-key=#{key}] input.awesome-auto-edit")
+    input.fill_in with: "A new làbel\n"
+    sleep 1
+    expect(page).not_to have_css("input.awesome-auto-edit")
+    expect(page).to have_css("span.awesome-auto-edit[data-key=a_new_label]")
+
+    find("*[type=submit]").click
+    case test_case
+    when :css
+      expect(page).to have_content("body {background: red;}")
+    when :fields
+      expect(page).to have_content("Occupation")
+      expect(page).to have_content("Street Sweeper")
+      expect(page).not_to have_content("Short Bio")
+    when :admins
+      expect(page).not_to have_content(user.name.to_s)
+      expect(page).to have_content(user2.name.to_s)
+      expect(page).to have_content(user3.name.to_s)
+    end
+    expect(page).to have_css("span.awesome-auto-edit[data-key=a_new_label]")
+    expect(page).not_to have_css("span.awesome-auto-edit[data-key=#{key}]")
+  end
+
+  it "updates the label with previous changes" do
+    case test_case
+    when :css
+      sleep 1
+      page.execute_script("document.querySelector(\"[data-key=#{key}] .CodeMirror\").CodeMirror.setValue(\"div {background: brown;}\");")
+    when :fields
+      sleep 2
+      page.execute_script("$('.proposal_custom_fields_container[data-key=#{key}] .proposal_custom_fields_editor')[0].FormBuilder.actions.setData(#{data})")
+    when :admins
+      sleep 1
+      page.execute_script("$('.multiusers-select:first').append(new Option('#{user.name}', #{user.id}, true, true)).trigger('change');")
+    end
+
+    link = find("[data-key=#{key}] a.awesome-auto-edit", match: :first)
+    expect(page).not_to have_css("input.awesome-auto-edit")
+    link.click
+    expect(page).to have_css("input.awesome-auto-edit")
+    find("body").click
+    expect(page).not_to have_css("input.awesome-auto-edit")
+    link.click
+    input = find("[data-key=#{key}] input.awesome-auto-edit")
+    input.fill_in with: "A new làbel\n"
+    sleep 1
+    expect(page).not_to have_css("input.awesome-auto-edit")
+    expect(page).to have_css("span.awesome-auto-edit[data-key=a_new_label]")
+
+    find("*[type=submit]").click
+    case test_case
+    when :css
+      expect(page).to have_admin_callout("updated successfully")
+      expect(page).to have_content("div {background: brown;}")
+    when :fields
+      expect(page).to have_content("Short Name")
+    when :admins
+      expect(page).to have_content(user.name.to_s)
+      expect(page).to have_content(user2.name.to_s)
+      expect(page).to have_content(user3.name.to_s)
+    end
+    expect(page).to have_css("span.awesome-auto-edit[data-key=a_new_label]")
+    expect(page).not_to have_css("span.awesome-auto-edit[data-key=#{key}]")
+  end
+
+  it "updates the label with post changes" do
+    link = find("[data-key=#{key}] a.awesome-auto-edit", match: :first)
+    expect(page).not_to have_css("input.awesome-auto-edit")
+    link.click
+    expect(page).to have_css("input.awesome-auto-edit")
+    find("body").click
+    expect(page).not_to have_css("input.awesome-auto-edit")
+    link.click
+    input = find("[data-key=#{key}] input.awesome-auto-edit")
+    input.fill_in with: "A new làbel\n"
+    sleep 1
+    expect(page).not_to have_css("input.awesome-auto-edit")
+    expect(page).to have_css("span.awesome-auto-edit[data-key=a_new_label]")
+
+    case test_case
+    when :css
+      sleep 1
+      page.execute_script('document.querySelector("[data-key=a_new_label] .CodeMirror").CodeMirror.setValue("body {background: lilac;}");')
+      find("*[type=submit]").click
+      expect(page).to have_admin_callout("updated successfully")
+      expect(page).to have_content("body {background: lilac;}")
+    when :fields
+      expect(page).to have_content("Full Name")
+      sleep 2
+      page.execute_script("$('.proposal_custom_fields_container[data-key=a_new_label] .proposal_custom_fields_editor')[0].FormBuilder.actions.setData(#{data})")
+      find("*[type=submit]").click
+      expect(page).to have_content("Short Name")
+    when :admins
+      page.execute_script("$('.multiusers-select:first').append(new Option('#{user.name}', #{user.id}, true, true)).trigger('change');")
+      find("*[type=submit]").click
+      expect(page).to have_content(user.name.to_s)
+      expect(page).to have_content(user2.name.to_s)
+      expect(page).to have_content(user3.name.to_s)
+    end
+    expect(page).to have_css("span.awesome-auto-edit[data-key=a_new_label]")
+    expect(page).not_to have_css("span.awesome-auto-edit[data-key=#{key}]")
+  end
+end

data/lib/decidim/decidim_awesome/test/shared_examples/current_config_examples.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+shared_examples "same environment" do
+  it "do not modify the environment" do
+    code, new_env = middleware.call(env)
+
+    expect(new_env).to eq(env)
+    expect(code).to eq(200)
+  end
+
+  it "has current organization in env" do
+    _code, new_env = middleware.call(env)
+
+    expect(new_env["decidim.current_organization"]).to eq(env["decidim.current_organization"])
+    expect(new_env["decidim_awesome.current_config"]).to be_a Decidim::DecidimAwesome::Config
+  end
+end
+
+shared_examples "untampered user model" do
+  it "user model is reset" do
+    # ensure model is always reset after calling the middleware
+    Decidim::User.awesome_admins_for_current_scope = [123]
+    middleware.call(env)
+
+    expect(Decidim::User.awesome_admins_for_current_scope).not_to be_present
+  end
+end
+
+shared_examples "tampered users model" do
+  it "user model is tampered" do
+    # ensure model is always reset after calling the middleware
+    Decidim::User.awesome_admins_for_current_scope = [123]
+    middleware.call(env)
+
+    expect(Decidim::User.awesome_admins_for_current_scope).to match_array([user.id, admin.id])
+  end
+end
+
+shared_examples "tampered user model" do
+  it "user model is tampered" do
+    # ensure model is always reset after calling the middleware
+    Decidim::User.awesome_admins_for_current_scope = [123]
+    middleware.call(env)
+
+    expect(Decidim::User.awesome_admins_for_current_scope).to match_array([user.id])
+  end
+end
+
+shared_examples "tampered admin model" do
+  it "user model is tampered" do
+    # ensure model is always reset after calling the middleware
+    Decidim::User.awesome_admins_for_current_scope = [123]
+    middleware.call(env)
+
+    expect(Decidim::User.awesome_admins_for_current_scope).to match_array([admin.id])
+  end
+end
+
+shared_examples "generic admin routes" do
+  context "when admin index" do
+    let(:path) { "admin/" }
+
+    it_behaves_like "tampered users model"
+
+    context "when additional slashes" do
+      let(:path) { "/admin/" }
+
+      it_behaves_like "untampered user model"
+    end
+
+    context "when multiple slashes" do
+      let(:path) { "//admin/" }
+
+      it_behaves_like "untampered user model"
+    end
+
+    context "when POST" do
+      let(:method) { "POST" }
+
+      it_behaves_like "untampered user model"
+    end
+
+    context "when PATCH" do
+      let(:method) { "PATCH" }
+
+      it_behaves_like "untampered user model"
+    end
+  end
+
+  context "when admin terms" do
+    let(:path) { "admin/admin_terms" }
+
+    it_behaves_like "tampered users model"
+
+    context "when POST" do
+      let(:method) { "POST" }
+
+      it_behaves_like "tampered users model"
+    end
+  end
+
+  context "when admin out of scope" do
+    let(:path) { "admin/some_path" }
+
+    it_behaves_like "untampered user model"
+  end
+
+  context "when admin an assembly" do
+    let(:path) { "admin/assemblies/#{assembly.slug}" }
+
+    it_behaves_like "tampered users model"
+
+    context "and accessing assemblies index" do
+      let(:path) { "admin/assemblies" }
+
+      it_behaves_like "tampered users model"
+
+      context "when POST" do
+        let(:method) { "POST" }
+
+        it_behaves_like "untampered user model"
+      end
+
+      context "when PATCH" do
+        let(:method) { "PATCH" }
+
+        it_behaves_like "untampered user model"
+      end
+    end
+  end
+
+  context "and accessing another assemblies index" do
+    let(:path) { "admin/assemblies/#{another_assembly.slug}" }
+
+    it_behaves_like "untampered user model"
+  end
+
+  context "when admin a participatory process" do
+    let(:path) { "admin/participatory_processes/some-process" }
+
+    it_behaves_like "tampered admin model"
+  end
+end

data/lib/decidim/decidim_awesome/test/shared_examples/editor_examples.rb

@@ -11,10 +11,12 @@ shared_examples "has no drag and drop" do |rte|
     end
   else
     it "has no paste event" do
+      sleep 1
       expect(page.execute_script("return typeof $._data($('#{editor_selector}')[0], 'events').paste")).to eq("undefined")
     end
 
     it "has no drop event" do
+      sleep 1
       expect(page.execute_script("return typeof $._data($('#{editor_selector}')[0], 'events').drop")).to eq("undefined")
     end
   end
@@ -31,10 +33,12 @@ shared_examples "has drag and drop" do |rte|
     end
   else
     it "has paste event" do
+      sleep 1
       expect(page.execute_script("return typeof $._data($('#{editor_selector}')[0], 'events').paste")).to eq("object")
     end
 
     it "has drop event" do
+      sleep 1
       expect(page.execute_script("return typeof $._data($('#{editor_selector}')[0], 'events').drop")).to eq("object")
     end
   end