Tidy up the Gemfile a bit and document things

diff --git a/Gemfile b/Gemfile
index 14757dc946c3b66288844b5c0f9c873688dc39de..0a4f1638c8a0c964ffc5ac7b4e9c7c2c0f1ba457 100644 (file)
--- a/Gemfile
+++ b/Gemfile
@@ -1,38 +1,48 @@
+# Gem source to use

 source 'http://rubygems.org'
 
 source 'http://rubygems.org'
 

+# Require rails

 gem 'rails', '3.1.0'
 
 gem 'rails', '3.1.0'
 

+# Require the postgres database driver

 gem 'pg'
 gem 'pg'

-gem 'arel', '>= 2.0.9'
+
+# Load prototype support
+gem 'prototype-rails'
+
+# Load rails plugins
+gem 'rails-i18n-updater'
+gem 'dynamic_form'
+gem 'rinku', '>= 1.2.2', :require => 'rails_rinku'
+gem 'oauth-plugin', '>= 0.4.0.pre7'
+gem 'open_id_authentication', '>= 1.1.0'
+gem 'validates_email_format_of', '>= 1.5.1'
+gem 'composite_primary_keys', '= 4.0.0'
+
+# Load libxml support for XML parsing and generation

 gem 'libxml-ruby', '>= 2.0.5', :require => 'libxml'
 gem 'libxml-ruby', '>= 2.0.5', :require => 'libxml'

+
+# Load ImageMagick support for user picture resizing

 gem 'rmagick', :require => 'RMagick'
 gem 'rmagick', :require => 'RMagick'

-gem 'oauth', '>= 0.4.4'
-gem 'oauth-plugin', '>= 0.4.0.pre4'
-gem 'httpclient'
-gem 'SystemTimer', '>= 1.1.3', :require => 'system_timer'
+
+# Load HTML sanitizer

 gem 'sanitize'
 gem 'sanitize'

-gem 'rails-i18n-updater'
-gem 'validates_email_format_of', '>= 1.5.1'
-gem 'open_id_authentication', '>= 1.1.0'
-gem 'prototype-rails'
-gem 'rinku', '>= 1.2.2', :require => 'rails_rinku'
-gem 'dynamic_form'
+
+# Load SystemTimer for implementing request timeouts
+gem 'SystemTimer', '>= 1.1.3', :require => 'system_timer'
+
+# Load httpclient for SOAP support for Quova GeoIP queries
+gem 'httpclient'

 
 # Should only load if memcache is in use
 #gem 'memcached'
 
 
 # Should only load if memcache is in use
 #gem 'memcached'
 

-# Should only load if we're not in database offline mode
-gem 'composite_primary_keys', '= 4.0.0'
-
-# Bundle gems for the local environment. Make sure to
-# put test-only gems in this group so their generators
-# and rake tasks are available in development mode:
-group :development, :test do
+# Gems needed for running tests
+group :test do

   gem 'timecop'
 end
 
   gem 'timecop'
 end
 

-# Gems used only for assets and not required
-# in production environments by default.
+# Gems needed for compiling assets

 group :assets do
   gem 'sass-rails', "  ~> 3.1.0"
   gem 'coffee-rails', "~> 3.1.0"
 group :assets do
   gem 'sass-rails', "  ~> 3.1.0"
   gem 'coffee-rails', "~> 3.1.0"

diff --git a/Gemfile.lock b/Gemfile.lock
index 89d57d02226659a8322f3adf1f9659cb5dad771a..dfa191d95e18ed6a3491f9dcd5d3945540f1f6a4 100644 (file)
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -145,14 +145,12 @@ PLATFORMS
 
 DEPENDENCIES
   SystemTimer (>= 1.1.3)
 
 DEPENDENCIES
   SystemTimer (>= 1.1.3)

-  arel (>= 2.0.9)

   coffee-rails (~> 3.1.0)
   composite_primary_keys (= 4.0.0)
   dynamic_form
   httpclient
   libxml-ruby (>= 2.0.5)
   coffee-rails (~> 3.1.0)
   composite_primary_keys (= 4.0.0)
   dynamic_form
   httpclient
   libxml-ruby (>= 2.0.5)

-  oauth (>= 0.4.4)
-  oauth-plugin (>= 0.4.0.pre4)
+  oauth-plugin (>= 0.4.0.pre7)

   open_id_authentication (>= 1.1.0)
   pg
   prototype-rails
   open_id_authentication (>= 1.1.0)
   pg
   prototype-rails