ecom_core 1.1.16 → 1.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe250f7096d4de2dbcce2ab0e9ad159f107812cf69768fa6cd92962c8c80c937
-  data.tar.gz: 29bba333d43472d8339ad18a0ecd9e238a72b705c13fd86ae283ac095d9adf0b
+  metadata.gz: 20baeb3e84b28e3138d9d2b64cc0f91afe5e3e79361baa4564b280eca1d7db92
+  data.tar.gz: 714499d1b00181a32b8ac85dd2a469d3474ec590ac4c0bb958d655285420647a
 SHA512:
-  metadata.gz: 981a42e43a0beeef91423b2f282c2908dd516d1c4ee56d5ad55cf6275221f3962e2ba1eacb7861d63bdb5ae4805041f1e786f321473696f540c927b8c8472b8f
-  data.tar.gz: 2a84218270b5001b34d02c16e4a5c6cfc6fc0e9d47651389e2851524bf4e6910dc8e99b6578e2d52dd7996802c06953f266034df6652a42c97c8e6608e48f162
+  metadata.gz: 99fa344c2db5b7a704eed5cf9191c9f620f95b0f74cb1e38da9c121e91b6d3b477b1b8bea16387647f0bda528054f8b6ae55276a74944bf08998c070d660a4a7
+  data.tar.gz: 1959a1648e993edd98fa846391b38bc967c8844fde3b85ab9c99dde4bbbed683bcb9c57ce215fc2657348a36eb3b539a7dfdb878dd73df022a21d4bcdc4bee6b

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

@@ -10,19 +10,24 @@ module Ecom
 
       has_many :attendance_sheet_entries
 
-      scope :open, -> { find_by(status: OPEN) }
-      scope :current_open, -> { where(status: OPEN, date: Date.today) }
+      scope :open, -> { where(status: OPEN) }
+      scope :current, -> { where(date: Date.today) }
+      scope :current_open, -> { open.current }
+
+      def self.open_for_date(date)
+        AttendanceSheet.find_by(status: OPEN, date: date)
+      end
 
       def self.open_exists?
-        AttendanceSheet.where(status: OPEN).exists?
+        AttendanceSheet.open.exists?
       end
 
       def self.exists_for_today?
-        AttendanceSheet.where(date: Date.today).exists?
+        AttendanceSheet.current.exists?
       end
 
       def self.open_exists_for_today?
-        where(status: OPEN, date: Date.today).exists?
+        AttendanceSheet.current_open.exists?
       end
 
       # Attendance sheet should be created using the
@@ -53,13 +58,14 @@ module Ecom
       # to submit the attendance sheet after the date has
       # passed. Normally, timekeepers need to open and close
       # an attendance sheet of a date on the specific date.
-      def submit
-        raise 'This attendance sheet is not open. Therefore it cannot be submitted' unless status == OPEN
+      def self.submit(date)
+        sheet = AttendanceSheet.open_for_date(date)
+        raise 'There is no open attendance sheet to submit for the selected day.' unless sheet
 
-        self.closed_at = Time.now
-        self.status = SUBMITTED
-        save
-        self
+        sheet.closed_at = Time.now
+        sheet.status = SUBMITTED
+        sheet.save
+        sheet
       end
     end
   end

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

@@ -0,0 +1,21 @@
+module Ecom
+  module Core
+    class CrewOvertime < ApplicationRecord
+      belongs_to :overtime_type
+      belongs_to :overtime_sheet_entry
+      belongs_to :revision_to, class_name: 'Ecom::Core::CrewOvertime', optional: true
+      belongs_to :created_by, class_name: 'Ecom::Core::User'
+
+      has_one :revision, class_name: 'Ecom::Core::CrewOvertime', foreign_key: :revision_to_id
+
+      validates :hours, :raw_hours, presence: true
+
+      before_save :calculate_hours
+
+      def calculate_hours
+        rate = OvertimeType.find(overtime_type_id).rate
+        self.hours = raw_hours * rate
+      end
+    end
+  end
+end

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

@@ -1,26 +1,52 @@
 module Ecom
   module Core
     class CrewTime < ApplicationRecord
+      # Time Ranges
+      MORNING = 'Morning'.freeze
+      AFTERNOON = 'Afternoon'.freeze
+      BOTH = 'Both'.freeze
+
+      TIME_RANGE = {
+        MORNING => {start: Time.parse('8:00 AM'), end: Time.parse('12:00 PM')},
+        AFTERNOON => {start: Time.parse('1:00 PM'), end: Time.parse('5:00 PM')},
+        BOTH => {start: Time.parse('8:00 AM'), end: Time.parse('5:00 PM')}
+      }.freeze
+
       belongs_to :attendance_sheet_entry
-      belongs_to :overtime_type, optional: true
+      belongs_to :revision_to, class_name: 'Ecom::Core::CrewTime', optional: true
+      belongs_to :created_by, class_name: 'Ecom::Core::User'
+      has_one :revision, class_name: 'Ecom::Core::CrewTime', foreign_key: :revision_to_id
+
+      validates :hours, presence: true
 
-      validates :hours, :converted_hours, presence: true
-      # validates_each :date do |record, attr, value|
-      #   if record.crew && value && (value < record.crew.employment_date)
-      #     record.errors.add(attr, 'should be after employment date')
-      #   end
-      # end
+      before_save :calculate_hours
 
-      before_save :calculate_converted_hours
+      def calculate_hours
+        self.hours = checkout_time.nil? ? 0 : compute_hours
+      end
 
-      def calculate_converted_hours
-        if overtime
-          rate = OvertimeType.find(overtime_type_id).rate
-          self.converted_hours = hours * rate
+      # A method to check if checkin and checkout range falls in the morning,
+      # afternoon, or both.
+      def find_range
+        if checkin_time.before?(TIME_RANGE[MORNING][:end]) && checkout_time.before?(TIME_RANGE[AFTERNOON][:start])
+          MORNING
+        elsif checkin_time.after?(TIME_RANGE[MORNING][:end]) && checkout_time.after?(TIME_RANGE[AFTERNOON][:start])
+          AFTERNOON
         else
-          self.converted_hours = hours
+          BOTH
         end
       end
+
+      # A method to adjust time ranges by trimming any time value outside
+      # of the defined morning and afternoon ranges
+      def compute_hours
+        range = find_range
+        left = checkin_time.before?(TIME_RANGE[range][:start]) ? TIME_RANGE[range][:start] : checkin_time
+        right = checkout_time.after?(TIME_RANGE[range][:end]) ? TIME_RANGE[range][:end] : checkout_time
+        time = (right - left) / 1.hour
+        time -= 1 if range == BOTH
+        time
+      end
     end
   end
 end

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

@@ -0,0 +1,42 @@
+module Ecom
+  module Core
+    class OvertimeSheet < ApplicationRecord
+      OPEN = 'Open'.freeze
+      SUBMITTED = 'Submitted'.freeze
+      APPROVED = 'Approved'.freeze
+
+      validates :date, :opened_at, presence: true, uniqueness: true
+      validates :status, inclusion: [OPEN, SUBMITTED, APPROVED]
+
+      has_many :overtime_sheet_entries
+
+      scope :open, -> { where(status: OPEN) }
+      scope :for_date, ->(date) { where(date: date) }
+
+      def self.open_exists?
+        OvertimeSheet.open.exists?
+      end
+
+      def self.open_for_date_exists?(date)
+        OvertimeSheet.open.for_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)
+        if OvertimeSheet.open_for_date_exists?(date)
+          raise 'There is already an open overtime sheet for the selected date.'
+        end
+
+        if OvertimeSheet.open_exists?
+          raise 'There is already an open overtime sheet. It has to be submitted before creating a new one.'
+        end
+
+        OvertimeSheet.create(date: date, opened_at: Time.now, status: OPEN)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Ecom
+  module Core
+    class OvertimeSheetEntry < ApplicationRecord
+      belongs_to :overtime_sheet
+      belongs_to :crew
+      has_many :crew_overtimes
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module Ecom
       has_and_belongs_to_many :user_roles, join_table: 'ecom_core_users_user_roles'
 
       VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i.freeze
-      validates :first_name, :last_name, :active, presence: true
+      validates :first_name, :last_name, presence: true
       validates :email, presence: true, format: { with: VALID_EMAIL_REGEX }, uniqueness: { case_sensitive: false }
       validates :password, presence: true, length: { minimum: 6 }, confirmation: true, if: :password
 

data/db/migrate/20200410090701_create_ecom_core_overtime_sheets.rb

@@ -0,0 +1,12 @@
+class CreateEcomCoreOvertimeSheets < ActiveRecord::Migration[6.0]
+  def change
+    create_table :ecom_core_overtime_sheets do |t|
+      t.date :date, null: false, unique: true
+      t.time :opened_at, null: false
+      t.time :submitted_at
+      t.string :status, null: false, default: 'Open'
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200410100035_create_ecom_core_overtime_sheet_entries.rb

@@ -0,0 +1,14 @@
+class CreateEcomCoreOvertimeSheetEntries < ActiveRecord::Migration[6.0]
+  def change
+    create_table :ecom_core_overtime_sheet_entries do |t|
+      t.references :overtime_sheet, null: false, index: { name: 'ose_on_os_indx' }
+      t.references :crew, null: false, index: { name: 'ose_on_crew_indx' }
+      t.float :total_overtime
+
+      t.timestamps
+    end
+    add_foreign_key :ecom_core_overtime_sheet_entries, :ecom_core_overtime_sheets,
+                    column: :overtime_sheet_id
+    add_foreign_key :ecom_core_overtime_sheet_entries, :ecom_core_crews, column: :crew_id
+  end
+end

data/db/migrate/20200410111827_create_ecom_core_crew_overtimes.rb

@@ -0,0 +1,21 @@
+class CreateEcomCoreCrewOvertimes < ActiveRecord::Migration[6.0]
+  def change
+    create_table :ecom_core_crew_overtimes do |t|
+      t.float :hours, null: false
+      t.float :converted_hours, null: false, default: 0
+      t.string :remark
+      t.references :overtime_type, null: false, index: { name: 'ot_on_co_indx' }
+      t.references :overtime_sheet_entry, null: false, index: { name: 'ose_on_co_indx' }
+      t.boolean :revised, null: false, default: false
+      t.references :revision_to, null: true
+      t.references :created_by, null: false, index: { name: 'cb_on_co_indx' }
+
+      t.timestamps
+    end
+    add_foreign_key :ecom_core_crew_overtimes, :ecom_core_overtime_types, column: :overtime_type_id
+    add_foreign_key :ecom_core_crew_overtimes, :ecom_core_overtime_sheet_entries,
+                    column: :overtime_sheet_entry_id
+    add_foreign_key :ecom_core_crew_overtimes, :ecom_core_crew_overtimes, column: :revision_to_id
+    add_foreign_key :ecom_core_crew_overtimes, :ecom_core_users, column: :created_by_id
+  end
+end

data/db/migrate/20200413144023_fix_crew_time_columns.rb

@@ -0,0 +1,17 @@
+class FixCrewTimeColumns < ActiveRecord::Migration[6.0]
+  def change
+    remove_column :ecom_core_crew_times, :overtime, :boolean
+    remove_column :ecom_core_crew_times, :overtime_type_id, :integer
+    remove_column :ecom_core_crew_times, :converted_hours, :float
+
+    add_column :ecom_core_crew_times, :revised, :boolean, default: false, null: false
+    add_column :ecom_core_crew_times, :revision_to_id, :integer
+    add_column :ecom_core_crew_times, :created_by_id, :integer
+
+    add_index :ecom_core_crew_times, :revision_to_id, name: 'ct_on_rt_indx'
+    add_index :ecom_core_crew_times, :created_by_id, name: 'cb_on_ct_indx'
+
+    add_foreign_key :ecom_core_crew_times, :ecom_core_crew_times, column: :revision_to_id
+    add_foreign_key :ecom_core_crew_times, :ecom_core_users, column: :created_by_id
+  end
+end

data/db/migrate/20200414044144_adjust_crew_overtime_column_names.rb

@@ -0,0 +1,6 @@
+class AdjustCrewOvertimeColumnNames < ActiveRecord::Migration[6.0]
+  def change
+    rename_column :ecom_core_crew_overtimes, :hours, :raw_hours
+    rename_column :ecom_core_crew_overtimes, :converted_hours, :hours
+  end
+end

data/db/migrate/20200414185248_change_time_columns_to_datetime.rb

@@ -0,0 +1,6 @@
+class ChangeTimeColumnsToDatetime < ActiveRecord::Migration[6.0]
+  def change
+    change_column :ecom_core_crew_times, :checkin_time, :datetime
+    change_column :ecom_core_crew_times, :checkout_time, :datetime
+  end
+end

data/lib/ecom/core/version.rb

@@ -1,5 +1,5 @@
 module Ecom
   module Core
-    VERSION = '1.1.16'.freeze
+    VERSION = '1.1.21'.freeze
   end
 end

data/lib/ecom_core.rb

@@ -3,4 +3,3 @@ require 'ecom/core/engine'
 require 'ancestry'
 require 'aasm'
 require 'active_model_serializers'
-require 'data_migrate'

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

@@ -0,0 +1,12 @@
+FactoryBot.define do
+  factory :crew_overtime, class: 'Ecom::Core::CrewOvertime' do
+    raw_hours { 2 }
+    hours { 2 }
+    remark { FFaker::Name.name }
+    association :overtime_type
+    association :overtime_sheet_entry
+    revised { false }
+    revision_to { nil }
+    association :created_by, factory: :user
+  end
+end

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

@@ -3,10 +3,10 @@ FactoryBot.define do
     checkin_time { Time.now }
     checkout_time { Time.now + 2 * 60 * 60 }
     hours { 2 }
-    converted_hours { 2 }
     remark { FFaker::Name.name }
-    overtime { false }
-    overtime_type { nil }
     association :attendance_sheet_entry
+    revised { false }
+    revision_to { nil }
+    association :created_by, factory: :user
   end
 end

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

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :overtime_sheet_entry, class: 'Ecom::Core::OvertimeSheetEntry' do
+    association :overtime_sheet
+    association :crew
+    total_overtime { FFaker::Random.rand(0..8) }
+  end
+end

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

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :overtime_sheet, class: 'Ecom::Core::OvertimeSheet' do
+    date { Date.today }
+    opened_at { Time.now }
+    submitted_at { Time.now + 1.day }
+    status { Ecom::Core::OvertimeSheet::OPEN }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecom_core
 version: !ruby/object:Gem::Version
-  version: 1.1.16
+  version: 1.1.21
 platform: ruby
 authors:
 - Henock L.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-10 00:00:00.000000000 Z
+date: 2020-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ancestry
+  name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
-  name: bcrypt
+  name: ancestry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: active_model_serializers
+  name: bcrypt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 6.0.2
-- !ruby/object:Gem::Dependency
-  name: data_migrate
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -219,6 +205,7 @@ files:
 - app/models/ecom/core/attendance_sheet.rb
 - app/models/ecom/core/attendance_sheet_entry.rb
 - app/models/ecom/core/crew.rb
+- app/models/ecom/core/crew_overtime.rb
 - app/models/ecom/core/crew_time.rb
 - app/models/ecom/core/crew_type.rb
 - app/models/ecom/core/currency.rb
@@ -234,6 +221,8 @@ files:
 - app/models/ecom/core/lookup.rb
 - app/models/ecom/core/material_type.rb
 - app/models/ecom/core/menu.rb
+- app/models/ecom/core/overtime_sheet.rb
+- app/models/ecom/core/overtime_sheet_entry.rb
 - app/models/ecom/core/overtime_type.rb
 - app/models/ecom/core/payment.rb
 - app/models/ecom/core/payment_detail.rb
@@ -261,7 +250,6 @@ files:
 - app/services/ecom/core/token_auth_service.rb
 - config/database.ci.yml
 - config/routes.rb
-- db/data/20200401064242_move_date_to_attendance_sheet.rb
 - db/migrate/20190101112620_create_ecom_core_lookups.rb
 - db/migrate/20190101112625_create_ecom_core_overtime_types.rb
 - db/migrate/20191119010518_create_ecom_core_task_template_types.rb
@@ -303,6 +291,12 @@ files:
 - db/migrate/20200401122539_create_ecom_core_attendance_sheet_entries.rb
 - db/migrate/20200401142959_relate_crew_time_with_attendance_sheet_entry.rb
 - db/migrate/20200401144137_remove_crew_time_id_from_crew.rb
+- db/migrate/20200410090701_create_ecom_core_overtime_sheets.rb
+- db/migrate/20200410100035_create_ecom_core_overtime_sheet_entries.rb
+- db/migrate/20200410111827_create_ecom_core_crew_overtimes.rb
+- db/migrate/20200413144023_fix_crew_time_columns.rb
+- db/migrate/20200414044144_adjust_crew_overtime_column_names.rb
+- db/migrate/20200414185248_change_time_columns_to_datetime.rb
 - lib/ecom/core.rb
 - lib/ecom/core/engine.rb
 - lib/ecom/core/version.rb
@@ -311,6 +305,7 @@ files:
 - spec/factories/ecom/core/application_modules.rb
 - spec/factories/ecom/core/attendance_sheet_entries.rb
 - spec/factories/ecom/core/attendance_sheets.rb
+- spec/factories/ecom/core/crew_overtimes.rb
 - spec/factories/ecom/core/crew_times.rb
 - spec/factories/ecom/core/crew_types.rb
 - spec/factories/ecom/core/crews.rb
@@ -327,6 +322,8 @@ files:
 - spec/factories/ecom/core/lookups.rb
 - spec/factories/ecom/core/material_types.rb
 - spec/factories/ecom/core/menus.rb
+- spec/factories/ecom/core/overtime_sheet_entries.rb
+- spec/factories/ecom/core/overtime_sheets.rb
 - spec/factories/ecom/core/overtime_types.rb
 - spec/factories/ecom/core/payment_details.rb
 - spec/factories/ecom/core/payments.rb

data/db/data/20200401064242_move_date_to_attendance_sheet.rb

@@ -1,20 +0,0 @@
-class MoveDateToAttendanceSheet < ActiveRecord::Migration[6.0]
-  def up
-    dates = Ecom::Core::CrewTime.pluck('DISTINCT date(date)')
-
-    return if dates.count.zero?
-
-    attendances = []
-    dates.each do |date|
-      attendances << Ecom::Core::AttendanceSheet.new(date: date)
-    end
-
-    Ecom::Core::AttendanceSheet.transaction do
-      attendances.each(&:save)
-    end
-  end
-
-  def down
-    raise ActiveRecord::IrreversibleMigration
-  end
-end