app_config 0.2.1 → 0.2.3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: app_config
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors: 
 - Dale Campbell
@@ -9,51 +9,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-15 00:00:00 -05:00
+date: 2009-09-27 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: An easy to use, customizable library to easily store and retrieve application configuration
+description: An easy to use, customizable library to easily store and retrieve application configuration.
 email: 
-- dale@save-state.net
+- oshuma@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: []
 
-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
-- lib/core_ext/hashish.rb
-- 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
+files: []
+
 has_rdoc: true
 homepage: http://oshuma.github.com/app_config
+licenses: []
+
 post_install_message: 
-rdoc_options: 
-- --title
-- AppConfig
-- --all
-- --inline-source
-- --line-numbers
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -71,9 +48,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: app-config
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Quick and easy application configuration.
 test_files: []
 

data/README

@@ -1,40 +0,0 @@
-= AppConfig
-
-An easy to use, customizable library to easily store and retrieve application
-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.setup.  See AppConfig::Base for a list of valid storage methods.
-
-For example, given this YAML file:
-
-  ---
-  admin_email: 'admin@example.com'
-  api_name:    'Supr Webz 2.0'
-  api_key:     'SUPERAWESOMESERVICE'
-
-Use it like so:
-
-  require 'app_config'
-
-  AppConfig.setup do |config|
-    config[:storage_method] = :yaml
-    config[:path] = '/path/to/app_config.yml'
-  end
-
-  AppConfig[admin_email]  # => 'admin@example.com'
-  AppConfig[:api_name]    # => 'Supr Webz 2.0'
-  AppConfig[:api_key]     # => 'SUPERAWESOMESERVICE'
-
-Want SQLite3 support?  No problem!
-
-  AppConfig.setup do |config|
-    config[:storage_method] = :sqlite
-    config[:database] = '/path/to/database.sqlite3'
-    config[:table] = 'app_config'
-  end
-
-  AppConfig[:column]  # => 'value'

data/Rakefile

@@ -1,10 +0,0 @@
-require 'spec/rake/spectask'
-
-FileList[File.dirname(__FILE__) + '/tasks/**/*.rake'].each { |task| load task }
-
-task :default => [:spec]
-
-desc 'Start an irb session with AppConfig loaded'
-task :console do
-  sh "irb -I ./lib -r 'app_config'"
-end

data/lib/app_config.rb

@@ -1,41 +0,0 @@
-$LOAD_PATH.unshift File.dirname(__FILE__)
-
-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.2.1'
-
-  autoload :Base, 'app_config/base'
-  autoload :Storage, 'app_config/storage'
-
-  # Returns the AppConfig version string.
-  def self.to_version
-    "#{self.class} v#{VERSION}"
-  end
-
-  # Access the configured <tt>key</tt>'s value.
-  def self.[](key)
-    error = "Must call '#{self}.configure' to setup storage!"
-    raise error if @@storage.nil?
-    @@storage[key]
-  end
-
-  # 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
-
-end

data/lib/app_config/base.rb

@@ -1,46 +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.
-  class Base
-
-    DEFAULTS = {
-      :storage_method => :yaml
-    }
-
-    # Accepts either a hash of +options+ or a block (which overrides
-    # any options passed in the hash).
-    #
-    # Valid storage methods:
-    # * :sqlite
-    # * :yaml
-    def initialize(options = {}, &block)
-      @options = DEFAULTS.merge(options)
-      yield @options if block_given?
-      @storage = initialize_storage
-    end
-
-    # Access the <tt>key</tt>'s value in @storage.
-    def [](key)
-      @storage[key]
-    end
-
-  private
-
-    # This decides how to load the data, based on the +storage_method+.
-    def initialize_storage
-      case @options[:storage_method]
-      when :sqlite
-        AppConfig::Storage::Sqlite.load(@options)
-      when :yaml
-        AppConfig::Storage::Yaml.load(@options)
-      else
-        raise UnknownStorageMethod
-      end
-    end
-
-  end # Base
-
-end # AppConfig

data/lib/app_config/storage.rb

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

data/lib/app_config/storage/sqlite.rb

@@ -1,61 +0,0 @@
-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

@@ -1,29 +0,0 @@
-module AppConfig
-  module Storage
-
-    # YAML storage method.
-    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(options)
-        path = options[:path] || DEFAULTS[:path]
-        @data = Hashish.new(YAML.load_file(path))
-      end
-
-      # Creates a new Yaml storage with the given +path+ and returns the data.
-      def self.load(path)
-        new(path).data
-      end
-
-    end # Yaml
-
-  end # Storage
-end # AppConfig

data/lib/core_ext/hashish.rb

@@ -1,124 +0,0 @@
-# Stolen from Rails Active Support 2.3.0 and renamed to Hashish.
-#
-# This class has dubious semantics and we only have it so that
-# people can write params[:key] instead of params['key']
-# and they get the same value for both keys.
-class Hashish < Hash
-  def initialize(constructor = {})
-    if constructor.is_a?(Hash)
-      super()
-      update(constructor)
-    else
-      super(constructor)
-    end
-  end
-
-  def default(key = nil)
-    if key.is_a?(Symbol) && include?(key = key.to_s)
-      self[key]
-    else
-      super
-    end
-  end
-
-  alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
-  alias_method :regular_update, :update unless method_defined?(:regular_update)
-
-  # Assigns a new value to the hash:
-  #
-  #   hash = HashWithIndifferentAccess.new
-  #   hash[:key] = "value"
-  #
-  def []=(key, value)
-    regular_writer(convert_key(key), convert_value(value))
-  end
-
-  # Updates the instantized hash with values from the second:
-  # 
-  #   hash_1 = HashWithIndifferentAccess.new
-  #   hash_1[:key] = "value"
-  # 
-  #   hash_2 = HashWithIndifferentAccess.new
-  #   hash_2[:key] = "New Value!"
-  # 
-  #   hash_1.update(hash_2) # => {"key"=>"New Value!"}
-  # 
-  def update(other_hash)
-    other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
-    self
-  end
-
-  alias_method :merge!, :update
-
-  # Checks the hash for a key matching the argument passed in:
-  #
-  #   hash = HashWithIndifferentAccess.new
-  #   hash["key"] = "value"
-  #   hash.key? :key  # => true
-  #   hash.key? "key" # => true
-  #
-  def key?(key)
-    super(convert_key(key))
-  end
-
-  alias_method :include?, :key?
-  alias_method :has_key?, :key?
-  alias_method :member?, :key?
-
-  # Fetches the value for the specified key, same as doing hash[key]
-  def fetch(key, *extras)
-    super(convert_key(key), *extras)
-  end
-
-  # Returns an array of the values at the specified indices:
-  #
-  #   hash = HashWithIndifferentAccess.new
-  #   hash[:a] = "x"
-  #   hash[:b] = "y"
-  #   hash.values_at("a", "b") # => ["x", "y"]
-  #
-  def values_at(*indices)
-    indices.collect {|key| self[convert_key(key)]}
-  end
-
-  # Returns an exact copy of the hash.
-  def dup
-    HashWithIndifferentAccess.new(self)
-  end
-
-  # Merges the instantized and the specified hashes together, giving precedence to the values from the second hash
-  # Does not overwrite the existing hash.
-  def merge(hash)
-    self.dup.update(hash)
-  end
-
-  # Removes a specified key from the hash.
-  def delete(key)
-    super(convert_key(key))
-  end
-
-  def stringify_keys!; self end
-  def symbolize_keys!; self end
-  def to_options!; self end
-
-  # Convert to a Hash with String keys.
-  def to_hash
-    Hash.new(default).merge(self)
-  end
-
-  protected
-    def convert_key(key)
-      key.kind_of?(Symbol) ? key.to_s : key
-    end
-
-    def convert_value(value)
-      case value
-      when Hash
-        value.with_indifferent_access
-      when Array
-        value.collect { |e| e.is_a?(Hash) ? e.with_indifferent_access : e }
-      else
-        value
-      end
-    end
-end

data/spec/app_config/base_spec.rb

@@ -1,19 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-
-describe Base do
-
-  it 'should raise UnknownStorageMethod' do
-    lambda do
-      Base.new(:storage_method => 'not_a_real_storage_method')
-    end.should raise_error(UnknownStorageMethod)
-  end
-
-  it 'should have default options' do
-    default_path = File.expand_path(File.join(ENV['HOME'], '.app_config.yml'))
-    # 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.instance_variable_get(:@options)[:storage_method].should == :yaml
-  end
-
-end

data/spec/app_config/storage/sqlite_spec.rb

@@ -1,15 +0,0 @@
-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/app_config/storage/yaml_spec.rb

@@ -1,17 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
-
-include AppConfig::Storage
-describe Yaml do
-
-  it 'should have some values' do
-    config_for_yaml
-    AppConfig[:api_key].should_not be_nil
-  end
-
-  it 'should raise file not found' do
-    lambda do
-      config_for_yaml(:path => 'not/a/real/file.yml')
-    end.should raise_error(Errno::ENOENT)
-  end
-
-end

data/spec/app_config_spec.rb

@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe AppConfig do
-  it 'should have a version' do
-    AppConfig.to_version.should_not be_nil
-  end
-end

data/spec/core_ext/hashish_spec.rb

@@ -1,18 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-
-describe Hashish do
-  before(:each) do
-    @strings = { 'key' => 'value', 'four' => 20 }
-    @symbols = { :key  => 'value', :four  => 20 }
-  end
-
-  it 'should not give a fuck about symbols' do
-    hashish = Hashish.new(@strings)
-    hashish[:key].should == 'value'
-  end
-
-  it 'should not give a fuck about strings' do
-    hashish = Hashish.new(@symbols)
-    hashish['key'].should == 'value'
-  end
-end

data/spec/fixtures/app_config.yml

@@ -1,4 +0,0 @@
----
-admin_email: 'admin@example.com'
-api_name:    'Supr Webz 2.0'
-api_key:     'SUPERAWESOMESERVICE'

data/spec/rcov.opts

@@ -1 +0,0 @@
---exclude "spec/*,gems/*"

data/spec/spec.opts

@@ -1,4 +0,0 @@
---colour
---format progress
---loadby mtime
---reverse

data/spec/spec_helper.rb

@@ -1,37 +0,0 @@
-require 'spec'
-
-require File.expand_path(File.dirname(__FILE__) + '/../lib/app_config')
-
-Spec::Runner.configure do |config|
-  include AppConfig
-end
-
-# 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('app_config.yml')
-  yaml = {
-    :storage_method => :yaml,
-    :path => path,
-  }
-  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