decidim-admin 0.23.6 → 0.24.0.rc1

data/lib/decidim/admin/import/creator.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module Import
+      # This is an abstract class with a very naive default implementation
+      # for the importers to use. It can also serve as a superclass of your
+      # own implementation.
+      #
+      # It is used to be run against each element of an importable collection
+      # in order to parse relevant fields. Every import should specify their
+      # own creator or this default will be used.
+      class Creator
+        attr_reader :data
+
+        # Initializes the creator with a resource.
+        #
+        # data - The data hash to parse.
+        # context - The context needed by the producer
+        def initialize(data, context = nil)
+          @data = data.except(:id, "id")
+          @context = context
+        end
+
+        # Retuns the resource class to be created with the provided data.
+        def self.resource_klass
+          raise NotImplementedError, "#{self.class.name} does not define resource class"
+        end
+
+        # Can be used to convert the data hash to the resource attributes in
+        # case the data hash to be imported has different column names than the
+        # resource object to be created of it.
+        #
+        # By default returns the data hash but can be implemented by each creator
+        # implementation.
+        #
+        # Returns the resource attributes to be passed for the constructor.
+        def resource_attributes
+          @data
+        end
+
+        # Public: Returns a created object with the parsed data.
+        #
+        # Returns a target object.
+        def produce
+          self.class.resource_klass.new(resource_attributes)
+        end
+
+        def finish!
+          resource.save!
+        end
+
+        private
+
+        def resource
+          raise NotImplementedError, "#{self.class.name} does not define resource"
+        end
+
+        #
+        # Collect field's language specified cells to one hash
+        #
+        # field - The field name eg. "title"
+        # locales - Available locales
+        #
+        # Returns the hash including locale-imported_data pairs. eg. {en: "Heading", ca: "Cap", es: "Bóveda"}
+        #
+        def locale_hasher(field, locales)
+          return data[field.to_sym] if data.has_key?(field.to_sym)
+
+          hash = {}
+          locales.each do |locale|
+            parsed = data[:"#{field}/#{locale}"]
+            next if parsed.nil?
+
+            hash[locale] = parsed
+          end
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/decidim/admin/import/importer.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module Import
+      # Class providing the interface and implementation of an importer. Needs
+      # a reader to be passed to the constructor which handles the import file
+      # reading depending on its type.
+      #
+      # You can also use the ImporterFactory class to create an Importer
+      # instance.
+      class Importer
+        # Public: Initializes an Importer.
+        #
+        # file   - A file with the data to be imported.
+        # reader - A Reader to be used to read the data from the file.
+        # creator - A Creator to be used during the import.
+        # context - A hash including component specific data.
+        def initialize(file:, reader: Readers::Base, creator: Creator, context: nil)
+          @file = file
+          @reader = reader
+          @creator = creator
+          @context = context
+        end
+
+        # Import data and create resources
+        #
+        # Returns an array of resources
+        def prepare
+          @prepare ||= collection.map(&:produce)
+        end
+
+        # Save resources
+        def import!
+          collection.map(&:finish!)
+        end
+
+        # Returns a collection of creators
+        def collection
+          @collection ||= collection_data.map { |item| creator.new(item, context) }
+        end
+
+        # Returns array of all resource indexes where validations fail.
+        def invalid_lines
+          @invalid_lines ||= check_invalid_lines(prepare)
+        end
+
+        private
+
+        attr_reader :file, :reader, :creator, :context
+
+        def collection_data
+          return @collection_data if @collection_data
+
+          @collection_data = []
+          data_headers = []
+          reader.new(file).read_rows do |rowdata, index|
+            if index.zero?
+              data_headers = rowdata.map(&:to_sym)
+            else
+              @collection_data << Hash[
+                rowdata.each_with_index.map do |val, ind|
+                  [data_headers[ind], val]
+                end
+              ]
+            end
+          end
+
+          @collection_data
+        end
+
+        def check_invalid_lines(imported_data)
+          invalid_lines = []
+          imported_data.each_with_index do |record, index|
+            invalid_lines << index + 1 unless record.valid?
+          end
+          invalid_lines
+        end
+      end
+    end
+  end
+end

data/lib/decidim/admin/import/importer_factory.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module Import
+      # A factory class providing easier way to create new importers.
+      class ImporterFactory
+        def self.build(file, mime_type, **keyword_args)
+          reader = Readers.search_by_mime_type(mime_type)
+          raise NotImplementedError, "No reader implemented for mime type: #{mime_type}" if reader.nil?
+
+          Importer.new(file: file, reader: reader, **keyword_args)
+        end
+      end
+    end
+  end
+end

data/lib/decidim/admin/import/readers/base.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module Import
+      module Readers
+        # Abstract class with a very naive default implementation. Each importable
+        # file type should have it's own reader.
+        class Base
+          def initialize(file)
+            @file = file
+          end
+
+          # The read_rows method should iterate over each row of the data and
+          # yield the data array of each row with the row's index.
+          # The first row yielded with index 0 needs to contain the data headers
+          # which can be later used to map the data to correct attributes.
+          #
+          # This needs to be implemented by the extending classes.
+          def read_rows
+            raise NotImplementedError
+          end
+
+          protected
+
+          attr_reader :file
+        end
+      end
+    end
+  end
+end

data/lib/decidim/admin/import/readers/csv.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module Decidim
+  module Admin
+    module Import
+      module Readers
+        # Imports any exported CSV file to local objects. It transforms the
+        # import data using the creator into the final target objects.
+        class CSV < Base
+          MIME_TYPE = "text/csv"
+
+          def read_rows
+            ::CSV.read(file, col_sep: ";").each_with_index do |row, index|
+              yield row, index
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/admin/import/readers/json.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Decidim
+  module Admin
+    module Import
+      module Readers
+        # Imports any exported JSON file to local objects. It transforms the
+        # import data using the creator into the final target objects.
+        class JSON < Base
+          MIME_TYPE = "application/json"
+
+          def read_rows
+            json_string = File.read(file)
+            ::JSON.parse(json_string).each_with_index do |row, index|
+              yield row.keys, index if index.zero?
+              yield row.values, index + 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/admin/import/readers/xls.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "spreadsheet"
+
+module Decidim
+  module Admin
+    module Import
+      module Readers
+        # Imports any exported XLS file to local objects. It transforms the
+        # import data using the creator into the final target objects.
+        class XLS < Base
+          MIME_TYPE = "application/vnd.ms-excel"
+
+          def read_rows
+            book = ::Spreadsheet.open(file)
+            sheet = book.worksheet(0)
+            sheet.each_with_index do |row, index|
+              yield row.to_a, index
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/admin/import/readers.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module Import
+      module Readers
+        autoload :Base, "decidim/admin/import/readers/base"
+        autoload :CSV, "decidim/admin/import/readers/csv"
+        autoload :JSON, "decidim/admin/import/readers/json"
+        autoload :XLS, "decidim/admin/import/readers/xls"
+
+        # Accepted mime types
+        # keys: are used for dynamic help text on admin form.
+        # values: are used to validate the file format of imported document.
+        ACCEPTED_MIME_TYPES = {
+          json: Readers::JSON::MIME_TYPE,
+          csv: Readers::CSV::MIME_TYPE,
+          xls: Readers::XLS::MIME_TYPE
+        }.freeze
+
+        def self.all
+          [
+            Readers::CSV,
+            Readers::JSON,
+            Readers::XLS
+          ]
+        end
+
+        def self.search_by_mime_type(mime_type)
+          all.each do |reader_klass|
+            return reader_klass if mime_type == reader_klass::MIME_TYPE
+          end
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/decidim/admin/import.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module Import
+      autoload :ImporterFactory, "decidim/admin/import/importer_factory"
+      autoload :Importer, "decidim/admin/import/importer"
+      autoload :Creator, "decidim/admin/import/creator"
+      autoload :Readers, "decidim/admin/import/readers"
+    end
+  end
+end

data/lib/decidim/admin/test/commands/create_attachment_collection_examples.rb

@@ -10,12 +10,12 @@ module Decidim
         let(:form_params) do
           {
             "attachment_collection" => {
-              "name_en" => Decidim::Faker::Localized.sentence(3),
-              "name_es" => Decidim::Faker::Localized.sentence(3),
-              "name_ca" => Decidim::Faker::Localized.sentence(3),
-              "description_en" => Decidim::Faker::Localized.paragraph(3),
-              "description_es" => Decidim::Faker::Localized.paragraph(3),
-              "description_ca" => Decidim::Faker::Localized.paragraph(3)
+              "name_en" => Decidim::Faker::Localized.sentence(word_count: 3),
+              "name_es" => Decidim::Faker::Localized.sentence(word_count: 3),
+              "name_ca" => Decidim::Faker::Localized.sentence(word_count: 3),
+              "description_en" => Decidim::Faker::Localized.paragraph(sentence_count: 3),
+              "description_es" => Decidim::Faker::Localized.paragraph(sentence_count: 3),
+              "description_ca" => Decidim::Faker::Localized.paragraph(sentence_count: 3)
             }
           }
         end

data/lib/decidim/admin/test/commands/create_category_examples.rb

@@ -10,12 +10,12 @@ module Decidim
         let(:form_params) do
           {
             "category" => {
-              "name_en" => Decidim::Faker::Localized.paragraph(3),
-              "name_es" => Decidim::Faker::Localized.paragraph(3),
-              "name_ca" => Decidim::Faker::Localized.paragraph(3),
-              "description_en" => Decidim::Faker::Localized.paragraph(3),
-              "description_es" => Decidim::Faker::Localized.paragraph(3),
-              "description_ca" => Decidim::Faker::Localized.paragraph(3)
+              "name_en" => Decidim::Faker::Localized.paragraph(sentence_count: 3),
+              "name_es" => Decidim::Faker::Localized.paragraph(sentence_count: 3),
+              "name_ca" => Decidim::Faker::Localized.paragraph(sentence_count: 3),
+              "description_en" => Decidim::Faker::Localized.paragraph(sentence_count: 3),
+              "description_es" => Decidim::Faker::Localized.paragraph(sentence_count: 3),
+              "description_ca" => Decidim::Faker::Localized.paragraph(sentence_count: 3)
             }
           }
         end

data/lib/decidim/admin/test/filterable_examples.rb

@@ -2,16 +2,9 @@
 
 shared_context "with filterable context" do
   let(:factory_name) { model_name.singular_route_key }
-  let(:module_name) { model_name.route_key.camelize }
-  let(:filterable_concern) { "Decidim::#{module_name}::Admin::Filterable".constantize }
-
-  let(:filterable_fake_controller) do
-    FILTERABLE_CONCERN ||= filterable_concern
-    class FilterableFakeController < Decidim::ApplicationController; include FILTERABLE_CONCERN; end
-  end
 
   def filterable_method(method_name)
-    (@controller ||= filterable_fake_controller.new).send(method_name)
+    resource_controller.new.send(method_name)
   end
 
   def apply_filter(options, filter)

data/lib/decidim/admin/test/manage_moderations_examples.rb

@@ -3,7 +3,7 @@
 shared_examples "manage moderations" do
   let!(:moderations) do
     reportables.first(reportables.length - 1).map do |reportable|
-      moderation = create(:moderation, reportable: reportable, report_count: 1)
+      moderation = create(:moderation, reportable: reportable, report_count: 1, reported_content: reportable.reported_searchable_content_text)
       create(:report, moderation: moderation)
       moderation
     end
@@ -11,15 +11,16 @@ shared_examples "manage moderations" do
   let!(:moderation) { moderations.first }
   let!(:hidden_moderations) do
     reportables.last(1).map do |reportable|
-      moderation = create(:moderation, reportable: reportable, report_count: 3, hidden_at: Time.current)
+      moderation = create(:moderation, reportable: reportable, report_count: 3, reported_content: reportable.reported_searchable_content_text, hidden_at: Time.current)
       create_list(:report, 3, moderation: moderation, reason: :spam)
       moderation
     end
   end
+  let(:moderations_link_text) { "Moderations" }
 
   before do
     visit participatory_space_path
-    click_link "Moderations"
+    click_link moderations_link_text
   end
 
   context "when listing moderations" do
@@ -48,11 +49,55 @@ shared_examples "manage moderations" do
       expect(page).to have_admin_callout("Resource successfully hidden")
       expect(page).to have_no_content(moderation.reportable.reported_content_url)
     end
+
+    it "user can sort by report count" do
+      moderations.each_with_index { |moderation, index| moderation.update(report_count: index + 1) }
+      moderations_ordered_by_report_count_asc = moderations.sort_by(&:report_count)
+
+      within "table" do
+        click_link "Count"
+
+        all("tbody tr").each_with_index do |row, index|
+          reportable_id = moderations_ordered_by_report_count_asc[index].reportable.id
+          expect(row.find("td:first-child")).to have_content(reportable_id)
+        end
+      end
+    end
+
+    it "user can filter by reportable type" do
+      reportable_type = moderation.reportable.class.name.demodulize
+      within ".filters__section" do
+        find(:xpath, "//a[contains(text(), 'Filter')]").hover
+        find(:xpath, "//a[contains(text(), 'Type')]").hover
+        click_link reportable_type
+      end
+      expect(page).to have_selector("tbody tr", count: moderations.length)
+    end
+
+    it "user can filter by reported content" do
+      search = moderation.reportable.id
+      within ".filters__section" do
+        fill_in("Search Moderation by reportable id or content.", with: search)
+        find(:xpath, "//button[@type='submit']").click
+      end
+      expect(page).to have_selector("tbody tr", count: 1)
+    end
+
+    it "user can see moderation details" do
+      within "tr[data-id=\"#{moderation.id}\"]" do
+        click_link "Expand"
+      end
+
+      reported_content_slice = moderation.reportable.reported_searchable_content_text.split("\n").first
+      expect(page).to have_content(reported_content_slice)
+    end
   end
 
   context "when listing hidden resources" do
     it "user can review them" do
-      click_link "Hidden"
+      within ".card-title" do
+        click_link "Hidden"
+      end
 
       hidden_moderations.each do |moderation|
         within "tr[data-id=\"#{moderation.id}\"]" do

data/lib/decidim/admin/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-admin version.
   module Admin
     def self.version
-      "0.23.6"
+      "0.24.0.rc1"
     end
   end
 end

data/lib/decidim/admin.rb

@@ -11,6 +11,7 @@ module Decidim
   module Admin
     autoload :Components, "decidim/admin/components"
     autoload :FormBuilder, "decidim/admin/form_builder"
+    autoload :Import, "decidim/admin/import"
 
     include ActiveSupport::Configurable
 
@@ -28,5 +29,10 @@ module Decidim
       config.default_per_page = Decidim::Admin.per_page_range.first
       config.max_per_page = Decidim::Admin.per_page_range.last
     end
+
+    # Public: Stores an instance of ViewHooks
+    def self.view_hooks
+      @view_hooks ||= ViewHooks.new
+    end
   end
 end