decidim-core 0.0.8.1 → 0.1.0

data/config/locales/nl.yml

@@ -308,7 +308,7 @@ nl:
         title: Gebruikersinstellingen
         user_groups: Organisaties
   locale:
-    name: Engels
+    name: Nederlands
   pages:
     '404':
       back_home: Terug naar huis
@@ -340,8 +340,6 @@ nl:
         see_all_processes: Toon alle processen
       statistics:
         headline: Huidige stand van %{organization}
-        processes: Processen
-        users: Gebruikers
       sub_hero:
         register: Registeren
   social_share_button:

data/db/seeds.rb

@@ -20,7 +20,7 @@ if !Rails.env.production? || ENV["SEED"]
     reference_prefix: Faker::Name.suffix
   )
 
-  3.times.each do |index|
+  3.times.each do
     Decidim::Scope.create!(
       name: Faker::Address.unique.state,
       organization: organization

data/lib/decidim/core.rb

@@ -24,6 +24,9 @@ module Decidim
   autoload :HasCategory, "decidim/has_category"
   autoload :HasReference, "decidim/has_reference"
   autoload :Attributes, "decidim/attributes"
+  autoload :StatsRegistry, "decidim/stats_registry"
+  autoload :Exporters, "decidim/exporters"
+  autoload :FileZipper, "decidim/file_zipper"
 
   include ActiveSupport::Configurable
 
@@ -79,13 +82,13 @@ module Decidim
 
   # Exposes a configuration option: The application name String.
   config_accessor :available_locales do
-    %w(en ca es eu fi)
+    %w(en ca es eu fi fr nl)
   end
 
   # Exposes a configuration option: an object to configure geocoder
   config_accessor :geocoder
 
-   # Exposes a configuration option: the currency unit
+  # Exposes a configuration option: the currency unit
   config_accessor :currency_unit { "€" }
 
   # Exposes a configuration option: The maximum file size of an attachment.
@@ -155,4 +158,9 @@ module Decidim
   def self.resource_manifests
     @resource_manifests ||= feature_manifests.flat_map(&:resource_manifests)
   end
+
+  # Public: Stores an instance of StatsRegistry
+  def self.stats
+    @stats ||= StatsRegistry.new
+  end
 end

data/lib/decidim/core/api/decidim_type.rb

@@ -8,5 +8,9 @@ module Decidim
     field :version, !types.String, "The current decidim's version of this deployment." do
       resolve ->(obj, _args, _ctx) { obj.version }
     end
+
+    field :application_name, !types.String, "The current installation's name." do
+      resolve ->(obj, _args, _ctx) { obj.application_name }
+    end
   end
 end

data/lib/decidim/core/api/translated_field_type.rb

@@ -20,7 +20,7 @@ module Decidim
         description "A list of locales to scope the translations to."
       end
 
-      resolve ->(obj, args, _ctx) {
+      resolve lambda { |obj, args, _ctx|
         translations = obj.stringify_keys
         translations = translations.slice(*args["locales"]) if args["locales"]
 
@@ -33,7 +33,7 @@ module Decidim
       description "Returns a single translation given a locale."
       argument :locale, !types.String, "A locale to search for"
 
-      resolve ->(obj, args, _ctx) {
+      resolve lambda { |obj, args, _ctx|
         translations = obj.stringify_keys
         translations[args["locale"]]
       }

data/lib/decidim/core/engine.rb

@@ -119,6 +119,19 @@ module Decidim
           )
         end
       end
+
+      initializer "decidim.stats" do
+        Decidim.stats.register :users_count, priority: StatsRegistry::HIGH_PRIORITY do |organization, start_at, end_at|
+          StatsUsersCount.for(organization, start_at, end_at)
+        end
+
+        Decidim.stats.register :processes_count, priority: StatsRegistry::HIGH_PRIORITY do |organization, start_at, end_at|
+          processes = (OrganizationParticipatoryProcesses.new(organization) | PublicParticipatoryProcesses.new)
+          processes = processes.where("created_at >= ?", start_at) if start_at.present?
+          processes = processes.where("created_at <= ?", end_at) if end_at.present?
+          processes.count
+        end
+      end
     end
   end
 end

data/lib/decidim/core/test/shared_examples/comments_examples.rb

@@ -3,17 +3,15 @@
 RSpec.shared_examples "comments" do
   let!(:organization) { create(:organization) }
   let!(:user) { create(:user, :confirmed, organization: organization) }
-  let!(:comments) {
-    3.times.map do
+  let!(:comments) do
+    Array.new(3) do
       create(:comment, commentable: commentable)
     end
-  }
+  end
   let(:authenticated) { false }
 
   def visit_commentable_path
-    if authenticated
-      login_as user, scope: :user
-    end
+    login_as user, scope: :user if authenticated
     visit resource_path
   end
 
@@ -42,13 +40,13 @@ RSpec.shared_examples "comments" do
     visit_commentable_path
 
     within ".order-by" do
-      page.find('.dropdown.menu .is-dropdown-submenu-parent').hover
+      page.find(".dropdown.menu .is-dropdown-submenu-parent").hover
     end
 
     click_link "Best rated"
 
     within "#comments" do
-      expect(page.find('.comment', match: :first)).to have_content "Most Rated Comment"
+      expect(page.find(".comment", match: :first)).to have_content "Most Rated Comment"
     end
   end
 
@@ -98,9 +96,9 @@ RSpec.shared_examples "comments" do
             expect(page).to have_content "This is a new comment"
           end
         else
-          expect {
+          expect do
             wait_for_email subject: "new comment"
-          }.to raise_error StandardError
+          end.to raise_error StandardError
         end
       end
     end
@@ -173,7 +171,7 @@ RSpec.shared_examples "comments" do
 
         expect(page).to have_selector(".add-comment form")
 
-        page.find('.opinion-toggle--ok').click
+        page.find(".opinion-toggle--ok").click
 
         within ".add-comment form" do
           fill_in "add-comment-#{commentable.commentable_type}-#{commentable.id}", with: "I am in favor about this!"
@@ -181,7 +179,7 @@ RSpec.shared_examples "comments" do
         end
 
         within "#comments" do
-          expect(page).to have_selector 'span.success.label', text: "In favor"
+          expect(page).to have_selector "span.success.label", text: "In favor"
         end
       end
     end
@@ -195,9 +193,9 @@ RSpec.shared_examples "comments" do
         visit_commentable_path
 
         within "#comment_#{comments[0].id}" do
-          expect(page).to have_selector('.comment__votes--up', text: /0/)
-          page.find('.comment__votes--up').click
-          expect(page).to have_selector('.comment__votes--up', text: /1/)
+          expect(page).to have_selector(".comment__votes--up", text: /0/)
+          page.find(".comment__votes--up").click
+          expect(page).to have_selector(".comment__votes--up", text: /1/)
         end
       end
 
@@ -205,9 +203,9 @@ RSpec.shared_examples "comments" do
         visit_commentable_path
 
         within "#comment_#{comments[0].id}" do
-          expect(page).to have_selector('.comment__votes--down', text: /0/)
-          page.find('.comment__votes--down').click
-          expect(page).to have_selector('.comment__votes--down', text: /1/)
+          expect(page).to have_selector(".comment__votes--down", text: /0/)
+          page.find(".comment__votes--down").click
+          expect(page).to have_selector(".comment__votes--down", text: /1/)
         end
       end
     end

data/lib/decidim/core/test/shared_examples/manage_moderations_examples.rb

@@ -38,7 +38,7 @@ RSpec.shared_examples "manage moderations" do
       click_link "Moderations"
 
       within "tr[data-id=\"#{moderation.id}\"]" do
-        click_link "Unreport"
+        find("a.action-icon--unreport").click
       end
 
       within ".callout-wrapper" do
@@ -50,7 +50,7 @@ RSpec.shared_examples "manage moderations" do
       click_link "Moderations"
 
       within "tr[data-id=\"#{moderation.id}\"]" do
-        click_link "Hide"
+        find("a.action-icon--hide").click
       end
 
       within ".callout-wrapper" do

data/lib/decidim/core/test/shared_examples/reports_examples.rb

@@ -5,13 +5,13 @@ RSpec.shared_examples "reports" do
     it "should be given the option to sign in" do
       visit reportable_path
 
-      expect(page).to have_selector('.author-data__extra')
+      expect(page).to have_selector(".author-data__extra")
 
       within ".author-data__extra", match: :first do
-        page.find('button').click
+        page.find("button").click
       end
 
-      expect(page).to have_css('#loginModal', visible: true)
+      expect(page).to have_css("#loginModal", visible: true)
     end
   end
 
@@ -24,13 +24,13 @@ RSpec.shared_examples "reports" do
       it "reports the resource" do
         visit reportable_path
 
-        expect(page).to have_selector('.author-data__extra')
+        expect(page).to have_selector(".author-data__extra")
 
         within ".author-data__extra", match: :first do
-          page.find('button').click
+          page.find("button").click
         end
 
-        expect(page).to have_css('.flag-modal', visible: true)
+        expect(page).to have_css(".flag-modal", visible: true)
 
         within ".flag-modal" do
           click_button "Report"
@@ -49,13 +49,13 @@ RSpec.shared_examples "reports" do
       it "cannot report it twice" do
         visit reportable_path
 
-        expect(page).to have_selector('.author-data__extra')
+        expect(page).to have_selector(".author-data__extra")
 
         within ".author-data__extra", match: :first do
-          page.find('button').click
+          page.find("button").click
         end
 
-        expect(page).to have_css('.flag-modal', visible: true)
+        expect(page).to have_css(".flag-modal", visible: true)
 
         expect(page).to have_content "already reported"
       end

data/lib/decidim/core/version.rb

@@ -2,7 +2,7 @@
 # This holds Decidim's version and the Rails version on which it depends.
 module Decidim
   def self.version
-    "0.0.8.1"
+    "0.1.0"
   end
 
   def self.rails_version

data/lib/decidim/exporters.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Decidim
+  module Exporters
+    autoload :Exporter, "decidim/exporters/exporter"
+    autoload :JSON, "decidim/exporters/json"
+    autoload :CSV, "decidim/exporters/csv"
+    autoload :ExportData, "decidim/exporters/export_data"
+  end
+end

data/lib/decidim/exporters/csv.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require "csv"
+
+module Decidim
+  module Exporters
+    # Exports any serialized object (Hash) into a readable CSV. It transforms
+    # the columns using slashes in a way that can be afterwards reconstructed
+    # into the original nested hash.
+    #
+    # For example, `{ name: { ca: "Hola", en: "Hello" } }` would result into
+    # the columns: `name/ca` and `name/es`.
+    class CSV < Exporter
+      # Public: Exports a CSV serialized version of the collection using the
+      # provided serializer and following the previously described strategy.
+      #
+      # Returns an ExportData instance.
+      def export
+        data = ::CSV.generate(headers: headers, write_headers: true, col_sep: ";") do |csv|
+          processed_collection.each do |resource|
+            csv << headers.map { |header| resource[header] }
+          end
+        end
+
+        ExportData.new(data, "csv")
+      end
+
+      private
+
+      def headers
+        return [] if processed_collection.empty?
+        processed_collection.first.keys
+      end
+
+      def processed_collection
+        @processed_collection ||= collection.map do |resource|
+          flatten(@serializer.new(resource).serialize)
+        end
+      end
+
+      def flatten(object, key = nil)
+        if object.is_a? Hash
+          object.inject({}) do |result, (subkey, value)|
+            new_key = key ? "#{key}/#{subkey}" : subkey.to_s
+            result.merge(flatten(value, new_key))
+          end
+        elsif object.is_a?(Array)
+          { key.to_s => object.map(&:to_s).join(", ") }
+        else
+          { key.to_s => object }
+        end
+      end
+    end
+  end
+end

data/lib/decidim/exporters/export_data.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module Decidim
+  module Exporters
+    # Holds the result of an export.
+    class ExportData
+      attr_reader :extension
+
+      # Initializes an `ExportData` with the RAW data and the extension.
+      def initialize(data, extension)
+        @data = data
+        @extension = extension
+      end
+
+      # Gives back the raw data of the export.
+      #
+      # Returns a String with the result of the export.
+      def read
+        @data
+      end
+    end
+  end
+end

data/lib/decidim/exporters/exporter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Decidim
+  module Exporters
+    # Abstract class providing the interface and partial implementation
+    # of an exporter. See `Decidim::Exporters::JSON` and `Decidim::Exporters::CSV`
+    # for a reference implementation.
+    class Exporter
+      # Public: Initializes an Exporter.
+      #
+      # collection - An Array with the collection to be exported.
+      # serializer - A Serializer to be used during the export.
+      def initialize(collection, serializer)
+        @collection = collection
+        @serializer = serializer
+      end
+
+      # Public: Should generate an `ExportData` with the result of the export.
+      # Responsibility of the subclass.
+      def export
+        raise NotImplementedError
+      end
+
+      private
+
+      attr_reader :collection, :serializer
+    end
+  end
+end

data/lib/decidim/exporters/json.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require "json"
+
+module Decidim
+  module Exporters
+    # Exports a JSON version of a provided hash, given a collection and a
+    # Serializer.
+    class JSON < Exporter
+      # Public: Generates a JSON representation of a collection and a
+      # Serializer.
+      #
+      # Returns an ExportData with the export.
+      def export
+        data = ::JSON.pretty_generate(@collection.map do |resource|
+          @serializer.new(resource).serialize
+        end)
+
+        ExportData.new(data, "json")
+      end
+    end
+  end
+end

data/lib/decidim/feature_manifest.rb

@@ -135,5 +135,23 @@ module Decidim
     def resource_manifests
       @resource_manifests ||= []
     end
+
+    # Public: Stores an instance of StatsRegistry
+    def stats
+      @stats ||= StatsRegistry.new
+    end
+
+    # Public: Registers a stat inside a feature manifest.
+    #
+    # name - The name of the stat
+    # options - A hash of options
+    #         * primary: Wether the stat is primary or not.
+    #         * priority: The priority of the stat used for render issues.
+    # block - A block that receive the features to filter out the stat.
+    #
+    # Returns nothing.
+    def register_stat(name, options = {}, &block)
+      stats.register(name, options, &block)
+    end
   end
 end