arsettings 1.1.1 → 1.1.2

data/Rakefile

@@ -10,27 +10,27 @@ task :default => :test
 namespace :test do
   desc 'create the gemsets'
   task :make_gemsets do
-    sh File.dirname(__FILE__) << "/test/_make_gemsets.sh"
+    sh File.dirname(__FILE__) << "/script/_make_gemsets.sh"
   end
   
   desc 'run the tests on current ruby/gemspec'
   task :crnt do
-    require File.dirname(__FILE__) << "/test/_run_one"
+    require File.dirname(__FILE__) << "/script/_run_one"
   end
   
   desc 'check that all code is covered'
   task :rcov do
-    sh File.dirname(__FILE__) << "/test/_rcov.sh"
+    sh File.dirname(__FILE__) << "/script/_rcov.sh"
   end
   
   desc 'run the tests on the supported rubies and gemsets'
   task :all do
-    sh File.dirname(__FILE__) << "/test/_run_all.sh"
+    sh File.dirname(__FILE__) << "/script/_run_all.sh"
   end
   
   desc 'checks for code smells -- assumes you have reek installed'
   task :reek do
-    sh File.dirname(__FILE__) << "/test/_reek.sh"
+    sh File.dirname(__FILE__) << "/script/_reek.sh"
   end
 end
 
@@ -56,7 +56,7 @@ spec = Gem::Specification.new do |s|
 
   # Change these as appropriate
   s.name              = "arsettings"
-  s.version           = "1.1.1"
+  s.version           = "1.1.2"
   s.author            = "Joshua Cheek"
   s.email             = "josh.cheek@gmail.com"
   s.homepage          = "https://github.com/JoshCheek/ARSettings"
@@ -68,7 +68,7 @@ spec = Gem::Specification.new do |s|
   s.rdoc_options      = %w(--main Readme.mdown)
 
   # Add any extra files to include in the gem
-  s.files             = %w(Rakefile Readme.mdown) + Dir.glob("{examples/**/*,test/**/*,lib/**/*}")
+  s.files             = %w(Rakefile Readme.mdown) + Dir.glob("{examples/**/*,test/**/*,lib/**/*,script/**/*}")
   s.require_paths     = ["lib"]
 
   # If you want to depend on other gems, add them here, along with any

data/examples/generic_settings.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/../lib/arsettings'
 
 # tell it to create us a settings class named Settings
 # this means you must have a table in your db named 'settings'
-ARSettings.create_settings_class 'Settings'
+ARSettings.create 'Settings'
 
 # add and change a setting
 Settings.has_setting :domain , :default => 'localhost:3000'
@@ -21,3 +21,13 @@ rescue ARSettings::UninitializedSettingError
 end
 Settings.port = 3000
 Settings.port         # => 3000
+
+
+# for performance, can specify volatility to be false
+# if the setting is volatile, it could be changed by something
+# other than this code (ie you in the console, or another instance of your app)
+# so **ARSettings reloads the setting from the db each time you ask for it.**
+# if volatile is false, it only touches the db when initially loading the setting
+# or when saving the setting after updating it
+Settings.has_setting :site_name , :volatile => false
+

data/examples/helper.rb

@@ -6,22 +6,19 @@ require 'active_record'
 ActiveRecord::Base.establish_connection :adapter => 'sqlite3' , :database => ":memory:" 
 
 
-# silently create the db
-require 'stringio'
-$stdout = StringIO.new
-
+# create the db
 ActiveRecord::Schema.define do
-  create_table :settings do |t|
-    t.string  :name     , :null => false , :size => 30
-    t.text    :value
-    t.text    :package
-    t.boolean :volatile , :default => false
-    t.timestamps
-  end
+  suppress_messages do
+    create_table :settings do |t|
+      t.string  :name     , :null => false , :size => 30
+      t.text    :value
+      t.text    :package
+      t.boolean :volatile , :default => false
+      t.timestamps
+    end
   
-  create_table :users do |t|
-    t.string :name
+    create_table :users do |t|
+      t.string :name
+    end
   end
 end
-
-$stdout = STDOUT

data/examples/namespaced.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/../lib/arsettings'
 
 # tell it to create us a settings class named Settings
 # this means you must have a table in your db named 'settings'
-ARSettings.create_settings_class 'Settings'
+ARSettings.create 'Settings'
 
 
 # you can package settings together under a namespace

data/examples/on_activerecord_class.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/../lib/arsettings'
 
 # tell it to create us a settings class named Settings
 # this means you must have a table in your db named 'settings'
-ARSettings.create_settings_class 'Settings'
+ARSettings.create 'Settings'
 
 class User < ActiveRecord::Base
   has_setting(:site_admin) { |user| user.name }

data/examples/on_any_class.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/../lib/arsettings'
 
 # tell it to create us a settings class named Settings
 # this means you must have a table in your db named 'settings'
-ARSettings.create_settings_class 'Settings'
+ARSettings.create 'Settings'
 
 
 class Water

data/lib/arsettings/arsettings.rb

@@ -16,8 +16,8 @@ module ARSettings
     klass = Object.const_get(classname).class_eval do
       extend  SettingsClass::ClassMethods
       include SettingsClass::InstanceMethods
-      const_set :MAX_CHARS           , options.fetch( :max_chars , 30    )
-      const_set :VOLATILIE_DEFAULT   , options.fetch( :volatile  , false )
+      const_set :MAX_CHARS           , options.fetch( :max_chars , 30   )
+      const_set :VOLATILIE_DEFAULT   , options.fetch( :volatile  , true )
       send :load_from_db
       self
     end

data/lib/arsettings/packaged.rb

@@ -114,7 +114,7 @@ module ARSettings
     end
   
     def remove_method(name) # :nodoc:
-      metaclass.send :remove_method , "#{setting}="
+      metaclass.send :remove_method , name
     end
 
     def add_setter(name) # :nodoc:
@@ -132,22 +132,23 @@ module ARSettings
     end
 
     def remove_setter(name) # :nodoc:
-      metaclass.send :remove_method , "#{name}="
+      remove_method "#{name}="
     end
   
     def remove_getter(name) # :nodoc:
-      metaclass.send :remove_method , name
+      remove_method name
     end
   
     def remove_boolean_getter(name) # :nodoc:
-      metaclass.send :remove_method , "#{name}?"
+      remove_method "#{name}?"
     end
   
     def method_missing(name,*args) # :nodoc:
-      if name.to_s =~ /\A[A-Z]/
+      name_to_s = name.to_s
+      if name_to_s =~ /\A[A-Z]/
         settings_class.const_get name , *args
-      elsif name.to_s !~ /=$/ || ( name.to_s =~ /=$/ && args.size == 1 )
-        raise ARSettings::NoSuchSettingError.new("There is no setting named #{name.to_s.chomp '='}")
+      elsif name_to_s !~ /=$/ || ( name_to_s =~ /=$/ && args.size == 1 )
+        raise ARSettings::NoSuchSettingError.new("There is no setting named #{name_to_s.chomp '='}")
       else
         super
       end

data/{test → script}/_run_all.sh

@@ -7,5 +7,5 @@ for rvm_set in 1.8.6-2.3.3 1.8.6-2.3.5 1.8.6-2.3.8 1.8.7-2.3.3 1.8.7-2.3.5 1.8.7
   ruby_version=${arr[0]}
   ar_version=${arr[1]}
   rvm use "$ruby_version@ruby$ruby_version-activerecord$ar_version"
-  ./test/_run_one.rb
+  ./script/_run_one.rb
 done

data/script/_run_one.rb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+query = File.dirname(__FILE__) << '/../test/*_test.rb'
+Dir[query].each { |filename| require filename }

data/test/_in_memory_db.rb

@@ -58,6 +58,8 @@ ActiveRecord::Schema.define do
     :setting24s                       ,
     :setting25s                       ,
     :volatile_tests                   ,
+    :volatile_test2s                  ,
+    :default_volatiles                ,
     :this_should_be_returneds         ,
   ].flatten.each do |tablename|
     create_table tablename , &define_as_settings_class

data/test/activerecord_integration_test.rb

@@ -67,7 +67,7 @@ class ActiveRecordIntegration < Test::Unit::TestCase
     $sql_executor.silent_execute "update settings set value='#{ARSettings.serialize(200.0)}' where name='ijkl'"
     assert_equal 200                  ,  @klass.abcd
     assert_equal 14.0                 ,  @klass.efgh
-    assert_equal '14'                 ,  @klass.ijkl
+    assert_equal 200.0                ,  @klass.ijkl
   end
 
   verify 'two classes dont see eachothers settings' do

data/test/arbitrary_class_test.rb

@@ -88,7 +88,7 @@ class AddToArbitraryClass < Test::Unit::TestCase
     $sql_executor.silent_execute "update setting15s set value='#{ARSettings.serialize(200.0)}' where name='ijkl'"
     assert_equal 200                  ,  C6.abcd
     assert_equal 14.0                 ,  C6.efgh
-    assert_equal '14'                 ,  C6.ijkl
+    assert_equal 200.0                ,  C6.ijkl
   end
   
   verify 'two classes dont see eachothers settings' do

data/test/packaged_test.rb

@@ -138,7 +138,7 @@ class TestPackaging < Test::Unit::TestCase
     end
       
     verify 'can specify that object should reload from db each time' do
-      s.add :abcd , :default => 1
+      s.add :abcd , :default => 1  , :volatile => false
       s.add :efgh , :default => 10 , :volatile => true
       assert_equal 1  , s.abcd
       assert_equal 10 , s.efgh

data/test/setting_initialize_test.rb

@@ -26,6 +26,14 @@ class InitializingSettingsClasses < Test::Unit::TestCase
     PredefinedValues.add :predefined_value , :default => 20
     assert_equal 12 , PredefinedValues.predefined_value
   end
+  
+  verify 'volatile is false by default' do
+    ARSettings.create_settings_class :DefaultVolatile
+    DefaultVolatile.add :efgh , :default => 10
+    assert_equal 10 , DefaultVolatile.efgh
+    $sql_executor.silent_execute "update default_volatiles set value='#{ARSettings.serialize(20)}' where name='efgh'"
+    assert_equal 20 , DefaultVolatile.efgh
+  end
    
   verify 'can specify a volatility default' do
     ARSettings.create_settings_class :VolatileTest    , :volatile => true
@@ -41,6 +49,20 @@ class InitializingSettingsClasses < Test::Unit::TestCase
     assert_equal 1   , VolatileTest.abcd
     assert_equal 20  , VolatileTest.efgh
     assert_equal 200 , VolatileTest.ijkl
+    
+    ARSettings.create_settings_class :VolatileTest2    , :volatile => false
+    VolatileTest2.add :abcd , :default => 1    , :volatile => false
+    VolatileTest2.add :efgh , :default => 10   , :volatile => true
+    VolatileTest2.add :ijkl , :default => 100
+    assert_equal 1   , VolatileTest2.abcd
+    assert_equal 10  , VolatileTest2.efgh
+    assert_equal 100 , VolatileTest2.ijkl
+    $sql_executor.silent_execute "update volatile_test2s set value='#{ARSettings.serialize(2)}' where name='abcd'"
+    $sql_executor.silent_execute "update volatile_test2s set value='#{ARSettings.serialize(20)}' where name='efgh'"
+    $sql_executor.silent_execute "update volatile_test2s set value='#{ARSettings.serialize(200)}' where name='ijkl'"
+    assert_equal 1   , VolatileTest2.abcd
+    assert_equal 20  , VolatileTest2.efgh
+    assert_equal 100 , VolatileTest2.ijkl
   end
   
   verify 'create_settings_class should return the class' do

data/test/setting_test.rb

@@ -80,15 +80,19 @@ class SettingTest < Test::Unit::TestCase
     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
+  verify 'can specify that object should or shouldnt reload from db each time, with default being to do so' do
+    Setting.add :abcd , :default => 1   , :volatile => false
+    Setting.add :efgh , :default => 10  , :volatile => true
+    Setting.add :ijkl , :default => 100
     assert_equal 1  , Setting.abcd
     assert_equal 10 , Setting.efgh
+    assert_equal 100 , Setting.ijkl
     $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
+    $sql_executor.silent_execute "update settings set value='#{ARSettings.serialize(200)}' where name='ijkl'"
+    assert_equal 1   , Setting.abcd
+    assert_equal 20  , Setting.efgh
+    assert_equal 200 , Setting.ijkl
   end
   
   verify 'retains postprocessing after a reload' do

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: arsettings
 version: !ruby/object:Gem::Version 
-  hash: 17
   prerelease: false
   segments: 
   - 1
   - 1
-  - 1
-  version: 1.1.1
+  - 2
+  version: 1.1.2
 platform: ruby
 authors: 
 - Joshua Cheek
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-16 00:00:00 -06:00
+date: 2010-12-03 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 5
         segments: 
         - 2
         - 3
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 49
         segments: 
         - 0
         - 8
@@ -58,7 +55,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 25
         segments: 
         - 1
         - 3
@@ -84,11 +80,6 @@ files:
 - 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
@@ -102,6 +93,11 @@ files:
 - lib/arsettings/settings_class/class_methods.rb
 - lib/arsettings/settings_class/instance_methods.rb
 - lib/arsettings.rb
+- script/_make_gemsets.sh
+- script/_rcov.sh
+- script/_reek.sh
+- script/_run_all.sh
+- script/_run_one.rb
 has_rdoc: true
 homepage: https://github.com/JoshCheek/ARSettings
 licenses: []
@@ -117,7 +113,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -126,7 +121,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"

data/test/_run_one.rb

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-query = File.dirname(__FILE__) << '/*_test.rb'
-Dir[query].each { |filename| require filename }