arsettings 1.0.0 → 1.0.1

data/Rakefile

@@ -1,11 +1,19 @@
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+# require "rake/testtask"
+
+
 task :default => :test
 
+
 desc 'run the unit tests'
 task :test do
   query = File.dirname(__FILE__) << '/test/*_test.rb'
   Dir[query].each { |filename| require filename }
 end
 
+
 desc 'irb session with env loaded'
 task :console do
   dir = File.dirname(__FILE__)
@@ -14,18 +22,6 @@ task :console do
   system "irb -f #{requirements}"
 end
 
-require "rubygems"
-require "rake/gempackagetask"
-require "rake/rdoctask"
-
-require "rake/testtask"
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList["test/**/*_test.rb"]
-  t.verbose = true
-end
-
-
 
 # This builds the actual gem. For details of what all these options
 # mean, and other ones you can add, check the documentation here:
@@ -36,7 +32,7 @@ spec = Gem::Specification.new do |s|
 
   # Change these as appropriate
   s.name              = "arsettings"
-  s.version           = "1.0.0"
+  s.version           = "1.0.1"
   s.author            = "Joshua Cheek"
   s.email             = "josh.cheek@gmail.com"
   s.homepage          = "https://github.com/JoshCheek/ARSettings"
@@ -89,3 +85,8 @@ desc 'Clear out RDoc and generated packages'
 task :clean => [:clobber_rdoc, :clobber_package] do
   rm "#{spec.name}.gemspec"
 end
+
+# desc 'generate docs'
+# task :doc do
+#   system "rdoc --force-update --format=darkfish --main=lib/arsettings.rb --title=ARSettings --main=arsettings.rb #{File.dirname(__FILE__)}/lib"
+# end

data/Readme.mdown

@@ -1,37 +1,32 @@
 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.
+
 Usage
 =====
 
-        
-Test
-====
-
-    $ rake
-
+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)).
 
 Dependencies
 ============
 
-* [ActiveRecord](http://rubygems.org/gems/activerecord)
-* [sqlite-ruby 1.3.1](http://rubygems.org/gems/sqlite-ruby)
-
+* 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
 
-TODO
-====
 
-* Write examples
-* Write documentation
-* Turn into gem
+Bugs / Contribution
+===================
 
----------------------------------------
+If you discover any errors / bugs, please inform me, and I will fix them and push out a new version.
 
-**This code is unmaintained.** 
+If you wish to fix it yourself, fork it, fix it, and send me a pull request.
 
-_If you do something interesting with it, let me know so I can be happy._
+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.
 
----------------------------------------
+License
+=======
 
 Copyright (c) 2010 Joshua Cheek
 

data/lib/arsettings/arsettings.rb

@@ -34,7 +34,7 @@ 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|
+    (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
@@ -54,15 +54,15 @@ module ARSettings
     end
   end
   
-  def self.serialize(data)
+  def self.serialize(data) # :nodoc:
     YAML::dump(data)
   end
   
-  def self.deserialize(data)
+  def self.deserialize(data) # :nodoc:
     YAML::load(data)
   end
   
-  def self.validate_options(options,*valid_options)
+  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}"

data/lib/arsettings/packaged.rb

@@ -2,13 +2,13 @@ module ARSettings
   class Packaged
     
     InvalidSettingsClassError = Class.new Exception
-    PASSTHROUGH = lambda { |val| val }
+    PASSTHROUGH = lambda { |val| val } # :nodoc:
     
     attr_reader :package , :settings_class
     
     private_class_method :new
         
-    def self.instance(settings_class,package)
+    def self.instance(settings_class,package) # :nodoc:
       validate(settings_class,package)
       package = normalize package
       @instances ||= Hash.new
@@ -16,42 +16,33 @@ module ARSettings
       @instances[settings_class][package] ||= new(settings_class,package)
     end
     
-    def self.has_instance?(settings_class,package)
+    def self.has_instance?(settings_class,package) # :nodoc:
       @instances && @instances[settings_class] && @instances[settings_class][normalize package]
     end
     
-    def self.validate(settings_class,package)
+    def self.validate(settings_class,package) # :nodoc:
       validate_package(package)
       validate_settings_class(settings_class)
     end
     
-    def self.validate_package(package)
+    def self.validate_package(package) # :nodoc:
       raise ARSettings::InvalidPackageError.new("#{package.inspect} should be a String/Symbol/Class") unless 
           String === package || Symbol === package || Class === package
     end
     
-    def self.validate_settings_class(settings_class)
+    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
     end
-    
-    def self.instances(settings_class)
-      @instances ||= Hash.new
-      @instances[settings_class] || Hash.new
-    end
-    
-    def self.normalize(package)
-      return package if Symbol === package
-      package.to_s.to_sym
-    end
    
    
     # instance methods
-        
-    def initialize(settings_class,package)
+    
+    def initialize(settings_class,package) # :nodoc:
       @package , @settings_class , @settings = package.to_s.to_sym , settings_class , Hash.new
     end    
     
+    # Destroy all of this package's settings *WARNING* This will wipe them out of the database
     def reset
       (@settings||{}).each do |name,instance| 
         remove_setter(name)
@@ -62,12 +53,6 @@ module ARSettings
       @settings = Hash.new
     end
     
-    def validate_name(name)
-      raise ARSettings::InvalidNameError.new("#{name} is #{name.to_s.size}, but MAX_CHARS is set to #{settings_class::MAX_CHARS}") if name.to_s.length > settings_class::MAX_CHARS
-      regex = /\A[a-z_][a-zA-Z_]*\Z/m
-      raise ARSettings::InvalidNameError.new("#{name.inspect} is not a valid settings name, because it is not a valid method name since it does not match #{regex.inspect}") if name.to_s !~ regex
-    end
-    
     def add( name , options={} , &proc )
       return(add_from_instance name[:record]) if name.is_a? Hash # internal use only
       ARSettings.validate_options options , :volatile , :default
@@ -89,48 +74,74 @@ module ARSettings
     def setting?(name)
       @settings.has_key? name
     end
+        
+    def settings
+      @settings.keys
+    end
+    
+    def settings_with_values
+      @settings.map { |name,instance| [name,instance.value] }
+    end
+    
+  private
+  
+    def self.instances(settings_class) # :nodoc:
+      @instances ||= Hash.new
+      @instances[settings_class] || Hash.new
+    end
+  
+    def self.normalize(package) # :nodoc:
+      return package if Symbol === package
+      package.to_s.to_sym
+    end
 
-    def metaclass
+    def validate_name(name) # :nodoc:
+      raise ARSettings::InvalidNameError.new("#{name} is #{name.to_s.size}, but MAX_CHARS is set to #{settings_class::MAX_CHARS}") if name.to_s.length > settings_class::MAX_CHARS
+      regex = /\A[a-z_][a-zA-Z_]*\Z/m
+      raise ARSettings::InvalidNameError.new("#{name.inspect} is not a valid settings name, because it is not a valid method name since it does not match #{regex.inspect}") if name.to_s !~ regex
+    end
+  
+    def metaclass # :nodoc:
       class << self
         self
       end
     end
-    
-    def define_method( name , &body )
+  
+    def define_method( name , &body ) # :nodoc:
       metaclass.send :define_method , name , &body
     end
-    
-    def remove_method(name)
+  
+    def remove_method(name) # :nodoc:
       metaclass.send :remove_method , "#{setting}="
     end
-    
-    def add_setter(name)
+
+    def add_setter(name) # :nodoc:
       define_method "#{name}=" do |value|
         @settings[name].value = @settings[name].postprocessing.call(value)
       end
     end
-    
-    def add_getter(name)
+  
+    def add_getter(name) # :nodoc:
       define_method(name) { @settings[name].value }
     end
-    
-    def add_boolean_getter(name)
+  
+    def add_boolean_getter(name) # :nodoc:
       define_method("#{name}?") { !!@settings[name].value }
     end
-    
-    def remove_setter(name)
+
+    def remove_setter(name) # :nodoc:
       metaclass.send :remove_method , "#{name}="
     end
-    
-    def remove_getter(name)
+  
+    def remove_getter(name) # :nodoc:
       metaclass.send :remove_method , name
     end
-    
-    def remove_boolean_getter(name)
+  
+    def remove_boolean_getter(name) # :nodoc:
       metaclass.send :remove_method , "#{name}?"
     end
-    
-    def method_missing(name,*args)
+  
+    def method_missing(name,*args) # :nodoc:
       if name.to_s =~ /\A[A-Z]/
         settings_class.const_get name , *args
       elsif name.to_s !~ /=$/ || ( name.to_s =~ /=$/ && args.size == 1 )
@@ -139,18 +150,8 @@ module ARSettings
         super
       end
     end
-    
-    def settings
-      @settings.keys
-    end
-    
-    def settings_with_values
-      @settings.map { |name,instance| [name,instance.value] }
-    end
-    
-  private
-  
-    def add_from_instance(record)
+
+    def add_from_instance(record) # :nodoc:
       record.postprocessing = PASSTHROUGH
       name = record.name.to_sym
       validate_name(name)

data/lib/arsettings/settings_class_methods.rb

@@ -1,14 +1,28 @@
 module ARSettings
   module SettingsClass_ClassMethods
     
-    def reset_all
+    def reset_all # :nodoc:
       Packaged.instances(self).each { |name,package| package.reset }
     end
     
-    def package(package)
-      Packaged.instance self , package
+    # 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]
@@ -18,7 +32,9 @@ module ARSettings
       end.add( name , options , &proc )
     end
      
-    def method_missing(name,*args)
+  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 )
@@ -27,10 +43,8 @@ module ARSettings
         super
       end
     end
-    
-  private
   
-    def load_from_db
+    def load_from_db # :nodoc:
       reset_all
       all.each { |instance| add :record => instance , :package => instance.package }
     end

data/lib/arsettings/settings_instance_methods.rb

@@ -1,6 +1,6 @@
 module ARSettings
     
-  module SettingsClass_InstanceMethods
+  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

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: arsettings
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Joshua Cheek
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 19
         segments: 
         - 2
         - 3
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 25
         segments: 
         - 1
         - 3
@@ -82,7 +79,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -91,7 +87,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"