decidim-admin 0.0.1.alpha9 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d142764afb04ce2249b4458d4b8b2974c5c067f
-  data.tar.gz: 1ca7e8e1d797aa607e9d3dee8d2acc53992604a3
+  metadata.gz: 46d6185dd125a2294268f3ecd81a04bda650cd19
+  data.tar.gz: 7285fb73b6dc707318b4aa7e6521361bc3324e8a
 SHA512:
-  metadata.gz: dba8739599a660f86a627009888cb6f661d98caf8a6291ced478f8eb55eab1950edca6004de9d5c104f1d30105310d343a51b3752559ca5b9ed715453bcb9da2
-  data.tar.gz: 86acfe10d775b3c56e88f8b853e072ff07f9e6b392eef8c2c8537769c55b43033182f42c67d1dd2693ccece9ffe7ba02eb9818264788cc4717f30a3f8cbc9072
+  metadata.gz: 3ea15149f26cb7988fd7493bd77f194b7a2eb7b2b52dfa8b1d77f68e9390a5a601ef37301d5694827fa90f93ef77b66161e245c6c7568209dbb9016053647213
+  data.tar.gz: 3b828b9ce5ba8de78d7340c1272f7fddace5f5221a2ce0c4f99369ba9338a7e12d9ff21dde3fc6300abc06b41e4a8b73b73fa3a45f4f64f4222a1c279e50c7c7

data/README.md

@@ -1,8 +1,11 @@
 # Decidim::Admin
-Short description and motivation.
+
+This library adds and administration dashboard so users can manage their
+organization, participatory processes and all other entities.
 
 ## Usage
-How to use my plugin.
+This will add an admin dashboard to manage an organization an all its entities.
+It's included by default with Decidim.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -16,13 +19,35 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install decidim-admin
-```
+## Features
+
+### Participatory process
+
+Here you can manage participatory processes.
+
+TODO: Elaborate on this.
+
+
+### Static pages
+
+This feature allows an admin to create pages to serve static content. Some
+example of this kind of pages could be:
+
+  * Terms and Conditions
+  * FAQ
+  * Accessibility guidelines
+  * About the project
+
+All the pages can be created with I18n support and will be accessible as
+`/pages/:page-slug`. You can link them at your website the same way you link
+other Rails models: `pages_path("terms-and-conditions")`.
+
+There are some pages that exist by default and cannot be deleted since there
+are links to them inside the Decidim framework, see `Decidim::StaticPage` for
+the default list.
 
 ## Contributing
-Contribution directions go here.
+See [Decidim](https://github.com/AjuntamentdeBarcelona/decidim).
 
 ## License
-The gem is available as open source under the terms of the [AGPLv3 License](https://opensource.org/licenses/AGPL-3.0).
+See [Decidim](https://github.com/AjuntamentdeBarcelona/decidim).

data/Rakefile

@@ -1,27 +1,2 @@
 # frozen_string_literal: true
-
 require "decidim/common_rake"
-require "rdoc/task"
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.title    = "Decidim::Admin"
-  rdoc.options << "--line-numbers"
-  rdoc.rdoc_files.include("README.md")
-  rdoc.rdoc_files.include("lib/**/*.rb")
-end
-
-load "rails/tasks/statistics.rake"
-
-require "bundler/gem_tasks"
-
-begin
-  require "rspec/core/rake_task"
-  RSpec::Core::RakeTask.new(:spec)
-  ENV["ENGINE_PATH"] = File.dirname(__FILE__)
-
-  task default: :spec
-
-  Rake::Task["spec"].enhance ["common:test_app"]
-rescue LoadError
-end

data/app/assets/javascripts/decidim/admin/application.js.es6

@@ -1,12 +1,19 @@
-//= require jquery
-//= require jquery_ujs
-//= require foundation
-//= require turbolinks
-//= require html.sortable.min
-//= require ./sort_steps
-//= require_self
+/* global sortSteps */
 
-$(document).on('turbolinks:load', () => {
-  $(() => { $(document).foundation(); });
-});
+// = require jquery
+// = require jquery_ujs
+// = require foundation
+// = require turbolinks
+// = require html.sortable
+// = require ./sort_steps
+// = require ./tab_focus
+// = require decidim/editor
+// = require_self
 
+const pageLoad = () => {
+  $(document).foundation();
+  sortSteps();
+};
+
+$(document).on('turbolinks:load', pageLoad);
+$(pageLoad);

data/app/assets/javascripts/decidim/admin/sort_steps.js.es6

@@ -1,21 +1,30 @@
+/* eslint-disable camelcase */
 /* global sortable */
 
-// consider removing from application.js file
-//
 // Needs a `tbody` element inside a `#steps` section. The `tbody` element
 // should have a `data-sort-url` attribute with the URL where the data should
 // be posted to.
-$(() => {
-  const sortableElement = $('#steps tbody');
+const sortSteps = () => {
+  const $sortableElement = $('#steps tbody');
 
-  if (sortableElement) {
-    const sortUrl = sortableElement.data('sort-url');
+  if ($sortableElement.length > 0) {
+    const sortUrl = $sortableElement.data('sort-url');
 
     sortable('#steps tbody', {
-      placeholder: $('<tr style="border-style: dashed; border-color: #000"><td colspan="4">&nbsp;</td></tr>')[0],
-    })[0].addEventListener('sortupdate', (e) => {
-      const order = $(e.target).children().map(() => $(this).data('id')).toArray();
-      $.ajax({ method: 'POST', url: sortUrl, data: { items_ids: order } });
+      placeholder: $('<tr style="border-style: dashed; border-color: #000"><td colspan="4">&nbsp;</td></tr>')[0]
+    })[0].addEventListener('sortupdate', (event) => {
+      const order = $(event.target).children()
+        .map((index, child) => $(child).data('id'))
+        .toArray();
+
+      $.ajax({
+        method: 'POST',
+        url: sortUrl,
+        contentType: 'application/json',
+        data: JSON.stringify({ items_ids: order }) },
+      );
     });
   }
-});
+};
+
+window.sortSteps = sortSteps;

data/app/assets/javascripts/decidim/admin/tab_focus.js.es6

@@ -0,0 +1,22 @@
+// = require_self
+
+/**
+ * When switching tabs in i18n fields, autofocus on the input to save clicks #212
+ */
+$(document).on('turbolinks:load', () => {
+  // Event launched by foundation
+  $('[data-tabs]').on('change.zf.tabs', (event) => {
+    const $container = $(event.target).next('.tabs-content .tabs-panel.is-active');
+    // Detect quilljs editor inside the tabs-panel
+    let $content = $container.find('.editor .ql-editor');
+    if ($content.length > 0) {
+      $content.focus();
+    // Detect if inside the tabs-panel have an input
+    } else {
+      $content = $container.find('input:first');
+      if ($content.length > 0) {
+        $content.focus();
+      }
+    }
+  });
+});

data/app/assets/stylesheets/decidim/admin/_forms.scss

@@ -0,0 +1,10 @@
+form {
+  ul.tabs {
+    a.alert {
+      color: map-get($foundation-palette, alert);
+    }
+  }
+  .tabs-content {
+    margin-bottom: 1rem;
+  }
+}

data/app/assets/stylesheets/decidim/admin/_layout.scss

@@ -13,4 +13,15 @@
 
 .page-title{
   margin-bottom: $global-margin;
+}
+
+dd {
+  margin-bottom: 1rem;
+}
+
+tr.subcategory {
+  td:first-child a:before {
+    content: "•";
+    margin-right: 1rem;
+  }
 }

data/app/assets/stylesheets/decidim/admin/_tables.scss

@@ -11,4 +11,8 @@ tbody.sortable tr {
     border-left-style: dotted;
     border-left-color: #ccc;
   }
+}
+
+#process_admins td input {
+  margin: 0;
 }

data/app/assets/stylesheets/decidim/admin/application.scss

@@ -1,8 +1,14 @@
-@import 'https://fonts.googleapis.com/css?family=Montserrat:400,700';
-
 @import "foundation_and_overrides";
 @import "layout";
 @import "login";
 @import "sidebar";
 @import "tables";
 @import "actions";
+@import "forms";
+
+@import "decidim/editor";
+@import "decidim/utils/fontface";
+
+body {
+  font-family: 'Source Sans Pro', sans-serif;
+}

data/app/commands/decidim/admin/activate_participatory_process_step.rb

@@ -11,7 +11,7 @@ module Decidim
         @step = step
       end
 
-      # Executes the command. Braodcasts these events:
+      # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
       # - :invalid if the data wasn't valid and we couldn't proceed.

data/app/commands/decidim/admin/create_category.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # A command with all the business logic to create a new category in the
+    # system.
+    class CreateCategory < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # form - A form object with the params.
+      # participatory_process - The ParticipatoryProcess that will hold the
+      #   category
+      def initialize(form, participatory_process)
+        @form = form
+        @participatory_process = participatory_process
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if the form wasn't valid and we couldn't proceed.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if form.invalid?
+
+        create_category
+        broadcast(:ok)
+      end
+
+      private
+
+      attr_reader :form
+
+      def create_category
+        Category.create!(
+          name: form.name,
+          description: form.description,
+          parent_id: form.parent_id,
+          participatory_process: @participatory_process
+        )
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/create_feature.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # This command gets called when a feature is created from the admin panel.
+    class CreateFeature < Rectify::Command
+      attr_reader :form, :manifest, :participatory_process
+
+      # Public: Initializes the command.
+      #
+      # manifest              - The feature's manifest to create a feature from.
+      # form                  - The form from which the data in this feature comes from.
+      # participatory_process - The participatory process that will hold this feature.
+      def initialize(manifest, form, participatory_process)
+        @manifest = manifest
+        @form = form
+        @participatory_process = participatory_process
+      end
+
+      # Public: Creates the Feature.
+      #
+      # Broadcasts :ok if created, :invalid otherwise.
+      def call
+        return broadcast(:invalid) if form.invalid?
+
+        transaction do
+          create_feature
+          run_hooks
+        end
+
+        broadcast(:ok)
+      end
+
+      private
+
+      def create_feature
+        @feature = Feature.create!(
+          manifest_name: manifest.name,
+          name: form.name,
+          participatory_process: participatory_process
+        )
+      end
+
+      def run_hooks
+        manifest.run_hooks(:create, @feature)
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/create_participatory_process.rb

@@ -7,14 +7,11 @@ module Decidim
       # Public: Initializes the command.
       #
       # form - A form object with the params.
-      # organization - The Organization of the user that created the
-      #   participatory process
-      def initialize(form, organization)
+      def initialize(form)
         @form = form
-        @organization = organization
       end
 
-      # Executes the command. Braodcasts these events:
+      # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
       # - :invalid if the form wasn't valid and we couldn't proceed.
@@ -42,7 +39,7 @@ module Decidim
           hero_image: form.hero_image,
           banner_image: form.banner_image,
           promoted: form.promoted,
-          organization: @organization
+          organization: form.current_organization
         )
       end
     end

data/app/commands/decidim/admin/create_participatory_process_admin.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # A command with all the business logic when creating a new participatory
+    # process admin in the system.
+    class CreateParticipatoryProcessAdmin < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # form - A form object with the params.
+      # participatory_process - The ParticipatoryProcess that will hold the
+      #   user role
+      def initialize(form, participatory_process)
+        @form = form
+        @participatory_process = participatory_process
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if the form wasn't valid and we couldn't proceed.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if form.invalid?
+        return broadcast(:invalid) unless user
+
+        create_participatory_process_admin
+        broadcast(:ok)
+      end
+
+      private
+
+      attr_reader :form, :participatory_process
+
+      def create_participatory_process_admin
+        ParticipatoryProcessUserRole.create!(
+          role: :admin,
+          user: user,
+          participatory_process: @participatory_process
+        )
+      end
+
+      def user
+        User.where(
+          email: form.email,
+          organization: participatory_process.organization
+        ).first
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/create_participatory_process_attachment.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # A command with all the business logic to add an attachment to a
+    # participatory process.
+    class CreateParticipatoryProcessAttachment < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # form - A form object with the params.
+      # participatory_process - The ParticipatoryProcess that will hold the
+      #   attachment
+      def initialize(form, participatory_process)
+        @form = form
+        @participatory_process = participatory_process
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if the form wasn't valid and we couldn't proceed.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if form.invalid?
+
+        create_attachment
+        broadcast(:ok)
+      end
+
+      private
+
+      attr_reader :form
+
+      def create_attachment
+        ParticipatoryProcessAttachment.create!(
+          title: form.title,
+          description: form.description,
+          file: form.file,
+          participatory_process: @participatory_process
+        )
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/create_participatory_process_step.rb

@@ -14,7 +14,7 @@ module Decidim
         @participatory_process = participatory_process
       end
 
-      # Executes the command. Braodcasts these events:
+      # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
       # - :invalid if the form wasn't valid and we couldn't proceed.
@@ -36,8 +36,8 @@ module Decidim
           title: form.title,
           description: form.description,
           short_description: form.short_description,
-          start_date: form.start_date.at_midnight,
-          end_date: form.end_date.at_midnight,
+          start_date: form.start_date,
+          end_date: form.end_date,
           participatory_process: @participatory_process
         )
       end

data/app/commands/decidim/admin/create_scope.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # A command with all the business logic when creating a static scope.
+    class CreateScope < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # form - A form object with the params.
+      def initialize(form)
+        @form = form
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if the form wasn't valid and we couldn't proceed.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if form.invalid?
+
+        create_scope
+        broadcast(:ok)
+      end
+
+      private
+
+      attr_reader :form
+
+      def create_scope
+        Scope.create!(
+          name: form.name,
+          organization: form.organization
+        )
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/create_static_page.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # A command with all the business logic when creating a static page.
+    class CreateStaticPage < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # form - A form object with the params.
+      def initialize(form)
+        @form = form
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if the form wasn't valid and we couldn't proceed.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if form.invalid?
+
+        create_page
+        broadcast(:ok)
+      end
+
+      private
+
+      attr_reader :form
+
+      def create_page
+        StaticPage.create!(
+          title: form.title,
+          slug: form.slug,
+          content: form.content,
+          organization: form.organization
+        )
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/destroy_category.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # A command with all the business logic to destroy a category in the
+    # system.
+    class DestroyCategory < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # category - A Category that will be destroyed
+      def initialize(category)
+        @category = category
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if the data wasn't valid and we couldn't proceed.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if category.nil? || category.subcategories.any?
+
+        destroy_category
+        broadcast(:ok)
+      end
+
+      private
+
+      attr_reader :category
+
+      def destroy_category
+        category.destroy!
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/destroy_feature.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # This command deals with destroying a Feature from the admin panel.
+    class DestroyFeature < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # feature - The Feature to be destroyed.
+      def initialize(feature)
+        @feature = feature
+      end
+
+      # Public: Executes the command.
+      #
+      # Broadcasts :ok if it got destroyed, raises an exception otherwise.
+      def call
+        begin
+          destroy_feature
+        rescue StandardError
+          return broadcast(:invalid)
+        end
+        broadcast(:ok)
+      end
+
+      private
+
+      def destroy_feature
+        transaction do
+          @feature.destroy!
+          run_hooks
+        end
+      end
+
+      def run_hooks
+        @feature.manifest.run_hooks(:destroy, @feature)
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/publish_participatory_process.rb

@@ -10,7 +10,7 @@ module Decidim
         @process = process
       end
 
-      # Executes the command. Braodcasts these events:
+      # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
       # - :invalid if the data wasn't valid and we couldn't proceed.