app_config 0.2.4 → 0.3.1

data/README

@@ -23,6 +23,8 @@ Use it like so:
   AppConfig.setup do |config|
     config[:storage_method] = :yaml
     config[:path] = '/path/to/app_config.yml'
+    # ..or..
+    config[:uri] = 'yaml://path/to/app_config.yml'
   end
 
   # Later on...
@@ -36,13 +38,34 @@ Want SQLite3?  No problem!
   AppConfig.setup do |config|
     config[:storage_method] = :sqlite
     config[:database] = '/path/to/database.sqlite3'
-    config[:table] = 'app_config'
+    # ..or..
+    config[:uri] = 'sqlite://path/to/database.sqlite3'
+
+    config[:table] = 'app_config' # defaults to 'app_config'
   end
 
   AppConfig[:column]  # => 'value'
 
-You can also pass a <tt>:uri</tt> option, which will automatically determine
-the options for the storage method.  So in the block (or passed in hash):
 
-  config[:uri] = 'sqlite://path/to/database.sqlite3'
-  config[:uri] = 'yaml://path/to/app_config.yml'
+== Rails Mode
+
+As of version 0.3.1, there's a 'Rails mode' where you can organize
+the config file sort of like Rails' database config.
+
+*NOTE:* This might get renamed to a more Rack-ish 'environment' mode.
+
+  development:
+    name: 'Dev Mode'
+
+  production:
+    name: 'Production Mode'
+
+Then set the <tt>:rails</tt> option to true (it's false by default).
+
+  AppConfig.setup do |config|
+    config[:rails] = true
+    config[:uri] = 'yaml://path/to/app_config.yml'
+  end
+
+  # If Rails.env is 'production'
+  AppConfig[:name] = 'Production Mode'

data/lib/app_config.rb

@@ -1,37 +1,32 @@
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
 # TODO: Only load deps if needed (no gems unless required).
-libs = %w{ sqlite3 yaml uri }
+dependencies = %w{ sqlite3 yaml uri }
 
 begin
-  libs.each { |lib| require lib }
+  dependencies.each { |lib| require lib }
 rescue LoadError
   require 'rubygems'
-  libs.each { |lib| require lib }
+  dependencies.each { |lib| require lib }
 end
 
+# AppConfig stuff.
 require 'core_ext/hashish'
 
-# TODO: Move these to their own file.
-class NotConfigured < Exception
-  def to_s; "Must call 'AppConfig.setup' to setup storage!"; end
-end
-class UnknownStorageMethod < Exception; end
-
 module AppConfig
-  VERSION = '0.2.4'
+  VERSION = '0.3.1'
 
   autoload :Base, 'app_config/base'
+  autoload :Error, 'app_config/error'
   autoload :Storage, 'app_config/storage'
 
   # Returns the AppConfig version string.
   def self.to_version
-    "#{self.class} v#{VERSION}"
+    "#{self.name} v#{VERSION}"
   end
 
   # Access the configured <tt>key</tt>'s value.
   def self.[](key)
-    raise NotConfigured unless defined?(@@storage)
     @@storage[key]
   end
 
@@ -41,4 +36,8 @@ module AppConfig
     @@storage = AppConfig::Base.new(options, &block)
   end
 
+  def self.to_hash
+    @@storage.to_hash
+  end
+
 end # AppConfig

data/lib/app_config/base.rb

@@ -20,42 +20,55 @@ module AppConfig
     def initialize(options = {}, &block)
       @options = DEFAULTS.merge(options)
       yield @options if block_given?
+
       determine_storage_method if @options[:uri]
       @storage = initialize_storage
     end
 
     # Access the <tt>key</tt>'s value in @storage.
     def [](key)
-      @storage[key]
+      storage[key]
+    end
+
+    def storage
+      rails_enabled? ? @storage[::Rails.env] : @storage
     end
 
-  private
-
-  # Sets the storage_method depending on the URI given.
-  def determine_storage_method
-    uri = URI.parse(@options.delete(:uri))
-    case uri.scheme
-    when 'sqlite'
-      @options[:storage_method] = :sqlite
-      @options[:database] = uri.path
-    when 'yaml'
-      @options[:storage_method] = :yaml
-      @options[:path] = uri.path
+    def to_hash
+      storage.to_hash
     end
-  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).
-  def initialize_storage
-    case @options[:storage_method]
-    when :sqlite
-      AppConfig::Storage::Sqlite.load(@options)
-    when :yaml
-      AppConfig::Storage::YAML.load(@options)
-    else
-      raise UnknownStorageMethod
+
+    private
+
+    # Sets the storage_method depending on the URI given.
+    def determine_storage_method
+      uri = URI.parse(@options.delete(:uri))
+      case uri.scheme
+      when 'sqlite'
+        @options[:storage_method] = :sqlite
+        @options[:database] = uri.path
+      when 'yaml'
+        @options[:storage_method] = :yaml
+        @options[:path] = uri.path
+      end
+    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).
+    def initialize_storage
+      case @options[:storage_method]
+      when :sqlite
+        AppConfig::Storage::Sqlite.load(@options)
+      when :yaml
+        AppConfig::Storage::YAML.load(@options)
+      else
+        raise Error::UnknownStorageMethod
+      end
+    end
+
+    def rails_enabled?
+      @options[:rails] || false
     end
-  end
 
   end # Base
 end # AppConfig

data/lib/app_config/storage/sqlite.rb

@@ -37,6 +37,7 @@ module AppConfig
         values(columns(table))
       end
 
+      # Return the values for a given +columns+ (as a Hashish).
       def values(columns)
         data = Hashish.new
         query = "SELECT #{columns.join(', ')} FROM #{@options[:table]}"
@@ -46,6 +47,7 @@ module AppConfig
         data
       end
 
+      # Return the column names of a given +table+ (as an Array).
       def columns(table)
         columns = table.split(', ')
         # Trip the first element, since it's the SQL CREATE statement.

data/lib/core_ext/hashish.rb

@@ -135,3 +135,11 @@ end
 
 # Simple alias.
 Hashish = HashWithIndifferentAccess
+
+class Hash
+  def with_indifferent_access
+    hash = Hashish.new(self)
+    hash.default = self.default
+    hash
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: app_config
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.3.1
 platform: ruby
 authors: 
 - Dale Campbell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-27 00:00:00 -05:00
+date: 2009-10-01 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency