arsettings 1.0.1 → 1.1.1

data/Rakefile

@@ -7,12 +7,36 @@ require "rake/rdoctask"
 task :default => :test
 
 
-desc 'run the unit tests'
-task :test do
-  query = File.dirname(__FILE__) << '/test/*_test.rb'
-  Dir[query].each { |filename| require filename }
+namespace :test do
+  desc 'create the gemsets'
+  task :make_gemsets do
+    sh File.dirname(__FILE__) << "/test/_make_gemsets.sh"
+  end
+  
+  desc 'run the tests on current ruby/gemspec'
+  task :crnt do
+    require File.dirname(__FILE__) << "/test/_run_one"
+  end
+  
+  desc 'check that all code is covered'
+  task :rcov do
+    sh File.dirname(__FILE__) << "/test/_rcov.sh"
+  end
+  
+  desc 'run the tests on the supported rubies and gemsets'
+  task :all do
+    sh File.dirname(__FILE__) << "/test/_run_all.sh"
+  end
+  
+  desc 'checks for code smells -- assumes you have reek installed'
+  task :reek do
+    sh File.dirname(__FILE__) << "/test/_reek.sh"
+  end
 end
 
+desc 'synonym for test:crnt'
+task :test => 'test:crnt'
+
 
 desc 'irb session with env loaded'
 task :console do
@@ -32,7 +56,7 @@ spec = Gem::Specification.new do |s|
 
   # Change these as appropriate
   s.name              = "arsettings"
-  s.version           = "1.0.1"
+  s.version           = "1.1.1"
   s.author            = "Joshua Cheek"
   s.email             = "josh.cheek@gmail.com"
   s.homepage          = "https://github.com/JoshCheek/ARSettings"
@@ -44,15 +68,16 @@ 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("{test,lib/**/*}")
+  s.files             = %w(Rakefile Readme.mdown) + Dir.glob("{examples/**/*,test/**/*,lib/**/*}")
   s.require_paths     = ["lib"]
 
   # If you want to depend on other gems, add them here, along with any
   # relevant versions
-  s.add_dependency("activerecord", ">= 2.3.8")
+  s.add_dependency("activerecord", ">= 2.3.3")
 
   # If your tests use any gems, include them here
-  s.add_development_dependency("sqlite-ruby", ">= 1.3.1")
+  s.add_development_dependency("rake",         "~> 0.8.7")
+  s.add_development_dependency("sqlite3-ruby", "~> 1.3.1")
 end
 
 # This task actually builds the gem. We also regenerate a static

data/Readme.mdown

@@ -3,18 +3,31 @@ 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.
 
+Tested on Ruby versions 1.8.6, 1.8.7, 1.9.2
+Tested against ActiveRecord versions 2.3.3, 2.3.5, 2.3.8 and 3.0.1
+If you would like me to test against a specific version not on here, let me know.
+
 Usage
 =====
 
-Create a table to store your settings ([see example](https://github.com/JoshCheek/ARSettings/blob/master/example/helper.rb)), and then declare your settings as you like ([see examples](https://github.com/JoshCheek/ARSettings/blob/master/example/example.rb)).
+First you need to create a table to store your settings, this will probably go in a migration, though the only requirement is that the schema is correct ([see example](https://github.com/JoshCheek/ARSettings/blob/master/examples/helper.rb))
 
-Dependencies
+* Use the settings class to store settings ([see example](https://github.com/JoshCheek/ARSettings/blob/master/examples/generic_settings.rb))
+* Package settings together under a single namespace ([see example](https://github.com/JoshCheek/ARSettings/blob/master/examples/namespaced.rb))
+* Add settings directly to your ActiveRecord class and its instances ([see example](https://github.com/JoshCheek/ARSettings/blob/master/examples/on_activerecord_class.rb))
+* Add settings to any class you like ([see example](https://github.com/JoshCheek/ARSettings/blob/master/examples/on_any_class.rb))
+
+
+Installation
 ============
 
-* Ruby 1.9
-* [ActiveRecord](http://rubygems.org/gems/activerecord) Tested on versions 2.3.8 and 3.0.1
-* [sqlite-ruby](http://rubygems.org/gems/sqlite-ruby) Tested on version 1.3.1
+    gem install arsettings
+
+
+Dependencies
+============
 
+* [ActiveRecord](http://rubygems.org/gems/activerecord)
 
 Bugs / Contribution
 ===================
@@ -23,7 +36,7 @@ If you discover any errors / bugs, please inform me, and I will fix them and pus
 
 If you wish to fix it yourself, fork it, fix it, and send me a pull request.
 
-If you think it would fit your use better if it did ______ or if the interface would be a lot nicer given _______ then let me know so I can consider that and make the gem better.
+If you think it would fit your use better if it did this or if the interface would be a lot nicer given that then let me know so I can consider that and make the gem better.
 
 License
 =======

data/examples/generic_settings.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/helper'
+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'
+
+# add and change a setting
+Settings.has_setting :domain , :default => 'localhost:3000'
+Settings.domain                       # => "localhost:3000"
+Settings.domain = 'localhost:9292'
+Settings.domain                       # => "localhost:9292"
+
+
+# what if the value is never initialized? (ie first use with no default)
+Settings.has_setting :port
+begin 
+  Settings.port
+rescue ARSettings::UninitializedSettingError
+  $! # => #<ARSettings::UninitializedSettingError: Settings#port has not been initialized.>
+end
+Settings.port = 3000
+Settings.port         # => 3000

data/examples/helper.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'sqlite3'
+require 'active_record'
+
+# hook up an in memory sqlite3 db
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3' , :database => ":memory:" 
+
+
+# silently create the db
+require 'stringio'
+$stdout = StringIO.new
+
+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
+  
+  create_table :users do |t|
+    t.string :name
+  end
+end
+
+$stdout = STDOUT

data/examples/namespaced.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/helper'
+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'
+
+
+# you can package settings together under a namespace
+EmailSettings = Settings.package :email
+
+# you can add settings with has_setting for consistency across uses
+# or you can use add for brevity
+Settings.add :enabled
+EmailSettings.has_setting :enabled
+
+# initialize, and show that boolean methods translate object/nil to true/false
+EmailSettings.enabled = 'yes'
+EmailSettings.enabled? # => true
+
+EmailSettings.enabled = nil
+EmailSettings.enabled? # => false
+
+# can access the package still via the ::package method
+Settings.package(:email) == EmailSettings   # => true
+Settings.package(:email).enabled?           # => false
+
+
+# Settings and EmailSettings are under different packages (namespaces)
+# so they do not conflict with eachother's values
+Settings.enabled = true
+Settings.enabled?      # => true
+EmailSettings.enabled? # => false

data/examples/on_activerecord_class.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/helper'
+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'
+
+class User < ActiveRecord::Base
+  has_setting(:site_admin) { |user| user.name }
+  has_setting :delete_account_after , :instance => true , :default => 365   # days
+end
+
+User.create! :name => 'the admin'
+User.site_admin = User.first    
+
+# block converted the user to its name
+User.site_admin                 # => "the admin"
+
+# can access the setting on the instance, because we passed :instance => true
+User.new.delete_account_after   # => 365

data/examples/on_any_class.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/helper'
+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'
+
+
+class Water
+  ARSettings.on self
+  has_setting :hydrogen , :default => 1
+  has_setting :oxygen   , :default => 2
+  has_setting :state    , :default => :liquid , :instance => true
+end
+
+Water.hydrogen  # => 1
+Water.oxygen    # => 2
+Water.new.state # => :liquid

data/lib/arsettings/arsettings.rb

@@ -9,13 +9,13 @@ module ARSettings
   UninitializedSettingError = Class.new(Exception)
   
   # create the settings class
-  def self.create_settings_class( classname , options=Hash.new )
+  def self.create( classname , options=Hash.new )
     raise AlreadyDefinedError.new("you are trying to define the settings class #{classname}, but it already exists") if Object.constants.map { |c| c.to_s }.include?(classname.to_s)
     validate_options options , :volatile , :max_chars
     Object.const_set classname , Class.new(ActiveRecord::Base)
     klass = Object.const_get(classname).class_eval do
-      extend  SettingsClass_ClassMethods
-      include SettingsClass_InstanceMethods
+      extend  SettingsClass::ClassMethods
+      include SettingsClass::InstanceMethods
       const_set :MAX_CHARS           , options.fetch( :max_chars , 30    )
       const_set :VOLATILIE_DEFAULT   , options.fetch( :volatile  , false )
       send :load_from_db
@@ -25,7 +25,14 @@ module ARSettings
     klass
   end
   
+  
+  
   class << self
+    # initially called create_settings_class, this is for backwards compatibility
+    alias :create_settings_class :create
+    
+    # the class that will be used when you inherit from AR::B,
+    # or if you don't specify in ::on
     attr_accessor :default_class
   end
   
@@ -34,24 +41,8 @@ module ARSettings
     settings_class = options.fetch :settings_class , default_class
     raise NoDefaultPackageError.new("You did not specify a settings class, and no default is set (make sure you have already invoked create_settings_class)") unless settings_class
     validate_options options , :settings_class
-    (class << object ; self ; end).send :define_method , :has_setting do |name,inner_options={},&block|  # :nodoc:
-      instance = inner_options.delete :instance
-      package = settings_class.package(object)
-      package.add name , inner_options , &block
-      getter = name
-      setter = "#{name}="
-      boolean_getter = "#{name}?"
-      (class << self ; self ; end).instance_eval do
-        define_method getter          do       package.send getter          end
-        define_method setter          do |arg| package.send setter , arg    end
-        define_method boolean_getter  do       package.send boolean_getter  end
-      end
-      if 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
-    end
+    object.instance_variable_set( '@arsettings_package' , settings_class.package(object) )
+    (class << object ; self ; end).send :include , HasSettings
   end
   
   def self.serialize(data) # :nodoc:
@@ -65,10 +56,10 @@ module ARSettings
   def self.validate_options(options,*valid_options) # :nodoc:
     options.each do |option,value|
       unless valid_options.include? option
-        raise ARSettings::InvalidOptionError.new "#{option.inspect} is not a valid option, because it is not in #{valid_options.inspect}"
+        raise ARSettings::InvalidOptionError.new("#{option.inspect} is not a valid option, because it is not in #{valid_options.inspect}")
       end
     end
   end
-  
+    
 end
 

data/lib/arsettings/has_settings.rb

@@ -0,0 +1,19 @@
+module ARSettings
+  module HasSettings
+    
+    def has_setting( name , inner_options={} , &block )
+      @arsettings_package ||= ARSettings.default_class.package(self)
+      instance = inner_options.delete :instance
+      package = @arsettings_package
+      package.add name , inner_options , &block
+      definitions = lambda do |*args|
+        define_method name        do       package.send name              end # getter
+        define_method "#{name}="  do |arg| package.send "#{name}=" , arg  end # setter
+        define_method "#{name}?"  do       package.send "#{name}?"        end # boolean-getter
+      end
+      (class << self ; self ; end).instance_eval(&definitions)
+      definitions.call if instance
+    end
+    
+  end
+end

data/lib/arsettings/packaged.rb

@@ -17,7 +17,7 @@ module ARSettings
     end
     
     def self.has_instance?(settings_class,package) # :nodoc:
-      @instances && @instances[settings_class] && @instances[settings_class][normalize package]
+      @instances && @instances[settings_class] && @instances[settings_class][normalize(package)]
     end
     
     def self.validate(settings_class,package) # :nodoc:
@@ -32,7 +32,7 @@ module ARSettings
     
     def self.validate_settings_class(settings_class) # :nodoc:
       raise InvalidSettingsClassError.new("#{settings_class.inspect} should be a class created by the create_settings_class method") unless 
-          Class === settings_class && settings_class.superclass == ActiveRecord::Base && SettingsClass_ClassMethods === settings_class
+          Class === settings_class && settings_class.superclass == ActiveRecord::Base && SettingsClass::ClassMethods === settings_class
     end
    
    
@@ -70,6 +70,8 @@ module ARSettings
       end
       self
     end
+    
+    alias :has_setting :add
 
     def setting?(name)
       @settings.has_key? name

data/lib/arsettings/settings_class/class_methods.rb

@@ -0,0 +1,57 @@
+module ARSettings
+module SettingsClass
+module 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
+  
+  alias :has_setting :add
+ 
+  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
+end

data/lib/arsettings/settings_class/instance_methods.rb

@@ -0,0 +1,46 @@
+module ARSettings
+module SettingsClass
+module 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
+    @value_is_deserialized ||= false # just to clear a stupid warning
+    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  
+end
+

data/lib/arsettings.rb

@@ -2,12 +2,28 @@ require 'yaml'
 
 manifest = %w(
   arsettings
-  settings_class_methods
-  settings_instance_methods
+  settings_class/class_methods
+  settings_class/instance_methods
   packaged
-  activerecord
+  has_settings
 )
 
 manifest.each do |filename|
   require File.dirname(__FILE__) << "/arsettings/#{filename}"
+end
+
+
+
+# placing this here because otherwise it violates packaging standard
+class ActiveRecord::Base
+  
+  def self.inherited_with_settings(subclass)
+    inherited_without_settings subclass
+    subclass.extend ARSettings::HasSettings
+  end
+  
+  class << self
+    alias_method_chain :inherited, :settings
+  end
+  
 end

data/test/_helper.rb

@@ -0,0 +1,56 @@
+# require libs and gems
+require 'test/unit'
+require File.dirname(__FILE__) << "/_in_memory_db"
+
+ARSettings.create_settings_class 'Setting'
+
+# monkey patch Test::Unit::TestCase to make it easier to work with
+class Test::Unit::TestCase
+  
+  # some dummy classes for use with test data
+  Example1 = Struct.new :a , :b
+
+  Example2 = Class.new do 
+    attr_accessor :a , :b
+    def initialize(a,b)
+      @a,@b = a,b
+    end
+    def ==(ex2)
+      @a == ex2.a && 
+      @b == ex2.b
+    end
+  end
+  
+  def object_menagerie
+    [ 'a' , :a , 1 , /a/ , [1,2] , true , false , nil , {:a => 1,:b => 2} , Example1.new(1,2) , Example2.new(1,2) ]
+  end
+  
+  def self.to_method_name(str)
+    str.gsub(/\s+/,'_').gsub(/\W+/,'')
+  end
+  
+  def self.context(context)
+    @context = to_method_name(context)
+    yield
+    @context = nil
+  end
+  
+  def self.verify( to_verify , &verification )
+    prefix = "test_"
+    prefix << @context << '_' if @context && !@context.empty?
+    define_method prefix << to_method_name(to_verify) , &verification if verification
+  end
+
+  def assert_invalid(&block)
+    assert_raises ActiveRecord::RecordInvalid , &block
+  end
+  
+  def assert_invalid_name(&block)
+    assert_raises ARSettings::InvalidNameError , &block
+  end
+  
+  def assert_count(count)
+    assert_equal count , Setting.count
+  end
+    
+end

data/test/_in_memory_db.rb

@@ -0,0 +1,73 @@
+require 'rubygems'
+require 'sqlite3'
+require 'active_record'
+
+
+
+# require the setting lib that we will be testing
+require File.dirname(__FILE__) + '/../lib/arsettings'
+
+
+
+# hook it up to an in memory sqlite3 db
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3' , :database => ":memory:" 
+
+
+
+# silently create the db
+require 'stringio'
+old_stdout = $stdout
+$stdout = StringIO.new
+
+define_as_settings_class = lambda do |t|
+  t.string  :name     , :null => false , :size => 30
+  t.text    :value
+  t.text    :package
+  t.boolean :volatile , :default => false
+  t.timestamps
+end
+
+ActiveRecord::Schema.define do
+  
+  [ 
+    :different_names                  , 
+    :predefined_values                ,
+    :settings                         ,
+    :setting2s                        ,
+    :setting3s                        ,
+    :setting4s                        ,
+    :setting5s                        ,
+    :setting6s                        ,
+    :setting7s                        ,
+    :setting8s                        ,
+    :setting9s                        ,
+    :setting10s                       ,
+    :setting11s                       ,
+    :setting12s                       ,
+    :setting13s                       ,
+    :setting14s                       ,
+    :setting15s                       ,
+    :setting16s                       ,
+    :setting17s                       ,
+    :setting18s                       ,
+    :setting19s                       ,
+    :setting20s                       ,
+    :setting21s                       ,
+    :setting22s                       ,
+    :setting23s                       ,
+    :setting24s                       ,
+    :setting25s                       ,
+    :volatile_tests                   ,
+    :this_should_be_returneds         ,
+  ].flatten.each do |tablename|
+    create_table tablename , &define_as_settings_class
+  end
+  
+  # capture this object so that I can write sql later (prob a better way, but IDK what it is)
+  $sql_executor = self
+  def $sql_executor.silent_execute(sql)
+    suppress_messages { execute(sql) }
+  end
+
+end
+$stdout = old_stdout

data/test/_make_gemsets.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash -l
+
+IFS="-"
+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-2.3.8 1.9.1-2.3.3 1.9.1-2.3.5 1.9.1-2.3.8 1.9.2-2.3.3 1.9.2-2.3.5 1.9.2-2.3.8 1.9.2-3.0.1 ; do
+  arr=( $rvm_set )
+  ruby_version=${arr[0]}
+  ar_version=${arr[1]}
+  rvm use "$ruby_version@ruby$ruby_version-activerecord$ar_version" --create
+  gem install activerecord -v "$ar_version" --no-ri --no-rdoc
+  gem install sqlite3-ruby -v 1.3.1 --no-ri --no-rdoc
+done

data/test/_rcov.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash -l
+
+# WARNING: MAKES ASSUMPTIONS BASED ON BEING INVOKED BY THE RAKEFILE
+
+# if this breaks, its probably because you need to install rcov on 1.8.7@ruby1.8.7-activerecord2.3.5
+rvm use 1.8.7@ruby1.8.7-activerecord2.3.5
+
+rcov -x gems test/*_test.rb
+
+open coverage/index.html

data/test/_reek.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash -l
+
+# WARNING: MAKES ASSUMPTIONS BASED ON BEING INVOKED BY THE RAKEFILE
+
+# if this breaks, its probably because you need to install reek on 1.8.7@ruby1.8.7-activerecord2.3.5
+rvm use 1.8.7@ruby1.8.7-activerecord2.3.5
+
+reek lib

data/test/_run_all.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash -l
+
+
+IFS="-"
+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-2.3.8 1.9.1-2.3.3 1.9.1-2.3.5 1.9.1-2.3.8 1.9.2-2.3.3 1.9.2-2.3.5 1.9.2-2.3.8 1.9.2-3.0.1 ; do
+  arr=( $rvm_set )
+  ruby_version=${arr[0]}
+  ar_version=${arr[1]}
+  rvm use "$ruby_version@ruby$ruby_version-activerecord$ar_version"
+  ./test/_run_one.rb
+done