app-config 0.1.0 → 0.1.1

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+*.swp
+*.tmproj
+*~
+.DS_Store
+.\#*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+\#*
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Dan Sosedoff
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,113 @@
+= AppConfig
+
+AppConfig is a library to manage your (web) application dynamic settings with flexible access and configuration strategy.
+
+Primary datasource for AppConfig is an ActiveRecord model.
+
+== Installation
+
+via rubygems:
+
+  gem install app-config
+  
+via github:
+
+  git clone git://github.com/sosedoff/app-config.git
+  cd app-config
+  gem build
+  gem install app-config-x.y.z.gem
+  
+== Supported platforms
+
+- Ruby 1.8.7
+- Ruby REE 1.8.7
+- Ruby 1.9.2
+  
+== Data Formats
+
+You can use following formats:
+- String
+- Boolean
+- Array
+- Hash
+
+String format is a default format. Everything is a string by default.
+
+Boolean format is just a flag, values 'true', 'on', 'yes', 'y', '1' are equal to True. Everything else is False.
+
+Array format is a multiline text which is transformed into array. Each evelemnt will be trimmed. Empty strings are ignored.
+
+Hash format is special key-value string, "foo: bar, user: username", which is transformed into Hash instance.
+Only format "keyname: value, keyname2: value2" is supported. No nested hashes allowed.
+
+== Usage
+
+AppConfig is designed to work with ActiveRecord model. Only ActiveRecord >= 3.0.0 is supported.
+
+By default model "Setting" will be used as a data source.
+
+Default migration:
+
+  class CreateSettings < ActiveRecord::Migration
+    def self.up
+      create_table :settings do |t|
+        t.string   :keyname,       :null => false, :limit => 64
+        t.string   :name,          :null => false, :limit => 64
+        t.text     :value,         :null => false
+        t.string   :value_format,  :limit => 64,  :default => "string"
+        t.string   :description,   :limit => 512, :null => false
+        t.timestamps
+      end
+    end
+  
+    def self.down
+      drop_table :settings
+    end
+  end
+
+Now, configure:
+
+  AppConfig.configure
+  
+If your settings model has a different schema, you can redefine columns:
+
+  AppConfig.configure(
+    :model  => Setting,           # define your model as a source
+    :key    => 'KEYNAME_FIELD',   # field that contains name
+    :format => 'FORMAT_FIELD',    # field that contains key format
+    :value  => 'VALUE_FIELD',     #field that contains value data
+  )
+  
+Load all settings somewhere in your application. In Rails it should be initializer file.
+
+  AppConfig.load
+  
+Configuration in Rails 3: (you can put this into environment/ENV or application.rb)
+Make sure your application does not have any critical parts depending on AppConfig at startup.
+
+  config.after_initialize do
+    AppConfig.configure(:model => Setting)
+    AppConfig.load if Setting.table_exists?
+  end
+
+AppConfig gives you 3 ways to access variables:
+
+  AppConfig.my_setting      # method-like
+  AppConfig[:my_setting]    # hash-like by symbol key
+  AppConfig['my_setting']   # hash-like by string key
+  
+You can define settings items manually. NOTE: THESE KEYS WILL BE REMOVED ON RELOAD/LOAD.
+
+  AppConfig.set('KEYNAME, 'VALUE', 'FORMAT')
+  
+Everytime you change your settings on the fly, use reload:
+
+  AppConfig.reload
+  
+Cleanup everything:
+
+  AppConfig.flush
+
+== Copyright
+
+Copyright (c) 2011 Dan Sosedoff.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = 'spec/*_spec.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/app-config.gemspec

@@ -0,0 +1,27 @@
+require File.expand_path('../lib/app-config/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "app-config"
+  s.version     = AppConfig::VERSION.dup
+  s.summary     = "Configurable application settings"
+  s.description = "Flexible and simple configuration settings for your Rails/Sinatra applications."
+  s.homepage    = "http://github.com/sosedoff/app-config"
+  s.authors     = ["Dan Sosedoff"]
+  s.email       = ["dan.sosedoff@gmail.com"]
+  s.license     = "MIT"
+  
+  s.add_development_dependency 'rake', '~> 0.8'
+  s.add_development_dependency 'rspec', '~> 2.6'
+  s.add_development_dependency 'simplecov', '~> 0.4'
+  s.add_development_dependency 'sqlite3', '~> 1.3'
+  
+  s.add_runtime_dependency     'activerecord', '~> 3.0.0'
+  
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.require_paths = ["lib"]
+  
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
+end

data/lib/app-config.rb

@@ -1,4 +1,5 @@
-require 'app-config/version'
+require 'active_record'
+
 require 'app-config/errors'
 require 'app-config/processor'
 require 'app-config/app-config'

data/lib/app-config/app-config.rb

@@ -1,7 +1,22 @@
 module AppConfig
   extend AppConfig::Processor
 
-  FORMATS = ['string', 'array', 'hash', 'boolean']
+  FORMATS = ['string', 'array', 'hash', 'boolean'].freeze
+  RESTRICTED_KEYS = [
+    'id',
+    'to_s',
+    'configure',
+    'load',
+    'flush',
+    'reload',
+    'keys',
+    'empty?',
+    'method_missing',
+    'exist?',
+    'source_model',
+    'configuration'
+  ].freeze
+  
   @@options = {}
   @@records = {}
   
@@ -13,6 +28,11 @@ module AppConfig
     @@options[:format]  = opts[:format] || 'value_format'
   end
   
+  # Returns a configuration options
+  def self.configuration
+    @@options
+  end
+  
   # Load and process application settings
   def self.load
     @@records = fetch
@@ -31,7 +51,7 @@ module AppConfig
   
   # Manually set (or add) a key
   def self.set_key(keyname, value, format='string')
-    raise InvalidKeyName, "Invalid key name: #{keyname}" if self.respond_to?(keyname)
+    raise InvalidKeyName, "Invalid key name: #{keyname}" if RESTRICTED_KEYS.include?(keyname)
     @@records[keyname] = process(value, format)
   end
   
@@ -60,12 +80,25 @@ module AppConfig
     @@records.key?(key)
   end
   
+  # Returns class that defined as source
+  def self.source_model
+    @@options[:model]
+  end
+  
   protected
   
+  # Checks the column structure of the source model
+  def self.check_structure
+    klass = @@options[:model]
+    keys = [@@options[:key], @@options[:value], @@options[:format]]
+    return (keys - klass.column_names).empty?
+  end
+  
   # Fetch data from model
   def self.fetch
     raise InvalidSource, 'Model is not defined!' if @@options[:model].nil?
     raise InvalidSource, 'Model was not found!' unless @@options[:model].superclass == ActiveRecord::Base
+    raise InvalidSource, 'Model fields are invalid!' unless check_structure
     
     records = {}
     

data/lib/app-config/version.rb

@@ -1,3 +1,3 @@
 module AppConfig
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/spec/config_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe 'AppConfig' do
+  before :all do
+    establish_connection
+    init_settings_table
+    
+    Setting.create(:keyname => 'foo', :value => 'bar', :value_format => 'string')
+    AppConfig.configure
+  end
+  
+  it 'should validate default source fields' do
+    ['keyname', 'value', 'value_format'].each do |c|
+      AppConfig.source_model.column_names.include?(c).should == true
+    end
+  end
+  
+  it 'should have no configuration options' do
+    AppConfig.empty?.should == true
+  end
+  
+  it 'should raise InvalidKeyName when setting value of a restricted key' do
+    keys = AppConfig::RESTRICTED_KEYS
+    keys.each do |k|
+      proc { AppConfig.set_key(k, 'foo') }.should raise_error AppConfig::InvalidKeyName
+    end
+  end
+    
+  it 'should load setting item manually' do
+    AppConfig.set_key('email_notifications', 'noreply@foo.com')
+    AppConfig.exist?('email_notifications').should == true
+  end
+  
+  it 'should provide hash-like and object-like access to options' do
+    AppConfig.set_key('foo', 'bar')
+    AppConfig['foo'].should == 'bar'
+    AppConfig[:foo].should == 'bar'
+    AppConfig.foo.should == 'bar'
+  end
+  
+  it 'should return nil if option does not exist' do
+    AppConfig[:foobar].should == nil
+    AppConfig['foobar'].should == nil
+    AppConfig.foobar.should == nil
+  end
+  
+  it 'should erase all settings' do
+    AppConfig.flush
+    AppConfig.empty?.should == true
+  end
+  
+  it 'should load data from database' do
+    AppConfig.load
+    AppConfig.keys.size.should == 1
+    AppConfig.foo.should == 'bar'
+  end
+  
+  it 'should reload data' do
+    s = Setting.find_by_keyname('foo')
+    s.update_attribute('value', 'TEST')
+    
+    AppConfig.reload
+    AppConfig.keys.size.should == 1
+    AppConfig.foo.should == 'TEST'
+  end
+end

data/spec/processor_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe 'Processor' do
+  include AppConfig::Processor
+
+  it 'should raise InvalidType expection on invalid data type' do
+    proc { process('foo', 'bar') }.should raise_error AppConfig::InvalidType
+  end
+  
+  it 'should return an empty object if data is nil' do
+    process(nil, 'string').should == ''
+    process(nil, 'array').should == []
+    process(nil, 'boolean').should == false
+    process(nil, 'hash').should == {}
+  end
+  
+  it 'should process and trim string data' do
+    data = "  Foo bar \r\n  "
+    result = process(data, 'string')
+    
+    result.should be_a_kind_of String
+    result.empty?.should_not be true
+    result.should == 'Foo bar'
+  end
+  
+  it 'should process and trim array data' do
+    data = "str1\r\nstr2\r\nstr3 \r\n\r\n"    
+    target = ['str1', 'str2', 'str3']
+    
+    result = process(data, 'array')
+    result.should be_a_kind_of Array
+    result.size.should == 3
+    result.should == target
+  end
+  
+  it 'should process empty array data' do
+    result = process("\r\n", 'array')
+    result.should be_a_kind_of Array
+    result.size.should == 0
+  end
+  
+  it 'should process hash data' do
+    data = "key: value1, key2: value2, key3: hello world, key 4: text data ,"
+    result = process(data, 'hash')
+    
+    result.should be_a_kind_of Hash
+    result.empty?.should_not == true
+    result.size.should == 4
+    result.keys.should include 'key 4'
+    result['key 4'].should == 'text data'
+  end
+  
+  it 'should process a boolean data' do
+    ['true', 'on', 'yes', 'y', '1'].each { |v| process(v, 'boolean').should == true }
+    ['', 'no', 'n', '0', 'other'].each { |v| process(v, 'boolean').should == false }
+  end
+end

data/spec/source_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe 'AppConfig' do
+  before :all do
+    establish_connection
+    init_custom_table
+    
+    Item.create(:name => 'foo', :data => 'bar', :fmt => 'string')
+  end
+  
+  it 'should raise InvalidSource error if source model is not defined' do
+    AppConfig.configure
+    proc { AppConfig.load }.should raise_error AppConfig::InvalidSource
+  end
+  
+  it 'should raise InvalidSource error if source model was not found' do
+    AppConfig.configure(:model => FakeModel)
+    proc { AppConfig.load }.should raise_error AppConfig::InvalidSource
+  end
+  
+  it 'should validate custom source fields' do
+    AppConfig.configure(
+      :model  => Item,
+      :key    => 'name',
+      :value  => 'data',
+      :format => 'fmt'
+    )
+    
+    proc { AppConfig.load }.should_not raise_error AppConfig::InvalidSource
+    
+    AppConfig.configure(
+      :model  => Item,
+      :key    => 'fake_field',
+      :value  => 'data',
+      :format => 'fmt'
+    )
+    
+    proc { AppConfig.load }.should raise_error AppConfig::InvalidSource
+  end
+  
+  it 'should load data from custom model' do
+    
+    AppConfig.configure(
+      :model  => Item,
+      :key    => 'name',
+      :value  => 'data',
+      :format => 'fmt'
+    )
+    
+    AppConfig.load
+    AppConfig.exist?('foo').should == true
+    AppConfig.foo.should == 'bar'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+$:.unshift File.expand_path("../..", __FILE__)
+
+require 'simplecov'
+SimpleCov.start do
+  add_group 'AppConfig', 'lib/app-config'
+end
+
+require 'app-config'
+
+class Setting < ActiveRecord::Base
+  validates_presence_of   :keyname, :value, :value_format
+  validates_uniqueness_of :keyname
+end
+
+class Item < ActiveRecord::Base ; end
+
+class FakeModel ; end
+
+def establish_connection
+  ActiveRecord::Base.establish_connection(
+    :adapter => "sqlite3",
+    :database => ":memory:"
+  )
+end
+
+def init_settings_table
+  ActiveRecord::Schema.define do
+    create_table :settings do |t|
+      t.string :keyname
+      t.string :value
+      t.string :value_format
+    end
+  end
+end
+
+def init_custom_table
+  ActiveRecord::Schema.define do
+    create_table :items do |t|
+      t.string :name
+      t.string :data
+      t.string :fmt
+    end
+  end
+end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: app-config
 version: !ruby/object:Gem::Version 
-  hash: 27
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Dan Sosedoff
@@ -15,27 +10,67 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-11 00:00:00 -06:00
+date: 2011-06-15 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activerecord
+  name: rake
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.8"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.6"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-description: Flexible and simple configuration settings for your Rails/Sinatra applications
-email: dan.sosedoff@gmail.com
+  version_requirements: *id005
+description: Flexible and simple configuration settings for your Rails/Sinatra applications.
+email: 
+- dan.sosedoff@gmail.com
 executables: []
 
 extensions: []
@@ -43,11 +78,22 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- app-config.gemspec
 - lib/app-config.rb
-- lib/app-config/version.rb
+- lib/app-config/app-config.rb
 - lib/app-config/errors.rb
 - lib/app-config/processor.rb
-- lib/app-config/app-config.rb
+- lib/app-config/version.rb
+- spec/config_spec.rb
+- spec/processor_spec.rb
+- spec/source_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/sosedoff/app-config
 licenses: 
@@ -62,25 +108,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.1
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Configurable application settings
-test_files: []
-
+test_files: 
+- spec/config_spec.rb
+- spec/processor_spec.rb
+- spec/source_spec.rb
+- spec/spec_helper.rb