decidim 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # Decidim [![Gem](https://img.shields.io/gem/v/decidim.svg)](https://rubygems.org/gems/decidim) [![Gem](https://img.shields.io/gem/dt/decidim.svg)](https://rubygems.org/gems/decidim) [![License: AGPL v3](https://img.shields.io/github/license/AjuntamentdeBarcelona/decidim.svg)](https://github.com/AjuntamentdeBarcelona/decidim/blob/master/LICENSE-AGPLv3.txt)
 
-[[Documentation](https://github.com/AjuntamentdeBarcelona/decidim/tree/master/doc)] - [[Demo](http://staging.decidim.codegram.com)]
+[[Documentation](https://github.com/AjuntamentdeBarcelona/decidim/tree/master/docs)] - [[Demo](http://staging.decidim.codegram.com)]
 
 ### Code quality
 [![Build Status](https://img.shields.io/travis/AjuntamentdeBarcelona/decidim/master.svg)](https://travis-ci.org/AjuntamentdeBarcelona/decidim)
@@ -9,6 +9,7 @@
 [![codecov](https://img.shields.io/codecov/c/github/AjuntamentdeBarcelona/decidim.svg)](https://codecov.io/gh/AjuntamentdeBarcelona/decidim)
 [![Dependency Status](https://img.shields.io/gemnasium/AjuntamentdeBarcelona/decidim.svg)](https://gemnasium.com/github.com/AjuntamentdeBarcelona/decidim)
 [![Crowdin](https://d322cqt584bo4o.cloudfront.net/decidim/localized.svg)](https://crowdin.com/project/decidim/invite)
+[![Inline docs](http://inch-ci.org/github/AjuntamentdeBarcelona/decidim.svg?branch=master)](http://inch-ci.org/github/AjuntamentdeBarcelona/decidim)
 
 ### Project management
 [![GitHub pull requests](https://img.shields.io/github/issues-pr/AjuntamentdeBarcelona/decidim.svg)](https://github.com/AjuntamentdeBarcelona/decidim/pulls)
@@ -17,6 +18,20 @@
 [![GitHub closed issues](https://img.shields.io/github/issues-closed/AjuntamentdeBarcelona/decidim.svg)](https://github.com/AjuntamentdeBarcelona/decidim/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed)
 [![GitHub contributors](https://img.shields.io/github/contributors/AjuntamentdeBarcelona/decidim.svg)](https://github.com/AjuntamentdeBarcelona/decidim/graphs/contributors)
 
+---
+
+## What do you need to do?
+
+- [Contribute to the project](#how-to-contribute)
+- [Create & browse development app](#browse-decidim)
+- [Install "Decidim" for an organization](#installation-instructions)
+- [Upgrade an already existing "Decidim" installation](#upgrade-instructions)
+- [Use Docker to deploy "Decidim"](#docker-instructions)
+- [Check current components](#components)
+- [Further configuration](#further-configuration)
+
+---
+
 ## Installation instructions
 
 First of all, you need to install the `decidim` gem, which currently is in a *prerelease* status.
@@ -93,9 +108,10 @@ Also you can run it as a standalone container like this:
 In order to develop on decidim, you'll need:
 
 * **PostgreSQL** 9.4+
-* **Ruby** 2.3.3
+* **Ruby** 2.4.0
 * **NodeJS** with **yarn** (JavaScript dependency manager, can be installed with `npm install yarn`)
 * **ImageMagick**
+* **PhantomJS**
 
 The easiest way to work on decidim is to clone decidim's repository and install its dependencies
 
@@ -108,8 +124,50 @@ $ yarn install
 
 You have several rake tasks available for you:
 
-* `rake development_app`: Creates a development app inside `decidim_development` which you can use to run an application with the gems in your path.
-* `rake test_all`: Generates a test app for every engine and runs their tests.
-* `rake generate_all`: Generates all the tests apps but doesn't run the tests - this is useful is you want to run them manually afterwards.
+* `bundle exec rake development_app`: Creates a development app inside `decidim_development` which you can use to run an application with the gems in your path.
+* `bundle exec rake test_all`: Generates a test app for every engine and runs their tests.
+* `bundle exec rake generate_all`: Generates all the tests apps but doesn't run the tests - this is useful is you want to run them manually afterwards.
+* `cd <component>` and do `bundle exec rspec spec` to run those particular tests.
+
+
+### Browse Decidim
+
+After you create a development app (`bundle exec rake development_app`):
+- `cd development_app`
+- `bundle exec rails s`
+- Go to 'http://localhost:3000'
+
+Optionally, you can log in as: user@decidim.org | decidim123456
+
+Also, if you want to verify yourself against the default authorization handler use a document number ended with "X".
+
+
+### Browse Admin Interface
+
+After you create a development app (`bundle exec rake development_app`):
+- `cd development_app`
+- `bundle exec rails s`
+- Go to 'http://localhost:3000/admin'
+- Login data: admin@decidim.org | decidim123456
+
+
+## Components
+
+
+| Component        | Description           |
+| ------------- |-------------|
+| [Admin](https://github.com/AjuntamentdeBarcelona/decidim/tree/master/decidim-admin)      | This library adds an administration dashboard so users can manage their organization, participatory processes and all other entities. |
+| [API](https://github.com/AjuntamentdeBarcelona/decidim/tree/master/decidim-api)      | This library exposes a GraphQL API to programatically interact with the Decidim platform via HTTP      |
+| [Comments](https://github.com/AjuntamentdeBarcelona/decidim/tree/master/decidim-comments) | The Comments module adds the ability to include comments to any resource which can be commentable by users.      |
+| [Core](https://github.com/AjuntamentdeBarcelona/decidim/tree/master/decidim-core) | The basics of Decidim: users, participatory processes, etc. This is the only required engine to run Decidim, all the others are optional. |
+| [Dev](https://github.com/AjuntamentdeBarcelona/decidim/tree/master/decidim-dev) | This gem aids the local development of Decidim's features. |
+| [Meeting](https://github.com/AjuntamentdeBarcelona/decidim/tree/master/decidim-meetings) | The Meeeting module adds meeting to any participatory process. It adds a CRUD engine to the admin and public view scoped inside the participatory process. |
+| [Pages](https://github.com/AjuntamentdeBarcelona/decidim/tree/master/decidim-pages) | The Pages module adds static page capabilities to any participatory process. It basically provides an interface to include arbitrary HTML content to any step. |
+| [Proposals](https://github.com/AjuntamentdeBarcelona/decidim/tree/master/decidim-proposals) | The Proposals module adds one of the main features of Decidim: allows users to contribute to a participatory process by creating proposals. |
+| [System](https://github.com/AjuntamentdeBarcelona/decidim/tree/master/decidim-system) | Multitenant Admin to manage multiple organizations in a single installation |
+
+## Further configuration
+
+- [Social providers integration](https://github.com/AjuntamentdeBarcelona/decidim/blob/master/docs/social_providers.md): Enable sign up from social networks.
 
 TODO: Improve guide.

data/Rakefile

@@ -4,7 +4,7 @@ require "rspec/core/rake_task"
 require_relative "lib/generators/decidim/app_generator"
 require_relative "lib/generators/decidim/docker_generator"
 
-DECIDIM_GEMS = %w(core system admin api pages meetings comments).freeze
+DECIDIM_GEMS = %w(core system admin api pages meetings proposals comments).freeze
 
 RSpec::Core::RakeTask.new(:spec)
 

data/codecov.yml

@@ -77,6 +77,7 @@ coverage:
   - "bundle.js"
   - "vendor/*"
   - "node_modules/*"
+  - ".bundle/*"
 
 comment:
   layout: "header, diff, changes, sunburst, uncovered, tree"

data/decidim-admin/Rakefile

@@ -1,2 +1,2 @@
 # frozen_string_literal: true
-require "decidim/common_rake"
+require "decidim/dev/common_rake"

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

@@ -16,4 +16,3 @@ const pageLoad = () => {
 };
 
 $(document).on('turbolinks:load', pageLoad);
-$(pageLoad);

data/decidim-admin/app/assets/stylesheets/decidim/admin/_foundation_and_overrides.scss

@@ -22,6 +22,7 @@
 @include foundation-breadcrumbs;
 @include foundation-button-group;
 @include foundation-callout;
+@include foundation-card;
 @include foundation-close-button;
 @include foundation-drilldown-menu;
 @include foundation-dropdown;

data/decidim-admin/app/assets/stylesheets/decidim/admin/_icons.scss

@@ -0,0 +1,9 @@
+.icon{
+  height: 0.8em;
+  width: 0.8em;
+  display: inline;
+  vertical-align: middle;
+  fill: currentColor;
+  margin-left: .1rem;
+  margin-right: .1rem;
+}

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

@@ -5,6 +5,7 @@
 @import "tables";
 @import "actions";
 @import "forms";
+@import "icons";
 
 @import "decidim/editor";
 @import "decidim/utils/fontface";

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

@@ -36,7 +36,9 @@ module Decidim
         @feature = Feature.create!(
           manifest_name: manifest.name,
           name: form.name,
-          participatory_process: participatory_process
+          participatory_process: participatory_process,
+          settings: @form.settings,
+          step_settings: form.step_settings
         )
       end
 

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

@@ -20,8 +20,8 @@ module Decidim
       def call
         return broadcast(:invalid) if form.invalid?
 
-        create_participatory_process
-        broadcast(:ok)
+        process = create_participatory_process
+        broadcast(:ok, process)
       end
 
       private
@@ -29,18 +29,30 @@ module Decidim
       attr_reader :form
 
       def create_participatory_process
-        ParticipatoryProcess.create!(
-          title: form.title,
-          subtitle: form.subtitle,
-          slug: form.slug,
-          hashtag: form.hashtag,
-          description: form.description,
-          short_description: form.short_description,
-          hero_image: form.hero_image,
-          banner_image: form.banner_image,
-          promoted: form.promoted,
-          organization: form.current_organization
-        )
+        transaction do
+          process = ParticipatoryProcess.create!(
+            title: form.title,
+            subtitle: form.subtitle,
+            slug: form.slug,
+            hashtag: form.hashtag,
+            description: form.description,
+            short_description: form.short_description,
+            hero_image: form.hero_image,
+            banner_image: form.banner_image,
+            promoted: form.promoted,
+            organization: form.current_organization
+          )
+
+          process.steps.create!(
+            title: TranslationsHelper.multi_translation(
+              "decidim.admin.participatory_process_steps.default_title",
+              form.current_organization.available_locales
+            ),
+            active: true
+          )
+
+          process
+        end
       end
     end
   end

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

@@ -26,11 +26,16 @@ module Decidim
 
       def destroy_feature
         transaction do
+          run_before_hooks
           @feature.destroy!
           run_hooks
         end
       end
 
+      def run_before_hooks
+        @feature.manifest.run_hooks(:before_destroy, @feature)
+      end
+
       def run_hooks
         @feature.manifest.run_hooks(:destroy, @feature)
       end

data/decidim-admin/app/commands/decidim/admin/destroy_participatory_process_step.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # A command that sets all steps in a participatory process as inactive
+    class DestroyParticipatoryProcessStep < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # step - A ParticipatoryProcessStep that will be deactivated
+      def initialize(step)
+        @step = step
+        @participatory_process = step.participatory_process
+      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, :last_step) if @participatory_process.steps.count == 1
+        return broadcast(:invalid, :active_step) if @step.active?
+
+        @step.destroy!
+        broadcast(:ok)
+      end
+    end
+  end
+end

data/decidim-admin/app/commands/decidim/admin/update_feature.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+module Decidim
+  module Admin
+    # This command gets called when a feature is created from the admin panel.
+    class UpdateFeature < Rectify::Command
+      attr_reader :form, :feature
+
+      # Public: Initializes the command.
+      #
+      # form    - The form from which the data in this feature comes from.
+      # feature - The feature to update.
+      def initialize(form, feature)
+        @manifest = feature.manifest
+        @form = form
+        @feature = feature
+      end
+
+      # Public: Creates the Feature.
+      #
+      # Broadcasts :ok if created, :invalid otherwise.
+      def call
+        return broadcast(:invalid) if form.invalid?
+
+        transaction do
+          update_feature
+          run_hooks
+        end
+
+        broadcast(:ok)
+      end
+
+      private
+
+      def update_feature
+        @feature.update_attributes(
+          name: form.name,
+          settings: form.settings,
+          step_settings: form.step_settings
+        )
+      end
+
+      def run_hooks
+        @manifest.run_hooks(:update, @feature)
+      end
+    end
+  end
+end

data/decidim-admin/app/commands/decidim/admin/update_organization.rb

@@ -37,11 +37,13 @@ module Decidim
       def attributes
         {
           name: form.name,
+          twitter_handler: form.twitter_handler,
           description: form.description,
           welcome_text: form.welcome_text,
           homepage_image: form.homepage_image || organization.homepage_image,
           logo: form.logo || organization.logo,
-          default_locale: form.default_locale
+          default_locale: form.default_locale,
+          show_statistics: form.show_statistics
         }
       end
     end

data/decidim-admin/app/controllers/decidim/admin/features_controller.rb

@@ -20,7 +20,13 @@ module Decidim
       def new
         authorize! :create, Feature
 
-        @form = form(FeatureForm).instance(name: default_name(manifest))
+        @feature = Feature.new(
+          name: default_name(manifest),
+          manifest_name: params[:type],
+          participatory_process: participatory_process
+        )
+
+        @form = form(FeatureForm).from_model(@feature)
       end
 
       def create
@@ -40,8 +46,33 @@ module Decidim
         end
       end
 
+      def edit
+        @feature = query_scope.find(params[:id])
+        authorize! :update, @feature
+
+        @form = form(FeatureForm).from_model(@feature)
+      end
+
+      def update
+        @feature = query_scope.find(params[:id])
+        @form = form(FeatureForm).from_params(params)
+        authorize! :update, @feature
+
+        UpdateFeature.call(@form, @feature) do
+          on(:ok) do
+            flash[:notice] = I18n.t("features.update.success", scope: "decidim.admin")
+            redirect_to action: :index
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("features.update.error", scope: "decidim.admin")
+            render action: "new"
+          end
+        end
+      end
+
       def destroy
-        @feature = participatory_process.features.find(params[:id])
+        @feature = query_scope.find(params[:id])
         authorize! :destroy, @feature
 
         DestroyFeature.call(@feature) do
@@ -59,6 +90,10 @@ module Decidim
 
       private
 
+      def query_scope
+        participatory_process.features
+      end
+
       def manifest
         Decidim.find_feature_manifest(params[:type])
       end

data/decidim-admin/app/controllers/decidim/admin/participatory_process_step_activations_controller.rb

@@ -24,22 +24,6 @@ module Decidim
         end
       end
 
-      def destroy
-        authorize! :deactivate, process_step
-
-        DeactivateParticipatoryProcessStep.call(process_step) do
-          on(:ok) do
-            flash[:notice] = I18n.t("participatory_process_step_activations.destroy.success", scope: "decidim.admin")
-          end
-
-          on(:invalid) do
-            flash.now[:alert] = I18n.t("participatory_process_step_activations.destroy.error", scope: "decidim.admin")
-          end
-
-          redirect_to participatory_process_steps_path(participatory_process)
-        end
-      end
-
       private
 
       def process_step

data/decidim-admin/app/controllers/decidim/admin/participatory_process_steps_controller.rb

@@ -66,11 +66,18 @@ module Decidim
       def destroy
         @participatory_process_step = collection.find(params[:id])
         authorize! :destroy, @participatory_process_step
-        @participatory_process_step.destroy!
 
-        flash[:notice] = I18n.t("participatory_process_steps.destroy.success", scope: "decidim.admin")
+        DestroyParticipatoryProcessStep.call(@participatory_process_step) do
+          on(:ok) do
+            flash[:notice] = I18n.t("participatory_process_steps.destroy.success", scope: "decidim.admin")
+            redirect_to participatory_process_steps_path(participatory_process)
+          end
 
-        redirect_to participatory_process_steps_path(@participatory_process_step.participatory_process)
+          on(:invalid) do |reason|
+            flash[:alert] = I18n.t("participatory_process_steps.destroy.error.#{reason}", scope: "decidim.admin")
+            redirect_to participatory_process_steps_path(participatory_process)
+          end
+        end
       end
 
       private