decidim-decidim_awesome 0.7.2 → 0.8.0

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

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+shared_examples "registered components" do |enabled|
+  if enabled
+    it "has components registered" do
+      expect(Decidim.component_manifests.pluck(:name)).to include(:awesome_map)
+      expect(Decidim.component_manifests.pluck(:name)).to include(:awesome_iframe)
+    end
+
+    it "has map content block is registered" do
+      expect(Decidim.content_blocks.for(:homepage).pluck(:name)).to include(:awesome_map)
+    end
+  else
+    it "components are not registered" do
+      expect(Decidim.component_manifests.pluck(:name)).not_to include(:awesome_map)
+      expect(Decidim.component_manifests.pluck(:name)).not_to include(:awesome_iframe)
+    end
+
+    it "map content block is not registered" do
+      expect(Decidim.content_blocks.for(:homepage).pluck(:name)).not_to include(:awesome_map)
+    end
+  end
+end
+
+shared_examples "activated concerns" do |enabled|
+  it "common concerns are registered" do
+    expect(ActionView::Base.included_modules).to include(Decidim::DecidimAwesome::AwesomeHelpers)
+    expect(Decidim::MenuPresenter.included_modules).to include(Decidim::DecidimAwesome::MenuPresenterOverride)
+    expect(Decidim::MenuItemPresenter.included_modules).to include(Decidim::DecidimAwesome::MenuItemPresenterOverride)
+  end
+
+  if enabled
+    it "concerns are registered" do
+      expect(Decidim::User.included_modules).to include(Decidim::DecidimAwesome::UserOverride)
+      expect(Decidim::ErrorsController.included_modules).to include(Decidim::DecidimAwesome::NotFoundRedirect)
+      expect(Decidim::Proposals::ApplicationHelper.included_modules).to include(Decidim::DecidimAwesome::Proposals::ApplicationHelperOverride)
+      expect(Decidim::Proposals::ProposalWizardCreateStepForm.included_modules).to include(Decidim::DecidimAwesome::Proposals::ProposalWizardCreateStepFormOverride)
+      expect(Decidim::AmendmentsHelper.included_modules).to include(Decidim::DecidimAwesome::AmendmentsHelperOverride)
+    end
+  else
+    it "concerns are not registered" do
+      expect(Decidim::User.included_modules).not_to include(Decidim::DecidimAwesome::UserOverride)
+      expect(Decidim::ErrorsController.included_modules).not_to include(Decidim::DecidimAwesome::NotFoundRedirect)
+      expect(Decidim::Proposals::ApplicationHelper.included_modules).not_to include(Decidim::DecidimAwesome::Proposals::ApplicationHelperOverride)
+      expect(Decidim::Proposals::ProposalWizardCreateStepForm.included_modules).not_to include(Decidim::DecidimAwesome::Proposals::ProposalWizardCreateStepFormOverride)
+      expect(Decidim::AmendmentsHelper.included_modules).not_to include(Decidim::DecidimAwesome::AmendmentsHelperOverride)
+    end
+  end
+end
+
+shared_examples "custom menus" do |enabled|
+  # rubocop:disable RSpec/EmptyExampleGroup
+  describe Decidim::MenuPresenter, type: :helper do
+    before do
+      allow(view).to receive(:current_organization).and_return(organization)
+      allow(view).to receive(:current_user).and_return(user)
+    end
+
+    if enabled
+      it "MenuPresenter returns an instance of MenuHacker" do
+        expect(Decidim::MenuPresenter.new(:menu, view).evaluated_menu).to be_a(Decidim::DecidimAwesome::MenuHacker)
+      end
+    else
+      it "MenuPresenter returns an instance of Decidim::Menu" do
+        expect(Decidim::MenuPresenter.new(:menu, view).evaluated_menu).to be_a(Decidim::Menu)
+      end
+    end
+  end
+  # rubocop:enable RSpec/EmptyExampleGroup
+end
+
+shared_examples "basic rendering" do |enabled|
+  describe "shows public pages", type: :system do
+    let(:image_vars) do
+      [
+        :allow_images_in_proposals,
+        :allow_images_in_small_editor,
+        :allow_images_in_full_editor,
+        :allow_images_in_proposals,
+        :use_markdown_editor,
+        :allow_images_in_markdown_editor,
+        :auto_save_forms,
+        :intergram_for_admins,
+        :intergram_for_public
+      ]
+    end
+
+    before do
+      switch_to_host(organization.host)
+      visit decidim.root_path
+    end
+
+    it "renders the home page" do
+      expect(page).to have_content("Home")
+    end
+
+    it "has DecidimAwesome object" do
+      expect(page.body).to have_content("window.DecidimAwesome")
+    end
+
+    it "has DecidimAwesome javascript and CSS" do
+      expect(page).to have_xpath("//link[@rel='stylesheet'][contains(@href,'decidim_decidim_awesome')]", visible: :all)
+      expect(page).to have_xpath("//script[contains(@src,'decidim_decidim_awesome')]", visible: :all)
+    end
+
+    if enabled
+      it "has editor images configs enabled" do
+        image_vars.each do |var|
+          expect(page.body).to have_content("\"#{var}\":true")
+        end
+      end
+
+      it "has custom fields javascript" do
+        expect(page).to have_xpath("//script[contains(@src,'decidim_decidim_awesome_proposals_custom_fields')]", visible: :all)
+      end
+
+      it "has custom styles CSS" do
+        expect(page.body).to have_content(styles)
+      end
+    else
+      it "has editor images configs disabled" do
+        image_vars.each do |var|
+          expect(page.body).to have_content("\"#{var}\":false")
+        end
+      end
+
+      it "do not have custom fields javascript" do
+        expect(page).not_to have_xpath("//script[contains(@src,'decidim_decidim_awesome_proposals_custom_fields')]", visible: :all)
+      end
+
+      it "do not have custom styles CSS" do
+        expect(page.body).not_to have_content(styles)
+      end
+    end
+  end
+
+  describe "shows admin pages", type: :system do
+    let(:menus) do
+      [
+        "config/editors",
+        "config/proposals",
+        "config/surveys",
+        "config/styles",
+        "config/proposal_custom_fields",
+        "config/admins",
+        "menu_hacks",
+        "custom_redirects",
+        "config/livechat"
+      ]
+    end
+
+    before do
+      switch_to_host(organization.host)
+      login_as user, scope: :user
+
+      visit decidim_admin_decidim_awesome.root_path
+    end
+
+    it "has DecidimAwesome object" do
+      expect(page.body).to have_content("window.DecidimAwesome")
+    end
+
+    it "has DecidimAwesome javascript and CSS" do
+      expect(page).to have_xpath("//link[@rel='stylesheet'][contains(@href,'decidim_admin_decidim_awesome')]", visible: :all)
+      expect(page).to have_xpath("//script[contains(@src,'decidim_admin_decidim_awesome')]", visible: :all)
+    end
+
+    if enabled
+      it "renders the editors page" do
+        expect(page).to have_content("Tweaks for editors")
+      end
+
+      it "has custom fields javascript" do
+        expect(page).to have_xpath("//script[contains(@src,'decidim_admin_decidim_awesome_custom_fields')]", visible: :all)
+      end
+
+      it "has all admin menus" do
+        menus.each do |menu|
+          within ".secondary-nav" do
+            expect(page).to have_link(href: "/admin/decidim_awesome/#{menu}")
+          end
+        end
+      end
+    else
+      it "renders the compatibility checks page" do
+        expect(page).to have_content("System compatibility checks")
+      end
+
+      it "do not have custom fields javascript" do
+        expect(page).not_to have_xpath("//script[contains(@src,'decidim_admin_decidim_awesome_custom_fields')]", visible: :all)
+      end
+
+      it "has no admin menus" do
+        menus.each do |menu|
+          within ".secondary-nav" do
+            expect(page).not_to have_link(href: "/admin/decidim_awesome/#{menu}")
+          end
+        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.7.2"
-    COMPAT_DECIDIM_VERSION = [">= 0.23.0", "< 0.25"].freeze
+    VERSION = "0.8.0"
+    COMPAT_DECIDIM_VERSION = [">= 0.25.0", "< 0.27"].freeze
   end
 end

data/lib/decidim/decidim_awesome.rb

@@ -1,165 +1,17 @@
 # frozen_string_literal: true
 
+require "decidim/decidim_awesome/awesome"
 require "decidim/decidim_awesome/admin"
 require "decidim/decidim_awesome/engine"
 require "decidim/decidim_awesome/admin_engine"
 require "decidim/decidim_awesome/context_analyzers"
 require "decidim/decidim_awesome/map_component/engine"
+require "decidim/decidim_awesome/map_component/admin_engine"
 require "decidim/decidim_awesome/map_component/component"
 require "decidim/decidim_awesome/iframe_component/engine"
+require "decidim/decidim_awesome/iframe_component/admin_engine"
 require "decidim/decidim_awesome/iframe_component/component"
-
-module Decidim
-  module DecidimAwesome
-    include ActiveSupport::Configurable
-
-    autoload :Config, "decidim/decidim_awesome/config"
-    autoload :SystemChecker, "decidim/decidim_awesome/system_checker"
-    autoload :ContextAnalyzers, "decidim/decidim_awesome/context_analyzers"
-    autoload :MenuHacker, "decidim/decidim_awesome/menu_hacker"
-    autoload :CustomFields, "decidim/decidim_awesome/custom_fields"
-
-    # Boolean configuration options
-    #
-    # Default values for configuration options:
-    #   true  => always true but admins can still restrict its scope
-    #   false => default false, admins can turn it true
-    #   :disabled => false and non available, hidden from admins
-    config_accessor :allow_images_in_full_editor do
-      false
-    end
-
-    config_accessor :allow_images_in_small_editor do
-      false
-    end
-
-    config_accessor :allow_images_in_proposals do
-      false
-    end
-
-    config_accessor :use_markdown_editor do
-      false
-    end
-
-    config_accessor :allow_images_in_markdown_editor do
-      false
-    end
-
-    # used to save forms in localstorage
-    config_accessor :auto_save_forms do
-      false
-    end
-
-    # Live chat widget linked to Telegram account or group
-    config_accessor :intergram_for_admins do
-      false
-    end
-
-    config_accessor :intergram_for_public do
-      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
-
-    # custom fields for proposals using JSON specification:
-    # https://github.com/jsonform/jsonform/wiki
-    # Valid values uses the same structure as :scoped_styles
-    #   :disabled => false and non available, hidden from admins
-    #   Hash => hash of different JSON texts, each key will be used for the contraints
-    # Admins can create this hash dynamically but some pre-defined css boxes can be created here as:
-    #   {
-    #      some_identifier: "{ ... some definition... }"
-    #   }
-    config_accessor :proposal_custom_fields 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
-
-    # Allows admins to assignate "fake" admins scoped to some admin zones using the
-    # same scope editor as :scoped_styles, valid values uses the same convention:
-    #   :disabled => false and non available, hidden from admins
-    #   Hash => hash of different admin ids, each key will be used for the contraints
-    # Admins create this hash dynamically but some pre-defined admin boxes can be created here as:
-    #   {
-    #      some_identifier: [1234, 5678, 90123]
-    #   }
-    config_accessor :scoped_admins do
-      {}
-    end
-
-    # these settings do not follow the :disabled convention but
-    # depends on the previous intergram configurations
-    config_accessor :intergram_url do
-      "https://www.intergram.xyz/js/widget.js"
-    end
-
-    # no need to override these settings, there admin-configurable
-    config_accessor :intergram_for_admins_settings do
-      {
-        chat_id: nil,
-        color: nil,
-        use_floating_button: false,
-        title_closed: nil,
-        title_open: nil,
-        intro_message: nil,
-        auto_response: nil,
-        auto_no_response: nil
-      }
-    end
-
-    config_accessor :intergram_for_public_settings do
-      {
-        chat_id: nil,
-        require_login: true,
-        color: nil,
-        use_floating_button: false,
-        title_closed: nil,
-        title_open: nil,
-        intro_message: nil,
-        auto_response: nil,
-        auto_no_response: nil
-      }
-    end
-
-    # additional correspondences between participatory spaces manifests and routes
-    # ie: /admin/assemblies and /admin/assemblies_types are both treated as a "assembly" participatory space in terms of permission scoping
-    # This can be tuned in a initialized if some other hacks over routes are applied
-    # if a registered participatory space is not listed here then the name manifest will be used as a default route /manifest_name /admin/manifes_name
-    config_accessor :participatory_spaces_routes_context do
-      {
-        # route in admin is diferent than in the frontend: /processes, /admin/participatory_processes
-        participatory_processes: [:participatory_processes, :processes],
-        # both /admin/assemblies and /admin/assemblies_types are considered assemblies
-        assemblies: [:assemblies, :assemblies_types],
-        # route in admin is diferent than in the frontend: /process_groups, /admin/participatory_process_groups
-        process_groups: [:processes_groups, :participatory_process_groups]
-      }
-    end
-  end
-end
+require "decidim/decidim_awesome/content_parsers/editor_images_parser"
 
 # Engines to handle logic unrelated to participatory spaces or components
 

data/lib/tasks/decidim_awesome_active_storage_migrations_tasks.rake

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+namespace :decidim_awesome do
+  namespace :active_storage_migrations do
+    desc "Migrates editor images from Carrierwave to ActiveStorage"
+    task migrate_from_carrierwave: :environment do
+      stdout = Logger.new($stdout)
+      stdout.level = Logger::INFO
+      Rails.logger.extend(ActiveSupport::Logger.broadcast(stdout))
+      Decidim::Organization.find_each do |organization|
+        puts "Migrating Organization #{organization.id} (#{organization.host})..."
+        routes_mappings = []
+        Decidim::DecidimAwesome::MigrateLegacyImagesJob.perform_now(organization.id, routes_mappings)
+
+        path = Rails.root.join("tmp/decidim_awesome_editor_images_mappings.csv")
+        dirname = File.dirname(path)
+        FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
+        File.open(path, "wb") do |file|
+          file.write(Decidim::Exporters::CSV.new(routes_mappings).export.read)
+        end
+      end
+    end
+
+    desc "Checks editor images migrated from Carrierwave to ActiveStorage"
+    task check_migration_from_carrierwave: :environment do
+      logger = ActiveSupport::TaggedLogging.new(Logger.new($stdout))
+
+      Decidim::CarrierWaveMigratorService.check_migration(
+        klass: Decidim::DecidimAwesome::EditorImage,
+        cw_attribute: "image",
+        cw_uploader: Decidim::Cw::DecidimAwesome::ImageUploader,
+        as_attribute: "file",
+        logger: logger
+      )
+    end
+  end
+end

data/lib/tasks/decidim_awesome_webpacker_tasks.rake

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "decidim/gem_manager"
+
+namespace :decidim_decidim_awesome do
+  namespace :webpacker do
+    desc "Installs Decidim Awesome webpacker files in Rails instance application"
+    task install: :environment do
+      raise "Decidim gem is not installed" if decidim_path.nil?
+
+      install_decidim_awesome_npm
+    end
+
+    desc "Adds Decidim Awesome dependencies in package.json"
+    task upgrade: :environment do
+      raise "Decidim gem is not installed" if decidim_path.nil?
+
+      install_decidim_awesome_npm
+    end
+
+    def install_decidim_awesome_npm
+      decidim_awesome_npm_dependencies.each do |type, packages|
+        system! "npm i --save-#{type} #{packages.join(" ")}"
+      end
+    end
+
+    def decidim_awesome_npm_dependencies
+      @decidim_awesome_npm_dependencies ||= begin
+        package_json = JSON.parse(File.read(decidim_awesome_path.join("package.json")))
+
+        {
+          prod: package_json["dependencies"].map { |package, version| "#{package}@#{version}" },
+          dev: package_json["devDependencies"].map { |package, version| "#{package}@#{version}" }
+        }.freeze
+      end
+    end
+
+    def decidim_awesome_path
+      @decidim_awesome_path ||= Pathname.new(decidim_awesome_gemspec.full_gem_path) if Gem.loaded_specs.has_key?(gem_name)
+    end
+
+    def decidim_awesome_gemspec
+      @decidim_awesome_gemspec ||= Gem.loaded_specs[gem_name]
+    end
+
+    def rails_app_path
+      @rails_app_path ||= Rails.root
+    end
+
+    def copy_awesome_file_to_application(origin_path, destination_path = origin_path)
+      FileUtils.cp(decidim_awesome_path.join(origin_path), rails_app_path.join(destination_path))
+    end
+
+    def system!(command)
+      system("cd #{rails_app_path} && #{command}") || abort("\n== Command #{command} failed ==")
+    end
+
+    def gem_name
+      "decidim-decidim_awesome"
+    end
+  end
+end