settings-goo 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Chris Kilmer
+
+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,47 @@
+= settings-goo
+
+settings-goo is a simple ActiveRecord based model for storing global application settings for your rails application in your database.  Settings was designed to be as simple as possible and to mimic a Hash.  Data is stored in the database fields :key and :value.  The :value field is serialized as json.  The possible method_missing magic (ex: Settings.admin_email) was intentionally left off.  Keep it simple!  You can store any kind of data as your value, i.e. boolean, float, integer, array.  
+
+== Installation
+
+Install the settings-goo gem
+  sudo gem install settings-goo
+
+== Setup
+
+Create the settings migration
+  script/generate settings_migration
+
+Run the database migration
+  rake db:migrate
+
+== Usage
+
+Create some settings:
+  Settings[:admin_email] = 'admin@somewhere.com'
+  Settings[:role_enabled] = true
+  Settings[:per_page] = 1
+  Settings[:ca_tax] = 0.87
+
+Retrieve some settings:
+  Settings[:admin_email]    # returns 'admin@somewhere.com'
+  Settings[:role_enabled]   # returns true
+  Settings[:per_page]       # returns 1
+  Settings[:ca_tax]         # return 0.87
+
+Update a setting:
+  Settings[:admin_email] = 'admin@somewhere.com'
+  Settings[:admin_email] = 'another.admin@somewhere.com'
+  Settings[:admin_email]    # returns 'another.admin@somewhere.com'
+  
+Remove a setting:
+  Settings.remove(:admin_email)
+  Settings[:admin_email]    # returns nil
+  
+List all setting keys:
+  Settings.keys             # returns [:admin_email, :ca_tax, :per_page, :role_enabled]
+  
+== TODO
+
+  Cache Settings.keys
+  Cache Create rails plugin gem

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    desc = "A simple ActiveRecord based model for storing global application settings for your rails application in your database."
+    gem.name = "settings-goo"
+    gem.summary = desc
+    gem.description = desc
+    gem.email = "chris.kilmer@dogwalkercentral.com"
+    gem.homepage = "http://github.com/chriskilmer/settings-goo"
+    gem.authors = ["Chris Kilmer"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "settings-goo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/generators/settings_migration/settings_migration_generator.rb

@@ -0,0 +1,12 @@
+class SettingsMigrationGenerator < Rails::Generator::NamedBase
+  def initialize(runtime_args, runtime_options = {})
+    runtime_args << 'create_settings' if runtime_args.empty?
+    super
+  end
+ 
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate'
+    end
+  end
+end

data/generators/settings_migration/templates/migration.rb

@@ -0,0 +1,16 @@
+class <%= class_name %> < ActiveRecord::Migration
+  @tablename = :settings
+  
+  def self.up
+    create_table @tablename do |t|
+      t.string :key, :null => false
+      t.text :value   
+    end
+    add_index @tablename, :key
+  end
+
+  def self.down
+    remove_index @tablename, :key
+    drop_table @tablename
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), %w(lib settings)))

data/lib/settings.rb

@@ -0,0 +1,56 @@
+class Settings < ActiveRecord::Base
+  validates_uniqueness_of :key
+  after_save :clear_cache
+  after_destroy :clear_cache
+
+  def value
+    val = self[:value]
+    if val
+      ActiveSupport::JSON.decode val
+    else
+      nil
+    end
+  end
+  
+  def value=(val)
+    self[:value] = val.to_json
+  end
+    
+  def self.[](key)
+    if setting = find_cached(key)
+      setting.value
+    else
+      nil
+    end
+  end
+  
+  def self.[]=(key, val)
+    key = key.to_s
+    setting = Settings.find_by_key(key) || Settings.new(:key => key)
+    setting.value = val
+    setting.save
+  end
+  
+  def self.keys
+    self.find(:all, :select => 'key', :order => 'key ASC').map{|s| s.key.to_sym}
+  end
+  
+  def self.remove(key)
+    key = key.to_s
+    setting = Settings.find_by_key(key)
+    if setting
+      setting.destroy
+    else
+      nil
+    end
+  end
+private
+  def self.find_cached(key)
+    key = key.to_s
+    Rails.cache.fetch("settings/#{key}") { Settings.find_by_key(key) }
+  end
+  
+  def clear_cache
+    Rails.cache.delete("settings/#{key}")
+  end
+end

data/settings-goo.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{settings-goo}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Kilmer"]
+  s.date = %q{2010-02-11}
+  s.description = %q{A simple ActiveRecord based model for storing global application settings for your rails application in your database.}
+  s.email = %q{chris.kilmer@dogwalkercentral.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "generators/settings_migration/settings_migration_generator.rb",
+     "generators/settings_migration/templates/migration.rb",
+     "init.rb",
+     "lib/settings.rb",
+     "settings-goo.gemspec",
+     "test/test_settings.rb"
+  ]
+  s.homepage = %q{http://github.com/chriskilmer/settings-goo}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A simple ActiveRecord based model for storing global application settings for your rails application in your database.}
+  s.test_files = [
+    "test/test_settings.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/test_settings.rb

@@ -0,0 +1,150 @@
+require File.dirname(__FILE__) + '/../../../../test/test_helper'
+
+class SettingsTest < ActiveSupport::TestCase
+  
+  def setup
+    @key_name = 'some_key'
+    Rails.cache.clear
+  end
+  
+  ##############################
+  # Proper Serialization       #
+  ##############################
+  test 'should serialize string correctly' do
+    val = 'some string'
+    setting = Settings.create(:key => @key_name, :value => val)
+    setting.reload
+    assert_equal val, setting.value
+  end
+  
+  test 'should serialize boolen correctly' do
+    val = true
+    setting = Settings.create(:key => @key_name, :value => val)
+    setting.reload
+    assert_equal val, setting.value
+  end
+  
+  test 'should serialize integer correctly' do
+    val = 1
+    setting = Settings.create(:key => @key_name, :value => val)
+    setting.reload
+    val = setting.value
+    assert_equal val, val
+    assert_equal 2, val*2
+  end
+  
+  test 'should serialize float correctly' do
+    val = 0.1
+    setting = Settings.create(:key => @key_name, :value => val)
+    setting.reload
+    val = setting.value
+    assert_equal val, val
+    assert_equal 0.2, val*2
+  end
+  
+  test 'should serialize nil correctly' do
+    setting = Settings.create(:key => @key_name)
+    setting.reload
+    assert_equal nil, setting.value
+  end
+  
+  ##############################
+  # Hash Functionality         #
+  ##############################
+  test 'should retrieve key' do
+    val = true
+    Settings.create(:key => @key_name, :value => val)
+    
+    #key given as string
+    setting = Settings[@key_name]
+    assert_equal setting, val
+    
+    #key given as symbol
+    setting = Settings[@key_name.to_sym]
+    assert_equal setting, val
+  end
+  
+  test 'should set key' do
+    val = true
+    Settings[@key_name] = val
+    setting = Settings.find_by_key(@key_name)
+    assert_equal setting.value, val
+  end
+  
+  test 'should return nil if key does not exist' do
+    assert_nil Settings[:some_unknown_key]
+  end
+  
+  test 'should remove existing key' do
+    Settings[@key_name] = true
+    Settings.remove @key_name
+    assert_nil Settings[@key_name]
+  end
+  
+  test 'should return nil when trying to remove non-existent key' do
+    assert_nil Settings.remove :non_existent_key
+  end
+   
+  ##############################
+  # Duplicate Handling         #
+  ##############################
+  test 'should not allow creation of duplicate keys' do
+    val = true
+    setting = Settings.create(:key => @key_name, :value => val)
+    assert !setting.new_record?
+    
+    #Try to create duplicate key
+    setting = Settings.create(:key => @key_name, :value => val)
+    assert setting.new_record?
+  end
+  
+  test 'should overwrite setting vs. creating a new one if existing key is specified' do
+    val = true
+    Settings[@key_name] = val
+    assert_no_difference('Settings.count') do
+      val = false
+      setting = (Settings[@key_name] = val)
+      assert_equal val, setting
+    end
+  end
+  
+  ##############################
+  # Collections                #
+  ##############################
+  test 'should return all keys' do
+    val = 'some val'
+    keys = [:a_key, :b_key]
+    keys.each {|k| Settings[k] = val}
+    assert_equal keys, Settings.keys
+  end
+  
+  ##############################
+  # Cache                      #
+  ##############################
+  test 'should set cache' do
+    cache_key = "settings/#{@key_name}"
+    assert_nil Rails.cache.fetch(cache_key)
+    Settings[@key_name] = 'some val'
+    #Now fetch it so it will be cached
+    Settings[@key_name]
+    assert_not_nil Rails.cache.fetch(cache_key)
+  end
+  
+  test 'should clear cache when updated' do
+    cache_key = "settings/#{@key_name}"
+    Settings[@key_name] = 'some val'
+    #Now fetch it so it will be cached
+    Settings[@key_name]
+    Settings[@key_name] = 'other val'
+    assert_nil Rails.cache.fetch(cache_key)
+  end
+  
+  test 'should clear cache when destroyed' do
+    cache_key = "settings/#{@key_name}"
+    Settings[@key_name] = 'some val'
+    #Now fetch it so it will be cached
+    Settings[@key_name]
+    Settings.remove @key_name
+    assert_nil Rails.cache.fetch(cache_key)    
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: settings-goo
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Kilmer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-11 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A simple ActiveRecord based model for storing global application settings for your rails application in your database.
+email: chris.kilmer@dogwalkercentral.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- generators/settings_migration/settings_migration_generator.rb
+- generators/settings_migration/templates/migration.rb
+- init.rb
+- lib/settings.rb
+- settings-goo.gemspec
+- test/test_settings.rb
+has_rdoc: true
+homepage: http://github.com/chriskilmer/settings-goo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.5
+signing_key: 
+specification_version: 3
+summary: A simple ActiveRecord based model for storing global application settings for your rails application in your database.
+test_files: 
+- test/test_settings.rb