openproject-service_packs 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 527fadb4ab0d898c0b42fab884ceb22b11244060c7599fed1d212fcd67c095d4
+  data.tar.gz: d19e0f5302fe898a109df7c6537e970ab2d6f431eeeca4d3cec1f0f6fd929e00
+SHA512:
+  metadata.gz: 403086129a426fd15ad56843e4a9f74adde12177b7da7149599831cfe0abb5474ccfa2885560701979b739dbf069ca0f75971ccfd4aa4249a4417c048fa1cc67
+  data.tar.gz: 1358d495404e2159a6577012ebebcec5845ac2e5dab1b3de889798382ef56e4b118ea61ff32d2d27d649ba047070b2e895a343990902749bbac94f3af7816790

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+<!---- copyright
+OpenProject Plugins Plugin
+
+Copyright (C) 2013 - 2014 the OpenProject Foundation (OPF)
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License version 3.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+See doc/COPYRIGHT.md for more details.
+
+++-->
+
+# Changelog
+
+* `#<ticket number>` Create plugin

data/README.md

@@ -0,0 +1,4 @@
+OpenProject Service Packs Plugin
+================================	
+ ## A R&D project	
+A plugin tracks its units through logging time work packages basing on definable rates of Time Entry Activities.

data/app/assets/javascripts/assigns.js

@@ -0,0 +1,20 @@
+//use <% javascript_include_tag %>
+function loadServicePack() {
+	if (this.selectedIndex == 0) {
+		document.querySelector("#sp-content").innerHTML = "Please select a Service Pack";
+		document.querySelector("#sp-assign-button").disabled = true;
+		return;
+	}
+	var comp = this.options[this.selectedIndex];
+	var str = "Activation Date: " + comp.dataset.start + "<br/>";
+	str += "Expiration Date: " + comp.dataset.end + "<br/>";
+	str += "Capacity: " + comp.dataset.cap + "<br/>";
+	str += "Remained: " + comp.dataset.rem + "<br/>";
+	// click for more
+	document.querySelector("#sp-content").innerHTML = str;
+	document.querySelector("#sp-assign-button").disabled = false;
+}
+document.addEventListener("DOMContentLoaded", function(event) { 
+	document.querySelector("#select-sp").addEventListener("change", loadServicePack);
+	document.querySelector("#sp-assign-button").disabled = true;
+})

data/app/assets/javascripts/service_packs.js

@@ -0,0 +1,17 @@
+document.addEventListener("DOMContentLoaded", function(event) { 
+	document.getElementById("view-stat").addEventListener("click", function(){
+  		var xhr = new XMLHttpRequest();
+  		// replace the link with statistics link
+  		xhr.open('GET', 'http://localhost:3000/service_packs/1.json');
+  		xhr.setRequestHeader('Content-Type', 'application/json');
+		xhr.onload = function() {
+		    if (xhr.status === 200) {
+		        console.log(JSON.parse(xhr.responseText))
+		    }
+		    else {
+		        alert('Request failed.  Returned status of ' + xhr.status);
+		    }
+		};
+		xhr.send();
+	});
+})

data/app/assets/stylesheets/assigns.css

@@ -0,0 +1,9 @@
+  a.button.norm {
+    background-color: #1a67a3 !important;
+    color: #ffffff !important;
+    margin-bottom: 0;
+  }
+  #sp-display h2 {
+    padding-bottom: 0px;
+    font-size: 1.25em;
+  }

data/app/assets/stylesheets/service_packs.css

@@ -0,0 +1,132 @@
+label, input {
+    margin-bottom: 0 !important;
+    max-width: 500px !important;
+}
+
+input.rates {
+    max-width: 465px !important;
+}
+
+table {
+    font-family: arial, sans-serif;
+    border-collapse: collapse;
+    width: 100%;
+}
+
+td, th {
+    border: 1px solid #dddddd;
+    text-align: left;
+    padding: 8px;
+}
+
+.destroy {
+    background-color: #fc0000 !important;
+    color: #ffeeee !important;
+}
+
+a.blocked {
+    opacity: 0.3;
+    margin-right: 8px;
+    cursor: default !important;
+    margin-left: -5px;
+}
+
+#warnbox {
+    font-size: 0.75em;
+    text-align: center;
+    position: relative;
+    bottom: 7px;
+    right: 2px;
+}
+
+hr {
+    margin-top: 12px;
+}
+
+.button.-highlight.-edit {
+    margin-bottom: 0;
+}
+
+.button.-alt-highlight.-new {
+    margin-bottom: 0;
+}
+
+.button-container {
+    margin-bottom: 10px;
+}
+
+#rates-input {
+    padding-left: 30px;
+    padding-bottom: 20px;
+    overflow-x: auto;
+}
+
+#table-rates-input {
+    width: 40%;
+}
+
+table#table-rates-input td {
+    border: 0px;
+}
+
+table#table-rates-input th {
+    border: 0px;
+}
+
+#error-explanation {
+    background-color: rgba(255, 255, 0, 0.41);
+}
+
+#error-explanation h2 {
+    color: #fc0000;
+}
+
+
+#detailed-sp {
+  position: relative;
+  right: 15px;
+}
+
+#block-left {
+  float: left;
+  width: 47%;
+  height: auto;
+}
+
+#block-right {
+  float: right;
+  width: 47%;
+  height: auto;
+}
+
+@media screen and (max-width: 860px) {
+    #block-left, #block-right {
+        width: 95%;
+        float: none;
+        height: auto;
+    }
+}
+
+.sp {
+    border: 1.5px solid;
+    border-color: #EAEAEA;
+    min-height: 200px;
+    margin: 0 20px 20px 20px;
+    padding: 20px 0 20px 20px;
+    box-sizing: border-box;
+}
+
+.sp.description {
+    float: left;
+    width: 100%;
+    line-height: 1.8em;
+}
+
+.sp.rates, .sp.assigned {
+    width: 100%;
+    height: auto;
+}
+
+.clearfix {
+    clear: both;
+}

data/app/controllers/assigns_controller.rb

@@ -0,0 +1,157 @@
+class AssignsController < ApplicationController
+  #layout 'admin'
+  before_action :find_project_by_project_id
+  include SPAssignmentManager
+
+  def assign
+    # binding.pry
+    return head 403 unless @can_assign = User.current.allowed_to?(:assign_service_packs, @project)
+
+    if assigned?(@project)
+      flash.now[:alert] = "You must unassign first!"
+      render_400 and return
+    end
+    @service_pack = ServicePack.find_by(id: params[:assign][:service_pack_id])
+    if @service_pack.nil?
+      flash.now[:alert] = "Service Pack not found"
+      render_404 and return
+    end
+    if @service_pack.available?
+        # binding.pry
+        assign_to(@service_pack, @project)
+        flash.now[:notice] = "Service Pack '#{@service_pack.name}' successfully assigned to project '#{@project.name}'"
+        render 'already_assigned' and return
+    else
+      # already assigned for another project
+      # constraint need
+      flash.now[:alert] = "Service Pack '#{@service_pack.name}' has been already assigned"
+      render_400 and return
+    end
+    flash.now[:alert] = 'Service Pack cannot be assigned'
+    redirect_to action: :show
+  end
+
+  def unassign
+    return head 403 unless @can_unassign = User.current.allowed_to?(:unassign_service_packs, @project)
+
+    if unassigned?(@project)
+      flash[:alert] = 'No Service Pack is assigned to this project'
+      render_404 and return
+    end
+    _unassign(@project)
+    flash[:notice] = 'Unassigned a Service Pack from this project'
+    redirect_to action: :show and return
+  end
+
+  def show
+    # This will lock even admins out if the module is not activated.
+    return head 403 unless 
+    User.current.allowed_to?(:see_assigned_service_packs, @project) ||
+    (@can_assign = User.current.allowed_to?(:assign_service_packs, @project)) ||
+    (@can_unassign = User.current.allowed_to?(:unassign_service_packs, @project))
+    # binding.pry
+    if @assignment = @project.assigns.find_by(assigned: true)
+      if @assignment.service_pack.unavailable?
+        @assignment.terminate
+        @assignment = nil # signifying no assignments are in effect
+        # as the single one is terminated.
+      end
+    end
+    # binding.pry
+    if @assignment.nil?
+      if @can_assign ||= User.current.allowed_to?(:assign_service_packs, @project)
+        @assignables = ServicePack.availables
+        if @assignables.exists?
+          @assignment = Assign.new
+          render -'not_assigned_yet' and return
+        end
+      end
+      render -'unassignable'
+      # binding.pry
+    else
+      @service_pack = @assignment.service_pack
+      render -'already_assigned'
+    end
+  end
+
+  def select_to_transfer
+    return head 403 unless @can_assign = User.current.allowed_to?(:assign_service_packs, @project)
+  end
+
+  def report
+    return head 403 unless User.current.allowed_to?(:see_assigned_service_packs, @project)
+    if assignment = assigned?(@project)
+      render csv: ServicePackReport.new(assignment.service_pack).call(@project), filename: "ServicePackReport_#{@project.name.gsub(/\s+/, -'_')}.csv"
+    else
+      render_404
+    end
+  end
+  
+  # =======================================================
+  # :Docs
+  # * Limit: Serving JSON only. Intended to restrict to :show.
+  # * Purpose:
+  # Return a table with consumed units by a Project grouped by service 
+  # pack, then activities and sorted from large to small.
+  # * Expected Inputs:
+  # [project_id]: Sharing the same route with the resourceful default.
+  # Put in the link. Mandatory.
+  # [start_period]: Beginning of the counting period. As a date. Optional.
+  # [end_period]: Ending of the counting period. As a date. Optional.
+  # start_period MUST NOT be later than end_period.
+  # Both or none of [start_period, end_period] can be present.
+  # * Expected Outputs
+  # Top class: None
+  # Content: Array of object having [name, act_name, consumed]
+  # - Name: Name of Service Pack
+  # - act_name: Name of activity
+  # - consumed: How many units are consumed (in given period)
+  # Status: 200
+  # * When raising error
+  # HTTP 400: Malformed request.
+  # =======================================================
+
+  def statistics
+    return head 403 unless 
+    User.current.allowed_to?(:see_assigned_service_packs, @project) ||
+    User.current.allowed_to?(:assign_service_packs, @project) ||
+    User.current.allowed_to?(:unassign_service_packs, @project)
+    
+    start_day = params[:start_period]&.to_date # ruby >= 2.3.0
+    end_day = params[:end_period]&.to_date
+    if start_day.nil? ^ end_day.nil?
+      render json: { error: 'GET OUT!'}, status: 400 and return
+    end
+
+    # Notice: Change max(t4.name) to ANY_VALUE(t4.name) on production builds.
+    # MySQL specific >= 5.7.5
+    # https://dev.mysql.com/doc/refman/5.7/en/group-by-handling.html
+
+    get_parent_id = <<-SQL
+      SELECT id, name, COALESCE(parent_id, id) AS pid
+      FROM #{TimeEntryActivity.table_name}
+      WHERE type = 'TimeEntryActivity'
+      SQL
+    body_query = <<-SQL
+      SELECT t1.service_pack_id AS spid, max(t4.name) AS name, t3.pid AS pid,
+      max(t3.name) AS act_name, sum(t1.units) AS consumed
+      FROM #{ServicePackEntry.table_name} t1
+      INNER JOIN #{TimeEntry.table_name} t2
+      ON t1.time_entry_id = t2.id
+      INNER JOIN (#{get_parent_id}) t3
+      ON t2.activity_id = t3.id
+      INNER JOIN #{ServicePack.table_name} t4
+      ON t1.service_pack_id = t4.id
+      SQL
+    group_clause = <<-SQL
+      GROUP BY t1.service_pack_id, t3.pid
+      ORDER BY consumed DESC
+      SQL
+    where_clause = "WHERE t2.project_id = ?"
+    where_clause << (start_day.nil? ? '' : ' AND t1.created_at BETWEEN ? AND ?')
+    query = body_query + where_clause + group_clause
+    par = start_day.nil? ? [query, params[@project.id]] : [query, params[@project.id], start_day, end_day]
+    sql = ActiveRecord::Base.send(:sanitize_sql_array, par)
+    render json: ActiveRecord::Base.connection.exec_query(sql).to_hash, status: 200
+  end
+end

data/app/controllers/service_packs_controller.rb

@@ -0,0 +1,219 @@
+class ServicePacksController < ApplicationController
+  # only allow admin
+  before_action :require_admin
+
+  # Specifying Layouts for Controllers, looking at OPENPROJECT_ROOT/app/views/layouts/admin
+  layout 'admin'
+
+  def index
+    @service_packs = ServicePack.all
+    # for demo
+    #ServicePacksMailer.notify_under_threshold1(User.first,@service_packs.first).deliver_now
+  end
+
+  def new
+    @service_pack = ServicePack.new
+    # TimeEntryActivity.shared.count.times {@service_pack.mapping_rates.build}
+    @sh = TimeEntryActivity.shared
+    @c = TimeEntryActivity.shared.count
+  end
+
+  def show
+    @service_pack = ServicePack.find(params[:id])
+    # controller chooses not to get the thresholds.
+    # assume the service pack exists.
+    # TODO: make a separate action JSON only.
+    respond_to do |format|
+      format.json {
+        # the function already converted this to json
+        render plain: ServicePackPresenter.new(@service_pack).json_export(:rate), status: 200
+      }
+      format.html {
+        # http://www.chrisrolle.com/en/blog/benchmark-preload-vs-eager_load
+        @rates = @service_pack.mapping_rates.preload(:activity)
+        @assignments = @service_pack.assignments.preload(:project)
+      }
+      format.csv {
+        render csv: ServicePackReport.new(@service_pack).call, filename: "service_pack_#{@service_pack.name}.csv"
+      }
+    end
+  end
+
+  # The string with the minus sign in front is a shorthand for <string>.freeze
+  # reducing server processing time (and testing time) by 30%!
+  # Freezing a string literal will stop it from being created anew over and over.
+  # All literal strings will be frozen in Ruby 3 by default, which is a good idea.
+
+  def create
+    mapping_rate_attribute = params[:service_pack][:mapping_rates_attributes]
+    # binding.pry
+    activity_id = []
+    mapping_rate_attribute.each {|_index, hash_value| activity_id.push(hash_value[:activity_id])}
+
+    if activity_id.uniq.length == activity_id.length
+      @service_pack = ServicePack.new(service_pack_params)
+      # render plain: 'not duplicated'
+      if @service_pack.save
+        flash[:notice] = -'Service Pack creation successful.'
+        redirect_to action: :show, id: @service_pack.id and return
+      else
+        flash.now[:error] = -'Service Pack creation failed.'
+      end
+    else
+      # render plain: 'duplicated'
+      flash.now[:error] = -'Only one rate can be defined to one activity.'
+    end
+    # the only successful path has returned 10 lines ago.
+    @sh = TimeEntryActivity.shared
+    @c = TimeEntryActivity.shared.count
+    render 'new'
+  end
+
+  def edit
+    @sp = ServicePack.find_by(id: params[:id])
+    if @sp.nil?
+      flash[:error] = -"Service Pack not found"
+      redirect_to action: :index and return
+    end
+    # @activity = @sp.time_entry_activities.build
+  end
+
+  def update
+    @sp = ServicePack.find_by(id: params[:id])
+    if @sp.nil?
+      flash[:error] = -"Service Pack not found"
+      redirect_to action: :index and return
+    end
+
+    mapping_rate_attribute = params[:service_pack][:mapping_rates_attributes]
+    activity_id = []
+    mapping_rate_attribute.each {|_index, hash_value| activity_id.push(hash_value[:activity_id])}
+
+    if activity_id.uniq.length == activity_id.length
+      # No duplication
+      add_units
+      @sp.assign_attributes(service_pack_edit_params)
+      # binding.pry
+      if @sp.save
+        flash[:notice] = -'Service Pack update successful.'
+        redirect_to @sp
+      else
+        flash.now[:error] = -'Service Pack update failed.'
+        render -'edit'
+      end
+    else
+      # Duplication
+      flash.now[:error] = -'Only one rate can be defined to one activity.'
+      render -'edit'
+    end
+  end
+
+  def destroy
+    @sp = ServicePack.find_by(id: params[:id])
+    if @sp.nil?
+      flash[:error] = -"Service Pack not found"
+      redirect_to action: :index and return
+    end
+    if @sp.assigned?
+      flash.now[:error] = "Please unassign this SP from all projects before proceeding!"
+      redirect_to @sp
+    end
+    @sp.destroy!
+
+    redirect_to service_packs_path
+  end
+
+  # for breadcrumb code
+  def show_local_breadcrumb
+    true
+  end
+
+  def default_breadcrumb
+    action_name == 'index' ? -'Service Packs' : ActionController::Base.helpers.link_to(-'Service Packs', service_packs_path)
+  end
+
+  # =======================================================
+  # :Docs
+  # * Limit: Serving JSON only. Must be Admin to access.
+  # * Purpose:
+  # Return a table with consumed units for a Service Pack grouped by activities and sorted
+  # from large to small.
+  # * Expected Inputs:
+  # [service_pack_id]: Sharing the same route with the resourceful default.
+  # Put in the link. Mandatory.
+  # [start_period]: Beginning of the counting period. As a date. Optional.
+  # [end_period]: Ending of the counting period. As a date. Optional.
+  # start_period MUST NOT be later than end_period.
+  # Both or none of [start_period, end_period] can be present.
+  # * Expected Outputs
+  # Top class: None
+  # Content: Array of object having [name, consumed]
+  # - consumed: How many units are consumed (in given period)
+  # - act_name: Name of activity
+  # Status: 200
+  # * When raising error
+  # HTTP 404: SP not found
+  # HTTP 400: Malformed request.
+  # =======================================================
+
+  def statistics
+    start_day = params[:start_period]&.to_date # ruby >= 2.3.0
+    end_day = params[:end_period]&.to_date
+    if start_day.nil? ^ end_day.nil?
+      render json: {error: 'GET OUT!'}, status: 400 and return
+    end
+    if !ServicePack.find_by(id: params[:service_pack_id])
+      render json: {error: 'NOT FOUND'}, status: 404 and return
+    end
+
+    # Notice: Change max(t3.name) to ANY_VALUE(t3.name) on production builds.
+    # MySQL specific >= 5.7.5
+    # https://dev.mysql.com/doc/refman/5.7/en/group-by-handling.html
+
+    get_parent_id = <<-SQL
+      SELECT id, name, COALESCE(parent_id, id) AS pid
+      FROM #{TimeEntryActivity.table_name}
+      WHERE type = 'TimeEntryActivity'
+    SQL
+    body_query = <<-SQL
+      SELECT t3.pid AS act_id, max(t3.name) AS act_name, sum(t1.units) AS consumed
+      FROM #{ServicePackEntry.table_name} t1
+      INNER JOIN #{TimeEntry.table_name} t2
+      ON t1.time_entry_id = t2.id
+      INNER JOIN (#{get_parent_id}) t3
+      ON t2.activity_id = t3.id
+    SQL
+    group_clause = <<-SQL
+      GROUP BY t3.pid
+      ORDER BY consumed DESC
+    SQL
+    where_clause = "WHERE t1.service_pack_id = ?"
+    where_clause << (start_day.nil? ? '' : ' AND t1.created_at BETWEEN ? AND ?')
+    query = body_query + where_clause + group_clause
+    # binding.pry
+    par = start_day.nil? ? [query, params[:service_pack_id]] : [query, params[:service_pack_id], start_day, end_day]
+    sql = ActiveRecord::Base.send(:sanitize_sql_array, par)
+    render json: ActiveRecord::Base.connection.exec_query(sql).to_hash, status: 200
+  end
+
+  private
+
+  def service_pack_params
+    params.require(:service_pack).permit(:name, :total_units, :started_date, :expired_date, :threshold1, :threshold2,
+                                         mapping_rates_attributes: [:id, :activity_id, :service_pack_id, :units_per_hour, :_destroy])
+  end
+
+  def service_pack_edit_params
+    params.require(:service_pack).permit(:total_units, :threshold1, :threshold2,
+                                         mapping_rates_attributes: [:id, :activity_id, :service_pack_id, :units_per_hour, :_destroy])
+  end
+
+  def add_units
+    return unless params[:service_pack][:total_units]
+    if (t = params[:service_pack][:total_units].to_f) <= 0.0
+      @sp.errors.add(:total_units, 'is invalid') and return
+    end
+    @sp.grant(t - @sp.total_units) unless t == @sp.total_units
+  end
+
+end