arsettings 1.0.1 → 1.1.1

data/test/setting_initialize_test.rb

@@ -0,0 +1,113 @@
+require File.dirname(__FILE__) + '/_helper'
+
+class InitializingSettingsClasses < Test::Unit::TestCase
+  
+  # can't lazy load so that error only shows up if you try to use it
+  # because we need to read the table immediately to load propagated settings
+  verify 'raises error if db does not support the class' do
+    assert_raises(ActiveRecord::StatementInvalid) { ARSettings.create_settings_class 'NotInTheDatabase' }
+  end
+  
+  verify 'raises error if the constant already exists' do
+    assert_nothing_raised { ARSettings.create_settings_class 'Setting2' }
+    assert_raises(ARSettings::AlreadyDefinedError) { ARSettings.create_settings_class 'Setting2' }
+  end
+          
+  verify 'loads up values previously stored in the db' do
+    $sql_executor.silent_execute "insert into predefined_values (name,value,package,volatile) values ('predefined_value','#{ARSettings.serialize(12)}','PredefinedValues','f')"
+    $sql_executor.silent_execute "insert into predefined_values (name,value,package,volatile) values ('predefined_value','#{ARSettings.serialize(13)}','String','f')"
+    ARSettings.create_settings_class :PredefinedValues
+    # make sure it loads the value
+    assert_equal 2 , PredefinedValues.count
+    assert PredefinedValues.package(PredefinedValues).setting?(:predefined_value)
+    assert PredefinedValues.package(String).setting?(:predefined_value)
+    assert_equal 12 , PredefinedValues.predefined_value
+    assert_equal 13 , PredefinedValues.package(String).predefined_value
+    PredefinedValues.add :predefined_value , :default => 20
+    assert_equal 12 , PredefinedValues.predefined_value
+  end
+   
+  verify 'can specify a volatility default' do
+    ARSettings.create_settings_class :VolatileTest    , :volatile => true
+    VolatileTest.add :abcd , :default => 1    , :volatile => false
+    VolatileTest.add :efgh , :default => 10   , :volatile => true
+    VolatileTest.add :ijkl , :default => 100
+    assert_equal 1   , VolatileTest.abcd
+    assert_equal 10  , VolatileTest.efgh
+    assert_equal 100 , VolatileTest.ijkl
+    $sql_executor.silent_execute "update volatile_tests set value='#{ARSettings.serialize(2)}' where name='abcd'"
+    $sql_executor.silent_execute "update volatile_tests set value='#{ARSettings.serialize(20)}' where name='efgh'"
+    $sql_executor.silent_execute "update volatile_tests set value='#{ARSettings.serialize(200)}' where name='ijkl'"
+    assert_equal 1   , VolatileTest.abcd
+    assert_equal 20  , VolatileTest.efgh
+    assert_equal 200 , VolatileTest.ijkl
+  end
+  
+  verify 'create_settings_class should return the class' do
+    result = ARSettings.create_settings_class :ThisShouldBeReturned
+    assert_equal ThisShouldBeReturned , result
+  end
+  
+  verify 'cannot reload from db' do
+    begin
+      flag = false
+      Setting.load_from_db
+      flag = true
+    rescue Exception
+      assert !flag
+    end
+  end
+  
+  verify 'default MAX_CHARS is 30' do
+    ARSettings.create_settings_class :Setting4
+    assert_equal 30 , Setting4.MAX_CHARS
+  end
+  
+  # leave it up to the user to ensure they are not speciying more than their DB's string class
+  # if that is the case, they could switch it out with text
+  verify 'can specify MAX_CHARS' do
+    ARSettings.create_settings_class :Setting5 , :max_chars => 50
+    assert_equal 50 , Setting5.MAX_CHARS
+  end
+
+  verify 'raises errors if values loaded from the db violate maxlength' do
+    $sql_executor.silent_execute "insert into setting10s (name,value,package,volatile) values ('abc','#{ARSettings.serialize(12)}','Setting10','f')"
+    assert_raises(ARSettings::InvalidNameError) { ARSettings.create_settings_class :Setting10 , :max_chars => 2 }
+  end
+  
+  context 'ARSettings.default_class' do
+    verify 'ARSettings will set the new class to the default if no default exists' do
+      ARSettings.default_class = nil
+      ARSettings.create_settings_class :Setting14s
+      assert_equal Setting14s , ARSettings.default_class
+    end
+  end
+  
+  verify "doesn't raise error for valid options" do
+    assert_nothing_raised do
+      ARSettings.create_settings_class :Setting17s , :max_chars => 50 , :volatile => false
+    end
+  end
+  
+  verify "does raise error if it receives any invalid options" do
+    [ [ :Setting18s  ,  :package         ,   String  ],
+      [ :Setting19s  ,  :settings_class  ,   Setting ],
+      [ :Setting20s  ,  :lkjdsf          ,   true    ],
+      [ :Setting21s  ,  :abcd            ,   true    ],
+      [ :Setting22s  ,  :instance        ,   true    ],
+      [ :Setting24s  ,  :default         ,   true    ],
+    ].each do |klass,key,value|
+      assert_raises ARSettings::InvalidOptionError do
+        ARSettings.create_settings_class klass , key => value
+      end      
+    end
+  end
+  
+  verify 'create should be an alias for create_settings_class' do
+    ARSettings.create :Setting25s
+    Setting25s.add :howdy , :default => 0
+    assert_equal 0 , Setting25s.howdy
+    assert_equal 1 , Setting25s.count
+  end
+  
+end

data/test/setting_test.rb

@@ -0,0 +1,203 @@
+require File.dirname(__FILE__) + '/_helper'
+
+class SettingTest < Test::Unit::TestCase
+      
+  def setup
+    Setting.reset_all
+  end
+  
+  verify 'can query whether a setting exists with setting?, and can declare settings with add, or has_setting' do
+    assert !Setting.setting?(:a)
+    assert !Setting.setting?(:b)
+    Setting.add :a
+    Setting.has_setting :b
+    assert Setting.setting?(:a)
+    assert Setting.setting?(:b)
+  end
+  
+  verify 'has_setting is an alias for add' do
+    # the later versions can verify that it is correct, but comment it out so early versions don't fail
+    assert_equal Setting.method(:add) , Setting.method(:has_setting) unless RUBY_VERSION < '1.9.1'
+  end
+  
+  verify 'can add default when creating' do
+    Setting.add :a , :default => 123
+    assert_equal 123 , Setting.a
+  end
+  
+  verify 'can pass proc to handle postprocessing' do
+    Setting.add :a , :default => '123' do |setting|
+      setting.to_i
+    end
+    assert_equal 123 , Setting.a
+    Setting.a = '456'
+    assert_equal 456 , Setting.a
+  end
+  
+  verify 'adds record to the db' do
+    assert_count 0
+    Setting.add :a , :default => /abc/
+    assert_count 1
+    setting = Setting.find_by_sql("select * from settings").first
+    assert_equal 'a' , setting.name
+    assert_equal( /abc/ , setting.value )
+  end
+  
+  verify 'does not raise error if the setting already exists' do
+    assert_nothing_raised { Setting.add :a }
+    assert_nothing_raised { 
+      # begin
+      Setting.add :a 
+    # rescue Exception
+    #   puts $@
+    # end
+      }
+  end
+  
+  verify 'does not overwrite current value with default when added repeatedly' do
+    Setting.add :a , :default => 12
+    assert_equal 12 , Setting.a
+    Setting.add 'a' , :default => 13
+    assert_equal 12 , Setting.a
+    Setting.add 'b' , :default => 14
+    assert_equal 14 , Setting.b
+    Setting.add :b , :default => 15
+    assert_equal 14 , Setting.b
+  end
+  
+  
+  verify 'get a list of settings' do
+    Setting.add :abc
+    Setting.add :def
+    Setting.add :ghi
+    assert_equal [:abc,:def,:ghi] , Setting.settings.sort_by { |name| name.to_s }
+  end
+  
+  verify 'get a list of settings and values' do
+    Setting.add :abc , :default => 1
+    Setting.add :def , :default => 2
+    Setting.add :ghi , :default => 3
+    assert_equal [[:abc,1],[:def,2],[:ghi,3]] , Setting.settings_with_values.sort_by { |name,value| name.to_s }
+  end
+  
+  verify 'can specify that object should reload from db each time' do
+    Setting.add :abcd , :default => 1
+    Setting.add :efgh , :default => 10 , :volatile => true
+    assert_equal 1  , Setting.abcd
+    assert_equal 10 , Setting.efgh
+    $sql_executor.silent_execute "update settings set value='#{ARSettings.serialize(2)}' where name='abcd'"
+    $sql_executor.silent_execute "update settings set value='#{ARSettings.serialize(20)}' where name='efgh'"
+    assert_equal 1  , Setting.abcd
+    assert_equal 20 , Setting.efgh
+  end
+  
+  verify 'retains postprocessing after a reload' do
+    Setting.add( :abcd , :default => 1 , :volatile => true ) { |val| val.to_i }
+    assert_equal 1 , Setting.abcd
+    $sql_executor.silent_execute "update settings set value='#{ARSettings.serialize(2)}' where name='abcd'"
+    assert_equal 2  , Setting.abcd
+    Setting.abcd = "3"
+    assert_equal 3 , Setting.abcd
+  end
+  
+  verify 'readding the setting allows you to update volatility' do
+    Setting.add( :abcd , :default => "12.5" , :volatile => false ) { |val| val.to_f }
+    assert_equal 12.5 , Setting.abcd
+    $sql_executor.silent_execute "update settings set value='#{ARSettings.serialize(5.5)}' where name='abcd'"
+    assert_equal 12.5 , Setting.abcd
+    Setting.add :abcd , :volatile => true
+    assert_equal 5.5 , Setting.abcd
+  end
+  
+  verify 'postprocessing only occurs when inserting the data' do
+    Setting.add( :abcd , :default => "12.5" , :volatile => false ) { |val| val.to_f }
+    assert_equal 12.5 , Setting.abcd
+    Setting.add( :abcd ) { |val| val.to_i }    
+    assert_equal 12.5 , Setting.abcd
+  end
+  
+  verify 'readding the setting allows you to update postprocessing' do
+    Setting.add( :abcd , :default => 0 ) { |val| val.to_f }
+    Setting.abcd = "12.5"
+    assert_equal 12.5 , Setting.abcd
+    Setting.add( :abcd ) { |val| val.to_i }
+    Setting.abcd = "12.5"
+    assert_equal 12 , Setting.abcd
+  end
+  
+  verify 'defaults get run through the postprocessor' do
+    Setting.add( :abcd , :default => "5" ) { |i| i.to_i }
+    assert_equal 5 , Setting.abcd
+  end
+  
+  verify 'raises NoSuchSettingError when invoking nonexistent setting' do
+    assert_raises(ARSettings::NoSuchSettingError) { Setting.hjk     }
+    assert_raises(ARSettings::NoSuchSettingError) { Setting.hjk = 1 }
+  end
+  
+  verify 'raises InvalidSetting for settings with over MAX_NAME chars' do
+    assert_nothing_raised { Setting.add 'a' * Setting.MAX_CHARS      }
+    assert_invalid_name   { Setting.add 'a' * Setting.MAX_CHARS.next }
+  end
+  
+  verify 'raises Invalid name error if the setting is not a valid method name' do
+    [ '123' , '1abc' , '.abc' , 'Constant' , 'ab-c' , 'ab.c' , 'ab)c' , 'ab@c' , 'a:b' ].each do |invalid_name|
+      assert_invalid_name { Setting.add invalid_name }
+    end
+  end
+  
+  verify 'add returns the package' do
+    assert_equal Setting.package(Setting) , Setting.add( :a , :default => 100)
+    assert_equal Setting.package(String)  , Setting.package(String).add( :b , :default => 101)
+    assert_equal Setting.package(String)  , Setting.package(String).add( :b , :default => 102)
+  end
+  
+  
+  context 'new default handling' do
+    verify "if a default is passed, saves the default" do
+      seen = nil
+      Setting.add :hunted , :default => 5   do |val| seen = val end
+      assert_equal seen , 5
+      assert_equal 5, Setting.first.value
+      assert_equal 5, Setting.hunted
+    end
+    
+    verify "if no default is passed, waits for initial setting" do
+      seen = nil
+      Setting.add :down do |val| seen = val end
+      Setting.down = 6
+      assert_equal seen , 6
+      assert_equal 6, Setting.first.value      
+      assert_equal 6, Setting.down      
+    end
+    
+    verify "if no default is passed, raises an error if not initialized by first access" do
+      seen = nil
+      Setting.add :like do |val| seen = val end
+      assert_equal nil , seen
+      assert_raises(ARSettings::UninitializedSettingError) { Setting.like }
+    end
+  end
+  
+  verify 'it adds ? methods' do
+    Setting.add :ten , :default => 3
+    assert_equal TrueClass , Setting.ten?.class
+    assert_equal 3 , Setting.ten
+  end
+  
+  verify 'it raises error if accessing uninitialized boolean' do
+    Setting.add :cent
+    assert_raises(ARSettings::UninitializedSettingError) { Setting.cent? }
+  end
+  
+  verify 'resetting removes teh boolean getter' do
+    Setting.add :blues
+    Setting.blues = 5
+    assert_equal true , Setting.blues?
+    Setting.reset_all
+    assert_raises(ARSettings::NoSuchSettingError) { Setting.blues? }
+  end
+  
+end
+
+

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: arsettings
 version: !ruby/object:Gem::Version 
+  hash: 17
   prerelease: false
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Joshua Cheek
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-07 01:00:00 -05:00
+date: 2010-11-16 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,28 +26,46 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 5
         segments: 
         - 2
         - 3
-        - 8
-        version: 2.3.8
+        - 3
+        version: 2.3.3
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: sqlite-ruby
+  name: rake
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 25
         segments: 
         - 1
         - 3
         - 1
         version: 1.3.1
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 description: ActiveRecord has a lot of support for tables of similar values. But what about those one time only values, like site settings? This is what ARSettings is intended for. One line to add settings to your ActiveRecord classes. Two to non-ActiveRecord classes. And you can have settings that are not defined on any class as well.
 email: josh.cheek@gmail.com
 executables: []
@@ -58,11 +77,30 @@ extra_rdoc_files:
 files: 
 - Rakefile
 - Readme.mdown
-- lib/arsettings/activerecord.rb
+- examples/generic_settings.rb
+- examples/helper.rb
+- examples/namespaced.rb
+- examples/on_activerecord_class.rb
+- examples/on_any_class.rb
+- test/_helper.rb
+- test/_in_memory_db.rb
+- test/_make_gemsets.sh
+- test/_rcov.sh
+- test/_reek.sh
+- test/_run_all.sh
+- test/_run_one.rb
+- test/activerecord_integration_test.rb
+- test/arbitrary_class_test.rb
+- test/packaged_test.rb
+- test/reset_test.rb
+- test/setting_choose_name_test.rb
+- test/setting_initialize_test.rb
+- test/setting_test.rb
 - lib/arsettings/arsettings.rb
+- lib/arsettings/has_settings.rb
 - lib/arsettings/packaged.rb
-- lib/arsettings/settings_class_methods.rb
-- lib/arsettings/settings_instance_methods.rb
+- lib/arsettings/settings_class/class_methods.rb
+- lib/arsettings/settings_class/instance_methods.rb
 - lib/arsettings.rb
 has_rdoc: true
 homepage: https://github.com/JoshCheek/ARSettings
@@ -79,6 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -87,6 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"

data/lib/arsettings/activerecord.rb

@@ -1,23 +0,0 @@
-class ActiveRecord::Base
-  
-  def self.has_setting( name , options=Hash.new , &block)
-    raise NoDefaultPackageError.new("No default settings class is set (make sure you have already invoked create_settings_class)") unless ARSettings.default_class
-    ARSettings.validate_options options , :default , :volatile , :instance
-    package         =  ARSettings.default_class.package(self)
-    getter          =  name
-    setter          =  "#{name}="
-    boolean_getter  =  "#{name}?"
-    (class << self ; self ; end).instance_eval do
-      define_method getter          do       package.send getter          end
-      define_method boolean_getter  do       package.send boolean_getter  end
-      define_method setter          do |arg| package.send setter , arg    end
-    end
-    if options.delete :instance
-      define_method getter          do       package.send getter          end
-      define_method boolean_getter  do       package.send boolean_getter  end
-      define_method setter          do |arg| package.send setter , arg    end
-    end
-    package.add name , options , &block
-  end
-  
-end

data/lib/arsettings/settings_class_methods.rb

@@ -1,53 +0,0 @@
-module ARSettings
-  module SettingsClass_ClassMethods
-    
-    def reset_all # :nodoc:
-      Packaged.instances(self).each { |name,package| package.reset }
-    end
-    
-    # get a Package (aka namespace or scope or group)
-    # to package settings together with
-    # 
-    # email_settings = Settings.package :email
-    #
-    # email_settings.add :enabled , :default => false
-    # 
-    # ProfileSettings = Settings.package :profile_settings
-    #
-    # ProfileSettings.add :enabled , :default => true
-    def package(name)
-      Packaged.instance self , name
-    end
-    
-    # add a setting to the settings class, it will be packaged under the settings class itself
-    #
-    #--
-    # FIXME: Document the options and proc
-    def add( name , options={} , &proc )
-      options = name if name.is_a? Hash
-      if options[:package]
-        package options.delete(:package)
-      else
-        package self
-      end.add( name , options , &proc )
-    end
-     
-  private
-  
-    def method_missing(name,*args) # :nodoc:
-      if name =~ /\A[A-Z]/
-        const_get name , *args
-      elsif name.to_s !~ /=$/ || ( name.to_s =~ /=$/ && args.size == 1 )
-        package(self).send name , *args
-      else
-        super
-      end
-    end
-  
-    def load_from_db # :nodoc:
-      reset_all
-      all.each { |instance| add :record => instance , :package => instance.package }
-    end
-
-  end
-end

data/lib/arsettings/settings_instance_methods.rb

@@ -1,45 +0,0 @@
-module ARSettings
-    
-  module SettingsClass_InstanceMethods # :nodoc: all
-
-    # unfortunately, can't serialize a proc. I tried both yaml and marshal
-    # so will have to keep it in memory and just be sure to set it each time app loads
-    attr_accessor :postprocessing
-
-    
-    def value=(new_value)
-      @deserialized_value = new_value
-      @value_is_deserialized = true
-      super ARSettings.serialize(new_value)
-      save
-    end
-    
-    def value
-      if @value_is_deserialized && !volatile?
-        @deserialized_value
-      else
-        raise UninitializedSettingError.new("#{package}##{name} has not been initialized.") unless super
-        reload
-        @value_is_deserialized = true
-        @deserialized_value = ARSettings.deserialize(super)
-        @deserialized_value
-      end
-    end
-        
-    def volatile=(value)
-      super
-      save
-    end
-        
-    def package
-      @package ||= super.to_sym
-    end
-    
-    def package=(pkg)
-      super pkg.to_s
-    end
-    
-  end
-  
-end
-