Skip to content
Browse files

AS guide: documents Kernel#require_library_or_gem

  • Loading branch information...
1 parent e3a95cb commit 7cb459eb60a27571fb68ad2919f071e13b38614d @fxn fxn committed Feb 6, 2010
Showing with 14 additions and 0 deletions.
  1. +14 −0 railties/guides/source/active_support_core_extensions.textile
View
14 railties/guides/source/active_support_core_extensions.textile
@@ -422,6 +422,20 @@ end
NOTE: Defined in +active_support/core_ext/kernel/reporting.rb+.
+h4. +require_library_or_gem+
+
+The convenience method +require_library_or_gem+ tries to load its argument with a regular +require+ first. If it fails loads +rubygems+ and tries again.
+
+If the first attempt is a failure and +rubygems+ can't be loaded the method raises +LoadError+. On the other hand, if +rubygems+ is available but the argument is not loadable as a gem, the method gives up and +LoadError+ is also raised.
+
+For example, that's the way the MySQL adapter loads the MySQL library:
+
+<ruby>
+require_library_or_gem('mysql')
+</ruby>
+
+NOTE: Defined in +active_support/core_ext/kernel/requires.rb+.
+
h3. Extensions to +Module+
h4. Aliasing

0 comments on commit 7cb459e

Please sign in to comment.
Something went wrong with that request. Please try again.