Skip to content
Snippets Groups Projects

Port an existing app to OOD

Last edited by Brian L. McMichael
  • Rails 4.1.15+
  • Use rubygems.org gems when possible
  • Dataroot changes

Due to changes in the OOD gems, OOD applications will need to have a minimum Rails version of 4.1.15, you can also update to the latest version of Rails 4.2. Rails 5.0 is not yet supported.

We will be replacing the awesim_rails gem with the ood_appkit gem, and updating the rest of the OOD dependencies to work with the latest version of OodAppkit.

1. Clone the existing app to /awesim/share

2. Update the Gemfile

Update Rails

-gem 'rails', '4.0.0'
+gem 'rails', '4.1.15'

Update sass-rails

-gem 'sass-rails', '4.0.2'
+gem 'sass-rails', '~> 5.0'

Update bootstrap-sass

-gem 'bootstrap-sass', '3.3.1.0'
+gem 'bootstrap-sass', '~> 3.3'

Update OSC gems

-gem 'osc-machete', '~> 1.0.0', :git => 'git@github.com:OSC/osc-machete.git', :tag => 'v1.0.1'
+gem 'osc-machete', '~> 1.2'
-gem 'osc_machete_rails', '~> 1.0.0', :git => 'git@github.com:OSC/osc_machete_rails.git', :tag => 'v1.0.1'
+gem 'osc_machete_rails', '~> 1.2'
-gem 'osc-vnc', '~> 1.0.0', :git => 'git@github.com:OSC/osc-vnc.git', :tag => 'v1.0.8'
+gem 'osc-vnc', '~> 1.1'

Add ood_appkit, pbs, and awesim_branding gems

+gem 'ood_appkit', '~> 0.3.0'
+gem 'pbs', '~> 2.0'
+gem 'awesim_branding', :git => 'git@github.com:AweSim-OSC/awesim_branding.git'

Remove awesim_rails and awesim_rails_logging gems, these are not supported on OOD

-gem 'awesim_rails', '~> 1.0.0', :git => 'git@github.com:AweSim-OSC/awesim_rails.git', :tag => 'v1.0.0'
-gem 'awesim_rails_logging', '~> 1.0.0', :git => 'git@github.com:AweSim-OSC/awesim_rails_logging.git', :tag => 'v1.0.0'

Find all references to AwesimRails in the app code and modify to OodAppkit

Examples:

-      outdir: File.join(AwesimRails.dataroot, "vnc", "paraview"),
+      outdir: File.join(OodAppkit.dataroot, "vnc", "paraview"),

-Paperclip::Attachment.default_options[:path] = "#{AwesimRails.dataroot}/uploads/:class/:id/:created_at/:attachment/:filename"
+Paperclip::Attachment.default_options[:path] = "#{OodAppkit.dataroot}/uploads/:class/:id/:created_at/:attachment/:filename"

Run Bundler

$ scl enable git19 rh-ruby22 -- bin/bundle install --path=vendor/bundle

Test Changes

Test to make sure everything's working properly.