sinatra-mongoid-config 0.0.2 → 0.1.0

data/README.md

@@ -15,45 +15,117 @@ If you're using Bundler, just add `gem "sinatra-mongoid-config"` to your `Gemfil
 Using the Extension
 -------------------
 
-As with all Sinatra extensions, it's simply a matter of **requiring the library** and **registering the extension**. Other than that, you should just **set the database name**.
+This extension works fine with both "classic" Sinatra apps, as well as "modular" apps which inherit from `Sinatra::Base`. How you use the extension varies slightly between styles.
 
+### "Classic"
+
+    require 'rubygems'
     require 'sinatra'
     require 'sinatra-mongoid-config'
     
-    register Sinatra::MongoidConfig
-    
-    configure do
-      set :mongo_db, 'the_database_name'
-    end
-    
     get '/' do
       'It works!'
     end
-    
-Note that this extension works fine both with classic-style Sinatra apps like the one above, as well as modular-style apps which inherit from `Sinatra::Base`.
 
-### Options
+### "Modular"
 
-    app.set :mongo_host,     ENV['MONGO_HOST'] || 'localhost'
-    app.set :mongo_db,       ENV['MONGO_DB']   || 'sinatra-mongoid'
-    app.set :mongo_port,     ENV['MONGO_PORT'] || Mongo::Connection::DEFAULT_PORT
-    app.set :mongo_user,     ENV['MONGO_USER']
-    app.set :mongo_password, ENV['MONGO_PASSWORD']
+    require 'rubygems'
+    require 'sinatra'
+    require 'sinatra-mongoid-config'
+    
+    class MyApp < Sinatra::Base
+    
+      register Sinatra::MongoidConfig
+    
+      get '/' do
+        'It works!'
+      end
+    
+    end
+    
+Options & Defaults
+------------------
 
-All configuration options have **sensible defaults listed above**, and in most cases, you can get away with just setting the `:mongo_db`. Remember that you can also change settings for each environment:
+All options are set using Sinatra's standard `set` method. Remember that you can also change settings for each environment:
 
     configure do
-      set :mongo_db, 'the_database_development'
-    end
-
-    configure :test do
-      set :mongo_db, 'the_database_test'
+      set :mongo_db, 'the_database'
+      set :mongo_port, 123
     end
 
     configure :production do
-      set :mongo_db, 'the_database_production'
+      set :mongo_db, 'the_other_database'
+      set :mongo_user, 'the_user'
+      set :mongo_password, 'the_password'
     end
     
+All configuration options have **sensible defaults listed below**, and depending on your situation, you may not have to set anything. 
+
+<table>
+  <thead>
+    <tr>
+      <th style="text-align: left">Option</th>
+      <th style="text-align: left">Default</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><code>:mongo_host</code></td>
+      <td><code>ENV['MONGO_HOST'] || 'localhost'</code></td>
+    </tr>
+    <tr>
+      <td><code>:mongo_db</code></td>
+      <td><code>ENV['MONGO_DB']   || self.app_to_db_name(app)</code></td>
+    </tr>
+    <tr>
+      <td><code>:mongo_port</code></td>
+      <td><code>ENV['MONGO_PORT'] || Mongo::Connection::DEFAULT_PORT</code></td>
+    </tr>
+    <tr>
+      <td><code>:mongo_user</code></td>
+      <td><code>ENV['MONGO_USER']</code></td>
+    </tr>
+    <tr>
+      <td><code>:mongo_password</code></td>
+      <td><code>ENV['MONGO_PASSWORD']</code></td>
+    </tr>
+  </tbody>
+</table>
+
+Did you notice the call to `self.app_to_db_name`? That method attempts to be smart about what your database is named, based on **the class name of your app and the current environment**. The real benefit here is for those who are creating "modular" apps, as they are named something other than the Sinatra default. Here are some examples:
+
+<table>
+  <thead>
+    <tr>
+      <th style="text-align: left">App&rsquo;s Class Name</th>
+      <th style="text-align: left">Environment</th>
+      <th style="text-align: left">Resulting Database Name</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><code>Refresh</code></td>
+      <td><code>:development</code></td>
+      <td><code>refresh_development</code></td>
+    </tr>
+    <tr>
+      <td><code>RefreshChicago</code></td>
+      <td><code>:test</code></td>
+      <td><code>refresh_chicago_test</code></td>
+    </tr>
+    <tr>
+      <td><code>RefreshChicago::Jobs</code></td>
+      <td><code>:production</code></td>
+      <td><code>refresh_chicago_jobs_production</code></td>
+    </tr>
+    <tr>
+      <td><code>Sinatra::Application</code></td>
+      <td><code>:development</code></td>
+      <td><code>sinatra_application_development</code></td>
+    </tr>
+  </tbody>
+</table>
+
 Alternatives
 ------------
 

data/lib/sinatra/mongoid_config.rb

@@ -37,11 +37,28 @@ module Sinatra
       Mongoid.configure.sinatra_app = app
       
       app.set :mongo_host,     ENV['MONGO_HOST'] || 'localhost'
-      app.set :mongo_db,       ENV['MONGO_DB']   || 'sinatra-mongoid'
+      app.set :mongo_db,       ENV['MONGO_DB']   || self.app_to_db_name(app)
       app.set :mongo_port,     ENV['MONGO_PORT'] || Mongo::Connection::DEFAULT_PORT
       app.set :mongo_user,     ENV['MONGO_USER']
       app.set :mongo_password, ENV['MONGO_PASSWORD']
     end
     
+    private
+    
+    # Inspired by the ActiveSupport Inflector's #underscore method
+    def self.app_to_db_name app
+      name = app.
+        to_s.
+        gsub(/::/, '_').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+      
+      "#{ name }_#{ app.environment }"
+    end
+    
   end
+  
+  register MongoidConfig
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Matt Puchlerz