ironjan / klausurtool-ror

Previous Klausurtool of the FSMI UPB.

Klausurtool RoR

Superseded by https://git.cs.upb.de/fsmi/fsmi-klausurarchiv (FSMI internal).

Fehler melden, Feedback geben

• Sieh im Issue Tracker nach, ob das Feedback oder Problem bereits bekannt wird
• Falls es nicht nicht bekannt ist, erstelle einen neuen Issue
• Sei bitte so ausführlich wie möglich
• Falls es um eine bestimmte Seite im Tool geht, bitte URL mit einfügen

Mithelfen

Wirf einen Blick in den Issue Tracker. Dort findest du alle bekannten Probleme und Erweiterungswünsche. Über das Label high-prio findest du die Issues, die am wichtigsten sind.

Backup der Datenbank zum Testen nutzen

1. Get a data.yml file created by bin/rake db:dump on production server
2. Disable foreign key checks on your local DB: SET GLOBAL foreign_key_checks = 0;
3. Execute RAILS_ENV=production bin/rake db:data:load; RAILS_ENV=development bin/rake db:data:load
4. Enable foreign key checks on your DB: SET GLOBAL foreign_key_checks = 1;

Getting started

• Install RVM. You can use this to install rails and ruby.
• Check that ruby and MySQL/MariaDB are installed
• ruby -v
• mysql --version
• Other requirements: git and sed
• Install dependencies via bundle install
• If you don't have sudo access, you can install the gems to a path of your choice via e.g. bundle install --path $HOME/bundle/
• Copy config/secrets.yml.template to config/secrets.yml and generate different values for secret_key_base (You can use bin/rake secret)
• Create the schemas klausurtool, klausurtool_development, and klausurtool_test in your database
• Load the db:schema via bin/rake db:schema:load
• In development mode, RoR will tell you, when migrations need to be run via bin/rake db:migrate
• Start the server via bin/rails server
• The -e switch can be used to start a server in a different environment
• Start with bin/rails server --binding 0.0.0.0 to listen to external requests
• This does not automatically mean "production mode"
• Pre-Compile assets for production via RAILS_ENV=production bin/rake assets:precompile

Deployment

Das Deployment ist ähnlich aufgebaut wie auf Ralf Ebert's Blog beschrieben. Es gibt folgende Abweichungen:

• MySQL statt Prostgres
• Deployment-Pfad und SSH-Settings

Versioning

• Follows Semantic Versioning
• Uses http://stackoverflow.com/questions/9073446/where-do-you-store-your-rails-applications-version-number to update version
• git tag $version & restart server

Incompatible updates

• In 0.7.0 the archive was changed to be independent of old_folder_instances
• The sql-script data_conversion_0.6.6_to_0.7.0.sql has to be executed after updating to 0.7.0 (Don't forget to backup!)

Links that helped to get started

The goal of this list is to collect links that helped me Getting started. It was started in the middle of the project and is therefore incomplete.

• Rails Getting Started
• http://www.korenlc.com/creating-a-simple-search-in-rails-4/
• http://www.dotnetperls.com/sub-ruby
• http://stackoverflow.com/questions/6551128/split-on-different-newlines
• http://stackoverflow.com/questions/5878697/how-do-i-remove-blank-elements-from-an-array
• http://www.eriktrautman.com/posts/ruby-explained-map-select-and-other-enumerable-methods
• http://edgeguides.rubyonrails.org/active_record_migrations.html#creating-a-join-table
• http://blog.teamtreehouse.com/ruby-arrays
• http://stackoverflow.com/questions/2831059/how-to-drop-columns-using-rails-migration
• http://makandracards.com/makandra/31937-differences-between-transactions-and-locking
• http://stackoverflow.com/questions/19690687/check-if-multi-insert-transaction-is-successful-or-not
• http://guides.rubyonrails.org/layouts_and_rendering.html
• http://stackoverflow.com/questions/185965/how-do-i-change-the-title-of-a-page-in-rails
• http://stackoverflow.com/questions/3025784/rails-layouts-per-action
• http://stackoverflow.com/a/23066966/1666181
• http://ruby-doc.org/
• http://www.mediaevent.de/xhtml/htmtl-section-header.html
• http://railsguides.net/change-data-in-migrations-like-a-boss/
• http://stackoverflow.com/questions/4282710/how-do-i-describe-an-enumeration-column-in-a-rails-3-migration
• http://stackoverflow.com/questions/23686265/saving-enum-from-select-in-rails-4-1
• http://joanswork.com/localized-activerecordenum-display-names/
• http://guides.rubyonrails.org/i18n.html
• http://maxdesign.com.au/articles/definition/
• https://github.com/twbs/bootstrap-sass
• http://bootcards.org/
• http://stackoverflow.com/questions/19622056/include-bootstrap-role-attribute-in-rails-form-helper
• http://v4-alpha.getbootstrap.com/components/forms/#form-layouts
• http://www.w3schools.com/bootstrap/
• http://stackoverflow.com/questions/10691442/adding-a-simple-spacer-to-twitter-bootstrap
• http://stackoverflow.com/questions/9282689/allow-public-connections-to-local-ruby-on-rails-development-server
• http://stackoverflow.com/questions/18000037/rails-how-to-handle-existing-invalid-dates-in-database
• Testing:
• http://everydayrails.com/2012/03/19/testing-series-rspec-models-factory-girl.html
• http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
• https://www.relishapp.com/rspec/rspec-mocks/docs