has_settings 0.0.1 → 0.0.3

data/README.rdoc

@@ -1,17 +1,94 @@
-= has_settings
+= Has settings
 
-Description goes here.
+This is a slightly revised version of the features gem (http://github.com/zendesk/features/). This gem allows you to work with row oriented settings rather than having an ever increasing number of columns on your model table. You may want to check out alternative approaches for this, like e.g. the bit mask based ones such as https://github.com/xing/flag_shih_tzu
 
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+== Description
 
-== Copyright
+You configure the allowed settings by specifying these in an initializer:
 
-Copyright (c) 2010 Morten Primdahl. See LICENSE for details.
+  class Account < ActiveRecord::Base
+    has_settings do
+      setting :forums
+      setting :wiki
+    end
+  end
+
+These are the settings that can be used runtime. This enables code like:
+
+  account.settings.ssl?         # checks whether an account has the ssl setting.
+  account.settings.ssl.create   # adds the ssl setting to the account
+  account.settings.ssl.destroy  # removes the ssl setting from the account
+
+And that's pretty much it.
+
+Settings can also be updated with the update_attributes and update_attributes! methods.
+  
+  # assuming params include { :account => { :settings => { :wiki => '1', :forums => '0' } } }
+  account.update_attributes(params[:account]) # would add the wiki feature and remove the forums setting
+  
+We also created a view helper to help you generate the UI for enabling and disabling settings:
+
+  <% form_for(:account, :html => { :method => :put }) do |f| %>
+    <h3>
+      <%= f.settings_check_box :forums %> Enable forums on your account
+    </h3>
+  <% end %>
+
+== Security
+
+We support protection from mass updates, the syntax is as follows:
+
+  class Account < ActiveRecord::Base
+    has_settings do
+      setting :forums, :protected => true
+      setting :wiki
+    end
+  end
+
+== Installation
+
+Install the gem in your rails project by putting it in your Gemfile:
+
+  gem 'has_settings'
+
+Also remember to create the settings table, if for example you are going to be using this with an accounts model, you can should the table like:
+
+  create_table :account_settings do |t|
+    t.integer :account_id, :null => false
+    t.string  :name, :null => false
+    t.timestamps
+  end
+
+  add_index :account_settings, [ :account_id, :name ], :unique => true
+
+== Requirements
+
+* ActiveRecord
+* ActionPack
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Zendesk
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.3

data/has_settings.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{has_settings}
-  s.version = "0.0.1"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Morten Primdahl"]

data/lib/has_settings.rb

@@ -4,7 +4,7 @@ require 'has_settings/has_settings_helper'
 
 module HasSettings
   def self.ensure_settings_class(owner_class)
-    const_name = "#{owner_class.name}Settings".to_sym
+    const_name = "#{owner_class.name}Setting".to_sym
     unless Object.const_defined?(const_name)
       settings_class = Object.const_set(const_name, Class.new(HasSettings::Setting))
       settings_class.owner_class = owner_class

data/lib/has_settings/active_record_extension.rb

@@ -6,7 +6,7 @@ module HasSettings
         settings_class.instance_eval(&block)
 
         has_many :settings, :class_name => settings_class.name, :dependent => :destroy do
-          moo = settings_class
+
           def build(*setting_names)
             setting_names.each do |setting_name|
               self << settings_class.new(:name => setting_name)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: has_settings
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Morten Primdahl