gravatar-ultimate 1.0.2 → 1.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (127) hide show
  1. data/.gitignore +13 -0
  2. data/.travis.yml +16 -0
  3. data/Gemfile +6 -0
  4. data/Gemfile.lock +37 -0
  5. data/README.rdoc +19 -25
  6. data/Rakefile +9 -38
  7. data/environments/rails-2.3/README +243 -0
  8. data/environments/rails-2.3/Rakefile +10 -0
  9. data/environments/rails-2.3/app/controllers/application_controller.rb +10 -0
  10. data/environments/rails-2.3/app/helpers/application_helper.rb +3 -0
  11. data/environments/rails-2.3/config/boot.rb +114 -0
  12. data/environments/rails-2.3/config/database.yml +22 -0
  13. data/environments/rails-2.3/config/environment.rb +43 -0
  14. data/environments/rails-2.3/config/environments/development.rb +17 -0
  15. data/environments/rails-2.3/config/environments/production.rb +28 -0
  16. data/environments/rails-2.3/config/environments/test.rb +28 -0
  17. data/environments/rails-2.3/config/initializers/backtrace_silencers.rb +7 -0
  18. data/environments/rails-2.3/config/initializers/cookie_verification_secret.rb +7 -0
  19. data/environments/rails-2.3/config/initializers/inflections.rb +10 -0
  20. data/environments/rails-2.3/config/initializers/mime_types.rb +5 -0
  21. data/environments/rails-2.3/config/initializers/new_rails_defaults.rb +21 -0
  22. data/environments/rails-2.3/config/initializers/session_store.rb +15 -0
  23. data/environments/rails-2.3/config/locales/en.yml +5 -0
  24. data/environments/rails-2.3/config/routes.rb +43 -0
  25. data/environments/rails-2.3/db/seeds.rb +7 -0
  26. data/environments/rails-2.3/doc/README_FOR_APP +2 -0
  27. data/environments/rails-2.3/public/404.html +30 -0
  28. data/environments/rails-2.3/public/422.html +30 -0
  29. data/environments/rails-2.3/public/500.html +30 -0
  30. data/environments/rails-2.3/public/favicon.ico +0 -0
  31. data/environments/rails-2.3/public/images/rails.png +0 -0
  32. data/environments/rails-2.3/public/index.html +275 -0
  33. data/environments/rails-2.3/public/javascripts/application.js +2 -0
  34. data/environments/rails-2.3/public/javascripts/controls.js +963 -0
  35. data/environments/rails-2.3/public/javascripts/dragdrop.js +973 -0
  36. data/environments/rails-2.3/public/javascripts/effects.js +1128 -0
  37. data/environments/rails-2.3/public/javascripts/prototype.js +4320 -0
  38. data/environments/rails-2.3/public/robots.txt +5 -0
  39. data/environments/rails-2.3/script/about +4 -0
  40. data/environments/rails-2.3/script/console +3 -0
  41. data/environments/rails-2.3/script/dbconsole +3 -0
  42. data/environments/rails-2.3/script/destroy +3 -0
  43. data/environments/rails-2.3/script/generate +3 -0
  44. data/environments/rails-2.3/script/performance/benchmarker +3 -0
  45. data/environments/rails-2.3/script/performance/profiler +3 -0
  46. data/environments/rails-2.3/script/plugin +3 -0
  47. data/environments/rails-2.3/script/runner +3 -0
  48. data/environments/rails-2.3/script/server +3 -0
  49. data/environments/rails-2.3/test/performance/browsing_test.rb +9 -0
  50. data/environments/rails-2.3/test/test_helper.rb +38 -0
  51. data/environments/rails-3.1/.gitignore +15 -0
  52. data/environments/rails-3.1/README +261 -0
  53. data/environments/rails-3.1/Rakefile +7 -0
  54. data/environments/rails-3.1/app/assets/images/rails.png +0 -0
  55. data/environments/rails-3.1/app/assets/javascripts/application.js +9 -0
  56. data/environments/rails-3.1/app/assets/stylesheets/application.css +7 -0
  57. data/environments/rails-3.1/app/controllers/application_controller.rb +3 -0
  58. data/environments/rails-3.1/app/helpers/application_helper.rb +2 -0
  59. data/environments/rails-3.1/app/mailers/.gitkeep +0 -0
  60. data/environments/rails-3.1/app/models/.gitkeep +0 -0
  61. data/environments/rails-3.1/app/views/layouts/application.html.erb +14 -0
  62. data/environments/rails-3.1/config.ru +4 -0
  63. data/environments/rails-3.1/config/application.rb +48 -0
  64. data/environments/rails-3.1/config/boot.rb +6 -0
  65. data/environments/rails-3.1/config/database.yml +25 -0
  66. data/environments/rails-3.1/config/environment.rb +5 -0
  67. data/environments/rails-3.1/config/environments/development.rb +30 -0
  68. data/environments/rails-3.1/config/environments/production.rb +60 -0
  69. data/environments/rails-3.1/config/environments/test.rb +39 -0
  70. data/environments/rails-3.1/config/initializers/backtrace_silencers.rb +7 -0
  71. data/environments/rails-3.1/config/initializers/inflections.rb +10 -0
  72. data/environments/rails-3.1/config/initializers/mime_types.rb +5 -0
  73. data/environments/rails-3.1/config/initializers/secret_token.rb +7 -0
  74. data/environments/rails-3.1/config/initializers/session_store.rb +8 -0
  75. data/environments/rails-3.1/config/initializers/wrap_parameters.rb +14 -0
  76. data/environments/rails-3.1/config/locales/en.yml +5 -0
  77. data/environments/rails-3.1/config/routes.rb +58 -0
  78. data/environments/rails-3.1/db/seeds.rb +7 -0
  79. data/environments/rails-3.1/doc/README_FOR_APP +2 -0
  80. data/environments/rails-3.1/lib/assets/.gitkeep +0 -0
  81. data/environments/rails-3.1/lib/tasks/.gitkeep +0 -0
  82. data/environments/rails-3.1/public/404.html +26 -0
  83. data/environments/rails-3.1/public/422.html +26 -0
  84. data/environments/rails-3.1/public/500.html +26 -0
  85. data/environments/rails-3.1/public/favicon.ico +0 -0
  86. data/environments/rails-3.1/public/index.html +241 -0
  87. data/environments/rails-3.1/public/robots.txt +5 -0
  88. data/environments/rails-3.1/script/rails +6 -0
  89. data/environments/rails-3.1/test/fixtures/.gitkeep +0 -0
  90. data/environments/rails-3.1/test/functional/.gitkeep +0 -0
  91. data/environments/rails-3.1/test/integration/.gitkeep +0 -0
  92. data/environments/rails-3.1/test/performance/browsing_test.rb +12 -0
  93. data/environments/rails-3.1/test/test_helper.rb +13 -0
  94. data/environments/rails-3.1/test/unit/.gitkeep +0 -0
  95. data/environments/rails-3.1/vendor/assets/stylesheets/.gitkeep +0 -0
  96. data/environments/rails-3.1/vendor/plugins/.gitkeep +0 -0
  97. data/environments/rails.rb +26 -0
  98. data/gemfiles/rails-2.3.14 +5 -0
  99. data/gemfiles/rails-2.3.14.lock +55 -0
  100. data/gemfiles/rails-3.1.3 +5 -0
  101. data/gemfiles/rails-3.1.3.lock +110 -0
  102. data/gravatar-ultimate.gemspec +13 -53
  103. data/lib/gravatar.rb +68 -30
  104. data/lib/gravatar/cache.rb +27 -21
  105. data/lib/gravatar/dependencies.rb +1 -18
  106. data/lib/gravatar/test_case.rb +105 -0
  107. data/lib/gravatar/version.rb +8 -0
  108. data/spec/fixtures/image.jpg +0 -0
  109. data/spec/fixtures/responses/grav.addresses +24 -0
  110. data/spec/fixtures/responses/grav.deleteUserimage +18 -0
  111. data/spec/fixtures/responses/grav.exists +20 -0
  112. data/spec/fixtures/responses/grav.exists.invalid +20 -0
  113. data/spec/fixtures/responses/grav.exists.multiple_invalid +21 -0
  114. data/spec/fixtures/responses/grav.removeImage +20 -0
  115. data/spec/fixtures/responses/grav.saveData +18 -0
  116. data/spec/fixtures/responses/grav.saveUrl +18 -0
  117. data/spec/fixtures/responses/grav.test +22 -0
  118. data/spec/fixtures/responses/grav.useUserimage +20 -0
  119. data/spec/fixtures/responses/grav.userimages +27 -0
  120. data/spec/lib/gravatar/cache_setup_spec.rb +2 -0
  121. data/spec/lib/gravatar/{cache_and_logger_spec.rb → cache_spec.rb} +12 -1
  122. data/spec/lib/gravatar/test_case_spec.rb +40 -0
  123. data/spec/lib/gravatar_spec.rb +97 -61
  124. data/spec/spec_helper.rb +37 -9
  125. metadata +208 -38
  126. data/VERSION +0 -1
  127. data/spec/lib/gravatar/dependencies_spec.rb +0 -33
data/.gitignore CHANGED
@@ -22,3 +22,16 @@ rdoc
22
22
  pkg
23
23
 
24
24
  ## PROJECT::SPECIFIC
25
+ spec/fixtures/requests
26
+ spec/credentials.yml
27
+
28
+
29
+ rails*/.bundle
30
+
31
+ # Ignore the default SQLite database.
32
+ rails*/db/*.sqlite3
33
+
34
+ # Ignore all logfiles and tempfiles.
35
+ rails*/log/*.log
36
+ rails*/tmp
37
+
@@ -0,0 +1,16 @@
1
+ rvm:
2
+ - 1.8.7
3
+ - 1.9.2
4
+ - 1.9.3
5
+ - jruby
6
+ - rbx-18mode
7
+ - ree
8
+ - ruby-head
9
+
10
+ gemfile:
11
+ - Gemfile
12
+ - gemfiles/rails-2.3.14
13
+ - gemfiles/rails-3.1.3
14
+
15
+ env:
16
+ - DEBUG=1
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "http://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in jax.gemspec
4
+ gemspec
5
+
6
+ gem 'jruby-openssl', :platforms => :jruby
@@ -0,0 +1,37 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ gravatar-ultimate (1.0.3)
5
+
6
+ GEM
7
+ remote: http://rubygems.org/
8
+ specs:
9
+ activesupport (2.3.14)
10
+ diff-lcs (1.1.3)
11
+ fakeweb (1.3.0)
12
+ i18n (0.6.0)
13
+ json (1.6.1)
14
+ rake (0.9.2.2)
15
+ rdoc (3.11)
16
+ json (~> 1.4)
17
+ rspec (2.8.0)
18
+ rspec-core (~> 2.8.0)
19
+ rspec-expectations (~> 2.8.0)
20
+ rspec-mocks (~> 2.8.0)
21
+ rspec-core (2.8.0)
22
+ rspec-expectations (2.8.0)
23
+ diff-lcs (~> 1.1.2)
24
+ rspec-mocks (2.8.0)
25
+
26
+ PLATFORMS
27
+ ruby
28
+
29
+ DEPENDENCIES
30
+ activesupport (>= 2.3.14)
31
+ fakeweb (>= 1.2.8)
32
+ gravatar-ultimate!
33
+ i18n (~> 0.6.0)
34
+ jruby-openssl
35
+ rake (~> 0.9.2.2)
36
+ rdoc (~> 3.11)
37
+ rspec (>= 1.3.0)
@@ -1,14 +1,12 @@
1
- = gravatar-ultimate
1
+ = gravatar-ultimate {<img src="https://secure.travis-ci.org/sinisterchipmunk/gravatar.png" />}[http://travis-ci.org/sinisterchipmunk/gravatar]
2
2
 
3
3
  The Ultimate Gravatar Gem!
4
4
 
5
- This gem is used to interface with the entire Gravatar API: it's not just for generating image URLs, but for connecting
6
- to and communicating with the XML-RPC API too! Additionally, it can be used to download the Gravatar image data itself,
7
- rather than just a URL to that data. This saves you the extra step of having to do so.
5
+ This gem is used to interface with the entire Gravatar API: it's not just for generating image URLs, but for connecting to and communicating with the XML-RPC API too! Additionally, it can be used to download the Gravatar image data itself, rather than just a URL to that data. This saves you the extra step of having to do so.
8
6
 
9
7
  == Installation
10
8
 
11
- gem install gravitar-ultimate
9
+ gem install gravatar-ultimate
12
10
 
13
11
  == Activate the gem...
14
12
 
@@ -18,19 +16,19 @@ As with any gem, you have to type a few lines to tell Ruby to actually *use* it.
18
16
 
19
17
  * Edit your Gemfile
20
18
  * Add this line:
21
- gem 'gravitar-ultimate'
19
+ gem 'gravatar-ultimate'
22
20
 
23
21
  ==== ...in Ruby on Rails (v2.x)
24
22
 
25
23
  * Edit your config/environment.rb file
26
24
  * Add this line beneath "Rails::Initializer.run do |config|":
27
- config.gem 'gravitar-ultimate'
25
+ config.gem 'gravatar-ultimate'
28
26
 
29
27
  ==== ...in vanilla Ruby
30
28
 
31
29
  require 'rubygems'
32
- gem 'gravitar-ultimate'
33
- require 'gravitar-ultimate'
30
+ gem 'gravatar-ultimate'
31
+ require 'gravatar-ultimate'
34
32
 
35
33
  == Usage
36
34
  Using the gem is actually pretty simple. Let's say you want the Gravatar image URL for "generic@example.com":
@@ -56,10 +54,7 @@ After you have that, things get a lot easier:
56
54
 
57
55
  == Caching
58
56
 
59
- As you can see this is quite powerful. But it gets better. Gravatar Ultimate even manages caching of API responses for
60
- you! That way, if an error occurs, (such as the Gravatar site being offline), your code won't break. It'll instead
61
- gracefully fall back to the cached copy! By default, if you are using Rails, it'll use the Rails cache. Otherwise, it'll
62
- use whatever cache you're using with Gravatar (by default an instance of ActiveSupport::Cache::FileStore).
57
+ As you can see this is quite powerful. But it gets better. Gravatar Ultimate even manages caching of API responses for you! That way, if an error occurs, (such as the Gravatar site being offline), your code won't break. It'll instead gracefully fall back to the cached copy! By default, if you are using Rails, it'll use the Rails cache. Otherwise, it'll use whatever cache you're using with Gravatar (by default an instance of ActiveSupport::Cache::FileStore).
63
58
 
64
59
  This has obvious benefits when used for the API calls that do not result in changing the user's profile, but what you
65
60
  might not have thought of yet is that it also caches #image_data, so you can hook your application up to that method
@@ -69,12 +64,9 @@ To customize exactly which cache is used, see the next section...
69
64
 
70
65
  === Configuration
71
66
 
72
- To see settings and options you can give for a particular Gravatar instance, check out the Gravatar class documentation.
73
- There are a few things you can set for Gravatar on a system-wide basis, and that's what we'll go over next.
67
+ To see settings and options you can give for a particular Gravatar instance, check out the Gravatar class documentation. There are a few things you can set for Gravatar on a system-wide basis, and that's what we'll go over next.
74
68
 
75
- For a non-Rails project, simply set these options before you start using Gravatar. For a Rails project, you should set
76
- them within an Initializer in config/initializers/any_filename.rb in order to ensure that the settings are applied
77
- (A) after Gravatar has been included into the project, and (B) before it is actually used by Rails.
69
+ For a non-Rails project, simply set these options before you start using Gravatar. For a Rails project, you should set them within an Initializer in config/initializers/any_filename.rb in order to ensure that the settings are applied (A) after Gravatar has been included into the project, and (B) before it is actually used by Rails.
78
70
 
79
71
  # You can set the default cache for Gravatar to use:
80
72
  Gravatar.cache = ActiveSupport::Cache::SynchronizedMemoryStore.new
@@ -86,21 +78,23 @@ them within an Initializer in config/initializers/any_filename.rb in order to en
86
78
  # the Rails logger if it's available. Otherwise, the default is $stdout.
87
79
  grav_log = ""
88
80
  Gravatar.logger = StringIO.new(grav_log) # logs Gravatar output to a String
89
-
81
+
90
82
  == Note on Patches/Pull Requests
91
83
 
92
84
  * Fork the project.
93
85
  * Make your feature addition or bug fix.
94
- * Add tests for it. This is important so I don't break it in a
95
- future version unintentionally.
96
- * Commit, do not mess with rakefile, version, or history.
97
- (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
86
+ * Add tests for it. This is important so I don't break it in a future version unintentionally.
87
+ * Don't update the version number. (If you want to have your own version, that's fine but bump version in a commit by itself I can ignore when I pull.)
98
88
  * Send me a pull request. Bonus points for topic branches.
99
89
 
100
90
  == Copyright
101
91
 
102
- Copyright (c) 2010 Colin MacKenzie IV. See LICENSE for details.
92
+ Copyright (c) 2010-2012 Colin MacKenzie IV. See LICENSE for details.
103
93
 
104
94
  == Contributors
105
95
 
106
- Ben Tillman - github.com/crossroads
96
+ https://github.com/sinisterchipmunk/gravatar/contributors
97
+
98
+ Also:
99
+
100
+ {abitdodgy (Mohamad El-Husseini)}[https://github.com/abitdodgy] for https://github.com/sinisterchipmunk/gravatar/pull/7
data/Rakefile CHANGED
@@ -1,42 +1,15 @@
1
- require 'rubygems'
2
- require 'rake'
3
-
4
- begin
5
- require 'jeweler'
6
- Jeweler::Tasks.new do |gem|
7
- gem.name = "gravatar-ultimate"
8
- gem.summary = %Q{A gem for interfacing with the entire Gravatar API: not just images, but the XML-RPC API too!}
9
- gem.description = %Q{The Ultimate Gravatar Gem!
10
-
11
- This gem is used to interface with the entire Gravatar API: it's not just for generating image URLs, but for connecting
12
- to and communicating with the XML-RPC API too! Additionally, it can be used to download the Gravatar image data itself,
13
- rather than just a URL to that data. This saves you the extra step of having to do so.}
14
- gem.email = "sinisterchipmunk@gmail.com"
15
- gem.homepage = "http://www.thoughtsincomputation.com/"
16
- gem.authors = ["Colin MacKenzie IV"]
17
- gem.add_dependency "sc-core-ext", ">= 1.2.0"
18
- gem.add_development_dependency "rspec", ">= 1.3.0"
19
- gem.add_development_dependency "fakeweb", ">= 1.2.8"
20
- end
21
- Jeweler::GemcutterTasks.new
22
- rescue LoadError
23
- puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
24
- end
25
-
26
- require 'spec/rake/spectask'
27
- Spec::Rake::SpecTask.new(:test) do |test|
28
- test.libs << 'lib' << 'spec'
29
- test.pattern = 'spec/**/*_spec.rb'
30
- test.verbose = true
31
- end
1
+ require 'bundler'
2
+ Bundler::GemHelper.install_tasks
3
+ Bundler.setup
32
4
 
5
+ require 'rspec/core/rake_task'
33
6
  desc "Run all specs"
34
- task :spec => :test
7
+ RSpec::Core::RakeTask.new
35
8
 
36
9
  begin
37
10
  gem 'rcov'
38
11
  require 'rcov/rcovtask'
39
- Spec::Rake::SpecTask.new(:coverage) do |test|
12
+ RSpec::Core::RakeTask.new(:coverage) do |test|
40
13
  test.libs << 'lib' << 'spec'
41
14
  test.pattern = "spec/**/*_spec.rb"
42
15
  test.verbose = true
@@ -49,12 +22,10 @@ rescue LoadError
49
22
  end
50
23
  end
51
24
 
52
- task :test => :check_dependencies
53
-
54
- task :default => :test
25
+ task :default => :spec
55
26
 
56
- require 'rake/rdoctask'
57
- Rake::RDocTask.new do |rdoc|
27
+ require 'rdoc/task'
28
+ RDoc::Task.new do |rdoc|
58
29
  version = File.exist?('VERSION') ? File.read('VERSION') : ""
59
30
 
60
31
  rdoc.rdoc_dir = 'rdoc'
@@ -0,0 +1,243 @@
1
+ == Welcome to Rails
2
+
3
+ Rails is a web-application framework that includes everything needed to create
4
+ database-backed web applications according to the Model-View-Control pattern.
5
+
6
+ This pattern splits the view (also called the presentation) into "dumb" templates
7
+ that are primarily responsible for inserting pre-built data in between HTML tags.
8
+ The model contains the "smart" domain objects (such as Account, Product, Person,
9
+ Post) that holds all the business logic and knows how to persist themselves to
10
+ a database. The controller handles the incoming requests (such as Save New Account,
11
+ Update Product, Show Post) by manipulating the model and directing data to the view.
12
+
13
+ In Rails, the model is handled by what's called an object-relational mapping
14
+ layer entitled Active Record. This layer allows you to present the data from
15
+ database rows as objects and embellish these data objects with business logic
16
+ methods. You can read more about Active Record in
17
+ link:files/vendor/rails/activerecord/README.html.
18
+
19
+ The controller and view are handled by the Action Pack, which handles both
20
+ layers by its two parts: Action View and Action Controller. These two layers
21
+ are bundled in a single package due to their heavy interdependence. This is
22
+ unlike the relationship between the Active Record and Action Pack that is much
23
+ more separate. Each of these packages can be used independently outside of
24
+ Rails. You can read more about Action Pack in
25
+ link:files/vendor/rails/actionpack/README.html.
26
+
27
+
28
+ == Getting Started
29
+
30
+ 1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
31
+ and your application name. Ex: rails myapp
32
+ 2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
33
+ 3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
34
+ 4. Follow the guidelines to start developing your application
35
+
36
+
37
+ == Web Servers
38
+
39
+ By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
40
+ with a variety of other web servers.
41
+
42
+ Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
43
+ suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
44
+ getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
45
+ More info at: http://mongrel.rubyforge.org
46
+
47
+ Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
48
+ Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
49
+ FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
50
+
51
+ == Apache .htaccess example for FCGI/CGI
52
+
53
+ # General Apache options
54
+ AddHandler fastcgi-script .fcgi
55
+ AddHandler cgi-script .cgi
56
+ Options +FollowSymLinks +ExecCGI
57
+
58
+ # If you don't want Rails to look in certain directories,
59
+ # use the following rewrite rules so that Apache won't rewrite certain requests
60
+ #
61
+ # Example:
62
+ # RewriteCond %{REQUEST_URI} ^/notrails.*
63
+ # RewriteRule .* - [L]
64
+
65
+ # Redirect all requests not available on the filesystem to Rails
66
+ # By default the cgi dispatcher is used which is very slow
67
+ #
68
+ # For better performance replace the dispatcher with the fastcgi one
69
+ #
70
+ # Example:
71
+ # RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
72
+ RewriteEngine On
73
+
74
+ # If your Rails application is accessed via an Alias directive,
75
+ # then you MUST also set the RewriteBase in this htaccess file.
76
+ #
77
+ # Example:
78
+ # Alias /myrailsapp /path/to/myrailsapp/public
79
+ # RewriteBase /myrailsapp
80
+
81
+ RewriteRule ^$ index.html [QSA]
82
+ RewriteRule ^([^.]+)$ $1.html [QSA]
83
+ RewriteCond %{REQUEST_FILENAME} !-f
84
+ RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
85
+
86
+ # In case Rails experiences terminal errors
87
+ # Instead of displaying this message you can supply a file here which will be rendered instead
88
+ #
89
+ # Example:
90
+ # ErrorDocument 500 /500.html
91
+
92
+ ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
93
+
94
+
95
+ == Debugging Rails
96
+
97
+ Sometimes your application goes wrong. Fortunately there are a lot of tools that
98
+ will help you debug it and get it back on the rails.
99
+
100
+ First area to check is the application log files. Have "tail -f" commands running
101
+ on the server.log and development.log. Rails will automatically display debugging
102
+ and runtime information to these files. Debugging info will also be shown in the
103
+ browser on requests from 127.0.0.1.
104
+
105
+ You can also log your own messages directly into the log file from your code using
106
+ the Ruby logger class from inside your controllers. Example:
107
+
108
+ class WeblogController < ActionController::Base
109
+ def destroy
110
+ @weblog = Weblog.find(params[:id])
111
+ @weblog.destroy
112
+ logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
113
+ end
114
+ end
115
+
116
+ The result will be a message in your log file along the lines of:
117
+
118
+ Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
119
+
120
+ More information on how to use the logger is at http://www.ruby-doc.org/core/
121
+
122
+ Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
123
+
124
+ * The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
125
+ * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
126
+
127
+ These two online (and free) books will bring you up to speed on the Ruby language
128
+ and also on programming in general.
129
+
130
+
131
+ == Debugger
132
+
133
+ Debugger support is available through the debugger command when you start your Mongrel or
134
+ Webrick server with --debugger. This means that you can break out of execution at any point
135
+ in the code, investigate and change the model, AND then resume execution!
136
+ You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
137
+ Example:
138
+
139
+ class WeblogController < ActionController::Base
140
+ def index
141
+ @posts = Post.find(:all)
142
+ debugger
143
+ end
144
+ end
145
+
146
+ So the controller will accept the action, run the first line, then present you
147
+ with a IRB prompt in the server window. Here you can do things like:
148
+
149
+ >> @posts.inspect
150
+ => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
151
+ #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
152
+ >> @posts.first.title = "hello from a debugger"
153
+ => "hello from a debugger"
154
+
155
+ ...and even better is that you can examine how your runtime objects actually work:
156
+
157
+ >> f = @posts.first
158
+ => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
159
+ >> f.
160
+ Display all 152 possibilities? (y or n)
161
+
162
+ Finally, when you're ready to resume execution, you enter "cont"
163
+
164
+
165
+ == Console
166
+
167
+ You can interact with the domain model by starting the console through <tt>script/console</tt>.
168
+ Here you'll have all parts of the application configured, just like it is when the
169
+ application is running. You can inspect domain models, change values, and save to the
170
+ database. Starting the script without arguments will launch it in the development environment.
171
+ Passing an argument will specify a different environment, like <tt>script/console production</tt>.
172
+
173
+ To reload your controllers and models after launching the console run <tt>reload!</tt>
174
+
175
+ == dbconsole
176
+
177
+ You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
178
+ You would be connected to the database with the credentials defined in database.yml.
179
+ Starting the script without arguments will connect you to the development database. Passing an
180
+ argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
181
+ Currently works for mysql, postgresql and sqlite.
182
+
183
+ == Description of Contents
184
+
185
+ app
186
+ Holds all the code that's specific to this particular application.
187
+
188
+ app/controllers
189
+ Holds controllers that should be named like weblogs_controller.rb for
190
+ automated URL mapping. All controllers should descend from ApplicationController
191
+ which itself descends from ActionController::Base.
192
+
193
+ app/models
194
+ Holds models that should be named like post.rb.
195
+ Most models will descend from ActiveRecord::Base.
196
+
197
+ app/views
198
+ Holds the template files for the view that should be named like
199
+ weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
200
+ syntax.
201
+
202
+ app/views/layouts
203
+ Holds the template files for layouts to be used with views. This models the common
204
+ header/footer method of wrapping views. In your views, define a layout using the
205
+ <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
206
+ call <% yield %> to render the view using this layout.
207
+
208
+ app/helpers
209
+ Holds view helpers that should be named like weblogs_helper.rb. These are generated
210
+ for you automatically when using script/generate for controllers. Helpers can be used to
211
+ wrap functionality for your views into methods.
212
+
213
+ config
214
+ Configuration files for the Rails environment, the routing map, the database, and other dependencies.
215
+
216
+ db
217
+ Contains the database schema in schema.rb. db/migrate contains all
218
+ the sequence of Migrations for your schema.
219
+
220
+ doc
221
+ This directory is where your application documentation will be stored when generated
222
+ using <tt>rake doc:app</tt>
223
+
224
+ lib
225
+ Application specific libraries. Basically, any kind of custom code that doesn't
226
+ belong under controllers, models, or helpers. This directory is in the load path.
227
+
228
+ public
229
+ The directory available for the web server. Contains subdirectories for images, stylesheets,
230
+ and javascripts. Also contains the dispatchers and the default HTML files. This should be
231
+ set as the DOCUMENT_ROOT of your web server.
232
+
233
+ script
234
+ Helper scripts for automation and generation.
235
+
236
+ test
237
+ Unit and functional tests along with fixtures. When using the script/generate scripts, template
238
+ test files will be generated for you and placed in this directory.
239
+
240
+ vendor
241
+ External libraries that the application depends on. Also includes the plugins subdirectory.
242
+ If the app has frozen rails, those gems also go here, under vendor/rails/.
243
+ This directory is in the load path.