tunable 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f46c7acc701e5042514bd5e5b38aaf6e7d55f36
-  data.tar.gz: d64dacc173796faffd043002b8984df92f2f744a
+  metadata.gz: 429e9db65fc91c748fc526ef2b8b3a8241490e39
+  data.tar.gz: 21c3c99469bebdd04cfcf5e9d383a15878eb2520
 SHA512:
-  metadata.gz: 4f3b123409df4270709860c7f0f02ae43e738450905ef44494664a01ef54c583a5897ca723e8fc120e849c465b1a26fdd5d2060c369551fa59e2a1e479ae497f
-  data.tar.gz: 8c89d8944a34e84aa30c79ac91504aa120c31d6788bbe01f2ecabc61ea98f01a2c0098fae763458df75529a8f09153868d90eb1fea2f6c9b9fabe8f76b8ba1b3
+  metadata.gz: b12ebe2c3d3670c3d9eb3de9511d0e5e068d90806c315c1011ca91c74fe9579bdca681102dde7f1aa47ed298dde33064fc56fb2f14393f14b1921bb849cc7bbb
+  data.tar.gz: 44e64b53736a25c6c754dccb8f6a842ee3182c0aeaf2400ecc9fd5b860ae834fe920d22ea209840206c7ddb2515d1bd9e476cb2457fcd12edf053ab4c46991cf

data/README.md

@@ -1,19 +1,14 @@
 Tunable
 =======
 
-Pluggable settings for your AR models.
+A simple gem that provides scoped, pluggable settings for your AR 4+ models. Let's you keep things simple in your models by moving all customizable settings into a separate table, using a polymorphic Settings model. 
 
 The code
 --------
 
-Let's set up notification settings for our Users.
-
 ``` rb
 class User < ActiveRecord::Base
   include Tunable::Model
-
-  has_settings :notify => :activity, :new_messages, :weekly_report
-
 end
 ```
 
@@ -21,16 +16,23 @@ Now we can do:
 
 ``` rb
   user = User.create(:name => 'John Lennon')
-  user.get_setting(:notify, :activity) # => nil
+  user.get_setting(:theme, :layout) # => nil
+  user.get_setting(:theme, :color) # => nil
 
-  user.settings = { notify: { activity: true } }
+  user.settings = { theme: { format: 'wide', color: 'red' } }
   user.save
 
-  user.get_setting(:notify, :activity) # => true
+  user.get_setting(:theme, :layout) # => 'wide'
+  user.get_setting(:theme, :color) # => 'red'
 ```
 
-Tunable also lets you set defaults for your settings. Here's how.
+You can also get a flat hash of your settings by calling the `settings_hash` method.
+
+``` rb
+  user.settings_hash # => { :theme => { :layout => 'wide', :color => 'red' } }
+```
 
+Tunable also lets you set defaults for your settings. Let's set up default notification settings for our Users. 
 
 ``` rb
 class User < ActiveRecord::Base
@@ -39,9 +41,8 @@ class User < ActiveRecord::Base
   has_settings :notify => {
     activity:      { default: false },
     new_messages:  { default: true },
-    weekly_report: { default: true }
+    weekly_report: { default: false }
   }
-
 end
 ```
 
@@ -57,7 +58,7 @@ Now we can do:
   user.get_setting(:notify, :new_messages) # => false
 ```
 
-Tunable also provides a `main_settings` helper that sets up main level settings.
+Tunable also provides a `main_settings` helper that sets up main level settings. These automatically define setters and getters for your model instances.
 
 ``` rb
 class User < ActiveRecord::Base
@@ -65,13 +66,11 @@ class User < ActiveRecord::Base
 
   # in this case we're not setting a default value for the :no_cookies setting
   main_settings :no_cookies, :language => { :default => 'en' }
-
 end
 ```
 
 Now let's see what happens.
 
-
 ``` rb
   user = User.create(:name => 'Paul MacCartney')
   user.no_cookies # => nil
@@ -85,14 +84,15 @@ Now let's see what happens.
   user.language # => 'es'
 ```
 
-You can also set a lambda to return the default setting for a model.
+Beautiful. You can also set a lambda to return the default setting for a model.
 
 
-```
+``` rb
 class User < ActiveRecord::Base
+  include Tunable::Model
 
-  main_settings :layout_color => {
-    :default => lambda { |user| user.is_admin? ? 'black' : 'blue' }
+  main_settings :layout_type => {
+    :default => lambda { |user| user.is_admin? ? 'advanced' : 'simple' }
   }
 
 end
@@ -102,12 +102,12 @@ Then:
 
 ``` rb
   user = User.create(:name => 'Ringo Starr', :admin => false)
-  user.layout_color # => 'blue'
+  user.layout_type # => 'simple'
   user.admin = true
-  user.layout_color # => 'black'
+  user.layout_type # => 'advanced'
 ```
 
-That's pretty much it.
+That's pretty much it. Fork away and send a PR, but please add tests for it.
 
 Boring stuff
 ------------

data/lib/tunable/model.rb

@@ -139,7 +139,6 @@ module Tunable
     # instance methods below
 
     def settings=(hash)
-      puts hash.inspect
       Tunable::Setting.store_many(hash, self)
     end
 
@@ -230,7 +229,8 @@ module Tunable
             # main settings, so we need to make sure we normalize here again
             normalized_value = Tunable.normalize_value(value)
 
-            new_settings << [context.to_s, key.to_s, normalized_value, self.id, self.class.model_name.to_s]
+            # class.base_class returns name of parent class for STI models
+            new_settings << [context.to_s, key.to_s, normalized_value, self.id, self.class.base_class.name]
             # remove_instance_variable("@setting_main_#{key}") if context == :main
           end
         end

data/lib/tunable/version.rb

@@ -1,5 +1,5 @@
 module Tunable
 
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tunable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tomás Pollak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord