ecom_core 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47ccd7e2c54144e923760559287513ba289fb117647a448890de1bcb9b971d67
+  data.tar.gz: b8e18049239a4241bf93aec57e0a57d451edacd791e11ad51ac2daf8cfaa0854
+SHA512:
+  metadata.gz: 7cea63bfb85af16d0171286a566101ecabe2f3bceab181400d6de20dede48c5766154c26bced86d8920eb64f3bde0b7cfc98657ae003a444290c6ec488cb9723
+  data.tar.gz: faa67d9ee5d399e3236b8d69af16c57021c464ec0a831890f3ae69b8d5710357455200cbfe7f7068124aab0aacf28e8e12da6aa287a1dcf7e7d63d0bdd3c11b4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Henock L.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Ecom Core
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ecom_core'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ecom_model
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EcomCore'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')

data/app/controllers/concerns/ecom/core/resource_typeable.rb

@@ -0,0 +1,43 @@
+module Ecom
+  module Core
+    module ResourceTypeable
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :set_clazz
+      end
+
+      def index
+        render json: ResourceTypeSerializer.new(@clazz.all)
+      end
+
+      def create
+        resource_type = @clazz.new(resource_type_params)
+        if resource_type.save
+          render json: ResourceTypeSerializer.new(resource_type), status: :created
+        else
+          render json: { success: false, errors: resource_type.errors }, status: :unprocessable_entity
+        end
+      end
+
+      def update
+        resource_type = @clazz.find(params[:id])
+        if resource_type.update(resource_type_params)
+          render json: ResourceTypeSerializer.new(resource_type)
+        else
+          render json: { success: false, errors: resource_type.errors }, status: :unprocessable_entity
+        end
+      end
+
+      private
+
+      def set_clazz
+        @clazz = "Ecom::Core::#{controller_name.classify}".constantize
+      end
+
+      def resource_type_params
+        params.require(:resource_type).permit(:code, :name, :base_unit)
+      end
+    end
+  end
+end

data/app/controllers/ecom/core/application_controller.rb

@@ -0,0 +1,7 @@
+module Ecom
+  module Core
+    class ApplicationController < ActionController::API
+      # protect_from_forgery with: :exception
+    end
+  end
+end

data/app/controllers/ecom/core/crew_types_controller.rb

@@ -0,0 +1,7 @@
+module Ecom
+  module Core
+    class CrewTypesController < ApplicationController
+      include ResourceTypeable
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Ecom
+  module Core
+    class ApplicationModule < ApplicationRecord
+      validates :code, :name, uniqueness: true
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Ecom
+  module Core
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Ecom
+  module Core
+    class Crew < ApplicationRecord
+      PERMANENT = 'Permanent'.freeze
+      TEMPORARY = 'Temporary'.freeze
+
+      belongs_to :crew_type
+
+      validates :name, :qualification, presence: true
+      validates :wage, presence: true, if: ->(o) { o.employment == PERMANENT }
+      validates :wage, absence: true, if: ->(o) { o.employment == TEMPORARY }
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Ecom
+  module Core
+    class CrewTime < ApplicationRecord
+      belongs_to :crew
+
+      validates :date, presence: true
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Ecom
+  module Core
+    class CrewType < ResourceType
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Ecom
+  module Core
+    class Currency < ApplicationRecord
+      validates :code, :name, presence: true, uniqueness: true
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Ecom
+  module Core
+    class EquipmentType < ResourceType
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Ecom
+  module Core
+    class MaterialType < ResourceType
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Ecom
+  module Core
+    class Menu < ApplicationRecord
+      belongs_to :parent, class_name: 'Ecom::Core::Menu', optional: true
+      belongs_to :application_module
+
+      validates :label, :route, presence: true
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Ecom
+  module Core
+    class ProductType < ApplicationRecord
+      belongs_to :work_product_template
+
+      validates :name, presence: true
+      validates :name, uniqueness: { scope: :work_product_template_id }
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Ecom
+  module Core
+    class Project < ApplicationRecord
+      belongs_to :employer, class_name: 'Ecom::Core::Stakeholder'
+      belongs_to :contractor, class_name: 'Ecom::Core::Stakeholder'
+      belongs_to :consultant, class_name: 'Ecom::Core::Stakeholder'
+      belongs_to :project_manager, class_name: 'Ecom::Core::Stakeholder'
+      belongs_to :task_template
+      belongs_to :currency
+  
+      validates :name, :location, :contract_number, :date_contract_signed, :commencement_date, :completion_date,
+                :contract_amount, :advance_payment, :retention, presence: true
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Ecom
+  module Core
+    class ResourceType < ApplicationRecord
+      validates :code, :name, :base_unit, :type, presence: true
+      validates :code, uniqueness: { scope: :type }
+      validates :name, uniqueness: { scope: :type }
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Ecom
+  module Core
+    class Stakeholder < ApplicationRecord
+      belongs_to :stakeholder_type
+
+      validates :name, presence: true, uniqueness: true
+
+      delegate :name, to: :stakeholder_type, prefix: true
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Ecom
+  module Core
+    class StakeholderType < ApplicationRecord
+      validates :name, presence: true, uniqueness: true
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Ecom
+  module Core
+    class Task < ApplicationRecord
+      belongs_to :project
+      belongs_to :task_template
+
+      validates :code, :name, presence: true
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Ecom
+  module Core
+    class TaskTemplate < ApplicationRecord
+      has_ancestry
+
+      belongs_to :task_template_type
+      has_one :work_product_template
+      has_and_belongs_to_many :resource_types, join_table: 'ecom_core_task_templates_resource_types'
+
+      validates :name, :code, presence: true
+      validates :code, uniqueness: true
+      delegate(:name, to: :task_template_type, prefix: true)
+
+      def full_name
+        parent_name = parent&.name
+        return name unless parent_name
+
+        "#{name} - #{parent_name}"
+      end
+
+      def crew_types
+        resource_types.where(type: 'Ecom::Core::CrewType')
+      end
+
+      def material_types
+        resource_types.where(type: 'Ecom::Core::MaterialType')
+      end
+
+      def equipment_types
+        resource_types.where(type: 'Ecom::Core::EquipmentType')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Ecom
+  module Core
+    class TaskTemplateType < ApplicationRecord
+      validates :code, :name, presence: true, uniqueness: true
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Ecom
+  module Core
+    class User < ApplicationRecord
+      has_secure_password
+
+      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 :email, presence: true, format: { with: VALID_EMAIL_REGEX }, uniqueness: { case_sensitive: false }
+      validates :password, length: { minimum: 6 }
+
+      def full_name
+        "#{first_name} #{last_name}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Ecom
+  module Core
+    class UserRole < ApplicationRecord
+      belongs_to :application_module
+      has_and_belongs_to_many :users, join_table: 'ecom_core_users_user_roles'
+      has_and_belongs_to_many :menus, join_table: 'ecom_core_menus_user_roles'
+
+      validates :name, presence: true
+      validates :name, uniqueness: { scope: :application_module_id }
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Ecom
+  module Core
+    class WorkComponent < ApplicationRecord
+      belongs_to :performer, class_name: 'Ecom::Core::User'
+      belongs_to :approver, class_name: 'Ecom::Core::User'
+      belongs_to :supervisor, class_name: 'Ecom::Core::User'
+      belongs_to :quality_controller, class_name: 'Ecom::Core::User'
+      belongs_to :work_component_template
+      belongs_to :work_product
+
+      validates :name, :assignment_status, :task_status, :percent_completed, presence: true
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Ecom
+  module Core
+    class WorkComponentTemplate < ApplicationRecord
+      belongs_to :work_product_template
+      belongs_to :task_template
+
+      validates :code, :name, presence: true
+      validates :code, uniqueness: { scope: %i[work_product_template_id task_template_id] }
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# The WorkProduct core represents a task being implemented on a specific
+# work product. To this regard, a work product is an assignable itself which
+# contains the basic product attributes (e.g. dimension, name, design reference)
+# on one hand, and task related attributes (e.g. start date and completion date)
+# on the other hand. A task may have multiple work products under it. It is
+# important to note that currently there is no direct way to link products and
+# sub products, as we have done with tasks and sub tasks. If there is a desire
+# to have such a link between products (e.g. we may later want to have reports
+# per specific high level products, which in turn asks for finding all sub products
+# under the selected high level product and do calculations), then a `code` field
+# has been introduced to the WorkProduct core. This field can be used in a similar
+# way as chart of accounts to identify parent and child relationships. Even then,
+# there needs to be a well defined coding scheme developed before using the column
+# field.
+# 
+module Ecom
+  module Core
+    class WorkProduct < ApplicationRecord
+      include AASM
+
+      belongs_to :work_product_template
+      belongs_to :task
+      belongs_to :project
+      belongs_to :performer, class_name: 'Ecom::Core::User'
+      belongs_to :approver, class_name: 'Ecom::Core::User'
+      belongs_to :supervisor, class_name: 'Ecom::Core::User'
+      belongs_to :quality_controller, class_name: 'Ecom::Core::User'
+
+      validates :name, presence: true
+      validates :design_reference_no, uniqueness: true
+
+      aasm column: 'task_status' do
+        state :new, initial: true
+        state :in_progress
+        state :submitted
+        state :under_review
+        state :completed
+
+        event :start do
+          transitions from: :new, to: :in_progress
+        end
+
+        event :submit do
+          transitions from: :in_progress, to: :submitted
+        end
+
+        event :review do
+          transitions from: :submitted, to: :under_review
+        end
+
+        event :complete do
+          transitions from: %i[submitted under_review], to: :completed
+        end
+
+        event :rework do
+          transitions from: :under_review, to: :in_progress
+        end
+      end
+
+      aasm column: 'assignment_status' do
+        state :unassigned, initial: true
+        state :assigned
+
+        event :assign do
+          transitions from: :unassigned, to: :assigned
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Ecom
+  module Core
+    class WorkProductTemplate < ApplicationRecord
+      validates :code, :name, presence: true, uniqueness: true
+      belongs_to :task_template
+      has_many :product_types
+
+      scope :filtered_by_template_type, lambda { |id|
+        joins(:task_template).where('ecom_core_task_templates.task_template_type_id = ?', id)
+                             .order(:code)
+      }
+    end
+  end
+end

data/app/serializers/ecom/core/resource_type_serializer.rb

@@ -0,0 +1,8 @@
+module Ecom
+  module Core
+    class ResourceTypeSerializer
+      include FastJsonapi::ObjectSerializer
+      attributes :code, :name, :base_unit, :type
+    end
+  end
+end

data/config/database.ci.yml

@@ -0,0 +1,12 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  pool: 5
+  timeout: 5000
+  host: <%= ENV['DB_HOST'] %>
+  username: <%= ENV['POSTGRES_USER'] %>
+  password: <%= ENV['POSTGRES_PASSWORD'] %>
+  database: <%= ENV['POSTGRES_DB'] %>
+
+test:
+  <<: *default

data/config/routes.rb

@@ -0,0 +1,3 @@
+Ecom::Core::Engine.routes.draw do
+  resources :crew_types
+end

data/db/migrate/20191119010518_create_ecom_core_task_template_types.rb

@@ -0,0 +1,13 @@
+class CreateEcomCoreTaskTemplateTypes < ActiveRecord::Migration[6.0]
+  def change
+    create_table :ecom_core_task_template_types do |t|
+      t.string :code, null: false
+      t.string :name, null: false
+
+      t.timestamps
+    end
+
+    add_index :ecom_core_task_template_types, :code, unique: true
+    add_index :ecom_core_task_template_types, :name, unique: true
+  end
+end

data/db/migrate/20191119012030_create_ecom_core_task_templates.rb

@@ -0,0 +1,15 @@
+class CreateEcomCoreTaskTemplates < ActiveRecord::Migration[6.0]
+  def change
+    create_table :ecom_core_task_templates do |t|
+      t.string :code, null: false
+      t.string :name, null: false
+      t.string :description
+      t.references :task_template_type, index: { name: 'ttt_on_tt_indx' }
+      t.string :ancestry, index: true
+
+      t.timestamps
+    end
+
+    add_foreign_key :ecom_core_task_templates, :ecom_core_task_template_types, column: :task_template_type_id
+  end
+end

data/db/migrate/20191119013236_create_ecom_core_work_product_templates.rb

@@ -0,0 +1,15 @@
+class CreateEcomCoreWorkProductTemplates < ActiveRecord::Migration[6.0]
+  def change
+    create_table :ecom_core_work_product_templates do |t|
+      t.string :code, null: false, unique: true
+      t.string :name, null: false, unique: true
+      t.string :description
+      t.string :remark
+      t.references :task_template, index: { name: 'tt_on_wpt_indx' }
+
+      t.timestamps
+    end
+
+    add_foreign_key :ecom_core_work_product_templates, :ecom_core_task_templates, column: :task_template_id
+  end
+end

data/db/migrate/20191119144141_create_ecom_core_stakeholder_types.rb

@@ -0,0 +1,10 @@
+class CreateEcomCoreStakeholderTypes < ActiveRecord::Migration[6.0]
+  def change
+    create_table :ecom_core_stakeholder_types do |t|
+      t.string :name, null: false, unique: true
+      t.string :description
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20191119144618_create_ecom_core_stakeholders.rb

@@ -0,0 +1,19 @@
+class CreateEcomCoreStakeholders < ActiveRecord::Migration[6.0]
+  def change
+    create_table :ecom_core_stakeholders do |t|
+      t.string :name, null: false, unique: true
+      t.string :type_of_business
+      t.string :address
+      t.string :license_no
+      t.string :tin_no
+      t.string :contact_name, null: false
+      t.string :contact_phone, null: false
+      t.string :contact_email, null: false
+      t.references :stakeholder_type, index: { name: 'em_stakeholders_on_type_indx' }
+
+      t.timestamps
+    end
+
+    add_foreign_key :ecom_core_stakeholders, :ecom_core_stakeholder_types, column: :stakeholder_type_id
+  end
+end

data/db/migrate/20191119145711_create_ecom_core_resource_types.rb

@@ -0,0 +1,15 @@
+class CreateEcomCoreResourceTypes < ActiveRecord::Migration[6.0]
+  def change
+    create_table :ecom_core_resource_types do |t|
+      t.string :code, null: false
+      t.string :name, null: false
+      t.string :base_unit, null: false
+      t.string :type, null: false
+
+      t.timestamps
+    end
+
+    add_index :ecom_core_resource_types, %i[code type], unique: true
+    add_index :ecom_core_resource_types, %i[name type], unique: true
+  end
+end

data/db/migrate/20191201131341_create_ecom_core_product_types.rb

@@ -0,0 +1,14 @@
+class CreateEcomCoreProductTypes < ActiveRecord::Migration[6.0]
+  def change
+    create_table :ecom_core_product_types do |t|
+      t.string :name, null: false
+      t.references :work_product_template, index: { name: 'pt_on_wpt_indx' }
+      t.json :dimension
+
+      t.timestamps
+    end
+
+    add_index :ecom_core_product_types, %i[name work_product_template_id], unique: true, name: 'wpt_on_pt_name_indx'
+    add_foreign_key :ecom_core_product_types, :ecom_core_work_product_templates, column: :work_product_template_id
+  end
+end

data/db/migrate/20191201134420_create_ecom_core_work_component_templates.rb

@@ -0,0 +1,23 @@
+class CreateEcomCoreWorkComponentTemplates < ActiveRecord::Migration[6.0]
+  def change
+    create_table :ecom_core_work_component_templates do |t|
+      t.string :code, null: false
+      t.string :name, null: false
+      t.string :description
+      t.integer :relative_percentage
+      t.json :dimension
+      t.references :work_product_template, index: { name: 'wct_on_wpt_indx' }
+      t.references :task_template, index: { name: 'wct_on_tt_indx' }
+
+      t.timestamps
+    end
+
+    add_index :ecom_core_work_component_templates, %i[code work_product_template_id task_template_id],
+              unique: true,
+              name: 'wct_on_code_wpt_id_tt_id_indx'
+    add_foreign_key :ecom_core_work_component_templates, :ecom_core_work_product_templates,
+                    column: :work_product_template_id
+    add_foreign_key :ecom_core_work_component_templates, :ecom_core_task_templates,
+                    column: :task_template_id
+  end
+end