app_config 0.1.0

data/README

@@ -0,0 +1,39 @@
+= 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.configure.  See AppConfig::Base for a list of valid options.
+
+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.configure 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.configure do |config|
+    config.storage_method = :sqlite
+    config.database = '/path/to/database.sqlite3'
+  end
+
+  AppConfig[:column]  # => 'value'

data/Rakefile

@@ -0,0 +1,77 @@
+require 'spec/rake/spectask'
+
+task :default => [:spec]
+
+desc 'Start an irb session with AppConfig loaded'
+task :console do
+  sh "irb -I ./lib -r 'app_config'"
+end
+
+desc 'Run the specs with autotest'
+task :autotest do
+  ENV['RSPEC'] = 'true'
+  sh 'autotest'
+end
+
+desc 'Run all specs in spec directory'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Run all specs in spec directory with RCov'
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = lambda do
+    IO.readlines('spec/rcov.opts').map {|l| l.chomp.split ' '}.flatten
+  end
+end
+
+desc 'Generate API documentation'
+task :doc do
+  Rake::Task['doc:api'].invoke
+end
+
+namespace :doc do
+  task :setup_rdoc do
+    @file_list = FileList[ "#{File.dirname(__FILE__)}/README",
+                           "#{File.dirname(__FILE__)}/lib/**/*.rb" ]
+    # Substitute APP_ROOT with a dot.  Makes for a better index in the generated docs.
+    @files = @file_list.collect  {|f| f.gsub(/#{File.dirname(__FILE__)}/, '.')}
+    @options = %W[
+      --all
+      --inline-source
+      --line-numbers
+      --main README
+      --op #{File.join(File.dirname(__FILE__), 'doc', 'api')}
+      --title 'AppConfig API Documentation'
+    ]
+    # Generate a diagram, yes/no?
+    @options << '-d' if RUBY_PLATFORM !~ /win32/ && `which dot` =~ /\/dot/ && !ENV['NODOT']
+  end
+
+  task :api => [:setup_rdoc] do
+    run_rdoc(@options, @files)
+  end
+
+  desc 'Remove generated API documentation'
+  task :clear do
+    system("rm -rf #{File.dirname(__FILE__) + '/doc/api'}")
+  end
+
+  desc 'Rebuild API documentation'
+  task :rebuild do
+    Rake::Task['doc:clear'].invoke
+    Rake::Task['doc:api'].invoke
+  end
+end
+
+private
+
+def run_rdoc(options, files)
+  options = options.join(' ') if options.is_a? Array
+  files   = files.join(' ')   if files.is_a? Array
+  system("rdoc #{options} #{files}")
+end

data/lib/app_config.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'yaml'
+
+require 'core_ext/hashish'
+
+module AppConfig
+  VERSION = '0.1.0'
+
+  autoload :Base, 'app_config/base'
+  autoload :Storage, 'app_config/storage'
+
+  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 pass a block.
+  # See AppConfig::Base for valid options.
+  def self.configure(options = {}, &block)
+    @@storage = AppConfig::Base.new(options, &block)
+  end
+
+end

data/lib/app_config/base.rb

@@ -0,0 +1,51 @@
+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
+
+    attr_accessor :storage_method, :path
+
+    DEFAULTS = {
+      :storage_method => :yaml,
+      :path => File.expand_path(File.join(ENV['HOME'], '.app_config.yml'))
+    }
+
+    # 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)
+      DEFAULTS.merge(options).each_pair do |key, value|
+        self.send("#{ key }=", value)
+      end
+      yield self 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 storage_method
+      when :sqlite
+        # TODO: Initialize SQLite3 storage.
+      when :yaml
+        AppConfig::Storage::Yaml.load(path)
+      else
+        raise 'Unknown storage method.'
+      end
+    end
+
+  end # Base
+
+end # AppConfig

data/lib/app_config/storage.rb

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

data/lib/app_config/storage/yaml.rb

@@ -0,0 +1,23 @@
+module AppConfig
+  module Storage
+
+    # YAML storage method.
+    class Yaml
+      attr_reader :data
+
+      # Loads @data with the YAML file located at +path+.
+      #
+      # Defaults to $HOME/.app_config.yml
+      def initialize(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

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

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Base do
+
+  it 'should raise error on unknown option' do
+    lambda do
+      Base.new(:unknown => 'option')
+    end.should raise_error(NoMethodError)
+  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.storage_method.should == :yaml
+    base.path.should == default_path
+  end
+
+end

data/spec/app_config/storage/yaml_spec.rb

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

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

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

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

data/spec/rcov.opts

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

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'spec'
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/app_config')
+
+Spec::Runner.configure do |config|
+  include AppConfig
+end
+
+FIXTURE = File.expand_path(File.dirname(__FILE__) + '/fixtures/app_config.yml')
+def config_for_yaml(opts = {})
+  path = opts[:path] || FIXTURE
+  @yaml = {
+    :storage_method => :yaml,
+    :path => path,
+  }
+  AppConfig.configure(@yaml.merge(opts))
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: app_config
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dale Campbell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-13 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: An easy to use, customizable library to easily store and retrieve application configuration
+email: 
+- dale@save-state.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- Rakefile
+- lib/app_config/base.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/yaml_spec.rb
+- spec/app_config_spec.rb
+- spec/core_ext
+- spec/core_ext/hashish_spec.rb
+- spec/fixtures
+- spec/fixtures/app_config.yml
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://oshuma.github.com/app_config
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Quick and easy application configuration.
+test_files: []
+