decidim-decidim_awesome 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca4e9a5883518e03b29844b430fe92343558ca88394a4e03334ebb387cf133dc
-  data.tar.gz: 2dbdc12ff4446debcf62641c8dc4fa788fc5a07011060216874d3811f526d4f5
+  metadata.gz: 2be39606cbd0f92bc8232bbd4a1c8b04a27aed18e9a0732668af6f37126d66f4
+  data.tar.gz: 5034f9d65042871ec4be47c313e90c46390e40751003666ea8a93166df087d31
 SHA512:
-  metadata.gz: eb94d6bb293ebf2ac77767d18721f7f59f674a6fcfa89b5d8c3a12b7a2c56f3c49629767e878ff0ef7c9f7dffb31b13c1a90c7d82e5ffea2893aa1d59b57b548
-  data.tar.gz: 1af64bdf1c90aa1bcfb296777726df9fe7ffe6e1b472cd057e2595376b9eac47e96bd3c3abc4a6ebc2aba20537ecaac4c6047f8d2d0039ed436b33bdfbac2f6f
+  metadata.gz: b2219e00f0a35206d772032e1f259e5283e2085a39bf5f45e47af09a784ece3776c0824ed7dc6d191cdcbf036b34a647fb5c9c172e13f86ef21394f54275fc9a
+  data.tar.gz: e2abb579c41c61b11377c986f692cba8b944671e1876616bf771309b8e62900a05b57582f72f1f458ef17309b55d8030c15727993ad99092c40ac4c4e31fd94a

data/README.md

@@ -33,7 +33,7 @@ Each hack can be scoped to one or more specific participatory spaces or componen
 
 #### 1. Image support for the Quill editor
 
-Modifies the WYSIWYG editor in Decidim by adding the possibility to insert images. When uploading images, Drag & Drop is supported. Images will be uploaded to the server and inserted as external resources (it doesn't use base64 inline encoding).
+Modifies the WYSIWYG editor in Decidim by adding the possibility to insert images. When uploading images, Drag & Drop is supported. Images will be uploaded to the server and inserted as external resources (it doesn't use base64 in-line encoding).
 
 This feature allows you use images in newsletters as well.
 
@@ -71,13 +71,13 @@ Many scopes can be defined for every tweak.
 
 This is a component you can add in any participatory space. It retrieves all the geolocated content in that participatory space (meetings or proposals) and displays it in a big map.
 
-It also provides a simple search by category, each category is assignated to a different color.
+It also provides a simple search by category, each category is assigned to a different color.
 
 ![Awesome map](examples/awesome-map.png)
 
 #### 7. Allow Decidim to use custom CSS themes for every tenant
 
-When customizind CSS for a Decidim installation, each change affects all the organizations (tenant).
+When customizing CSS for a Decidim installation, each change affects all the organizations (tenant).
 
 This feature allows to customize each organization css without affecting the others in the same Decidim installation.
 
@@ -106,12 +106,20 @@ With this feature you can have a support chat in Decidim. It is linked to a [Tel
 
 ![Intergram screenshot](examples/intergram.png)
 
-#### 10. Custom CSS applied only according scopes restrictions
+#### 10. Custom CSS applied only according scoped restrictions
 
-For instance, with this feature you can create directly from the admin a CSS snipped that is only applied globally, in a particular assembly or even a single proposal!
+With this feature you can create directly in the admin a CSS snipped that is only applied globally, in a particular assembly or even a single proposal!
 
 ![CSS screenshot](examples/custom_styles.png)
 
+#### 11. Change the main menu of Decidim entirely!
+
+Feel free to hide, modify or add items in the Decidim's main menu. You can also change the order, establish some conditions (like showing only for logged users) or open in a new window.
+
+![Menu hacks screenshot](examples/menu-1.png)
+![Menu hacks screenshot](examples/menu-2.png)
+![Menu hacks screenshot](examples/menu-3.png)
+![Menu hacks screenshot](examples/menu-4.png)
 
 #### To be continued...
 
@@ -127,7 +135,7 @@ Some things in the road-map:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "decidim-decidim_awesome", "~> 0.6.4"
+gem "decidim-decidim_awesome", "~> 0.6.5"
 ```
 
 And then execute:

data/app/assets/stylesheets/decidim/decidim_awesome/admin.scss

@@ -43,3 +43,7 @@
     padding-bottom: 0;
   }
 }
+
+tbody tr.menu_hack-addition {
+  background: rgb(255, 248, 222);
+}

data/app/awesome_overrides/presenters/decidim/menu_presenter_override.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+Decidim::MenuPresenter.class_eval do
+  def evaluated_menu
+    @evaluated_menu ||= if Decidim::DecidimAwesome.config.send(@name) == :disabled
+                          begin
+                            menu = Decidim::Menu.new(@name)
+                            menu.build_for(@view)
+                            menu
+                          end
+                        else
+                          Decidim::DecidimAwesome::MenuHacker.new(@name, @view)
+                        end
+  end
+end
+
+Decidim::MenuItemPresenter.class_eval do
+  def link_to(name = nil, options = nil, html_options = nil, &block)
+    html_options ||= {}
+    html_options[:target] = @menu_item.try(:target)
+
+    options ||= html_options
+    @view.link_to(name, options, html_options, &block)
+  end
+
+  def active
+    return @menu_item.active.call(url, @view) if @menu_item.try(:active).respond_to?(:call)
+
+    @menu_item&.active
+  end
+end

data/app/commands/decidim/decidim_awesome/admin/create_menu_hack.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module Admin
+      class CreateMenuHack < Rectify::Command
+        # Public: Initializes the command.
+        #
+        def initialize(form, menu_name)
+          @form = form
+          @menu = AwesomeConfig.find_or_initialize_by(var: menu_name, organization: form.current_organization)
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+          return broadcast(:invalid, I18n.t("menu_hacks.url_exists", scope: "decidim.decidim_awesome.admin")) if url_exists?
+
+          menu.value = [] unless menu.value.is_a? Array
+          menu.value << to_params
+          menu.save!
+          broadcast(:ok, menu)
+        rescue StandardError => e
+          broadcast(:invalid, e.message)
+        end
+
+        private
+
+        attr_reader :form, :menu
+
+        def url_exists?
+          return false unless menu
+
+          menu.value&.detect { |i| i["url"] == form.url.gsub(/\?.*/, "") }
+        end
+
+        def to_params
+          params = form.to_params
+          url = Addressable::URI.parse(params[:url])
+          params[:url] = url.path if url.host == form.current_organization.host
+          params
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/decidim_awesome/admin/destroy_menu_hack.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module Admin
+      class DestroyMenuHack < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # item - the menu item to destroy
+        # organization
+        def initialize(item, menu_name, organization)
+          @item = item
+          @organization = organization
+          @menu = AwesomeConfig.find_by(var: menu_name, organization: organization)
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) unless url_exists?
+
+          menu.value&.reject! { |i| i["url"] == item.url }
+          menu.save!
+
+          broadcast(:ok, @item)
+        rescue StandardError => e
+          broadcast(:invalid, e.message)
+        end
+
+        private
+
+        attr_reader :organization, :item, :menu
+
+        def url_exists?
+          return false unless menu
+          return false unless menu.value.is_a? Array
+
+          menu.value&.detect { |i| i["url"] == item.url }
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/decidim_awesome/admin/update_config.rb

@@ -23,7 +23,7 @@ module Decidim
           begin
             form.attributes.each do |key, val|
               # ignore nil attributes (must specifically be set to false if necessary)
-              next if val.nil?
+              next unless form.valid_keys.include?(key)
 
               setting = AwesomeConfig.find_or_initialize_by(var: key, organization: form.current_organization)
 

data/app/commands/decidim/decidim_awesome/admin/update_menu_hack.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module Admin
+      class UpdateMenuHack < Rectify::Command
+        # Public: Initializes the command.
+        #
+        def initialize(form, menu_name)
+          @form = form
+          @menu = AwesomeConfig.find_or_initialize_by(var: menu_name, organization: form.current_organization)
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          menu.value = [] unless menu.value.is_a? Array
+          menu.value = menu.value.filter { |i| i.is_a? Hash }
+          found = false
+          menu.value.map! do |item|
+            if item["url"] == form.url
+              found = true
+              form.to_params
+            else
+              item
+            end
+          end
+          menu.value << form.to_params unless found
+          menu.save!
+          broadcast(:ok, menu)
+        rescue StandardError => e
+          broadcast(:invalid, e.message)
+        end
+
+        private
+
+        attr_reader :form, :menu
+      end
+    end
+  end
+end

data/app/controllers/decidim/decidim_awesome/admin/application_controller.rb

@@ -9,9 +9,10 @@ module Decidim
       # Note that it inherits from `Decidim::Admin::Components::BaseController`, which
       # override its layout and provide all kinds of useful methods.
       class ApplicationController < Decidim::Admin::ApplicationController
-        # def permission_class_chain
-        #   [::Decidim::DecidimAwesome::Admin::Permissions] + super
-        # end
+        def permission_class_chain
+          [::Decidim::DecidimAwesome::Admin::Permissions] + super
+        end
+
         before_action do
           enforce_permission_to :update, :organization, organization: current_organization
         end

data/app/controllers/decidim/decidim_awesome/admin/config_controller.rb

@@ -12,6 +12,9 @@ module Decidim
         layout "decidim/admin/decidim_awesome"
 
         helper_method :constraints_for
+        before_action do
+          enforce_permission_to :edit_config, configs
+        end
 
         def show
           @form = form(ConfigForm).from_params(organization_awesome_config)
@@ -65,6 +68,12 @@ module Decidim
         def constraints_for(key)
           awesome_config_instance.setting_for(key)&.constraints
         end
+
+        def configs
+          return params[:config].keys if params.has_key?(:config)
+
+          DecidimAwesome.config.keys
+        end
       end
     end
   end

data/app/controllers/decidim/decidim_awesome/admin/constraints_controller.rb

@@ -9,6 +9,9 @@ module Decidim
         helper ConfigConstraintsHelpers
 
         layout false
+        before_action do
+          enforce_permission_to :edit_config, constraint_key
+        end
 
         def new
           @form = form(ConstraintForm).from_params(filtered_params, setting: current_setting)
@@ -118,6 +121,16 @@ module Decidim
         def current_setting
           awesome_config_instance.setting_for params[:key]
         end
+
+        def constraint_key
+          key = params[:key] || constraint.awesome_config.var
+          case key
+          when /^scoped_style_/
+            :scoped_styles
+          else
+            key
+          end
+        end
       end
     end
   end

data/app/controllers/decidim/decidim_awesome/admin/menu_hacks_controller.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module Admin
+      # Editing menu items
+      class MenuHacksController < DecidimAwesome::Admin::ApplicationController
+        include NeedsAwesomeConfig
+        helper ConfigConstraintsHelpers
+
+        layout "decidim/admin/decidim_awesome"
+
+        helper_method :current_items, :md5, :visibility_options, :target_options
+
+        before_action do
+          enforce_permission_to :edit_config, :menu
+        end
+
+        def index; end
+
+        def new
+          @form = form(MenuForm).instance
+        end
+
+        def create
+          @form = form(MenuForm).from_params(params)
+          CreateMenuHack.call(@form, current_menu_name) do
+            on(:ok) do
+              flash[:notice] = I18n.t("menu_hacks.create.success", scope: "decidim.decidim_awesome.admin")
+              redirect_to decidim_admin_decidim_awesome.menu_hacks_path
+            end
+
+            on(:invalid) do |message|
+              flash.now[:alert] = I18n.t("menu_hacks.create.error", error: message, scope: "decidim.decidim_awesome.admin")
+              render :new
+            end
+          end
+        end
+
+        def edit
+          @form = form(MenuForm).from_model(menu_item)
+        end
+
+        def update
+          @form = form(MenuForm).from_params(params)
+          UpdateMenuHack.call(@form, current_menu_name) do
+            on(:ok) do
+              flash[:notice] = I18n.t("menu_hacks.update.success", scope: "decidim.decidim_awesome.admin")
+              redirect_to decidim_admin_decidim_awesome.menu_hacks_path
+            end
+
+            on(:invalid) do |message|
+              flash.now[:alert] = I18n.t("menu_hacks.update.error", error: message, scope: "decidim.decidim_awesome.admin")
+              render :edit
+            end
+          end
+        end
+
+        def destroy
+          DestroyMenuHack.call(menu_item, current_menu_name, current_organization) do
+            on(:ok) do
+              flash[:notice] = I18n.t("menu_hacks.destroy.success", scope: "decidim.decidim_awesome.admin")
+            end
+            on(:invalid) do |error|
+              flash[:alert] = I18n.t("menu_hacks.destroy.error", scope: "decidim.decidim_awesome.admin", error: error)
+            end
+          end
+          redirect_to decidim_admin_decidim_awesome.menu_hacks_path
+        end
+
+        private
+
+        def menu_item
+          item = current_items.find { |i| md5(i.url) == params[:id] }
+          raise ActiveRecord::RecordNotFound unless item
+
+          OpenStruct.new(
+            raw_label: item.try(:raw_label) || { current_organization.default_locale => item.label },
+            url: item.url,
+            position: item.position,
+            target: item.try(:target),
+            visibility: item.try(:visibility),
+            native?: !item.respond_to?(:overrided?)
+          )
+        end
+
+        def current_items
+          @current_items ||= current_menu.items(true)
+        end
+
+        def current_menu
+          @current_menu ||= MenuHacker.new(current_menu_name, self)
+        end
+
+        def current_menu_name
+          :menu
+        end
+
+        def md5(text)
+          Digest::MD5.hexdigest(text)
+        end
+
+        def visibility_options
+          MenuForm::VISIBILITY_STATES.map { |key| [I18n.t(".menu_hacks.form.visibility.#{key}", scope: "decidim.decidim_awesome.admin"), key] }.to_h
+        end
+
+        def target_options
+          {
+            I18n.t(".menu_hacks.form.target.self", scope: "decidim.decidim_awesome.admin") => "",
+            I18n.t(".menu_hacks.form.target.blank", scope: "decidim.decidim_awesome.admin") => "_blank"
+          }
+        end
+      end
+    end
+  end
+end