klastera 1.4.0.3 → 1.4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d11790c4adc1c5453272730dce9ca59a760bf5a6efcb57d6eefb974cd304aa3
-  data.tar.gz: a42a54a74634773884f315eda227c42bf34999bf3b9fbeb82c826ce87dd872e2
+  metadata.gz: ef0519c775285f8e1684e2b7710f6a2729d89335f4742a04f4267a156870746d
+  data.tar.gz: 87adbf443e12d8dc8eb93a6d40dd7518d138dea65c404fc8ac19e9a69ea7a742
 SHA512:
-  metadata.gz: 7c037938caa55966f240959944bec48e155525fedd23f15fa32e8711eb90121247498abe16b57882a9ac2db7e673761f711e377befe921cfe1f0d4018ededc85
-  data.tar.gz: 3f6bab84a0d94a87362cd08ef68f546ddaba9aba1e6c02ce5108f625f91a166058cb9a103a938beb00643a186780ea7006ce6da25b218f3de4ceddbe229dd318
+  metadata.gz: 252b2cc54c25a5d1338d7064610ff2806c4e246f44f1101809fe97b5d0167e9d75de71994f1820e67f0e9c26e164be36ea2fd6ee0922eea9c8152c4ebbce83bb
+  data.tar.gz: 573ef0536c76d2fb6b199ac188cc90ec8f04b780f4d2562a6772b3f73051e77f62d4897ecc633fd3b869ae5d4c5f97a536bb31ebcf13a1c8c58904a37d326d4c

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/clusterizable.rb

@@ -1,13 +1,16 @@
 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
     accepts_nested_attributes_for :cluster_entities, reject_if: :all_blank, allow_destroy: true
 
-    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? }
+    validates :cluster_id, presence: true, if: -> { cluster_id.present? && organization.present? && organization.required_suborganization_mode? }
+    validate :at_least_one_cluster_entity, if: -> { organization.present? && organization.required_suborganization_mode? }
     validate :uniqueness_of_cluster_entity_record
 
     scope :includes_cluster, -> { includes(cluster_entities: :cluster) }
@@ -18,6 +21,10 @@ module Klastera::Concerns::Clusterizable
       end
     end
 
+    def allow_multiple_clusters?(default=:one)
+      organization.present? && 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.
@@ -25,7 +32,7 @@ module Klastera::Concerns::Clusterizable
      ##
     def clusters_string_separated_by(separator,attribute=:name)
       Klastera.entity_clusters_string_list!(
-        self.cluster_entities, separator, attribute
+        cluster_entities, separator, attribute
       )
     end
 

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/app/models/klastera/concerns/user.rb

@@ -11,29 +11,29 @@ module Klastera::Concerns::User
 
     has_many :cluster_users, inverse_of: :user, class_name: ::ClusterUser.to_s
     accepts_nested_attributes_for :cluster_users, reject_if: :all_blank, allow_destroy: true
-    validates :cluster_role, presence: true, if: proc{ self.organization.is_in_cluster_mode? }
-    validates :cluster_role, inclusion: { in: CLUSTER_ROLES , message: I18n.t('klastera.clusters.wrong_option') }, if: proc{ cluster_role.present? }
-    validate :at_least_one_role, if: proc{ self.use_cluster? && self.try(:need_cluster_assignation?) }
+    validates :cluster_role, presence: true, if: -> { organization.present? && organization.is_in_cluster_mode? }
+    validates :cluster_role, inclusion: { in: CLUSTER_ROLES , message: I18n.t('klastera.clusters.wrong_option') }, if: -> { cluster_role.present? }
+    validate :at_least_one_role, if: -> { use_cluster? && try(:need_cluster_assignation?) }
 
-    def use_cluster?; self.cluster_role.present?; end
+    def use_cluster?; cluster_role.present?; end
 
-    def is_a_cluster_root?; self.cluster_role == CLUSTER_ROOT; end
-    def is_a_cluster_admin?; self.cluster_role == CLUSTER_ADMIN; end
-    def is_a_cluster_user?; self.cluster_role == CLUSTER_USER; end
+    def is_a_cluster_root?; cluster_role == CLUSTER_ROOT; end
+    def is_a_cluster_admin?; cluster_role == CLUSTER_ADMIN; end
+    def is_a_cluster_user?; cluster_role == CLUSTER_USER; end
 
     def need_cluster_assignation?
-      self.try(:organization).try(:required_suborganization_mode?) && self.is_a_cluster_user?
+      organization.present? && organization.required_suborganization_mode? && is_a_cluster_user?
     end
 
     def can_admin_clusters?
-      self.organization.is_in_cluster_mode? && ( self.is_a_cluster_admin? || self.is_a_cluster_root? )
+      organization.present? && organization.is_in_cluster_mode? && ( is_a_cluster_admin? || is_a_cluster_root? )
     end
 
     #
     # It tells if this user should see what they cluster role or organization dictates
     # Adminers and users from show cluster modes skip cluster clause
     def cannot_skip_cluster_clause?
-      ! ( self.is_a_cluster_admin? || self.is_a_cluster_root? || ( self.organization.optional_suborganization_mode? && self.cluster_users.blank? ) )
+      ! ( is_a_cluster_admin? || is_a_cluster_root? || ( organization.present? && organization.optional_suborganization_mode? && cluster_users.blank? ) )
     end
 
     #
@@ -43,9 +43,9 @@ module Klastera::Concerns::User
     # cluster_id is present (on show/use mode organizations).
     #
     def try_to_clusterify!(role,cluster_ids)
-      if self.try(:organization).try(:is_in_cluster_mode?)
+      if organization.present? && organization.is_in_cluster_mode?
         self.cluster_role = role
-        if self.try(:organization).try(:required_suborganization_mode?) || cluster_ids.present?
+        if ( organization.present? && organization.required_suborganization_mode? ) || cluster_ids.present?
           timestamp = DateTime.now.to_i
           nested_attributes = {}
           cluster_ids.each do |cluster_id|

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.3"
+  VERSION = "1.4.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klastera
 version: !ruby/object:Gem::Version
-  version: 1.4.0.3
+  version: 1.4.4.1
 platform: ruby
 authors:
 - Gino Barahona
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-03 00:00:00.000000000 Z
+date: 2020-10-14 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