decidim-core 0.12.0.pre → 0.12.0

data/lib/decidim/searchable.rb

@@ -18,11 +18,16 @@ module Decidim
 
     included do
       has_many :searchable_resources, class_name: "Decidim::SearchableResource", inverse_of: :resource, foreign_key: :resource_id, dependent: :destroy
-      after_create :add_to_index_as_search_resource
-      after_update :update_index_for_search_resource
+      # after_create and after_update callbacks are dynamically setted in `searchable_fields` method.
 
-      # Public: after_create callback to index the model as a SearchableResource.
+      # Public: after_create callback to index the model as a SearchableResource, if configured so.
       #
+      def try_add_to_index_as_search_resource
+        return unless self.class.search_resource_fields_mapper.index_on_create?(self)
+        add_to_index_as_search_resource
+      end
+
+      # Forces the model to be indexed for the first time.
       def add_to_index_as_search_resource
         fields = self.class.search_resource_fields_mapper.mapped(self)
         fields[:i18n].keys.each do |locale|
@@ -32,10 +37,18 @@ module Decidim
 
       # Public: after_update callback to update index information of the model.
       #
-      def update_index_for_search_resource
-        fields = self.class.search_resource_fields_mapper.mapped(self)
-        searchable_resources.each do |sr|
-          sr.update(contents_to_searchable_resource_attributes(fields, sr.locale))
+      def try_update_index_for_search_resource
+        if self.class.search_resource_fields_mapper.index_on_update?(self)
+          if searchable_resources.empty?
+            add_to_index_as_search_resource
+          else
+            fields = self.class.search_resource_fields_mapper.mapped(self)
+            searchable_resources.each do |sr|
+              sr.update(contents_to_searchable_resource_attributes(fields, sr.locale))
+            end
+          end
+        elsif searchable_resources.any?
+          searchable_resources.clear
         end
       end
 
@@ -66,8 +79,8 @@ module Decidim
         @search_resource_indexable_fields
       end
 
-      # Declares the searchable fields for this instance.
-      # Must be a Hash that follow the following format:
+      # Declares the searchable fields for this instance and, optionally, some conditions.
+      # `declared_fields` must be a Hash that follow the following format:
       # {
       #   scope_id: { scope: :id },
       #   participatory_space: { feature: :participatory_space },
@@ -76,9 +89,23 @@ module Decidim
       #   C: :somehow_relevant_field,
       #   D: [:description, :address]
       # }
-      def searchable_fields(declared_fields)
+      #
+      # `conditions` must be a Hash that only accepts a boolean or a Proc that will be evaluated on runtime and returns a boolean for the following keys:
+      # - index_on_create: Whether to index, or not, the current searchabe when it is created. Defaults to true.
+      # - index_on_update: Whether to index, or not, the current searchabe when it is updated. Defaults to true.
+      #
+      def searchable_fields(declared_fields, conditions = {})
         @search_resource_indexable_fields = SearchResourceFieldsMapper.new(declared_fields)
         Decidim::Searchable.searchable_resources[name] = self unless Decidim::Searchable.searchable_resources.has_key?(name)
+        conditions = { index_on_create: true, index_on_update: true }.merge(conditions)
+        if conditions[:index_on_create]
+          after_create :try_add_to_index_as_search_resource
+          @search_resource_indexable_fields.set_index_condition(:create, conditions[:index_on_create])
+        end
+        if conditions[:index_on_update]
+          after_update :try_update_index_for_search_resource
+          @search_resource_indexable_fields.set_index_condition(:update, conditions[:index_on_update])
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-core
 version: !ruby/object:Gem::Version
-  version: 0.12.0.pre
+  version: 0.12.0
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-06 00:00:00.000000000 Z
+date: 2018-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_link_to
@@ -242,6 +242,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: loofah
   requirement: !ruby/object:Gem::Requirement
@@ -594,28 +608,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0.pre
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0.pre
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: decidim-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0.pre
+        version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0.pre
+        version: 0.12.0
 description: Adds core features so other engines can hook into the framework.
 email:
 - josepjaume@gmail.com
@@ -1186,6 +1200,7 @@ files:
 - config/initializers/rack_attack.rb
 - config/locales/ca.yml
 - config/locales/en.yml
+- config/locales/es-PY.yml
 - config/locales/es.yml
 - config/locales/eu.yml
 - config/locales/fi.yml
@@ -1298,6 +1313,7 @@ files:
 - db/migrate/20180323102631_change_event_name_and_class_to_rename_to_publish_proposal_event.rb
 - db/migrate/20180508111640_add_tos_version_to_organization.rb
 - db/migrate/20180508111710_add_accepted_tos_version_field_to_users.rb
+- db/migrate/20180613080638_rename_missing_features_to_components.rb
 - db/seeds.rb
 - db/seeds/homepage_image.jpg
 - lib/decidim/api/attachable_interface.rb
@@ -1465,9 +1481,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6