Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 1.47 KB

README.md

File metadata and controls

57 lines (42 loc) · 1.47 KB

Application Settings for Ruby on Rails built on Active Record

Gem Version Build Status Maintainability

Simplified, permanent key-value store for global application settings.

Getting Started

Add following to Gemfile:

gem 'ar-settings', require: 'settings'

then bundle install

Run generator to add migration:

$ rails generate install_settings

Usage

Gem implements minimal amount of public methods needed to manage settings

Storing and fetching settings

Settings.set(:key, 'value')    # store a value
Settings.get(:key)             # fetch a value
Settings.key = 'value'         # equivalent to Settings.set(...)
Settings.key                   # equivalent to Settings.get(...)

Mass update

Method convenient for handling settings form submission.

Settings.update({
  key: 'value',
  key2: 'value2',
  ...
})

Additional methods

Settings.has(:key)             # check if setting field exists
Settings.unset(:key)           # remove stored value if exists

To do

  1. Utilize Rails.cache to reduce overhead of querying db

Licence

Licensed under the MIT license.