decidim-decidim_awesome 0.6.0 → 0.6.5

data/lib/decidim/decidim_awesome.rb

@@ -18,6 +18,7 @@ module Decidim
     autoload :SystemChecker, "decidim/decidim_awesome/system_checker"
     autoload :ContentRenderes, "decidim/decidim_awesome/content_renderers"
     autoload :ContextAnalyzers, "decidim/decidim_awesome/context_analyzers"
+    autoload :MenuHacker, "decidim/decidim_awesome/menu_hacker"
 
     # Boolean configuration options
     #
@@ -59,6 +60,32 @@ module Decidim
       false
     end
 
+    # allows admins to created specific CSS snippets affecting only some specific parts
+    # Valid values differ a little from the previous convention:
+    #   :disabled => false and non available, hidden from admins
+    #   Hash => hash of different css text, each key will be used for the contraints
+    # Admins create this hash dynamically but some pre-defined css boxes can be created here as:
+    #   {
+    #      some_identifier: ".wrapper { background: red; }"
+    #   }
+    config_accessor :scoped_styles do
+      {}
+    end
+
+    # allows to keep modifications for the main menu
+    # can return :disabled to completly remove this feature
+    # otherwise it should be an array (some overrides can be specified by default):
+    # [
+    #    {
+    #       url: "/a-new-link",
+    #       label: { "en" => "The label to show in the menu" },
+    #       position: 10
+    #    }
+    # ]
+    config_accessor :menu do
+      []
+    end
+
     # these settings do not follow the :disabled convention but
     # depends on the previous intergram configurations
     config_accessor :intergram_url do

data/lib/decidim/decidim_awesome/admin_engine.rb

@@ -12,7 +12,10 @@ module Decidim
       routes do
         # Add admin engine routes here
         resources :constraints
+        resources :menu_hacks, except: [:show]
         resources :config, param: :var, only: [:show, :update]
+        post :new_scoped_style, to: "config#new_scoped_style"
+        post :destroy_scoped_style, param: :key, to: "config#destroy_scoped_style"
         get :checks, to: "checks#index"
         root to: "config#show", var: :editors
       end

data/lib/decidim/decidim_awesome/awesome_helpers.rb

@@ -19,6 +19,10 @@ module Decidim
         @awesome_config ||= awesome_config_instance.config
       end
 
+      def javascript_config_vars
+        awesome_config.except(:scoped_styles).to_json.html_safe
+      end
+
       def show_public_intergram?
         return unless awesome_config[:intergram_for_public]
         return true unless awesome_config[:intergram_for_public_settings][:require_login]
@@ -45,6 +49,18 @@ module Decidim
         return @tenant_stylesheets = current_organization.host.to_s if File.exist?("#{prefix}.css") || File.exist?("#{prefix}.scss") || File.exist?("#{prefix}.scss.erb")
       end
 
+      # Collects all CSS that is applied in the current URL context
+      def awesome_custom_styles
+        return unless awesome_config[:scoped_styles]
+        return @awesome_custom_styles if @awesome_custom_styles
+
+        styles = awesome_config[:scoped_styles]&.filter do |key, _value|
+          config = AwesomeConfig.find_by(var: "scoped_style_#{key}", organization: current_organization)
+          @awesome_config_instance.valid_in_context?(config&.constraints)
+        end
+        @awesome_custom_styles = styles.values.join("\n")
+      end
+
       def version_prefix
         "v#{Decidim.version[0..3]}"
       end

data/lib/decidim/decidim_awesome/checksums.yml

@@ -9,7 +9,15 @@ decidim-core:
   /app/assets/javascripts/decidim/editor.js.es6:
     decidim-0.22: 797d0ec1c9e79453cf6718f82d2fdd27
     decidim-0.23: cb059b8ff0ffc62c67eb99d8d7a6637b
+    decidim-0.23.1: 4787f73f0f33661e3897404f10019d26
+  /app/presenters/decidim/menu_presenter.rb:
+    decidim-0.22: 042743c44a2aff284b493c7bebbccbb3
+    decidim-0.23: 042743c44a2aff284b493c7bebbccbb3
+  /app/presenters/decidim/menu_item_presenter.rb:
+    decidim-0.22: 70db39954b5840924530bf94d2a0a73a
+    decidim-0.23: 70db39954b5840924530bf94d2a0a73a
 decidim-proposals:
   /app/presenters/decidim/proposals/proposal_presenter.rb:
     decidim-0.22: 7d60c8310d7fa4e38d9a27080c22b12c
     decidim-0.23: 437c0c25151f605401a4f14d090ba5ea
+    decidim-0.23.1: 892021b2ce9ac10c2e1b738e6948cde0

data/lib/decidim/decidim_awesome/config.rb

@@ -79,6 +79,19 @@ module Decidim
         config[setting]
       end
 
+      # checks if some constraint blocks the validity fot the current context
+      def valid_in_context?(constraints)
+        # if no constraints defined, applies to everything
+        return true if constraints.blank?
+
+        # check if current context matches some constraint
+        constraints.detect do |constraint|
+          # if some setting is different, rejects
+          invalid = constraint.settings.detect { |key, val| context[key.to_sym].to_s != val.to_s }
+          invalid.blank?
+        end
+      end
+
       private
 
       def map_defaults
@@ -112,18 +125,6 @@ module Decidim
         end
         true
       end
-
-      def valid_in_context?(constraints)
-        # if no constraints defined, applies to everything
-        return true if constraints.blank?
-
-        # check if current context matches some constraint
-        constraints.detect do |constraint|
-          # if some setting is different, rejects
-          invalid = constraint.settings.detect { |key, val| context[key.to_sym] != val }
-          invalid.blank?
-        end
-      end
     end
   end
 end

data/lib/decidim/decidim_awesome/engine.rb

@@ -20,7 +20,7 @@ module Decidim
 
       initializer "decidim_decidim_awesome.assets" do |app|
         app.config.assets.precompile += %w(decidim_decidim_awesome_manifest.js decidim_decidim_awesome_manifest.css)
-        # add to precompile any present
+        # add to precompile any present theme asset
         Dir.glob(Rails.root.join("app", "assets", "themes", "*.*")).each do |path|
           app.config.assets.precompile << path
         end

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

@@ -14,7 +14,7 @@ Decidim.register_component(:awesome_iframe) do |component|
   component.settings(:global) do |settings|
     # Add your global settings
     # Available types: :integer, :boolean
-    # settings.attribute :announcement, type: :text, translated: true, editor: true
+    settings.attribute :announcement, type: :text, translated: true, editor: true
     settings.attribute :iframe, type: :text
     settings.attribute :viewport_width, type: :boolean, default: false
     settings.attribute :no_margins, type: :boolean, default: false
@@ -22,7 +22,7 @@ Decidim.register_component(:awesome_iframe) do |component|
 
   component.settings(:step) do |settings|
     # Add your settings per step
-    # settings.attribute :announcement, type: :text, translated: true, editor: true
+    settings.attribute :announcement, type: :text, translated: true, editor: true
     settings.attribute :iframe, type: :text
   end
 
@@ -31,7 +31,7 @@ Decidim.register_component(:awesome_iframe) do |component|
   # end
 
   component.seeds do |participatory_space|
-    # Create a Iframe and a few geolocated proposals
+    # Create a Iframe component in all participatory spaces
     admin_user = Decidim::User.find_by(
       organization: participatory_space.organization,
       email: "admin@example.org"

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

@@ -22,6 +22,12 @@ Decidim.register_component(:awesome_map) do |component|
   component.settings(:step) do |settings|
     # Add your settings per step
     settings.attribute :announcement, type: :text, translated: true, editor: true
+    settings.attribute :show_not_answered, type: :boolean, default: true
+    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_withdrawn, type: :boolean, default: false
   end
 
   # component.register_stat :some_stat do |context, start_at, end_at|

data/lib/decidim/decidim_awesome/menu_hacker.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    class MenuHacker
+      include Decidim::TranslatableAttributes
+      def initialize(name, view)
+        @name = name
+        @organization = view.try(:current_organization)
+        @user = view.try(:current_user)
+        @view = view
+      end
+
+      # returns a combined array of the Decidim defined menu and the hacked stored as config vars
+      def items(include_invisible = false)
+        return @items if @items
+
+        @items = default_items
+        menu_overrides.each do |item|
+          default = default_items.find { |i| i.url.gsub(/\?.*/, "") == item.url }
+          if default
+            item.send("overrided?=", true)
+            @items.reject! { |i| i.url.gsub(/\?.*/, "") == item.url }
+          end
+          @items << item if include_invisible || visible?(item)
+        end
+
+        @items.sort_by!(&:position)
+      end
+
+      private
+
+      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
+          item
+        end
+      end
+
+      def build_menu
+        menu = Decidim::Menu.new(name)
+        menu.build_for(view)
+        menu
+      end
+
+      def menu_overrides
+        @menu_overrides ||= current_config.map do |item|
+          OpenStruct.new(
+            label: translated_attribute(item["label"], organization),
+            raw_label: item["label"],
+            url: item["url"],
+            position: item["position"] || 1,
+            # see options in https://github.com/comfy/active_link_to
+            active: method(:activate?),
+            visibility: item["visibility"],
+            target: item["target"],
+            overrided?: false
+          )
+        end
+      end
+
+      def activate?(url, view)
+        urls = @items.map(&:url).sort_by(&:length).reverse
+        url == urls.find { |u| view.request.original_fullpath.start_with?(u) }
+      end
+
+      def current_config
+        @current_config ||= (AwesomeConfig.find_by(var: name, organization: organization)&.value || []).filter { |i| i.is_a? Hash }
+      end
+    end
+  end
+end

data/lib/decidim/decidim_awesome/test/factories.rb

@@ -16,7 +16,7 @@ FactoryBot.define do
   end
 
   factory :editor_image, class: "Decidim::DecidimAwesome::EditorImage" do
-    image { Faker::Hacker.noun }
+    image { Decidim::Dev.test_file("city.jpeg", "image/jpeg") }
     path { Faker::Internet.url(host: "", scheme: "") }
     author { create :user }
     organization { create :organization }

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

@@ -9,17 +9,19 @@ shared_examples "javascript config vars" do
 end
 
 shared_examples "has menu link" do |item|
+  let(:prefix) { "config/" }
   it "shows the feature link" do
     within ".secondary-nav" do
-      expect(page).to have_link(href: "/admin/decidim_awesome/config/#{item}")
+      expect(page).to have_link(href: "/admin/decidim_awesome/#{prefix}#{item}")
     end
   end
 end
 
 shared_examples "do not have menu link" do |item|
+  let(:prefix) { "config/" }
   it "do not show the feature link" do
     within ".secondary-nav" do
-      expect(page).not_to have_link(href: "/admin/decidim_awesome/config/#{item}")
+      expect(page).not_to have_link(href: "/admin/decidim_awesome/#{prefix}#{item}")
     end
   end
 end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+shared_examples "has no drag and drop" do |rte|
+  it "has no help text" do
+    expect(page).not_to have_content("Add images by dragging & dropping or pasting them.")
+  end
+
+  if rte
+    it "has image button" do
+      expect(page).not_to have_xpath("//button[@class='ql-image']")
+    end
+  else
+    it "has no paste event" do
+      expect(page.execute_script("return typeof $._data($('#{editor_selector}')[0], 'events').paste")).to eq("undefined")
+    end
+
+    it "has no drop event" do
+      expect(page.execute_script("return typeof $._data($('#{editor_selector}')[0], 'events').drop")).to eq("undefined")
+    end
+  end
+end
+
+shared_examples "has drag and drop" do |rte|
+  it "has help text" do
+    expect(page).to have_content("Add images by dragging & dropping or pasting them.")
+  end
+
+  if rte
+    it "has image button" do
+      expect(page).to have_xpath("//button[@class='ql-image']")
+    end
+  else
+    it "has paste event" do
+      expect(page.execute_script("return typeof $._data($('#{editor_selector}')[0], 'events').paste")).to eq("object")
+    end
+
+    it "has drop event" do
+      expect(page.execute_script("return typeof $._data($('#{editor_selector}')[0], 'events').drop")).to eq("object")
+    end
+  end
+end
+
+shared_examples "has markdown editor" do |images|
+  it "has CodeMirror class" do
+    expect(page).to have_xpath("//div[@class='CodeMirror cm-s-paper CodeMirror-wrap']")
+  end
+
+  it "has toolbar" do
+    expect(page).to have_xpath("//div[@class='editor-toolbar']")
+  end
+
+  if images
+    it "has help text" do
+      expect(page).to have_content("Add images by dragging & dropping or pasting them.")
+    end
+  else
+    it "has no help text" do
+      expect(page).not_to have_content("Add images by dragging & dropping or pasting them.")
+    end
+  end
+end
+
+shared_examples "has no markdown editor" do
+  it "has CodeMirror class" do
+    expect(page).not_to have_xpath("//div[@class='CodeMirror cm-s-paper CodeMirror-wrap']")
+  end
+
+  it "has toolbar" do
+    expect(page).not_to have_xpath("//div[@class='editor-toolbar']")
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+shared_context "with menu hacks params" do
+  let(:organization) { create(:organization) }
+  let(:context) do
+    {
+      current_user: create(:user, organization: organization),
+      current_organization: organization
+    }
+  end
+  let(:params) do
+    {
+      raw_label: label,
+      url: url,
+      position: position,
+      target: target,
+      visibility: visibility
+    }
+  end
+  let(:attributes) do
+    {
+      "label" => label,
+      "url" => url,
+      "position" => position,
+      "target" => target,
+      "visibility" => visibility
+    }
+  end
+  let(:label) do
+    {
+      "en" => "Menu english",
+      "ca" => "Menu catalan"
+    }
+  end
+  let(:url) { "/some-path" }
+  let(:position) { 2 }
+  let(:target) { "_blank" }
+  let(:visibility) { "hidden" }
+  let(:menu_name) { "menu" }
+
+  let(:another_params) do
+    {
+      allow_images_in_full_editor: true,
+      allow_images_in_small_editor: true
+    }
+  end
+  let(:form) do
+    Decidim::DecidimAwesome::Admin::MenuForm.from_params(params).with_context(context)
+  end
+  let(:another_form) do
+    Decidim::DecidimAwesome::Admin::ConfigForm.from_params(another_params).with_context(context)
+  end
+  let(:another_config) { Decidim::DecidimAwesome::Admin::UpdateConfig.new(another_form) }
+end
+
+shared_examples "forbids disabled feature" do
+  let(:feature) { :menu }
+  let(:features) { [feature] }
+  before do
+    features.each do |feat|
+      allow(Decidim::DecidimAwesome.config).to receive(feat).and_return(:disabled)
+    end
+  end
+
+  it "redirects with error" do
+    action
+
+    expect(flash[:alert]).not_to be_empty
+    expect(response).to redirect_to("/admin/")
+  end
+end