Merge pull request #136 from shakacode/improve-gemfile-readability

updates for readability

Author: justin808

Gemfile

@@ -4,9 +4,15 @@ ruby "2.2.2"
 #
 # Bundle edge Rails instead: gem "rails", github: "rails/rails"
 gem "rails", "~>4.2"
-# Use sqlite3 as the database for Active Record
-gem "sqlite3", group: :development
-gem "pg", group: :production
+
+# Note: We're using sqllite3 for development and testing
+gem "sqlite3", group: [:development, :test]
+
+group :production do
+ # Pg is used for Heroku
+ gem "pg"
+ gem "rails_12factor" # Never include this for development or tests
+end
 
 # Use SCSS for stylesheets
 gem "sass-rails"
@@ -15,17 +21,13 @@ gem "bootstrap-sass", "~> 3.3"
 gem "uglifier"
 # Use CoffeeScript for .js.coffee assets and views
 gem "coffee-rails"
-# See https://github.com/sstephenson/execjs#readme for more supported runtimes
-# gem "therubyracer", platforms: :ruby
-
-# jquery as the JavaScript library has been moved under /client and managed by npm.
-# It is critical to not include any of the jquery gems when following this pattern or
-# else you might have multiple jQuery versions.
 
 # Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
 gem "turbolinks"
+
 # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
 gem "jbuilder"
+
 # bundle exec rake doc:rails generates the API under doc/api.
 gem "sdoc", group: :doc
 
@@ -39,42 +41,41 @@ gem "rails-html-sanitizer"
 gem "unicorn"
 
 gem "react_on_rails", "~> 1.0.0.pre"
+# See https://github.com/sstephenson/execjs#readme for more supported runtimes
 gem "therubyracer"
 
 gem "autoprefixer-rails"
 
 gem "awesome_print"
 
-# Use Capistrano for deployment
-# gem "capistrano-rails", group: :development
-group :production do
- gem "rails_12factor"
-end
+# jquery as the JavaScript library has been moved under /client and managed by npm.
+# It is critical to not include any of the jquery gems when following this pattern or
+# else you might have multiple jQuery versions.
 
 group :development, :test do
  # Access an IRB console on exceptions page and /console in development
  gem "web-console"
 
+ ################################################################################
  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
  gem "spring"
-
  gem "spring-commands-rspec"
 
+ ################################################################################
  # Manage application processes
  gem "foreman"
-
  gem "factory_girl_rails"
 
+ ################################################################################
  # Linters and Security
  gem "rubocop", require: false
  gem "ruby-lint", require: false
+ # Critical that require: false be set! https://github.com/brigade/scss-lint/issues/278
  gem "scss_lint", require: false
  gem "brakeman", require: false
  gem "bundler-audit", require: false
 
- # Allow printing with colors to terminal
- gem "rainbow"
-
+ ################################################################################
  # Favorite debugging gems
  gem "pry"
  gem "pry-doc"

Gemfile.lock

@@ -350,7 +350,6 @@ DEPENDENCIES
  rails (~> 4.2)
  rails-html-sanitizer
  rails_12factor
- rainbow
  react_on_rails (~> 1.0.0.pre)
  rspec-rails
  rubocop

config/database.yml

@@ -4,6 +4,7 @@
 # Ensure the SQLite 3 gem is defined in your Gemfile
 # gem "sqlite3"
 #
+# NOTE: Real world apps would not have a different DB for development
 default: &default
  adapter: sqlite3
  pool: 5