brown-university-library / vivo-on-rails Goto Github PK

A Ruby on Rails front-end for VIVO

Ruby 55.48% JavaScript 0.12% CSS 10.64% HTML 33.77%

rails vivo

vivo-on-rails's Introduction

VIVO on Rails

This is the code for the new VIVO front-end for Researchers@Brown. This is a Ruby on Rails application that searches directly against the VIVO's Solr index. See the General Architecture information below for more details.

Pre-requisites

You need to have Solr running. We use the Solr index that VIVO provides out of the box but we have added several fields needed by this project. See Solr Index section below.

We are currently using Ruby 2.7.1, Rails 6.0.3, and MySQL.

brew install ruby-install
brew install chruby
ruby-install ruby 2.7.1
source /usr/local/opt/chruby/share/chruby/chruby.sh
chruby 2.7.1
brew install mysql
gem install bundle

To get started

git https://github.com/Brown-University-Library/vivo-on-rails.git
cd vivo-on-rails
source .env_sample
bundle config set path 'vendor/bundle'
bundle install
bundle exec rake db:create
bundle exec rake db:migrate
bundle exec rails server

Update the values in .env_sample to match the URLs where Solr is running in your environment.

General Architecture

This is a Ruby on Rails web site that shows faculty information stored in Solr. All searches and retrieval of information are done against Solr.

In the future, access to the Fuseki triple store will be used to perform linked data queries and other visualizations.

A few diagrams on how the project is structure can be found here

Solr Index

The site assumes that the Solr index has Faculty information stored in a structure like the following:

  {
    id: "http://vivo.brown.edu/individual/jane_researcher",
    record_type: "PEOPLE",
    affiliations: ["dept1", "dept2", ... "deptN"],
    research_areas":["r1", "r2", "r3", ... "rN"],
    json_txt: "# string representation of a JSON object with the all the data (see below)"
  }

Below is a sample of the data stored in json_txt for a sample PEOPLE document. Notice that the field is a string with the JSON of the data for the given document.

"{
  \"record_type\":\"PEOPLE\",
  \"affiliations_text\":\"\",
  \"affiliations\":[
    {
      \"uri\":\"http://vivo.brown.edu/individual/org-brown-univ-dept57\",
      \"name\":\"Pathology and Laboratory Medicine\",
      \"id\":\"http://vivo.brown.edu/individual/org-brown-univ-dept57\"
    }
  ],
  \"awards\":\"\",
  \"collaborators\":[],
  \"contributor_to\":[],
  \"education\":[
    {
      \"school_uri\":\"http://vivo.brown.edu/individual/n37819\",
      \"date\":\"1980\",
      \"degree\":\"BA\",
      \"school_name\":\"Mount Holyoke College\"
    },
    {
      \"school_uri\":\"http://vivo.brown.edu/individual/n67738\",
      \"date\":\"1985\",
      \"degree\":\"MD\",
      \"school_name\":\"State University of New York\"
    }
  ],
  \"email\":\"[email protected]\",
  \"funded_research\":\"\",
  \"name\":\"Hansen, Katrine\",
  \"org_label\":\"Pathology and Laboratory Medicine\",
  \"overview\":\"\",
  \"research_overview\":\"\",
  \"research_statement\":\"\",
  \"scholarly_work\":\"\",
  \"teacher_for\":[],
  \"teaching_overview\":\"\",
  \"title\":\"Associate Professor of Pathology and Laboratory Medicine\",
  \"thumbnail\":null,
  \"research_areas\":[],
  \"uri\":\"http://vivo.brown.edu/individual/khansenm\",
  \"id\":\"http://vivo.brown.edu/individual/khansenm\"
}"

Organization records follow a similar pattern.

  {
    id: "http://vivo.brown.edu/individual/some-org-id",
    record_type: "ORGANIZATION",
    json_txt: "# string representation of a JSON object with the all the data (see below)"
  }

Below is a sample of the data stored in json_txt for a sample ORGANIZATION. Notice that the field is a string with the JSON of the data for the given document.

"{
  \"record_type\":\"ORGANIZATION\",
  \"uri\":\"http://vivo.brown.edu/individual/org-brown-univ-dept57\",
  \"name\":\"Pathology and Laboratory Medicine\",
  \"overview\":...",
  \"thumbnail\":\"http://vivo.brown.edu/individual/n5457\",
  \"people\":[
  {
    \"id\":\"http://vivo.brown.edu/individual/khansenm\",
    \"uri\":\"http://vivo.brown.edu/individual/khansenm\",
    \"label\":\"Hansen, Katrine\",
    \"specific_position\":\"Associate Professor of Pathology and Laboratory Medicine\",
    \"general_position\":\"Faculty Position\"
  },
  {
    \"id\":\"http://vivo.brown.edu/individual/elaposat\",
    \"uri\":\"http://vivo.brown.edu/individual/elaposat\",
    \"label\":\"\",
    \"specific_position\":\"Clinical Associate Professor of Pathology and Laboratory Medicine\",
    \"general_position\":\"Faculty Position\"
  }]
}

We use json_txt to reconstruct the data that will be displayed when the user wants to view the detail for a specific individual or organization. This is what allows us to run the system without interfacing with the Fuseki endpoint.

TODO: We still need to create individual fields in Solr to allow for a better search experience, for example, a separate field for name to give it a higher boost on search results and the ability to facet the data by other fields.

Caveats

The code at this point is hard-coded for very specific predicates that we use at Brown and might not work on your particular VIVO database.

The unit tests (bundle exec rake vivo:tests) are hard-coded to find very specific people/departments so they will very likely fail on your installation.

vivo-on-rails's People

Contributors

Stargazers

Watchers

vivo-on-rails's Issues

repurpose 1 of 3 homepage lower boxes for news alerts/listings

add link from homepage to an "advanced search" screen/page

add a few additional homepage background photos, showing diversity

within start-page logo's SVG paths, switch Vitesse font to Freight Sans Pro (re: feeback relayed to JR)

move pagination out of .results-wrapper and into a full width row for more room on mobile

Visualization - general tweaks

The entire content of the visualizations is flushed to the left side of the screen, it would be nice if there was a margin on the left. (see arrow 1 in screenshot)

It would be nice if the researcher name (Audrey Tyrka) also had the bar with the color of the department as the department name does (see arrow 2 below)

It would be nice if the buttons to select the visualization were the same size (see arrow 3 below)

Code:
https://github.com/Brown-University-Library/vivo-on-rails/blob/master/app/views/visualization/collab.html.erb (it really applies to all the views under app/views/visualization)

adjust styling/layout of top banner areas for mobile-widths

adjust/reposition "manage your profile" link so it does not bump search input area and center title area; possibly move to line below along with "advanced search" link

Faculty - affiliations

See if we can make sure the icons for the Faculty Affiliations can be lined up.

Code:
https://github.com/Brown-University-Library/vivo-on-rails/blob/master/app/views/faculty/_show_right_panel.html.erb#L9-L21

Example: http://localhost:3000/display/rbaier

Visualization - legend for publication history

It is possible to get a very large number of authors on the publication history. When this happens the legend section grows way to big. See if there is a better way of handling this case.

Code:
https://github.com/Brown-University-Library/vivo-on-rails/blob/master/app/views/visualization/publications_org.html.erb

Example:
http://localhost:3000/display/org-brown-univ-dept84/viz/publications

Faculty - social media icons

It would be nice to line up the text and icons of the social media links for faculty profiles (displayed under "On the web" for a Faculty profile)

Code:
https://github.com/Brown-University-Library/vivo-on-rails/blob/master/app/views/faculty/_show_right_panel.html.erb#L38-L52

Examples:
http://localhost:3000/display/dsdizon

http://localhost:3000/display/bbilgen

What is VIZ_SERVICE_URL meant to be?

I'm attempting to develop graph visualizations for a new web application representing scholarship located at the Ibero-Amerikanisches Institut (Ibero-American Institute) Preußischer Kulturbesitz in Berlin, Germany.

Since it is our goal to integrate graph visualization functionality using d3.js into a web frontend we develop ourselves and use VIVO as a backend in order to feed that frontend, we stumbled across VIVO on Rails, which we thought of using as some kind of blueprint. However, we're going to use Laravel as the web framework rather than Ruby on Rails. Now I'm trying to figure out how it all works together :)

As far as I believe having understood up to now the data to be displayed in the graph is being retrieved in the form of a JSON file, which is then being processed by d3.js. For example, this should apply when calling the URL https://vivo.brown.edu/display/chaassko/viz/coauthor in your live system.

But when investigating the Ruby on Rails code provided by you on Github, I'm getting stuck at the moment it comes to the CoauthorGraph.get_data(id) call. There, in app/models/coauthor_graph.rb, line 25, the environment constant ENV['VIZ_SERVICE_URL'] is being used. This is commented out in .env_sample, having a default value of just https://somewhere anyway. But this seems to be the spot where the JSON file actually is being retrieved from.

So what is this VIZ_SERVICE_URL meant to be? Is it supposed to point to an API provided by VIVO out of box, or some third-party software component? I would be very grateful if you could enlighten me a bit :)

Visualization - no data page

Style the page that is displayed when there is no data for a given profile (see http://localhost:3000/display/pmonti/viz/collab for an example)

Code:
https://github.com/Brown-University-Library/vivo-on-rails/blob/master/app/views/visualization/collab.html.erb

Visualization - Show buttons

The "Show Collaborator" and "Show Collaborator's Collaborators" buttons normally display at the top of the page but sometimes, when the screen is too wide, they show at the bottom. It would be nice if they always show at the top regardless of the screen width.

Code: https://github.com/Brown-University-Library/vivo-on-rails/blob/master/app/views/visualization/collab.html.erb

Normal display (buttons are at the top of the screen)

Display on a wide screen (buttons are at the bottom of the screen)