decidim-decidim_awesome 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eed88558d87e79b6943a0fafa5e482129482f29d60de45cb30dabeb696a726d
-  data.tar.gz: 3818b75fbfa54b2517e75c2873f443262afeb684735a348f4e4a110a4979fe30
+  metadata.gz: 3eae6aea754d4ce898a8631f7d8c3b03946a11fc0cb15c5e1d373d98774aabeb
+  data.tar.gz: 7f3107a8bfa4d3069c34cf28c7347686d38811fd7f9d6b1a18ff41e470216af2
 SHA512:
-  metadata.gz: 1036da296077cd339bc14428b2c3bdcd8e47ebbc881ede6d96fe0f74c513d78f5e8691aff184754932c7e071d942d1d9c2dbb93bcbf5b32c6d2b1627f4c2bb60
-  data.tar.gz: a0b3b5476eef71ab74b45bee55366bcd9c90918daa7e3aa043dd85aaa9adca6518b2984fe46d5d5567f72fadbfc3c72d653c99cea07f13e1f0a8fe220226daaf
+  metadata.gz: dbbaaea663e4c9d317e7f971e0da7446577d6427245da4f17993b971c166a951e7eaeeb2d0264f01eaded4b3eb65b79c07ecec9e216cafc7e45ed6dc1fc010a4
+  data.tar.gz: d77a435d6ebf77601d27344a744048e1eff43f599e64a330dcb9e7ea3f22e1efbbf808fb676891dd4404d334acc217a5a19fd892482631cc148992c342295893

data/README.md

@@ -6,7 +6,7 @@
 
 Usability and UX tweaks for Decidim.
 
-This plugin allows the administrators to expand the possibilities of Decidim beyond some existing limitations. 
+This plugin allows the administrators to expand the possibilities of Decidim beyond some existing limitations.
 All tweaks are provided in a optional fashion with granular permissions that let the administrator to choose exactly where to apply those mods. Some tweaks can be applied to any assembly, other in an specific participatory process or even in type of component only.
 
 **This in beta status, we do not accept any responsibility for breaking anything. Feedback is appreciated though.**
@@ -16,7 +16,7 @@ All tweaks are provided in a optional fashion with granular permissions that let
 At Platoniq, we like to explore and combine open tools for enriching democracy in many levels. And also for organizations or companies, not only governments.
 Currently we are working very closely with the team behind [Decidim](https://decidim.org) because we believe that it is a great software.
 
-However in Platoniq we have this slogan: "Democracy is fun if you take it seriously" (feel free to ask for T-shirts 😉). 
+However in Platoniq we have this slogan: "Democracy is fun if you take it seriously" (feel free to ask for T-shirts 😉).
 And, let's face it, sometimes we feel that Decidim lacks a bit of the "fun" part so we created this.
 Because Decidim is awesome and so is this!
 
@@ -89,7 +89,7 @@ This feature allows to customize each organization css without affecting the oth
 4. Modify that file as you like, you can use any SASS function available (such as `@import`)
 5. Restart your server, enjoy!
 
-See an example here: 
+See an example here:
 https://github.com/Platoniq/decidim-demo/tree/master/app/assets/themes
 
 NOTE: Files presents in the `app/assets/themes` folder are added automatically into the precompile list of Rails by this plugin.
@@ -109,7 +109,7 @@ With this feature you can have a support chat in Decidim. It is linked to a [Tel
 
 #### To be continued...
 
-Some things in the road-map: 
+Some things in the road-map:
 
 1. Improve the conversation in comments by allowing images
 1. Direct export of surveys in PDF
@@ -121,7 +121,7 @@ Some things in the road-map:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "decidim-decidim_awesome", "~> 0.6.1"
+gem "decidim-decidim_awesome", "~> 0.6.2"
 ```
 
 And then execute:
@@ -141,7 +141,7 @@ Depending on your Decidim version, choose the corresponding Awesome version to e
 
 ## Configuration
 
-Each tweak can be enabled or disabled by default. It also can be deactivated so 
+Each tweak can be enabled or disabled by default. It also can be deactivated so
 admins do not even see it.
 
 In order to personalize default values, create an initializer such as:
@@ -244,15 +244,23 @@ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake test_
 DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rspec
 ```
 
-However, this project also make use of the gem [Appraisals](https://github.com/thoughtbot/appraisal) in order to test againts several versions of Decidim. The idea is to suport same supported versions of Decidim.
+However, this project also make use of the gem [Appraisals](https://github.com/thoughtbot/appraisal) in order to test against several versions of Decidim. The idea is to support same supported versions of Decidim.
 
 You can run run all tests against all Decidim versions by using:
+
 ```bash
 bundle exec appraisal install
-DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake test_app
+DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec appraisal rake test_app
 DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec appraisal rspec
 ```
 
+To test a specific apprasail configured version do the following:
+
+```
+DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec appraisal decidim-0.23 rake test_app
+DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec appraisal decidim-0.23 rspec
+```
+
 Note that the database user has to have rights to create and drop a database in
 order to create the dummy test app database.
 
@@ -276,13 +284,15 @@ the code coverage report.
 
 ### Appraisals commands
 
+The [Appraisals](Appraisals) file contains the supported versions. In i each version defines the changes respect to the main `Gemfile`.
+
 Appraisal uses custom gems for testing in the folder `gemfiles`, these gemfiles are generated from the file `Appraisals`. To update definitions do:
 
 ```
 bundle exec appraisal install
 ```
 
-To update the Appraisal definitions manually do the following:
+The former command will take care of updating all configured version. To update the Appraisal definitions manually (not usually necessary) do the following:
 
 ```
 cd gemfiles

data/app/assets/javascripts/decidim/decidim_awesome/editors/quill_editor.js.es6

@@ -12,7 +12,7 @@
   // Redefines Quill editor with images
   if(exports.DecidimAwesome.allow_images_in_full_editor  || exports.DecidimAwesome.allow_images_in_small_editor || exports.DecidimAwesome.use_markdown_editor) {
 
-    const quillFormats = ["bold", "italic", "link", "underline", "header", "list", "video", "image"];
+    const quillFormats = ["bold", "italic", "link", "underline", "header", "list", "video", "image", "alt"];
 
     const createQuillEditor = (container) => {
       const toolbar = $(container).data("toolbar");

data/app/awesome_overrides/presenters/decidim/proposals/proposal_presenter_override.rb

@@ -2,8 +2,30 @@
 
 # Tune Proposal presenter to use markdown if configured
 Decidim::Proposals::ProposalPresenter.class_eval do
-  def body(links: false, extras: true, strip_tags: false)
-    if respond_to? :translated_attribute
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/PerceivedComplexity
+  def body(links: false, extras: true, strip_tags: false, all_locales: false)
+    return unless proposal
+
+    if defined? handle_locales
+      return handle_locales(proposal.body, all_locales) do |content|
+        content = strip_tags(sanitize_text(content)) if strip_tags
+
+        renderer = Decidim::ContentRenderers::HashtagRenderer.new(content)
+        content = renderer.render(links: links, extras: extras).html_safe
+
+        if use_markdown?(proposal) && !all_locales # avoid rendering in editors
+          content = render_markdown(content)
+        elsif links
+          content = Decidim::ContentRenderers::LinkRenderer.new(content).render
+        end
+        content
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
+
+    if defined? translated_attribute
       text = translated_attribute(proposal.body)
 
       text = strip_tags(sanitize_text(text)) if strip_tags
@@ -17,9 +39,7 @@ Decidim::Proposals::ProposalPresenter.class_eval do
     text = renderer.render(links: links, extras: extras).html_safe
 
     if use_markdown? proposal
-      text = Decidim::DecidimAwesome::ContentRenderers::MarkdownRenderer.new(text).render
-      # HACK: to avoid the replacement of lines to <br> that simple_format does
-      text = text.gsub(">\n", ">").gsub("\n<", "<")
+      text = render_markdown(text)
     elsif links
       text = Decidim::ContentRenderers::LinkRenderer.new(text).render
     end
@@ -35,4 +55,10 @@ Decidim::Proposals::ProposalPresenter.class_eval do
     config.context_from_component proposal
     config.enabled_for? :use_markdown_editor
   end
+
+  def render_markdown(content)
+    content = Decidim::DecidimAwesome::ContentRenderers::MarkdownRenderer.new(content).render
+    # HACK: to avoid the replacement of lines to <br> that simple_format does
+    content.gsub(">\n", ">").gsub("\n<", "<")
+  end
 end

data/lib/decidim/decidim_awesome/checksums.yml

@@ -9,7 +9,9 @@ decidim-core:
   /app/assets/javascripts/decidim/editor.js.es6:
     decidim-0.22: 797d0ec1c9e79453cf6718f82d2fdd27
     decidim-0.23: cb059b8ff0ffc62c67eb99d8d7a6637b
+    decidim-0.23.1: 4787f73f0f33661e3897404f10019d26
 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/iframe_component/component.rb

@@ -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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decidim-decidim_awesome
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Ivan Vergés
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-admin
@@ -223,6 +223,7 @@ files:
 - lib/decidim/decidim_awesome/test/layouts/decidim/_head.html.erb
 - lib/decidim/decidim_awesome/test/layouts/decidim/admin/_header.html.erb
 - lib/decidim/decidim_awesome/test/shared_examples/config_examples.rb
+- lib/decidim/decidim_awesome/test/shared_examples/editor_examples.rb
 - lib/decidim/decidim_awesome/test/themes/css.lvh.me.css
 - lib/decidim/decidim_awesome/test/themes/erb.lvh.me.scss.erb
 - lib/decidim/decidim_awesome/test/themes/scss.lvh.me.scss