app_config 0.4.1 → 0.5.2

data/Rakefile

@@ -1,8 +1,8 @@
-require 'spec/rake/spectask'
+require 'rspec/core/rake_task'
 
 FileList[File.dirname(__FILE__) + '/tasks/**/*.rake'].each { |task| load task }
 
-task :default => [:spec]
+task :default => :spec
 
 desc 'Start an irb session with AppConfig loaded'
 task :console do

data/lib/app_config.rb

@@ -4,30 +4,47 @@ $LOAD_PATH.unshift File.dirname(__FILE__)
 require 'core_ext/hashish'
 
 module AppConfig
-  VERSION = '0.4.1'
+  VERSION = '0.5.2'
 
   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.name} v#{VERSION}"
-  end
+  class << self
 
-  # Access the configured <tt>key</tt>'s value.
-  def self.[](key)
-    @@storage[key]
-  end
+    # Accepts an +options+ hash or a block.
+    # See AppConfig::Base for valid storage methods.
+    def setup(options = {}, &block)
+      @@storage = AppConfig::Base.new(options, &block)
+    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
+    # Clears the <tt>@@storage</tt>.
+    def reset!
+      @@storage = nil if defined?(@@storage)
+    end
 
-  def self.to_hash
-    @@storage.to_hash
-  end
+    # Access the configured <tt>key</tt>'s value.
+    def [](key)
+      validate!
+      @@storage[key]
+    end
 
+    # Set a new <tt>value</tt> for <tt>key</tt> (persistence depends on the type of Storage).
+    def []=(key, value)
+      validate!
+      @@storage[key] = value
+    end
+
+    def to_hash
+      validate!
+      @@storage.to_hash
+    end
+
+    private
+
+    def validate!
+      raise AppConfig::Error::NotSetup unless defined?(@@storage) && @@storage
+    end
+
+  end # self
 end # AppConfig

data/lib/app_config/base.rb

@@ -30,7 +30,19 @@ module AppConfig
 
     # Access the <tt>key</tt>'s value in storage.
     def [](key)
-      storage[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 environment
@@ -74,7 +86,7 @@ module AppConfig
       when :yaml
         AppConfig::Storage::YAML.load(@options)
       else
-        raise Error::UnknownStorageMethod
+        raise AppConfig::Error::UnknownStorageMethod
       end
     end
 

data/lib/app_config/error.rb

@@ -1,7 +1,7 @@
 module AppConfig
   module Error
 
-    class NotConfigured < Exception
+    class NotSetup < Exception
       def to_s; "Must call 'AppConfig.setup' to setup storage!"; end
     end
 

data/lib/app_config/storage.rb

@@ -1,8 +1,9 @@
 module AppConfig
   module Storage
-    autoload :BaseStorage, 'app_config/storage/base_storage'
-    autoload :Memory,      'app_config/storage/memory'
-    autoload :Sqlite,      'app_config/storage/sqlite'
-    autoload :YAML,        'app_config/storage/yaml'
+    autoload :Base,   'app_config/storage/base'
+    autoload :Memory, 'app_config/storage/memory'
+    autoload :Mongo,  'app_config/storage/mongo'
+    autoload :Sqlite, 'app_config/storage/sqlite'
+    autoload :YAML,   'app_config/storage/yaml'
   end
 end

data/lib/app_config/storage/{base_storage.rb → base.rb}

@@ -1,6 +1,6 @@
 module AppConfig
   module Storage
-    class BaseStorage
+    class Base
 
       attr_reader :data
 

data/lib/app_config/storage/memory.rb

@@ -1,6 +1,6 @@
 module AppConfig
   module Storage
-    class Memory < BaseStorage
+    class Memory < Storage::Base
 
       def initialize(options)
         @data = Hashish.new(options)

data/lib/app_config/storage/mongo.rb

@@ -0,0 +1,73 @@
+begin
+  require 'mongo'
+rescue LoadError
+  require 'rubygems'
+  require 'mongo'
+end
+
+module AppConfig
+  module Storage
+
+    # Mongo storage method.
+    class Mongo < Storage::Base
+
+      DEFAULTS = {
+        :host => 'localhost',
+        :port => '27017',
+        :database => 'app_config',
+        :collection => 'app_config',
+        :user => nil,
+        :password => nil
+      }
+
+      def initialize(options)
+        @connected = false
+        @options = DEFAULTS.merge(options)
+        setup_connection
+        @data = fetch_data
+      end
+
+      def [](key)
+        @data[key]
+      end
+
+      def []=(key, value)
+        @data[key] = value
+        save!
+      end
+
+      private
+
+      def save!
+        collection.save(@data)
+      end
+
+      def setup_connection
+        @connection = ::Mongo::Connection.new(@options[:host], @options[:port].to_i)
+        authenticate_connection if @options[:user] && @options[:password]
+      end
+
+      def authenticate_connection
+        database.authenticate(@options[:user], @options[:password])
+      end
+
+      def connected?
+        @connection && @connection.connected?
+      end
+
+      def fetch_data
+        raise 'Not connected to MongoDB' unless connected?
+        Hashish.new(collection.find_one)
+      end
+
+      def database
+        @database ||= @connection.db(@options[:database])
+      end
+
+      def collection
+        @collection ||= database.collection(@options[:collection])
+      end
+
+    end # Mongo
+  end # Storage
+end # AppConfig

data/lib/app_config/storage/sqlite.rb

@@ -9,7 +9,7 @@ module AppConfig
     end
 
     # SQLite3 storage method.
-    class Sqlite < BaseStorage
+    class Sqlite < Storage::Base
 
       DEFAULTS = {
         :database => File.expand_path(File.join(ENV['HOME'], '.app_config.sqlite3')),

data/lib/app_config/storage/yaml.rb

@@ -4,7 +4,7 @@ module AppConfig
     require 'yaml'
 
     # YAML storage method.
-    class YAML < BaseStorage
+    class YAML < Storage::Base
 
       DEFAULTS = {
         :path => File.expand_path(File.join(ENV['HOME'], '.app_config.yml'))

data/lib/core_ext/hashish.rb

@@ -1,9 +1,9 @@
-# Stolen from Rails Active Support and aliased to Hashish.
+# Stolen from Rails Active Support 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 HashWithIndifferentAccess < Hash
+class Hashish < Hash
   def initialize(constructor = {})
     if constructor.is_a?(Hash)
       super()
@@ -117,24 +117,23 @@ class HashWithIndifferentAccess < Hash
   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
+  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
 
-# Simple alias.
-Hashish = HashWithIndifferentAccess
+end # Hashish
 
 class Hash
   def with_indifferent_access

data/spec/app_config/storage/mongo_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe AppConfig::Storage::Mongo do
+
+  before(:each) do
+    pending "TODO: Spec this out"
+  end
+
+  it 'should have some values' do
+    config_for_mongo
+    AppConfig[:api_key].should_not be_nil
+  end
+
+  it 'should update the values' do
+    config_for_mongo
+    original_key = AppConfig[:api_key]
+    AppConfig[:api_key] = 'SOME_NEW_API_KEY'
+
+    # Reload the data.
+    AppConfig.reset!
+    config_for_mongo
+
+    AppConfig[:api_key].should == 'SOME_NEW_API_KEY'
+  end
+end

data/spec/app_config/storage/yaml_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe AppConfig::Storage::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
+
+  it 'parses the URI properly' do
+    AppConfig.setup(:uri => "yaml://#{fixture('app_config.yml')}")
+    AppConfig[:api_key].should_not be_nil
+  end
+
+  it 'saves the new value in memory' do
+    config_for_yaml
+    AppConfig[:new_key] = 'new value'
+    AppConfig[:new_key].should == 'new value'
+  end
+
+end

data/spec/app_config/storage_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe AppConfig::Storage do
+
+  it 'responds to .setup()' do
+    AppConfig.should respond_to(:setup)
+  end
+
+end

data/spec/app_config_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe AppConfig do
+
+  it 'has a version' do
+    AppConfig::VERSION.should_not be_nil
+  end
+
+  it 'responds to .setup()' do
+    AppConfig.should respond_to(:setup)
+  end
+
+  it 'responds to .reset!()' do
+    AppConfig.should respond_to(:reset!)
+  end
+
+  it 'should have to_hash' do
+    config_for_yaml
+    AppConfig.to_hash.class.should == Hash
+  end
+
+  it 'should reset @@storage' do
+    config_for_yaml   # configure first
+    AppConfig.reset!  # then reset
+    lambda do
+      AppConfig[:some_key]
+    end.should raise_error(AppConfig::Error::NotSetup)
+  end
+
+  it 'Error::NotSetup is raised when calling to_hash()' do
+    # First, reset the storage variable.
+    AppConfig.send(:class_variable_set, :@@storage, nil)
+    lambda do
+      AppConfig.to_hash
+    end.should raise_error(AppConfig::Error::NotSetup)
+  end
+
+  describe 'environment mode' do
+    it 'should load the proper environment' do
+      config_for_yaml(:path => fixture('env_app_config.yml'),
+                      :env  => 'development')
+      AppConfig[:api_key].should_not be_nil
+    end
+  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/fixtures/env_app_config.yml

@@ -0,0 +1,17 @@
+defaults: &defaults
+  title: 'AppConfig Env Mode'
+  admin_email: 'admin@example.com'
+  api_name:    'Supr Webz 2.0'
+  api_key:     'SUPERAWESOMESERVICE'
+
+development:
+  <<: *defaults
+  admin_email: 'dev@example.com'
+
+production:
+  <<: *defaults
+  title: 'AppConfig Env Production Mode!'
+
+test:
+  <<: *defaults
+  admin_email: 'test@example.com'

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require 'rubygems' if RUBY_VERSION =~ /^1\.8/
+require 'rspec'
+
+require File.expand_path("#{File.dirname(__FILE__)}/../lib/app_config")
+
+RSpec.configure do |config|
+  include AppConfig
+
+  # Returns the full path to the +name+ fixture file.
+  def fixture(name)
+    File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', name))
+  end
+
+  # AppConfig.setup wrapper.  Accepts a hash of +options+.
+  def config_for(options)
+    AppConfig.reset!
+    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
+
+  def config_for_mongo(opts = {})
+    mongo = {
+      :storage_method => :mongo,
+      :host => 'localhost',
+      :database => 'app_config_spec',
+      :environment => 'test',
+    }
+    begin
+      config_for(mongo.merge(opts))
+    rescue Mongo::ConnectionFailure
+      pending "***** Mongo specs require a running MongoDB server *****"
+    end
+  end
+end

data/spec/watchr.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+def run_specs
+  system('rake spec')
+end
+
+# Ctrl-\
+Signal.trap('QUIT') do
+  puts "\n--- Running all specs ---\n"
+  run_specs
+end
+
+# Ctrl-C
+Signal.trap('INT') { abort("\n") }
+
+
+if __FILE__ == $0
+  system("watchr #{$0}")
+else
+  run_specs
+
+  [
+    'lib/(.*/)?.*\.rb',
+    'spec/(.*/)?.*_spec\.rb'
+  ].each do |pattern|
+    watch(pattern) { |md| run_specs }
+  end
+end

data/tasks/doc.rake

@@ -0,0 +1,47 @@
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+desc 'Generate API documentation'
+task :doc do
+  Rake::Task['doc:api'].invoke
+end
+
+namespace :doc do
+  task :setup_rdoc do
+    @file_list = FileList[ "#{File.join(APP_ROOT, 'README')}",
+                           "#{APP_ROOT}/lib/**/*.rb" ]
+    # Substitute APP_ROOT with a dot.  Makes for a better index in the generated docs.
+    @files = @file_list.collect  {|f| f.gsub(/#{APP_ROOT}/, '.')}
+    @options = %W[
+      --all
+      --inline-source
+      --line-numbers
+      --op #{File.join(APP_ROOT, '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
+    sh "rm -rf #{File.join(APP_ROOT, '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
+  sh "rdoc #{options} #{files}"
+end

data/tasks/gem.rake

@@ -0,0 +1,26 @@
+APP_DIR = File.join(File.dirname(__FILE__), '..')
+GEMSPEC = File.join(APP_DIR, 'app_config.gemspec')
+
+desc 'Build the gem'
+task :gem => ['gem:build']
+
+namespace :gem do
+  task :build do
+    sh "gem build #{GEMSPEC}"
+  end
+
+  desc 'Remove the gem'
+  task :clean do
+    sh "rm -f #{APP_DIR}/*.gem"
+  end
+
+  desc 'Clean and rebuild the gem'
+  task :rebuild => ['gem:clean', 'gem:build']
+
+  desc 'Rebuild and install the gem'
+  task :install => ['gem:rebuild'] do
+    gem = FileList["#{APP_DIR}/*.gem"].first
+    raise 'Gem not found!' unless gem && File.exists?(gem)
+    sh "sudo gem uninstall app_config; sudo gem install --no-ri --no-rdoc #{gem}"
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,5 @@
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--color', '--format progress']
+  t.pattern = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: app_config
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 2
+  version: 0.5.2
 platform: ruby
 authors: 
 - Dale Campbell
@@ -9,10 +15,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-25 00:00:00 -05:00
+date: 2010-11-05 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  type: :development
+  version_requirements: *id002
 description: An easy to use, customizable library to easily store and retrieve application configuration.
 email: 
 - oshuma@gmail.com
@@ -23,17 +60,30 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- Rakefile
 - README
-- lib/app_config.rb
-- lib/app_config/base.rb
+- Rakefile
 - lib/app_config/error.rb
 - lib/app_config/storage.rb
-- lib/app_config/storage/base_storage.rb
+- lib/app_config/base.rb
 - lib/app_config/storage/memory.rb
 - lib/app_config/storage/sqlite.rb
+- lib/app_config/storage/mongo.rb
 - lib/app_config/storage/yaml.rb
+- lib/app_config/storage/base.rb
+- lib/app_config.rb
 - lib/core_ext/hashish.rb
+- spec/watchr.rb
+- spec/fixtures/app_config.yml
+- spec/fixtures/env_app_config.yml
+- spec/app_config_spec.rb
+- spec/app_config/storage_spec.rb
+- spec/app_config/storage/yaml_spec.rb
+- spec/app_config/storage/mongo_spec.rb
+- spec/spec_helper.rb
+- spec/core_ext/hashish_spec.rb
+- tasks/doc.rake
+- tasks/rspec.rake
+- tasks/gem.rake
 has_rdoc: true
 homepage: http://oshuma.github.com/app_config
 licenses: []
@@ -45,21 +95,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: app-config
-rubygems_version: 1.3.5
+rubyforge_project: 
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Quick and easy application configuration.