decidim 0.0.1.alpha9 → 0.0.1

data/decidim-proposals/app/controllers/decidim/proposals/admin/application_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Decidim
+  module Proposals
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Admin::Features::BaseController`, which
+      # override its layout and provide all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::Features::BaseController
+      end
+    end
+  end
+end

data/decidim-proposals/app/controllers/decidim/proposals/admin/proposals_controller.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module Decidim
+  module Proposals
+    module Admin
+      # This controller allows admins to manage proposals in a participatory process.
+      class ProposalsController < Admin::ApplicationController
+        helper_method :proposals
+
+        def new
+          @form = form(ProposalForm).from_params({}, feature: current_feature)
+        end
+
+        def create
+          @form = form(ProposalForm).from_params(params, feature: current_feature)
+
+          CreateProposal.call(@form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("proposals.create.success", scope: "decidim.proposals.admin")
+              redirect_to proposals_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("proposals.create.invalid", scope: "decidim.proposals.admin")
+              render action: "new"
+            end
+          end
+        end
+
+        private
+
+        def proposals
+          @proposals ||= Proposal.where(feature: current_feature)
+        end
+      end
+    end
+  end
+end

data/decidim-proposals/app/controllers/decidim/proposals/application_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Features::BaseController`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Features::BaseController
+    end
+  end
+end

data/decidim-proposals/app/controllers/decidim/proposals/proposals_controller.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    # Exposes the proposal resource so users can view and create them.
+    class ProposalsController < Decidim::Proposals::ApplicationController
+      include FormFactory
+      before_action :authenticate_user!, only: [:new, :create]
+
+      def show
+        @proposal = Proposal.where(feature: current_feature).find(params[:id])
+      end
+
+      def index
+        @search = ProposalSearch.new(current_feature, params[:page], params[:random_seed])
+        @proposals = @search.proposals
+        @random_seed = @search.random_seed
+      end
+
+      def new
+        @form = form(ProposalForm).from_params({}, author: current_user, feature: current_feature)
+      end
+
+      def create
+        @form = form(ProposalForm).from_params(params, author: current_user, feature: current_feature)
+
+        CreateProposal.call(@form) do
+          on(:ok) do |proposal|
+            flash[:notice] = I18n.t("proposals.create.success", scope: "decidim")
+            redirect_to proposal_path(proposal)
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("proposals.create.error", scope: "decidim")
+            render :new
+          end
+        end
+      end
+    end
+  end
+end

data/decidim-proposals/app/forms/decidim/proposals/admin/proposal_form.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module Decidim
+  module Proposals
+    module Admin
+      # A form object to be used when admin users want to create a proposal.
+      class ProposalForm < Decidim::Form
+        mimic :proposal
+
+        attribute :title, String
+        attribute :body, String
+        attribute :category_id, Integer
+        attribute :scope_id, Integer
+        attribute :feature, Decidim::Feature
+
+        validates :title, :body, :feature, presence: true
+        validates :category, presence: true, if: ->(form) { form.category_id.present? }
+        validates :scope, presence: true, if: ->(form) { form.scope_id.present? }
+
+        delegate :categories, to: :feature
+        delegate :scopes, to: :current_organization
+
+        # Finds the Category from the category_id.
+        #
+        # Returns a Decidim::Category
+        def category
+          @category ||= feature.categories.where(id: category_id).first
+        end
+
+        # Finds the Scope from the scope_id.
+        #
+        # Returns a Decidim::Scope
+        def scope
+          @scope ||= feature.scopes.where(id: scope_id).first
+        end
+      end
+    end
+  end
+end

data/decidim-proposals/app/forms/decidim/proposals/proposal_form.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module Decidim
+  module Proposals
+    # A form object to be used when public users want to create a proposal.
+    class ProposalForm < Decidim::Form
+      mimic :proposal
+
+      attribute :title, String
+      attribute :body, String
+      attribute :author, Decidim::User
+      attribute :category_id, Integer
+      attribute :scope_id, Integer
+      attribute :feature, Decidim::Feature
+
+      validates :title, :body, :author, :feature, presence: true
+      validates :category, presence: true, if: ->(form) { form.category_id.present? }
+      validates :scope, presence: true, if: ->(form) { form.scope_id.present? }
+
+      delegate :categories, to: :feature
+      delegate :scopes, to: :current_organization
+
+      # Finds the Category from the category_id.
+      #
+      # Returns a Decidim::Category
+      def category
+        @category ||= feature.categories.where(id: category_id).first
+      end
+
+      # Finds the Scope from the scope_id.
+      #
+      # Returns a Decidim::Scope
+      def scope
+        @scope ||= feature.scopes.where(id: scope_id).first
+      end
+    end
+  end
+end

data/decidim-proposals/app/helpers/decidim/proposals/application_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module Decidim
+  module Proposals
+    # Custom helpers, scoped to the pages engine.
+    #
+    module ApplicationHelper
+      include Decidim::Comments::CommentsHelper
+    end
+  end
+end

data/decidim-proposals/app/models/decidim/proposals/application_record.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Decidim
+  module Proposals
+    # Abstract class from which all models in this engine inherit.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/decidim-proposals/app/models/decidim/proposals/proposal.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+module Decidim
+  module Proposals
+    # The data store for a Proposal in the Decidim::Proposals component.
+    class Proposal < Proposals::ApplicationRecord
+      belongs_to :feature, foreign_key: "decidim_feature_id", class_name: Decidim::Feature
+      belongs_to :author, foreign_key: "decidim_author_id", class_name: Decidim::User
+      belongs_to :category, foreign_key: "decidim_category_id", class_name: Decidim::Category
+      belongs_to :scope, foreign_key: "decidim_scope_id", class_name: Decidim::Scope
+      has_one :organization, through: :feature
+
+      validates :title, :feature, :body, presence: true
+      validate :category_belongs_to_feature
+      validate :scope_belongs_to_organization
+      validate :author_belongs_to_organization
+
+      def author_name
+        author&.name || I18n.t("decidim.proposals.models.proposal.fields.official_proposal")
+      end
+
+      def author_avatar_url
+        author&.avatar&.url || ActionController::Base.helpers.asset_path("decidim/default-avatar.svg")
+      end
+
+      # Public: Canpeople comment on this proposal?
+      #
+      # Until we have a way to store options fore features and its resources we
+      # assume all proposals can be commented.
+      #
+      # Returns Boolean
+      def commentable?
+        true
+      end
+
+      private
+
+      def category_belongs_to_feature
+        return unless category
+        errors.add(:category, :invalid) unless feature.categories.where(id: category.id).exists?
+      end
+
+      def scope_belongs_to_organization
+        return unless scope
+        errors.add(:scope, :invalid) unless feature.scopes.where(id: scope.id).exists?
+      end
+
+      def author_belongs_to_organization
+        return unless author
+        errors.add(:author, :invalid) unless Decidim::User.where(decidim_organization_id: feature.organization.id, id: author.id).exists?
+      end
+    end
+  end
+end

data/decidim-proposals/app/services/decidim/proposals/proposal_search.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+module Decidim
+  module Proposals
+    # A service to encapsualte all the logic when searching and filtering
+    # proposals in a participatory process.
+    class ProposalSearch
+      attr_reader :feature, :page, :per_page
+
+      # Public: Initializes the service.
+      # feature     - A Decidim::Feature to get the proposals from.
+      # page        - The page number to paginate the results.
+      # random_seed - A random flaot number between -1 and 1 to be used as a random seed at the database.
+      # per_page    - The number of proposals to return per page.
+      def initialize(feature, page = nil, random_seed = nil, per_page = nil)
+        @feature = feature
+        @page = (page || 1).to_i
+        @per_page = (per_page || 12).to_i
+        @random_seed = random_seed.to_f
+      end
+
+      # Returns the random proposals for the current page.
+      def proposals
+        @proposals ||= Proposal.transaction do
+          Proposal.connection.execute("SELECT setseed(#{Proposal.connection.quote(random_seed)})")
+          Proposal.where(feature: feature).reorder("RANDOM()").page(page).per(per_page).load
+        end
+      end
+
+      # Returns the random seed used to randomize the proposals.
+      def random_seed
+        @random_seed = (rand * 2 - 1) if @random_seed == 0.0 || @random_seed > 1 || @random_seed < -1
+        @random_seed
+      end
+    end
+  end
+end

data/decidim-proposals/app/views/decidim/proposals/admin/proposals/_form.html.erb

@@ -0,0 +1,19 @@
+<div class="field">
+  <%= form.text_field :title %>
+</div>
+
+<div class="field">
+  <%= form.text_area :body, rows: 10 %>
+</div>
+
+<% if @form.categories&.any? %>
+  <div class="field">
+    <%= form.categories_select :category_id, @form.categories, t(".select_a_category") %>
+  </div>
+<% end %>
+
+<% if @form.scopes&.any? %>
+  <div class="field">
+    <%= form.select :scope_id, @form.scopes.map{|s| [translated_attribute(s.name), s.id]}, prompt: t(".select_a_scope") %>
+  </div>
+<% end %>

data/decidim-proposals/app/views/decidim/proposals/admin/proposals/index.html.erb

@@ -0,0 +1,34 @@
+<h2><%= t(".title") %></h2>
+
+<div class="actions title">
+  <%= link_to t("actions.new", scope: "decidim.proposals", name: t("models.proposal.name", scope: "decidim.proposals.admin")), new_proposal_path, class: 'new' if can? :manage, current_feature %>
+</div>
+
+<table class="stack">
+  <thead>
+    <tr>
+      <th><%= t("models.proposal.fields.title", scope: "decidim.proposals") %></th>
+      <th><%= t("models.proposal.fields.category", scope: "decidim.proposals") %></th>
+      <th><%= t("models.proposal.fields.scope", scope: "decidim.proposals") %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% proposals.each do |proposal| %>
+      <tr data-id="<%= proposal.id %>">
+        <td>
+          <%= link_to proposal.title, decidim_proposals.proposal_path(id: proposal, feature_id: current_feature, participatory_process_id: current_participatory_process), target: :blank %><br />
+        </td>
+        <td>
+          <% if proposal.category %>
+            <%= translated_attribute proposal.category.name %>
+          <% end %>
+        </td>
+        <td>
+          <% if proposal.scope %>
+            <%= translated_attribute proposal.scope.name %>
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/decidim-proposals/app/views/decidim/proposals/admin/proposals/new.html.erb

@@ -0,0 +1,9 @@
+<h3><%= t ".title" %></h3>
+
+<%= form_for(@form) do |f| %>
+  <%= render partial: 'form', object: f %>
+
+  <div class="actions">
+    <%= f.submit t(".create") %>
+  </div>
+<% end %>

data/decidim-proposals/app/views/decidim/proposals/proposals/_proposal.html.erb

@@ -0,0 +1,34 @@
+<div class="column">
+  <article class="card card--proposal">
+    <div class="card__content">
+      <div class="card__header">
+        <%= link_to proposal do%>
+          <h5 class="card__title"><%= proposal.title %></h5>
+        <% end %>
+        <div class="card__author author-data author-data--small">
+          <div class="author-data__main">
+            <div class="author author--inline">
+              <span class="author__avatar author__avatar--small">
+                <%= image_tag proposal.author_avatar_url %>
+              </span>
+              <span class="author__name"><%= proposal.author_name %></span>
+              <%= l proposal.created_at, format: "%d/%m/%Y" %>
+            </div>
+          </div>
+        </div>
+      </div>
+      <p><%= truncate(proposal.body, length: 100) %></p>
+      <% if proposal.category %>
+        <ul class="tags tags--proposal">
+          <li><a href=""><%= translated_attribute(proposal.category.name) %></a></li>
+        </ul>
+      <% end %>
+    </div>
+    <div class="card__footer">
+      <div class="card__support">
+        <div class="card__support__data"></div>
+        <%= link_to t(".view_proposal"), proposal, class: "card__button button small secondary" %>
+      </div>
+    </div>
+  </article>
+</div>

data/decidim-proposals/app/views/decidim/proposals/proposals/index.html.erb

@@ -0,0 +1,23 @@
+<div class="row columns">
+  <div class="title-action">
+    <h2 class="title-action__title section-heading"><%= t(".proposals_count", count: @proposals.total_count) %></h2>
+    <%= link_to new_proposal_path, class: "title-action__action button small hollow" do %>
+      <%= t(".new_proposal") %>
+      <%= icon "plus" %>
+    <% end %>
+  </div>
+</div>
+<div class="row">
+  <div class="columns mediumlarge-12 large-12">
+    <div class="row small-up-1 medium-up-3 card-grid">
+      <%= render @proposals %>
+    </div>
+    <%
+      # Kaminari uses url_for to generate the url, but this doesn't play nice with our engine system
+      # and unless we remove these params they are added again as query string 😩
+      params.delete("participatory_process_id")
+      params.delete("feature_id")
+    %>
+    <%= paginate @proposals, theme: "decidim", params: { random_seed: @random_seed } %>
+  </div>
+</div>

data/decidim-proposals/app/views/decidim/proposals/proposals/new.html.erb

@@ -0,0 +1,40 @@
+<div class="row columns">
+  <%= link_to :back, class: "muted-link" do %>
+    <%= icon "chevron-left", class: "icon--small" %>
+    <%= t(".back") %>
+  <% end %>
+  <h2 class="section-heading"><%= t(".title") %></h2>
+</div>
+<div class="row">
+  <div class="columns large-6 medium-centered">
+    <div class="card">
+      <div class="card__content">
+        <%= form_for(@form) do |form| %>
+          <div class="field">
+            <%= form.text_field :title %>
+          </div>
+
+          <div class="field">
+            <%= form.text_area :body, rows: 10 %>
+          </div>
+
+          <% if @form.categories&.any? %>
+            <div class="field">
+              <%= form.categories_select :category_id, @form.categories, prompt: t(".select_a_category") %>
+            </div>
+          <% end %>
+
+          <% if @form.scopes&.any? %>
+            <div class="field">
+              <%= form.select :scope_id, @form.scopes.map{|s| [s.name, s.id]}, prompt: t(".select_a_scope") %>
+            </div>
+          <% end %>
+
+          <div class="actions">
+            <%= form.submit t(".send"), class: "button expanded" %>
+          </div>
+        <% end %>
+      </div>
+    </div>
+  </div>
+</div>