Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Ruby gem to handle settings for ActiveRecord objects by storing them as serialized Hash in a separate database table. Optional: Defaults and Namespaces.
Ruby
tree: 14f9658c7b

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
ci
lib
spec
.gitignore
.travis.yml
Changelog.md
Gemfile
MIT-LICENSE
README.md
Rakefile
rails-settings.gemspec

README.md

Settings for Rails 3

Build Status Code Climate

Ruby gem to handle settings for ActiveRecord objects by storing them as serialized Hash in a separate database table. Optional: Defaults and Namespaces.

BEWARE: This is version 2 which is a complete rewrite and NOT compatible with version 1.x

Example

Defining settings

class User < ActiveRecord::Base
  has_settings do |s|
    s.key :dashboard, :defaults => { :theme => 'blue', :view => 'monthly', :filter => false }
    s.key :calendar,  :defaults => { :scope => 'company'}
  end
end

If no defaults are needed, a simplified syntax can be used:

class User < ActiveRecord::Base
  has_settings :dashboard, :calendar
end

Every setting is handled by the class RailsSettings::SettingObject. You can use your own class, e.g. for validations:

class Project < ActiveRecord::Base
  has_settings :info, :class_name => 'ProjectSettingObject'
end

class ProjectSettingObject < RailsSettings::SettingObject
  validate do
    unless self.owner_name.present? && self.owner_name.is_a?(String)
      errors.add(:base, "Owner name is missing")
    end
  end
end

Set settings

user = User.find(1)
user.settings(:dashboard).theme = 'black'
user.settings(:calendar).scope = 'all'
user.settings(:calendar).display = 'daily'
user.save! # saves new or changed settings, too

or

user = User.find(1)
user.settings(:dashboard).update_attributes! :theme => 'black'
user.settings(:calendar).update_attributes! :scope => 'all', :display => 'dialy'

Get settings

user = User.find(1)
user.settings(:dashboard).theme
# => 'black

user.settings(:dashboard).view
# => 'monthly'  (it's the default)

user.settings(:calendar).scope
# => 'all'

Using scopes

User.with_settings
# => all users having any setting

User.without_settings
# => all users without having any setting

User.with_settings_for(:calendar)
# => all users having a setting for 'calender'

User.without_settings_for(:calendar)
# => all users without having settings for 'calendar'

Requirements

Rails 3.1.x or 3.2.x Ruby 1.8.7, 1.9.3 or 2.0.0

Installation

Include the gem in your Gemfile:

gem 'ledermann-rails-settings', :github => 'ledermann/rails-settings', :require => 'rails-settings'

Generate and run the migration:

rails g rails_settings:migration
rake db:migrate

Compatibility

Version 2 is a complete rewrite and has a new DSL, so it's not compatible with Version 1. But the database schema is unchanged, so you can use the same data after upgrading. In addition, Rails 2.3 is not supported anymore.

If you don't want to upgrade, you find the old version in the 1.x branch. But don't expect any updates there.

License

MIT License Copyright (c) 2013 Georg Ledermann

This gem is a complete rewrite of rails-settings by Alex Wayne

Something went wrong with that request. Please try again.