decidim-toggle 0.1.3

data/lib/decidim/toggle/tab_form.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Toggle
+    # Recommended base for organization settings tab forms.
+    #
+    #   class MyModule::AdminConfigForm < Decidim::Form
+    #     include Decidim::Toggle::TabForm
+    #     include Decidim::Toggle::ModuleConfigForm
+    #     ...
+    #   end
+    module TabForm
+      extend ActiveSupport::Concern
+
+      included do
+        include InformativeCallouts
+      end
+    end
+  end
+end

data/lib/decidim/toggle/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This holds the decidim-toggle version.
+  module Toggle
+    def self.version
+      "0.1.3" # DO NOT UPDATE MANUALLY
+    end
+
+    def self.decidim_version
+      [">= 0.29", "< 0.33"].freeze
+    end
+  end
+end

data/lib/decidim/toggle.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "decidim/toggle/version"
+require "decidim/toggle/gem_registry"
+require "decidim/toggle/settings_tab_registry"
+require "decidim/toggle/settings_tab_item"
+require "decidim/toggle/settings_tabs"
+require "decidim/toggle/module_config"
+require "decidim/toggle/informative_callouts"
+require "decidim/toggle/module_config_i18n"
+require "decidim/toggle/module_config_form"
+require "decidim/toggle/tab_form"
+require "decidim/toggle/expose_attributes_to_js"
+require "decidim/toggle/javascript_config"
+require "decidim/toggle/engine"
+
+module Decidim
+  module Toggle
+    def self.settings_tabs(name, &)
+      SettingsTabRegistry.register(name, &)
+    end
+
+    # @param gem_name [String, Symbol] Bundler gem name (e.g. +"decidim-space_page"+)
+    # @return [Boolean]
+    def self.gem_present?(gem_name)
+      GemRegistry.present?(gem_name)
+    end
+
+    # @param organization [Decidim::Organization, nil]
+    # @param registry_name [Symbol] settings tab registry (default +:organization_settings+)
+    # @return [Hash{String => Object}] flat keys like +"decidim_geo.enabled"+
+    def self.javascript_config_for(organization, registry_name: :organization_settings)
+      JavascriptConfig.for(organization, registry_name:)
+    end
+  end
+end

data/lib/tasks/decidim/toggle/toggle_upgrade.rake

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+Rake::Task["decidim:choose_target_plugins"].enhance do
+  name = Decidim::Toggle::Engine.railtie_name
+  ENV["FROM"] = "#{ENV.fetch("FROM", nil)},#{name}" unless ENV["FROM"].to_s.include?(name)
+end
+
+if Rake::Task.task_defined?("decidim:upgrade")
+  Rake::Task["decidim:upgrade"].enhance do
+    name = Decidim::Toggle::Engine.railtie_name
+    Rake::Task["#{name}:webpacker:install"].invoke if Rake::Task.task_defined?("#{name}:webpacker:install")
+  end
+end

data/lib/tasks/decidim/toggle/toggle_webpacker.rake

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "decidim/gem_manager"
+
+namespace :decidim_toggle do
+  namespace :webpacker do
+    desc "Installs Toggle webpacker files in Rails instance application"
+    task install: :environment do
+      raise "Decidim gem is not installed" if decidim_path.nil?
+
+      install_toggle_npm
+    end
+
+    desc "Adds Toggle dependencies in package.json"
+    task upgrade: :environment do
+      raise "Decidim gem is not installed" if decidim_path.nil?
+
+      install_toggle_npm
+    end
+
+    def install_toggle_npm
+      return if toggle_npm_dependencies.empty?
+
+      puts "install NPM packages. You can also do this manually with this command:"
+      puts "npm i #{toggle_npm_dependencies.join(" ")}"
+      toggle_system! "npm i #{toggle_npm_dependencies.join(" ")}"
+    end
+
+    def toggle_npm_dependencies
+      @toggle_npm_dependencies ||=
+        if toggle_path.nil? || !File.exist?(toggle_path.join("package.json"))
+          []
+        else
+          package_json = JSON.parse(File.read(toggle_path.join("package.json")))
+
+          (package_json["dependencies"] || {}).map { |package, version| "#{package}@#{version}" }
+        end
+    end
+
+    def toggle_path
+      @toggle_path ||= Pathname.new(toggle_gemspec.full_gem_path) if Gem.loaded_specs.has_key?(toggle_gem_name)
+    end
+
+    def rails_app_path
+      @rails_app_path ||= Rails.root
+    end
+
+    def toggle_system!(command)
+      system("cd #{rails_app_path} && #{command}") || abort("\n== Command #{command} failed ==")
+    end
+
+    def toggle_gemspec
+      @toggle_gemspec ||= Gem.loaded_specs[toggle_gem_name]
+    end
+
+    def toggle_gem_name
+      "decidim-toggle"
+    end
+  end
+end

data/log/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "decidim-toggle",
+  "private": true,
+  "version": "0.1.3",
+  "description": "Decidim system settings tabbed UI",
+  "devDependencies": {
+    "@decidim/prettier-config": "0.29",
+    "prettier": "^2.3.2"
+  },
+  "scripts": {
+    "format": "prettier --write \"./app/packs/**/*.{js,scss,css}\" --no-error-on-unmatched-pattern",
+    "format:check": "prettier --check \"./app/packs/**/*.{js,scss,css}\" --no-error-on-unmatched-pattern",
+    "postversion": "bash bin/postversion",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "license": "AGPL-3.0-or-later",
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+}

data/prettier.config.js

@@ -0,0 +1,15 @@
+const decidimPrettier = require("@decidim/prettier-config");
+
+module.exports = {
+  ...decidimPrettier,
+  overrides: [
+    ...(decidimPrettier.overrides || []),
+    {
+      files: "*.scss",
+      options: {
+        parser: "scss",
+        singleQuote: false
+      }
+    }
+  ]
+};

data/spec/commands/decidim/toggle/update_authorizations_command_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Decidim
+  module Toggle
+    describe UpdateAuthorizationsCommand do
+      let(:organization) { create(:organization, available_authorizations: []) }
+
+      it "updates available_authorizations when form is valid" do
+        form = UpdateAuthorizationsForm.from_params(
+          organization: { available_authorizations: %w(dummy_authorization_handler) }
+        ).with_context(current_organization: organization)
+
+        outcomes = []
+        cmd = described_class.new(organization, form)
+        cmd.on(:ok) { outcomes << :ok }
+        cmd.on(:invalid) { outcomes << :invalid }
+        cmd.call
+
+        expect(outcomes).to eq([:ok])
+        expect(organization.reload.available_authorizations).to eq(%w(dummy_authorization_handler))
+      end
+
+      it "broadcasts invalid when form is invalid" do
+        form = UpdateAuthorizationsForm.from_params(
+          organization: { available_authorizations: %w(not_a_real_workflow) }
+        ).with_context(current_organization: organization)
+
+        outcomes = []
+        cmd = described_class.new(organization, form)
+        cmd.on(:ok) { outcomes << :ok }
+        cmd.on(:invalid) { outcomes << :invalid }
+        cmd.call
+
+        expect(outcomes).to eq([:invalid])
+        expect(organization.reload.available_authorizations).to eq([])
+      end
+    end
+  end
+end

data/spec/commands/decidim/toggle/update_emails_command_spec.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Decidim
+  module Toggle
+    describe UpdateEmailsCommand do
+      let(:organization) do
+        Struct.new(:smtp_settings) do
+          def save!
+            @saved = true
+          end
+
+          def saved?
+            !!@saved
+          end
+        end.new
+      end
+
+      it "updates smtp_settings when form is valid" do
+        form = instance_double(UpdateEmailsForm, invalid?: false, encrypted_smtp_settings: { "host" => "smtp.example" })
+
+        outcomes = []
+        expect(Decidim::OrganizationSettings).to receive(:reload).with(organization)
+
+        cmd = described_class.new(organization, form)
+        cmd.on(:ok) { outcomes << :ok }
+        cmd.on(:invalid) { outcomes << :invalid }
+
+        cmd.call
+
+        expect(outcomes).to eq([:ok])
+        expect(organization.smtp_settings).to eq({ "host" => "smtp.example" })
+        expect(organization).to be_saved
+      end
+
+      it "broadcasts invalid when the form is invalid" do
+        form = instance_double(UpdateEmailsForm, invalid?: true)
+
+        outcomes = []
+        expect(organization).not_to receive(:save!)
+        cmd = described_class.new(organization, form)
+        cmd.on(:ok) { outcomes << :ok }
+        cmd.on(:invalid) { outcomes << :invalid }
+
+        cmd.call
+
+        expect(outcomes).to eq([:invalid])
+        expect(organization.smtp_settings).to be_nil
+      end
+
+      it "broadcasts invalid when saving fails" do
+        errors = double("errors", full_messages: [])
+        invalid_record_class = Class.new do
+          def initialize(record_errors)
+            @errors = record_errors
+          end
+
+          def errors
+            @errors
+          end
+
+          def self.i18n_scope
+            "fake_scope"
+          end
+        end
+
+        invalid_record = invalid_record_class.new(errors)
+        allow(organization).to receive(:save!).and_raise(ActiveRecord::RecordInvalid.new(invalid_record))
+
+        form = instance_double(UpdateEmailsForm, invalid?: false, encrypted_smtp_settings: { "host" => "smtp.example" })
+
+        outcomes = []
+        cmd = described_class.new(organization, form)
+        cmd.on(:ok) { outcomes << :ok }
+        cmd.on(:invalid) { outcomes << :invalid }
+
+        cmd.call
+
+        expect(outcomes).to eq([:invalid])
+      end
+    end
+  end
+end

data/spec/commands/decidim/toggle/update_file_upload_settings_command_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Decidim
+  module Toggle
+    describe UpdateFileUploadSettingsCommand do
+      let(:organization) { create(:organization) }
+
+      it "updates file_upload_settings when form is valid" do
+        form = UpdateFileUploadSettingsForm.from_model(organization)
+        form.file_upload_settings.maximum_file_size = {
+          default: 5.0,
+          avatar: 2.0
+        }
+
+        outcomes = []
+        cmd = described_class.new(organization, form)
+        cmd.on(:ok) { outcomes << :ok }
+        cmd.on(:invalid) { outcomes << :invalid }
+        cmd.call
+        expect(outcomes).to eq([:ok])
+        expect(organization.reload.file_upload_settings["maximum_file_size"]["default"]).to eq(5.0)
+        expect(organization.file_upload_settings["maximum_file_size"]["avatar"]).to eq(2.0)
+      end
+    end
+  end
+end

data/spec/commands/decidim/toggle/update_locale_command_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Decidim
+  module Toggle
+    describe UpdateLocaleCommand do
+      let(:organization) { create(:organization) }
+      let(:rebuild_search_task) { instance_double(Rake::Task, invoke: nil, reenable: nil) }
+
+      before do
+        allow(Rails.application).to receive(:load_tasks)
+        allow(Rake::Task).to receive(:[]).and_call_original
+        allow(Rake::Task).to receive(:[]).with("decidim:locales:rebuild_search").and_return(rebuild_search_task)
+      end
+
+      it "updates locales and rebuilds search index" do
+        organization.update!(available_locales: %w(en ca), default_locale: "ca")
+
+        expect(Rails.application).to receive(:load_tasks).ordered
+        expect(rebuild_search_task).to receive(:reenable).ordered
+        expect(rebuild_search_task).to receive(:invoke).ordered
+
+        form = UpdateLocaleForm.from_params(
+          organization: { available_locales: { "en" => "1" }, default_locale: "en" }
+        ).with_context(current_organization: organization)
+
+        outcomes = []
+        cmd = described_class.new(organization, form)
+        cmd.on(:ok) { outcomes << :ok }
+        cmd.on(:invalid) { outcomes << :invalid }
+        cmd.call
+        expect(outcomes).to eq([:ok])
+        organization.reload
+        expect(organization.available_locales).to eq(%w(en))
+        expect(organization.default_locale).to eq("en")
+      end
+
+      it "broadcasts invalid when form is invalid" do
+        form = UpdateLocaleForm.from_model(organization)
+        form.available_locales = []
+        form.default_locale = ""
+
+        outcomes = []
+        cmd = described_class.new(organization, form)
+        cmd.on(:ok) { outcomes << :ok }
+        cmd.on(:invalid) { outcomes << :invalid }
+        cmd.call
+        expect(outcomes).to eq([:invalid])
+      end
+    end
+  end
+end

data/spec/commands/decidim/toggle/update_module_config_command_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Decidim
+  module Toggle
+    describe UpdateModuleConfigCommand do
+      let(:organization) { create(:organization) }
+
+      let(:form_class) do
+        Class.new(Decidim::Form) do
+          include Decidim::Toggle::ModuleConfigForm
+
+          self.module_config_name = "decidim_geo"
+
+          mimic :organization
+          attribute :enabled, :boolean
+        end
+      end
+
+      describe "#call" do
+        it "broadcasts :ok and persists config" do
+          form = form_class.from_params(organization: { enabled: true }).with_context(current_organization: organization)
+
+          outcomes = []
+          cmd = described_class.new(organization, form)
+          cmd.on(:ok) { outcomes << :ok }
+          cmd.on(:invalid) { outcomes << :invalid }
+          cmd.call
+
+          expect(outcomes).to eq([:ok])
+          row = OrganizationModuleConfig.find_by!(decidim_organization_id: organization.id, module_name: "decidim_geo")
+          expect(row.config["enabled"]).to be(true)
+        end
+      end
+    end
+  end
+end

data/spec/commands/decidim/toggle/update_name_command_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Decidim
+  module Toggle
+    describe UpdateNameCommand do
+      let(:organization) { create(:organization) }
+
+      it "updates organization when form is valid" do
+        form = UpdateNameForm.from_params(
+          organization: {
+            name_en: "New org name",
+            host: "newhost.example.org",
+            secondary_hosts: "alias.example.org"
+          }
+        ).with_context(current_organization: organization)
+
+        outcomes = []
+        cmd = described_class.new(organization, form)
+        cmd.on(:ok) { outcomes << :ok }
+        cmd.on(:invalid) { outcomes << :invalid }
+        cmd.call
+        expect(outcomes).to eq([:ok])
+        organization.reload
+        expect(organization.name["en"]).to eq("New org name")
+        expect(organization.host).to eq("newhost.example.org")
+        expect(organization.secondary_hosts).to eq(["alias.example.org"])
+      end
+
+      it "broadcasts invalid when form is invalid" do
+        form = UpdateNameForm.from_params(
+          organization: {
+            name_en: "",
+            host: "",
+            secondary_hosts: ""
+          }
+        ).with_context(current_organization: organization)
+
+        outcomes = []
+        cmd = described_class.new(organization, form)
+        cmd.on(:ok) { outcomes << :ok }
+        cmd.on(:invalid) { outcomes << :invalid }
+        cmd.call
+        expect(outcomes).to eq([:invalid])
+      end
+    end
+  end
+end

data/spec/commands/decidim/toggle/update_omniauth_command_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Decidim
+  module Toggle
+    describe UpdateOmniauthCommand do
+      let(:organization) do
+        Struct.new(:omniauth_settings) do
+          def save!
+            @saved = true
+          end
+
+          def saved?
+            !!@saved
+          end
+        end.new
+      end
+
+      it "updates omniauth_settings when form is valid" do
+        form = instance_double(UpdateOmniauthForm, invalid?: false, encrypted_omniauth_settings: { "foo" => "bar" })
+
+        outcomes = []
+        expect(Decidim::OrganizationSettings).to receive(:reload).with(organization)
+
+        cmd = described_class.new(organization, form)
+        cmd.on(:ok) { outcomes << :ok }
+        cmd.on(:invalid) { outcomes << :invalid }
+        cmd.call
+
+        expect(outcomes).to eq([:ok])
+        expect(organization.omniauth_settings).to eq({ "foo" => "bar" })
+        expect(organization).to be_saved
+      end
+
+      it "broadcasts invalid when the form is invalid" do
+        form = instance_double(UpdateOmniauthForm, invalid?: true)
+
+        outcomes = []
+        expect(organization).not_to receive(:save!)
+        cmd = described_class.new(organization, form)
+        cmd.on(:ok) { outcomes << :ok }
+        cmd.on(:invalid) { outcomes << :invalid }
+        cmd.call
+
+        expect(outcomes).to eq([:invalid])
+      end
+
+      it "broadcasts invalid when saving fails" do
+        errors = double("errors", full_messages: [])
+        invalid_record_class = Class.new do
+          def initialize(record_errors)
+            @errors = record_errors
+          end
+
+          def errors
+            @errors
+          end
+
+          def self.i18n_scope
+            "fake_scope"
+          end
+        end
+
+        invalid_record = invalid_record_class.new(errors)
+        allow(organization).to receive(:save!).and_raise(ActiveRecord::RecordInvalid.new(invalid_record))
+
+        form = instance_double(UpdateOmniauthForm, invalid?: false, encrypted_omniauth_settings: { "foo" => "bar" })
+
+        outcomes = []
+        cmd = described_class.new(organization, form)
+        cmd.on(:ok) { outcomes << :ok }
+        cmd.on(:invalid) { outcomes << :invalid }
+        cmd.call
+
+        expect(outcomes).to eq([:invalid])
+      end
+    end
+  end
+end

data/spec/commands/decidim/toggle/update_security_command_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Decidim
+  module Toggle
+    describe UpdateSecurityCommand do
+      let(:organization) { create(:organization) }
+
+      it "updates security fields when form is valid" do
+        form = UpdateSecurityForm.from_model(organization)
+        form.force_users_to_authenticate_before_access_organization = true
+        form.users_registration_mode = "enabled"
+
+        outcomes = []
+        cmd = described_class.new(organization, form)
+        cmd.on(:ok) { outcomes << :ok }
+        cmd.on(:invalid) { outcomes << :invalid }
+        cmd.call
+        expect(outcomes).to eq([:ok])
+        expect(organization.reload.force_users_to_authenticate_before_access_organization).to be true
+      end
+    end
+  end
+end

data/spec/decidim/toggle/settings_tab_item_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Decidim
+  module Toggle
+    describe SettingsTabItem do
+      it "detects form tabs" do
+        form = described_class.new(:f, "L", form_class: String, command_class: Integer)
+        expect(form).to be_form_tab
+      end
+
+      it "respects open? and visible?" do
+        open = described_class.new(:a, "A", open: true, if: true)
+        hidden = described_class.new(:b, "B", if: false)
+        expect(open).to be_open
+        expect(open).to be_visible
+        expect(hidden).not_to be_visible
+      end
+
+      it "allows form tab with form_layout_partial" do
+        item = described_class.new(
+          :lang,
+          "L",
+          form_class: String,
+          command_class: Integer,
+          form_layout_partial: "decidim_toggle/system/organizations/tabs/language_tab"
+        )
+        expect(item).to be_form_tab
+        expect(item.form_layout_partial).to include("language_tab")
+      end
+    end
+  end
+end