Simple settings management for applications (Ruby on Rails with ActiveRecord)
Add this line to your application's Gemfile:
gem 'settingson'And then execute:
$ bundleOr install it yourself as:
$ gem install settingsonrails g settingson MODELReplace MODEL by the class name used for the applications settings, it's frequently Settings but it may also be Configuration or something else. This will create a model (if one does not exist) and configure it with default options.
Next, you'll usually run
bin/rails db:migrate
# or
rake db:migrate
# for rails 4 or lessas the generator will have created a migration file (if your ORM supports them).
shell commands:
bin/rails g settingson Settings
bin/rails db:migratecode:
Settings.server.host = '127.0.0.1' # => '127.0.0.1'
Settings.server.port = '8888' # => '8888'
Settings.server.host # => '127.0.0.1'
Settings.server.port # => '8888'
Settings.server.smtp.host = '127.0.0.1' # => '127.0.0.1'
Settings.server.smtp.port = 25 # => 25
Settings.server.smtp.host # => "127.0.0.1"
Settings.server.smtp.port # => 25
Settings.from_hash({hello: :world})
Settings.hello # => :world
Settings.hello? # => true
Settings[:greeting].welcome.message = 'Hello'
Settings[:greeting].welcome.message # => 'Hello'
Settings.greeting[:welcome].message # => 'Hello'
Settings.greeting.welcome[:message] # => 'Hello'
Settings.greeting.welcome['message'] # => 'Hello'
Settings.not_found.to_s # => ""
Settings.not_found.to_i # => 0
Settings.not_found.nil? # => true
Settings.not_found.empty? # => true
Settings.not_found.blank? # => true
Settings.not_found.present? # => false
# but
Settings.not_found.class # => Settingson::Store
Settings.all # =>
# [#<Settings id: 1, key: "server.host", value: "127.0.0.1", created_at: "2015-12-08 15:17:56", updated_at: "2015-12-08 15:17:56">,
# #<Settings id: 2, key: "server.port", value: "8888", created_at: "2015-12-08 15:17:56", updated_at: "2015-12-08 15:17:56">,
# #<Settings id: 3, key: "server.smtp.host", value: "127.0.0.1", created_at: "2015-12-08 15:18:21", updated_at: "2015-12-08 15:18:21">,
# #<Settings id: 4, key: "server.smtp.port", value: 25, created_at: "2015-12-08 15:18:22", updated_at: "2015-12-08 15:18:22">,
# #<Settings id: 5, key: "hello", value: :world, created_at: "2015-12-08 15:18:32", updated_at: "2015-12-08 15:18:32">]Using with Simple Form and Haml
in view:
= simple_form_for( Settings, url: settings_path, method: :patch ) do |f|
= f.error_notification
= f.input :'server.smtp.host', label: 'SMTP Host', as: :string, placeholder: 'mail.google.com'
= f.input :'server.smtp.port', label: 'SMTP Port', as: :string, placeholder: '25'
= f.button :submit, t('update', default: 'Update settings')in controller:
class SettingsController < ApplicationController
def update
if Settings.from_hash(params[:settings])
flash.now[:notice] = t('settings_updated', default: 'Settings updated successfully')
else
flash.now[:alert] = t('settings_not_updated', default: 'Settings not updated')
end
render :edit
end
endin config/initializers/settingson.rb
Settings.defaults do |default|
default.server.smtp.host = 'host'
default.server.smtp.port = 25
end
Settings.server.smtp.host # => 'host'
Settings.server.smtp.port # => 25in config/initializers/settingson.rb
if Rails.env.development?
Settings.configure.debug = true
Settings.configure.trace = 3
Settings.configure.cache.enabled = false # default: true
endCaching is disabled by default only in test environment.
- Skip key search when assignment requested
- Fork it ( https://github.com/daanforever/settingson/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request