app_config 1.0.0 → 1.0.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    app_config (0.7.1)
+    app_config (1.0.0)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -22,6 +22,11 @@ In it's simplest form, you can use it like so:
 You may also specify the storage method along with options specific to that storage method.
 Check the [wiki](https://github.com/Oshuma/app_config/wiki) for more usage examples.
 
+## Deprecation Note
+
+Version `1.0` is \***not**\* backwards compatible with `0.7.1`!  See the [wiki](https://github.com/Oshuma/app_config/wiki)
+for upgrade instructions.
+
 
 ## AppConfig::Storage::YAML
 

data/lib/app_config.rb

@@ -1,18 +1,34 @@
 require 'core_ext/hashish'
 
 module AppConfig
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 
-  autoload :Base,    'app_config/base'
   autoload :Error,   'app_config/error'
   autoload :Storage, 'app_config/storage'
 
   class << self
 
     # Accepts an `options` hash or a block.
-    # See {AppConfig::Base AppConfig::Base} for valid storage methods.
+    # See each storage method's documentation for their specific options.
+    #
+    # Valid storage methods:
+    # * `:memory` - {AppConfig::Storage::Memory AppConfig::Storage::Memory}
+    # * `:mongo` - {AppConfig::Storage::Mongo AppConfig::Storage::Mongo}
+    # * `:yaml` - {AppConfig::Storage::YAML AppConfig::Storage::YAML}
     def setup(options = {}, &block)
-      @@storage = AppConfig::Base.new(options, &block)
+      @@options = options
+
+      if @@options[:yaml]
+        @@storage = AppConfig::Storage::YAML.new(@@options.delete(:yaml))
+      elsif @@options[:mongo]
+        @@storage = AppConfig::Storage::Mongo.new(@@options.delete(:mongo))
+      else
+        @@storage = AppConfig::Storage::Memory.new(@@options)
+      end
+
+      yield @@storage if block_given?
+
+      to_hash
     end
 
     # Returns `true` if {AppConfig.setup AppConfig.setup} has been called.
@@ -33,17 +49,33 @@ module AppConfig
     # Access the configured `key`'s value.
     def [](key)
       setup unless setup?
-      @@storage[key]
+      storage[key]
     end
 
     # Set a new `value` for `key` (persistence depends on the type of Storage).
     def []=(key, value)
       setup unless setup?
-      @@storage[key] = value
+      storage[key] = value
+    end
+
+    def empty?
+      storage.empty?
     end
 
     def to_hash
-      setup? ? @@storage.to_hash : Hashish.new
+      setup? ? storage.to_hash : Hashish.new
+    end
+
+    private
+
+    def environment
+      (@@options[:environment] || @@options[:env]) || nil
+    end
+    alias_method :env, :environment
+
+    # Returns the `@@storage` contents, which is what is exposed as the configuration.
+    def storage
+      environment ? @@storage[environment] : @@storage
     end
 
   end # self

data/lib/app_config/storage/base.rb

@@ -2,28 +2,14 @@ module AppConfig
   module Storage
     class Base
 
-      attr_reader :data
-
       def initialize(options)
         @options = options
       end
 
-      def [](key)
-        @data[key]
-      end
-
-      def []=(key, value)
-        @data[key] = value
-      end
-
-      def empty?
-        @data.empty?
-      end
-
       def to_hash
         @data.to_hash
       end
 
-    end # BaseStorage
+    end # Base
   end # Storage
 end # AppConfig

data/lib/app_config/storage/memory.rb

@@ -3,10 +3,21 @@ module AppConfig
     class Memory < Storage::Base
 
       def initialize(options)
-        super(options)
         @data = Hashish.new(options)
       end
 
+      def [](key)
+        @data[key]
+      end
+
+      def []=(key, value)
+        @data[key] = value
+      end
+
+      def empty?
+        @data.empty?
+      end
+
     end # Memory
   end # Storage
 end # AppConfig

data/lib/app_config/storage/mongo.rb

@@ -16,11 +16,10 @@ module AppConfig
       }
 
       def initialize(options)
-        super(DEFAULTS.merge(options))
         @connected = false
         @options = DEFAULTS.merge(options)
         setup_connection
-        @data = fetch_data
+        fetch_data!
       end
 
       def [](key)
@@ -32,11 +31,15 @@ module AppConfig
         save!
       end
 
+      def empty?
+        @data.empty?
+      end
+
       private
 
       def save!
-        if @data.has_key?('_id')
-          collection.update({'_id' => @data['_id']}, @data)
+        if @_id
+          collection.update({ '_id' => @_id}, @data)
         else
           collection.save(@data)
         end
@@ -55,9 +58,10 @@ module AppConfig
         @connection && @connection.connected?
       end
 
-      def fetch_data
+      def fetch_data!
         raise 'Not connected to MongoDB' unless connected?
-        Hashish.new(collection.find_one)
+        @data = Hashish.new(collection.find_one)
+        @_id = @data.delete('_id')
       end
 
       def database

data/lib/app_config/storage/yaml.rb

@@ -17,6 +17,22 @@ module AppConfig
         @data = Hashish.new(::YAML.load_file(path))
       end
 
+      def [](key)
+        @data[key]
+      end
+
+      def []=(key, value)
+        @data[key] = value
+      end
+
+      def empty?
+        @data.empty?
+      end
+
+      def to_hash
+        @data.to_hash
+      end
+
     end # YAML
   end # Storage
 end # AppConfig

data/spec/app_config/storage/mongo_spec.rb

@@ -13,14 +13,17 @@ describe AppConfig::Storage::Mongo do
   end
 
   it 'should update the values' do
-    pending 'Needs a little work...'
-    AppConfig.class_variable_get(:@@storage).
-      instance_variable_get(:@storage).should_receive(:save!)
+    AppConfig.class_variable_get(:@@storage).should_receive(:save!)
     AppConfig[:api_key] = 'SOME_NEW_API_KEY'
-
-    # now reload the config options and check the value
-    AppConfig.reset!
-    config_for_mongo({}, false)  # use default options and do not load test data
     AppConfig[:api_key].should == 'SOME_NEW_API_KEY'
   end
+
+  it 'should not have the Mongo _id in storage' do
+    AppConfig['_id'].should be_nil
+  end
+
+  it 'should have a @_id variable for the Mongo ID' do
+    AppConfig.class_variable_get(:@@storage).
+      instance_variable_get(:@_id).should_not be_nil
+  end
 end

data/spec/app_config_spec.rb

@@ -54,4 +54,13 @@ describe AppConfig do
     AppConfig.should be_setup
   end
 
+  it 'should create nested keys' do
+    pending 'Implement nested keys'
+    AppConfig.reset!
+    AppConfig.setup
+
+    AppConfig[:name][:first] = 'Dale'
+    AppConfig[:name][:first].should == 'Dale'
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_config
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -140,7 +140,6 @@ files:
 - app_config.gemspec
 - doc/.gitignore
 - lib/app_config.rb
-- lib/app_config/base.rb
 - lib/app_config/error.rb
 - lib/app_config/storage.rb
 - lib/app_config/storage/base.rb

data/lib/app_config/base.rb

@@ -1,70 +0,0 @@
-module AppConfig
-
-  # The Base storage class.
-  # Acts as a wrapper for the different storage methods.
-  #
-  # See each storage method's documentation for their specific options.
-  #
-  # Valid storage methods:
-  # * `:memory` - {AppConfig::Storage::Memory AppConfig::Storage::Memory}
-  # * `:mongo` - {AppConfig::Storage::Mongo AppConfig::Storage::Mongo}
-  # * `:yaml` - {AppConfig::Storage::YAML AppConfig::Storage::YAML}
-  class Base
-
-    # Accepts either a hash of `options` or a block (which overrides any options passed in the hash).
-    def initialize(options = {}, &block)
-      @options = options
-
-      if @options[:yaml]
-        @storage = AppConfig::Storage::YAML.new(@options.delete(:yaml))
-      elsif @options[:mongo]
-        @storage = AppConfig::Storage::Mongo.new(@options.delete(:mongo))
-      else
-        @storage = AppConfig::Storage::Memory.new(@options)
-      end
-
-      yield @storage if block_given?
-    end
-
-    # Access the `key`'s value in storage.
-    def [](key)
-      if storage.respond_to?(:[])
-        storage[key]
-      else
-        raise AppConfig::Error::MustOverride.new('#[]')
-      end
-    end
-
-    def []=(key, value)
-      if storage.respond_to?(:[]=)
-        storage[key] = value
-      else
-        raise AppConfig::Error::MustOverride.new('#[]=')
-      end
-    end
-
-    def empty?
-      if storage.respond_to?(:empty?)
-        storage.empty?
-      else
-        raise AppConfig::Error::MustOverride.new('#empty?')
-      end
-    end
-
-    def environment
-      (@options[:environment] || @options[:env]) || nil
-    end
-    alias_method :env, :environment
-
-    # Returns the `@storage` contents, which is what is exposed
-    # as the configuration.
-    def storage
-      environment ? @storage[environment] : @storage
-    end
-
-    def to_hash
-      storage.to_hash
-    end
-
-  end # Base
-end # AppConfig