Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Simple settings manager for Rails 3.
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.gitignore
MIT-LICENSE
README.md
Rakefile
init.rb
set_man.gemspec
setman_test

README.md

SetMan

Simple settings manager for your application.

Requirements

Rails 3 only.

Install

Add to your gemfile

gem 'set_man'

after this execute in console:

rails g set_man [ModelName]

Overview

For enable SetMan for model, you can add call settings.

class Options < ActiveRecord::Base

  settings

end

For getting option, you can use get_option:

Options.get_option :site_name #=> "Site Name"

or shorten variant:

Options.get :site_name #=> "Site Name"

For setting option, you can use set_option:

Options.set_option :site_name, "New name" #=> "New Name"

or shorten variant:

Options.set :site_name, "New Name" #=> "New Name"

Methods set_option and set can given :to parameter:

Options.set_option :site_name, :to => "New Name" #=> "New Name"
Options.set :site_name, :to => "New Name" #=> "New Name"

If given second argument, and :to, set_option will use second argument as new value:

Options.set_option :site_name, "New Name", :to => "Not New Name" #=> "New Name"

If option doesn't exists, then option will been created:

Options.set_option :not_existing_option, "Some value" #=> "Some value"

For deleting option, you can use del_option:

Options.del_option :site_name #=> "New Name"

or shorten variant:

Options.del :site_name #=> "New Name"

You can use methods with names of options for accessing:

Options.site_name #=> "Site Name"
Options.site_name = "New Name" #=> "Site Name"
Options.site_name? #=> true
Options.site_name! #=> "Site Name"

Postfix ? using for test of existing option. Postfix ! using for deleting option.

This is method not override default methods of ActiveRecord::Base methods and other. Example:

Options.columns_hash #=> columns list of table

If you need returning ActiveRecord::Base object, instead value of option, you can use :as_object => true:

Options.get_option :site_name, :as_object => true #=> #<Options ...>

This work for short names too:

Options.site_name :as_object => true #=> #<Options ...>

Multiple options

You can work with multiple options:

Options.get_options [:site_name, :site_description] #=> { "site_name" => "Site Name", "site_description" => "Site description" }
Options.set_options { :site_name => "New Site Name", :per_page => 20 } #=> { "site_name" => "New Site Name", :per_page => 20 }
Options.del_options [:site_name, :per_page] #=> { "site_name" => "New Site Name", "per_page" => 20 }

If given :as_object => true, returning array of objects, instead hash of values.

get_options and del_options return only existing options.

Ideas for next

  • Support of cache;
  • Default options;
  • Options group;
  • Callbacks, validations and own types.

Copyright (c) 2011 Alexey Plutalov, released under the MIT license

Something went wrong with that request. Please try again.