app-config 0.1.1 → 0.1.2

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.1
+  - 1.9.2
+  - 1.9.3
+  - ree

data/README.md

@@ -0,0 +1,155 @@
+# 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 EE 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.
+
+### Setup
+
+In order to use AppConfig you should have a source table, similar to this:
+
+```ruby
+class CreateSettings < ActiveRecord::Migration
+  def self.up
+    create_table :settings do |t|
+      t.string   :keyname,       :null => false, :limit => 64
+      t.text     :value,         :null => false
+      t.string   :value_format,  :limit => 64,   :default => "string"
+      t.string   :name,          :limit => 64
+      t.string   :description,   :limit => 512
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :settings
+  end
+end
+```
+
+Required columns are:
+
+- keyname
+- value
+- value_format
+
+Columns **:name** and **:description** are optional and used only for informative purpose (ex: show name and description in admin panel).
+
+There is no need in indexes since the data is being loaded only once on application start.
+
+Simple model with validations should look like this:
+
+```ruby
+class Setting < ActiveRecord::Base
+  validates_presence_of   :keyname, :value
+  validates_uniqueness_of :keyname
+end
+```
+
+### Configuration
+
+Default configuration method is:
+
+```ruby
+AppConfig.configure
+```
+  
+If your settings model has a different schema, you can redefine columns:
+
+```ruby
+AppConfig.configure(
+  :model  => Setting,           # model class name as 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.
+
+```ruby
+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.
+
+```ruby
+config.after_initialize do
+  AppConfig.configure(:model => Setting)
+  AppConfig.load if Setting.table_exists?
+end
+```
+
+AppConfig gives you 3 ways to access variables:
+
+```ruby
+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.*
+
+```ruby
+AppConfig.set_key('KEYNAME', 'VALUE', 'FORMAT')
+```
+  
+Everytime you change your settings on the fly, use reload:
+
+```ruby
+AppConfig.reload
+```
+  
+Cleanup everything:
+
+```ruby
+AppConfig.flush
+```
+
+## Copyright
+
+Copyright (c) 2011 Dan Sosedoff.

data/app-config.gemspec

@@ -1,3 +1,4 @@
+# -*- encoding: utf-8 -*-
 require File.expand_path('../lib/app-config/version', __FILE__)
 
 Gem::Specification.new do |s|
@@ -10,18 +11,15 @@ Gem::Specification.new do |s|
   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=
+  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'
 end

data/lib/app-config.rb

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

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

@@ -1,3 +1,5 @@
+require 'active_record'
+
 module AppConfig
   extend AppConfig::Processor
 
@@ -96,8 +98,8 @@ module AppConfig
   
   # 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 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/errors.rb

@@ -1,6 +1,6 @@
 module AppConfig
-  class InvalidType     < Exception ; end
-  class InvalidKeyName  < Exception ; end
-  class InvalidSource   < Exception ; end
-  class UndefinedKey    < Exception ; end
+  class InvalidType     < RuntimeError ; end
+  class InvalidKeyName  < RuntimeError ; end
+  class InvalidSource   < RuntimeError ; end
+  class UndefinedKey    < RuntimeError ; end
 end

data/lib/app-config/version.rb

@@ -1,3 +1,5 @@
 module AppConfig
-  VERSION = '0.1.1'.freeze
-end
+  unless defined?(::AppConfig::VERSION)
+    VERSION = '0.1.2'.freeze
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: app-config
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Dan Sosedoff
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-15 00:00:00 -05:00
+date: 2011-08-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,7 +65,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 3.0.0
+        version: "3.0"
   type: :runtime
   version_requirements: *id005
 description: Flexible and simple configuration settings for your Rails/Sinatra applications.
@@ -80,9 +80,10 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - app-config.gemspec
 - lib/app-config.rb
@@ -114,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.3.6
+      version: "0"
 requirements: []
 
 rubyforge_project: 

data/README.rdoc

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