klastera 1.4.0.1 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a400414db24740d7888bd0627051715a8b81c6d6f481e15b3819958b043a984f
-  data.tar.gz: 782575cb6ffd02a17dc9318878bc9b3b678e98760feb936038f18dd73dd99326
+  metadata.gz: e524bc600751df634962778af44d6b9bd782cabdf7a125a145d2a7efbfbe6950
+  data.tar.gz: ab457168729e69d5f1ca94f40ea667b78e3610993eaa686998e8aa792f865db1
 SHA512:
-  metadata.gz: c5fe5cd793facd2af1ed367485daaac3822b7f2dda768d90d5aa92e5bc2a296860585d220076de1277e4bc0b5716daa4c560f9d93cc1464ff0839fb48cfa4ba8
-  data.tar.gz: 9c01bd79e3df23f2e514ed9aab6b7e0c544a74bde7e2e88f98e18977d8e20833815e05ea0b85d36f9e72818ffe3edf34ee8c9ced19f5d81de7b4876f22a70e98
+  metadata.gz: f30c250c13e081a7aebeb66fce89386638d445a92f5dd995c4855483a45efd7bf7927265980fff8ffcef7ca3e9d3f5fc53c618b05babc92464a6986a8878df84
+  data.tar.gz: 97007ff678bbc223506ac5fc53814c9b7363c3e45ba4f39455f73d8abdd1012bab6fd7b126b3237cc42b91fbbb6a969061c72ece12549aa1d84ae0810522a43a

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

@@ -8,5 +8,11 @@ module Klastera::Concerns::ClusterEntity
   end
   
   module ClassMethods
+    def left_join_sources_of(scope_klass)
+      scope_klass_arel_table = scope_klass.arel_table
+      scope_klass_arel_table.join(arel_table, Arel::Nodes::OuterJoin).on(
+        scope_klass_arel_table[:id].eq(arel_table[:entity_id]), arel_table[:entity_type].eq(scope_klass.name)
+      ).join_sources
+    end
   end
 end

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

@@ -14,7 +14,7 @@ module Klastera::Concerns::ClusterUser
      #
     def clusters_of(organization,and_user=nil)
       and_user_id = and_user.present? ? { users: { id: and_user } }  : {}
-      ::Cluster.eager_load(cluster_users: :user).where({ organization_id: organization }.merge(and_user_id) )
+      ::Cluster.eager_load(cluster_users: :user).where({ organization_id: organization }.merge(and_user_id) ).order(order: :asc)
     end
 
     ##

data/lib/klastera.rb

@@ -5,8 +5,9 @@ module Klastera
 
   extend ActiveSupport::Concern
 
+  UNCLUSTERED_POSITION = 9999
   UNCLUSTERED_ENTITY = 'without_cluster'.freeze
-  KLSTR_HELPERS = %i[ cluster_user cluster_organization cluster_list cluster_scope cluster_scope_through_of user_clusters_string_list ].freeze
+  KLSTR_HELPERS = %i[ cluster_user cluster_organization cluster_list cluster_scope cluster_scope_through_of user_clusters_string_list cluster_scope_left_join ].freeze
 
   class << self
 
@@ -29,13 +30,15 @@ module Klastera
       if organization.is_in_cluster_mode? && user.cannot_skip_cluster_clause?
         active_record_collection = ::ClusterUser.clusters_of(organization,user)
       else
-        active_record_collection = ::Cluster.where({ organization_id: organization })
+        active_record_collection = ::Cluster.where({ organization_id: organization }).order(order: :asc)
       end
 
       active_record_collection = active_record_collection.order(order: :asc)
 
       if include_unclustered && organization.optional_suborganization_mode? # For show and use modes only
-        active_record_collection << ::Cluster.new({nid: UNCLUSTERED_ENTITY, name: I18n.t("klastera.#{UNCLUSTERED_ENTITY}")})
+        active_record_collection.append(
+          ::Cluster.new({nid: UNCLUSTERED_ENTITY, name: I18n.t("klastera.#{UNCLUSTERED_ENTITY}")}, order: UNCLUSTERED_POSITION )
+        )
       end
       active_record_collection
     end
@@ -76,28 +79,39 @@ module Klastera
     # cluster_filter_id is present when the optional_suborganization mode is on. BUT!
     # Be aware that if the cluster_filter is not present, the value of force_cluster_clause
     # will be overridden by the returned value of cannot_skip_cluster_clause? method.
-    #
-    def cluster_scope!(scope_klass, user, organization, cluster_filter=nil, force_cluster_clause=false)
-      scope_klass = scope_class(scope_klass)
+    def should_clusterize_scope?(user, organization, cluster_filter=nil, force_cluster_clause=false)
+      should = false # I don't know if this is a good idea
       if organization.is_in_cluster_mode? && ( cluster_filter.present? || force_cluster_clause = user.cannot_skip_cluster_clause? ) # yes, this is an assignation
         cluster_ids = []
         # Set another variable as array to get the cluster id(s)
         if cluster_filter.present?
           cluster_ids = cluster_filter.is_a?(Array) ? cluster_filter : [cluster_filter]
         elsif force_cluster_clause
-          cluster_ids = ::ClusterUser.clusters_of(organization,user).map(&:id).sort
+          cluster_ids = ::ClusterUser.clusters_of(organization,user).map(&:id)
         end
         # We will avoid the query unless cluster_ids is having values OR force_cluster_clause is set (see method description)
         if cluster_ids.present? || force_cluster_clause
-          scope_klass = scope_klass.eager_load(:organization,cluster_entities: :cluster)
           # We add the unclustered if the value of cluster_filter have the special without_cluster string or as method description says
           if cluster_ids.delete(UNCLUSTERED_ENTITY) || ( force_cluster_clause && organization.optional_suborganization_mode? )
             cluster_ids << nil
           end
-          scope_klass = scope_klass.where( cluster_entities: { cluster_id: cluster_ids } )
+          should = true
+        end
+      end
+      yield(should,cluster_ids)
+    end
+
+    #
+    # The cleanest and fast way to clusterize a entity!
+    #
+    def cluster_scope!(scope_klass, user, organization, cluster_filter=nil, force_cluster_clause=false)
+      scope = scope_class(scope_klass)
+      should_clusterize_scope?(user,organization,cluster_filter,force_cluster_clause) do |should,cluster_ids|
+        if should
+          scope = scope.eager_load(:organization,cluster_entities: :cluster).where( cluster_entities: { cluster_id: cluster_ids } )
         end
       end
-      scope_klass.where(organization_id: organization)
+      scope.where(organization_id: organization)
     end
 
     # 
@@ -107,7 +121,7 @@ module Klastera
       unclusterized_scope = scope_class(scope_klass)
 
       if organization.is_in_cluster_mode? && ( force_cluster_clause || user.cannot_skip_cluster_clause? )
-        unclusterized_scope = unclusterized_scope.joins(relation => :cluster_entities)
+        unclusterized_scope = unclusterized_scope.joins(relation).joins(Klastera::ClusterEntity.left_join_sources_of(cluster_entity_klass))
       end
 
       if scope_klass.respond_to?(:organization)
@@ -117,22 +131,51 @@ module Klastera
       unclusterized_scope.where("#{relation}_id" => cluster_scope!(cluster_entity_klass, user, organization, cluster_filter, force_cluster_clause))
     end
 
-    # 
+    #
     # Returns an array with a clusterized scoped result and its grouped version
     #
     def group_by_cluster_scope!(scope_klass, user, organization, cluster_filter=[], scope_scopes=[])
       cluster_ids = cluster_filter.is_a?(Array) ? cluster_filter : [cluster_filter]
-      kluster_scope = cluster_scope!(scope_klass, user, organization, cluster_ids, organization.optional_suborganization_mode? )
+      kluster_scope = cluster_scope!(scope_klass, user, organization, cluster_ids, organization.is_in_cluster_mode? )
+
       scope_scopes.each do |tuple_scope|
         scope_name, scope_arg = tuple_scope
         kluster_scope = scope_arg.present? ? kluster_scope.send(scope_name,scope_arg) : kluster_scope.send(scope_name)
       end
-      [
-        kluster_scope,
-        kluster_scope.order(:cluster_id).group_by do |e|
-          e.cluster.present? ? e.cluster.name : I18n.t("klastera.#{UNCLUSTERED_ENTITY}")
+
+      group_by_block = ->(o) {
+        if organization.is_in_cluster_mode?
+          o.cluster.present? ? o.cluster.name : UNCLUSTERED_POSITION
+        else
+          I18n.t("klastera.group_by_cluster_scope.#{scope_klass.model_name.plural}")
+        end
+      }
+
+      grouped_cluster_scope = kluster_scope.group_by(&group_by_block).sort_by{|k,v|k.to_s}
+
+      grouped_cluster_scope.dup.each do |group|
+        if group.first == UNCLUSTERED_POSITION
+          grouped_cluster_scope.delete(group)
+          group[0] = I18n.t("klastera.#{UNCLUSTERED_ENTITY}")
+          grouped_cluster_scope.append(group)
         end
-      ]
+      end
+
+      [ kluster_scope, grouped_cluster_scope ]
+    end
+
+    #
+    # A helper that returns a CLUSTER SCOPE to build queries that need explicit LEFT OUTER JOIN clause,
+    # instead of the default INNER JOIN provide by ActiveRecord's joins method
+    #
+    def cluster_scope_left_join!(scope_klass,organization)
+      cluster_entities_arel_table = Klastera::ClusterEntity.arel_table
+      cluster_arel_table = ::Cluster.arel_table
+      cluster_entities_cluster = cluster_entities_arel_table.join(cluster_arel_table, Arel::Nodes::OuterJoin).on(
+        cluster_entities_arel_table[:cluster_id].eq(cluster_arel_table[:id]),
+      ).join_sources
+
+      scope_class(scope_klass).where(organization_id: organization).joins(Klastera::ClusterEntity.left_join_sources_of(scope_klass)).joins(cluster_entities_cluster)
     end
   end
 
@@ -175,6 +218,10 @@ module Klastera
     Klastera.user_clusters_string_list!(cluster_user, cluster_organization, object_entity.try(:cluster_entities), separator, attribute)
   end
 
+  def cluster_scope_left_join(scope_klass)
+    Klastera.cluster_scope_left_join!(scope_klas,cluster_organization)
+  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.4.0.1"
+  VERSION = "1.4.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klastera
 version: !ruby/object:Gem::Version
-  version: 1.4.0.1
+  version: 1.4.3
 platform: ruby
 authors:
 - Gino Barahona
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-30 00:00:00.000000000 Z
+date: 2020-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Clusterization Engine