rails-settings 1.0.0

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Alex Wayne
+
+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 PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL 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,70 @@
+= Settings Plugin
+
+Settings is a plugin that makes managing a table of global key, value pairs easy.
+Think of it like a global Hash stored in you database, that uses simple ActiveRecord
+like methods for manipulation.  Keep track of any global setting that you dont want
+to hard code into your rails app.  You can store any kind of object.  Strings, numbers,
+arrays, or any object.
+
+
+== Installation
+ 
+Install the rails-settings gem
+
+  gem install rails-settings
+
+And include the gem in your apps config
+
+  config.gem 'rails-settings', :lib => 'settings'
+
+Or install as a plugin if you must.  But gems are cooler.
+
+  ./script/plugin install git://github.com/Squeegy/rails-settings.git
+
+== Setup
+
+You must create the table used by the Settings model.  Simply run this command:
+  ruby script/generate settings_migration
+
+Now just put that migration in the database with:
+  rake db:migrate
+
+
+== Usage
+
+The syntax is easy.  First, lets create some settings to keep track of:
+
+  Settings.admin_password = 'supersecret'
+  Settings.date_format    = '%m %d, %Y'
+  Settings.cocktails      = ['Martini', 'Screwdriver', 'White Russian']
+  Settings.foo            = 123
+
+Now lets read them back:
+
+  Settings.foo            # returns 123
+
+Changing an existing setting is the same as creating a new setting:
+
+  Settings.foo = 'super duper bar'
+
+Decide you dont want to track a particular setting anymore?
+
+  Settings.destroy :foo
+  Settings.foo            # returns nil
+
+Want a list of all the settings?
+
+  Settings.all            # returns {'admin_password' => 'super_secret', 'date_format' => '%m %d, %Y'}
+
+Set defaults for certain settings of your app.  This will cause the defined settings to return with the
+Specified value even if they are not in the database.  Make a new file in config/initializers/settings.rb
+with the following:
+
+  Settings.defaults[:some_setting] = 'footastic'
+  
+Now even if the database is completely empty, you app will have some intelligent defaults:
+
+  Settings.some_setting   # returns 'footastic'
+
+
+That's all there is to it!. Enjoy!

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rubygems'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the fleximage plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+
+desc 'Generate documentation for the rails-settings plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rails Settings'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rails-settings"
+    gem.summary = <<EOF
+Settings is a plugin that makes managing a table of global key, value pairs
+easy. Think of it like a global Hash stored in your database, that uses simple
+ActiveRecord like methods for manipulation. Keep track of any global setting
+that you don't want to hard code into your rails app. You can store any kind
+of object. Strings, numbers, arrays, or any serializable object.
+EOF
+    gem.description = <<EOF
+Settings is a plugin that makes managing a table of global key, value pairs
+easy.
+EOF
+    gem.email = "ruby@beautifulpixel.com"
+    gem.homepage = "http://github.com/Squeegy/rails-settings"
+    gem.authors = `git log --pretty=format:"%an"`.split("\n").uniq.sort
+    gem.add_development_dependency "rails", ">=2.0.1"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available."
+  puts "Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/generators/settings_migration/USAGE

@@ -0,0 +1,14 @@
+Description:
+    The settings migration generator creates a migration for the settings plugin.
+
+    The generator takes a migration name as its argument.  The migration name may be
+    given in CamelCase or under_score.  'add_settings_table' is the default.
+
+    The generator creates a migration class in db/migrate prefixed by its number
+    in the queue.
+
+Example:
+    ./script/generate settings_migration
+
+    With 4 existing migrations, this will create an AddSettingsTable migration in the
+    file db/migrate/005_add_settings_table.rb

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 << 'add_settings_table' 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,15 @@
+class <%= class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :settings, :force => true do |t|
+      t.string :var, :null => false
+      t.text   :value, :null => true
+      t.timestamps
+    end
+    
+    add_index :settings, :var, :uniq => true
+  end
+
+  def self.down
+    drop_table :settings
+  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,92 @@
+class Settings < ActiveRecord::Base
+  class SettingNotFound < RuntimeError; end
+  
+  cattr_accessor :defaults
+  @@defaults = {}.with_indifferent_access
+  
+  # Support old plugin
+  if defined?(SettingsDefaults::DEFAULTS)
+    @@defaults = SettingsDefaults::DEFAULTS.with_indifferent_access
+  end
+  
+  #get or set a variable with the variable as the called method
+  def self.method_missing(method, *args)
+    method_name = method.to_s
+    super(method, *args)
+    
+  rescue NoMethodError
+    #set a value for a variable
+    if method_name =~ /=$/
+      var_name = method_name.gsub('=', '')
+      value = args.first
+      self[var_name] = value
+    
+    #retrieve a value
+    else
+      self[method_name]
+      
+    end
+  end
+  
+  #destroy the specified settings record
+  def self.destroy(var_name)
+    var_name = var_name.to_s
+    if self[var_name]
+      object(var_name).destroy
+      true
+    else
+      raise SettingNotFound, "Setting variable \"#{var_name}\" not found"
+    end
+  end
+
+  #retrieve all settings as a hash
+  def self.all
+    vars = find(:all, :select => 'var, value')
+    
+    result = {}
+    vars.each do |record|
+      result[record.var] = record.value
+    end
+    result.with_indifferent_access
+  end
+  
+  #retrieve a setting value by [] notation
+  def self.[](var_name)
+    if var = object(var_name)
+      var.value
+    elsif @@defaults[var_name.to_s]
+      @@defaults[var_name.to_s]
+    else
+      nil
+    end
+  end
+  
+  #set a setting value by [] notation
+  def self.[]=(var_name, value)
+    var_name = var_name.to_s
+    
+    record = object(var_name) || Settings.new(:var => var_name)
+    record.value = value
+    record.save
+  end
+  
+  #retrieve the actual Setting record
+  def self.object(var_name)
+    Settings.find_by_var(var_name.to_s)
+  end
+  
+  #get the value field, YAML decoded
+  def value
+    YAML::load(self[:value])
+  end
+  
+  #set the value field, YAML encoded
+  def value=(new_value)
+    self[:value] = new_value.to_yaml
+  end
+  
+  #Deprecated!
+  def self.reload # :nodoc:
+    self
+  end
+end

data/rails-settings.gemspec

@@ -0,0 +1,56 @@
+# 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{rails-settings}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alex Wayne", "Joshua Clayton", "squeegy"]
+  s.date = %q{2009-12-24}
+  s.description = %q{Settings is a plugin that makes managing a table of global key, value pairs
+easy.
+}
+  s.email = %q{ruby@beautifulpixel.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "generators/settings_migration/USAGE",
+     "generators/settings_migration/settings_migration_generator.rb",
+     "generators/settings_migration/templates/migration.rb",
+     "init.rb",
+     "lib/settings.rb",
+     "rails-settings.gemspec",
+     "test/settings_test.rb"
+  ]
+  s.homepage = %q{http://github.com/Squeegy/rails-settings}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Settings is a plugin that makes managing a table of global key, value pairs easy. Think of it like a global Hash stored in your database, that uses simple ActiveRecord like methods for manipulation. Keep track of any global setting that you don't want to hard code into your rails app. You can store any kind of object. Strings, numbers, arrays, or any serializable object.}
+  s.test_files = [
+    "test/settings_test.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
+      s.add_development_dependency(%q<rails>, [">= 2.0.1"])
+    else
+      s.add_dependency(%q<rails>, [">= 2.0.1"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 2.0.1"])
+  end
+end
+

data/test/settings_test.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../../../test/test_helper'
+
+class SettingsTest < Test::Unit::TestCase
+  
+	def setup
+		Settings.create(:var => 'test',  :value => 'foo')
+		Settings.create(:var => 'test2', :value => 'bar')
+	end
+	
+  def test_defaults
+    Settings.defaults[:foo] = 'default foo'
+    
+    assert_nil Settings.object(:foo)
+    assert_equal 'default foo', Settings.foo
+    
+    Settings.foo = 'bar'
+    assert_equal 'bar', Settings.foo
+    assert_not_nil Settings.object(:foo)
+  end
+  
+	def test_get
+		assert_setting 'foo', :test
+		assert_setting 'bar', :test2
+	end
+	
+	def test_update
+		assert_assign_setting '321', :test
+	end
+	
+	def test_create
+    assert_assign_setting '123', :onetwothree
+	end
+  
+  def test_complex_serialization
+    complex = [1, '2', {:three => true}]
+    Settings.complex = complex
+    assert_equal complex, Settings.complex
+  end
+  
+  def test_serialization_of_float
+    Settings.float = 0.01
+    Settings.reload
+    assert_equal 0.01, Settings.float
+    assert_equal 0.02, Settings.float * 2
+  end
+  
+  private
+    def assert_setting(value, key)
+      key = key.to_sym
+      assert_equal value, eval("Settings.#{key}")
+      assert_equal value, Settings[key.to_sym]
+      assert_equal value, Settings[key.to_s]
+    end
+    
+    def assert_assign_setting(value, key)
+      key = key.to_sym
+      assert_equal value, eval("Settings.#{key} = value")
+      assert_setting value, key
+      eval("Settings.#{key} = nil")
+      
+      assert_equal value, (Settings[key] = value)
+      assert_setting value, key
+      Settings[key] = nil
+      
+      assert_equal value, (Settings[key.to_s] = value)
+      assert_setting value, key
+    end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: rails-settings
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Alex Wayne
+- Joshua Clayton
+- squeegy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-24 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.1
+    version: 
+description: |
+  Settings is a plugin that makes managing a table of global key, value pairs
+  easy.
+
+email: ruby@beautifulpixel.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- generators/settings_migration/USAGE
+- generators/settings_migration/settings_migration_generator.rb
+- generators/settings_migration/templates/migration.rb
+- init.rb
+- lib/settings.rb
+- rails-settings.gemspec
+- test/settings_test.rb
+has_rdoc: true
+homepage: http://github.com/Squeegy/rails-settings
+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: Settings is a plugin that makes managing a table of global key, value pairs easy. Think of it like a global Hash stored in your database, that uses simple ActiveRecord like methods for manipulation. Keep track of any global setting that you don't want to hard code into your rails app. You can store any kind of object. Strings, numbers, arrays, or any serializable object.
+test_files: 
+- test/settings_test.rb