cats_core 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 604365a363f0851bc10ec03d4e364de15b081685afbd076e3fef22d66c045b6f
+  data.tar.gz: d1ff473020652f3fbb66bef23955cff2e57270e419507540195ef9d8a5702b8f
+SHA512:
+  metadata.gz: 9476576fe0f712e1001cd6148b365ef2e94ec65c8287b1eeb4304baec8bef1f37cbcff62a499145bd9f78f0878bef775225a2cd2cf5795ffe6a3efcfbb44506d
+  data.tar.gz: db89e8070c9b8f82a242c811435af2a0bf85876b6d1c86ed64fe5da3fdcd85c9a6f08d8b907a9f8f922140417ce5baa639e78ecbec0be7c233b450564a92e5d2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 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 @@
+# CatsCore
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cats_core'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install cats_core
+```
+
+## 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,10 @@
+require 'bundler/setup'
+
+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/cats/core/application_controller.rb

@@ -0,0 +1,4 @@
+module CatsCore
+  class ApplicationController < ActionController::Base
+  end
+end

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

@@ -0,0 +1,8 @@
+module Cats
+  module Core
+    class ApplicationModule < ApplicationRecord
+      validates :prefix, :name, presence: true
+      validates :prefix, uniqueness: true
+    end
+  end
+end

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

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

data/app/models/cats/core/commodity.rb

@@ -0,0 +1,17 @@
+module Cats
+  module Core
+    class Commodity < ApplicationRecord
+      # Commodity statuses
+      GOOD = 'Good'.freeze
+      DAMAGED = 'Damaged'.freeze
+      COMMODITY_STATUSES = [GOOD, DAMAGED].freeze
+
+      belongs_to :commodity_category
+      belongs_to :donor
+      belongs_to :program
+      belongs_to :unit_of_measure
+
+      validates :quantity, presence: true, numericality: { greater_than: 0 }
+    end
+  end
+end

data/app/models/cats/core/commodity_category.rb

@@ -0,0 +1,8 @@
+module Cats
+  module Core
+    class CommodityCategory < ApplicationRecord
+      validates :code, presence: true, uniqueness: true
+      validates :name, presence: true
+    end
+  end
+end

data/app/models/cats/core/commodity_transaction.rb

@@ -0,0 +1,55 @@
+module Cats
+  module Core
+    class CommodityTransaction < ApplicationRecord
+      # Transaction statuses
+      DRAFT = 'Draft'.freeze
+      COMMITTED = 'Committed'.freeze
+      STATUSES = [DRAFT, COMMITTED].freeze
+
+      # Transaction types
+      STACK_TO_STACK = 'Stack to Stack'.freeze
+      STACK_TO_WAY_BILL = 'Stack to Way Bill'.freeze
+      WAY_BILL_TO_STACK = 'Way Bill to Stack'.freeze
+      TRANSACTION_TYPES = [STACK_TO_STACK, STACK_TO_WAY_BILL, WAY_BILL_TO_STACK].freeze
+
+      belongs_to :source, polymorphic: true
+      belongs_to :destination, polymorphic: true
+
+      validates :transaction_date, :quantity, :status, presence: true
+      validates :quantity, numericality: { greater_than: 0 }
+      validates :status, inclusion: { in: STATUSES }
+      validate :validate_quantity
+
+      before_validation :set_transaction_type
+
+      def validate_quantity
+        return unless quantity.present? && source.present?
+
+        errors.add(:quantity, 'cannot be more than source quantity') if quantity > source.quantity
+      end
+
+      def commit
+        CommodityTransaction.transaction do
+          source.quantity -= quantity
+          destination.quantity += quantity
+          source.save
+          destination.save
+        end
+      end
+
+      private
+
+      def set_transaction_type
+        return unless transaction_type.nil? && source.present? && destination.present?
+
+        if source.instance_of?(Cats::Core::Stack) && destination.instance_of?(Cats::Core::Stack)
+          self.transaction_type = STACK_TO_STACK
+        elsif source.instance_of?(Cats::Core::Stack) && destination.instance_of?(Cats::Core::WayBillItem)
+          self.transaction_type = STACK_TO_WAY_BILL
+        else
+          self.transaction_type = WAY_BILL_TO_STACK
+        end
+      end
+    end
+  end
+end

data/app/models/cats/core/donor.rb

@@ -0,0 +1,8 @@
+module Cats
+  module Core
+    class Donor < ApplicationRecord
+      validates :code, :name, presence: true
+      validates :code, uniqueness: true
+    end
+  end
+end

data/app/models/cats/core/location.rb

@@ -0,0 +1,48 @@
+module Cats
+  module Core
+    class Location < ApplicationRecord
+      REGION = 'Region'.freeze
+      ZONE = 'Zone'.freeze
+      WOREDA = 'Woreda'.freeze
+      KEBELE = 'Kebele'.freeze
+      HUB = 'Hub'.freeze
+      WAREHOUSE = 'Warehouse'.freeze
+
+      LOCATION_TYPES = [REGION, ZONE, WOREDA, KEBELE, HUB, WAREHOUSE].freeze
+
+      has_ancestry
+
+      validates :name, :location_type, presence: true
+      validates :location_type, inclusion: { in: LOCATION_TYPES }
+      validate :validate_location_parent
+
+      def validate_location_parent
+        parents = {
+          REGION => [],
+          ZONE => [REGION],
+          WOREDA => [REGION, ZONE],
+          KEBELE => [REGION, ZONE, WOREDA],
+          HUB => [REGION, ZONE, WOREDA, KEBELE],
+          WAREHOUSE => [REGION, ZONE, WOREDA, KEBELE, HUB]
+        }
+
+        return if location_type.nil? || location_type.empty?
+
+        return if location_type == REGION && parent.nil?
+
+        # Check that parent is not nil for locations other than region
+        errors.add(:location, 'parent cannot be empty') if location_type != REGION && parent.nil?
+
+        # At this point, we may return if parent.nil? is true
+        # because the above statement already took care of that.
+        return unless parent
+
+        return if parents[location_type].include?(parent.location_type)
+
+        # If we reach this far then it means that we have assigned a
+        # wrong type of parent to our location.
+        errors.add(:location, "cannot have #{parent.location_type} as parent")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Cats
+  module Core
+    class Menu < ApplicationRecord
+      belongs_to :application_module
+
+      validates :label, presence: true
+    end
+  end
+end

data/app/models/cats/core/menu_item.rb

@@ -0,0 +1,9 @@
+module Cats
+  module Core
+    class MenuItem < ApplicationRecord
+      belongs_to :menu
+
+      validates :label, :route, presence: true
+    end
+  end
+end

data/app/models/cats/core/program.rb

@@ -0,0 +1,8 @@
+module Cats
+  module Core
+    class Program < ApplicationRecord
+      validates :code, :name, presence: true
+      validates :code, uniqueness: true
+    end
+  end
+end

data/app/models/cats/core/role.rb

@@ -0,0 +1,9 @@
+module Cats
+  module Core
+    class Role < ApplicationRecord
+      belongs_to :application_module
+
+      validates :name, presence: true
+    end
+  end
+end

data/app/models/cats/core/role_menu.rb

@@ -0,0 +1,19 @@
+module Cats
+  module Core
+    class RoleMenu < ApplicationRecord
+      belongs_to :role
+      belongs_to :menu
+      has_and_belongs_to_many :menu_items, join_table: :cats_core_role_menus_menu_items
+
+      validate :validate_role_and_menu
+
+      def validate_role_and_menu
+        return unless role.present? && menu.present?
+
+        return if role.application_module_id == menu.application_module.id
+
+        errors.add(:base, 'Application module does not match for role and menu')
+      end
+    end
+  end
+end

data/app/models/cats/core/stack.rb

@@ -0,0 +1,39 @@
+module Cats
+  module Core
+    class Stack < ApplicationRecord
+      # Stack statuses
+      RESERVED = 'Reserved'.freeze
+      ALLOCATED = 'Allocated'.freeze
+      DESTROYED = 'Destroyed'.freeze
+      STACK_STATUSES = [RESERVED, ALLOCATED, DESTROYED].freeze
+
+      belongs_to :commodity
+      belongs_to :store
+      has_many :source_transactions, class_name: 'Cats::Core::CommodityTransaction', as: :source
+      has_many :destination_transactions, class_name: 'Cats::Core::CommodityTransaction', as: :destination
+
+      validates :code, :length, :width, :height, :start_x, :start_y, :commodity_status, :stack_status,
+                :quantity, presence: true
+      validates :code, uniqueness: true
+      validates :length, :width, :height, :start_x, :start_y, numericality: { greater_than: 0 }
+      validates :quantity, numericality: { greater_than_or_equal_to: 0 }
+      validates :commodity_status, inclusion: { in: Cats::Core::Commodity::COMMODITY_STATUSES }
+      validates :stack_status, inclusion: { in: STACK_STATUSES }
+      validate :validate_coordinates, :validate_dimensions
+
+      def validate_coordinates
+        return unless store.present? && length.present? && width.present? && start_x.present? && start_y.present?
+
+        errors.add(:start_x, 'cannot exceed length') if start_x.present? && start_x > store.length
+        errors.add(:start_y, 'cannot exceed width') if start_y.present? && start_y > store.width
+      end
+
+      def validate_dimensions
+        return unless store.present? && length.present? && width.present? && start_x.present? && start_y.present?
+
+        errors.add(:length, 'cannot exceed store length') if start_x + length > store.length
+        errors.add(:width, 'cannot exceed store width') if start_y + width > store.width
+      end
+    end
+  end
+end

data/app/models/cats/core/store.rb

@@ -0,0 +1,24 @@
+module Cats
+  module Core
+    class Store < ApplicationRecord
+      belongs_to :warehouse, class_name: 'Cats::Core::Location'
+      has_many :stacks
+
+      validates :name, :store_keeper_name, :length, :width, :height, presence: true
+      validates :length, :width, :height, numericality: { greater_than: 0 }
+      validates :gangway_length, :gangway_width, :gangway_corner_dist, presence: true, if: :has_gangway?
+      validates :gangway_length,
+                :gangway_width,
+                :gangway_corner_dist,
+                numericality: { greater_than: 0 },
+                allow_nil: true
+      validate :validate_location
+
+      def validate_location
+        return if warehouse.nil?
+
+        errors.add(:warehouse, 'must be a valid warehouse') unless warehouse.location_type == Location::WAREHOUSE
+      end
+    end
+  end
+end

data/app/models/cats/core/transporter.rb

@@ -0,0 +1,8 @@
+module Cats
+  module Core
+    class Transporter < ApplicationRecord
+      validates :code, :name, :address, :contact_phone, presence: true
+      validates :code, uniqueness: true
+    end
+  end
+end

data/app/models/cats/core/unit_of_measure.rb

@@ -0,0 +1,13 @@
+module Cats
+  module Core
+    class UnitOfMeasure < ApplicationRecord
+      WEIGHT = 'Weight'.freeze
+      VOLUME = 'Volume'.freeze
+      ITEM = 'Item'.freeze
+      UNIT_TYPES = [WEIGHT, VOLUME, ITEM].freeze
+
+      validates :name, :abbreviation, presence: true, uniqueness: true
+      validates :unit_type, presence: true, inclusion: { in: UNIT_TYPES }
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Cats
+  module Core
+    class User < ApplicationRecord
+      has_secure_password
+      rolify
+
+      belongs_to :application_module
+
+      validates :first_name, :last_name, :email, presence: true
+      validates :password, length: { minimum: 6 }
+      validates :email, uniqueness: true, format: { with: URI::MailTo::EMAIL_REGEXP }
+    end
+  end
+end

data/app/models/cats/core/way_bill.rb

@@ -0,0 +1,12 @@
+module Cats
+  module Core
+    class WayBill < ApplicationRecord
+      belongs_to :source, class_name: 'Cats::Core::Location'
+      belongs_to :destination, class_name: 'Cats::Core::Location'
+      belongs_to :transporter
+
+      validates :ref_no, :plate_no, :driver_name, :driver_phone, :date_prepared, presence: true
+      validates :ref_no, uniqueness: true
+    end
+  end
+end

data/app/models/cats/core/way_bill_item.rb

@@ -0,0 +1,15 @@
+module Cats
+  module Core
+    class WayBillItem < ApplicationRecord
+      belongs_to :way_bill
+      belongs_to :commodity
+
+      has_many :source_transactions, class_name: 'Cats::Core::CommodityTransaction', as: :source
+      has_many :destination_transactions, class_name: 'Cats::Core::CommodityTransaction', as: :destination
+
+      validates :quantity, :commodity_status, presence: true
+      validates :quantity, numericality: { greater_than: 0 }
+      validates :commodity_status, inclusion: { in: Cats::Core::Commodity::COMMODITY_STATUSES }
+    end
+  end
+end