decidim-core 0.12.2 → 0.13.0.pre1

data/db/migrate/20171212103803_create_unique_nicknames.rb

@@ -11,7 +11,7 @@ class CreateUniqueNicknames < ActiveRecord::Migration[5.1]
     add_column :decidim_users, :nickname, :string, limit: 20
 
     User.where.not(name: nil).find_each do |user|
-      user.update!(nickname: User.nicknamize(user.name))
+      user.update!(nickname: User.nicknamize(user.name, decidim_organization_id: user.decidim_organization_id))
     end
 
     add_index :decidim_users,

data/db/migrate/20180221101934_fix_nickname_index.rb

@@ -3,13 +3,15 @@
 class FixNicknameIndex < ActiveRecord::Migration[5.1]
   class User < ApplicationRecord
     self.table_name = :decidim_users
+
+    include Decidim::Nicknamizable
   end
 
   def change
     User.where(nickname: nil)
         .where(deleted_at: nil)
         .where(managed: false)
-        .find_each { |u| u.update(nickname: User.nicknamize(u.name)) }
+        .find_each { |u| u.update(nickname: User.nicknamize(u.name, decidim_organization_id: u.decidim_organization_id)) }
 
     # rubocop:disable Rails/SkipsModelValidations
     User.where(nickname: nil).update_all("nickname = ''")

data/db/migrate/20180427141253_create_coauthorships.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateCoauthorships < ActiveRecord::Migration[5.1]
+  def change
+    create_table :decidim_coauthorships do |t|
+      t.references :decidim_author, null: false, index: { name: "index_author_on_coauthorsihp" }
+      t.references :decidim_user_group, index: { name: "index_user_group_on_coauthorsihp" }
+      t.references :coauthorable, polymorphic: true, index: { name: "index_coauthorable_on_coauthorship" }
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180611121852_change_newsletter_notification_type_value.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class ChangeNewsletterNotificationTypeValue < ActiveRecord::Migration[5.2]
+  class User < ApplicationRecord
+    self.table_name = :decidim_users
+  end
+
+  def up
+    add_column :decidim_users, :newsletter_token, :string, default: ""
+    add_column :decidim_users, :newsletter_notifications_at, :datetime
+    User.where(newsletter_notifications: true).update(newsletter_notifications_at: Time.zone.parse("2018-05-24 00:00 +02:00"))
+    remove_column :decidim_users, :newsletter_notifications
+  end
+
+  def down
+    add_column :decidim_users, :newsletter_notifications, :boolean
+    User.where.not(newsletter_notifications_at: nil).update(newsletter_notifications: true)
+    remove_column :decidim_users, :newsletter_notifications_at
+    remove_column :decidim_users, :newsletter_token
+  end
+end

data/lib/decidim/api/authorable_interface.rb

@@ -7,7 +7,16 @@ module Decidim
       name "AuthorableInterface"
       description "An interface that can be used in authorable objects."
 
-      field :author, !Decidim::Core::AuthorInterface, "The comment's author", property: :normalized_author
+      field :author, !Decidim::Core::AuthorInterface, "The comment's author" do
+        # can be an Authorable or a Coauthorable
+        resolve ->(authorable, _, _) {
+          if authorable.respond_to?(:normalized_author)
+            authorable&.normalized_author
+          elsif authorable.respond_to?(:creator_identity)
+            authorable&.creator_identity
+          end
+        }
+      end
     end
   end
 end

data/lib/decidim/authorable.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 module Decidim
-  # This concern contains the logic related to authorship
+  # This concern contains the logic related to single authorship.
+  #
+  # Sometimes authorship may belong to a single user or be shared among coauthors, in
+  # this latest case the Coauthorable concern should be used instead of Authorable.
   module Authorable
     extend ActiveSupport::Concern
 

data/lib/decidim/coauthorable.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This concern contains the logic related to collective or shared authorship.
+  #
+  # Coauthorable shares nearly the same object interface as Authorable but with some differences.
+  # - `authored_by?(user)` is exactly the same
+  # - `normalized_author` is now `identities`.
+  #
+  # All coauthors, including the initial author, will share the same permissions.
+  module Coauthorable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :coauthorships, -> { order(:created_at) }, as: :coauthorable, class_name: "Decidim::Coauthorship", dependent: :destroy
+      has_many :authors, -> { order(:created_at) }, through: :coauthorships, class_name: "Decidim::User"
+      has_many :user_groups, -> { order(:created_at) }, as: :coauthorable, class_name: "Decidim::UserGroup", through: :coauthorships
+
+      # retrieves models from all identities of the user.
+      scope :from_all_user_identities, ->(user) { joins(:coauthorships).where("decidim_coauthorships.decidim_author_id": user.id) }
+      # retrieves models from the given User, ignoring the UserGroups it belongs to.
+      scope :from_author, ->(author) { joins(:coauthorships).where("decidim_coauthorships.decidim_author_id": author.id).where("decidim_coauthorships.decidim_user_group_id": nil) }
+      # retrieves models from the given UserGroup.
+      scope :from_user_group, ->(user_group) { joins(:coauthorships).where("decidim_coauthorships.decidim_user_group_id": user_group.id) }
+
+      # Checks whether the user is author of the given proposal, either directly
+      # authoring it or via a user group.
+      #
+      # user - the user to check for authorship
+      def authored_by?(user)
+        coauthorships.where(author: user).exists?
+      end
+
+      # Returns the identities for the authors, whether they are user groups or users.
+      #
+      # Returns an Array of User and/or UserGroups.
+      def identities
+        coauthorships.order(:created_at).collect(&:identity)
+      end
+
+      # Syntactic sugar to access first coauthor as a Coauthorship.
+      def creator
+        coauthorships.first
+      end
+
+      # Syntactic sugar to access first coauthor Author
+      def creator_author
+        authors.first
+      end
+
+      # Syntactic sugar to access first identity whether it is a User or a UserGroup.
+      # @return The User od UserGroup that created this Coauthorable.
+      def creator_identity
+        coauthorships.order(:created_at).first&.identity
+      end
+
+      # Adds a new coauthor to the list of coauthors. The coauthorship is created with
+      # current object as coauthorable and `user` param as author. To set the user group
+      # use `extra_attrs` either with `user_group` or `decidim_user_group_id` keys.
+      #
+      # @param user: The new coauthor.
+      # @extra_attrs: Extra
+      def add_coauthor(user, extra_attrs = {})
+        attrs = { coauthorable: self, author: user }
+        Decidim::Coauthorship.create!(attrs.merge(extra_attrs))
+      end
+    end
+  end
+end

data/lib/decidim/component_manifest.rb

@@ -21,6 +21,10 @@ module Decidim
 
     attribute :query_type, String, default: "Decidim::Core::ComponentType"
 
+    # An array with the name of the classes that will be exported with
+    # the data portability feature for this component. For example, `Decidim::<MyModule>::<MyClass>``
+    attribute :data_portable_entities, Array, default: []
+
     # A path with the `scss` stylesheet this engine provides. It is used to
     # mix this engine's stylesheets with the main app's stylesheets so it can
     # use the scss variables and mixins provided by Decidim::Core.

data/lib/decidim/core.rb

@@ -18,6 +18,7 @@ module Decidim
   autoload :Loggable, "decidim/loggable"
   autoload :Reportable, "decidim/reportable"
   autoload :Authorable, "decidim/authorable"
+  autoload :Coauthorable, "decidim/coauthorable"
   autoload :Participable, "decidim/participable"
   autoload :Publicable, "decidim/publicable"
   autoload :Scopable, "decidim/scopable"
@@ -57,6 +58,10 @@ module Decidim
   autoload :ViewModel, "decidim/view_model"
   autoload :FingerprintCalculator, "decidim/fingerprint_calculator"
   autoload :Fingerprintable, "decidim/fingerprintable"
+  autoload :DataPortability, "decidim/data_portability"
+  autoload :DataPortabilitySerializers, "decidim/data_portability_serializers"
+  autoload :DataPortabilityFileReader, "decidim/data_portability_file_reader"
+  autoload :DataPortabilityFileZipper, "decidim/data_portability_file_zipper"
 
   include ActiveSupport::Configurable
 
@@ -176,6 +181,11 @@ module Decidim
     true
   end
 
+  # Time that data portability files are available in server
+  config_accessor :data_portability_expiry_time do
+    7.days
+  end
+
   # Max requests in a time period to prevent DoS attacks. Only applied on production.
   config_accessor :throttling_max_requests do
     100

data/lib/decidim/core/engine.rb

@@ -40,6 +40,7 @@ require "cells-erb"
 require "kaminari"
 require "doorkeeper"
 require "doorkeeper-i18n"
+require "nobspw"
 require "kaminari"
 
 require "decidim/api"
@@ -167,6 +168,10 @@ module Decidim
                       position: 1.3
           end
 
+          menu.item t("my_data", scope: "layouts.decidim.user_profile"),
+                    decidim.data_portability_path,
+                    position: 1.4
+
           menu.item t("delete_my_account", scope: "layouts.decidim.user_profile"),
                     decidim.delete_account_path,
                     position: 999,

data/lib/decidim/core/test.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "decidim/core/test/shared_examples/authorable"
+require "decidim/core/test/shared_examples/coauthorable"
 require "decidim/core/test/shared_examples/publicable"
 require "decidim/core/test/shared_examples/localised_email"
 require "decidim/core/test/shared_examples/has_attachments"

data/lib/decidim/core/test/factories.rb

@@ -82,7 +82,7 @@ FactoryBot.define do
   factory :user, class: "Decidim::User" do
     email { generate(:email) }
     password "password1234"
-    password_confirmation "password1234"
+    password_confirmation { password }
     name { generate(:name) }
     nickname { generate(:nickname) }
     organization
@@ -289,6 +289,14 @@ FactoryBot.define do
     organization
   end
 
+  factory :coauthorship, class: "Decidim::Coauthorship" do
+    coauthorable { create(:dummy_resource) }
+    transient do
+      organization { coauthorable.component.participatory_space.organization }
+    end
+    author { create(:user, :confirmed, organization: organization) }
+  end
+
   factory :dummy_resource, class: "Decidim::DummyResources::DummyResource" do
     title { generate(:name) }
     component { create(:component, manifest_name: "dummy") }

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

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+shared_examples_for "coauthorable" do
+  describe "authorable interface" do
+    let!(:creator_author) { coauthorable.authors.first }
+    let(:other_authors) { create_list(:user, 5, organization: coauthorable.component.participatory_space.organization) }
+    let(:other_user_groups) { create_list(:user_group, 5, :verified, organization: creator_author.organization, users: [creator_author]) }
+
+    describe "authors" do
+      context "when there is one author" do
+        it "returns the only coauthor" do
+          expect(coauthorable.authors).to eq([creator_author])
+        end
+      end
+
+      context "when there are many authors" do
+        before { coauthorable.authors = other_authors }
+
+        it "returns all coauthors" do
+          expect(coauthorable.authors).to eq(other_authors)
+        end
+      end
+    end
+
+    describe "user_groups" do
+      let(:user_group) do
+        create(:user_group,
+               :verified,
+               organization: creator_author.organization,
+               users: [creator_author])
+      end
+
+      context "when there is NO user_group" do
+        it "returns empty array" do
+          expect(coauthorable.user_groups).to eq([])
+        end
+      end
+
+      context "when there is one user_group" do
+        before do
+          coauthorship = coauthorable.coauthorships.first
+          coauthorship.user_group = user_group
+          coauthorship.save
+        end
+
+        it "returns the only user_group" do
+          expect(coauthorable.user_groups).to eq([user_group])
+        end
+      end
+
+      context "when there are many user_groups" do
+        before do
+          coauthorable.coauthorships.clear
+          other_user_groups.each do |ug|
+            Decidim::Coauthorship.create(author: ug.memberships.first.user, user_group: ug, coauthorable: coauthorable)
+          end
+        end
+
+        it "returns all user_groups" do
+          expect(coauthorable.user_groups).to eq(other_user_groups)
+        end
+      end
+    end
+
+    describe "authored by? user" do
+      context "when there are no coauthors" do
+        before { coauthorable.authors.clear }
+
+        it "returns false" do
+          expect(coauthorable.authored_by?(creator_author)).to be(false)
+        end
+      end
+      context "when the checked user is one of the coauthors" do
+        before do
+          other_authors.each { |author| coauthorable.authors << author }
+        end
+
+        it "returns true" do
+          expect(coauthorable.authored_by?(creator_author)).to be(true)
+        end
+      end
+
+      context "when the checked user is one of the coauthors user_groups"
+    end
+
+    describe "identities" do
+      context "when there are no coauthors" do
+        before { coauthorable.authors.clear }
+
+        it "returns an empty list" do
+        end
+      end
+      context "when there are many coauthors of both types" do
+        before do
+          other_authors.each { |author| coauthorable.authors << author }
+          other_user_groups.each do |user_group|
+            Decidim::Coauthorship.create(author: user_group.memberships.first.user, user_group: user_group, coauthorable: coauthorable)
+          end
+        end
+        it "returns an array of identities" do
+          identities = [creator_author]
+          identities += other_authors
+          identities += other_user_groups
+          expect(coauthorable.identities.to_a).to eq(identities)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+shared_examples_for "coauthorable interface" do
+  describe "author" do
+    let(:author) { model.creator_author }
+
+    describe "with a regular user" do
+      let(:query) { "{ author { name } }" }
+
+      it "includes the user's ID" do
+        expect(response["author"]["name"]).to eq(author.name)
+      end
+    end
+
+    describe "with a user group" do
+      let(:user_group) { create(:user_group, :verified, organization: model.participatory_space.organization, users: [author]) }
+      let(:query) { "{ author { name } }" }
+
+      before do
+        coauthorship = model.coauthorships.first
+        coauthorship.update!(user_group: user_group)
+      end
+
+      it "includes the user's ID" do
+        expect(response["author"]["name"]).to eq(user_group.name)
+      end
+    end
+  end
+end

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

@@ -28,7 +28,13 @@ shared_context "when a simple event" do
   let(:participatory_space_title) { participatory_space.title["en"] }
   let(:participatory_space_path) { Decidim::ResourceLocatorPresenter.new(participatory_space).path }
   let(:participatory_space_url) { Decidim::ResourceLocatorPresenter.new(participatory_space).url }
-  let(:author) { resource.author }
+  let(:author) do
+    if resource.respond_to?(:creator_author)
+      resource.creator_author
+    else
+      resource.author
+    end
+  end
   let(:author_presenter) { Decidim::UserPresenter.new(author) }
   let(:i18n_scope) { event_name }
 end

data/lib/decidim/core/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-core version.
   module Core
     def self.version
-      "0.12.2"
+      "0.13.0.pre1"
     end
   end
 end

data/lib/decidim/data_portability.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  # This concern contains the logic related to data portability.
+  module DataPortability
+    extend ActiveSupport::Concern
+
+    included do
+      # Returns a collection scoped by user.
+      # This is the default, if you want, you can overwrite in each Class to be export.
+      def self.user_collection(user)
+        where(decidim_author_id: user.id)
+      end
+
+      # Returns a Default export serializer
+      def self.export_serializer
+        Decidim::Exporters::Serializer
+      end
+
+      # Returns a collection of images scoped by User.
+      # Returns nil for default.
+      def self.data_portability_images(_user)
+        nil
+      end
+    end
+  end
+end