klastera 1.4.0.2 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c6ed8465fe9fcf78e96af1ad4d137ecdc867cc26242e0c4aada31557668b5db
-  data.tar.gz: 045d77f5c652c11aa1badd03c404c26b07a04ddd8d7bd7886b72ba47195d9339
+  metadata.gz: c15103fa238ee96065a307c2e8e4d30e99488174d0c1f6cd47cf76752998e37c
+  data.tar.gz: e6d79698657b081437e62238c3925e5346a4b47b17f5e4671f11bfeb7f6806a8
 SHA512:
-  metadata.gz: 70bb42f25ded9aa221049e3d2fc25a88eb467514f562a99b5ffbc26e575a9bbf692e41af450201d82f00452f7d924e5b4f3a71409539d091ab60397de65fc379
-  data.tar.gz: 53e3902628bfac1f1353e0d6760483df4d82a51aa4ee32066c579e23b81bdb3832ab3ef9fc79ccff94d576971958ca4d00a8920ed7860ba7df1356c894b3c2c4
+  metadata.gz: 3e39ddb9802da7ed9f31e320e8ac36f5f26cb2fe8a4d09065c5de22fee3851e7593b08cd7223455dfdf19a718d63a98610269c2c9702e51160834938181f47d7
+  data.tar.gz: 2a2f371d207ce603d3887a86cedabe5451d3edc056b5549361c46dfa0ed8a0c64aa7e4897251db7683457880c5b2868f374067690a5a9c5d34c0f92f3863f32f

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 }.order(order: :asc).merge(and_user_id) )
+      ::Cluster.eager_load(cluster_users: :user).where({ organization_id: organization }.merge(and_user_id) ).order(order: :asc)
     end
 
     ##

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

@@ -1,6 +1,9 @@
 module Klastera::Concerns::Clusterizable
   extend ActiveSupport::Concern
+
   included do
+    class MutipleClustersOperationError < StandardError; end
+
     belongs_to :cluster
 
     has_many :cluster_entities, as: :entity, class_name: Klastera::ClusterEntity
@@ -18,6 +21,10 @@ module Klastera::Concerns::Clusterizable
       end
     end
 
+    def allow_multiple_clusters?(default=:one)
+      organization.cluster_cardinality_of(self.class, default: default) == :many
+    end
+
     ##
      # This is a legacy method and we don't recommend using it.
      # Implement directly Klastera.entity_clusters_string_list instead of this method.

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

@@ -1,7 +1,7 @@
 module Klastera::Concerns::Organization
   extend ActiveSupport::Concern
   included do
-    
+    serialize :cluster_config
     has_many :clusters
     
     validates :use_cluster_as, inclusion: { in: ::Cluster::MODES.map{|m|m.to_s}, message: I18n.t('klastera.clusters.wrong_option') }, if: proc{ use_cluster_as.present? }
@@ -11,6 +11,17 @@ module Klastera::Concerns::Organization
       self.use_cluster_as.to_s.to_sym
     end
 
+    def cluster_cardinality_of(entity, default: :many)
+      if cluster_config.is_a?(Hash)
+        entities_cardinality = cluster_config[:entities]&.[](:cardinality)||{}
+        entity = entity.to_s.to_sym
+        if entities_cardinality.has_key?(entity)
+          default = entities_cardinality[entity]
+        end
+      end
+      default.to_s.to_sym
+    end
+
     ##
      # Return a boolean if one of three of options was set in organization
      # As useless option you can retrieve the value passing false as argument.

data/db/migrate/20200908180057_add_cluster_config_to_organization.rb

@@ -0,0 +1,5 @@
+class AddClusterConfigToOrganization < ActiveRecord::Migration
+  def change
+    add_column :organizations, :cluster_config, :text
+  end
+end

data/lib/klastera.rb

@@ -7,7 +7,7 @@ module Klastera
 
   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
 
@@ -79,9 +79,8 @@ 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)
@@ -92,15 +91,27 @@ module Klastera
         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
-      scope_klass.where(organization_id: organization)
+      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.where(organization_id: organization)
     end
 
     # 
@@ -110,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)
@@ -152,6 +163,20 @@ module Klastera
 
       [ 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
 
   ##################################################################################################################################################
@@ -193,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.2"
+  VERSION = "1.4.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klastera
 version: !ruby/object:Gem::Version
-  version: 1.4.0.2
+  version: 1.4.4
 platform: ruby
 authors:
 - Gino Barahona
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -93,6 +93,7 @@ files:
 - db/migrate/20200330010551_create_klastera_cluster_users.rb
 - db/migrate/20200330221601_add_order_field_to_clusters.rb
 - db/migrate/20200518142609_create_klastera_cluster_entities.rb
+- db/migrate/20200908180057_add_cluster_config_to_organization.rb
 - lib/klastera.rb
 - lib/klastera/engine.rb
 - lib/klastera/version.rb