Settings Rails

Simple gem to create cacheable and administrable application wide settings.

Key / value settings are fed to a settings table, and the value is serialized into JSON. This allows for creating as many setting type subclasses as you need.

This gem requires PostgreSQL >= 9.2 for its JSON column type.

Installation

Add it to your Gemfile and bundle :

gem 'settings-rails'

Use the install generator to copy migrations, and then migrate :

rails generate settings_rails:install
rake db:migrate

Usage

Fetching settings

To fetch stored settings all you need is to use the Settings.get method :

Settings.get(:minimum_free_shipping_price)

If you're unsure wether the setting will be created or not at that moment, you can pass it the type of the setting as an argument.

Settings.get(:minimum_free_shipping_price, :float)

If not found, the setting will be built and have the right type.

To create settings you can either :

Create settings from pure Ruby

With a console or through some seeds or rake task :

Settings.build(:minimum_free_shipping_price, :float, 100.0).save!

The Settings.build method only creates a SettingsRails::Setting instance and caches it. You need to call the ActiveRecord::Base#save method on it to persist it.

Create settings from a form

The gem contains a SettingsRails::Form class which allows you to easily create nested settings form in one page.

Create a SettingsController in your app, and add the edit and update actions. Then route to them :

resource :settings, only: [:edit, :update]

Then in your edit form :

= form_for SettingsRails::Form.new, url: settings_path do |form|
  = form.fields_for :settings, Settings.get(:minimum_free_shipping_price, :float) do |fields|
    = fields.hidden_field :key
    = fields.hidden_field :_type
    = fields.label :value, 'Minimum free shipping cart total price'
    = fields.number_field :value

The SettingsRails::Form instance is always considered to be persisted, so the form will automatically be submitted to the #update controller action.

class SettingsController < ApplicationController
  def update
    form = SettingsRails::Form.new
    form.settings_attributes = settings_params[:settings_attributes]
    form.save
    redirect_to settings_path
  end

  private

  def settings_params
    params.require(:settings).permit(settings_attributes: [:key, :_type, :value])
  end
end

You're setup.