klastera 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6cd1ffdd78e48cf6ed10e49ca9c25aec28b85687edfab45128c19e0fe355bbe6
+  data.tar.gz: b973e72ea86f49cdafdb2651470a6cf9ce4285ba255db1a83ecc0efffb3bd980
+SHA512:
+  metadata.gz: 19db0f35f3a830aaea9e0805a4235ee67ef25713f0cdde55675098d18d2d79ed2eefd9bbfc206b8feba2c4cc0df2d87901a5b2eeae97006aade6142fbcd1f79c
+  data.tar.gz: 8a1092f64ada8807fc6f8db2f2903a59a42a30cccb7b399dd151a2e9e274972c57d0d428a8926d2c2c155df49625e81a4b2165c0c9af15e005a802ebd3826495

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Gino Barahona
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= Klastera
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Klastera'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/klastera/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/klastera/clusters.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/klastera/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/controllers/klastera/application_controller.rb

@@ -0,0 +1,33 @@
+module Klastera
+  class ApplicationController < ::ApplicationController
+    protect_from_forgery with: :exception
+    layout :disable_in_xhr_requests
+    before_action :set_xhr_render_session
+    before_action :check_access_to_cluster_admin
+
+    def current_organization
+      super
+    end
+
+    def check_access_to_cluster_admin
+      unless current_user.can_admin_clusters?
+        redirect_to main_app.root_path, flash: { alert: t('klastera.messages.access_cluster_admin') }
+      end
+    end
+
+    if respond_to?(:skip_after_action)
+      skip_after_action :verify_authorized
+    end
+
+    private
+    def disable_in_xhr_requests
+      request.xhr? ? false : nil
+    end
+
+    def set_xhr_render_session
+      return unless request.get?
+      # request.xhr? return nil when this is not a XHR request, but we need a boolean
+      session[:xhr_render] = request.xhr?.present?
+    end
+  end
+end

data/app/controllers/klastera/clusters_controller.rb

@@ -0,0 +1,66 @@
+require_dependency "klastera/application_controller"
+
+module Klastera
+  class ClustersController < ApplicationController
+    before_action :set_cluster, only: %i[ edit update destroy transfer ]
+    before_action :set_clusters, only: %i[ index ]
+
+    def index; end
+
+    def new
+      @cluster = ::Cluster.new
+    end
+
+    def edit; end
+
+    def transfer
+      @transfer = Transfer.new
+    end
+
+    def create
+      @cluster = ::Cluster.new(cluster_params)
+      if @cluster.save
+        @cluster = ::Cluster.new
+        set_clusters
+      end
+    end
+
+    def update
+      if @cluster.update(cluster_params)
+        set_clusters
+      end
+    end
+
+    def destroy
+      new_cluster_id = params.require(:transfer).permit(:new_cluster_id).values.first rescue nil
+      @transfer = Transfer.new(
+        current_cluster: @cluster,
+        new_cluster_id: new_cluster_id
+      )
+      if @transfer.valid?
+        @transfer.to!(::Cluster.related_entities.map{|re|re.constantize})
+        @cluster.destroy
+        set_clusters
+      end
+    end
+
+    private
+      def set_cluster
+        @cluster = ::Cluster.find(params[:id])
+      end
+
+      ###
+        # We are assuming that the main application 
+        # has have implemented current_organization
+      ###
+      def set_clusters
+        @clusters = current_organization.clusters
+      end
+
+      def cluster_params
+        parameters = params.require(:cluster).permit(:nid, :name, :color)
+        parameters[:organization_id]=current_organization.id
+        parameters
+      end
+  end
+end

data/app/helpers/klastera/application_helper.rb

@@ -0,0 +1,40 @@
+module Klastera
+  module ApplicationHelper
+    def ac_errors_as_html_list(errors)
+      array_as_html_list(
+        errors.messages.inject([]) do |array,(attr,errors_array)|
+          array.concat(errors_array)
+          array
+        end
+      )
+    end
+
+    def array_as_html_list(array)
+      "<ul style='padding:0;'><li>#{array.join("</li><li>")}</li></ul>".html_safe
+    end
+
+    def method_missing(method, *args, &block)
+      if method.to_s.end_with?('_path') or method.to_s.end_with?('_url')
+        if main_app.respond_to?(method)
+          main_app.send(method, *args)
+        else
+          super
+        end
+      else
+        super
+      end
+    end
+
+    def respond_to?(method, include_priv=false)
+      if method.to_s.end_with?('_path') or method.to_s.end_with?('_url')
+        if main_app.respond_to?(method,include_priv)
+          true
+        else
+          super
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/app/helpers/klastera/clusters_helper.rb

@@ -0,0 +1,4 @@
+module Klastera
+  module ClustersHelper
+  end
+end

data/app/models/klastera/cluster.rb

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

data/app/models/klastera/cluster_user.rb

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

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

@@ -0,0 +1,78 @@
+module Klastera::Concerns::Cluster
+  extend ActiveSupport::Concern
+  # 'included do' causes the included code to be evaluated in the
+  # context where it is included (cluster.rb), rather than being
+  # executed in the module's context (klastera/concerns/models/cluster).
+  included do
+    self.table_name = 'clusters'
+    
+    attr_reader :last_record
+
+    MODES = [ :suborganization, :required_filter, :optional_filter ].freeze
+
+    default_scope { includes(:organization).order(id: :desc) }
+    belongs_to :organization, class_name: Klastera.organization_class
+
+    scope :all_clusters_of, lambda { |organization,except_ids=[]|
+      g=where(organization: organization)
+      g.where.not(id: except_ids) unless except_ids.blank? 
+    }
+
+    validates :name, presence: true
+    validates :nid, presence: true
+    validates :organization_id, presence: true
+
+    validates_uniqueness_of :nid, scope: [:nid, :organization_id]
+
+    before_destroy do |record|
+      self.can_transfer_and_destroy?
+    end
+
+    def siblings
+      self.class.all_clusters_of(self.organization,[self.id])
+    end
+
+    def is_the_last_record_in_suborganization_mode?
+      self.organization.suborganization_mode? && self.siblings.blank?
+    end
+
+    def required_transfer?
+      self.organization.suborganization_mode?
+    end
+
+    def has_related_entities_using_it?
+      ::Cluster.total_records_assign_to(self) > 0
+    end
+
+    def can_transfer_and_destroy?
+      can_destroy = true
+      if is_the_last_record_in_suborganization_mode?
+        errors.add(:last_record, I18n.t('klastera.messages.cant_delete_the_last_record_in_suborganization_mode'))
+        can_destroy = false
+      end
+      can_destroy
+    end
+  end
+  
+  module ClassMethods
+    def related_entities(attr_needed: :class_name, macro: :has_many)
+      ::Cluster.reflections.map do |association_name, reflection| 
+        reflection.send(attr_needed) if reflection.macro == macro
+      end.compact
+    end
+
+    def total_records_assign_to(cluster_instance)
+      related_entities(attr_needed: :name).inject(0) do |total, association_name|
+        entity = cluster_instance.send(association_name)
+        if entity.respond_to?(:cluster_id)
+          total+=entity.where(cluster_id: cluster_instance.id).count
+        end
+        total
+      end
+    end
+
+    def modes_as_strings
+      ::Cluster::MODES.map{|m|m.to_s}
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Klastera::Concerns::ClusterUser
+  extend ActiveSupport::Concern
+
+  included do
+    self.table_name = 'cluster_users'
+
+    belongs_to :user
+    belongs_to :cluster
+
+    validates :user_id, presence: true
+    validates :cluster_id, presence: true
+
+    before_destroy do |record|
+    end
+
+  end
+  
+  module ClassMethods
+  end
+end

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

@@ -0,0 +1,46 @@
+module Klastera::Concerns::Organization
+  extend ActiveSupport::Concern
+  included do
+    
+    has_many :clusters
+    
+    validates :use_cluster_as, inclusion: { in: ::Cluster.modes_as_strings , message: I18n.t('klastera.clusters.wrong_option') }, if: proc{ use_cluster_as.present? }
+
+    # Return a symbol version of use_cluster_as value
+    def cluster_mode
+      self.use_cluster_as.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.
+     #
+     ##
+    def is_in_cluster_mode?(return_the_mode=false)
+      is_active = cluster_mode.present? && ::Cluster::MODES.include?(cluster_mode)
+      ( return_the_mode ? ( is_active ? cluster_mode : false ) : is_active )
+    end
+
+    def suborganization_mode?
+      cluster_mode == ::Cluster::MODES.first
+    end
+
+    def required_filter_mode?
+      cluster_mode == ::Cluster::MODES.second
+    end
+
+    def optional_filter_mode?
+      cluster_mode == ::Cluster::MODES.third
+    end
+
+    def cluster_is_required?
+      self.suborganization_mode? || self.required_filter_mode?
+    end
+  end
+  
+  module ClassMethods
+    def cluster_params
+      [ :use_cluster_as ]
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+
+
+module Klastera::Concerns::Transfer
+  extend ActiveSupport::Concern
+
+  included do
+    include ActiveModel::Model
+    include ActiveModel::Validations::Callbacks
+
+    attr_accessor :current_cluster, :new_cluster_id, :entities_transfered
+
+    validates :current_cluster, presence: true
+    validates :new_cluster_id, presence: true, if: proc { self.required_transfer? }
+
+    validate do
+      new_cluster = ::Cluster.find(self.new_cluster_id.to_i) rescue nil
+      #
+      # In my time, to_a? didnt work
+      # current_cluster.class returned:
+      #   Cluster(id: integer, name: string, nid: text, organization_id: integer, created_at: datetime, updated_at: datetime, color: string)
+      #
+      # If you see this, please fixe it. Thanks
+      #
+      if current_cluster.class.name != 'Cluster' || current_cluster.try(:is_the_last_record_in_suborganization_mode?)
+        errors.add(:current_cluster, I18n.t('klastera.messages.current_cluster.cant_transfer'))
+      elsif self.required_transfer? && new_cluster_id.present? && new_cluster.nil?
+        errors.add(:new_cluster_id, I18n.t('klastera.messages.new_cluster_id.nil'))
+      elsif current_cluster.id == new_cluster.try(:id)
+        errors.add(:new_cluster_id, I18n.t('klastera.messages.new_cluster_id.same'))
+      elsif new_cluster.present? && current_cluster.organization_id != new_cluster.organization_id
+        # Clusters from another organization do not exist
+        errors.add(:new_cluster_id, I18n.t('klastera.messages.new_cluster_id.nil'))
+      end
+    end
+
+    ##
+    #
+    #
+    def to!(related_entities)
+      self.entities_transfered = 0
+      related_entities.each do |entity|
+        if entity.is_a?(Class) && entity.respond_to?(:cluster_id)
+          self.entities_transfered += entity.where(
+            cluster_id: self.current_cluster.id
+          ).update_all(cluster_id: self.new_cluster_id)
+        end
+      end
+    end
+
+    def required_transfer?
+      self.current_cluster.required_transfer? && self.current_cluster.has_related_entities_using_it?
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+module Klastera::Concerns::User
+  extend ActiveSupport::Concern
+
+  included do
+
+    ## @@current_organization = nil
+
+    CLUSTER_ROOT = 'root'.freeze
+    CLUSTER_ADMIN = 'admin'.freeze
+    CLUSTER_USER = 'user'.freeze
+
+    CLUSTER_ROLES = [ CLUSTER_ROOT, CLUSTER_ADMIN, CLUSTER_USER ].freeze
+
+    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.need_cluster_assignation? }
+    before_destroy do |record|
+    end
+
+    def use_cluster?; self.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_not_a_cluster_root?; ! self.is_a_cluster_root?; end
+    def is_not_a_cluster_admin?; ! self.is_a_cluster_admin?; end
+    def is_not_a_cluster_user?; ! self.is_a_cluster_user?; end
+
+    def need_cluster_assignation?
+      self.organization.is_in_cluster_mode? && self.organization.suborganization_mode? && self.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? )
+    end
+
+    # def __current_organization
+    #   @@current_organization
+    # end
+
+    # def __current_organization=(organization)
+    #   @@current_organization = organization
+    # end
+
+    private
+    def at_least_one_role
+      if cluster_users.none?
+        errors.add(:base, I18n.t('klastera.user.you_need_add_at_least_one_cluster'))
+      end
+    end
+
+  end
+  
+  module ClassMethods
+    def cluster_params
+      [ :cluster_role, { cluster_users_attributes: [:id, :cluster_id, :_destroy] } ]
+    end
+  end
+end

data/app/models/klastera/transfer.rb

@@ -0,0 +1,5 @@
+module Klastera
+  class Transfer
+    include Klastera::Concerns::Transfer
+  end
+end

data/app/views/klastera/clusters/_form.html.erb

@@ -0,0 +1,22 @@
+<%= simple_form_for( @cluster, remote: true, html: { autocomplete: :off, class: 'slim-form-field' } ) do |f| %>
+  <%=render 'layouts/remote_form/header', o: @cluster, title: title, fa: :qrcode %>
+
+  <div class="<%=classes_for_remote_modal_body()%>">
+    <div class="row">
+      <div class="col-xs-12">
+        <%= f.input :name, as: :string, label: t('klastera.cluster_name') %>
+      </div>
+      <div class="col-xs-12">
+        <%= f.input :nid, as: :string, label: t('klastera.cluster_nid') %>
+      </div>
+      <%# <div class="col-xs-12"> %>
+        <%# <%= f.input :organization_id, as: :string, label: t('klastera.organization_name') %>
+      <%# </div> %>
+      <div class="col-xs-12">
+        <%= f.input :color, as: :string, label: t('klastera.cluster_color'), input_html: { class: 'color-picker'} %>
+      </div>
+    </div>
+  </div>
+  
+  <%=render 'layouts/remote_form/footer', o: @cluster %>
+<% end %>

data/app/views/klastera/clusters/_form_transfer.html.erb

@@ -0,0 +1,34 @@
+<% can_transfer_and_destroy = @cluster.can_transfer_and_destroy? %>
+<%= simple_form_for( @transfer,  url: cluster_path(@cluster), method: :delete, remote: true, html: { autocomplete: :off, class: 'destroy-form slim-form-field' } ) do |f| %>
+  <%=render 'layouts/remote_form/header', o: @cluster, title: title, fa: :qrcode %>
+  <div class="<%=classes_for_remote_modal_body()%>">
+    <h4 class="text-center">Esta acción es irreversible.<br/>¿Está seguro?</h4>
+    <% if ::Cluster.total_records_assign_to(@cluster) > 0 %>
+      <br />
+      <div class="row">
+        <% if can_transfer_and_destroy %>
+          <div class="col-xs-12">
+            <div class="alert alert-<%=current_organization.suborganization_mode? ? :warning : :info %> text-center">
+              <i class="fa fa-2x fa-<%=current_organization.suborganization_mode? ? :warning : 'info-circle' %> float-none"></i>
+              <p class="margin-top-5 fa-1-2x"><%=t("klastera.clusters.transfer.#{current_organization.suborganization_mode? ? :required : :optional}")%></p>
+            </div>
+          </div>
+          <div class="col-xs-12">
+            <%= f.input :new_cluster_id, collection: @cluster.siblings.map{|s|[s.name,s.id]}, label: t('klastera.clusters.siblings') %>
+          </div>
+        <% else %>
+          <div class="col-xs-12">
+            <div class="alert alert-danger text-center no-margin">
+              <i class="fa fa-2x fa-times-circle float-none"></i>
+              <br />
+              <div class="fa-1-2x">
+                <%=ac_errors_as_html_list(@cluster.errors)%>
+              </div>
+            </div>
+          </div>
+        <% end %>
+      </div>
+    <% end %>
+  </div>
+  <%=render 'layouts/remote_form/footer', o: @cluster, btn_type: :danger, hide_submit_button: (! can_transfer_and_destroy )  %>
+<% end %>