openproject-service_packs 1.0.1

data/config/sidekiq.yml

@@ -0,0 +1,4 @@
+:schedule:
+  expired_sp:
+    every: 12h
+    class: ExpiredSpWorker

data/db/migrate/20190108031704_create_assigns.rb

@@ -0,0 +1,11 @@
+class CreateAssigns < ActiveRecord::Migration[5.1]
+  def change
+    create_table :assigns do |t|
+      t.belongs_to :service_pack
+      t.belongs_to :project
+      t.date :assign_date, null: false
+      t.timestamps
+    end
+    add_column(:assigns, :unassigned, :boolean, default: true, null: false)
+  end
+end

data/db/migrate/20190108031712_create_service_packs.rb

@@ -0,0 +1,14 @@
+class CreateServicePacks < ActiveRecord::Migration[5.1]
+  def change
+    create_table :service_packs do |t|
+      t.string :name, null: false
+      t.integer :total_units, null: false
+      t.integer :remained_units, null: false
+      t.date :started_date, null: false
+      t.date :expired_date, null: false
+      t.integer :threshold1, null: false
+      t.integer :threshold2, null: false
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20190108111243_create_mapping_rates.rb

@@ -0,0 +1,11 @@
+class CreateMappingRates < ActiveRecord::Migration[5.1]
+  def change
+    create_table :mapping_rates do |t|
+    	t.integer :activity_id
+      	t.belongs_to :service_pack
+      	t.integer :units_per_hour
+      	t.timestamps
+    end
+    change_column_null :mapping_rates, :units_per_hour, false
+  end
+end

data/db/migrate/20190113111300_rename_assign.rb

@@ -0,0 +1,6 @@
+class RenameAssign < ActiveRecord::Migration[5.1]
+	def change
+		# keep this name because of consensus
+		rename_column :assigns, :unassigned, :assigned
+	end
+end

data/db/migrate/20190116085528_create_service_pack_entries.rb

@@ -0,0 +1,9 @@
+class CreateServicePackEntries < ActiveRecord::Migration[5.1]
+  def change
+    create_table :service_pack_entries do |t|
+    	t.belongs_to :time_entry
+    	t.integer :units
+      	t.timestamps
+    end
+  end
+end

data/db/migrate/20190121072000_final_assigns_table.rb

@@ -0,0 +1,5 @@
+class FinalAssignsTable < ActiveRecord::Migration[5.1]
+	def change
+		add_column :assigns, :unassign_date, :date
+	end
+end

data/db/migrate/20190123150023_add_service_pack_ref_to_service_pack_entries.rb

@@ -0,0 +1,5 @@
+class AddServicePackRefToServicePackEntries < ActiveRecord::Migration[5.1]
+  def change
+    add_reference :service_pack_entries, :service_pack, foreign_key: true
+  end
+end

data/db/migrate/20190123205130_feature_a_done.rb

@@ -0,0 +1,16 @@
+class FeatureADone < ActiveRecord::Migration[5.1]
+	# enforce NOT NULL constraint
+	# false means NULL is not accepted.
+	def change
+		change_column_null :assigns, :unassign_date, false
+		change_column_null :assigns, :assign_date, false
+		change_column_null :service_pack_entries, :time_entry_id, false
+		change_column_null :service_pack_entries, :units, false
+		change_column_null :mapping_rates, :activity_id, false
+		change_column_null :mapping_rates, :service_pack_id, false
+		change_column_null :mapping_rates, :units_per_hour, false
+		if !index_exists?(:mapping_rates, [:service_pack_id, :activity_id])
+			add_index :mapping_rates, [:service_pack_id, :activity_id], unique: true
+		end
+	end
+end

data/db/migrate/20190301070654_change_units_of_service_pack_entries.rb

@@ -0,0 +1,5 @@
+class ChangeUnitsOfServicePackEntries < ActiveRecord::Migration[5.1]
+  def change
+  	change_column :service_pack_entries, :units, :float
+  end
+end

data/db/migrate/20190301071911_change_total_and_remained_units_of_service_pack.rb

@@ -0,0 +1,6 @@
+class ChangeTotalAndRemainedUnitsOfServicePack < ActiveRecord::Migration[5.1]
+  def change
+  	  	change_column :service_packs, :total_units, :float
+  	  	change_column :service_packs, :remained_units, :float
+  end
+end

data/lib/open_project/service_packs.rb

@@ -0,0 +1,5 @@
+module OpenProject
+  module ServicePacks
+    require 'open_project/service_packs/engine'
+  end
+end

data/lib/open_project/service_packs/engine.rb

@@ -0,0 +1,50 @@
+# Prevent load-order problems in case openproject-plugins is listed after a plugin in the Gemfile
+# or not at all
+require 'open_project/plugins'
+
+module OpenProject::ServicePacks
+  class Engine < ::Rails::Engine
+    engine_name 'openproject-service_packs'
+
+    include OpenProject::Plugins::ActsAsOpEngine
+
+    register('openproject-service_packs',
+             :author_url => 'https://openproject.org',
+             :requires_openproject => '>= 6.0.0') do
+
+      project_module :service_packs do
+        # permission :view_ServicePacks, {ServicePacks: [:index]}
+        # permission :create_ServicePacks, {ServicePacks: [:new, :create]}
+        # permission :update_ServicePacks, {ServicePacks: [:edit]}
+        # permission :delete_ServicePacks, {ServicePacks: [:destroy]}
+        permission :assign_service_packs, {assigns: [:assign, :show]}, require: :member
+        permission :unassign_service_packs, {assigns: [:unassign, :show]}, require: :member
+        permission :see_assigned_service_packs, {assigns: [:show]}, require: :member
+      end
+
+      menu :admin_menu,
+           :service_packs,
+           { controller: '/service_packs', action: 'index' },
+           after: :overview,
+           param: :project_id,
+           caption: 'Service Packs',
+           icon: 'icon2 icon-bug',
+           html: {id: 'service_packs-menu-item'}
+           # if: ->(project) {true}
+
+      menu :project_menu,
+           :assigns,
+           {controller: '/assigns', action: 'show'},
+           after: :overview,
+           param: :project_id,
+           caption: 'Service packs',
+           icon: 'icon2 icon-bug',
+           html: {id: 'assign-menu-item'}
+
+    end
+    patches %i[Project TimeEntryActivity TimeEntry Enumeration]
+    assets %w(assigns.js service_packs.js assigns.css service_packs.css)
+    end
+end
+# preserve lost path: no, you can't add a new tab into project settings from the plugin extension.
+# add_tab_entry :project_settings, name: "service_packs", partial: "assigns/show", label: :caption_service_pack

data/lib/open_project/service_packs/patches.rb

@@ -0,0 +1,4 @@
+module OpenProject::ServicePacks
+  module Patches
+  end
+end

data/lib/open_project/service_packs/patches/enumeration_patch.rb

@@ -0,0 +1,37 @@
+module OpenProject::ServicePacks
+	module Patches
+		module EnumerationPatch
+
+			module ClassMethods
+				
+			end
+		
+			module InstanceMethods
+	        # Activities are always created and updated as a new Enumeration
+	        # (see EnumerationsController#create, #update and line 117 - 123)
+	        # so #TEA patching doesn't work.
+				def update_sp_rates
+			    	if type == "TimeEntryActivity" && shared?
+			        	ServicePack.availables.each do |service_pack|
+			          	# service_pack.mapping_rates << self # WRONG: this is NOT a plain Ruby collection!
+	              	  	# trying to give a sensible default value
+			          		service_pack.mapping_rates.create!(units_per_hour: 0, activity_id: self.id)
+			        	end
+			      	end
+			    end
+			end
+		
+				def self.included(receiver)
+					receiver.extend         ClassMethods
+					receiver.send :include, InstanceMethods
+
+					receiver.class_eval do
+						after_create :update_sp_rates
+				end
+			end
+
+		end
+  	end
+end
+
+# Enumeration.send(:include, OpenProject::ServicePacks::Patches::EnumerationPatch)

data/lib/open_project/service_packs/patches/project_patch.rb

@@ -0,0 +1,14 @@
+module OpenProject::ServicePacks
+  module Patches
+    module ProjectPatch
+      def self.included(receiver)
+        receiver.class_eval do
+          has_many :assigns, dependent: :destroy
+          has_many :service_packs, through: :assigns
+        end
+      end
+    end
+  end
+end
+
+# Project.send(:include, OpenProject::ServicePacks::Patches::ProjectPatch)

data/lib/open_project/service_packs/patches/time_entry_activity_patch.rb

@@ -0,0 +1,16 @@
+module OpenProject::ServicePacks
+  module Patches
+    module TimeEntryActivityPatch
+
+      def self.included(receiver)
+          receiver.class_eval do
+            has_many :mapping_rates, foreign_key: :activity_id, inverse_of: 'activity', dependent: :delete_all
+            has_many :service_packs, through: :mapping_rates
+          end 
+      end
+    
+    end
+  end
+end
+
+# TimeEntryActivity.send(:include, OpenProject::ServicePacks::Patches::TimeEntryActivityPatch)

data/lib/open_project/service_packs/patches/time_entry_patch.rb

@@ -0,0 +1,89 @@
+module OpenProject::ServicePacks
+	module Patches
+		module TimeEntryPatch
+			module ClassMethods
+
+			end
+
+
+			# pseudocode:
+			# Find an assignment in effect, if not leave in peace.
+			# Then find a rate associated with activity_id and sp in effect.
+			# Create an SP_entry with the log entry cost.
+			# Subtract the remaining counter of SP to the cost.
+
+			module InstanceMethods
+
+				def log_consumed_units
+					assignment = project.assigns.where(assigned: true).first
+					if assignment.nil?
+            self.errors[:base] << "Cannot log time because none SP was assigned"
+            raise ActiveRecord::Rollback
+          end
+					activity_of_time_entry_id = self.activity.parent_id || self.activity.id
+					sp_of_project = assignment.service_pack
+					rate = sp_of_project.mapping_rates.find_by(activity_id: activity_of_time_entry_id).units_per_hour
+					units_cost = rate * self.hours
+					# binding.pry
+					sp_entry = ServicePackEntry.new(time_entry_id: id, units: units_cost)
+					sp_of_project.service_pack_entries << sp_entry
+          sp_of_project.remained_units -= units_cost
+          sp_of_project.save(context: :consumption)
+=begin
+          if sp_of_project.remained_units <= 0
+            assignment.update(assigned: false)
+            admin_users = User.where(admin: true)
+            admin_users.each do |admin_user|
+              ServicePacksMailer.used_up_email(admin_user, sp_of_project).deliver_now
+            end
+          end
+=end
+
+        end
+
+
+				def update_consumed_units
+					# First examine the entry
+					# then read the service pack related
+					# then recalculate the cost in the entry
+					# Update the entry
+					# Take the delta and subtract to the remained count of SP.
+
+					sp_entry = self.service_pack_entry
+					return if sp_entry.nil?
+					sp_of_project = sp_entry.service_pack # the SP entry is binded at the point of creation
+					activity_of_time_entry_id = self.activity.parent_id || self.activity.id
+					rate = sp_of_project.mapping_rates.find_by(activity_id: activity_of_time_entry_id).units_per_hour
+					units_cost = rate * self.hours
+
+					extra_consumption = units_cost - sp_entry.units
+					# Keep callbacks for SP. Entries have no callback.
+					sp_entry.update(units: units_cost) if extra_consumption != 0
+					sp_of_project.remained_units -= extra_consumption
+          sp_of_project.save(context: :consumption)
+				end
+
+				def get_consumed_units_back
+					sp_entry = self.service_pack_entry
+					return if sp_entry.nil?
+					service_pack = sp_entry.service_pack
+					service_pack.remained_units += sp_entry.units
+					service_pack.save
+				end
+
+			end
+
+			def self.included(receiver)
+				receiver.extend         ClassMethods
+				receiver.send :include, InstanceMethods
+				receiver.class_eval do
+          has_one :service_pack_entry, dependent: :delete
+					after_create :log_consumed_units
+					after_update :update_consumed_units
+					before_destroy :get_consumed_units_back
+				end
+			end
+
+		end
+	end
+end

data/lib/open_project/service_packs/version.rb

@@ -0,0 +1,5 @@
+module OpenProject
+  module ServicePacks
+    VERSION = '1.0.1'
+  end
+end

data/lib/openproject-service_packs.rb

@@ -0,0 +1 @@
+require 'open_project/service_packs'

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: openproject-service_packs
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- An AUT University R&D project team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Service Pack plugin
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- app/assets/javascripts/assigns.js
+- app/assets/javascripts/service_packs.js
+- app/assets/stylesheets/assigns.css
+- app/assets/stylesheets/service_packs.css
+- app/controllers/assigns_controller.rb
+- app/controllers/service_packs_controller.rb
+- app/helpers/service_pack_presenter.rb
+- app/helpers/service_pack_report.rb
+- app/helpers/service_packs_notification.rb
+- app/helpers/sp_assignment_manager.rb
+- app/mailers/application_mailer.rb
+- app/mailers/service_packs_mailer.rb
+- app/models/application_record.rb
+- app/models/assign.rb
+- app/models/mapping_rate.rb
+- app/models/service_pack.rb
+- app/models/service_pack_entry.rb
+- app/views/assigns/already_assigned.html.erb
+- app/views/assigns/not_assigned_yet.html.erb
+- app/views/assigns/unassignable.html.erb
+- app/views/layouts/mailer.html.erb
+- app/views/layouts/mailer.text.erb
+- app/views/service_packs/_active_assignments.html.erb
+- app/views/service_packs/_form.html.erb
+- app/views/service_packs/_rates_input.html.erb
+- app/views/service_packs/edit.html.erb
+- app/views/service_packs/index.html.erb
+- app/views/service_packs/new.html.erb
+- app/views/service_packs/show.html.erb
+- app/views/service_packs_mailer/expired_email.html.erb
+- app/views/service_packs_mailer/expired_email.text.erb
+- app/views/service_packs_mailer/notify_under_threshold1.html.erb
+- app/views/service_packs_mailer/notify_under_threshold1.text.erb
+- app/views/service_packs_mailer/notify_under_threshold2.html.erb
+- app/views/service_packs_mailer/notify_under_threshold2.text.erb
+- app/views/service_packs_mailer/used_up_email.html.erb
+- app/views/service_packs_mailer/used_up_email.text.erb
+- app/workers/expired_sp_worker.rb
+- app/workers/used_up_service_pack_job.rb
+- config/application.rb
+- config/routes.rb
+- config/schedule.example.rb
+- config/schedule.rb
+- config/sidekiq.yml
+- db/migrate/20190108031704_create_assigns.rb
+- db/migrate/20190108031712_create_service_packs.rb
+- db/migrate/20190108111243_create_mapping_rates.rb
+- db/migrate/20190113111300_rename_assign.rb
+- db/migrate/20190116085528_create_service_pack_entries.rb
+- db/migrate/20190121072000_final_assigns_table.rb
+- db/migrate/20190123150023_add_service_pack_ref_to_service_pack_entries.rb
+- db/migrate/20190123205130_feature_a_done.rb
+- db/migrate/20190301070654_change_units_of_service_pack_entries.rb
+- db/migrate/20190301071911_change_total_and_remained_units_of_service_pack.rb
+- lib/open_project/service_packs.rb
+- lib/open_project/service_packs/engine.rb
+- lib/open_project/service_packs/patches.rb
+- lib/open_project/service_packs/patches/enumeration_patch.rb
+- lib/open_project/service_packs/patches/project_patch.rb
+- lib/open_project/service_packs/patches/time_entry_activity_patch.rb
+- lib/open_project/service_packs/patches/time_entry_patch.rb
+- lib/open_project/service_packs/version.rb
+- lib/openproject-service_packs.rb
+homepage: https://gits.fromlabs.com/openproject/service-pack
+licenses:
+- GPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Allow to track units of service packs when logging time on tasks
+test_files: []