This project seeks to build a rails 5 app with the following specifications:
- mongoid gem for mongodb database
- devise and OmniAuth gems for user authentication and management
Success does not occur in a vacuum. Special thanks to the following individuals and tutorials that helped launch this project.
- Tutorials
- Mentors
- Install rails 5:
gem install rails - Generate new rails app
$ rails new rails5-mongoid --skip-bundle --skip-active-record --skip-test --skip-system-test
Explanation:
- The
$will be used in this tutorial for the command prompt and is not to be typed. rails5-mongoidis the name that I chose to call the app. You may specify a different name.--skip-bundleWe will be runningbundle installafter tweaking the gemfile--skip-active-recordActive record is for sql based databases, however we will be using the mongodb database.--skip-testand--skip-system-test: We will have using rspec and cucumber for out tests.
The following steps are to set up a git repository for source control. Skip this section if you are building a throw-away app for education. Of course, if you have an aversion to git, there are other version control options such as Mercurial and Subversion.
*$ git init .
$ git add .$ git commit -m 'Initial commit'- Create a remote repository. There are several options.
- On GitHub. Here are instructions if you need help. The README file is optional.
- Follow steps 8 and 9 to push your local repository to GitHub.
- OR you could use BitBucket or one of the many other git hosting options
- If Mongodb is not yet installed, follow the installation guide to install it.
- Add the mongoid gem to the Gemfile
gem 'mongoid', '~> 6.2.0'$ bundle install- Generate the configuration file
$ rails g mongoid:config
We will be using Test Driven Developement in this app.
- Add and adjust the
Gemfileto include the following gems.- rspec-rails
gem 'rspec-rails', '~> 3.6' - capybara
gem 'capybara', '~> 2.14' - database_cleaner
gem 'database_cleaner', '~> 1.6', '>= 1.6.1' - mongoid-rspec
gem 'mongoid-rspec', git: 'https://github.com/mongoid-rspec/mongoid-rspec.git'- Note at the time of writing the git master branch has been updated to include support for mongoid 6. However, the official release of 3.0.0 only supports through mongoid 5.
- cucumber-rails
gem 'cucumber-rails', '~> 1.5' - factory_girl_rails
gem 'factory_girl_rails', '~> 4.8' - email_spec
gem 'email_spec', '~> 2.1'
- rspec-rails
The above gems will need to be grouped as follows in the Gemfile.
group :development, :test do
# Call 'byebug' anywhere in the code to stop execution and get a debugger console
gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
gem 'rspec-rails', '~> 3.6'
gem 'factory_girl_rails', '~> 4.8'
gem 'cucumber-rails', '~> 1.5', :require => false
gem 'database_cleaner', '~> 1.6', '>= 1.6.1'
end
group :test do
gem 'capybara', '~> 2.14'
gem 'mongoid-rspec', git: 'https://github.com/mongoid-rspec/mongoid-rspec.git'
gem 'email_spec', '~> 2.1'
end
Run $ bundle install to install the new gems. Next we will configure these gems.
Rspec Configuration
https://github.com/rspec/rspec-rails- This generates several the necessary files to run rspec tests
- Add the following line to the top of the
.rspecfile--color- This adds color output for when rspec is run from the terminal. We will be setting up Travis CI to run the tests automatically, however the --color option is
nice for local debugging of tests which are run from the command line via
bundle exec rspec.
FactoryGirl Configuration
- Add the file
/spec/factories.rbwith the following code.FactoryGirl.define do # factories will go here end
Cucumber Configuration
- Run the installation code
rails generate cucumber:install - Cucumber tests can be run from the command line with either of the following commands, however, we will be setting up Travis CI to run the tests automatically
bundle exec cucumberrake cucumber
database_cleaner Configuration
- This Step by step guide is most helpful.
- Create a file called
spec/support/database_cleaner.rband add the following code
RSpec.configure do |config|
config.use_transactional_fixtures = false
config.before(:suite) do
DatabaseCleaner.clean_with(:truncation)
end
config.before(:each) do
DatabaseCleaner.strategy = :transaction
end
config.before(:each, :js => true) do
DatabaseCleaner.strategy = :truncation
end
config.before(:each) do
DatabaseCleaner.start
end
config.after(:each) do
DatabaseCleaner.clean
end
end