decidim-gallery 0.0.1

data/README.md

@@ -0,0 +1,30 @@
+# Decidim::Gallery
+
+Decidim Gallery Module.
+
+## Usage
+
+Gallery will be available as a Component for a Participatory
+Space.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "decidim-gallery"
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+## Contributing
+
+See [Decidim](https://github.com/decidim/decidim).
+
+## License
+
+This engine is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"
+
+desc "Generates a dummy app for testing"
+task test_app: "decidim:generate_external_test_app"
+
+desc "Generates a development app."
+task development_app: "decidim:generate_external_development_app"

data/app/cells/decidim/gallery/main/image.erb

@@ -0,0 +1,51 @@
+<% if gallery_component.settings.show_title? %>
+  <h3 class="section-heading gallery-heading"><%= title %> (<%= t( ".#{gallery_component.settings.gallery_type}", count: items.total_count) %>)</h3>
+<% end %>
+
+<% if gallery_component.settings.show_announcement? %>
+  <div class="row">
+    <div class="column"><%= translated_attribute(gallery_component.settings.announcement) %></div>
+  </div>
+<% end %>
+
+<div class="row small-up <%= model.css %> medium-up-3 mb-l gallery image" id="gallery_<%= model.section %>_<%=model.gallery_id %>">
+  <%= cell("decidim/gallery/main", model).collection %>
+</div>
+<% unless items.total_count.zero? || items.last_page? %>
+  <div class="row">
+    <div class="column">
+      <%= link_to t("decidim.gallery.main.load_more"), gallery_path(format: 'js', page: items.next_page,section: model.section, cb: model.id), class: "button small hollow", id: "link_gallery_#{model.section}_#{model.id}" , remote: true %>
+    </div>
+  </div>
+<% end %>
+
+<div class="small gallery-pop-up reveal" id="galleryModal_<%= model.section %>_<%=model.id %>" <% unless browser.mobile? %> data-reveal<% end %> >
+  <button class="close-button" data-close aria-label="<%= t("decidim.gallery.main.close_modal") %>"
+          type="button">
+    <span aria-hidden="true">&times;</span>
+  </button>
+
+  <div class="orbit row" data-orbit data-auto-play="false">
+    <div class="orbit-wrapper">
+      <div class="orbit-controls">
+        <button class="orbit-previous"><span class="show-for-sr"><%= t("decidim.gallery.main.previous_slide") %></span>
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24.425 38.092">
+            <path id="Path_3921" data-name="Path 3921" d="M0,.13,18.222,22.218l8.81-10.68L36.55,0" transform="translate(23.789 0.771) rotate(90)" fill="none" stroke-width="6"/>
+          </svg>
+        </button>
+        <button class="orbit-next"><span class="show-for-sr"><%= t("decidim.gallery.main.next_slide") %></span>
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24.425 38.092">
+            <path id="Path_3922" data-name="Path 3922" d="M0,22.088,18.222,0l8.81,10.68L36.55,22.218" transform="translate(22.854 0.771) rotate(90)" fill="none" stroke-width="6"/>
+          </svg>
+        </button>
+      </div>
+
+      <ul class="orbit-container">
+        <%= cell("decidim/gallery/main", model).list_items %>
+      </ul>
+    </div>
+  </div>
+</div>
+<% content_for(:js_content) do %>
+  <%= javascript_pack_tag "decidim_gallery" %>
+<% end  %>

data/app/cells/decidim/gallery/main/image_collection.erb

@@ -0,0 +1,13 @@
+<% items.each do |item| %>
+  <% next unless item.attached_uploader(:photo).attached? %>
+  <div class="column gallery-item">
+    <% if browser.mobile? %>
+      <%= image_tag item.attached_uploader(:photo).path(variant: :big), alt: translated_attribute(item.title), class: "speaker-image" %>
+    <% else %>
+      <a href="#" title="<%= translated_attribute(item.title) %>" data-open="galleryModal_<%= model.section %>_<%=model.id %>" data-id="link<%= item.id %>">
+        <%= image_tag item.attached_uploader(:photo).path(variant: :big), alt: translated_attribute(item.title), class: "speaker-image" %>
+      </a>
+    <% end %>
+    <div class="gallery-caption"><%= translated_attribute(item.title) %></div>
+  </div>
+<% end %>

data/app/cells/decidim/gallery/main/image_list.erb

@@ -0,0 +1,9 @@
+<% items.each_with_index do |item, index| %>
+  <% next unless item.attached_uploader(:photo).attached? %>
+  <li class="<%= index.zero? ?  'is-active ' : '' %>orbit-slide" data-target="link<%= item.id %>">
+    <figure class="orbit-figure">
+      <%= image_tag item.attached_uploader(:photo).path(variant: :big), class: 'orbit-image' %>
+      <figcaption class="orbit-caption gallery-caption"><%= translated_attribute(item.title) %></figcaption>
+    </figure>
+  </li>
+<% end  %>

data/app/cells/decidim/gallery/main/video.erb

@@ -0,0 +1,20 @@
+<% if gallery_component.settings.show_title? %>
+  <h3 class="section-heading gallery-heading"><%= title %> (<%= t( ".#{gallery_component.settings.gallery_type}", count: items.total_count) %>)</h3>
+<% end %>
+
+<% if gallery_component.settings.show_announcement? %>
+  <div class="row">
+    <div class="column"><%= translated_attribute(gallery_component.settings.announcement) %></div>
+  </div>
+<% end %>
+
+<div class="row small-up <%= model.css %> mb-l medium-up-3 gallery video" id="gallery_<%= model.section %>_<%=model.id %>">
+  <%= cell("decidim/gallery/main", model).collection %>
+</div>
+<% unless items.total_count.zero? || items.last_page? %>
+  <div class="row">
+    <div class="column">
+      <%= link_to t("decidim.gallery.main.load_more"), gallery_path(format: 'js', page: items.next_page, section: model.section, cb: model.id), class: "button small hollow", id: "link_gallery_#{model.section}_#{model.id}", remote: true %>
+    </div>
+  </div>
+<% end %>

data/app/cells/decidim/gallery/main/video_collection.erb

@@ -0,0 +1,3 @@
+<% items.each do |item| %>
+  <%= cell("decidim/gallery/video", stubbed_video_object(item)) %>
+<% end %>

data/app/cells/decidim/gallery/main_cell.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Gallery
+    class MainCell < Decidim::ViewModel
+      delegate :public_name_key, :has_settings?, to: :model
+      delegate :content_for, to: :view_context
+
+      def show
+        render gallery_type.to_sym if gallery_component.present?
+      end
+
+      def collection
+        render "#{gallery_type}_collection"
+      end
+
+      def list_items
+        return "" if gallery_type == "video"
+
+        render "#{gallery_type}_list"
+      end
+
+      def items
+        @items ||= Decidim::Gallery::GalleryItem
+                   .published
+                   .where(decidim_component_id: gallery_component.id)
+                   .order(weight: :desc, published_at: :desc)
+                   .page(options[:page])
+                   .per(per_page)
+      end
+
+      def gallery_path(**options)
+        current_params = try(:params) || {}
+        EngineRouter.main_proxy(gallery_component).root_path({ locale: current_params[:locale] }.reverse_merge(options))
+      end
+
+      Settings = Struct.new(:video_url, :title, keyword_init: true)
+      Video = Struct.new(:settings, :cache_key_with_version, keyword_init: true)
+
+      def stubbed_video_object(item)
+        Video.new(settings: Settings.new(
+          video_url: translated_attribute(item.video_url),
+          title: translated_attribute(item.title)
+        ),
+                  cache_key_with_version: item.cache_key_with_version)
+      end
+
+      def title
+        translated_attribute(gallery_component.name)
+      end
+
+      def gallery_component
+        @gallery_component ||= Decidim::Component.find_by(id: model.gallery_id)
+      end
+
+      def browser
+        @browser ||= Browser.new(
+          request.headers["User-Agent"],
+          accept_language: request.headers["Accept-Language"]
+        )
+      end
+
+      def current_participatory_space
+        controller.try(:current_participatory_space)
+      end
+
+      protected
+
+      def view_context
+        context.fetch(:view_context)
+      end
+
+      def per_page
+        gallery_component.settings.items_per_page
+      end
+
+      def show_title?
+        gallery_component.settings.show_title
+      end
+
+      private
+
+      def gallery_type
+        gallery_component.settings.gallery_type
+      end
+    end
+  end
+end

data/app/cells/decidim/gallery/video/show.erb

@@ -0,0 +1,6 @@
+<div class="column gallery-item">
+  <iframe src="<%= embeded_video_url %>" class="video-iframe class-<%= video_provider %>" title="<%= translated_title %>" style="border:0;"></iframe>
+  <div class="speaker-data">
+    <div class="data-name gallery-caption"><%= translated_title %></div>
+  </div>
+</div>

data/app/cells/decidim/gallery/video_cell.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Gallery
+    class VideoCell < Decidim::ViewModel
+      include Decidim::SanitizeHelper
+
+      PROVIDERS = {
+        "youtube" => :youtube,
+        "youtu.be" => :youtube,
+        "vimeo" => :vimeo,
+        "dai.ly" => :dailymotion,
+        "dailymotion" => :dailymotion
+      }.freeze
+
+      def show
+        return if embeded_video_url.nil?
+
+        render
+      end
+
+      def translated_title
+        @translated_title ||= translated_attribute(model.settings.title)
+      end
+
+      def cache_hash
+        hash = []
+        hash.push(I18n.locale)
+        hash.push(model.cache_key_with_version)
+        hash.join(Decidim.cache_key_separator)
+      end
+
+      private
+
+      def video_url
+        model.settings.video_url
+      end
+
+      def embeded_video_url
+        send("#{video_provider}_url".to_sym) if video_provider
+      end
+
+      def youtube_url
+        return if video_id_youtube.blank?
+
+        "//www.youtube.com/embed/#{video_id_youtube}"
+      end
+
+      def vimeo_url
+        return if video_id_vimeo.blank?
+
+        "//player.vimeo.com/video/#{video_id_vimeo}"
+      end
+
+      def dailymotion_url
+        return if video_id_dailymotion.blank?
+
+        "//www.dailymotion.com/embed/video/#{video_id_dailymotion}"
+      end
+
+      def video_id_youtube
+        @video_id_youtube ||= begin
+          regex_id = %r{(?:youtube(?:-nocookie)?\.com/(?:[^/\n\s]+/\S+/|(?:v|e(?:mbed)?)/|\S*?[?&]v=)|youtu\.be/)([a-zA-Z0-9_-]{7,11})}
+          match_value = regex_id.match(video_url)
+          match_value[1] if match_value && match_value[1].present?
+        end
+      end
+
+      def video_id_dailymotion
+        @video_id_dailymotion ||= begin
+          regex_id = %r{(?:dailymotion\.com|dai\.ly)/(?:embed/)?(?:video/)?([a-zA-Z0-9]*)}
+          match_value = regex_id.match(video_url)
+          match_value[1] if match_value && match_value[1].present?
+        end
+      end
+
+      def video_id_vimeo
+        @video_id_vimeo ||= begin
+          regex_id = %r{vimeo\.com/(?:channels/(?:\w+/)?|groups/[^/]*/videos/|video/|)(\d+)(?:|/\?)}
+          match_value = regex_id.match(video_url)
+          match_value[1] if match_value && match_value[1].present?
+        end
+      end
+
+      def video_provider
+        @video_provider ||= begin
+          regex_prov = /(youtube|youtu\.be|vimeo|dai\.ly|dailymotion)/
+          match_prov = regex_prov.match(video_url)
+          return unless match_prov && match_prov[1].present?
+
+          PROVIDERS[match_prov[1]]
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/gallery/admin/create_gallery_item.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Gallery
+    module Admin
+      class CreateGalleryItem < Rectify::Command
+        include ::Decidim::AttachmentAttributesMethods
+
+        def initialize(form, current_user)
+          @form = form
+          @current_user = current_user
+        end
+
+        def call
+          return broadcast(:invalid) if @form.invalid?
+
+          transaction do
+            create_gallery_item!
+          end
+
+          broadcast(:ok, @gallery_item)
+        end
+
+        private
+
+        attr_reader :form
+
+        def create_gallery_item!
+          @gallery_item = Decidim.traceability.create!(
+            GalleryItem,
+            @current_user,
+            attributes,
+            visibility: "all"
+          )
+        end
+
+        def attributes
+          @hash = { title: form.title, component: form.current_component, author: @current_user, weight: form.weight }
+
+          if form.current_component.settings["gallery_type"] == "image"
+            @hash.merge!(attachment_attributes(:photo))
+          else
+            @hash.merge!(video_url: form.video_url)
+          end
+          @hash
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/gallery/admin/publish_gallery_item.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Gallery
+    module Admin
+      class PublishGalleryItem < Rectify::Command
+        def initialize(gallery_item, current_user)
+          @gallery_item = gallery_item
+          @current_user = current_user
+        end
+
+        def call
+          return broadcast(:invalid) if @gallery_item.published?
+
+          transaction do
+            publish_gallery_item!
+          end
+
+          broadcast(:ok, @gallery_item)
+        end
+
+        private
+
+        def publish_gallery_item!
+          @gallery_item = Decidim.traceability.perform_action!(
+            :publish,
+            @gallery_item,
+            @current_user,
+            visibility: "all"
+          ) do
+            @gallery_item.publish!
+            @gallery_item
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/gallery/admin/unpublish_gallery_item.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Gallery
+    module Admin
+      class UnpublishGalleryItem < Rectify::Command
+        def initialize(gallery_item, current_user)
+          @gallery_item = gallery_item
+          @current_user = current_user
+        end
+
+        def call
+          return broadcast(:invalid) unless @gallery_item.published?
+
+          transaction do
+            unpublish_gallery_item!
+          end
+
+          broadcast(:ok, @gallery_item)
+        end
+
+        private
+
+        def unpublish_gallery_item!
+          @gallery_item = Decidim.traceability.perform_action!(
+            :unpublish,
+            @gallery_item,
+            @current_user,
+            visibility: "all"
+          ) do
+            @gallery_item.unpublish!
+            @gallery_item
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/gallery/admin/update_gallery_item.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Gallery
+    module Admin
+      class UpdateGalleryItem < Rectify::Command
+        include ::Decidim::AttachmentAttributesMethods
+
+        def initialize(form, gallery_item)
+          @form = form
+          @gallery_item = gallery_item
+        end
+
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          transaction do
+            update_gallery_item!
+          end
+
+          broadcast(:ok, @gallery_item)
+        end
+
+        private
+
+        attr_reader :form
+
+        def update_gallery_item!
+          @gallery_item.update!(**attributes)
+        end
+
+        def attributes
+          @hash = { title: form.title, weight: form.weight }
+          if @form.current_component.settings["gallery_type"] == "image"
+            @hash.merge!(attachment_attributes(:photo))
+          else
+            @hash.merge!(video_url: form.video_url)
+          end
+          @hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Gallery
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Admin::Components::BaseController`, which
+      # override its layout and provide all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::Components::BaseController
+        helper_method :gallery_items, :gallery_item
+
+        def gallery_items
+          @gallery_items ||= GalleryItem.where(component: current_component).page(params[:page]).per(15)
+        end
+
+        def gallery_item
+          @gallery_item ||= gallery_items.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/gallery/admin/gallery_item_controller.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Gallery
+    module Admin
+      class GalleryItemController < ::Decidim::Gallery::Admin::ApplicationController
+        def index
+          enforce_permission_to :list, :gallery
+        end
+
+        def new
+          enforce_permission_to :create, :gallery
+          @form = form(fetch_form).instance
+        end
+
+        def create
+          enforce_permission_to :create, :gallery
+          @form = form(fetch_form).from_params(params, current_component: current_component)
+
+          CreateGalleryItem.call(@form, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("gallery_item.create.success", scope: "decidim.gallery.admin")
+              redirect_to EngineRouter.admin_proxy(current_component).root_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("gallery_item.create.invalid", scope: "decidim.gallery.admin")
+              render action: "new"
+            end
+          end
+        end
+
+        def edit
+          enforce_permission_to :update, :gallery, gallery_item: gallery_item
+          @form = form(fetch_form).from_model(gallery_item)
+        end
+
+        def update
+          enforce_permission_to :update, :gallery, gallery_item: gallery_item
+          @form = form(fetch_form).from_params(params, current_component: current_component)
+
+          UpdateGalleryItem.call(@form, gallery_item) do
+            on(:ok) do
+              flash[:notice] = I18n.t("gallery_item.update.success", scope: "decidim.gallery.admin")
+              redirect_to EngineRouter.admin_proxy(current_component).root_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("gallery_item.update.invalid", scope: "decidim.gallery.admin")
+              render action: "edit"
+            end
+          end
+        end
+
+        def publish
+          enforce_permission_to :update, :gallery, gallery_item: gallery_item
+
+          Decidim::Gallery::Admin::PublishGalleryItem.call(gallery_item, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("gallery_item.publish.success", scope: "decidim.gallery.admin")
+              redirect_to EngineRouter.admin_proxy(current_component).root_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("gallery_item.publish.invalid", scope: "decidim.gallery.admin")
+              render action: "index"
+            end
+          end
+        end
+
+        def unpublish
+          enforce_permission_to :update, :gallery, gallery_item: gallery_item
+
+          Decidim::Gallery::Admin::UnpublishGalleryItem.call(gallery_item, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("gallery_item.unpublish.success", scope: "decidim.gallery.admin")
+              redirect_to root_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("gallery_item.unpublish.invalid", scope: "decidim.gallery.admin")
+              render action: "index"
+            end
+          end
+        end
+
+        def destroy
+          enforce_permission_to :destroy, :gallery, gallery_item: gallery_item
+          gallery_item.destroy!
+
+          flash[:notice] = I18n.t("gallery_item.destroy.success", scope: "decidim.gallery.admin")
+
+          redirect_to root_path
+        end
+
+        private
+
+        def fetch_form
+          current_component.settings["gallery_type"] == "image" ? GalleryItemImageForm : GalleryItemVideoForm
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/gallery/application_controller.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Gallery
+    class ApplicationController < Decidim::Components::BaseController
+    end
+  end
+end

data/app/controllers/decidim/gallery/gallery_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Gallery
+    class GalleryController < Decidim::Gallery::ApplicationController
+      def index; end
+    end
+  end
+end

data/app/forms/decidim/gallery/admin/gallery_item_form.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Gallery
+    module Admin
+      class GalleryItemForm < Decidim::Form
+        alias organization current_organization
+
+        include Decidim::TranslatableAttributes
+        translatable_attribute :title, String
+        attribute :weight, Integer, default: 0
+
+        validates :title, translatable_presence: true
+      end
+    end
+  end
+end