klastera 1.2.2 → 1.2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ca95ff5ffe21289a12131f7090036072103e196af1d81f9110c7896d705f837
-  data.tar.gz: c026cb690ec0fdbad89237a64e837b74e5112c50b4339dc78e3bdce03dfd84d5
+  metadata.gz: 8780a6928f5249deb34be42cac1f52a226113865b9f29ddb12e1a36f018141ed
+  data.tar.gz: 1d99b709cea49a08533192ad8a1df621d78ea4d4ee59e1c266f06e952e6d8063
 SHA512:
-  metadata.gz: 1f71455ad531a02b1f46672644f8d77aa98a4c842121de8fa1539e26920690d103e997a22470ea5dfa0efdbce6a970a89a824324343b87d90546aa4ad3653e5b
-  data.tar.gz: 1d5962c2c598cc389c67306fcd8bbf10ca7577c07bc89795daf98d774537bac01ddcdbd366c2478a4cfc0ea3b3b9082dd1c20edcf0e58e481d7461b92c71c372
+  metadata.gz: 62c72441e00d9edb6c17525453cde71d864389c9342dbe54df3538609814aef0cdcbc3f7c49f49134d526e2da1f99ff1cc258b750cd024a7031afd3a80977d2d
+  data.tar.gz: 806978a3fae34b0a2ddda331ce37b90de2e66f9c77bd707859b721ac7c83980f706b5eb432a00875db8b26b4c8901b11307ef62ab063952d013eef30eca69772

data/app/models/klastera/concerns/clusterizable.rb

@@ -9,9 +9,10 @@ module Klastera::Concerns::Clusterizable
 
     validates :cluster_id, presence: true, if: proc { self.try(:cluster_id) && self.organization.required_suborganization_mode? }
     validate :at_least_one_cluster_entity, if: proc { self.organization.required_suborganization_mode? }
+    validate :uniqueness_of_cluster_entity_record
 
     scope :related_clusters, ->() {
-      includes(:cluster_entities).where("cluster_entities.entity_id = #{self.table_name}.id")
+      joins(:cluster_entities).where("cluster_entities.entity_id = #{self.table_name}.id")
     }
 
     def at_least_one_cluster_entity
@@ -20,8 +21,15 @@ module Klastera::Concerns::Clusterizable
       end
     end
 
+    ##
+     # This is a legacy method and we don't recommend using it.
+     # Implement directly Klastera.entity_clusters_string_list instead of this method.
+     # TODO: In order to deprecate it, you will need to perform some changes in the main app
+     ##
     def clusters_string_separated_by(separator,attribute=:name)
-      self.cluster_entities.map{|ce|ce.cluster.send(attribute)}.join(separator)
+      Klastera.entity_clusters_string_list!(
+        self.cluster_entities, separator, attribute
+      )
     end
 
     def has_one_cluster_entity
@@ -29,6 +37,12 @@ module Klastera::Concerns::Clusterizable
         return errors.add(:cluster_entities, I18n.t('klastera.messages.has_one_cluster_entity'))
       end
     end
+
+    def uniqueness_of_cluster_entity_record
+      if cluster_entities.map(&:cluster_id).uniq.size != cluster_entities.size
+        return errors.add(:cluster_entities, I18n.t('klastera.messages.duplicated_cluster_entity') )
+      end
+    end
   end
   
   module ClassMethods

data/app/views/layouts/klastera/_cluster_entity_fields.html.erb

@@ -1,6 +1,6 @@
 <tr class="nested-fields">
   <td class="field">
-    <%= f.select :cluster_id, cluster_clusters.map{|c|[c.name,c.id]}, { include_blank: true }, { class: 'form-control' } %>
+    <%= f.select :cluster_id, @cluster_clusters.map{|c|[c.name,c.id]}, { include_blank: true }, { class: 'form-control' } %>
   </td>
   <td class="action vertical-align-middle text-center" width="44">
     <%= link_to_remove_association f, class: 'btn btn-danger btn-xs text-danger' do %>

data/app/views/layouts/klastera/_nested_cluster_entity.html.erb

@@ -1,4 +1,5 @@
 <% if cluster_organization.is_in_cluster_mode? %>
+  <% @cluster_clusters = cluster_clusters %>
   <div class="col-xs-12">
     <% if hide_title||=false %>
       <div class="form-group file required <%=f.object.class.name.parameterize%>_cluster_entity<%=' has-error' if f.object.errors.has_key?(:cluster_entities)%>">
@@ -26,6 +27,7 @@
           <table id="cluster-entities" class="table table-striped">
             <tbody class="cluster-entity-rows">
               <%= f.fields_for :cluster_entities do |cluster_entity|%>
+                <% next unless @cluster_clusters.map(&:id).include?(cluster_entity.try(:object).try(:cluster_id)) %>
                 <%= render 'layouts/klastera/cluster_entity_fields', f: cluster_entity %>
               <% end %>
             </body>

data/config/locales/es.yml

@@ -61,6 +61,7 @@ es:
       at_least_one_cluster_entity: Debe agregar al menos un cluster
       record_action_successfully: Registro %{a} exitosamente
       cant_delete_the_last_record_in_required_suborganization_mode: No se puede eliminar el único cluster de esta organización
+      duplicated_cluster_entity: Hay un cluster duplicado
       new_cluster_id:
         nil: Cluster no existe
         same: Cluster no puede ser el mismo

data/lib/klastera.rb

@@ -5,6 +5,12 @@ module Klastera
 
   extend ActiveSupport::Concern
 
+  KLSTR_HELPERS = %i[
+    cluster_user cluster_organization user_has_more_than_one_cluster
+    cluster_scope cluster_clusters cluster_scope_filtered clusters_from
+    user_clusters_string_list set_collection_before_group_by_entity
+  ]
+
   class << self
 
     def set_cluster_entities_attributes!(entity,array_cluster_ids)
@@ -30,13 +36,15 @@ module Klastera
     end
 
     #
-    # I like to wrap methods
+    # In cases you don't have the active_record_collection object to filter, this method helps you
+    # calling cluster_scope! before and pass the collction to filter_clusterized_collection_with!,
+    # but at the end of the day, I just like to wrap methods.
     #
-    def cluster_scope_filtered!(scope,cluster_id,user,organization,includes=[])
+    def cluster_scope_filtered!(scope,cluster_id,user,organization)
       self.filter_clusterized_collection_with!(
-        organization,
         cluster_id,
-        self.cluster_scope!(user,organization,scope,includes)
+        self.cluster_scope!(scope,user,organization),
+        organization
       )
     end
 
@@ -44,74 +52,88 @@ module Klastera
     # In order to this works, active_record_collection argument
     # should be passed through cluster_scope! method before.
     #
-    def filter_clusterized_collection_with!(cluster_organization,cluster_id,active_record_collection)
+    def filter_clusterized_collection_with!(cluster_id,active_record_collection,cluster_organization)
       if cluster_organization.is_in_cluster_mode?
+
+        # IMPORTANT
+        # The next block was commented on because cluster_scope! method is not returning
+        # the cluster_entities within the scope anymore and it doesn't make any sense trying
+        # to filter based on force/use/show logic. Nevertheless, someday we will need it again.
+
+        # # If cluster_id is nil we will try to filter including unclustered entities active_record_collection wsas
+        # unless cluster_id.present?
+        #   # Based on force/use/show definition we don't really need this validation. A force cluster organization won't return an entity that 
+        #   # doesn't belong to a cluster. Nevertheless we don't know if active_record_collection argument is fully definition-compliant.
+        #   if cluster_organization.optional_suborganization_mode?
+        #     cluster_array << nil
+        #   end
+        # end
+
         if cluster_id.present?
-          cluster_array = [cluster_id]
-          # Based on force/use/show definition we don't really need this validation.
-          # A force cluster organization won't return an entity out of a cluster, but
-          # we don't know if the clusterized entities are fully definition-compliant.
-          cluster_array << nil if cluster_organization.optional_suborganization_mode?
+          cluster_array = [cluster_id] unless cluster_id.is_a?(Array)
+          # The ActiveRecordCollection argument should have previously eager-loaded the cluster entities, thus the join statement is unnecessary.
           active_record_collection = active_record_collection.joins(:cluster_entities).where("cluster_entities.cluster_id": cluster_array)
         end
-        # you may use a block only with clusterizable data
+
+        # You should use a block with clusterable data only
         yield(active_record_collection) if block_given?
       end
       active_record_collection
     end
 
-    #
-    #
-    #
-    def set_collection_before_group_by_entity!(cluster_organization,active_record_collection,model_class,entity_params)
+    ##
+     #
+     #
+     ##
+    def set_collection_before_group_by_entity!(active_record_collection,entity_params,cluster_organization)
       entity_params_keys = [:entity_name,:entity_attribute,:entity_id,:entity_id_attribute,:unamed]
+      entity_params[:entity_id] ||= nil #Ensures the entity_id attribute presence even if there is no filter
       entity_params = entity_params.slice(*entity_params_keys).values
-      if model_class.try(:reflections).try(:keys).try(:include?,entity_params[0])
+      model_class = active_record_collection.model.base_class
+      model_relations = model_class.reflections.keys
+      if model_relations.include?(entity_params[0])
         entity_params << "#{entity_params[0]}_id".to_sym
         if entity_params[0] == 'cluster'
           entity_params << :unclustered if cluster_organization.is_in_cluster_mode?
           active_record_collection = Klastera.filter_clusterized_collection_with!(
-            cluster_organization,
             entity_params[2],
-            active_record_collection
+            active_record_collection,
+            cluster_organization
           )
         end
-        yield(
-          active_record_collection,
-          entity_params_keys.zip(entity_params).to_h)
+        yield( active_record_collection, entity_params_keys.zip(entity_params).to_h )
       end
     end
 
     ##
      # Returns a ::Cluster::ActiveRecord_Relation from a given scope
      #
-    def clusters_from!(user,organization,scope,includes=[])
-      cluster_scope!(user,organization,scope,includes).related_clusters
+    def clusters_from!(scope,user,organization)
+      cluster_scope!(scope,user,organization).related_clusters
     end
 
     ##
      # Returns a scope filtered by clusters or its
      # organization if the cluster mode is not active.
      #
-    def cluster_scope!(user,organization,scope,includes=[])
+    def cluster_scope!(scope,user,organization)
       scope_klass = scope_class(scope).where(organization_id: organization)
       session_clusters(user,organization) do |clusters|
         if organization.is_in_cluster_mode?
           scope_klass = scope_klass.select("DISTINCT ON (#{scope.table_name}.id) #{scope.table_name}.id, #{scope.table_name}.*")
-          scope_klass = scope_klass.includes(includes) if includes.present?
           cluster_ids = clusters.map(&:id)
           if organization.required_suborganization_mode?
             scope_klass = scope_klass.joins(:cluster_entities).where( cluster_entities: { cluster_id: cluster_ids } )
           else
+            or_these_cluster_ids = cluster_ids.present? ? " OR cluster_entities.cluster_id IN (#{cluster_ids.join(",")})" : ""
             scope_klass = scope_klass.joins("
               LEFT OUTER JOIN cluster_entities
-                ON cluster_entities.cluster_id IN (#{cluster_ids.join(",")})
-                AND entity_id = #{scope.table_name}.id 
+                ON entity_id = #{scope.table_name}.id
                 AND entity_type = '#{scope}'
-            ")
+            ").where("cluster_entities.id IS NULL#{or_these_cluster_ids}")
           end
           # Provisional fix to avoid SQL clashes due to DISTINCT ON clause
-          scope_klass = scope_class(scope).where(organization_id: organization).where(id: scope_klass.map(&:id))
+          scope_klass = scope_class(scope).eager_load(:cluster_entities).where(id: scope_klass.map(&:id), organization_id: organization)
         end
       end
       scope_klass
@@ -143,38 +165,42 @@ module Klastera
       end
       clusters
     end
-  end
 
-  included do
-    if respond_to?(:helper_method)
-      helper_method :cluster_scope
-      helper_method :user_cluster
-      helper_method :cluster_user
-      helper_method :cluster_organization
-      helper_method :cluster_clusters
-      helper_method :cluster_scope_filtered
-      helper_method :user_has_more_than_one_cluster
-      helper_method :clusters_from
+    ##
+     # Return a string with cluster attribute separated by separator argument
+     # A array of cluster ids can be passed fo filter the result
+     #
+    def entity_clusters_string_list!(cluster_entities,separator,attribute=:name,allowed_cluster_ids=nil)
+      _cluster_entities = cluster_entities.reject(&:nil?)
+      if allowed_cluster_ids.is_a?(Array)
+        _cluster_entities.select!{|ce| allowed_cluster_ids.include?(ce.cluster_id)}
+      end
+      _cluster_entities.map do |ce|
+        ce.cluster.try(attribute)
+      end.compact.join(separator)
     end
-    if respond_to?(:hide_action)
-      hide_action :cluster_scope
-      hide_action :cluster_scope=
-      hide_action :user_cluster
-      hide_action :user_cluster=
-      hide_action :cluster_user
-      hide_action :cluster_user=
-      hide_action :cluster_organization
-      hide_action :cluster_organization=
-      hide_action :cluster_clusters
-      hide_action :cluster_clusters=
-      hide_action :cluster_scope_filtered
-      hide_action :cluster_scope_filtered=
-      hide_action :user_has_more_than_one_cluster
-      hide_action :user_has_more_than_one_cluster=
-      hide_action :clusters_from
-      hide_action :clusters_from=
+
+    ##
+     # cluster_clusters needs the logged user and its organization
+     # that why, we perfomed this logic here
+     #
+    def user_clusters_string_list!(user,organization,cluster_entities,separator,attribute=:name)
+      @_session_clusters ||= self.session_clusters(user,organization)
+      self.entity_clusters_string_list!(cluster_entities, separator, attribute, @_session_clusters.map(&:id))
     end
-    before_action :set_the_lonely_cluster, only: %i[ create update ]
+  end
+
+  def cluster_user
+    current_user
+  end
+
+  def cluster_organization
+    current_organization
+  end
+
+  def user_has_more_than_one_cluster
+    @cluster_clusters ||= cluster_clusters
+    @cluster_clusters.size > 1
   end
 
   def set_the_lonely_cluster
@@ -186,52 +212,69 @@ module Klastera
     end
   end
 
-  def cluster_scope(scope,includes=[])
-    Klastera.cluster_scope!(cluster_user,cluster_organization,scope,includes)
+  def set_cluster_filter
+    @filter = ::ClusterFilter.new(cluster_filter_params)
+  end
+
+  def cluster_filter_params
+    parameters = params.require(:cluster_filter) rescue nil
+    return {} if parameters.blank?
+    parameters.permit(*cluster_filter_permit_params)
   end
 
-  def cluster_user
-    current_user
+  def cluster_filter_permit_params
+    [ :cluster_id ].concat( ::ClusterFilter.attributes )
   end
 
-  def cluster_organization
-    current_organization
+  def filter_clusterized_collection_with(cluster_id,active_record_collection)
+    Klastera.filter_clusterized_collection_with!(cluster_id,active_record_collection,cluster_organization)
+  end
+
+  def cluster_scope(scope)
+    Klastera.cluster_scope!(scope,cluster_user,cluster_organization)
   end
 
   def cluster_clusters
     Klastera.session_clusters(cluster_user,cluster_organization)
   end
 
-  def cluster_scope_filtered(scope,cluster_id,includes=[])
+  def cluster_scope_filtered(scope,cluster_id)
     Klastera.cluster_scope_filtered!(
       scope,
       cluster_id,
       cluster_user,
-      cluster_organization,
-      includes
+      cluster_organization
     )
   end
 
-  def user_has_more_than_one_cluster
-    @cluster_clusters ||= cluster_clusters
-    @cluster_clusters.size > 1
-  end
-
-  def clusters_from(scope,includes=[])
-    Klastera.clusters_from!(cluster_user,cluster_organization,scope,includes)
+  def clusters_from(scope)
+    Klastera.clusters_from!(scope,cluster_user,cluster_organization)
   end
 
-  def set_cluster_filter
-    @filter = ::ClusterFilter.new(cluster_filter_params)
+  def user_clusters_string_list(object_entity,separator,attribute=:name)
+    Klastera.user_clusters_string_list!(
+      cluster_user,
+      cluster_organization,
+      object_entity.try(:cluster_entities),
+      separator,
+      attribute
+    )
   end
 
-  def cluster_filter_params
-    parameters = params.require(:cluster_filter) rescue nil
-    return {} if parameters.blank?
-    parameters.permit(*cluster_filter_permit_params)
+  def set_collection_before_group_by_entity(active_record_collection,entity_params,&block)
+    Klastera.set_collection_before_group_by_entity!(active_record_collection,params,cluster_organization,&block)
   end
 
-  def cluster_filter_permit_params
-    [ :cluster_id ].concat( ::ClusterFilter.attributes )
+  included do
+    Klastera::KLSTR_HELPERS.each do |action|
+      if respond_to?(:helper_method)
+        helper_method(action)
+      end
+      if respond_to?(:hide_action)
+        hide_action(helper)
+        hide_action("#{helper}=")
+      end
+    end
+    before_action :set_the_lonely_cluster, only: %i[ create update ]
   end
 end

data/lib/klastera/version.rb

@@ -1,3 +1,3 @@
 module Klastera
-  VERSION = "1.2.2"
-end
+  VERSION = "1.2.4.2"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klastera
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.4.2
 platform: ruby
 authors:
 - Gino Barahona
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -54,7 +54,6 @@ files:
 - app/controllers/klastera/application_controller.rb
 - app/controllers/klastera/clusters_controller.rb
 - app/helpers/klastera/application_helper.rb
-- app/helpers/klastera/clusters_helper.rb
 - app/models/klastera/cluster.rb
 - app/models/klastera/cluster_entity.rb
 - app/models/klastera/cluster_filter.rb

data/app/helpers/klastera/clusters_helper.rb

@@ -1,4 +0,0 @@
-module Klastera
-  module ClustersHelper
-  end
-end