decidim-decidim_awesome 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eae6aea754d4ce898a8631f7d8c3b03946a11fc0cb15c5e1d373d98774aabeb
-  data.tar.gz: 7f3107a8bfa4d3069c34cf28c7347686d38811fd7f9d6b1a18ff41e470216af2
+  metadata.gz: 7731085ea63b1e475bc932df6a856fb15f4895ebaec108aacac0ef51698f80bb
+  data.tar.gz: 633a38263369173bc782046137a3a91a6b0a0759690a39d5759f8eb6abb2bb3a
 SHA512:
-  metadata.gz: dbbaaea663e4c9d317e7f971e0da7446577d6427245da4f17993b971c166a951e7eaeeb2d0264f01eaded4b3eb65b79c07ecec9e216cafc7e45ed6dc1fc010a4
-  data.tar.gz: d77a435d6ebf77601d27344a744048e1eff43f599e64a330dcb9e7ea3f22e1efbbf808fb676891dd4404d334acc217a5a19fd892482631cc148992c342295893
+  metadata.gz: '08415d52fa955527e623c3efca7f04a1d5456cedc8cbaca918329700cc4dd963bcc5c895eccc496b67ffa04410ad36067d380d71152f545c698e9fb334c521dc'
+  data.tar.gz: c9d394b5f3080b25c0e7d1ba88b1d55ce668f537e2ee07c2401ebff37acfff5d6e49ece69bc6bf518d38b468e1ee430ab7c193e0b1489f1ed8395ccea4fbcb66

data/README.md

@@ -106,14 +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
+
+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!
+
+![CSS screenshot](examples/custom_styles.png)
+
 
 #### To be continued...
 
 Some things in the road-map:
 
 1. Improve the conversation in comments by allowing images
-1. Direct export of surveys in PDF
-1. Allow to create surveys where the responding user is known
+1. Allow to create non-private surveys where the responding user is known by admins
+1. Manipulate menus (reorder, change texts, add new items)
 1. Propose something! or even better send a PR!
 
 ## Installation
@@ -121,7 +127,7 @@ Some things in the road-map:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "decidim-decidim_awesome", "~> 0.6.2"
+gem "decidim-decidim_awesome", "~> 0.6.3"
 ```
 
 And then execute:

data/app/assets/config/decidim_admin_decidim_awesome_manifest.js

@@ -1 +1,2 @@
 // = link decidim/decidim_awesome/admin.js
+// = link decidim/decidim_awesome/admin/form_exit_warn.js

data/app/assets/javascripts/decidim/decidim_awesome/admin/form_exit_warn.js.es6

@@ -0,0 +1,30 @@
+// = require_self
+
+$(() => {
+  const $form = $("form.awesome-edit-config");
+  if ($form.length > 0) {
+    $form.find("input, textarea, select").on("change", () => {
+      $form.data("changed", true);
+    });
+
+    const safePath = $form.data("safe-path").split("?")[0];
+    $(document).on("click", "a", (event) => {
+      window.exitUrl = event.currentTarget.href;
+    });
+    $(document).on("submit", "form", (event) => {
+      window.exitUrl = event.currentTarget.action;
+    });
+
+    window.addEventListener("beforeunload", (event) => {
+      const exitUrl = window.exitUrl;
+      const hasChanged = $form.data("changed");
+      window.exitUrl = null;
+
+      if (!hasChanged || (exitUrl && exitUrl.includes(safePath))) {
+        return null;
+      }
+
+      event.returnValue = true;
+    });
+  }
+});

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module Admin
+      class CreateScopedStyle < Rectify::Command
+        # Public: Initializes the command.
+        #
+        def initialize(organization)
+          @organization = organization
+          @ident = rand(36**8).to_s(36)
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          styles = AwesomeConfig.find_or_initialize_by(var: :scoped_styles, organization: @organization)
+          styles.value = {} unless styles.value.is_a? Hash
+          # TODO: prevent (unlikely) colisions with exisiting values
+          styles.value[@ident] = ""
+          styles.save!
+
+          broadcast(:ok, @ident)
+        rescue StandardError => e
+          broadcast(:invalid, e.message)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    module Admin
+      class DestroyScopedStyle < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # key - the key to destroy inise scoped_styles
+        # organization
+        def initialize(key, organization)
+          @key = key
+          @organization = organization
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          styles = AwesomeConfig.find_by(var: :scoped_styles, organization: @organization)
+          return broadcast(:invalid, "Not a hash") unless styles&.value.is_a? Hash
+          return broadcast(:invalid, "#{key} key invalid") unless styles.value.has_key?(@key)
+
+          styles.value.except!(@key)
+          styles.save!
+          # remove constrains associated (a new config var is generated automatically, by removing it, it will trigger destroy on dependents)
+          constraint = AwesomeConfig.find_by(var: "scoped_style_#{@key}", organization: @organization)
+          constraint.destroy! if constraint.present?
+
+          broadcast(:ok, @key)
+        rescue StandardError => e
+          broadcast(:invalid, e.message)
+        end
+      end
+    end
+  end
+end

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

@@ -19,7 +19,6 @@ module Decidim
 
         def update
           @form = form(ConfigForm).from_params(params)
-
           UpdateConfig.call(@form) do
             on(:ok) do
               flash[:notice] = I18n.t("config.update.success", scope: "decidim.decidim_awesome.admin")
@@ -33,6 +32,34 @@ module Decidim
           end
         end
 
+        def new_scoped_style
+          CreateScopedStyle.call(current_organization) do
+            on(:ok) do |key|
+              flash[:notice] = I18n.t("config.create_scoped_style.success", key: key, scope: "decidim.decidim_awesome.admin")
+            end
+
+            on(:invalid) do |message|
+              flash[:alert] = I18n.t("config.create_scoped_style.error", error: message, scope: "decidim.decidim_awesome.admin")
+            end
+          end
+
+          redirect_to decidim_admin_decidim_awesome.config_path(:styles)
+        end
+
+        def destroy_scoped_style
+          DestroyScopedStyle.call(params[:key], current_organization) do
+            on(:ok) do |key|
+              flash[:notice] = I18n.t("config.destroy_scoped_style.success", key: key, scope: "decidim.decidim_awesome.admin")
+            end
+
+            on(:invalid) do |message|
+              flash[:alert] = I18n.t("config.destroy_scoped_style.error", error: message, scope: "decidim.decidim_awesome.admin")
+            end
+          end
+
+          redirect_to decidim_admin_decidim_awesome.config_path(:styles)
+        end
+
         private
 
         def constraints_for(key)

data/app/forms/decidim/decidim_awesome/admin/config_form.rb

@@ -12,6 +12,7 @@ module Decidim
         attribute :use_markdown_editor, Boolean
         attribute :allow_images_in_markdown_editor, Boolean
         attribute :auto_save_forms, Boolean
+        attribute :scoped_styles, Hash
         attribute :intergram_for_admins, Boolean
         attribute :intergram_for_admins_settings, IntergramForm
         attribute :intergram_for_public, Boolean

data/app/views/decidim/decidim_awesome/admin/config/_form_styles.html.erb

@@ -0,0 +1,28 @@
+<div class="row column decidim_awesome-form">
+  <% if config_enabled? :scoped_styles %>
+    <p class="help-text"><%= t("help.scoped_styles", scope: "decidim.decidim_awesome.admin.config.form") %></p>
+    <p class="help-text">
+      <%= t("help.scoped_styles_variables", scope: "decidim.decidim_awesome.admin.config.form") %><br>
+      <% [:primary, :secondary, :success, :warning, :alert, :highlight, :highlight_alternative].each do |color| %>
+        var(--<%= color %>),
+      <% end %>
+    </p>
+
+    <% form.object.scoped_styles&.each do |key, value| %>
+      <div class="scoped-style" data-key="<%= key %>">
+        <%= label_tag :scoped_styles do %>
+          <%= t("config.scoped_styles", scope: "activemodel.attributes", id: key) %>
+          <%= link_to t(".remove"), decidim_admin_decidim_awesome.destroy_scoped_style_path(key: key), method: :post, class: "float-right", data: { confirm: t(".sure_to_remove") } %>
+        <% end %>
+        <%= text_area_tag key, value, name: "config[scoped_styles][#{key}]", rows: 5 %>
+        <%= render(partial: "decidim/decidim_awesome/admin/config/constraints", locals: { key: "scoped_style_#{key}", constraints: constraints_for("scoped_style_#{key}") }) %>
+      </div>
+    <% end %>
+
+    <%= link_to t(".new"), decidim_admin_decidim_awesome.new_scoped_style_path, method: :post %>
+
+  <% end %>
+</div>
+
+
+<%= javascript_include_tag "decidim/decidim_awesome/admin/form_exit_warn" %>

data/app/views/decidim/decidim_awesome/admin/config/show.html.erb

@@ -1,4 +1,4 @@
-<%= decidim_form_for(@form, method: :patch, url: decidim_admin_decidim_awesome.config_path(params[:var])) do |f| %>
+<%= decidim_form_for(@form, method: :patch, url: decidim_admin_decidim_awesome.config_path(params[:var]), html: { class: "awesome-edit-config" }, data: { "safe-path" => decidim_admin_decidim_awesome.config_path(params[:var]) }) do |f| %>
   <div class="card">
     <div class="card-divider">
       <h2 class="card-title"><%= t(".title", setting: params[:var]) %></h2>

data/app/views/layouts/decidim/admin/decidim_awesome.html.erb

@@ -16,6 +16,11 @@
           <%= aria_selected_link_to I18n.t("menu.surveys", scope: "decidim.decidim_awesome.admin"), decidim_admin_decidim_awesome.config_path(:surveys) %>
         </li>
       <% end %>
+      <% if config_enabled? :scoped_styles %>
+        <li <% if is_active_link?(decidim_admin_decidim_awesome.config_path(:styles)) %> class="is-active" <% end %>>
+          <%= aria_selected_link_to I18n.t("menu.styles", scope: "decidim.decidim_awesome.admin"), decidim_admin_decidim_awesome.config_path(:styles) %>
+        </li>
+      <% end %>
       <% if config_enabled? :allow_images_in_proposals %>
         <li <% if is_active_link?(decidim_admin_decidim_awesome.config_path(:proposals)) %> class="is-active" <% end %>>
           <%= aria_selected_link_to I18n.t("menu.proposals", scope: "decidim.decidim_awesome.admin"), decidim_admin_decidim_awesome.config_path(:proposals) %>

data/app/views/layouts/decidim/decidim_awesome/_awesome_config.html.erb

@@ -1,5 +1,5 @@
 <script>
-window.DecidimAwesome = <%= awesome_config.to_json.html_safe %>;
+window.DecidimAwesome = <%= javascript_config_vars %>;
 window.DecidimAwesome.editor_uploader_path = "<%= decidim_decidim_awesome.editor_images_path %>";
 window.DecidimAwesome.texts = {
   "drag_and_drop_image": "<%= j t(".drag_and_drop_image") %>",

data/app/views/layouts/decidim/decidim_awesome/_custom_styles.html.erb

@@ -0,0 +1,3 @@
+<style media="all">
+  <%= awesome_custom_styles %>
+</style>

data/app/views/v0.22/layouts/decidim/_head.html.erb

@@ -23,6 +23,7 @@
 
 <%= stylesheet_link_tag    "decidim/decidim_awesome/application", media: "all" %>
 <%= stylesheet_link_tag(tenant_stylesheets, media: "all") if tenant_stylesheets %>
+<%= render(partial: "layouts/decidim/decidim_awesome/custom_styles") if awesome_custom_styles %>
 
 <%= organization_colors %>
 <%= javascript_include_tag "decidim/confirm" %>

data/app/views/v0.23/layouts/decidim/_head.html.erb

@@ -23,6 +23,7 @@
 
 <%= stylesheet_link_tag    "decidim/decidim_awesome/application", media: "all" %>
 <%= stylesheet_link_tag(tenant_stylesheets, media: "all") if tenant_stylesheets %>
+<%= render(partial: "layouts/decidim/decidim_awesome/custom_styles") if awesome_custom_styles %>
 
 <%= organization_colors %>
 <%= javascript_include_tag "decidim/confirm" %>

data/config/locales/en.yml

@@ -22,6 +22,7 @@ en:
         intergram_title_open: Opened chat title
         intergram_use_floating_button: If checked, the closed chat is always a button
           instead of a text
+        scoped_styles: 'Custom styles #%{id}'
         use_markdown_editor: Use a Markdown editor instead of the HTML editor
       constraint:
         component_id: or specifically in
@@ -85,6 +86,12 @@ en:
             delete: Delete
             edit: Edit
             title: 'Applicable only in these cases:'
+          create_scoped_style:
+            error: Error creating a new CSS box! %{error}
+            success: CSS box %{key} created successfully!
+          destroy_scoped_style:
+            error: Error removing CSS box! %{error}
+            success: CSS box %{key} removed successfully!
           experimental: Experimental options
           form:
             help:
@@ -110,9 +117,17 @@ en:
               intergram_config: Invite the <a href="https://web.telegram.org/#/im?p=@IntergramBot">@Intergram
                 bot</a> to your group or start a chat with it directly. <a href="https://github.com/idoco/intergram#embed-intergram-in-your-website-with-these-2-simple-steps">+
                 info</a>
+              scoped_styles: Create custom CSS that applies only in certain parts
+                of the public web (use the restrictions editor for that)
+              scoped_styles_variables: 'You can use the following CSS variables for
+                organization customized colors:'
               use_markdown_editor: This will substitute the Quill WYSIWYG editor,
                 use a Markdown editor instead. Text will be rendered as HTML in the
                 public pages (text in database will be saved as markdown text)
+          form_styles:
+            new: Add a new CSS box
+            remove: Remove this CSS box
+            sure_to_remove: Are you sure you want to destroy this CSS box?
           rich_text_editor_in_public_views: 'NOTE: "Rich text editor for participants"
             is enabled, this option won''t apply. Use the editors hacks instead to
             enable images in proposals.'
@@ -148,6 +163,7 @@ en:
           editors: Editor hacks
           livechat: Live Chat
           proposals: Proposals hacks
+          styles: Custom styles
           surveys: Surveys & forms
       config:
         intergram:

data/lib/decidim/decidim_awesome.rb

@@ -59,6 +59,18 @@ 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
+
     # 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

@@ -13,6 +13,8 @@ module Decidim
         # Add admin engine routes here
         resources :constraints
         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/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/version.rb

@@ -3,7 +3,7 @@
 module Decidim
   # This holds the decidim-decidim_awesome version.
   module DecidimAwesome
-    VERSION = "0.6.2"
+    VERSION = "0.6.3"
     COMPAT_DECIDIM_VERSION = [">= 0.22.0", "< 0.24"].freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decidim-decidim_awesome
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Ivan Vergés
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-29 00:00:00.000000000 Z
+date: 2021-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-admin
@@ -116,6 +116,7 @@ files:
 - app/assets/images/decidim/decidim_awesome/platoniq-logo.png
 - app/assets/javascripts/decidim/decidim_awesome/admin.js
 - app/assets/javascripts/decidim/decidim_awesome/admin/constraints.js.es6
+- app/assets/javascripts/decidim/decidim_awesome/admin/form_exit_warn.js.es6
 - app/assets/javascripts/decidim/decidim_awesome/application.js
 - app/assets/javascripts/decidim/decidim_awesome/awesome_map/api_fetcher.js.es6
 - app/assets/javascripts/decidim/decidim_awesome/awesome_map/categories.js.es6
@@ -140,7 +141,9 @@ files:
 - app/assets/stylesheets/decidim/decidim_awesome/forms/autosave.scss
 - app/awesome_overrides/presenters/decidim/proposals/proposal_presenter_override.rb
 - app/commands/decidim/decidim_awesome/admin/create_constraint.rb
+- app/commands/decidim/decidim_awesome/admin/create_scoped_style.rb
 - app/commands/decidim/decidim_awesome/admin/destroy_constraint.rb
+- app/commands/decidim/decidim_awesome/admin/destroy_scoped_style.rb
 - app/commands/decidim/decidim_awesome/admin/update_config.rb
 - app/commands/decidim/decidim_awesome/admin/update_constraint.rb
 - app/commands/decidim/decidim_awesome/create_editor_image.rb
@@ -172,6 +175,7 @@ files:
 - app/views/decidim/decidim_awesome/admin/config/_form_editors.html.erb
 - app/views/decidim/decidim_awesome/admin/config/_form_livechat.html.erb
 - app/views/decidim/decidim_awesome/admin/config/_form_proposals.html.erb
+- app/views/decidim/decidim_awesome/admin/config/_form_styles.html.erb
 - app/views/decidim/decidim_awesome/admin/config/_form_surveys.html.erb
 - app/views/decidim/decidim_awesome/admin/config/_modal.html.erb
 - app/views/decidim/decidim_awesome/admin/config/show.html.erb
@@ -185,6 +189,7 @@ files:
 - app/views/layouts/decidim/admin/_header.html.erb
 - app/views/layouts/decidim/admin/decidim_awesome.html.erb
 - app/views/layouts/decidim/decidim_awesome/_awesome_config.html.erb
+- app/views/layouts/decidim/decidim_awesome/_custom_styles.html.erb
 - app/views/layouts/decidim/decidim_awesome/_intergram_widget.html.erb
 - app/views/v0.22/layouts/decidim/_head.html.erb
 - app/views/v0.22/layouts/decidim/admin/_header.html.erb