decidim-core 0.9.3 → 0.10.0

data/app/presenters/decidim/log/diff_presenter.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Log
+    # This class holds the logic to present the diff for any activity log.
+    # The data needed for this class to work should be sent by
+    # `Decidim::Log::BasePresenter` or any of its children.
+    #
+    # In order to be able to use your own class to present a diff, you'll need to
+    # overwrite `BasePresenter#diff_presenter` to return your custom diff presenter.
+    # The only requirement for custom renderers is that they should respond to `present`.
+    class DiffPresenter
+      # Public: Initializes the presenter.
+      #
+      # changeset - An array of hashes
+      # view_helpers - An object holding the view helpers at the render time.
+      #   Most probably should come automatically from the views.
+      # options - a Hash with options
+      def initialize(changeset, view_helpers, options = {})
+        @changeset = changeset
+        @view_helpers = view_helpers
+        @options = { show_previous_value?: true }.merge(options)
+      end
+
+      # Public: Renders the given diff.
+      #
+      # Returns an HTML-safe String.
+      def present
+        present_diff
+      end
+
+      private
+
+      attr_reader :changeset, :view_helpers, :options
+      alias h view_helpers
+
+      # Private: Presents the diff for this action. If the resource and the
+      # version are found in the database, it displays all changes.
+      #
+      # Returns an HTML-safe String.
+      def present_diff
+        return "".html_safe if changeset.blank?
+
+        h.content_tag(:div, class: "logs__log__diff") do
+          changeset.each do |attribute|
+            h.concat(present_new_value(attribute[:label], attribute[:new_value], attribute[:type]))
+            h.concat(present_previous_value(attribute[:previous_value], attribute[:type])) if options[:show_previous_value?]
+          end
+        end
+      end
+
+      # Private: Helper method to render the previous value.
+      #
+      # value - the value for the given attribute
+      # type - A symbol or String representing the type of the value.
+      #   If it's a String, it should be the name of the presenter that will
+      #   be in charge of presenting it.
+      #
+      # Returns an HTML-safe String.
+      def present_previous_value(value, type)
+        h.content_tag(:div, class: "logs__log__diff-row logs__log__diff-row--previous-value") do
+          h.concat(h.content_tag(:div, "before", class: "logs__log__diff-title"))
+          h.concat(h.content_tag(:div, present_value(value, type), class: "logs__log__diff-value"))
+        end
+      end
+
+      # Private: Helper method to render the new value.
+      #
+      # label - the label name
+      # value - the value for the given label
+      # type - A symbol or String representing the type of the value.
+      #   If it's a String, it should be the name of the presenter that will
+      #   be in charge of presenting it.
+      #
+      # Returns an HTML-safe String.
+      def present_new_value(label, value, type)
+        h.content_tag(:div, class: "logs__log__diff-row logs__log__diff-row--new-value") do
+          h.concat(h.content_tag(:div, label, class: "logs__log__diff-title"))
+          h.concat(h.content_tag(:div, present_value(value, type), class: "logs__log__diff-value"))
+        end
+      end
+
+      # Private: Presents the value with the its type presenter.
+      #
+      # value - the value to be presented, no specific type.
+      # type - A symbol or String representing the type of the value.
+      #   If it's a String, it should be the name of the presenter that will
+      #   be in charge of presenting it.
+      #
+      # Returns an HTML-safe String.
+      def present_value(value, type)
+        presenter_klass_for(type).new(value, view_helpers).present
+      end
+
+      # Private: Finds the presenter class for the given type.
+      #
+      # type - A symbol or String representing the type of the value.
+      #   If it's a String, it should be the name of the presenter that will
+      #   be in charge of presenting it.
+      #
+      # Returns a Class.
+      def presenter_klass_for(type)
+        default_klass = Decidim::Log::ValueTypes::DefaultPresenter
+        klass = ""
+
+        if type.is_a?(Symbol)
+          klass = "Decidim::Log::ValueTypes::#{type.to_s.camelize}Presenter"
+        elsif type.is_a?(String)
+          klass = type
+        end
+
+        begin
+          return klass.constantize
+        rescue NameError => _exception
+          default_klass
+        end
+      end
+    end
+  end
+end

data/app/presenters/decidim/log/resource_presenter.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Log
+    # This class holds the logic to present the resource for any activity log.
+    # The data needed for this class to work should be sent by
+    # `Decidim::Log::BasePresenter` or any of its children.
+    #
+    # In order to be able to use your own class to present a resource, you'll need to
+    # overwrite `BasePresenter#resource_presenter` to return your custom resource presenter.
+    # The only requirement for custom renderers is that they should respond to `present`.
+    class ResourcePresenter
+      # Public: Initializes the presenter.
+      #
+      # resource - An instance of a model that can be located by
+      #   `Decidim::ResourceLocatorPresenter`
+      # view_helpers - An object holding the view helpers at the render time.
+      #   Most probably should come automatically from the views.
+      # extra -  a Hash with extra data, most likely coming from the
+      #   `action_log` being presented
+      def initialize(resource, view_helpers, extra)
+        @resource = resource
+        @view_helpers = view_helpers
+        @extra = extra
+      end
+
+      # Public: Renders the given resource.
+      #
+      # Returns an HTML-safe String.
+      def present
+        present_resource
+      end
+
+      private
+
+      attr_reader :resource, :view_helpers, :extra
+      alias h view_helpers
+
+      # Private: Presents the resource of the action. If the resource and the
+      # space are found in the database, it links to it. Otherwise it only
+      # shows the resource name.
+      #
+      # Returns an HTML-safe String.
+      def present_resource
+        span = h.content_tag(:span, present_resource_name, class: "logs__log__resource")
+        return span if resource.blank? || resource_path.blank?
+
+        h.link_to(present_resource_name, resource_path, class: "logs__log__resource")
+      end
+
+      # Private: Finds the public link for the given resource.
+      #
+      # Returns an HTML-safe String. If the resource space is not
+      # present, it returns `nil`.
+      def resource_path
+        @resource_path ||= begin
+                             Decidim::ResourceLocatorPresenter.new(resource).path
+                           rescue NoMethodError
+                             nil
+                           end
+      end
+
+      # Private: Presents resource name.
+      #
+      # Returns an HTML-safe String.
+      def present_resource_name
+        h.translated_attribute extra["title"]
+      end
+    end
+  end
+end

data/app/presenters/decidim/log/space_presenter.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Log
+    # This class holds the logic to present the space of the resource of any
+    # activity log. The data needed for this class to work should be sent by
+    # `Decidim::Log::BasePresenter` or any of its children.
+    #
+    # In order to be able to use your own class to present a space, you'll need to
+    # overwrite `BasePresenter#space_presenter` to return your custom space presenter.
+    # The only requirement for custom renderers is that they should respond to `present`.
+    class SpacePresenter
+      # Public: Initializes the presenter.
+      #
+      # space - An instance of a model implementing the Decidim::Participable concern
+      # view_helpers - An object holding the view helpers at the render time.
+      #   Most probably should come automatically from the views.
+      # extra -  a Hash with extra data, most likely coming from the
+      #   `action_log` being presented
+      def initialize(space, view_helpers, extra)
+        @space = space
+        @view_helpers = view_helpers
+        @extra = extra
+      end
+
+      # Public: Renders the given space.
+      #
+      # Returns an HTML-safe String.
+      def present
+        present_space
+      end
+
+      private
+
+      attr_reader :space, :view_helpers, :extra
+      alias h view_helpers
+
+      # Private: Presents a space. If the space is found in the database, it
+      # links to it. Otherwise it only shows the name.
+      #
+      # Returns an HTML-safe String.
+      def present_space
+        return h.content_tag(:span, present_space_name, class: "logs__log__space") if space.blank?
+
+        h.link_to(present_space_name, space_path, class: "logs__log__space")
+      end
+
+      # Private: Finds the link for the given space.
+      #
+      # Returns an HTML-safe String.
+      def space_path
+        Decidim::ResourceLocatorPresenter.new(space).path
+      end
+
+      # Private: Presents the space name.
+      #
+      # Returns an HTML-safe String.
+      def present_space_name
+        h.translated_attribute extra["title"]
+      end
+    end
+  end
+end

data/app/presenters/decidim/log/user_presenter.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Log
+    # This class holds the logic to present the author for any activity log.
+    # The data needed for this class to work should be sent by
+    # `Decidim::Log::BasePresenter` or any of its children.
+    #
+    # In order to be able to use your own class to present a user, you'll need to
+    # overwrite `BasePresenter#user_presenter` to return your custom user presenter.
+    # The only requirement for custom renderers is that they should respond to `present`.
+    class UserPresenter
+      # Public: Initializes the presenter.
+      #
+      # user - An instance of Decidim::User
+      # view_helpers - An object holding the view helpers at the render time.
+      #   Most probably should come automatically from the views.
+      # extra -  a Hash with extra data, most likely coming from the
+      #   `action_log` being presented
+      def initialize(user, view_helpers, extra)
+        @user = user
+        @view_helpers = view_helpers
+        @extra = extra
+      end
+
+      # Public: Renders the resource associated to the given `action_log`.
+      #
+      # action_log - An instance of Decidim::ActionLog.last
+      # view_helpers - An object holding the view helpers at the render time.
+      #   Most probably should come automatically from the views.
+      #
+      # Returns an HTML-safe String.
+      def present
+        present_user
+      end
+
+      private
+
+      attr_reader :user, :view_helpers, :extra
+      alias h view_helpers
+
+      # Private: Presents the given user. If the user is found in the database, it
+      # links to their profile, and shows their nickname as a tooltip.
+      # Otherwise it only shows the name.
+      #
+      # Returns an HTML-safe String.
+      def present_user
+        return h.content_tag(:span, present_user_name, class: "logs__log__author") if user.blank?
+
+        h.link_to(
+          present_user_name,
+          user_path,
+          class: "logs__log__author",
+          title: "@" + user.nickname,
+          data: {
+            tooltip: true,
+            "disable-hover": false
+          }
+        )
+      end
+
+      # Private: Presents the name of the user performing the action.
+      #
+      # Returns an HTML-safe String.
+      def present_user_name
+        extra["name"].html_safe
+      end
+
+      # Private: Presents the nickname of the user performing the action.
+      #
+      # Returns an HTML-safe String.
+      def present_user_nickname
+        extra["nickname"].html_safe
+      end
+
+      # Private: Calculates the path for the user. Returns the path of the
+      # user profile. It's a public link.
+      #
+      # Returns an HTML-safe String.
+      def user_path
+        h.decidim.profile_path(present_user_nickname)
+      end
+    end
+  end
+end

data/app/presenters/decidim/log/value_types/area_presenter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Log
+    module ValueTypes
+      # This class presents the given value as a Decidim::Area. Check
+      # the `DefaultPresenter` for more info on how value
+      # presenters work.
+      class AreaPresenter < DefaultPresenter
+        # Public: Presents the value as a Decidim::Area. If the area can
+        # be found, it shows its title. Otherwise it shows its ID.
+        #
+        # Returns an HTML-safe String.
+        def present
+          return unless value
+          return h.translated_attribute(area.name) if area
+          I18n.t("not_found", id: value, scope: "decidim.log.value_types.area_presenter")
+        end
+
+        private
+
+        def area
+          @area ||= Decidim::Area.where(id: value).first
+        end
+      end
+    end
+  end
+end

data/app/presenters/decidim/log/value_types/date_presenter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Log
+    module ValueTypes
+      # This class presents the given value as a date. Check
+      # the `DefaultPresenter` for more info on how value
+      # presenters work.
+      class DatePresenter < DefaultPresenter
+        # Public: Presents the value as a date.
+        #
+        # Returns an HTML-safe String.
+        def present
+          return unless value
+          h.l(value, format: :long)
+        end
+      end
+    end
+  end
+end

data/app/presenters/decidim/log/value_types/default_presenter.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Log
+    module ValueTypes
+      # This class is used as a base for other value presenters,
+      # and as a default presenter when the presenter for the
+      # given value is not specified or is not found.
+      #
+      # Value presenters are dynamically found from the value type
+      # set in the `fields_mapping` method in the resource presenter.
+      # If the value is a symbol, the system will try to infer the
+      # correct presenter and use it. If it's a String, it will treat
+      # it as a class name, and will try to fetch that presenter.
+      # If the system fails in either case, it will use the `DefaultPresenter`.
+      #
+      # Check the other presenters in this folder for more examples.
+      class DefaultPresenter
+        # value - the vakue to render, can be of any type.
+        # view_helpers - an object encapsulating all the view helpers,
+        #   it will most likely come from the top of the chain.
+        def initialize(value, view_helpers)
+          @value = value
+          @view_helpers = view_helpers
+        end
+
+        # Public: Presents the value in a specific format. In this method
+        # you can use any view helper you need, but it's important to return
+        # an HTML-safe String.
+        #
+        # Returns an HTML-safe String.
+        def present
+          value
+        end
+
+        private
+
+        attr_reader :value, :view_helpers
+        alias h view_helpers
+      end
+    end
+  end
+end

data/app/presenters/decidim/log/value_types/locale_presenter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Log
+    module ValueTypes
+      # This class presents the given value as a locale. Check
+      # the `DefaultPresenter` for more info on how value
+      # presenters work.
+      class LocalePresenter < DefaultPresenter
+        # Public: Presents the value as a locale.
+        #
+        # Returns an HTML-safe String.
+        def present
+          return unless value
+          I18n.with_locale(value) { I18n.t("locale.name") }
+        end
+      end
+    end
+  end
+end