app_config 0.1.0 → 0.2.0

data/README

@@ -7,7 +7,7 @@ configuration, API keys or basically anything in 'key => value' pairs.
 == Usage
 
 Usage is simple.  Just pass either a hash of options, or a block, to
-AppConfig.configure.  See AppConfig::Base for a list of valid options.
+AppConfig.setup.  See AppConfig::Base for a list of valid storage methods.
 
 For example, given this YAML file:
 
@@ -20,9 +20,9 @@ Use it like so:
 
   require 'app_config'
 
-  AppConfig.configure do |config|
-    config.storage_method = :yaml
-    config.path = '/path/to/app_config.yml'
+  AppConfig.setup do |config|
+    config[:storage_method] = :yaml
+    config[:path] = '/path/to/app_config.yml'
   end
 
   AppConfig[admin_email]  # => 'admin@example.com'
@@ -31,9 +31,9 @@ Use it like so:
 
 Want SQLite3 support?  No problem!
 
-  AppConfig.configure do |config|
-    config.storage_method = :sqlite
-    config.database = '/path/to/database.sqlite3'
+  AppConfig.setup do |config|
+    config[:storage_method] = :sqlite
+    config[:database] = '/path/to/database.sqlite3'
   end
 
   AppConfig[:column]  # => 'value'

data/lib/app_config.rb

@@ -1,15 +1,26 @@
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
-require 'yaml'
+libs = %w{ sqlite3 yaml }
+
+begin
+  libs.each { |lib| require lib }
+rescue LoadError
+  require 'rubygems'
+  libs.each { |lib| require lib }
+end
 
 require 'core_ext/hashish'
 
+# TODO: Move these to their own file.
+class UnknownStorageMethod < Exception; end
+
 module AppConfig
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 
   autoload :Base, 'app_config/base'
   autoload :Storage, 'app_config/storage'
 
+  # Returns the AppConfig version string.
   def self.to_version
     "#{self.class} v#{VERSION}"
   end
@@ -21,9 +32,9 @@ module AppConfig
     @@storage[key]
   end
 
-  # Accepts an +options+ hash or pass a block.
-  # See AppConfig::Base for valid options.
-  def self.configure(options = {}, &block)
+  # Accepts an +options+ hash or a block.
+  # See AppConfig::Base for valid storage methods.
+  def self.setup(options = {}, &block)
     @@storage = AppConfig::Base.new(options, &block)
   end
 

data/lib/app_config/base.rb

@@ -6,11 +6,8 @@ module AppConfig
   # See each storage method's documentation for their specific options.
   class Base
 
-    attr_accessor :storage_method, :path
-
     DEFAULTS = {
-      :storage_method => :yaml,
-      :path => File.expand_path(File.join(ENV['HOME'], '.app_config.yml'))
+      :storage_method => :yaml
     }
 
     # Accepts either a hash of +options+ or a block (which overrides
@@ -20,10 +17,8 @@ module AppConfig
     # * :sqlite
     # * :yaml
     def initialize(options = {}, &block)
-      DEFAULTS.merge(options).each_pair do |key, value|
-        self.send("#{ key }=", value)
-      end
-      yield self if block_given?
+      @options = DEFAULTS.merge(options)
+      yield @options if block_given?
       @storage = initialize_storage
     end
 
@@ -36,13 +31,13 @@ module AppConfig
 
     # This decides how to load the data, based on the +storage_method+.
     def initialize_storage
-      case storage_method
+      case @options[:storage_method]
       when :sqlite
-        # TODO: Initialize SQLite3 storage.
+        AppConfig::Storage::Sqlite.load(@options)
       when :yaml
-        AppConfig::Storage::Yaml.load(path)
+        AppConfig::Storage::Yaml.load(@options)
       else
-        raise 'Unknown storage method.'
+        raise UnknownStorageMethod
       end
     end
 

data/lib/app_config/storage.rb

@@ -1,5 +1,6 @@
 module AppConfig
   module Storage
+    autoload :Sqlite, 'app_config/storage/sqlite'
     autoload :Yaml, 'app_config/storage/yaml'
   end
-end
+end

data/lib/app_config/storage/sqlite.rb

@@ -0,0 +1,61 @@
+module AppConfig
+  module Storage
+
+    # SQLite3 storage method.
+    class Sqlite
+      attr_accessor :data
+
+      DEFAULTS = {
+        :database => File.expand_path(File.join(ENV['HOME'], '.app_config.sqlite3')),
+        :table => 'app_config'
+      }
+
+      # Loads @data with the SQLite3 database located at +path+.
+      # @data will be the Hashish that is accessed like AppConfig[:key].
+      #
+      # Defaults to $HOME/.app_config.sqlite3
+      def initialize(options)
+        @options = DEFAULTS.merge(options)
+        @db = SQLite3::Database.open(@options[:database])
+        @data = load_from_database
+      end
+
+      # Creates a new Sqlite storage with the given +path+ and returns the data.
+      def self.load(path)
+        new(path).data
+      end
+
+      private
+
+      # Returns a Hashish that looks something like {:column => value}.
+      def load_from_database
+        query = ["SELECT * FROM sqlite_master",
+                 "WHERE type == 'table' AND name == '#{@options[:table]}'",
+                 "AND name != 'sqlite_sequence'"].join(' ')
+        table = @db.get_first_row(query).last
+        get_columns_from(table)
+      end
+
+      # Gets the column names for +table+.
+      def get_columns_from(table)
+        columns = table.split(', ')
+        # Trip the first element, since it's the SQL CREATE statement.
+        columns = columns[1, columns.size]
+        # Yes, Ruby is 'elegant', but this is fucking disgusting.  There *must* be a better way.
+        columns.map! {|c| c.split('"').reject {|e| e.empty? }.reject {|e| e.include? '('}}.flatten!
+        values_for(columns)
+      end
+
+      # Returns a Hashish mapping of the +columns+ and their values.
+      def values_for(columns)
+        data = Hashish.new
+        query = "SELECT #{columns.join(', ')} FROM #{@options[:table]}"
+        @db.get_first_row(query).each_with_index do |value, index|
+          data[columns[index]] = value
+        end
+        data
+      end
+    end # Sqlite
+
+  end # Storage
+end # AppConfig

data/lib/app_config/storage/yaml.rb

@@ -5,10 +5,16 @@ module AppConfig
     class Yaml
       attr_reader :data
 
+      DEFAULTS = {
+        :path => File.expand_path(File.join(ENV['HOME'], '.app_config.yml'))
+      }
+
       # Loads @data with the YAML file located at +path+.
+      # @data will be the Hashish that is accessed with AppConfig[:key].
       #
       # Defaults to $HOME/.app_config.yml
-      def initialize(path)
+      def initialize(options)
+        path = options[:path] || DEFAULTS[:path]
         @data = Hashish.new(YAML.load_file(path))
       end
 

data/spec/app_config/base_spec.rb

@@ -2,10 +2,10 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Base do
 
-  it 'should raise error on unknown option' do
+  it 'should raise UnknownStorageMethod' do
     lambda do
-      Base.new(:unknown => 'option')
-    end.should raise_error(NoMethodError)
+      Base.new(:storage_method => 'not_a_real_storage_method')
+    end.should raise_error(UnknownStorageMethod)
   end
 
   it 'should have default options' do
@@ -13,8 +13,7 @@ describe Base do
     # mock up the YAML stuff, so it won't puke
     YAML.should_receive(:load_file).with(default_path).and_return({:api => 'key'})
     base = Base.new
-    base.storage_method.should == :yaml
-    base.path.should == default_path
+    base.instance_variable_get(:@options)[:storage_method].should == :yaml
   end
 
 end

data/spec/app_config/storage/sqlite_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+include AppConfig::Storage
+describe Sqlite do
+  it 'should not find the database' do
+    lambda do
+      config_for_sqlite(:database => 'not/a/real/database.sqlite3')
+    end.should raise_error(SQLite3::CantOpenException)
+  end
+
+  it 'should have some values' do
+    config_for_sqlite
+    AppConfig[:api_key].should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -6,12 +6,32 @@ Spec::Runner.configure do |config|
   include AppConfig
 end
 
-FIXTURE = File.expand_path(File.dirname(__FILE__) + '/fixtures/app_config.yml')
+# Returns the full path to the +name+ fixture file.
+def fixture(name)
+  File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', name))
+end
+
+# AppConfig.configure wrapper.  Accepts a hash of +options+.
+def config_for(options)
+  AppConfig.setup(options)
+end
+
+# Setup Yaml options and pass to config_for().
 def config_for_yaml(opts = {})
-  path = opts[:path] || FIXTURE
-  @yaml = {
+  path = opts[:path] || fixture('app_config.yml')
+  yaml = {
     :storage_method => :yaml,
     :path => path,
   }
-  AppConfig.configure(@yaml.merge(opts))
+  config_for(yaml.merge(opts))
+end
+
+# Setup Sqlite options and pass to config_for().
+def config_for_sqlite(opts = {})
+  database = opts[:database] || fixture('app_config.sqlite3')
+  sqlite = {
+    :storage_method => :sqlite,
+    :database => database
+  }
+  config_for(sqlite.merge(opts))
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: app_config
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Dale Campbell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-13 00:00:00 -05:00
+date: 2009-03-15 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -26,6 +26,7 @@ files:
 - README
 - Rakefile
 - lib/app_config/base.rb
+- lib/app_config/storage/sqlite.rb
 - lib/app_config/storage/yaml.rb
 - lib/app_config/storage.rb
 - lib/app_config.rb
@@ -33,20 +34,26 @@ files:
 - spec/app_config
 - spec/app_config/base_spec.rb
 - spec/app_config/storage
+- spec/app_config/storage/sqlite_spec.rb
 - spec/app_config/storage/yaml_spec.rb
 - spec/app_config_spec.rb
 - spec/core_ext
 - spec/core_ext/hashish_spec.rb
 - spec/fixtures
+- spec/fixtures/app_config.sqlite3
 - spec/fixtures/app_config.yml
 - spec/rcov.opts
 - spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://oshuma.github.com/app_config
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --title "AppConfig"
+- --all
+- --inline-source
+- --line-numbers
+- --main README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -63,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: app-config
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2