klastera 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bd206c969548ea6d299cb57564aa67e9f7b88a5ba753ad5d0c112b7670ad4f0
-  data.tar.gz: 62580be564273b2a461808c9edbe2e9ef6c1cefa88f8b813ec9d2d02441a0836
+  metadata.gz: ae9963c78d2880fca43b1fd6bef6be6c7ebcdd957289dd1117d81b815fdef707
+  data.tar.gz: 3ae1a3a37239c56675aaa9b9c82cfd65f6262777746bf6e720465c62e66af069
 SHA512:
-  metadata.gz: d5f9073b9968cab43d2a88be5d1bcb9ac4cb6254670b480ac2adeadbe9c00bef78cd35a022f52626c75157844f9ad428c26afaab33b73b55e51b1bcfd0f0c682
-  data.tar.gz: 900d61f55072bfc19110dc4efda73c996dd7ec57e327165279e2c15b5eb86352c1f1aa98a28130b2b1f87a7d753a7891b388badee4a7771e6249fd758b662f5e
+  metadata.gz: ed36fabfe91b44b8d8209a1484081021be21cb0309bfd8731cd1380aa6dcf210464f0e1e6cd5dbba218691cbae023223160ee287d6b698ce99756bc452e4c563
+  data.tar.gz: 62ce187ce73ebf4bf07e045835a1f3c79a0c2a911c0f45c54d980938851afdf38dfe8f632641f0b6da40b5c62e82d03cf7d0286b321fed90c3873c267cce2574

data/app/assets/stylesheets/klastera/clusters.css.scss

@@ -0,0 +1,11 @@
+.nested-cluster-user,
+.nested-cluster-entity {
+  .panel {
+    margin: 0;
+    border-bottom: 0;
+    .panel-heading {
+      padding: 10px 12px 10px 15px;
+      background: none;
+    }
+  }
+}

data/app/models/klastera/cluster_entity.rb

@@ -0,0 +1,5 @@
+module Klastera
+  class ClusterEntity < ActiveRecord::Base
+    include Klastera::Concerns::ClusterEntity
+  end
+end

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

@@ -0,0 +1,12 @@
+module Klastera::Concerns::ClusterEntity
+  extend ActiveSupport::Concern
+
+  included do
+    self.table_name = 'cluster_entities'
+    belongs_to :entity, polymorphic: true
+    belongs_to :cluster, class_name: ::Cluster
+  end
+  
+  module ClassMethods
+  end
+end

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

@@ -7,14 +7,51 @@ module Klastera::Concerns::ClusterUser
     belongs_to :user
     belongs_to :cluster
 
-    validates :user_id, presence: true
     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
+
+    ##
+    # 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
+    end
+
+    ##
+     # Returns a Cluster::ActiveRecord_Relation
+     #
+     ##
+    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)
+      end
+      clusters
+    end
   end
 end

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

@@ -3,12 +3,37 @@ module Klastera::Concerns::Clusterizable
   included do
     attr_accessor :lonely_cluster
     belongs_to :cluster
-    validates :cluster_id, presence: true, if: proc { self.organization.required_suborganization_mode? }
+
+    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? }
+
+    scope :related_clusters, ->() {
+      includes(: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'))
+      end
+    end
+
+    def clusters_string_separated_by(separator)
+      self.cluster_entities.map{|ce|ce.cluster.name}.join(separator)
+    end
+
+    def has_one_cluster_entity
+      if cluster_entities.length > 1
+        return errors.add(:cluster_entities, I18n.t('klastera.messages.has_one_cluster_entity'))
+      end
+    end
   end
   
   module ClassMethods
-    def cluster_params
-      [ :cluster_id, :lonely_cluster ]
+    def cluster_entity_params
+      [ :cluster_id, :lonely_cluster, { cluster_entities_attributes: [:id, :cluster_id, :_destroy] } ]
     end
   end
 end

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

@@ -14,8 +14,6 @@ module Klastera::Concerns::User
     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?) }
-    before_destroy do |record|
-    end
 
     def use_cluster?; self.cluster_role.present?; end
 
@@ -35,6 +33,29 @@ module Klastera::Concerns::User
       self.organization.is_in_cluster_mode? && ( self.is_a_cluster_admin? || self.is_a_cluster_root? )
     end
 
+    #
+    # We will try to create a cluster_user record whether
+    # the organization is using force mode (if cluster_id isn't present, it will raise a validation error) 
+    # or
+    # 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?)
+        self.cluster_role = role
+        if self.try(:organization).try(:required_suborganization_mode?) || cluster_ids.present?
+          timestamp = DateTime.now.to_i
+          nested_attributes = {}
+          cluster_ids.each do |cluster_id|
+            nested_attributes["#{cluster_id}_#{timestamp}"] = {
+              cluster_id: cluster_id,
+              _destroy: false
+            }
+          end
+          self.cluster_users_attributes = nested_attributes
+        end
+      end
+    end
+
     private
 
     def at_least_one_role

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

@@ -0,0 +1,10 @@
+<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' } %>
+  </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 %>
+      <i class="fa fa-trash"></i>
+    <% end %>
+  </td>
+</tr>

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

@@ -4,7 +4,7 @@
     <%= button_tag(t('klastera.actions.filter'), class: 'btn btn-primary btn-sm float-right', data: { disable_with: "<i class='fa fa-spinner spin'></i>" }) %>
   </div>
 
-  <%=yield(f)%>
+  <%=yield(f) if block_given? %>
 
   <% if cluster_organization.is_in_cluster_mode? %>
     <% cluster_collection = cluster_clusters.map{|c|[c.name,(c.id||c.nid)]} %>

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_collection = @cluster_clusters || cluster_clusters
     label = t('klastera.cluster.title')
   %>
   <% if f.nil? %>

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

@@ -1,8 +1,8 @@
 <tr class="nested-fields">
   <td class="field">
     <%= f.select :cluster_id, @user.organization.clusters.map{|c|[c.name,c.id]}, { include_blank: true }, { class: 'form-control' } %>
-    </td>
-  <td class="action vertical-align-middle" width="44">
+  </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 %>
       <i class="fa fa-trash"></i>
     <% end %>

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

@@ -0,0 +1,41 @@
+<% if cluster_organization.is_in_cluster_mode? %>
+  <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)%>">
+        <label class="text" for="<%=f.object.class.name.parameterize%>_cluster_entity">
+          <%=t('klastera.clusters.title')%>
+          <% if cluster_organization.required_suborganization_mode? %>
+            <abbr title="required">*</abbr>
+          <% end %>
+        </label>
+    <% end %>
+  
+      <div class="nested-cluster-entity">
+        <div class="panel panel-default">
+          <div class="panel-heading<%=' custom-required' if cluster_organization.required_suborganization_mode? %>">
+            <h4 class="panel-title">
+              <% unless hide_title||=false %>
+                <div class="float-left" style="line-height: 20px"><%=t('klastera.clusters.title')%></div>
+              <% end %>
+              <%= link_to_add_association f, :cluster_entities, partial: 'layouts/klastera/cluster_entity_fields', data: { 'association-insertion-node': :'tbody.cluster-entity-rows', 'association-insertion-method': :append }, class: 'btn btn-success btn-xs float-right color-white' do %>
+                <i class="fa fa-plus"></i>
+              <% end %>
+              <div class="clearfix"></div>
+            </h4>
+          </div>
+          <table id="cluster-entities" class="table table-striped">
+            <tbody class="cluster-entity-rows">
+              <%= f.fields_for :cluster_entities do |cluster_entity|%>
+                <%= render 'layouts/klastera/cluster_entity_fields', f: cluster_entity %>
+              <% end %>
+            </body>
+          </table>
+        </div>
+      </div>
+
+      <% if hide_title||=false %>
+          <div class="invalid-feedback"><%=f.object.try(:errors)&.[](:cluster_entities).try(:first)%></div>
+        </div>
+      <% end %>
+  </div>
+<% end %>

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

@@ -1,20 +1,22 @@
 <% if @user.try(:is_a_cluster_user?) %>
-  <div class="panel panel-default">
-    <div class="panel-heading">
-      <h4 class="panel-title">
-        <div class="float-left" style="line-height: 20px"><%=t('klastera.clusters.title')%></div>
-        <%= link_to_add_association f, :cluster_users, partial: 'layouts/klastera/cluster_user_fields', data: { 'association-insertion-node': :'tbody.cluster-user-rows', 'association-insertion-method': :append }, class: 'btn btn-success btn-xs float-right color-white' do %>
-          <i class="fa fa-plus"></i>
-        <% end %>
-        <div class="clearfix">
-      </h4>
+  <div class="nested-cluster-user">
+    <div class="panel panel-default">
+      <div class="panel-heading">
+        <h4 class="panel-title">
+          <div class="float-left" style="line-height: 20px"><%=t('klastera.clusters.title')%></div>
+          <%= link_to_add_association f, :cluster_users, partial: 'layouts/klastera/cluster_user_fields', data: { 'association-insertion-node': :'tbody.cluster-user-rows', 'association-insertion-method': :append }, class: 'btn btn-success btn-xs float-right color-white' do %>
+            <i class="fa fa-plus"></i>
+          <% end %>
+          <div class="clearfix"></div>
+        </h4>
+      </div>
+      <table id="cluster-users" class="table table-striped">
+        <tbody class="cluster-user-rows">
+          <%= f.fields_for :cluster_users do |cluster_user|%>
+            <%= render 'layouts/klastera/cluster_user_fields', f: cluster_user %>
+          <% end %>
+        </body>
+      </table>
     </div>
-    <table id="cluster-users" class="table">
-      <tbody class="cluster-user-rows">
-        <%= f.fields_for :cluster_users do |cluster_user|%>
-          <%= render 'layouts/klastera/cluster_user_fields', f: cluster_user %>
-        <% end %>
-      </body>
-    </table>
   </div>
 <% end %>

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

@@ -13,7 +13,7 @@
   >
     <%= fa_icon 'info-circle', class: 'btn-link' %>
   </span>
-  <%= f.select :use_cluster_as, Cluster::MODES.map{|cm|[t("klastera.#{cm}"),cm]}, { include_blank: true }, { class: 'form-control' } %>
+  <%= f.select :use_cluster_as, ::Cluster::MODES.map{|cm|[t("klastera.#{cm}"),cm]}, { include_blank: true }, { class: 'form-control' } %>
 </div>
 
 <script type="text/javascript">

data/config/locales/es.yml

@@ -57,6 +57,8 @@ es:
       created: Creado
       updated: Actualizado
     messages:
+      has_one_cluster_entity: Está permitido agregar un sólo cluster
+      at_least_one_cluster_entity: Debe agregar al menos un cluster
       record_action_successfully: Registro %{a} exitosamente
       cant_delete_the_last_record_in_required_suborganization_mode: No se puede eliminar el único cluster de esta organización
       new_cluster_id:

data/db/migrate/20200518142609_create_klastera_cluster_entities.rb

@@ -0,0 +1,8 @@
+class CreateKlasteraClusterEntities < ActiveRecord::Migration
+  def change
+    create_table :cluster_entities do |t|
+      t.integer :cluster_id, index: true
+      t.references :entity, polymorphic: true, index: true
+    end
+  end
+end

data/lib/klastera.rb

@@ -3,29 +3,92 @@ require "klastera/engine"
 module Klastera
   mattr_accessor :organization_class
 
-  class RelatedClusterEntityComplianceError < StandardError; end
   extend ActiveSupport::Concern
 
   class << self
-    def cluster_scope!(user,organization,scope,includes=[])
-      scope_klass = scope_class(scope)
-      raise RelatedClusterEntityComplianceError, "attribute cluster_id was not found in #{scope_klass}" unless scope_klass.try(:column_names).try(:include?,'cluster_id')
-      scope_klass = scope_klass.includes(includes) if includes.present?
-      scope_klass = scope_klass.where(organization_id: organization)
 
-      session_clusters(user,organization) do |clusters|
-        clusters = clusters.reject{|c|c.id.blank?}
+    #
+    # I like to wrap methods
+    #
+    def cluster_scope_filtered!(scope,cluster_id,user,organization,includes=[])
+      self.filter_clusterized_collection_with!(
+        organization,
+        cluster_id,
+        self.cluster_scope!(user,organization,scope,includes)
+      )
+    end
 
-        if organization.required_suborganization_mode?
-          scope_klass = scope_klass.where("#{scope.table_name}.cluster_id IN (?)",clusters)
-        elsif organization.optional_mode?
-          with_clusters = clusters.present? ? "#{scope.table_name}.cluster_id IN (#{clusters.map(&:id).join(',')})" : nil
-          without_clusters = "#{with_clusters.blank? ? '' : ' OR ' }#{scope.table_name}.cluster_id IS NULL"
-          scope_klass = scope_klass.where("#{with_clusters}#{without_clusters}")
+    #
+    # 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)
+      if cluster_organization.is_in_cluster_mode?
+        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?
+          active_record_collection = active_record_collection.where("cluster_entities.cluster_id": cluster_array)
         end
+        # you may use a block only with clusterizable data
+        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)
+      entity_params_keys = [:entity_name,:entity_attribute,:entity_id,:entity_id_attribute,:unamed]
+      entity_params = entity_params.slice(*entity_params_keys).values
+      if model_class.try(:reflections).try(:keys).try(: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
+          )
+        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!(user,organization,scope,includes=[])
+      cluster_scope!(user,organization,scope,includes).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=[])
+      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.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 } )
+          else
+            scope_klass = scope_klass.joins("
+              LEFT OUTER JOIN cluster_entities
+                ON cluster_entities.cluster_id IN (#{cluster_ids.join(",")})
+                AND entity_id = #{scope.table_name}.id 
+                AND entity_type = '#{scope}'
+            ")
+          end
+        end
+      end
       scope_klass
     end
 
@@ -33,6 +96,7 @@ module Klastera
      # TODO:
      # Implement a validation to ensure that
      # object is a ActiveRecord::Base class
+     # (or just try to guess how to retrieve the argument class)
      #
      ##
     def scope_class(object)
@@ -40,22 +104,17 @@ module Klastera
     end
 
     ##
+     # Returns a cluster array if 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 = []
-      if organization.is_in_cluster_mode?
-        unless user.can_admin_clusters?
-          # TODO: 1: return a Cluster::ActiveRecord_Relation and then remove to_a in ::Cluster.of line
-          # TODO: 2: fix call to ::Cluster instead of Klastera::Cluster
-          clusters = ::ClusterUser.of(user,organization).map{|cu|::Cluster.find(cu.cluster_id)}
-          clusters << ::Cluster.new({nid: :without_cluster, name: I18n.t('klastera.without_cluster')}) if organization.optional_mode?
-        else
-          # TODO: remove "to_a" after ClusterUser.of result became a Cluster::ActiveRecord_Relation object
-          clusters = ::Cluster.of(organization).to_a
-        end
-        yield(clusters) if block_given?
+      clusters = organization.is_in_cluster_mode? ? ::ClusterUser.clusters_from(user,organization) : []
+      if block_given?
+        clusters = clusters.reject{|c|c.id.blank?}
+        yield(clusters)
       end
       clusters
     end
@@ -68,7 +127,9 @@ module Klastera
       helper_method :cluster_user
       helper_method :cluster_organization
       helper_method :cluster_clusters
-      # helper_method :cluster_clusters_ids
+      helper_method :cluster_scope_filtered
+      helper_method :user_has_more_than_one_cluster
+      helper_method :clusters_from
     end
     if respond_to?(:hide_action)
       hide_action :cluster_scope
@@ -81,18 +142,22 @@ module Klastera
       hide_action :cluster_organization=
       hide_action :cluster_clusters
       hide_action :cluster_clusters=
-      # hide_action :cluster_clusters_ids
-      # hide_action :cluster_clusters_ids=
+      hide_action :cluster_scope_filtered
+      hide_action :cluster_scope_filtered=
+      hide_action :user_has_more_than_one_cluster
+      hide_action :user_has_more_than_one_cluster=
+      hide_action :clusters_from
+      hide_action :clusters_from=
     end
     before_action :set_the_lonely_cluster, only: %i[ create update ]
   end
 
   def set_the_lonely_cluster
-    form_model = params[:controller].singularize
+    form_model = @form_record ? model_name_from_record_or_class(@form_record).param_key : params[:controller].singularize
     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] = ::ClusterUser.of(cluster_user,cluster_organization).first.try(:cluster_id)
+      params[form_model][:cluster_id] = cluster_clusters.first.try(:id)
     end
   end
 
@@ -112,9 +177,24 @@ module Klastera
     Klastera.session_clusters(cluster_user,cluster_organization)
   end
 
-  # def cluster_clusters_ids
-  #   cluster_clusters.map(&:id)
-  # end
+  def cluster_scope_filtered(scope,cluster_id,includes=[])
+    Klastera.cluster_scope_filtered!(
+      scope,
+      cluster_id,
+      cluster_user,
+      cluster_organization,
+      includes
+    )
+  end
+
+  def user_has_more_than_one_cluster
+    @cluster_clusters ||= cluster_clusters
+    @cluster_clusters.size > 1
+  end
+
+  def clusters_from(scope,includes=[])
+    Klastera.clusters_from!(cluster_user,cluster_organization,scope,includes)
+  end
 
   def set_cluster_filter
     @filter = ::ClusterFilter.new(cluster_filter_params)