setler 0.0.5 → 0.0.6

data/README.rdoc

@@ -6,7 +6,7 @@ Setler is a Gem that lets one easily implement the "Feature Flags" pattern, or a
 
 Install the gem by adding this to your Gemfile:
 
-  gem "setler", git: "git://github.com/ckdake/setler.git"
+  gem "setler"
   
 Generate the model:
 
@@ -20,13 +20,14 @@ Run the migration:
 
 Create/Update settings:
 
+  # Method calls and []= are synonymous
   Featureflags.bacon_dispenser_enabled = true
-  Settings.allowed_meats = ['bacon', 'crunchy bacon']
+  Settings[:allowed_meats] = ['bacon', 'crunchy bacon']
   
 Read settings:
 
   Featureflags.bacon_dispenser_enabled # true
-  Settings.allowed_meats.include?('bacon')  # true
+  Settings[:allowed_meats].include?('bacon')  # true
   
 Destroy them:
 
@@ -59,3 +60,15 @@ Then you get:
 TODO: And look em up:
 
   User.with_settings_for('favorite_meat') # => scope of users with the favorite_meat setting
+
+== Gem Development
+
+Getting started is pretty straightforward:
+
+  1. Check out the code:  `git clone git://github.com/ckdake/setler.git`
+  2. Bundle install:  `bundle install`
+  3. Run the tests and make sure they all pass and code coverage is still 100%:  `rake test`
+  
+If you'd like to contribute code, make your changes and submit a pull request that includes appropriate tests
+
+For building the gem: `rake build` and to release a gem to github and Rubygems: `rake release`

data/Rakefile

@@ -1,4 +1,5 @@
 require 'rake/testtask'
+require 'bundler/gem_tasks'
 
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'

data/lib/generators/setler/templates/model.rb

@@ -1,3 +1,2 @@
 class <%= class_name %> < Setler::Settings
-  
 end

data/lib/setler/active_record.rb

@@ -3,7 +3,7 @@ module Setler
     
     def has_setler(scopename = 'settings')
       define_method scopename do
-        Setler::ScopedSettings.for_thing(self)
+        Setler::ScopedSettings.for_thing(self, scopename)
       end
     end
     

data/lib/setler/scoped_settings.rb

@@ -1,12 +1,13 @@
 module Setler
   class ScopedSettings < Settings
-    def self.for_thing(object)
+    def self.for_thing(object, scopename)
+      set_table_name scopename
       @object = object
       self
     end
     
     def self.thing_scoped
-      Setler::Settings.where(thing_type: @object.class.base_class.to_s, thing_id: @object.id)
+      self.base_class.where(thing_type: @object.class.base_class.to_s, thing_id: @object.id)
     end
     
   end

data/lib/setler/settings.rb

@@ -3,8 +3,6 @@ module Setler
     serialize :value
     self.abstract_class = true
     
-    set_table_name 'settings'
-    
     cattr_accessor :defaults
     @@defaults = {}.with_indifferent_access
     
@@ -15,26 +13,30 @@ module Setler
       else
         method_name = method.to_s
         if method_name.ends_with?("=")
-          # THIS IS BAD
-          # thing_scoped.find_or_create_by_var(method_name[0..-2]) should work but doesnt for some reason
-          # When @object is present, thing_scoped sets the where scope for the polymorphic association
-          # but the find_or_create_by wasn't using the thing_type and thing_id
-          thing_scoped.find_or_create_by_var_and_thing_type_and_thing_id(
-            method_name[0..-2],
-            @object.try(:class).try(:base_class).try(:to_s),
-            @object.try(:id)
-          ).update_attribute(:value, args.first)
+          self[method_name[0..-2]] = args.first
         else
-          the_setting = thing_scoped.find_by_var(method_name)
-          if the_setting.nil?
-            return @@defaults[method_name]
-          else
-            return the_setting.value
-          end
+          self[method_name]
         end
       end
     end
-    
+
+    def self.[](var)
+      the_setting = thing_scoped.find_by_var(var.to_s)
+      the_setting.try(:value) || @@defaults[var]
+    end
+
+    def self.[]=(var, value)
+      # THIS IS BAD
+      # thing_scoped.find_or_create_by_var(method_name[0..-2]) should work but doesnt for some reason
+      # When @object is present, thing_scoped sets the where scope for the polymorphic association
+      # but the find_or_create_by wasn't using the thing_type and thing_id
+      thing_scoped.find_or_create_by_var_and_thing_type_and_thing_id(
+        var.to_s,
+        @object.try(:class).try(:base_class).try(:to_s),
+        @object.try(:id)
+      ).update_attribute(:value, value)
+    end
+
     def self.destroy(var_name)
       var_name = var_name.to_s
       if setting = self.find_by_var(var_name)
@@ -52,6 +54,7 @@ module Setler
     def self.thing_scoped
       self.where(thing_type: nil, thing_id: nil)
     end
+    
   end
   
 end

data/lib/setler/version.rb

@@ -1,3 +1,3 @@
 module Setler
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/test/settings_test.rb

@@ -1,67 +1,86 @@
 require 'test_helper'
 
-class Setler::SettingsTest < Test::Unit::TestCase
+class ::SettingsTest < Test::Unit::TestCase
   setup_db
   
   def setup
-    Setler::Settings.create(:var => 'test',  :value => 'foo')
-    Setler::Settings.create(:var => 'test2', :value => 'bar')
+    ::Settings.create(:var => 'test',  :value => 'foo')
+    ::Settings.create(:var => 'test2', :value => 'bar')
   end
   
   def teardown
-    Setler::Settings.delete_all
+    ::Settings.delete_all
+    ::Preferences.delete_all
   end
   
   def test_defaults
-    Setler::Settings.defaults[:foo] = 'default foo'
+    ::Settings.defaults[:foo] = 'default foo'
     
-    assert_equal 'default foo', Setler::Settings.foo
+    assert_equal 'default foo', ::Settings.foo
     
-    Setler::Settings.foo = 'bar'
-    assert_equal 'bar', Setler::Settings.foo
+    ::Settings.foo = 'bar'
+    assert_equal 'bar', ::Settings.foo
   end
   
   def tests_defaults_false
-    Setler::Settings.defaults[:foo] = false
-    assert_equal false, Setler::Settings.foo
+    ::Settings.defaults[:foo] = false
+    assert_equal false, ::Settings.foo
   end
   
   def test_get
-    assert_equal 'foo', Setler::Settings.test
-    assert_equal 'bar', Setler::Settings.test2
+    assert_equal 'foo', ::Settings.test
+    assert_equal 'bar', ::Settings.test2
   end
-
+  
+  def test_get_with_array_syntax
+    assert_equal 'foo', ::Settings["test"]
+    assert_equal 'bar', ::Settings[:test2]
+  end
+  
   def test_update
-    Setler::Settings.test = '321'
-    assert_equal '321', Setler::Settings.test
+    ::Settings.test = '321'
+    assert_equal '321', ::Settings.test
+  end
+  
+  def test_update_with_array_syntax
+    ::Settings["test"] = '321'
+    assert_equal '321', ::Settings.test
+  
+    ::Settings[:test] = '567'
+    assert_equal '567', ::Settings.test
   end
   
   def test_create
-    Setler::Settings.onetwothree = '123'
-    assert_equal '123', Setler::Settings.onetwothree
+    ::Settings.onetwothree = '123'
+    assert_equal '123', ::Settings.onetwothree
   end
   
   def test_complex_serialization
     complex = [1, '2', {:three => true}]
-    Setler::Settings.complex = complex
-    assert_equal complex, Setler::Settings.complex
+    ::Settings.complex = complex
+    assert_equal complex, ::Settings.complex
   end
-
+  
   def test_serialization_of_float
-    Setler::Settings.float = 0.01
-    Setler::Settings.reload
-    assert_equal 0.01, Setler::Settings.float
-    assert_equal 0.02, Setler::Settings.float * 2
+    ::Settings.float = 0.01
+    ::Settings.reload
+    assert_equal 0.01, ::Settings.float
+    assert_equal 0.02, ::Settings.float * 2
   end
   
   def test_all
-    assert_equal({ "test2" => "bar", "test" => "foo" }, Setler::Settings.all)
+    assert_equal({ "test2" => "bar", "test" => "foo" }, ::Settings.all)
   end
   
   def test_destroy
-    assert_not_nil Setler::Settings.test
-    Setler::Settings.destroy :test
-    assert_nil Setler::Settings.test
+    assert_not_nil ::Settings.test
+    ::Settings.destroy :test
+    assert_nil ::Settings.test
+  end
+  
+  def test_multiple_settings_classes
+    ::Settings.testing = '123'
+    assert_nil ::Preferences.testing
   end
   
   def test_user_has_setler
@@ -72,21 +91,21 @@ class Setler::SettingsTest < Test::Unit::TestCase
     user.preferences.destroy :likes_bacon
     assert_nil user.preferences.likes_bacon
   end
-  
+   
   def test_user_settings_all
-    Setler::Settings.destroy_all
+    ::Settings.destroy_all
     user = User.create name: 'user 1'
-    assert_equal Setler::Settings.all, user.preferences.all
+    assert_equal ::Settings.all, user.preferences.all
     user.preferences.likes_bacon = true
     user.preferences.really_likes_bacon = true
     assert user.preferences.all['likes_bacon']
-    assert !Setler::Settings.all['likes_bacon']
+    assert !::Settings.all['likes_bacon']
     assert user.preferences.all['really_likes_bacon']
-    assert !Setler::Settings.all['really_likes_bacon']
+    assert !::Settings.all['really_likes_bacon']
   end
   
   def test_user_settings_override_defaults
-    Setler::Settings.defaults[:foo] = false
+    ::Settings.defaults[:foo] = false
     user = User.create name: 'user 1'
     assert !user.preferences.foo
     user.preferences.foo = true
@@ -105,7 +124,7 @@ class Setler::SettingsTest < Test::Unit::TestCase
 
   def test_destroy_when_setting_does_not_exist
     assert_raise Setler::SettingNotFound do
-      Setler::Settings.destroy :not_a_setting
+      ::Settings.destroy :not_a_setting
     end
   end
 end

data/test/test_helper.rb

@@ -21,6 +21,12 @@ class User < ActiveRecord::Base
   has_setler :preferences
 end
 
+class Settings < Setler::Settings
+end
+
+class Preferences < Setler::Settings
+end
+
 def setup_db
   ActiveRecord::Schema.define(:version => 1) do
     create_table :settings do |t|
@@ -32,6 +38,15 @@ def setup_db
     end
     add_index :settings, [ :thing_type, :thing_id, :var ], :unique => true
     
+    create_table :preferences do |t|
+      t.string :var, :null => false
+      t.text   :value, :null => true
+      t.integer :thing_id, :null => true
+      t.string :thing_type, :limit => 30, :null => true
+      t.timestamps
+    end
+    add_index :preferences, [ :thing_type, :thing_id, :var ], :unique => true
+    
     create_table :users do |t|
       t.string :name
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: setler
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-09 00:00:00.000000000Z
+date: 2011-12-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70364807212080 !ruby/object:Gem::Requirement
+  requirement: &70335468202960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70364807212080
+  version_requirements: *70335468202960
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70364807211580 !ruby/object:Gem::Requirement
+  requirement: &70335468202460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70364807211580
+  version_requirements: *70335468202460
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70364807211200 !ruby/object:Gem::Requirement
+  requirement: &70335468202080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70364807211200
+  version_requirements: *70335468202080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70364807210740 !ruby/object:Gem::Requirement
+  requirement: &70335468231300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70364807210740
+  version_requirements: *70335468231300
 - !ruby/object:Gem::Dependency
   name: cover_me
-  requirement: &70364807210320 !ruby/object:Gem::Requirement
+  requirement: &70335468230880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70364807210320
+  version_requirements: *70335468230880
 description: Setler is a Gem that lets one easily implement the "Feature Flags" pattern,
   or add settings to individual models. This is a cleanroom implementation of what
   the 'rails-settings' gem does. It's been forked all over the place, and my favorite