shortage-tracker

This is a project of OSINThk.

Setup

If new to Ruby, this is a Good Guide to How to install Ruby on Rails with rbenv on macOS

Works with rbenv. May work with rvm.

An approximate macOS setup from basics:

brew install git rbenv postgres postgis redis

brew services start postgresql
brew services start redis

# do in this order
rbenv init
rbenv install 2.5.1
gem install bundler rails

git clone git@github.com:OSINThk/shortage-tracker.git
cd shortage-tracker

# check to make sure that the versions are correct before doing bundle install
$ ruby -v
$ rails -v

# if rails -v fails, with error message: Gem::GemNotFoundException, update gems
$ gem update --system

bundle install

# check to make sure your yarn packages are up to date
# $ yarn install --check-files

rake db:create && rake db:migrate
rake maxmind

# Map won't render until you've added the Mapbox API key to .env -- ask in the Telegram chat for it

rails s

Sample request: http://localhost:3000/maptest?lat=114.029&lon=22.344&dist=1500&since=2020-01-01

Hints for setup (MacOS):

Visit https://gorails.com/setup/osx/10.14-mojave
MacOS: You might need to mv /usr/local/include /usr/local/include_old to install Ruby 2.5.1. Also you might need to do sudo xcode-select --switch /Library/Developer/CommandLineTools.
If you can't find bundle try rbenv exec gem update --system followed by rbenv exec bundle update --bundler.
Use rbenv exec in front of gem/bundle commands if in doubt.
You might need to manually create /usr/local/var/postgres and give it the right permissions, then restart PG using brew services restart postgres

Anything that you find incomplete in the setup, please help us document!

Contributing

Join the Telegram group chat to get started. There you can keep up with what is happening and who is doing what. You may lay claim to individual tasks from the below TODO list.

Once we have more than one regular contributor we will use a GitHub PR workflow to organize getting work into the application.

TODO

This is a list of things that can be done to improve the application:

Localization Needing Translations

The World is not Enough Bugfix

A longitude of greater than 180º or less than -180º will break the loading behavior. At extremely zoomed out levels these numbers will appear. This will be related to the Great Circle Bugfix.

Great Circle Bugfix

All ST_MakeEnvelope requests that span >= 180º will take the shorter side around the globe. Split all ST_MakeEnvelope calls into polygons that ensure they cover the correct areas. This will be related to the The World is not Enough Bugfix.

Filtered Data Bugfix

If the filtered set increases in scope (for example, becomes unfiltered after being filtered for all previous requests) all previous cursor data loads need to be adjusted for that condition change.

In other words, they need to be run with the more-permissive filter to explicitly re-add filtered out values. For example:

~2020-02-04T16:22:27~114.1,22.5,114.2,22.6~7 => 719a480
719a480~2020-02-04T16:23:52~114.1,22.5,114.2,22.6~" => 79dda18
Loaded reports if and only if they contained product 7.
Region didn't change, should get only new reports and reports matching query 1 that did not contain product 7.

Currently Step 2 will only get new reports; it will not expand the scope of previous queries.

This should be implemented by creating a new merged chain using the multiple parents feature of cursors.