Skip to content
This repository

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

branch: master

This branch is 0 commits ahead and 0 commits behind master

Tests: Use the migration generator template

This makes sure that the template is tested, too
latest commit bb72209150
Georg Ledermann authored April 22, 2014
Octocat-spinner-32 ci Travis: Test against Rails 4.1 April 09, 2014
Octocat-spinner-32 lib Migration should be a .rb file April 22, 2014
Octocat-spinner-32 spec Tests: Use the migration generator template April 22, 2014
Octocat-spinner-32 .gitignore Gemified November 05, 2011
Octocat-spinner-32 .travis.yml Travis: Use the added Gemfile for Rails 4.1 April 09, 2014
Octocat-spinner-32 Gemfile Rewrite - first steps February 27, 2013
Octocat-spinner-32 MIT-LICENSE Whitespace cleanup March 07, 2013
Octocat-spinner-32 README.md Moving changelog to GitHub January 30, 2014
Octocat-spinner-32 Rakefile Added Bundler gem tasks March 07, 2013
Octocat-spinner-32 rails-settings.gemspec Support for Rails 4 (issue #38) July 15, 2013
README.md

Settings for Rails

Build Status Code Climate

Ruby gem to handle settings for ActiveRecord instances by storing them as serialized Hash in a separate database table. Namespaces and defaults included.

Usage

Define 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 => 'daily'

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

  • Ruby 1.9.3 or newer
  • Rails 3.1 or greater (including Rails 4)

Installation

Include the gem in your Gemfile and run bundle to install it:

gem '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. In addition, Rails 2.3 is not supported anymore. But the database schema is unchanged, so you can continue to use the data created by 1.x, no conversion is needed.

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

Changelog

See https://github.com/ledermann/rails-settings/releases

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.