settler 1.0.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 Reinier de Lange
+
+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,146 @@
+= Settler
+
+Settler can be used for defining application wide settings in Rails. Settings are loaded from a YAML file and stored in the database using ActiveRecord to allow users to update settings on the fly. The YAML configuration allows you to not only specify defaults, but setting value validations as well!
+
+== Requirements
+
+* Activerecord, tested with Rails 2.3.8.
+
+== Installation
+ 
+Install the rails-settings gem
+
+  gem install settler
+
+And include the gem in your apps config
+
+  config.gem 'settler'
+
+Or install as a plugin if you must.  But gems are cooler.
+
+  ./script/plugin install git://github.com/moiristo/settler.git
+
+== Setup
+
+* You must create the table used by the Setting model and install an initial configuration file. Simply run this command:
+  ruby script/generate settler
+
+* This will create a migration and will add a settler.yml configuration file in your config directory. Now just migrate the database:
+  rake db:migrate
+  
+* Next, you'll have to edit the settler.yml file, of which the details are described in the next section.
+
+* You can manually set the configuration file source and default namespace as follows:
+  * Settler.source = '/path/to/my/settler.yml'
+  * Settler.namespace = 'staging'
+  
+== Configuration
+
+The initial version of settler.yml contains example settings for every default Rails environment. A setting consists of at least a key and a value. Consider the following example:
+
+  google_analytics_key: 
+    alt: Google analytics key
+    value: 'UA-xxxxxx-x'
+    editable: true
+    deletable: false
+    validations:
+      presence: true
+
+In this case, 'google_analytics_key' is the key of the setting. Every nested property is either an attribute of the setting or a list of validations:
+
+* Alt, value, editable and deletable are attributes of the Setting model. If a Setting with a given key does not exist, it is created with the attributes found. Therefore, you can consider these attributes as the default values for the setting.
+* Validations are not part of every setting, but are loaded on validation of a Setting instance. They apply to the value of the setting. The following validations can be created:
+  * 'presence',  true/false.
+  * 'inclusion', followed by a YAML array (e.g. ['a','b','c']). Accepts a comma separated string as well.
+
+Note that you can use ERB in the configuration file if you need to. For example:
+
+  google_analytics_key: 
+    value: '<%= GOOGLE_ANALYTICS_KEY %>'
+
+will evaluate the GOOGLE_ANALYTICS_KEY constant.
+
+== Access settings
+
+* Accessors will be created for every defined setting, returning a Setting instance:
+
+  > Settler.google_analytics_key
+  Setting Load (0.7ms)   SELECT * FROM "settings" WHERE ("settings"."key" = 'google_analytics_key') LIMIT 1
+  +----+----------------------+----------------------+------------+----------+-----------+-------------------------+-------------------------+
+  | id | key                  | alt                  | value      | editable | deletable | created_at              | updated_at              |
+  +----+----------------------+----------------------+------------+----------+-----------+-------------------------+-------------------------+
+  | 6  | google_analytics_key | Google analytics key | UA-xxxxx-x | true     | false     | 2010-09-22 15:04:06 UTC | 2010-09-22 15:04:06 UTC |
+  +----+----------------------+----------------------+------------+----------+-----------+-------------------------+-------------------------+
+  
+* You can access a setting's value quickly by using the index operator:
+
+  > Settler[:google_analytics_key]
+  Setting Load (0.7ms)   SELECT * FROM "settings" WHERE ("settings"."key" = 'google_analytics_key') LIMIT 1
+  => "UA-xxxxx-x"
+
+== Changing / Destroying settings
+
+* As settings are represented by a Setting ActiveRecord model, you can just update and destroy them like you would update or destroy any AR model.
+
+* By default, settings will only be editable or deletable iff the corresponding attribute is set to 'true'. This will be enforced before saving or destroying a record:
+
+  > Settler.google_analytics_key.destroy
+  Setting Load (0.7ms)   SELECT * FROM "settings" WHERE ("settings"."key" = 'google_analytics_key') LIMIT 1
+  => false
+  
+* The Setting model performs a soft delete when it is destroyed, meaning the record is not really destroyed, but just marked as deleted. The reason for doing this is because settings are reloaded from the configuration file when your application is (re)started, unless a setting is already available in the database. Therefore, it should know about all deleted settings, otherwise it would re-insert the
+deleted setting. If you want to enforce this behaviour, use Setting#delete instead.
+
+== Advanced usage
+  
+* When you define an inclusion validation on a setting, you can access these values for use in web forms by calling 'valid_values' on the setting:
+
+  > Settler.search_algorithm.valid_values
+  Setting Load (0.7ms)   SELECT * FROM "settings" WHERE ("settings"."key" = 'search_algorithm') LIMIT 1
+  => ["ferret", "sphinx"]
+
+NB: This method returns nil when valid values cannot be found.
+
+* Overriding setting attributes in the configuration is not as easy as it seems, since YAML doesn't support nested node merges. When overriding specific setting attributes, you should therefore do something like this:
+
+  settings: &settings
+    google_analytics_key: &google
+      alt: Google analytics key
+      value: 'UA-xxxxxx-x'
+
+  development:
+    <<: *settings  
+    google_analytics_key:
+      <<: *google
+      alt: Development Google analytics key
+      value: 'UA-xxxxxx-1'    
+    
+* Report missing / raise missing
+  
+* You can tell Settler to report missing attributes:
+
+  Settler.report_missing = true
+
+This will output a warning to STDOUT and the Rails logger to notify you that a missing setting was requested.
+
+* It is also possible to raise an exception instead when requesting missing attributes:
+
+  Settler.raise_missing = true
+
+== To do
+
+- Add more validations, for now only 'presence' and 'inclusion' are supported.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Reinier de Lange. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "settler"
+    gem.summary = %Q{Settler manages global application settings in Rails}
+    gem.description = %Q{This gem is a combination of the Squeegy's rails-settings and Binarylogic's settingslogic gem, meaning it reads its configuration from a YAML file, but stores all settings in the database as well for on the fly changes.}
+    gem.email = "r.j.delange@nedforce.nl"
+    gem.homepage = "http://github.com/moiristo/settler"
+    gem.authors = ["Reinier de Lange"]
+    # 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 = "settler #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/generators/settler/settler_generator.rb

@@ -0,0 +1,13 @@
+class SettlerGenerator < Rails::Generator::NamedBase
+  def initialize(runtime_args, runtime_options = {})
+    runtime_args << 'Settler' if runtime_args.empty?
+    super
+  end
+
+  def manifest
+    record do |m|
+      m.file "settler.yml", "config/settler.yml"
+      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => 'add_settings_table'
+    end
+  end
+end

data/generators/settler/templates/migration.rb

@@ -0,0 +1,19 @@
+class <%= class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :settings, :force => true do |t|
+      t.string  :key, :null => false
+      t.string  :alt
+      t.text    :value
+      t.boolean :editable
+      t.boolean :deletable
+      t.boolean :deleted      
+      t.timestamps
+    end
+    
+    add_index :settings, :key
+  end
+
+  def self.down
+    drop_table :settings
+  end
+end

data/generators/settler/templates/settler.yml

@@ -0,0 +1,30 @@
+settings: &settings
+  google_analytics_key: &google
+    alt: Google analytics key
+    value: 'UA-xxxxxx-x'
+    editable: true
+    deletable: false
+    validations:
+      presence: true
+  search_algorithm:
+    alt: Default search engine
+    value: 'ferret'
+    editable: true
+    validations:
+      inclusion: [ 'ferret' , 'sphinx' ]
+  white_list:
+    alt: 'White-listed words'
+    value: 'herp, derp'
+
+development:
+  <<: *settings  
+  google_analytics_key:
+    <<: *google
+    alt: Development Google analytics key
+    value: 'UA-xxxxxx-1'
+
+test:
+  <<: *settings
+
+production:
+  <<: *settings

data/init.rb

@@ -0,0 +1,3 @@
+require 'hash_extension'
+require 'setting'
+require 'settler'

data/lib/hash_extension.rb

@@ -0,0 +1,9 @@
+class Hash
+  # Returns a hash that only contains keys that are passed in selected_keys. This is different
+  # from Hash#select, since that method returns an array of arrays.
+  def only(*selected_keys)
+    cpy = self.dup
+    keys.each { |key| cpy.delete(key) unless selected_keys.map(&:to_s).include?(key) }
+    cpy
+  end
+end

data/lib/setting.rb

@@ -0,0 +1,57 @@
+# The Setting class is an AR model that encapsulates a Settler setting. The key if the setting is the only required attribute.\
+class Setting < ActiveRecord::Base  
+  before_update :ensure_editable
+  
+  validates_presence_of :key  
+  validate :setting_validations
+  
+  serialize :value
+  
+  default_scope :conditions => ['deleted = ? or deleted IS NULL', false]
+  
+  # Returns all valid values for this setting, which is based on the presence of an inclusion validator.
+  # Will return nil if no valid values could be determined.
+  def valid_values
+    if validators['inclusion']
+      return case
+        when validators['inclusion'].is_a?(Array) then validators['inclusion']
+        when validators['inclusion'].is_a?(String) then validators['inclusion'].to_s.split(',').map{|v| v.to_s.strip }
+        else nil
+      end
+    end
+    nil
+  end
+  
+  # Performs a soft delete of the setting if this setting is deletable. This ensures this setting is not recreated from the configuraiton file.
+  # Returns false if the setting could not be destroyed.
+  def destroy    
+    if deletable?       
+      self.deleted = true if Setting.update_all({ :deleted => true }, { :id => self })
+      deleted?
+    else 
+      false
+    end
+  end
+  
+  # Can be used to get *all* settings, including deleted settings.
+  def self.without_default_scope &block
+    Setting.with_exclusive_scope(&block)
+  end
+  
+protected
+
+  # Performs instance validations as defined in the settler configuration.
+  def setting_validations
+    errors.add(:value, I18n.t(:blank, :scope => 'activerecord.errors.messages')) if validators['presence'] && ['1','true',true].include?(validators['presence']) && self.value.nil?
+    errors.add(:value, I18n.t(:inclusion, :scope => 'activerecord.errors.messages')) if valid_values && !valid_values.include?(self.value)
+  end
+  
+  # Retrieves all validators defined for this setting.
+  def validators
+    @validators ||= Settler.validations_for(self.key)
+  end
+  
+  # Before_update filter to ensure uneditable settings cannot be updated.
+  def ensure_editable;  return false unless editable?  end  
+    
+end

data/lib/settler.rb

@@ -0,0 +1,77 @@
+require "yaml"
+require "erb"
+
+# Settler loads and manages application wide settings and provides an interface for retrieving settings. The Settler
+# object cannot be instantiated; all functionality is available on class level.
+class Settler
+  private_class_method :new
+  cattr_accessor  :config, :raise_missing, :report_missing  
+  cattr_writer    :namespace, :source
+  
+  class << self
+    # Loads the settler configuration from settler.yml and defines methods for retrieving the found settings.
+    def load!    
+      raise "Source settler.yml not set. Please create one and set it by using Settler.source = <file>. When using Rails, please create a settler.yml file in the config directory." unless source
+      self.config = YAML.load(ERB.new(File.read(source)).result).to_hash
+      self.config = config[namespace] if namespace
+      self.config.each{ |key, attributes| Setting.without_default_scope { Setting.find_or_create_by_key(key, attributes.only(:alt, :value, :editable, :deletable)) } }
+      Setting.all.each{ |s| key = s.key; Settler.class.send(:define_method, key){ Setting.find_by_key(key) } }
+    end    
+    
+    # Shortcut method for quickly retrieving settings. This method directly returns the setting's value instead of the Setting instance. 
+    def [](key)
+      Settler.load! if config.nil?      
+      Setting.find_by_key(key.to_s).try(:value)
+    end
+    
+    # Returns an array of all setting keys
+    def settings
+      Settler.load! if config.nil?
+      Setting.all.map(&:key)
+    end  
+    
+    # Returns a list of validations to perform on a setting.
+    def validations_for(key)
+      setting_validations = {}
+      Settler.load! if config.nil?
+      (setting = config[key.to_s]) ? setting['validations'] || {} : {}
+    end
+    
+    # Overrides the normal method_missing to return nil for non-existant settings. The behaviour of this method
+    # depends on the boolean attributes raise_missing and report_missing.
+    def method_missing(name, *args, &block)
+      method_name = name.to_s      
+      return super if Settler.private_methods(false).include?(method_name)
+      
+      if config.nil?
+        Settler.load!
+        return send(method_name)
+      end
+      
+      if report_missing  
+        puts "[Settler] Warning: setting missing: #{method_name}"     
+        Rails.logger.warn("[Settler] setting missing: #{method_name}") if defined?(Rails)
+      end
+      
+      raise "[Settler] setting missing: #{method_name}" if raise_missing
+      
+      nil
+    end 
+    
+    # Returns the file location of the settler.yml configuration file. Defaults to 
+    # the 'config/settler.yml' if the library is included in a Rails app.
+    def source
+      @@source ||= File.join(Rails.root, 'config', 'settler.yml') if defined?(Rails)
+      @@source
+    end
+    
+    # Returns the namespace of the configuration to look for settings. Defaults to 
+    # the current Rails environment if the library is included in a Rails app.
+    def namespace
+      @@namespace ||= Rails.env if defined?(Rails)
+      @@namespace
+    end     
+    
+  end
+  
+end

data/test/database.yml

@@ -0,0 +1,6 @@
+sqlite: 
+  adapter: sqlite 
+  database: ":memory:"
+sqlite3: 
+  adapter: sqlite3 
+  database: ":memory:"