klastera 1.2.4.2 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8780a6928f5249deb34be42cac1f52a226113865b9f29ddb12e1a36f018141ed
-  data.tar.gz: 1d99b709cea49a08533192ad8a1df621d78ea4d4ee59e1c266f06e952e6d8063
+  metadata.gz: 999d5c067d080b90f56c82a36cbeb286e08000bf09af922845bdd67df023d16c
+  data.tar.gz: e4e105b33d55b228cc4d515e0167586b7b962218860d78593a29f6a71b436712
 SHA512:
-  metadata.gz: 62c72441e00d9edb6c17525453cde71d864389c9342dbe54df3538609814aef0cdcbc3f7c49f49134d526e2da1f99ff1cc258b750cd024a7031afd3a80977d2d
-  data.tar.gz: 806978a3fae34b0a2ddda331ce37b90de2e66f9c77bd707859b721ac7c83980f706b5eb432a00875db8b26b4c8901b11307ef62ab063952d013eef30eca69772
+  metadata.gz: 6902637aaf11219cff0b3ed2f9dcdf1f86c74d2e6c43211d683c559177da39498220d5fca6b987418b936a89c6b08dde5d49a0014d0b86d1fe3c258612912f92
+  data.tar.gz: 1ec8aad0c6793c426c01969bcdb9f04deed692b06499b0726ee047f13932fda3fe5046067432604947cf85e68662269569d61c482971b8855595a92dc87d1d29

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

@@ -11,6 +11,7 @@ module Klastera::Concerns::Cluster
     MODES = [ :required_suborganization, :optional_suborganization, :optional_filter ].freeze
 
     belongs_to :organization, class_name: Klastera.organization_class
+    has_many :cluster_users
 
     scope :of, -> (organization,except_ids=[]) {
       _scope = where(organization: organization)

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

@@ -4,11 +4,8 @@ module Klastera::Concerns::ClusterFilter
   included do
     include ActiveModel::Model
     include ActiveModel::Validations::Callbacks
-    attr_accessor :cluster_id
 
-    def kcluster_id
-      self.cluster_id == 'without_cluster' ? nil : self.cluster_id
-    end
+    attr_accessor :cluster_id
   end
   
   module ClassMethods

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

@@ -3,55 +3,39 @@ module Klastera::Concerns::ClusterUser
 
   included do
     self.table_name = 'cluster_users'
-
     belongs_to :user
     belongs_to :cluster
-
     validates :cluster_id, presence: true
-
-    scope :of, -> (user,organization) {
-      Rails.logger.warn("DON'T USE THIS SCOPE DIRECTLY: Use ::ClusterUser.clusters_from class method instead!")
-      includes(:cluster).where(user_id: user, "clusters.organization_id": organization)
-    }
   end
   
   module ClassMethods
+    ##
+     # Return a Cluster::ActiveRecord_Relation of organization (and) user
+     #
+    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) )
+    end
 
     ##
-    # Returns a hash with the users with cluster relation
-    #
-    def user_clusters_from(organization)
-      users_hash = {}
-      organization_cluster_ids = ::Cluster.of(organization).map(&:id)
-      ::ClusterUser.includes(:user).where(cluster_id: organization_cluster_ids).each do |cluster_user|
-        user_id = cluster_user.user_id || :uncluster
-        users_hash[user_id] ||= []
-        users_hash[user_id] << cluster_user.cluster_id
-      end
-      users_hash
+     # Return a User::ActiveRecord_Relation of organization (and) user
+     #
+    def users_of(organization)
+      ::User.eager_load(:cluster_users).where(users: { organization_id: organization } )
     end
 
     ##
-     # Returns a Cluster::ActiveRecord_Relation
+     # Return a hash of users and its clusters
      #
-     ##
-    def clusters_from(user,organization)
-      clusters = []
-      unless user.can_admin_clusters?
-        # We could return cu.clusters but you may quering this result and a array can't handle order, where and etc.
-        # So we take only the cluster_ids and perfome a new search in order to get a Cluster::ActiveRecord_Relation 
-        # like the else block.
-        # TODO: resolve it without quering twice
-        clusters_id = ::ClusterUser.of(user,organization).map(&:cluster_id)
-        clusters = ::Cluster.where(id: clusters_id)
-        # Add a empty cluster instance to handle models without a cluster assignation. Only for use and show modes
-        if organization.optional_mode?
-          clusters << ::Cluster.new({nid: :without_cluster, name: I18n.t('klastera.without_cluster')})
-        end
-      else
-        clusters = ::Cluster.of(organization)
+    def users_hash_of(organization)
+      users = {}
+      rows = self.users_of(organization).pluck("users.id AS user_id","cluster_users.cluster_id").uniq
+      rows.each do |row|
+        user_id = row.first
+        users[user_id] ||= []
+        users[user_id] << row.last
       end
-      clusters
+      users
     end
   end
 end

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

@@ -11,10 +11,6 @@ module Klastera::Concerns::Clusterizable
     validate :at_least_one_cluster_entity, if: proc { self.organization.required_suborganization_mode? }
     validate :uniqueness_of_cluster_entity_record
 
-    scope :related_clusters, ->() {
-      joins(:cluster_entities).where("cluster_entities.entity_id = #{self.table_name}.id")
-    }
-
     def at_least_one_cluster_entity
       if cluster_entities.length == 0 || cluster_entities.reject{|cluster_entity| cluster_entity._destroy == true}.empty?
         return errors.add(:cluster_entities, I18n.t('klastera.messages.at_least_one_cluster_entity'))

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, @clusters_session.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/_cluster_filter.html.erb

@@ -7,7 +7,7 @@
   <%=yield(f) if block_given? %>
 
   <% if cluster_organization.is_in_cluster_mode? %>
-    <% cluster_collection = cluster_clusters.map{|c|[c.name,(c.id||c.nid)]} %>
+    <% cluster_collection = cluster_of_my_own.map{|c|[c.name,(c.id||c.nid)]} %>
     <% if cluster_collection.size > 1 %>
       <div class="inline-label-control-block">
         <%= f.input :cluster_id, collection: cluster_collection, prompt: t('klastera.clusters.all'), label: false, wrapper: false %>

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

@@ -4,7 +4,7 @@
 %>
 <% if cluster_organization.is_in_cluster_mode? || other_visibility_reason %>
   <% 
-    cluster_collection = @cluster_clusters || cluster_clusters
+    cluster_collection = @clusters_session || cluster_of_my_own
     label = t('klastera.cluster.title')
   %>
   <% if f.nil? %>

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

@@ -1,5 +1,5 @@
 <% if cluster_organization.is_in_cluster_mode? %>
-  <% @cluster_clusters = cluster_clusters %>
+  <% @clusters_session = cluster_of_my_own %>
   <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)%>">
@@ -27,7 +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)) %>
+                <% next unless @clusters_session.map(&:id).include?(cluster_entity.try(:object).try(:cluster_id)) %>
                 <%= render 'layouts/klastera/cluster_entity_fields', f: cluster_entity %>
               <% end %>
             </body>

data/lib/klastera.rb

@@ -5,14 +5,17 @@ module Klastera
 
   extend ActiveSupport::Concern
 
+  UNCLUSTERED_ENTITY = 'without_cluster'
   KLSTR_HELPERS = %i[
-    cluster_user cluster_organization user_has_more_than_one_cluster
-    cluster_scope cluster_clusters cluster_scope_filtered clusters_from
+    cluster_user cluster_organization user_has_more_than_one_cluster cluster_scope cluster_of_my_own
     user_clusters_string_list set_collection_before_group_by_entity
   ]
 
   class << self
 
+    ##
+     #
+     #
     def set_cluster_entities_attributes!(entity,array_cluster_ids)
       cluster_entities_attributes = {}
       entity_cluster_entities = entity.try(:cluster_entities) || []
@@ -35,57 +38,10 @@ module Klastera
       cluster_entities_attributes
     end
 
-    #
-    # 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)
-      self.filter_clusterized_collection_with!(
-        cluster_id,
-        self.cluster_scope!(scope,user,organization),
-        organization
-      )
-    end
-
-    #
-    # In order to this works, active_record_collection argument
-    # should be passed through cluster_scope! method before.
-    #
-    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] 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 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!(active_record_collection,entity_params,cluster_organization)
+    def set_collection_before_group_by_entity!(active_record_collection,entity_params,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
@@ -94,47 +50,65 @@ module Klastera
       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!(
-            entity_params[2],
+          entity_params << :unclustered if organization.is_in_cluster_mode?
+          active_record_collection = Klastera.filter_clusterized!(
             active_record_collection,
-            cluster_organization
+            entity_params[2],
+            organization
           )
         end
         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!(scope,user,organization)
-      cluster_scope!(scope,user,organization).related_clusters
+    #
+    # In order to this work, the active_record_collection argument should be a cluster_scope! return.
+    #
+    def filter_clusterized!(active_record_collection,cluster_id,organization)
+      if organization.is_in_cluster_mode? && cluster_id.present?
+          # Ensures that an array of ids is used in the statement
+          cluster_array = cluster_id.is_a?(Array) ? cluster_id : [cluster_id]
+          # If we receive a UNCLUSTERED_ENTITY request, it means that we should filter by entities without clusters.
+          # The optional_mode?(show/use) condition add to this method an ambivalent use,
+          # where you can filter a unique value or multiple including NULL ones.
+          cluster_array << nil if cluster_array.delete(UNCLUSTERED_ENTITY) || organization.optional_mode?
+          active_record_collection = active_record_collection.where(cluster_entities: { cluster_id: cluster_array.uniq })
+          # You should use a block with clusterable data only
+          yield(active_record_collection) if block_given?
+      end
+      active_record_collection
     end
 
     ##
-     # Returns a scope filtered by clusters or its
-     # organization if the cluster mode is not active.
+     # If the cluster mode is not active, this returns a scope filtered by clusters of its organization/users/cluster
      #
-    def cluster_scope!(scope,user,organization)
+    def cluster_scope!(scope,user,organization,cluster_id=nil)
       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}.*")
-          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 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).eager_load(:cluster_entities).where(id: scope_klass.map(&:id), organization_id: organization)
+      if organization.is_in_cluster_mode?
+
+        if cluster_id.present?
+          # Ensures that an array of id is used in the statement
+          cluster_ids = cluster_id.is_a?(Array) ? cluster_id : [cluster_id]
+        else
+          clusters = cluster_of!(user,organization)
+          cluster_ids = clusters.map(&:id).compact
+        end
+
+        scope_klass = scope_klass.select("DISTINCT ON (#{scope.table_name}.id) #{scope.table_name}.id, #{scope.table_name}.*")
+
+        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 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 unresolved SQL clashes with the main application due to DISTINCT ON clause
+        scope_klass = scope_class(scope).eager_load(:cluster_entities).where(id: scope_klass.map(&:id), organization_id: organization)
       end
       scope_klass
     end
@@ -151,19 +125,19 @@ module Klastera
     end
 
     ##
-     # Returns a cluster array if organization is using the cluster mode
-     #
+     # Returns a Cluster::ActiveRecord_Relation if the organization is using the cluster mode.
      # Use this only to get current_user/organization clusters
-     # understanding this wont be useful out of a cluster mode context.
      #
-     ##
-    def session_clusters(user,organization)
-      clusters = organization.is_in_cluster_mode? ? ::ClusterUser.clusters_from(user,organization) : []
-      if block_given?
-        clusters = clusters.reject{|c|c.id.blank?}
-        yield(clusters)
+    def cluster_of!(user,organization)
+      # A cluster user with role Root or Admin retrieve every cluster of its organizations
+      and_this_user = user.can_admin_clusters? ? nil : user
+      # We weill return a cluster active record collection that can be filtered
+      active_record_collection = ::ClusterUser.clusters_of(organization,and_this_user)
+      # Add a empty cluster instance to handle models without a cluster assignation.
+      if organization.optional_mode? # For use and show modes only
+        active_record_collection << ::Cluster.new({nid: UNCLUSTERED_ENTITY, name: I18n.t("klastera.#{UNCLUSTERED_ENTITY}")})
       end
-      clusters
+      active_record_collection
     end
 
     ##
@@ -181,12 +155,11 @@ module Klastera
     end
 
     ##
-     # cluster_clusters needs the logged user and its organization
-     # that why, we perfomed this logic here
+     # cluster_of! needs a user and a 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))
+      @clusters_session ||= self.cluster_of!(user,organization)
+      self.entity_clusters_string_list!(cluster_entities, separator, attribute, @clusters_session.map(&:id))
     end
   end
 
@@ -199,8 +172,8 @@ module Klastera
   end
 
   def user_has_more_than_one_cluster
-    @cluster_clusters ||= cluster_clusters
-    @cluster_clusters.size > 1
+    @clusters_session ||= cluster_of_my_own
+    @clusters_session.size > 1
   end
 
   def set_the_lonely_cluster
@@ -208,7 +181,7 @@ module Klastera
     parameters = params.require( form_model ) rescue nil
     lonely_cluster = parameters.blank? ? false : parameters.permit( :lonely_cluster ).present?
     if lonely_cluster
-      params[form_model][:cluster_id] = cluster_clusters.first.try(:id)
+      params[form_model][:cluster_id] = cluster_of_my_own.first.try(:id)
     end
   end
 
@@ -226,29 +199,16 @@ module Klastera
     [ :cluster_id ].concat( ::ClusterFilter.attributes )
   end
 
-  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)
+  def filter_clusterized(active_record_collection,cluster_id)
+    Klastera.filter_clusterized!(active_record_collection, cluster_id, cluster_organization)
   end
 
-  def cluster_scope_filtered(scope,cluster_id)
-    Klastera.cluster_scope_filtered!(
-      scope,
-      cluster_id,
-      cluster_user,
-      cluster_organization
-    )
+  def cluster_scope(scope,cluster_id=nil)
+    Klastera.cluster_scope!(scope, cluster_user, cluster_organization, cluster_id)
   end
 
-  def clusters_from(scope)
-    Klastera.clusters_from!(scope,cluster_user,cluster_organization)
+  def cluster_of_my_own
+    Klastera.cluster_of!(cluster_user, cluster_organization)
   end
 
   def user_clusters_string_list(object_entity,separator,attribute=:name)
@@ -262,7 +222,7 @@ 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)
+    Klastera.set_collection_before_group_by_entity!(active_record_collection, params, cluster_organization, &block)
   end
 
   included do

data/lib/klastera/version.rb

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

data/lib/tasks/klastera_tasks.rake

@@ -13,6 +13,11 @@ namespace :klastera do
         klass = args.entity.constantize
         ActiveRecord::Base.transaction do
           klass.where.not(cluster_id: nil).each do |entity|
+            if entity.cluster.blank?
+              puts "Cluster ID #{entity.cluster_id} was not found!"
+              puts "skip..."
+              next
+            end
             Klastera::ClusterEntity.create(entity: entity, cluster: entity.cluster)
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klastera
 version: !ruby/object:Gem::Version
-  version: 1.2.4.2
+  version: '1.3'
 platform: ruby
 authors:
 - Gino Barahona
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-15 00:00:00.000000000 Z
+date: 2020-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails