decidim-sortitions 0.9.0 → 0.11.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0201c8215bdeaa94eb0432c3d45c2c7aba8e14cf97d6c4c95828b95b67174b8a
-  data.tar.gz: f404e63fccf8f883a2e4fef1bde10f0a2361e86b7602c0390f848bc33fbea0e4
+  metadata.gz: 24db428f20272b36ec8566a34250338db326a1031dd8e0d221a70ab549e9699a
+  data.tar.gz: 826a675e56d01daec292af92d75d5cc77d54f7bd84bf684aac7e489e22e5ba69
 SHA512:
-  metadata.gz: ce85cd7cc7a571f14e912c9b317122bafbb215c74ee9d7ba6aeee8118b11434f37c83ff1f93bc7eeb96b169a26a847effc80451d9ec51cfc231608a69f669adb
-  data.tar.gz: 5495ab01398af063aa02623e578c831359efa846a548458784631abe05f65fcf44d96065c29a8421656f1fed9d7b4f5fd1aed71950e2fa445ea13fd7780bfc43
+  metadata.gz: 2b5e4f34fccfe94473cf0af575d50f2e39e96ae384162af82293d95a1aed5d55754dc6c187ccc35f1bc2bd7db86a7b163cc1683457a53e9ef97110c936dd98fe
+  data.tar.gz: e721500c11fe706d9c755272bddfdf77602b682dfef72039fc7ee0eae1c347f1a874ff6666556757f306cafe9bc8310ddf4424ea22c5e7842f0ec7d98311525d

data/README.md

@@ -1,10 +1,13 @@
 # Decidim::Sortitions
-This module makes possible to select amont a set of proposal by sortition.
+
+This module makes possible to select among a set of proposals by sortition.
 
 ## Usage
+
 Simply include it in your Decidim instance.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -12,13 +15,9 @@ gem 'decidim-sortitions'
 ```
 
 And then execute:
-```bash
-$ bundle
-```
 
-Or install it yourself as:
 ```bash
-$ gem install decidim-sortitions
+bundle
 ```
 
 ## Import migrations
@@ -26,6 +25,14 @@ $ gem install decidim-sortitions
 After installing the gem you must import and execute the migrations bundled with the gem:
 
 ```bash
-$ bundle exec rails decidim_sortitions:install:migrations
-$ bundle exec rails db:migrate
+bundle exec rails decidim_sortitions:install:migrations
+bundle exec rails db:migrate
 ```
+
+## Contributing
+
+See [Decidim](https://github.com/decidim/decidim).
+
+## License
+
+See [Decidim](https://github.com/decidim/decidim).

data/app/assets/config/decidim_sortitions_manifest.css

@@ -1 +1 @@
-/*= link decidim/sortitions/social_share.css.scss */
+/* = link decidim/sortitions/social_share.css.scss */

data/app/assets/stylesheets/decidim/sortitions/_sortitions.scss

@@ -1,41 +1,45 @@
-#sortition-details {
+#sortition-details{
   margin-bottom: 1.5rem;
 }
 
-.sortition-details {
+.sortition-details{
   padding: 0;
   display: flex;
-  flex-direction: row;
-  flex-wrap: wrap;
+  flex-flow: row wrap;
   justify-content: flex-start;
   align-items: stretch;
   align-content: stretch;
 
-  .sortition-details-item {
+  .sortition-details-item{
     width: 33.3%;
+
     @include breakpoint(large down){
       width: 33.3%;
     }
+
     @include breakpoint(medium down){
       width: 49.9%;
     }
+
     @include breakpoint(smallmedium down){
       width: 100%;
     }
+
     display: inline-block;
     padding: 1em;
     border: $border;
     background: $white;
-    .sortition-details-title {
-      margin-right: 0.5rem;
+
+    .sortition-details-title{
+      margin-right: .5rem;
       font-weight: bolder;
     }
 
     .sortition-details-text{
       text-transform: uppercase;
-      letter-spacing: 0.03em;
+      letter-spacing: .03em;
       font-size: 90%;
-      color: #3D393C;
+      color: #3d393c;
       font-weight: 600;
       line-height: 1;
       vertical-align: middle;

data/app/assets/stylesheets/decidim/sortitions/social_share.css.scss

@@ -1,15 +1,19 @@
-/*= require social-share-button */
+/*
+ *= require social-share-button
+ */
+
 $size: 45px;
 
-.share-link:hover {
+.share-link:hover{
   text-decoration: underline;
   cursor: pointer;
 }
 
-.social-share-button {
+.social-share-button{
   display: inline-block;
   vertical-align: top;
-  .ssb-icon {
+
+  .ssb-icon{
     margin-right: 5px;
     background-size: $size $size;
     height: $size;

data/app/commands/decidim/sortitions/admin/create_sortition.rb

@@ -36,10 +36,12 @@ module Decidim
         attr_reader :form
 
         def create_sortition
-          Sortition.create!(
-            feature: form.current_feature,
+          Decidim.traceability.create!(
+            Sortition,
+            form.current_user,
+            component: form.current_component,
             title: form.title,
-            decidim_proposals_feature_id: form.decidim_proposals_feature_id,
+            decidim_proposals_component_id: form.decidim_proposals_component_id,
             request_timestamp: Time.now.utc,
             author: form.current_user,
             dice: form.dice,

data/app/commands/decidim/sortitions/admin/destroy_sortition.rb

@@ -29,11 +29,17 @@ module Decidim
         attr_reader :form
 
         def destroy_sortition
-          sortition.update(
-            cancel_reason: form.cancel_reason,
-            cancelled_on: Time.now.utc,
-            cancelled_by_user: form.current_user
-          )
+          Decidim.traceability.perform_action!(
+            :delete,
+            sortition,
+            form.current_user
+          ) do
+            sortition.update(
+              cancel_reason: form.cancel_reason,
+              cancelled_on: Time.now.utc,
+              cancelled_by_user: form.current_user
+            )
+          end
         end
 
         def sortition

data/app/commands/decidim/sortitions/admin/update_sortition.rb

@@ -30,7 +30,9 @@ module Decidim
         attr_reader :form
 
         def update_sortition
-          sortition.update(
+          Decidim.traceability.update!(
+            sortition,
+            form.current_user,
             title: form.title,
             additional_info: form.additional_info
           )

data/app/controllers/decidim/sortitions/admin/application_controller.rb

@@ -6,14 +6,14 @@ module Decidim
       # This controller is the abstract class from which all other controllers of
       # this engine inherit.
       #
-      # Note that it inherits from `Decidim::Features::BaseController`, which
+      # Note that it inherits from `Decidim::Components::BaseController`, which
       # override its layout and provide all kinds of useful methods.
-      class ApplicationController < Decidim::Admin::Features::BaseController
+      class ApplicationController < Decidim::Admin::Components::BaseController
         helper_method :sortitions, :sortition
 
         def sortitions
           @sortitions ||= Decidim::Sortitions::FilteredSortitions
-                          .for(current_feature)
+                          .for(current_component)
                           .order(created_at: :desc)
                           .page(params[:page])
                           .per(Decidim::Sortitions.items_per_page)

data/app/controllers/decidim/sortitions/admin/sortitions_controller.rb

@@ -6,7 +6,7 @@ module Decidim
       # Controller responsible of the sortition that selects proposals from
       # a participatory space.
       class SortitionsController < Admin::ApplicationController
-        helper_method :proposal_features
+        helper_method :proposal_components
 
         def index; end
 
@@ -91,8 +91,8 @@ module Decidim
           form(DestroySortitionForm)
         end
 
-        def proposal_features
-          ParticipatorySpaceProposalFeatures.for(current_participatory_space)
+        def proposal_components
+          ParticipatorySpaceProposalComponents.for(current_participatory_space)
         end
 
         def ability_context

data/app/controllers/decidim/sortitions/application_controller.rb

@@ -5,9 +5,9 @@ module Decidim
     # This controller is the abstract class from which all other controllers of
     # this engine inherit.
     #
-    # Note that it inherits from `Decidim::Features::BaseController`, which
+    # Note that it inherits from `Decidim::Components::BaseController`, which
     # override its layout and provide all kinds of useful methods.
-    class ApplicationController < Decidim::Features::BaseController
+    class ApplicationController < Decidim::Components::BaseController
     end
   end
 end

data/app/controllers/decidim/sortitions/sortition_widgets_controller.rb

@@ -9,7 +9,7 @@ module Decidim
       private
 
       def model
-        @model ||= Sortition.where(feature: params[:feature_id]).find(params[:sortition_id])
+        @model ||= Sortition.where(component: params[:component_id]).find(params[:sortition_id])
       end
 
       def iframe_url

data/app/forms/decidim/sortitions/admin/destroy_sortition_form.rb

@@ -13,7 +13,7 @@ module Decidim
         validates :cancel_reason, translatable_presence: true
 
         delegate :current_participatory_space, to: :context
-        delegate :current_feature, to: :context
+        delegate :current_component, to: :context
       end
     end
   end

data/app/forms/decidim/sortitions/admin/edit_sortition_form.rb

@@ -15,7 +15,7 @@ module Decidim
         validates :additional_info, translatable_presence: true
 
         delegate :current_participatory_space, to: :context
-        delegate :current_feature, to: :context
+        delegate :current_component, to: :context
       end
     end
   end

data/app/forms/decidim/sortitions/admin/sortition_form.rb

@@ -9,7 +9,7 @@ module Decidim
         mimic :sortition
 
         translatable_attribute :title, String
-        attribute :decidim_proposals_feature_id, Integer
+        attribute :decidim_proposals_component_id, Integer
         attribute :decidim_category_id, Integer
         attribute :dice, Integer
         attribute :target_items, Integer
@@ -17,7 +17,7 @@ module Decidim
         translatable_attribute :additional_info, String
 
         validates :title, translatable_presence: true
-        validates :decidim_proposals_feature_id, presence: true
+        validates :decidim_proposals_component_id, presence: true
         validates :witnesses, translatable_presence: true
         validates :additional_info, translatable_presence: true
         validates :dice,
@@ -37,7 +37,7 @@ module Decidim
 
         delegate :categories, to: :current_participatory_space
         delegate :current_participatory_space, to: :context
-        delegate :current_feature, to: :context
+        delegate :current_component, to: :context
       end
     end
   end

data/app/helpers/decidim/sortitions/admin/sortitions_helper.rb

@@ -6,9 +6,9 @@ module Decidim
       module SortitionsHelper
         include Decidim::TranslationsHelper
 
-        # Converst a list of features into a list of selectable options
-        def features_options(features)
-          features.map do |f|
+        # Converst a list of components into a list of selectable options
+        def components_options(components)
+          components.map do |f|
             [translated_attribute(f.name), f.id]
           end
         end

data/app/helpers/decidim/sortitions/sortitions_helper.rb

@@ -6,7 +6,7 @@ module Decidim
       include Decidim::TranslationsHelper
 
       def proposal_path(proposal)
-        EngineRouter.main_proxy(proposal.feature).proposal_path(proposal)
+        EngineRouter.main_proxy(proposal.component).proposal_path(proposal)
       end
 
       # Generates the sortition category label

data/app/models/decidim/sortitions/sortition.rb

@@ -7,15 +7,17 @@ module Decidim
       include Decidim::Resourceable
       include Decidim::HasCategory
       include Decidim::Authorable
-      include Decidim::HasFeature
+      include Decidim::HasComponent
       include Decidim::HasReference
+      include Decidim::Traceable
+      include Decidim::Loggable
       include Decidim::Comments::Commentable
 
-      feature_manifest_name "sortitions"
+      component_manifest_name "sortitions"
 
-      belongs_to :decidim_proposals_feature,
-                 foreign_key: "decidim_proposals_feature_id",
-                 class_name: "Decidim::Feature"
+      belongs_to :decidim_proposals_component,
+                 foreign_key: "decidim_proposals_component_id",
+                 class_name: "Decidim::Component"
 
       belongs_to :cancelled_by_user,
                  foreign_key: "cancelled_by_user_id",
@@ -30,13 +32,17 @@ module Decidim
       scope :active, -> { where(cancelled_on: nil) }
       scope :cancelled, -> { where.not(cancelled_on: nil) }
 
+      def self.log_presenter_class_for(_log)
+        Decidim::Sortitions::AdminLog::SortitionPresenter
+      end
+
       def proposals
         Decidim::Proposals::Proposal.where(id: selected_proposals)
       end
 
       def similar_count
-        Sortition.where(feature: feature)
-                 .where(decidim_proposals_feature: decidim_proposals_feature)
+        Sortition.where(component: component)
+                 .where(decidim_proposals_component: decidim_proposals_component)
                  .categorized_as(category&.id)
                  .where(target_items: target_items)
                  .count
@@ -52,7 +58,7 @@ module Decidim
 
       # Public: Overrides the `commentable?` Commentable concern method.
       def commentable?
-        feature.settings.comments_enabled?
+        component.settings.comments_enabled?
       end
 
       # Public: Overrides the `accepts_new_comments?` Commentable concern method.

data/app/presenters/decidim/sortitions/admin_log/sortition_presenter.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    module AdminLog
+      # This class holds the logic to present a `Decidim::Sortitions::Sortition`
+      # for the `AdminLog` log.
+      #
+      # Usage should be automatic and you shouldn't need to call this class
+      # directly, but here's an example:
+      #
+      #    action_log = Decidim::ActionLog.last
+      #    view_helpers # => this comes from the views
+      #    SortitionPresenter.new(action_log, view_helpers).present
+      class SortitionPresenter < Decidim::Log::BasePresenter
+        private
+
+        def action_string
+          case action
+          when "create", "delete", "update"
+            "decidim.sortitions.admin_log.sortition.#{action}"
+          else
+            super
+          end
+        end
+
+        def diff_fields_mapping
+          {
+            cancel_reason: :i18n,
+            dice: :integer,
+            request_timestamp: :date,
+            witnesses: :i18n,
+            additional_info: :i18n,
+            title: :i18n,
+            reference: :string,
+            decidim_proposals_component_id: :component
+          }
+        end
+
+        def i18n_labels_scope
+          "activemodel.attributes.sortition"
+        end
+
+        def has_diff?
+          action == "delete" || super
+        end
+      end
+    end
+  end
+end

data/app/queries/decidim/sortitions/admin/{participatory_space_proposal_features.rb → participatory_space_proposal_components.rb}

@@ -3,11 +3,11 @@
 module Decidim
   module Sortitions
     module Admin
-      # Query that retrieves a list of proposal features
-      class ParticipatorySpaceProposalFeatures < Rectify::Query
+      # Query that retrieves a list of proposal components
+      class ParticipatorySpaceProposalComponents < Rectify::Query
         attr_reader :participatory_space
 
-        # Sugar syntax. Allow retrieving all proposal features for the
+        # Sugar syntax. Allow retrieving all proposal components for the
         # given participatory space.
         def self.for(participatory_space)
           new(participatory_space).query
@@ -19,7 +19,7 @@ module Decidim
         end
 
         def query
-          Feature
+          Component
             .where(participatory_space: participatory_space, manifest_name: "proposals")
             .published
         end