Inventory System

Installation

After cloning, install dependencies:

  yarn install
  bundle install

Then initialize the database:

  rails db:create && rails db:migrate && rails db:seed

Use the npm script to run the developement server processes through Foreman:

  yarn dev

Application Intention

Asset management for entire asset lifecycle. Track from purchase through active support to deprecation.

All hardware asset types:

Check in and out of active inventory
Assign to person, department or location
Logging of all incoming and outgoing usage

Items:

Designate IP address info

Accessories:

Trackable quantity

Consumables:

"Using" a consumable permanently removes it from inventory
Can replenish quantity
- Optionally create a purchase order

Components:

Trackable quantity
Can only be assigned to an item

Networks:

Lists IP addresses of assets
Tracks structure of local network
- Notes network infrastructure which defines the network
Provides a table view of all assets categorized by network segment/address
- Paginates large subnets
Network calculation tools

Purchases:

Purchase order creates an item/consumeable/accessory/component record
- Purchase orders for existing consumeables increases inventory count
Tracks source, purchase date, cost, category
- Optional assignment to GL codes
- Optional purchase request generation to be printed or emailed

Licenses:

Assignable to an asset
- Decrementable in the case of bulk licensing

People:

Person records can be pulled from LDAP/AD (not required)
- Merges existing similar records (Person with no guid and same name can be merged)

Vendors:

Referenced and sortable by all assets
Stores useful details about the vendor
Links to contracts

Contracts:

Stores contract terms
- Start/end dates
- Billing cycles and amounts
File uploads for signed contracts storage

Companies:

Top level records
User permissions related to the company association
Brandable (logo, theme)

Locations:

Tree structure under company

Departments:

Flat structure under company

Help Desk:

Email integration
- Scans one email address, converts all incoming emails to tickets
- Scans sent mail to build full conversation in app
- Respond to tickets in app, generates email
- Filtering rules for what to ignore
Associate tickets with other records
Bulk edit/update/close

Documentation:

Wiki style living documentation
- Links to other records
- Revision history
- WYSIWYG editor
Permissions set at the department level, overridden at the individual level

Software Agents:

Agent for Mac, Windows, Linux, iOS, Android
Connects to server using API key
Periodically reports asset data through REST API endpoints

Table view for all models:

Hide/Show column tables
- persistent per table per user
Sortable column headings & Pagination
Custom fieldsets
Search bar filters by all fields, including custom fields
Advanced search options

Form view for all models:

Associated record dropdowns are lazy loaded
Associated records have a "New" button next to them

Dev Notes

Assets

All assignable asset types inherit from a base Asset class. This allows for easy searching across the entire inventory of assets. The base Asset class is not assignable, only children with Assignable concerns.

Assignments

There are three subclasses of the polymorphic Assignable class:

Assignable::Single: Items, no count, can be reassigned.
Assignable::Quantity: Accessories and Components, tracks quantity, can be reassigned.
Assignable::Consume: Consumables, tracks quantity, cannot be reassigned.

Assignments have a location which should be derived from the Person, Item or Location of the AssignToable model, but can be overridden during assignment.

Searchable/Sortable and Table Components

This needs to be fully documented, too much going on in the background

Companies

Companies are top level organizational units. All other objects can be considered to belong to a company via an "Ownership" relationship.

Ownerships

Given that an asset shouldn't belong to more than one company, a Company record is used to scope all items. Everything under the scope of a company is considered to be "owned" by that company, defined by a polymorphic Ownership record. An Ownership also contains an optional Department reference so that departmental ownership can live as a top level definition. This way an asset can be assigned outside of its department, but still maintain the relationship of its original owner.

Roles

User record can have one role, :super_admin.

Person record can have :admin role set for specific Companies.

PersonGroup record is where all other roles will be applied.

Git workflow

When working on something, always create a feature branch. Submit a PR to dev, it will be squashed and merged when accepted.

When bringing changes in dev over to main, create a release branch off of main. Merge dev into it using git pull origin dev --rebase. Merge into main using a standard merge.

Features for another time

Depreciation
EULA
Images
File uploads

Ideas

Add a preview icon to searchable dropdowns to either open the record in a new tab, or in a modal for a quick peek at the model data.

Reference

Books

Everyday Rails Testing with RSpec

Growing Rails Applications in Practice

Sites

Better Spec

Maybe Useful

GTIN library for identifying code types

aviemet/inventory