ecom_core 1.2.17 → 1.2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4ad578f6c6d7aece965edd8d3ad059afb16ff3f90445ba63f55c6afdc530b8f
-  data.tar.gz: a31af1754f7ccdc5669a1fe5747745bb8d98d0e82371db261bee62cd08d50f38
+  metadata.gz: 226d69727b3ecb4a8edfb5fc4c4a92fb6c91ff999d928f5509acaa9da26ec19a
+  data.tar.gz: bb35268fa5cda39ace0d06240ad53f06da6845076df4e23041b6bd3ce147a36b
 SHA512:
-  metadata.gz: 7720605e3fa55dd2ff8d12358a5ece0c11f11c47647b4ac1b9be6ca35d308592d3e2ffef33c9beea298c149f5abb301f0612a194934539ab357c78699529d3cb
-  data.tar.gz: 4c1a5cf5b05c9a8f247fb0b457b9904b9e98bb884a0b5e8a8da38b8268ae7177f631c51ab905dc947042f7117b1f8bf1525a1b92b76d3b1423c24ee157f0af5f
+  metadata.gz: 6069a79e8aa94eae4e49e9a68d0783a366fdb92c355d3d73ed4fdbd0ab2feaeb3f2c4c3678d8fda11a0cf7d25b783a89677d213752b1c9e5909e84f3491e52c6
+  data.tar.gz: cf82927e16d1809c43760e3238202a87df93c10ae89b06cc482e598758c933d4368ecab45b8fb1d38c4dfec10180ae35e87e8ad785bde60d6329eac9e4c81c2f

data/app/models/ecom/core/attendance_sheet.rb

@@ -61,7 +61,7 @@ module Ecom
 
         raise 'There is no open attendance sheet to submit.' if sheet.nil?
 
-        sheet.closed_at = Time.now
+        sheet.submitted_at = DateTime.now
         sheet.status = StatusConstants::SUBMITTED
         sheet.save
         sheet
@@ -75,11 +75,27 @@ module Ecom
         sheet = AttendanceSheet.open_for_date(date, project_id)
         raise 'There is no open attendance sheet to submit for the selected day.' unless sheet
 
-        sheet.closed_at = Time.now
+        sheet.submitted_at = DateTime.now
         sheet.status = StatusConstants::SUBMITTED
         sheet.save
         sheet
       end
+
+      def submit
+        raise 'Attendance sheet is not open and cannot be submitted' if status != StatusConstants::OPEN
+
+        self.submitted_at = DateTime.now
+        self.status = StatusConstants::SUBMITTED
+        save
+      end
+
+      def approve
+        raise 'Attendance sheet is not submitted and cannot be approved' unless status == StatusConstants::SUBMITTED
+
+        self.status = StatusConstants::APPROVED
+        self.approved_at = DateTime.now
+        save
+      end
     end
   end
 end

data/app/models/ecom/core/company.rb

@@ -1,10 +1,33 @@
 module Ecom
   module Core
     class Company < ApplicationRecord
+      # The settings attribute is a json string containing setting key value
+      # pairs. The valid settings are:
+      #   payroll_periods => a list of payroll period values. Each
+      #                      payroll period has the following entries:
+      #     order: A numeric value indicating the order of the period.
+      #     date: A numeric value indicating the date of each month which
+      #           upto which timesheet data is used for payroll calculation
+      #           for the specific period.
+      #     comparison: One of [:exact, :days_before_month_end]. :exact will
+      #            force calculations to be made upto the exact mentioned date
+      #            value, whereas :days_before_month_end is often used for last
+      #            period payroll calculation and we want to specify on which date
+      #            before the end of the month we have to limit timesheet data to
+      #            calculate payroll. E.g. 3 days before month end would be 27th
+      #            for september and 28th for october.
+      #
+      #   period_count - the total number of periods per month for payroll.
+      #            this value should align with the defined payroll periods.
+      #
       has_many :projects
 
       validates :code, :name, :address, :telephone, presence: true
       validates :code, :name, uniqueness: true
+
+      def valid_settings?
+        settings['payroll_periods'].count == settings['period_count']
+      end
     end
   end
 end

data/app/models/ecom/core/crew_time.rb

@@ -2,15 +2,15 @@ module Ecom
   module Core
     class CrewTime < ApplicationRecord
       # Time Ranges
-      MORNING = 'Morning'.freeze
-      AFTERNOON = 'Afternoon'.freeze
-      BOTH = 'Both'.freeze
+      MORNING = :morning
+      AFTERNOON = :afternoon
+      FULL_DAY = :full_day
 
-      TIME_RANGE = {
-        MORNING => { start: Time.zone.parse('5:00 AM'), end: Time.zone.parse('9:00 AM') },
-        AFTERNOON => { start: Time.zone.parse('10:00 AM'), end: Time.zone.parse('2:00 PM') },
-        BOTH => { start: Time.zone.parse('5:00 AM'), end: Time.zone.parse('2:00 PM') }
-      }.freeze
+      # TIME_RANGE = {
+      #   MORNING => { start: Time.zone.parse('5:00 AM'), end: Time.zone.parse('9:00 AM') },
+      #   AFTERNOON => { start: Time.zone.parse('10:00 AM'), end: Time.zone.parse('2:00 PM') },
+      #   BOTH => { start: Time.zone.parse('5:00 AM'), end: Time.zone.parse('2:00 PM') }
+      # }.freeze
 
       belongs_to :attendance_sheet_entry
       belongs_to :revision_to, class_name: 'Ecom::Core::CrewTime', optional: true
@@ -47,15 +47,42 @@ module Ecom
         attendance_sheet_entry.save
       end
 
+      # A method to get the available time ranges at a given point.
+      # We cannot define the range variables as a constant because
+      # the parsing should be done at the exact moment we are about
+      # to do time range calculations to avoid errors caused by date
+      # mismatches
+      def define_range
+        morning = {
+          start: Time.zone.parse('5:00 AM'),
+          finish: Time.zone.parse('9:00 AM')
+        }
+        afternoon = {
+          start: Time.zone.parse('10:00 AM'),
+          finish: Time.zone.parse('2:00 PM')
+        }
+        full_day = {
+          start: Time.zone.parse('5:00 AM'),
+          finish: Time.zone.parse('2:00 PM')
+        }
+
+        {
+          morning: morning,
+          afternoon: afternoon,
+          full_day: full_day
+        }
+      end
+
       # A method to check if checkin and checkout range falls in the morning,
       # afternoon, or both.
       def find_range(start, finish)
-        if start.before?(TIME_RANGE[MORNING][:end]) && finish.before?(TIME_RANGE[AFTERNOON][:start])
-          MORNING
-        elsif start.after?(TIME_RANGE[MORNING][:end]) && finish.after?(TIME_RANGE[AFTERNOON][:start])
-          AFTERNOON
+        range = define_range
+        if start.before?(range[:morning][:finish]) && finish.before?(range[:afternoon][:start])
+          :morning
+        elsif start.after?(range[:morning][:finish]) && finish.after?(range[:afternoon][:start])
+          :afternoon
         else
-          BOTH
+          :full_day
         end
       end
 
@@ -63,13 +90,14 @@ module Ecom
       # of the defined morning and afternoon ranges
       def compute_hours
         # Reparse time to avoid errors caused by date differences
+        range = define_range
         start = Time.zone.parse(checkin_time.strftime('%I:%M%p'))
         finish = Time.zone.parse(checkout_time.strftime('%I:%M%p'))
-        range = find_range(start, finish)
-        left = start.before?(TIME_RANGE[range][:start]) ? TIME_RANGE[range][:start] : start
-        right = finish.after?(TIME_RANGE[range][:end]) ? TIME_RANGE[range][:end] : finish
+        day_part = find_range(start, finish)
+        left = start.before?(range[day_part][:start]) ? range[day_part][:start] : start
+        right = finish.after?(range[day_part][:finish]) ? range[day_part][:finish] : finish
         time = (right - left) / 1.hour
-        time -= 1 if range == BOTH
+        time -= 1 if day_part == FULL_DAY
         time
       end
     end

data/app/models/ecom/core/overtime_sheet.rb

@@ -24,14 +24,18 @@ module Ecom
         OvertimeSheet.open(project_id).where(date: date).exists?
       end
 
+      def self.exists_for_date?(date, project_id)
+        OvertimeSheet.by_project(project_id).by_date(date).exists?
+      end
+
       # Overtime sheet should be created using the
       # method below only. This is because we need to
       # check if there is an open overtime already,
       # and also that we have only one open overtime
       # sheet at a time.
       def self.create_new(date, project_id)
-        if OvertimeSheet.open_for_date_exists?(date, project_id)
-          raise 'There is already an open overtime sheet for the selected date.'
+        if OvertimeSheet.exists_for_date?(date, project_id)
+          raise 'There is already an overtime sheet for the selected date.'
         end
 
         if OvertimeSheet.open_exists?(project_id)
@@ -40,6 +44,22 @@ module Ecom
 
         OvertimeSheet.create(date: date, opened_at: Time.now, status: StatusConstants::OPEN, project_id: project_id)
       end
+
+      def submit
+        raise 'Overtime sheet is not open and cannot be submitted' if status != StatusConstants::OPEN
+
+        self.submitted_at = DateTime.now
+        self.status = StatusConstants::SUBMITTED
+        save
+      end
+
+      def approve
+        raise 'Overtime sheet is not submitted and cannot be approved' unless status == StatusConstants::SUBMITTED
+
+        self.status = StatusConstants::APPROVED
+        self.approved_at = DateTime.now
+        save
+      end
     end
   end
 end

data/app/models/ecom/core/payment.rb

@@ -7,6 +7,8 @@ module Ecom
 
       before_validation :set_payment_order
 
+      scope :by_status, ->(status) { where(approved: status) }
+
       def set_payment_order
         unless payroll
           self.payment_order = 1

data/app/models/ecom/core/payroll.rb

@@ -9,6 +9,16 @@ module Ecom
       scope :by_project, ->(id) { where(project_id: id) }
       scope :by_month, ->(month) { where(month: month) }
       scope :by_year, ->(year) { where(year: year) }
+
+      def create_next
+        m = month + 1
+        y = year
+        if m > 12
+          m = 1
+          y += 1
+        end
+        Payroll.create(month: m, year: y)
+      end
     end
   end
 end

data/db/migrate/20190101085530_create_ecom_core_companies.rb

@@ -6,7 +6,7 @@ class CreateEcomCoreCompanies < ActiveRecord::Migration[6.0]
       t.string :address, null: false
       t.string :telephone, null: false
       t.string :email
-      t.json :settings
+      t.jsonb :settings, default: {}
 
       t.timestamps
     end

data/db/migrate/20191225140433_create_ecom_core_attendance_sheets.rb

@@ -2,8 +2,9 @@ class CreateEcomCoreAttendanceSheets < ActiveRecord::Migration[6.0]
   def change
     create_table :ecom_core_attendance_sheets do |t|
       t.date :date, null: false
-      t.time :opened_at, null: false
-      t.time :closed_at
+      t.datetime :opened_at, null: false
+      t.datetime :submitted_at
+      t.datetime :approved_at
       t.string :remark
       t.string :status, null: false, default: 'Open'
       t.references :project,

data/db/migrate/20200410090701_create_ecom_core_overtime_sheets.rb

@@ -2,8 +2,9 @@ class CreateEcomCoreOvertimeSheets < ActiveRecord::Migration[6.0]
   def change
     create_table :ecom_core_overtime_sheets do |t|
       t.date :date, null: false
-      t.time :opened_at, null: false
-      t.time :submitted_at
+      t.datetime :opened_at, null: false
+      t.datetime :submitted_at
+      t.datetime :approved_at
       t.string :remark
       t.string :status, null: false, default: 'Open'
       t.references :project,

data/lib/ecom/core/version.rb

@@ -1,5 +1,5 @@
 module Ecom
   module Core
-    VERSION = '1.2.17'.freeze
+    VERSION = '1.2.22'.freeze
   end
 end

data/spec/factories/ecom/core/application_modules.rb

@@ -3,6 +3,8 @@ FactoryBot.define do
     sequence :code do |n|
       "AMCode#{n}"
     end
-    name { FFaker::Name.name }
+    sequence :name do |n|
+      "AMName#{n}"
+    end
   end
 end

data/spec/factories/ecom/core/attendance_sheets.rb

@@ -1,8 +1,9 @@
 FactoryBot.define do
   factory :attendance_sheet, class: Ecom::Core::AttendanceSheet do
     date { Date.today }
-    opened_at { Time.now }
-    closed_at { nil }
+    opened_at { DateTime.now }
+    submitted_at { nil }
+    approved_at { nil }
     remark { FFaker::Name.name }
     status { Ecom::Core::StatusConstants::OPEN }
     association :project

data/spec/factories/ecom/core/companies.rb

@@ -3,9 +3,17 @@ FactoryBot.define do
     sequence :code do |n|
       "CCode#{n}"
     end
-    name { FFaker::Name.name }
+    sequence :name do |n|
+      "CName#{n}"
+    end
     address { FFaker::Address.street_address }
     telephone { FFaker::PhoneNumber.phone_number }
     email { FFaker::Internet.email }
+    settings do
+      {
+        payroll_periods: [{ order: 1, date: 25, comparison: :exact }],
+        period_count: 1
+      }
+    end
   end
 end

data/spec/factories/ecom/core/currencies.rb

@@ -1,6 +1,10 @@
 FactoryBot.define do
   factory :currency, class: Ecom::Core::Currency do
-    code { FFaker::Currency.code }
-    name { FFaker::Currency.name }
+    sequence :code do |n|
+      "CCode#{n}"
+    end
+    sequence :name do |n|
+      "CName#{n}"
+    end
   end
 end

data/spec/factories/ecom/core/equipment.rb

@@ -1,6 +1,8 @@
 FactoryBot.define do
   factory :equipment, class: Ecom::Core::Equipment do
-    name { FFaker::Name.name }
+    sequence :name do |n|
+      "EQName#{n}"
+    end
     description { FFaker::Name.name }
     minimum_acquisition_time { 10 }
     brands { ['Brand I', 'Brand II', 'Brand III'] }

data/spec/factories/ecom/core/equipment_categories.rb

@@ -1,6 +1,8 @@
 FactoryBot.define do
   factory :equipment_category, class: Ecom::Core::EquipmentCategory do
-    name { FFaker::Name.name }
+    sequence :name do |n|
+      "ECName#{n}"
+    end
     description { FFaker::Name.name }
     association :equipment_type
   end

data/spec/factories/ecom/core/equipment_locations.rb

@@ -1,6 +1,8 @@
 FactoryBot.define do
   factory :equipment_location, class: Ecom::Core::EquipmentLocation do
-    name { FFaker::Name.name }
+    sequence :name do |n|
+      "ELName#{n}"
+    end
     description { FFaker::Name.name }
     address { FFaker::Name.name }
     association :location_type

data/spec/factories/ecom/core/lookups.rb

@@ -1,6 +1,8 @@
 FactoryBot.define do
   factory :lookup, class: Ecom::Core::Lookup do
-    name { FFaker::Name.name }
+    sequence :name do |n|
+      "LName#{n}"
+    end
     type { 'Ecom::Core::Lookup' }
   end
 end

data/spec/factories/ecom/core/overtime_sheets.rb

@@ -1,8 +1,9 @@
 FactoryBot.define do
   factory :overtime_sheet, class: Ecom::Core::OvertimeSheet do
     date { Date.today }
-    opened_at { Time.now }
-    submitted_at { Time.now + 1.day }
+    opened_at { DateTime.now }
+    submitted_at { nil }
+    approved_at { nil }
     status { Ecom::Core::StatusConstants::OPEN }
     association :project
   end

data/spec/factories/ecom/core/overtime_types.rb

@@ -1,6 +1,8 @@
 FactoryBot.define do
   factory :overtime_type, class: Ecom::Core::OvertimeType do
-    name { FFaker::Name.name }
+    sequence :name do |n|
+      "OTName#{n}"
+    end
     from { '07:00 AM' }
     to { '08:00 AM' }
     rate { 1.5 }

data/spec/factories/ecom/core/product_groups.rb

@@ -1,6 +1,8 @@
 FactoryBot.define do
   factory :product_group, class: Ecom::Core::ProductGroup do
-    name { FFaker::Name.name }
+    sequence :name do |n|
+      "PGName#{n}"
+    end
     association :project
   end
 end

data/spec/factories/ecom/core/product_types.rb

@@ -1,6 +1,8 @@
 FactoryBot.define do
   factory :product_type, class: Ecom::Core::ProductType do
-    name { FFaker::Name.name }
+    sequence :name do |n|
+      "PTname#{n}"
+    end
     association :work_product_template
     dimension { [{ name: 'length', label: 'length' }, { name: 'width', label: 'width' }] }
   end

data/spec/factories/ecom/core/resource_types.rb

@@ -3,7 +3,9 @@ FactoryBot.define do
     sequence :code do |n|
       "RTCode#{n}"
     end
-    name { FFaker::Name.name }
+    sequence :name do |n|
+      "RTName#{n}"
+    end
     base_unit { FFaker::Name.name }
     type { 'Ecom::Core::CrewType' }
   end

data/spec/factories/ecom/core/stakeholder_types.rb

@@ -1,5 +1,7 @@
 FactoryBot.define do
   factory :stakeholder_type, class: Ecom::Core::StakeholderType do
-    name { FFaker::Name.name }
+    sequence :name do |n|
+      "STName#{n}"
+    end
   end
 end

data/spec/factories/ecom/core/stakeholders.rb

@@ -1,6 +1,8 @@
 FactoryBot.define do
   factory :stakeholder, class: Ecom::Core::Stakeholder do
-    name { FFaker::Name.unique.name }
+    sequence :name do |n|
+      "Stakeholder #{n}"
+    end
     type_of_business { FFaker::Name.name }
     address { FFaker::Name.name }
     license_no { FFaker::Name.name }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecom_core
 version: !ruby/object:Gem::Version
-  version: 1.2.17
+  version: 1.2.22
 platform: ruby
 authors:
 - Henock L.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2020-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm