openproject-service_packs 1.0.1

data/app/helpers/service_pack_presenter.rb

@@ -0,0 +1,39 @@
+class ServicePackPresenter
+	attr_reader :service_pack
+	def initialize(service_pack)
+		# we don't take NIL as an option
+		if service_pack&.id
+			@service_pack = service_pack
+		else
+			raise 'This is NIL cannot print'
+		end
+	end
+	def json_full_header
+		# not recommended in production
+		@service_pack.to_json
+	end
+	def hash_lite_header
+		@service_pack.as_json(except: [:id, :threshold1, :threshold2, :updated_at, :created_at])
+	end
+	def json_lite_header
+		hash_lite_header.to_json
+	end
+	def hash_rate_only
+		# ActiveRecord join returns an array!
+		q = <<-SQL
+			SELECT name, units_per_hour AS upt
+			FROM mapping_rates t1
+			INNER JOIN #{TimeEntryActivity.table_name} t2
+			ON t1.activity_id = t2.id
+			WHERE t1.service_pack_id = #{@service_pack.id}
+			SQL
+		ActiveRecord::Base.connection.exec_query(q).to_hash
+	end
+	def json_rate_only
+		hash_rate_only.to_json
+	end
+	def json_export(sym=:header)
+		err = { :error => 422, :name => "Unsupported format"}
+		sym == :header ? json_lite_header : (sym == :rate ? json_rate_only : err.to_json)
+	end
+end

data/app/helpers/service_pack_report.rb

@@ -0,0 +1,65 @@
+class ServicePackReport
+	attr_reader :service_pack
+
+	def initialize(service_pack)
+		if service_pack&.id
+			@service_pack = service_pack
+		else
+			raise -'This service pack is NIL, cannot report'
+		end
+	end
+
+	def query(project = nil)
+		sql = <<-SQL
+          SELECT t2.spent_on, concat(t4.firstname, ' ', t4.lastname) AS user_name, t3.name AS activity_name,
+			    t5.id AS work_package_id, t7.name AS type_name, t5.subject AS subject, t2.comments AS comment,
+          t1.units AS units, t2.hours AS hours, #{project.nil? ? 't6.name' : "'#{project.name}'"} AS project_name
+          FROM service_pack_entries t1
+          INNER JOIN #{TimeEntry.table_name} t2
+          ON t1.time_entry_id = t2.id
+          INNER JOIN #{TimeEntryActivity.table_name} t3
+          ON t2.activity_id = t3.id
+          INNER JOIN users t4
+          ON t2.user_id = t4.id
+          #{project.nil? ? 'INNER JOIN projects t6 ON t2.project_id = t6.id' : ''}
+          LEFT JOIN #{WorkPackage.table_name} t5
+          ON t2.work_package_id = t5.id
+          LEFT JOIN types t7
+          ON t5.type_id = t7.id
+          WHERE service_pack_id = #{@service_pack.id}
+          #{project.nil? ? '' : "AND t2.project_id = #{project.id}"}
+          ORDER BY spent_on DESC
+          SQL
+    @entries = ActiveRecord::Base.connection.exec_query(sql).to_hash
+  end
+
+  def csv_extractor
+    raise -'Query not run yet' unless @entries
+    decimal_separator = I18n.t(:general_csv_decimal_separator)
+    export = CSV.generate(col_sep: ';') { |csv|
+      headers = [-'Date', -'User', -'Activity', -'Project', -'Work Package', -'Hours', -'Type', -'Subject', -'Units', -'Comments']
+  		# headers += custom_fields.map(&:name) # not supported
+  		csv << headers
+      @entries.each do |entry|
+        fields = [entry[-'spent_on'],
+                  entry[-'user_name'],
+                  entry[-'activity_name'],
+                  entry[-'project_name'],
+                  entry[-'work_package_id'],
+                  entry[-'hours'].round(2).to_s.gsub(-'.', decimal_separator),
+                  entry[-'type_name'],
+                  entry[-'subject'],
+                  entry[-'units'].round(0),
+                  entry[-'comment']
+                 ]
+        # fields += custom_fields.map { |f| show_value(entry.custom_value_for(f)) }
+        csv << fields
+      end
+    }
+  end
+
+  def call(project=nil)
+    self.query(project)
+    self.csv_extractor
+  end
+end

data/app/helpers/service_packs_notification.rb

@@ -0,0 +1,13 @@
+module ServicePacksNotification
+
+	def self.notify_under_threshold1
+		# https://blog.arkency.com/2013/12/rails4-preloading/
+		service_packs = ServicePack.where('remained_units <= total_units / 100.0 * threshold1').preload(:consuming_projects)
+		ServicePack.find_each do |sp|
+			sp.consuming_projects.find_each do |project|
+				users = User.allowed(:see_assigned_service_packs, project)
+				users.each do |user| ServicePacksMailer.notify_under_threshold1(user, sp).deliver_later end
+			end
+		end
+	end
+end

data/app/helpers/sp_assignment_manager.rb

@@ -0,0 +1,25 @@
+module SPAssignmentManager
+	# Implementation is subject to change.
+	def assign_to(service_pack, project)
+		# binding.pry
+		ActiveRecord::Base.transaction do
+			# one query only
+			project.assigns.update_all(assigned: false)
+			@assignment = service_pack.assigns.find_by(project_id: project.id) || project.assigns.new
+			@assignment.assigned = true
+			@assignment.assign_date = Date.today
+			@assignment.unassign_date = service_pack.expired_date
+			@assignment.service_pack_id = service_pack.id if @assignment.new_record?
+			@assignment.save!
+		end
+	end
+	def _unassign(project)
+		project.assigns.find_by(assigned: true)&.terminate # ruby >= 2.3.0 "safe navigation operator"
+	end
+	def unassigned?(project)
+		!assigned?(project)
+	end
+	def assigned?(project)
+		project.assigns.find_by(assigned: true)
+	end
+end

data/app/mailers/application_mailer.rb

@@ -0,0 +1,5 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end
+

data/app/mailers/service_packs_mailer.rb

@@ -0,0 +1,43 @@
+class ServicePacksMailer < ApplicationMailer
+  def expired_email(user, service_pack)
+    @user = user
+    @sp = service_pack
+    # binding.pry
+
+    mail to: @user.mail, subject: "The service pack #{@sp.name} has expired" do |format|
+      format.text
+      format.html
+    end
+  end
+
+  def notify_under_threshold1(user, service_pack)
+    @user = user
+    @sp = service_pack
+    # binding.pry
+    mail to: @user.mail, subject: "The service pack #{@sp.name} is running out" do |format|
+      format.text
+      format.html
+    end
+  end
+
+  def notify_under_threshold2(user, service_pack)
+    @user = user
+    @sp = service_pack
+    # binding.pry
+    mail to: @user.mail, subject: "The service pack #{@sp.name} is running out" do |format|
+      format.text
+      format.html
+    end
+  end
+
+  def used_up_email(user, service_pack)
+    @user = user
+    @sp = service_pack
+
+    mail to: @user.mail, subject: "The service pack #{@sp.name} ran out of units" do |format|
+      format.text
+      format.html
+    end
+
+  end
+end

data/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/app/models/assign.rb

@@ -0,0 +1,13 @@
+class Assign < ApplicationRecord
+	belongs_to :service_pack
+	belongs_to :project
+	scope :active, ->{where("assigned = ? and unassign_date > ?", true, Date.today)}
+	def terminate
+		self.assigned = false
+		self.unassign_date = Date.today
+		self.save!
+	end
+	def overdue?
+		service_pack.unavailable?
+	end
+end

data/app/models/mapping_rate.rb

@@ -0,0 +1,14 @@
+class MappingRate < ApplicationRecord
+  # DO NOT ADD :inverse_of TO THIS CLASS - it breaks the SP#edit and #new
+  belongs_to :activity, class_name: 'TimeEntryActivity', foreign_key: 'activity_id'
+  belongs_to :service_pack
+  # validates_uniqueness_of :activity, scope: :service_pack
+
+  validates_numericality_of :units_per_hour, greater_than_or_equal_to: 0
+  validate :only_define_rates_on_shared_activity
+
+  private
+  	def only_define_rates_on_shared_activity
+  		errors.add(:activity, 'invalid') if !activity.shared?
+  	end
+end

data/app/models/service_pack.rb

@@ -0,0 +1,180 @@
+# freeze_literal_string: true
+class ServicePack < ApplicationRecord
+  before_create :default_remained_units
+  after_save :revoke_all_assignments, if: :expired? # should be time-based only.
+  after_save :knock_out, if: :used_up?, on: :consumption
+
+  has_many :assigns, dependent: :destroy
+  has_many :active_assignments, -> {where('assigned = ? and unassign_date >= ?', true, Date.today)}, class_name: 'Assign'
+  has_many :projects, through: :assigns
+  has_many :consuming_projects, through: :active_assignments, source: :project
+  has_many :mapping_rates, inverse_of: :service_pack, dependent: :delete_all
+  has_many :time_entry_activities, through: :mapping_rates, source: :activity
+  has_many :service_pack_entries, inverse_of: :service_pack, dependent: :delete_all
+  # :source is the name of association on the "going out" side of the joining table
+  # (the "going in" side is taken by this association)
+  # example: User has many :pets, Dog is a :pets and has many :breeds. Breeds have ...
+  # Rails will look for :dog_breeds by default! (e.g. User.pets.dog_breeds)
+  # sauce: https://stackoverflow.com/a/4632472
+
+  accepts_nested_attributes_for :mapping_rates, allow_destroy: true, reject_if: ->(attributes) {attributes['units_per_hour'].blank?}
+
+  validates_presence_of :name, :threshold1, :threshold2, :expired_date, :started_date, :total_units
+
+  validates_uniqueness_of :name, on: :create # SP name never changes
+  # https://rubular.com/r/CCtRDRq9jDuMmb
+
+  validates_format_of :name, with: /\A[^_`~^*\\+=\{\}\|\\;"'<>.\/]+\Z/, message: 'has invalid character(s)'
+
+  validates_numericality_of :total_units, greater_than: 0
+  validates_numericality_of :threshold1, :threshold2, only_integer: true, greater_than: 0
+
+  validate :threshold2_is_greater_than_threshold1
+  validate :end_after_start
+  validate :must_not_expire_in_the_past
+  validate :threshold1_is_greater_than_total_units
+  validate :threshold2_is_greater_than_total_units
+
+  scope :assignments, -> {joins(:assigns).where(assigned: true)}
+  scope :availables, -> {where('remained_units > 0 and expired_date >= ?', Date.today)}
+  scope :notifiable, ->(thresno) {where("remained_units <= threshold#{thresno}")}
+
+  def default_remained_units
+    self.remained_units = total_units
+  end
+
+  def revoke_all_assignments
+    assignments.where(assigned: true).update_all(assigned: false, unassign_date: Date.today)
+  end
+
+  ### CHECKERS ###
+  def expired?
+    true if Time.now > expired_date
+  end
+
+  def used_up?
+    true if remained_units <= 0
+  end
+
+  def unavailable? # available SP might not be assignable
+    used_up? && expired?
+  end
+
+  def available?
+    !unavailable?
+  end
+
+  def is_notify?
+    # so what is with the two thresholds!?
+    dates_to_notify = (expired_date - Date.today).to_i
+    dates_to_notify.between?(1, 2)
+  end
+
+  def assigned?
+    assigns.where(assigned: true).exists?
+  end
+
+  # def total_unit_updatable?(new_value, old_value = total_units)
+  #   # old_value=total_units
+  #   if new_value > old_value
+  #     true
+  #   elsif new_value == old_value
+  #     true
+  #   elsif new_value < old_value
+  #     unit_subtract_number = old_value - new_value
+  #     !(remained_units < unit_subtract_number)
+  #   end
+  # end
+
+  ### END CHECKERS ###
+
+  # FOR TESTING ONLY
+  def expired_notification # send to the first user in the first record in the DB
+    if expired?
+      user = User.first
+      ServicePacksMailer.expired_email(user, self).deliver_later
+    end
+  end
+
+  def cron_send_specific
+    # modify the User param
+    ServicePacksMailer.expired_email(User.last, ServicePack.first).deliver_later
+  end
+
+  # def self.cron_send_default
+  #   # modify the User param
+  #   ServicePack.find_each do |sp|
+  #     ExpiredSpMailer.expired_email(User.last, sp).deliver_now
+  #   end
+  # end
+  # END TESTING ONLY
+
+  def assignments
+    assigns.where(assigned: true)
+  end
+
+  def grant(units)
+    self.total_units += units
+    self.remained_units += units
+    self
+  end
+
+  ### START CRON JOBS ###
+  # modify User param first
+  # deliver_later doesn't work
+
+  def self.check_expired_sp
+    ServicePack.find_each do |sp|
+      ServicePacksMailer.expired_email(User.last, sp).deliver_now if sp.expired?
+    end
+  end
+
+  # will be replaced
+  # # notify immediately at entries
+  #   def self.check_used_up
+  #     ServicePack.find_each do |sp|
+  #       ServicePacksMailer.used_up_email(User.last, sp).deliver_now if sp.used_up?
+  #     end
+  #   end
+
+  def self.check_threshold1
+    ServicePack.notifiable(1).find_each do |sp|
+      ServicePacksMailer.notify_under_threshold1(User.last, sp).deliver_now
+    end
+  end
+
+  def self.check_threshold2
+    ServicePack.notifiable(2).find_each do |sp|
+      ServicePacksMailer.notify_under_threshold2(User.last, sp).deliver_now
+    end
+  end
+
+  ### END CRON JOBS ###
+
+  private
+
+  def threshold1_is_greater_than_total_units
+    @errors.add(:threshold1, 'must be smaller than total units') if threshold1 >= total_units
+  end
+
+  def threshold2_is_greater_than_total_units
+    @errors.add(:threshold2, 'must be smaller than total units') if threshold2 >= total_units
+  end
+
+  def threshold2_is_greater_than_threshold1
+    @errors.add(:threshold2, 'must be less than threshold 1') if threshold2 >= threshold1
+  end
+
+  def end_after_start
+    @errors.add(:expired_date, 'must be after start date') if expired_date < started_date
+  end
+
+  def must_not_expire_in_the_past
+    @errors.add(:expired_date, 'must not be in the past') if expired_date < Date.today
+  end
+
+  def knock_out
+    revoke_all_assignments
+    Delayed::Job.enqueue UsedUpServicePackJob.new(self)
+  end
+end

data/app/models/service_pack_entry.rb

@@ -0,0 +1,6 @@
+class ServicePackEntry < ApplicationRecord
+	belongs_to :time_entry
+	# dependent is for THIS association.
+	belongs_to :service_pack, inverse_of: :service_pack_entries
+end
+ 

data/app/views/assigns/already_assigned.html.erb

@@ -0,0 +1,14 @@
+<%= stylesheet_link_tag 'assigns', plugin: :openproject_service_packs %>
+
+<div id="sp-display">
+  <h2>Service Pack <%= @service_pack.name %> already assigned to <%= @project.name %></h2><hr/>
+  <strong>Assignment Date</strong>: <%= @assignment.assign_date %>
+  <strong>Valid Until</strong>: <%= @assignment.unassign_date %>
+  <strong>Remained:</strong> <%= @service_pack.remained_units %>/<%= @service_pack.total_units %>
+</div>
+<br/>
+<% if @can_unassign ||= User.current.allowed_to?(:unassign_service_packs, @project) %>
+  <%= link_to -'Unassign', assigns_unassign_path(@project), method: :post, class: -'button norm', data: { confirm: -'Are you sure?' }%>
+<% end %>
+<hr/>
+<p class='other-formats'>Report available in: <%= link_to -'CSV', {action: :report, format: :csv} %></p>

data/app/views/assigns/not_assigned_yet.html.erb

@@ -0,0 +1,19 @@
+<%= javascript_include_tag 'assigns.js', plugin: :openproject_service_packs %>
+
+<div id="sp-assign">
+  <h2>No Service Pack is assigned to this project.</h2>
+  <br/>
+
+  <%= form_with model: @assignment, url: assigns_assign_path(@project), local: true, method: :post do |f| %>
+    Choose a Service Pack to apply:
+    <%= f.select :service_pack_id, {},{},{id: "select-sp"} do %>
+      <option selected>--Pick one Service Pack--</option> 
+      <% @assignables.each do |assignable| %>
+        <%= content_tag(:option, assignable.name, value: assignable.id, data: {start: assignable.started_date.to_s, end: assignable.expired_date.to_s, cap: assignable.total_units, rem: assignable.remained_units}) %>
+      <% end %>
+    <% end %>
+    <br/>
+    <%= f.submit -'Assign a Service Pack', class: -'button -alt-highlight', id: 'sp-assign-button' %>
+  <% end %>
+</div>
+<div id="sp-content"></div>