decidim-meetings 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e19fd2bced64fedffeeb7e466c5afcbcad2b814
-  data.tar.gz: 8fadc5f684e7324c085da6f956923b66eb7c1818
+  metadata.gz: 39ecff3ff25e1f270d3bcd1b057d2f6035179297
+  data.tar.gz: a9796345f56085b0bf6613ec26b83823fb8e1652
 SHA512:
-  metadata.gz: 7784edad8cef64c16f94fd8c94c175a23b61361beb7dafa50cf4b1ec8fc0aec0c86005578923baf7dce7c4bc2c13a55357375c21263926701a5c226fbe44fc1f
-  data.tar.gz: 17e3efaa9f8d2e42642811a6b0336ae04409344f7e6b0ec19a12a18f3171b5e386432f884017674c8a30625bebce40e4b543c3b331728e6321cf4fc37ddca5dd
+  metadata.gz: 23ab8448060b0e8b10c0f079a31ded9cda519842ca798c0e5c42a4fb17acd5b9b5ce73c9ce4a9d0b5c66dabc3899fe4e5a78065da5709b3698a7de383b3b1f5b
+  data.tar.gz: 37d206c6c7ff80a8d82416233c6a30a2c9f868c6acff8ab5d6a3b2f0a517ab394d9c56fc3b8ad50f3c53bb50ba70616e511051f41c8cd022c324f322607733b9

data/app/assets/config/decidim_meetings_manifest.js

@@ -0,0 +1,2 @@
+//= link decidim/meetings/map.js
+//= link decidim/meetings/map.css

data/app/assets/javascripts/decidim/meetings/map.js.es6.erb

@@ -0,0 +1,92 @@
+// = require leaflet
+// = require leaflet-tilelayer-here
+// = require leaflet-svg-icon
+// = require jquery-tmpl
+// = require_self
+
+/* globals L */
+
+L.DivIcon.SVGIcon.DecidimIcon = L.DivIcon.SVGIcon.extend({
+  options: {
+    fillColor: '#ef604d',
+    opacity: 0
+  },
+  _createPathDescription: function() {
+    return 'M14 1.17a11.685 11.685 0 0 0-11.685 11.685c0 11.25 10.23 20.61 10.665 21a1.5 1.5 0 0 0 2.025 0c0.435-.435 10.665-9.81 10.665-21A11.685 11.685 0 0 0 14 1.17Zm0 17.415A5.085 5.085 0 1 1 19.085 13.5 5.085 5.085 0 0 1 14 18.585Z';
+  },
+  _createCircle: function() {
+    return ""
+  }
+});
+
+const popupTemplateId = 'meeting-popup';
+$.template('meeting-popup', $(`#${popupTemplateId}`).html());
+
+const addMarkers = (meetingsData, map) => {
+  const bounds = new L.LatLngBounds(meetingsData.map((meeting) => [meeting.latitude, meeting.longitude]));
+
+  meetingsData.forEach((meeting) => {
+    let marker = L.marker([meeting.latitude, meeting.longitude], {
+      icon: new L.DivIcon.SVGIcon.DecidimIcon()
+    }).addTo(map);
+    let node = document.createElement('div');
+
+    $.tmpl('meeting-popup', meeting).appendTo(node);
+
+    marker.bindPopup(node, {
+      maxwidth: 640,
+      minWidth: 500,
+      keepInView: true,
+      className: 'map-info'
+    }).openPopup();
+  });
+
+  map.fitBounds(bounds, { padding: [100, 100] });
+};
+
+const loadMap = (mapId, meetingsData) => {
+  const { hereAppId, hereAppCode } = window.DecidimMeetings.mapConfiguration;
+
+  if (window.DecidimMeetings.currentMap) {
+    window.DecidimMeetings.currentMap.remove();
+    window.DecidimMeetings.currentMap = null;
+  }
+
+  const map = L.map(mapId);
+
+  L.tileLayer.here({
+    appId: hereAppId,
+    appCode: hereAppCode,
+  }).addTo(map);
+
+  if (meetingsData.length > 0) {
+    addMarkers(meetingsData, map);
+  } else {
+    map.fitWorld();
+  }
+
+  map.scrollWheelZoom.disable();
+
+  return map;
+};
+
+window.DecidimMeetings = {
+  loadMap,
+  currentMap: null,
+  mapConfiguration: {}
+};
+
+$(() => {
+  const mapId = 'meetings-map';
+  const $map = $(`#${mapId}`);
+
+  const meetingsData = $map.data('meetings');
+  const hereAppId = $map.data('here-app-id');
+  const hereAppCode = $map.data('here-app-code');
+
+  window.DecidimMeetings.mapConfiguration = { hereAppId, hereAppCode };
+
+  if ($map.length > 0) {
+    window.DecidimMeetings.currentMap = loadMap(mapId, meetingsData);
+  }
+});

data/app/assets/stylesheets/decidim/meetings/map.css

@@ -0,0 +1 @@
+/* = require leaflet */

data/app/commands/decidim/meetings/admin/close_meeting.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+module Decidim
+  module Meetings
+    module Admin
+      # This command is executed when the user closes a Meeting from the admin
+      # panel.
+      class CloseMeeting < Rectify::Command
+        # Initializes a CloseMeeting Command.
+        #
+        # form - The form from which to get the data.
+        # meeting - The current instance of the page to be closed.
+        def initialize(form, meeting)
+          @form = form
+          @meeting = meeting
+        end
+
+        # Closes the meeting if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if @form.invalid?
+
+          transaction do
+            close_meeting
+            link_proposals
+          end
+
+          broadcast(:ok)
+        end
+
+        private
+
+        def close_meeting
+          @meeting.update_attributes!(
+            closing_report: @form.closing_report,
+            attendees_count: @form.attendees_count,
+            contributions_count: @form.contributions_count,
+            attending_organizations: @form.attending_organizations,
+            closed_at: @form.closed_at
+          )
+        end
+
+        def proposals
+          @meeting.sibling_scope(:proposals).where(id: @form.proposal_ids)
+        end
+
+        def link_proposals
+          @meeting.link_resources(proposals, "proposals_from_meeting")
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/meetings/admin/create_meeting.rb

@@ -15,18 +15,20 @@ module Decidim
         def call
           return broadcast(:invalid) if @form.invalid?
 
+          build_meeting
+          return broadcast(:invalid) if Decidim.geocoder.present? && !geocode_meeting
           create_meeting
+
           broadcast(:ok)
         end
 
         private
 
-        def create_meeting
-          Meeting.create!(
+        def build_meeting
+          @meeting = Meeting.new(
             scope: @form.scope,
             category: @form.category,
             title: @form.title,
-            short_description: @form.short_description,
             description: @form.description,
             end_time: @form.end_time,
             start_time: @form.start_time,
@@ -36,6 +38,16 @@ module Decidim
             feature: @form.current_feature
           )
         end
+
+        def geocode_meeting
+          result = @meeting.geocode
+          @form.errors.add :address, :invalid unless result
+          result
+        end
+
+        def create_meeting
+          @meeting.save!
+        end
       end
     end
   end

data/app/commands/decidim/meetings/admin/update_meeting.rb

@@ -20,18 +20,20 @@ module Decidim
         def call
           return broadcast(:invalid) if @form.invalid?
 
+          change_meeting
+          return broadcast(:invalid) if Decidim.geocoder.present? && @meeting.address_changed? && !geocode_meeting
           update_meeting
+
           broadcast(:ok)
         end
 
         private
 
-        def update_meeting
-          @meeting.update_attributes!(
+        def change_meeting
+          @meeting.assign_attributes(
             scope: @form.scope,
             category: @form.category,
             title: @form.title,
-            short_description: @form.short_description,
             description: @form.description,
             end_time: @form.end_time,
             start_time: @form.start_time,
@@ -40,6 +42,16 @@ module Decidim
             location_hints: @form.location_hints
           )
         end
+
+        def geocode_meeting
+          result = @meeting.geocode
+          @form.errors.add :address, :invalid unless result
+          result
+        end
+
+        def update_meeting
+          @meeting.save!
+        end
       end
     end
   end

data/app/controllers/decidim/meetings/admin/application_controller.rb

@@ -8,6 +8,15 @@ module Decidim
       # Note that it inherits from `Decidim::Features::BaseController`, which
       # override its layout and provide all kinds of useful methods.
       class ApplicationController < Decidim::Admin::Features::BaseController
+        helper_method :meetings, :meeting
+
+        def meetings
+          @meetings ||= Meeting.where(feature: current_feature)
+        end
+
+        def meeting
+          @meeting ||= meetings.find(params[:id])
+        end
       end
     end
   end

data/app/controllers/decidim/meetings/admin/attachments_controller.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Decidim
+  module Meetings
+    module Admin
+      # Controller that allows managing all the attachments for a participatory
+      # process.
+      #
+      class AttachmentsController < Admin::ApplicationController
+        include Decidim::Admin::Concerns::HasAttachments
+
+        def after_destroy_path
+          meetings_path
+        end
+
+        def attached_to
+          meeting
+        end
+
+        def meeting
+          @meeting ||= meetings.find(params[:meeting_id])
+        end
+
+        def authorization_object
+          meeting.feature
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/meetings/admin/meeting_closes_controller.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module Decidim
+  module Meetings
+    module Admin
+      # This controller allows an admin to manage meetings from a Participatory Process
+      class MeetingClosesController < Admin::ApplicationController
+        helper ResourceHelper
+        helper_method :meeting
+
+        def edit
+          @form = form(CloseMeetingForm).from_model(meeting)
+        end
+
+        def update
+          @form = form(CloseMeetingForm).from_params(params.merge(proposals: meeting.sibling_scope(:proposals)))
+
+          CloseMeeting.call(@form, meeting) do
+            on(:ok) do
+              flash[:notice] = I18n.t("meetings.close.success", scope: "decidim.meetings.admin")
+              redirect_to meetings_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("meetings.close.invalid", scope: "decidim.meetings.admin")
+              render action: "edit"
+            end
+          end
+        end
+
+        private
+
+        def meeting
+          @meeting ||= Meeting.where(feature: current_feature).find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/meetings/admin/meetings_controller.rb

@@ -4,8 +4,6 @@ module Decidim
     module Admin
       # This controller allows an admin to manage meetings from a Participatory Process
       class MeetingsController < Admin::ApplicationController
-        helper_method :meetings
-
         def new
           @form = form(MeetingForm).instance
         end
@@ -53,16 +51,6 @@ module Decidim
 
           redirect_to meetings_path
         end
-
-        private
-
-        def meetings
-          @meetings ||= Meeting.where(feature: current_feature)
-        end
-
-        def meeting
-          @meeting ||= meetings.find(params[:id])
-        end
       end
     end
   end

data/app/controllers/decidim/meetings/meetings_controller.rb

@@ -6,14 +6,23 @@ module Decidim
     class MeetingsController < Decidim::Meetings::ApplicationController
       include FilterResource
 
-      helper_method :meetings, :meeting
+      helper_method :meetings, :geocoded_meetings, :meeting
 
       def index; end
 
+      def static_map
+        @meeting = Meeting.where(feature: current_feature).find(params[:id])
+        send_data StaticMapGenerator.new(@meeting).data, type: "image/jpeg", disposition: "inline"
+      end
+
       private
 
       def meetings
-        @meetings ||= search.results
+        @meetings ||= search.results.page(params[:page]).per(12)
+      end
+
+      def geocoded_meetings
+        @geocoded_meetings ||= search.results.select(&:geocoded?)
       end
 
       def meeting
@@ -24,13 +33,6 @@ module Decidim
         MeetingSearch
       end
 
-      def default_search_params
-        {
-          page: params[:page],
-          per_page: 12
-        }
-      end
-
       def default_filter_params
         {
           order_start_time: "asc",

data/app/forms/decidim/meetings/admin/close_meeting_form.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module Decidim
+  module Meetings
+    module Admin
+      # This class holds a Form to close a meeting from Decidim's admin panel.
+      class CloseMeetingForm < Decidim::Form
+        include TranslatableAttributes
+
+        translatable_attribute :closing_report, String
+        attribute :attendees_count, Integer, default: 0
+        attribute :contributions_count, Integer, default: 0
+        attribute :attending_organizations, String
+        attribute :proposal_ids, Array[Integer]
+        attribute :proposals
+        attribute :closed_at, DateTime, default: ->(_form, _attribute) { Time.current }
+
+        validates :closing_report, translatable_presence: true
+        validates :attendees_count, :contributions_count, presence: true, numericality: { greater_than_or_equal_to: 0 }
+        validates :attending_organizations, presence: true
+
+        # Private: Gets the proposals from the meeting and injects them to the form.
+        #
+        # Returns nothing.
+        def map_model(model)
+          self.proposal_ids = model.linked_resources(:proposals, "proposals_from_meeting").pluck(:id)
+          self.proposals = model.sibling_scope(:proposals)
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/meetings/admin/meeting_form.rb

@@ -7,7 +7,6 @@ module Decidim
         include TranslatableAttributes
 
         translatable_attribute :title, String
-        translatable_attribute :short_description, String
         translatable_attribute :description, String
         translatable_attribute :location, String
         translatable_attribute :location_hints, String
@@ -18,7 +17,6 @@ module Decidim
         attribute :decidim_category_id, Integer
 
         validates :title, translatable_presence: true
-        validates :short_description, translatable_presence: true
         validates :description, translatable_presence: true
         validates :location, translatable_presence: true
         validates :address, presence: true

data/app/helpers/decidim/meetings/admin/application_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Decidim
+  module Meetings
+    module Admin
+      # Custom helpers, scoped to the meetings admin engine.
+      #
+      module ApplicationHelper
+        include MapHelper
+      end
+    end
+  end
+end

data/app/helpers/decidim/meetings/application_helper.rb

@@ -5,6 +5,7 @@ module Decidim
     #
     module ApplicationHelper
       include PaginateHelper
+      include MapHelper
     end
   end
 end

data/app/helpers/decidim/meetings/map_helper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+module Decidim
+  module Meetings
+    # This helper include some methods for rendering meetings static and dynamic maps.
+    module MapHelper
+      # Renders a link to openstreetmaps with the meeting latitude and longitude.
+      # The link's content is a static map image.
+      #
+      # meeting - A Decidim::Meetings::Meeting object
+      # options - An optional hash of options (default: { zoom: 17 })
+      #           * zoom: A number to represent the zoom value of the map
+      def static_map_link(meeting, options = {})
+        if meeting.geocoded?
+          zoom = options[:zoom] || 17
+          latitude = meeting.latitude
+          longitude = meeting.longitude
+
+          map_url = "https://www.openstreetmap.org/?mlat=#{latitude}&mlon=#{longitude}#map=#{zoom}/#{latitude}/#{longitude}"
+
+          link_to map_url, target: "_blank" do
+            image_tag decidim_meetings.static_map_meeting_path(feature_id: meeting.feature,
+                                                               participatory_process_id: meeting.feature.participatory_process,
+                                                               id: meeting)
+          end
+        end
+      end
+
+      # Serialize a collection of geocoded meetings to be used by the dynamic map component
+      #
+      # geocoded_meetings - A collection of geocoded meetings
+      def meetings_data_for_map(geocoded_meetings)
+        geocoded_meetings.map do |meeting|
+          meeting.slice(:latitude, :longitude, :address).merge(title: translated_attribute(meeting.title),
+                                                               description: translated_attribute(meeting.description),
+                                                               startTimeDay: l(meeting.start_time, format: "%d"),
+                                                               startTimeMonth: l(meeting.start_time, format: "%B"),
+                                                               startTime: "#{meeting.start_time.strftime("%H:%M")} - #{meeting.end_time.strftime("%H:%M")}",
+                                                               icon: icon("meetings", width: 40, height: 70, remove_icon_class: true),
+                                                               location: translated_attribute(meeting.location),
+                                                               locationHints: translated_attribute(meeting.location_hints),
+                                                               link: meeting_path(meeting))
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/meetings/meeting.rb

@@ -1,28 +1,24 @@
 # frozen_string_literal: true
+
 module Decidim
   module Meetings
     # The data store for a Meeting in the Decidim::Meetings component. It stores a
     # title, description and any other useful information to render a custom meeting.
     class Meeting < Meetings::ApplicationRecord
-      belongs_to :feature, foreign_key: "decidim_feature_id", class_name: Decidim::Feature
-      belongs_to :scope, foreign_key: "decidim_scope_id", class_name: Decidim::Scope
-      belongs_to :category, foreign_key: "decidim_category_id", class_name: Decidim::Category
-      has_one :organization, through: :feature
-      validates :title, presence: true
+      include Decidim::Resourceable
+      include Decidim::HasAttachments
+      include Decidim::HasFeature
+      include Decidim::HasScope
+      include Decidim::HasCategory
 
-      validate :scope_belongs_to_organization
-      validate :category_belongs_to_organization
+      feature_manifest_name "meetings"
 
-      private
+      validates :title, presence: true
 
-      def scope_belongs_to_organization
-        return unless scope
-        errors.add(:scope, :invalid) unless feature.scopes.where(id: scope.id).exists?
-      end
+      geocoded_by :address
 
-      def category_belongs_to_organization
-        return unless category
-        errors.add(:category, :invalid) unless feature.categories.where(id: category.id).exists?
+      def closed?
+        closed_at.present?
       end
     end
   end

data/app/services/decidim/meetings/meeting_search.rb

@@ -18,7 +18,6 @@ module Decidim
         query
           .where(localized_search_text_in(:title), text: "%#{search_text}%")
           .or(query.where(localized_search_text_in(:description), text: "%#{search_text}%"))
-          .or(query.where(localized_search_text_in(:short_description), text: "%#{search_text}%"))
       end
 
       # Handle the order_start_time filter

data/app/services/decidim/meetings/static_map_generator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require "httparty"
+
+module Decidim
+  module Meetings
+    # This class generates a url to create a static map image for a geocoded meeting
+    class StaticMapGenerator
+      BASE_HOST = "image.maps.cit.api.here.com"
+      BASE_PATH = "/mia/1.6/mapview"
+
+      def initialize(meeting, options = {})
+        @meeting = meeting
+        @options = options
+
+        @options[:zoom] ||= 15
+        @options[:width] ||= 120
+        @options[:height] ||= 120
+      end
+
+      def data
+        return if Decidim.geocoder.nil?
+
+        Rails.cache.fetch(@meeting.cache_key) do
+          request = HTTParty.get(uri)
+          request.body
+        end
+      end
+
+      private
+
+      def uri
+        params = {
+          c: "#{@meeting.latitude}, #{@meeting.longitude}",
+          z: @options[:zoom],
+          w: @options[:width],
+          h: @options[:height],
+          f: "1",
+          app_id: Decidim.geocoder&.fetch(:here_app_id),
+          app_code: Decidim.geocoder&.fetch(:here_app_code)
+        }
+
+        uri = URI.parse("https://#{BASE_HOST}#{BASE_PATH}").tap do |uri|
+          uri.query = URI.encode_www_form params
+        end
+
+        uri
+      end
+    end
+  end
+end

data/app/views/decidim/meetings/admin/meeting_closes/_form.html.erb

@@ -0,0 +1,23 @@
+<div class="field">
+  <%= form.translated :text_area, :closing_report, autofocus: true, rows: 15 %>
+</div>
+
+<div class="field">
+  <%= form.text_area :attending_organizations, rows: 5 %>
+</div>
+
+<div class="field">
+  <%= form.number_field :attendees_count, min: 0 %>
+</div>
+
+<div class="field">
+  <%= form.number_field :contributions_count, min: 0 %>
+</div>
+
+<% if @form.proposals %>
+  <%= form.select :proposal_ids,
+                  @form.proposals.order("title ASC").pluck(:title, :id),
+                  { include_blank: true },
+                  { multiple: true, class: "chosen-select" }
+  %>
+<% end %>

data/app/views/decidim/meetings/admin/meeting_closes/edit.html.erb

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

data/app/views/decidim/meetings/admin/meetings/_form.html.erb

@@ -3,11 +3,11 @@
 </div>
 
 <div class="field" >
-  <%= form.translated :editor, :short_description %>
+  <%= form.translated :editor, :description %>
 </div>
 
 <div class="field" >
-  <%= form.translated :editor, :description %>
+  <%= form.text_field :address %>
 </div>
 
 <div class="field" >
@@ -18,10 +18,6 @@
   <%= form.translated :text_area, :location_hints %>
 </div>
 
-<div class="field" >
-  <%= form.text_field :address %>
-</div>
-
 <div class="field" >
   <%= form.datetime_field :start_time %>
 </div>