decidim-core 0.14.4 → 0.15.0

data/lib/decidim/gamification/badge.rb

@@ -16,6 +16,9 @@ module Decidim
       # 10 points to get to level 3.
       attribute :levels, Array, default: []
 
+      # An array of types for which this badge is valid for.
+      attribute :valid_for, Array[Symbol], default: [:user]
+
       # (Optional) you can set a lambda in order to be able to reset the score of a
       # badge if the progress gets lost somehow. The lambda receives a user as an
       # argument.
@@ -43,12 +46,43 @@ module Decidim
         levels.length
       end
 
+      def translated_name
+        I18n.t "name", scope: translation_scope
+      end
+
+      def description(organization_name = nil)
+        I18n.t("description", organization_name: organization_name, scope: translation_scope)
+      end
+
+      def conditions
+        I18n.t("conditions", scope: translation_scope)
+      end
+
+      def score_descriptions(score)
+        {
+          unearned_own: I18n.t("unearned_own", scope: translation_scope),
+          description_own: I18n.t("description_own", score: score, scope: translation_scope),
+          unearned_another: I18n.t("unearned_another", scope: translation_scope),
+          description_another: I18n.t("description_another", score: score, scope: translation_scope)
+        }
+      end
+
       # Public: Returns an image for this badge.
       #
       # Returns a String with the image.
       def image
         ActionController::Base.helpers.asset_path("decidim/gamification/badges/#{name}.svg")
       end
+
+      def valid_for?(model)
+        valid_for.include?(model.class.name.demodulize.underscore.to_sym)
+      end
+
+      private
+
+      def translation_scope
+        "decidim.gamification.badges.#{name}"
+      end
     end
   end
 end

data/lib/decidim/gamification/badge_scorer.rb

@@ -2,20 +2,22 @@
 
 module Decidim
   module Gamification
-    # This class is responsible of updating scores given a user and a badge. Will
+    # This class is responsible of updating scores given a model and a badge. Will
     # also trigger any side-effects such as notifications.
     class BadgeScorer
       # Public: Initializes the class.
       #
-      # user  - The user for which to update scores.
+      # model  - The model for which to update scores.
       # badge - The `Badge` to update.
       #
-      def initialize(user, badge)
-        @user = user
+      def initialize(model, badge)
+        raise "Invalid badge for this UserBase type" unless badge.valid_for?(model)
+
+        @model = model
         @badge = badge
       end
 
-      # Public: Increments the score for the user and badge.
+      # Public: Increments the score for the model and badge.
       #
       # amount - Amount to increment. Defaults to 1.
       #
@@ -25,13 +27,13 @@ module Decidim
 
         with_level_tracking do
           BadgeScore.find_or_create_by(
-            user: @user,
+            user: @model,
             badge_name: @badge.name
           ).increment(:value, amount).save!
         end
       end
 
-      # Public: Decrements the score for the user and badge.
+      # Public: Decrements the score for the model and badge.
       #
       # amount - Amount to decrement. Defaults to 1.
       #
@@ -41,7 +43,7 @@ module Decidim
 
         with_level_tracking do
           badge_score = BadgeScore.find_by(
-            user: @user,
+            user: @model,
             badge_name: @badge.name
           )
 
@@ -53,7 +55,7 @@ module Decidim
         end
       end
 
-      # Public: Sets the score for the user and badge.
+      # Public: Sets the score for the model and badge.
       #
       # score - Score to set.
       #
@@ -63,7 +65,7 @@ module Decidim
 
         with_level_tracking do
           BadgeScore.find_or_create_by(
-            user_id: @user.id,
+            user_id: @model.id,
             badge_name: @badge.name
           ).update!(value: score)
         end
@@ -75,17 +77,18 @@ module Decidim
       class InvalidAmountException < StandardError; end
 
       def with_level_tracking
-        previous_level = BadgeStatus.new(@user, @badge).level
+        previous_level = BadgeStatus.new(@model, @badge).level
 
         yield
 
-        current_status = BadgeStatus.new(@user, @badge)
+        current_status = BadgeStatus.new(@model, @badge)
         send_notification(previous_level, current_status.level)
         current_status
       end
 
       def send_notification(previous_level, current_level)
         return unless current_level > previous_level
+        return unless badges_enabled?
 
         if previous_level.zero?
           publish_event(name: "decidim.events.gamification.badge_earned",
@@ -104,8 +107,8 @@ module Decidim
         Decidim::EventsManager.publish(
           event: name,
           event_class: klass,
-          resource: @user,
-          recipient_ids: [@user.id],
+          resource: @model,
+          recipient_ids: recipients,
           extra: {
             badge_name: @badge.name.to_s,
             previous_level: previous_level,
@@ -113,6 +116,18 @@ module Decidim
           }
         )
       end
+
+      def badges_enabled?
+        @model.organization.badges_enabled?
+      end
+
+      def recipients
+        if @model.is_a?(User)
+          [@model.id]
+        elsif @model.is_a?(UserGroup)
+          @model.users.pluck(:id)
+        end
+      end
     end
   end
 end

data/lib/decidim/gamification/badge_status.rb

@@ -5,6 +5,8 @@ module Decidim
     # This class is responsible to figure out the status of a user regarding
     # a certain badge.
     class BadgeStatus
+      attr_reader :badge
+
       # Public: Initializes the `BadgeStatus`.
       #
       # user  - The user of whom to check the status.

data/lib/decidim/hashtaggable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Decidim
-  # This concern contains the logic related to followable resources.
+  # This concern contains the logic related to hashtaggable resources.
   module Hashtaggable
     extend ActiveSupport::Concern
 

data/lib/decidim/manifest_registry.rb

@@ -21,10 +21,12 @@ module Decidim
     end
 
     def find(name)
+      name = name.to_s
       manifests.find do |manifest|
-        manifest.try(:model_class_name) == name.to_s ||
-          manifest.name.to_s == name.to_s ||
-          manifest.name.to_s.pluralize == name.to_s
+        manifest_name = manifest.name.to_s
+        manifest_name == name ||
+          manifest.try(:model_class_name) == name ||
+          manifest_name.pluralize == name
       end
     end
 

data/lib/decidim/metric_manifest.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class acts as a manifest for metrics.
+  #
+  # This manifest is a simple object that holds and stores currently available
+  # metrics and his managers, for calculations purpose
+  #
+  class MetricManifest
+    include ActiveModel::Model
+    include Virtus.model
+
+    attribute :metric_name, String
+    attribute :manager_class, String
+    attribute :highlighted, String
+    attribute :position, Integer
+
+    validates :metric_name, :manager_class, presence: true
+  end
+end

data/lib/decidim/metric_registry.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class acts as a registry for metrics. Each metric needs a name
+  # and a manager class, that will be used for calculations
+  #
+  # In order to register a metric, you can follow this example:
+  #
+  #     Decidim.metrics_registry.register(
+  #       :users_metric,
+  #       "Decidim::Metrics::UsersMetricManage"
+  #     )
+  #
+  # Metrics need to be registered in the `engine.rb` file of each module
+  class MetricRegistry
+    HIGHLIGHTED = "highlighted"
+    NOT_HIGHLIGHTED = "not-highlighted"
+    # Public: Registers a metric for calculations
+    #
+    # metric_name - a symbol representing the name of the metric
+    #
+    # manager_class - Manager class for specific metric calculation
+    #
+    # highlighted - value referencing if it's a highluithgted metric, or not
+    #
+    # Returns nothing. Raises an error if there's already a metric
+    # registered with that metric name.
+    def register(metric_name, manager_class, highlighted = NOT_HIGHLIGHTED, position = nil)
+      metric_name = metric_name.to_s
+      metric_exists = self.for(metric_name).present?
+      position ||= all.size + 1
+
+      if metric_exists
+        raise(
+          MetricAlreadyRegistered,
+          "There's a metric already registered with the name `:#{metric_name}`, must be unique"
+        )
+      end
+
+      metric_manifest = MetricManifest.new(metric_name: metric_name, manager_class: manager_class, highlighted: highlighted, position: position)
+
+      metric_manifest.validate!
+
+      metrics_manifests << metric_manifest
+    end
+
+    def for(metric_name)
+      all.find { |manifest| manifest.metric_name == metric_name }
+    end
+
+    def all
+      metrics_manifests
+    end
+
+    def highlighted
+      all.find_all { |manifest| manifest.highlighted == HIGHLIGHTED }.sort_by(&:position)
+    end
+
+    def not_highlighted
+      all.find_all { |manifest| manifest.highlighted == NOT_HIGHLIGHTED }.sort_by(&:position)
+    end
+
+    class MetricAlreadyRegistered < StandardError; end
+
+    private
+
+    def metrics_manifests
+      @metrics_manifests ||= []
+    end
+  end
+end

data/lib/decidim/participable.rb

@@ -9,7 +9,7 @@ module Decidim
 
     included do
       def demodulized_name
-        self.class.name.demodulize
+        @demodulized_name ||= self.class.name.demodulize
       end
 
       delegate :foreign_key, to: :demodulized_name

data/lib/decidim/participatory_space_resourceable.rb

@@ -51,7 +51,6 @@ module Decidim
       def participatory_space_sibling_scope(participatory_space_name)
         manifest = Decidim.find_participatory_space_manifest(participatory_space_name)
         return self.class.none unless manifest
-
         scope = manifest.participatory_spaces.call(organization)
 
         scope

data/lib/decidim/query_extensions.rb

@@ -75,6 +75,25 @@ module Decidim
           Decidim::HashtagsResolver.new(ctx[:current_organization], args[:name]).hashtags
         }
       end
+
+      type.field :metrics do
+        type types[Decidim::Core::MetricType]
+        argument :names, types[types.String], "The names of the metrics you want to retrieve"
+
+        resolve lambda { |_, args, ctx|
+                  manifests = if args[:names].blank?
+                                Decidim.metrics_registry.all
+                              else
+                                Decidim.metrics_registry.all.select do |manifest|
+                                  args[:names].include?(manifest.metric_name.to_s)
+                                end
+                              end
+
+                  manifests.map do |manifest|
+                    Decidim::Core::MetricResolver.new(manifest.metric_name, ctx[:current_organization])
+                  end
+                }
+      end
     end
   end
 end

data/lib/decidim/resourceable.rb

@@ -72,6 +72,7 @@ module Decidim
               to_id: resource.id
             }
             event_name = "decidim.resourceable.#{link_name}.created"
+
             ActiveSupport::Notifications.instrument event_name, this: payload do
               Decidim::ResourceLink.create!(
                 from: self,

data/lib/decidim/searchable.rb

@@ -94,7 +94,8 @@ module Decidim
           decidim_participatory_space_id: fields[:decidim_participatory_space_id],
           decidim_participatory_space_type: fields[:decidim_participatory_space_type],
           decidim_organization_id: fields[:decidim_organization_id],
-          resource: self
+          resource_id: id,
+          resource_type: self.class.name
         }
       end
     end

data/lib/tasks/decidim_metrics_tasks.rake

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+namespace :decidim do
+  namespace :metrics do
+    # All ------
+    #
+    # Get all metrics entities and execute his own rake task.
+    # It admits a date-string parameter, in a 'YYYY-MM-DD' format from
+    # today to all past dates
+    desc "Execute all metrics calculation methods"
+    task :all, [:day] => :environment do |_task, args|
+      Decidim::Organization.find_each do |organization|
+        Decidim.metrics_registry.all.each do |metric_manifest|
+          call_metric_job(metric_manifest, organization, args.day)
+        end
+      end
+    end
+
+    # One ------
+    #
+    # Execute metric calculations for just one metric
+    # It need a metric name and permits a date-string parameter, in a 'YYYY-MM-DD' format from
+    # today to all past dates
+    desc "Execute one metric calculation method"
+    task :one, [:metric, :day] => :environment do |_task, args|
+      next if args.metric.blank?
+      Decidim::Organization.find_each do |organization|
+        metric_manifest = Decidim.metrics_registry.for(args.metric)
+        call_metric_job(metric_manifest, organization, args.day)
+      end
+    end
+
+    def call_metric_job(metric_manifest, organization, day = nil)
+      Decidim::MetricJob.perform_later(
+        metric_manifest.manager_class,
+        organization.id,
+        day
+      )
+    end
+  end
+end

data/lib/tasks/decidim_tasks.rake

@@ -14,6 +14,7 @@ namespace :decidim do
       decidim_blogs
       decidim_budgets
       decidim_comments
+      decidim_conferences
       decidim_consultations
       decidim_debates
       decidim_initiatives

data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.ca.js

@@ -11,7 +11,6 @@
 		monthsShort: ["Gen", "Feb", "Mar", "Abr", "Mai", "Jun", "Jul", "Ago", "Set", "Oct", "Nov", "Des"],
 		today: "Avui",
 		clear: "Esborrar",
-		weekStart: 1,
-		format: "dd/mm/yyyy"
+		weekStart: 1
 	};
 }(jQuery));

data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.es.js

@@ -10,7 +10,6 @@
 		months: ["Enero", "Febrero", "Marzo", "Abril", "Mayo", "Junio", "Julio", "Agosto", "Septiembre", "Octubre", "Noviembre", "Diciembre"],
 		monthsShort: ["Ene", "Feb", "Mar", "Abr", "May", "Jun", "Jul", "Ago", "Sep", "Oct", "Nov", "Dic"],
 		today: "Hoy",
-    weekStart: 1,
-    format: "dd/mm/yyyy"
+    weekStart: 1
   };
 }(jQuery));

data/vendor/assets/javascripts/datepicker-locales/foundation-datepicker.fr.js

@@ -11,7 +11,6 @@
 		monthsShort: ["Jan", "Fev", "Mar", "Avr", "Mai", "Jui", "Jul", "Aou", "Sep", "Oct", "Nov", "Dec"],
 		today: "Aujourd'hui",
 		clear: "Effacer",
-		weekStart: 1,
-		format: "dd/mm/yyyy"
+		weekStart: 1
 	};
 }(jQuery));