klastera 1.2.4.1 → 1.2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 149afa24eba1225396134f74b791f7d1e960480af16f5785d7f1a76570eea5d3
-  data.tar.gz: e801acbf180a965cf9a922bfc0e7ad3006df21a780b7d9cbb279cad0c33a4f22
+  metadata.gz: 8780a6928f5249deb34be42cac1f52a226113865b9f29ddb12e1a36f018141ed
+  data.tar.gz: 1d99b709cea49a08533192ad8a1df621d78ea4d4ee59e1c266f06e952e6d8063
 SHA512:
-  metadata.gz: e43ab98889edd3d9ece42a1f496bfc614ee77ac4721344694adf1e084d05192bcc97a43e69be19247095d9b18c3131a5d86d123be9a69ef85544965af6bb419b
-  data.tar.gz: e994dfd1ae541212674faed964c526a38ee3ef14020af970893f54f04d054bf6b9abe36822cf5456ade0cb47a5570576c0cd790604b5d0e70ef71e41f12ae039
+  metadata.gz: 62c72441e00d9edb6c17525453cde71d864389c9342dbe54df3538609814aef0cdcbc3f7c49f49134d526e2da1f99ff1cc258b750cd024a7031afd3a80977d2d
+  data.tar.gz: 806978a3fae34b0a2ddda331ce37b90de2e66f9c77bd707859b721ac7c83980f706b5eb432a00875db8b26b4c8901b11307ef62ab063952d013eef30eca69772

data/lib/klastera.rb

@@ -8,7 +8,7 @@ module Klastera
   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
+    user_clusters_string_list set_collection_before_group_by_entity
   ]
 
   class << self
@@ -36,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
 
@@ -50,61 +52,75 @@ 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 } )
@@ -117,7 +133,7 @@ module Klastera
             ").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
@@ -210,26 +226,29 @@ module Klastera
     [ :cluster_id ].concat( ::ClusterFilter.attributes )
   end
 
-  def cluster_scope(scope,includes=[])
-    Klastera.cluster_scope!(cluster_user,cluster_organization,scope,includes)
+  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 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 user_clusters_string_list(object_entity,separator,attribute=:name)
@@ -242,6 +261,10 @@ module Klastera
     )
   end
 
+  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
+
   included do
     Klastera::KLSTR_HELPERS.each do |action|
       if respond_to?(:helper_method)

data/lib/klastera/version.rb

@@ -1,3 +1,3 @@
 module Klastera
-  VERSION = "1.2.4.1"
+  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.4.1
+  version: 1.2.4.2
 platform: ruby
 authors:
 - Gino Barahona
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2020-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails