app_config 0.5.3 → 0.6.0

data/{README → README.rdoc}

@@ -9,12 +9,6 @@ An easy to use, customizable library to easily store and retrieve application
 Usage is simple.  Just pass either a hash of options, or a block, to
 AppConfig.setup.  See AppConfig::Base for a list of valid storage methods.
 
-As of version 0.4.1, if the <tt>:storage_method</tt> is not set, AppConfig
-will act pretty much just like a normal Hash:
-
-  AppConfig.setup(:email => 'admin@example.com')
-  AppConfig[:email]    # => 'admin@example.com'
-
 
 == AppConfig::Storage::YAML
 
@@ -43,6 +37,37 @@ Use it like so:
   AppConfig[:api_key]      # => 'SUPERAWESOMESERVICE'
 
 
+== AppConfig::Storage::Mongo
+
+As of version 0.6.0, you can now use <tt>:mongo</tt> as the storage method.
+The values are read/saved (by default) to the 'app_config' database and
+'app_config' collection.  These defaults can be overridden, however, which
+might lend well to versioned configurations; collection names such as
+'app_config_v1', 'app_config_v2', etc.  Check the <tt>DEFAULTS</tt> constant
+in AppConfig::Storage::Mongo for the default Mongo connection options.
+
+  AppConfig.setup do |config|
+    config[:storage_method] = :mongo
+    config[:collection] = 'app_config_v2' # Or any valid Mongo collection name.
+
+    # Override an existing value:
+    config[:admin_email] = 'other_admin@example.com'
+  end
+
+If you wanted to read/update the configuration from the <tt>mongo</tt> client,
+it would look something like this:
+
+  $ mongo
+  MongoDB shell version: 1.6.4
+  connecting to: test
+  > use app_config
+  switched to db app_config
+  > db.app_config.find()
+  { "_id" : ObjectId("4cddc317da98dd42f8000001"), "admin_email" : "admin@example.com" }
+  > db.app_config_v2.find()
+  { "_id" : ObjectId("4cddc317da98dd42f8000001"), "admin_email" : "other_admin@example.com" }
+
+
 == AppConfig::Storage::Sqlite
 
   AppConfig.setup do |config|
@@ -57,6 +82,15 @@ Use it like so:
   AppConfig[:column]  # => 'value'
 
 
+== Basically just a Hash...
+
+As of version 0.4.1, if the <tt>:storage_method</tt> is not set, AppConfig
+will act pretty much just like a normal Hash:
+
+  AppConfig.setup(:email => 'admin@example.com')
+  AppConfig[:email]    # => 'admin@example.com'
+
+
 == Environment Mode
 
 As of version 0.4.0, there's an 'environment mode' where you can organize

data/lib/app_config.rb

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift File.dirname(__FILE__)
 require 'core_ext/hashish'
 
 module AppConfig
-  VERSION = '0.5.3'
+  VERSION = '0.6.0'
 
   autoload :Base, 'app_config/base'
   autoload :Error, 'app_config/error'
@@ -48,7 +48,7 @@ module AppConfig
     private
 
     def validate!
-      raise AppConfig::Error::NotSetup unless defined?(@@storage) && @@storage
+      raise AppConfig::Error::NotSetup unless setup?
     end
 
   end # self

data/lib/app_config/base.rb

@@ -9,6 +9,7 @@ module AppConfig
   #
   # Valid storage methods:
   # * :memory (AppConfig::Storage::Memory)
+  # * :mongo (AppConfig::Storage::Mongo)
   # * :sqlite (AppConfig::Storage::Sqlite)
   # * :yaml (AppConfig::Storage::YAML)
   class Base
@@ -76,11 +77,14 @@ module AppConfig
     end
 
     # This decides how to load the data, based on the +storage_method+.
-    # TODO: Maybe purge AppConfig options (ie, those not related to the user-end).
+    # TODO: Purge AppConfig options (ie, those not related to the user-end).
+    # TODO: This should return an instance of the storage method, instead of calling Storage::Base.load().
     def initialize_storage
       case @options[:storage_method]
       when :memory
         AppConfig::Storage::Memory.load(@options)
+      when :mongo
+        AppConfig::Storage::Mongo.new(@options)
       when :sqlite
         AppConfig::Storage::Sqlite.load(@options)
       when :yaml

data/lib/app_config/error.rb

@@ -1,6 +1,12 @@
 module AppConfig
   module Error
 
+    class MustOverride < Exception
+      def initialize(method)
+        super("Must override method: #{method}")
+      end
+    end
+
     class NotSetup < Exception
       def to_s; "Must call 'AppConfig.setup' to setup storage!"; end
     end

data/lib/app_config/storage/mongo.rb

@@ -9,6 +9,7 @@ module AppConfig
   module Storage
 
     # Mongo storage method.
+    # FIXME: Come up with a way of removing stale config entries.
     class Mongo < Storage::Base
 
       DEFAULTS = {
@@ -39,7 +40,11 @@ module AppConfig
       private
 
       def save!
-        collection.save(@data)
+        if @data.has_key?('_id')
+          collection.update({'_id' => @data['_id']}, @data)
+        else
+          collection.save(@data)
+        end
       end
 
       def setup_connection

data/spec/app_config/storage/mongo_spec.rb

@@ -3,23 +3,16 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 describe AppConfig::Storage::Mongo do
 
   before(:each) do
-    pending "TODO: Spec this out"
+    AppConfig.reset!
+    config_for_mongo
   end
 
   it 'should have some values' do
-    config_for_mongo
     AppConfig[:api_key].should_not be_nil
   end
 
   it 'should update the values' do
-    config_for_mongo
-    original_key = AppConfig[:api_key]
     AppConfig[:api_key] = 'SOME_NEW_API_KEY'
-
-    # Reload the data.
-    AppConfig.reset!
-    config_for_mongo
-
     AppConfig[:api_key].should == 'SOME_NEW_API_KEY'
   end
 end

data/spec/fixtures/app_config_mongo.yml

@@ -0,0 +1,5 @@
+# Test values loaded into the Mongo db.
+---
+admin_email: 'admin@example.com'
+api_name:    'Supr Webz 2.0'
+api_key:     'SUPERAWESOMESERVICE'

data/spec/spec_helper.rb

@@ -28,16 +28,32 @@ RSpec.configure do |config|
   end
 
   def config_for_mongo(opts = {})
-    mongo = {
+    mongo = AppConfig::Storage::Mongo::DEFAULTS.merge({
       :storage_method => :mongo,
       :host => 'localhost',
       :database => 'app_config_spec',
-      :environment => 'test',
-    }
+    })
     begin
       config_for(mongo.merge(opts))
+      load_mongo_test_config(mongo)
     rescue Mongo::ConnectionFailure
       pending "***** Mongo specs require a running MongoDB server *****"
     end
   end
+
+  private
+
+  def load_mongo_test_config(options)
+    connection = ::Mongo::Connection.new(options[:host], options[:port].to_i)
+    database   = connection.db(options[:database])
+    collection = database.collection(options[:collection])
+    test_data = YAML.load_file(fixture('app_config_mongo.yml'))
+
+    data = collection.find_one
+    if data
+      collection.update({'_id' => data['_id']}, test_data)
+    else
+      collection.save(test_data)
+    end
+  end
 end

data/tasks/doc.rake

@@ -7,7 +7,7 @@ end
 
 namespace :doc do
   task :setup_rdoc do
-    @file_list = FileList[ "#{File.join(APP_ROOT, 'README')}",
+    @file_list = FileList[ "#{File.join(APP_ROOT, 'README.rdoc')}",
                            "#{APP_ROOT}/lib/**/*.rb" ]
     # Substitute APP_ROOT with a dot.  Makes for a better index in the generated docs.
     @files = @file_list.collect  {|f| f.gsub(/#{APP_ROOT}/, '.')}
@@ -15,6 +15,7 @@ namespace :doc do
       --all
       --inline-source
       --line-numbers
+      --main README.rdoc
       --op #{File.join(APP_ROOT, 'doc', 'api')}
       --title 'AppConfig API Documentation'
     ]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: app_config
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 3
-  version: 0.5.3
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Dale Campbell
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-07 00:00:00 -04:00
+date: 2010-11-12 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,7 +60,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
+- README.rdoc
 - Rakefile
 - lib/app_config/error.rb
 - lib/app_config/storage.rb
@@ -73,6 +73,7 @@ files:
 - lib/app_config.rb
 - lib/core_ext/hashish.rb
 - spec/watchr.rb
+- spec/fixtures/app_config_mongo.yml
 - spec/fixtures/app_config.yml
 - spec/fixtures/env_app_config.yml
 - spec/app_config_spec.rb