decidim-decidim_awesome 0.5.1

data/db/migrate/20200324170000_create_decidim_awesome_config.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class CreateDecidimAwesomeConfig < ActiveRecord::Migration[5.2]
+  def change
+    create_table :decidim_awesome_config do |t|
+      t.jsonb :var
+      t.jsonb :value
+      t.integer :decidim_organization_id,
+                foreign_key: true,
+                index: { name: "index_decidim_awesome_on_decidim_organization_id" }
+
+      t.timestamps
+      t.index [:var, :decidim_organization_id], name: "index_decidim_awesome_organization_var", unique: true
+    end
+  end
+end

data/db/migrate/20200324230936_create_awesome_editor_images.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class CreateAwesomeEditorImages < ActiveRecord::Migration[5.2]
+  def change
+    create_table :decidim_awesome_editor_images do |t|
+      t.string :image
+      t.string :path
+      t.references :decidim_author, null: false, foreign_key: { to_table: :decidim_users }, index: { name: "decidim_awesome_editor_images_author" }
+      t.references :decidim_organization, null: false, foreign_key: true, index: { name: "decidim_awesome_editor_images_constraint_organization" }
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200403142257_create_decidim_awesome_config_constraints.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateDecidimAwesomeConfigConstraints < ActiveRecord::Migration[5.2]
+  def change
+    create_table :decidim_awesome_config_constraints do |t|
+      t.jsonb :settings
+
+      t.references :decidim_awesome_config, null: false, foreign_key: { to_table: :decidim_awesome_config }, index: { name: "decidim_awesome_config_constraints_config" }
+      t.timestamps
+      t.index [:settings, :decidim_awesome_config_id], name: "index_decidim_awesome_settings_awesome_config", unique: true
+    end
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+if !Rails.env.production? || ENV["SEED"]
+  print "Creating seeds for decidim_awesome...\n" unless Rails.env.test?
+
+  organization = Decidim::Organization.first
+
+  # Set the htmleditor on to facilitate development
+  admin_user = Decidim::User.find_by(
+    organization: organization,
+    email: "admin@example.org"
+  )
+
+  Decidim.traceability.update!(
+    organization,
+    admin_user,
+    rich_text_editor_in_public_views: true
+  )
+
+  # Enable images in general
+  setting = Decidim::DecidimAwesome::AwesomeConfig.find_or_initialize_by(var: :allow_images_in_full_editor, organization: organization)
+  setting.value = true
+  setting.save!
+  setting = Decidim::DecidimAwesome::AwesomeConfig.find_or_initialize_by(var: :allow_images_in_small_editor, organization: organization)
+  setting.value = true
+  setting.save!
+end

data/lib/decidim/decidim_awesome.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "decidim/decidim_awesome/admin"
+require "decidim/decidim_awesome/engine"
+require "decidim/decidim_awesome/admin_engine"
+require "decidim/decidim_awesome/content_renderers"
+require "decidim/decidim_awesome/context_analyzers"
+require "decidim/decidim_awesome/map_component/engine"
+require "decidim/decidim_awesome/map_component/component"
+require "decidim/decidim_awesome/iframe_component/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 :ContentRenderes, "decidim/decidim_awesome/content_renderers"
+    autoload :ContextAnalyzers, "decidim/decidim_awesome/context_analyzers"
+
+    # 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
+
+    # 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
+  end
+end
+
+# Engines to handle logic unrelated to participatory spaces or components
+
+Decidim.register_global_engine(
+  :decidim_decidim_awesome, # this is the name of the global method to access engine routes
+  ::Decidim::DecidimAwesome::Engine,
+  at: "/decidim_awesome"
+)
+
+# Decidim.register_global_engine(
+#   :decidim_admin_action_awesome,
+#   ::Decidim::DecidimAwesome::AdminEngine,
+#   at: "/admin/action_awesome"
+# )

data/lib/decidim/decidim_awesome/admin.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    # This module contains all the domain logic associated to Decidim's DecidimAwesome
+    # component admin panel.
+    module Admin
+    end
+  end
+end

data/lib/decidim/decidim_awesome/admin_engine.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    # This is the engine that runs on the public interface of `DecidimAwesome`.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::DecidimAwesome::Admin
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      routes do
+        # Add admin engine routes here
+        resources :constraints
+        resources :config, param: :var, only: [:show, :update]
+        get :checks, to: "checks#index"
+        root to: "config#show", var: :editors
+      end
+
+      initializer "decidim_admin_awesome.assets" do |app|
+        app.config.assets.precompile += %w(decidim_admin_decidim_awesome_manifest.js decidim_admin_decidim_awesome_manifest.css)
+      end
+
+      initializer "decidim_decidim_awesome.admin_mount_routes" do
+        Decidim::Core::Engine.routes do
+          mount Decidim::DecidimAwesome::AdminEngine, at: "/admin/decidim_awesome", as: "decidim_admin_decidim_awesome"
+        end
+      end
+
+      initializer "decidim_awesome.admin_menu" do
+        Decidim.menu :admin_menu do |menu|
+          menu.item I18n.t("menu.decidim_awesome", scope: "decidim.admin", default: "Decidim Awesome"),
+                    decidim_admin_decidim_awesome.config_path(:editors),
+                    icon_name: "fire",
+                    position: 7.5,
+                    active: is_active_link?(decidim_admin_decidim_awesome.config_path(:editors), :inclusive)
+        end
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end

data/lib/decidim/decidim_awesome/awesome_helpers.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "decidim/decidim_awesome/version"
+
+module Decidim
+  # add a global helper with awesome configuration
+  module DecidimAwesome
+    module AwesomeHelpers
+      # Returns the normalized config for an Organization and the current url
+      def awesome_config_instance
+        return @awesome_config_instance if @awesome_config_instance
+
+        @awesome_config_instance = Config.new request.env["decidim.current_organization"]
+        @awesome_config_instance.context_from_request request
+        @awesome_config_instance
+      end
+
+      def awesome_config
+        @awesome_config ||= awesome_config_instance.config
+      end
+
+      def show_public_intergram?
+        return unless awesome_config[:intergram_for_public]
+        return true unless awesome_config[:intergram_for_public_settings][:require_login]
+
+        user_signed_in?
+      end
+
+      def unfiltered_awesome_config
+        @unfiltered_awesome_config ||= awesome_config_instance.unfiltered_config
+      end
+
+      def organization_awesome_config
+        @organization_awesome_config ||= awesome_config_instance.organization_config
+      end
+
+      def awesome_version
+        ::Decidim::DecidimAwesome::VERSION
+      end
+
+      def tenant_stylesheets
+        return @tenant_stylesheets if @tenant_stylesheets
+
+        prefix = Rails.root.join("app", "assets", "themes", current_organization.host)
+        return @tenant_stylesheets = current_organization.host.to_s if File.exist?("#{prefix}.css") || File.exist?("#{prefix}.scss") || File.exist?("#{prefix}.scss.erb")
+      end
+
+      def version_prefix
+        return "v0.21" if Decidim.version.start_with? "0.21"
+
+        "v0.22"
+      end
+    end
+  end
+end

data/lib/decidim/decidim_awesome/checksums.yml

@@ -0,0 +1,15 @@
+decidim-admin:
+  /app/views/layouts/decidim/admin/_header.html.erb:
+    decidim-0.21: 6f0c010b1dcf912be1b3e0ff9f156026
+    decidim-0.22: 6af51ec6b8a760b0ee6e00a7834f5f9a
+decidim-core:
+  /app/views/layouts/decidim/_head.html.erb:
+    decidim-0.21: b261c55492d047ba730eed8b39be0304
+    decidim-0.22: bf16a58cd9e6d3f73e6875ff3d0b1e48
+  /app/assets/javascripts/decidim/editor.js.es6:
+    decidim-0.21: 797d0ec1c9e79453cf6718f82d2fdd27
+    decidim-0.22: 797d0ec1c9e79453cf6718f82d2fdd27
+decidim-proposals:
+  /app/presenters/decidim/proposals/proposal_presenter.rb:
+    decidim-0.21: d7a6e1e55613de8949ace284307a7674
+    decidim-0.22: 7d60c8310d7fa4e38d9a27080c22b12c

data/lib/decidim/decidim_awesome/config.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DecidimAwesome
+    # The current awesome config for the organization.
+    class Config
+      def initialize(organization)
+        @organization = organization
+        @vars = AwesomeConfig.for_organization(organization).includes(:constraints)
+        @context = {
+          participatory_space_manifest: nil,
+          participatory_slug: nil,
+          component_id: nil,
+          component_manifest: nil
+        }
+      end
+
+      attr_reader :context
+      attr_writer :defaults
+
+      def defaults
+        @defaults || Decidim::DecidimAwesome.config
+      end
+
+      def context=(context)
+        @config = nil
+        @context = context
+      end
+
+      # convert context to manifest, slug and id
+      def context_from_request(request)
+        @config = nil
+        @context = Decidim::DecidimAwesome::ContextAnalyzers::RequestAnalyzer.context_for request
+      end
+
+      # convert component to manifest, slug and id
+      def context_from_component(component)
+        @config = nil
+        @context = Decidim::DecidimAwesome::ContextAnalyzers::ComponentAnalyzer.context_for component
+      end
+
+      # convert participatory space to manifest, slug and id
+      def context_from_participatory_space(space)
+        @config = nil
+        @context = Decidim::DecidimAwesome::ContextAnalyzers::ParticipatorySpaceAnalyzer.context_for space
+      end
+
+      # config processed in context
+      def config
+        @config ||= calculate_config
+      end
+
+      # config processed for the organization config, without context
+      def organization_config
+        @organization_config ||= unfiltered_config.map do |key, value|
+          value = defaults[key] unless enabled_for_organization? key
+          [key, value]
+        end.to_h
+      end
+
+      # config normalized according default values, without context, without organization config
+      def unfiltered_config
+        valid = @vars.map { |v| [v.var.to_sym, v.value] }.to_h
+
+        map_defaults do |key|
+          valid[key].presence
+        end
+      end
+
+      def setting_for(var)
+        @vars.find_or_initialize_by(
+          organization: @organization,
+          var: var
+        )
+      end
+
+      # Checks if some config option es enabled in a certain context
+      def enabled_for?(setting)
+        config[setting]
+      end
+
+      private
+
+      def map_defaults
+        defaults.map do |key, val|
+          value = false
+          unless val == :disabled
+            value = yield(key) || val
+            value = val.merge(value.transform_keys(&:to_sym)) if val.is_a? Hash
+          end
+          [key, value]
+        end.to_h
+      end
+
+      def calculate_config
+        # filter vars compliant with current context
+        valid = @vars.filter { |item| enabled_for_organization?(item.var) && valid_in_context?(item.constraints) }
+                     .map { |v| [v.var.to_sym, v.value] }.to_h
+
+        map_defaults do |key|
+          valid[key].presence
+        end
+      end
+
+      # extra checks that may be relevant for the key
+      def enabled_for_organization?(key)
+        case key.to_sym
+        when :allow_images_in_proposals
+          if @organization.respond_to? :rich_text_editor_in_public_views
+            return false if @organization.rich_text_editor_in_public_views
+          end
+        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