rails-settings-cached 0.2.1 → 0.2.2

data/README.md

@@ -15,85 +15,123 @@ arrays, or any object. Ported to Rails 3!
 
 Edit your Gemfile:
 
-    gem "rails-settings-cached"
+```ruby
+gem "rails-settings-cached"
+```
 
 Generate your settings:
 
-    rails g settings <settings_name>
+```bash
+$ rails g settings <settings_name>
+```
 
 Now just put that migration in the database with:
     
-    rake db:migrate
+```bash
+rake db:migrate
+```
 
 ## Usage
 
 The syntax is easy.  First, lets create some settings to keep track of:
 
-    Setting.admin_password = 'supersecret'
-    Setting.date_format    = '%m %d, %Y'
-    Setting.cocktails      = ['Martini', 'Screwdriver', 'White Russian']
-    Setting.foo            = 123
-    Setting.credentials    = { :username => 'tom', :password => 'secret' }
+```ruby
+Setting.admin_password = 'supersecret'
+Setting.date_format    = '%m %d, %Y'
+Setting.cocktails      = ['Martini', 'Screwdriver', 'White Russian']
+Setting.foo            = 123
+Setting.credentials    = { :username => 'tom', :password => 'secret' }
+```
 
 Now lets read them back:
 
-    Setting.foo            # returns 123
+```ruby
+Setting.foo            # returns 123
+```
 
 Changing an existing setting is the same as creating a new setting:
 
-    Setting.foo = 'super duper bar'
+```ruby
+Setting.foo = 'super duper bar'
+```
 
 For changing an existing setting which is a Hash, you can merge new values with existing ones:
 
-    Setting.merge!(:credentials, :password => 'topsecret')
-    Setting.credentials    # returns { :username => 'tom', :password => 'topsecret' }
+```ruby
+Setting.merge!(:credentials, :password => 'topsecret')
+Setting.credentials    # returns { :username => 'tom', :password => 'topsecret' }
+```
 
 Decide you dont want to track a particular setting anymore?
 
-    Setting.destroy :foo
-    Setting.foo            # returns nil
+```ruby
+Setting.destroy :foo
+Setting.foo            # returns nil
+```
 
 Want a list of all the settings?
 
-    Setting.all            # returns {'admin_password' => 'super_secret', 'date_format' => '%m %d, %Y'}
+```ruby
+Setting.all    
+# returns {'admin_password' => 'super_secret', 'date_format' => '%m %d, %Y'}        
+```
 
 You need name spaces and want a list of settings for a give name space? Just choose your prefered named space delimiter and use Setting.all like this:
 
-    Setting['preferences.color'] = :blue
-    Setting['preferences.size'] = :large
-    Setting['license.key'] = 'ABC-DEF'
-    Setting.all('preferences.')   # returns { 'preferences.color' => :blue, 'preferences.size' => :large }
+```ruby
+Setting['preferences.color'] = :blue
+Setting['preferences.size'] = :large
+Setting['license.key'] = 'ABC-DEF'
+Setting.all('preferences.')   
+# returns { 'preferences.color' => :blue, 'preferences.size' => :large }
+```
 
 Set defaults for certain settings of your app.  This will cause the defined settings to return with the
 Specified value even if they are not in the database.  Make a new file in `config/initializers/default_settings.rb`
 with the following:
 
-    Setting.defaults[:some_setting] = 'footastic'
+```ruby
+Setting.defaults[:some_setting] = 'footastic'
+```
   
 Now even if the database is completely empty, you app will have some intelligent defaults:
 
-    Setting.some_setting   # returns 'footastic'
+```ruby
+Setting.some_setting   # returns 'footastic'
+```
 
 Settings may be bound to any existing ActiveRecord object. Define this association like this:
 Notice! is not do caching in this version.
   
-    class User < ActiveRecord::Base
-      include RailsSettings::Extend 
-    end
+```ruby
+class User < ActiveRecord::Base
+  include RailsSettings::Extend 
+end
+```
 
 Then you can set/get a setting for a given user instance just by doing this:
 
-    user = User.find(123)
-    user.settings.color = :red
-    user.settings.color # returns :red
-    user.settings.all # { "color" => :red }
+```ruby
+user = User.find(123)
+user.settings.color = :red
+user.settings.color # returns :red
+user.settings.all # { "color" => :red }
+```
 
 I you want to find users having or not having some settings, there are named scopes for this:
 
-    User.with_settings # => returns a scope of users having any setting
-    User.with_settings_for('color') # => returns a scope of users having a 'color' setting
-  
-    User.without_settings # returns a scope of users having no setting at all (means user.settings.all == {})
-    User.without_settings('color') # returns a scope of users having no 'color' setting (means user.settings.color == nil)
+```ruby
+User.with_settings 
+# => returns a scope of users having any setting
+
+User.with_settings_for('color') 
+# => returns a scope of users having a 'color' setting
+
+User.without_settings 
+# returns a scope of users having no setting at all (means user.settings.all == {})
+
+User.without_settings('color') 
+# returns a scope of users having no 'color' setting (means user.settings.color == nil)
+```
 
 That's all there is to it! Enjoy!

data/lib/rails-settings/settings.rb

@@ -1,37 +1,38 @@
 module RailsSettings
   class Settings < ActiveRecord::Base
-    
-		self.table_name = 'settings'
-    
+
+    self.table_name = 'settings'
+    attr_accessible :var
+
     class SettingNotFound < RuntimeError; end
-    
+
     cattr_accessor :defaults
     @@defaults = {}.with_indifferent_access
-    
+
     # Support old plugin
     if defined?(SettingsDefaults::DEFAULTS)
       @@defaults = SettingsDefaults::DEFAULTS.with_indifferent_access
     end
-    
+
     #get or set a variable with the variable as the called method
     def self.method_missing(method, *args)
       method_name = method.to_s
       super(method, *args)
-      
+
     rescue NoMethodError
       #set a value for a variable
       if method_name =~ /=$/
         var_name = method_name.gsub('=', '')
         value = args.first
         self[var_name] = value
-      
+
       #retrieve a value
       else
         self[method_name]
-        
+
       end
     end
-    
+
     #destroy the specified settings record
     def self.destroy(var_name)
       var_name = var_name.to_s
@@ -42,19 +43,19 @@ module RailsSettings
         raise SettingNotFound, "Setting variable \"#{var_name}\" not found"
       end
     end
-  
+
     #retrieve all settings as a hash (optionally starting with a given namespace)
     def self.all(starting_with=nil)
       options = starting_with ? { :conditions => "var LIKE '#{starting_with}%'"} : {}
       vars = thing_scoped.find(:all, {:select => 'var, value'}.merge(options))
-      
+
       result = {}
       vars.each do |record|
         result[record.var] = record.value
       end
       result.with_indifferent_access
     end
-    
+
     #get a setting value by [] notation
     def self.[](var_name)
       if var = object(var_name)
@@ -65,48 +66,48 @@ module RailsSettings
         nil
       end
     end
-    
+
     #set a setting value by [] notation
     def self.[]=(var_name, value)
       var_name = var_name.to_s
-      
+
       record = object(var_name) || thing_scoped.new(:var => var_name)
       record.value = value
       record.save!
-      
+
       value
     end
-    
+
     def self.merge!(var_name, hash_value)
       raise ArgumentError unless hash_value.is_a?(Hash)
-      
+
       old_value = self[var_name] || {}
       raise TypeError, "Existing value is not a hash, can't merge!" unless old_value.is_a?(Hash)
-      
+
       new_value = old_value.merge(hash_value)
       self[var_name] = new_value if new_value != old_value
-      
+
       new_value
     end
-  
+
     def self.object(var_name)
       thing_scoped.find_by_var(var_name.to_s)
     end
-    
+
     #get the value field, YAML decoded
     def value
       YAML::load(self[:value])
     end
-    
+
     #set the value field, YAML encoded
     def value=(new_value)
       self[:value] = new_value.to_yaml
     end
-    
+
     def self.thing_scoped
       self.scoped_by_thing_type_and_thing_id(nil, nil)
     end
-    
-    
+
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -16,7 +16,7 @@ date: 2011-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70171548902420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,7 +24,12 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70171548902420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: 
 email: huacnlee@gmail.com
 executables: []
@@ -60,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: This is imporved from rails-settings, added caching. Settings is a plugin
@@ -70,3 +75,4 @@ summary: This is imporved from rails-settings, added caching. Settings is a plug
   into your rails app.  You can store any kind of object.  Strings, numbers, arrays,
   or any object. Ported to Rails 3!
 test_files: []
+has_rdoc: