arsettings 1.0.0

data/Rakefile

@@ -0,0 +1,91 @@
+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__)
+  requirements = String.new
+  requirements << "-r #{dir}/test/_helper.rb"
+  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:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "arsettings"
+  s.version           = "1.0.0"
+  s.author            = "Joshua Cheek"
+  s.email             = "josh.cheek@gmail.com"
+  s.homepage          = "https://github.com/JoshCheek/ARSettings"
+  s.summary           = "Settings for ActiveRecord projects (ie Rails)"
+  s.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."
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(Readme.mdown)
+  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.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")
+
+  # If your tests use any gems, include them here
+  s.add_development_dependency("sqlite-ruby", ">= 1.3.1")
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more 
+# about that here: http://gemcutter.org/pages/gem_docs
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Build the gemspec file #{spec.name}.gemspec"
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+task :package => :gemspec
+
+# Generate documentation
+Rake::RDocTask.new do |rd|
+  rd.main = "Readme.mdown"
+  rd.rdoc_files.include("Readme.mdown", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/Readme.mdown

@@ -0,0 +1,54 @@
+Description
+===========
+
+Usage
+=====
+
+        
+Test
+====
+
+    $ rake
+
+
+Dependencies
+============
+
+* [ActiveRecord](http://rubygems.org/gems/activerecord)
+* [sqlite-ruby 1.3.1](http://rubygems.org/gems/sqlite-ruby)
+
+
+TODO
+====
+
+* Write examples
+* Write documentation
+* Turn into gem
+
+---------------------------------------
+
+**This code is unmaintained.** 
+
+_If you do something interesting with it, let me know so I can be happy._
+
+---------------------------------------
+
+Copyright (c) 2010 Joshua Cheek
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.

data/lib/arsettings/activerecord.rb

@@ -0,0 +1,23 @@
+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/arsettings.rb

@@ -0,0 +1,74 @@
+module ARSettings
+  
+  AlreadyDefinedError       = Class.new(Exception)
+  NoSuchSettingError        = Class.new(Exception)
+  InvalidNameError          = Class.new(Exception)
+  InvalidPackageError       = Class.new(Exception)
+  InvalidOptionError        = Class.new(Exception)
+  NoDefaultPackageError     = Class.new(Exception)
+  UninitializedSettingError = Class.new(Exception)
+  
+  # create the settings class
+  def self.create_settings_class( 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
+      const_set :MAX_CHARS           , options.fetch( :max_chars , 30    )
+      const_set :VOLATILIE_DEFAULT   , options.fetch( :volatile  , false )
+      send :load_from_db
+      self
+    end
+    @default_class ||= klass
+    klass
+  end
+  
+  class << self
+    attr_accessor :default_class
+  end
+  
+  # can be used to put settings on any object
+  def self.on( object , options = Hash.new )
+    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|
+      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
+  end
+  
+  def self.serialize(data)
+    YAML::dump(data)
+  end
+  
+  def self.deserialize(data)
+    YAML::load(data)
+  end
+  
+  def self.validate_options(options,*valid_options)
+    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}"
+      end
+    end
+  end
+  
+end
+

data/lib/arsettings/packaged.rb

@@ -0,0 +1,165 @@
+module ARSettings 
+  class Packaged
+    
+    InvalidSettingsClassError = Class.new Exception
+    PASSTHROUGH = lambda { |val| val }
+    
+    attr_reader :package , :settings_class
+    
+    private_class_method :new
+        
+    def self.instance(settings_class,package)
+      validate(settings_class,package)
+      package = normalize package
+      @instances ||= Hash.new
+      @instances[settings_class] ||= Hash.new
+      @instances[settings_class][package] ||= new(settings_class,package)
+    end
+    
+    def self.has_instance?(settings_class,package)
+      @instances && @instances[settings_class] && @instances[settings_class][normalize package]
+    end
+    
+    def self.validate(settings_class,package)
+      validate_package(package)
+      validate_settings_class(settings_class)
+    end
+    
+    def self.validate_package(package)
+      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)
+      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)
+      @package , @settings_class , @settings = package.to_s.to_sym , settings_class , Hash.new
+    end    
+    
+    def reset
+      (@settings||{}).each do |name,instance| 
+        remove_setter(name)
+        remove_getter(name)
+        remove_boolean_getter(name)
+        instance.destroy
+      end
+      @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
+      name = name.to_sym
+      validate_name(name)
+      if setting? name
+        @settings[name].volatile        =  options[:volatile]  if options.has_key? :volatile
+        @settings[name].postprocessing  =  proc                if proc
+      else
+        add_setter(name)
+        add_getter(name)
+        add_boolean_getter(name)
+        @settings[name] = settings_class.new :name => name.to_s , :postprocessing => proc || PASSTHROUGH , :volatile => !!options.fetch(:volatile,settings_class::VOLATILIE_DEFAULT) , :package => package
+        send "#{name}=" , options[:default] if options.has_key?(:default)
+      end
+      self
+    end
+
+    def setting?(name)
+      @settings.has_key? name
+    end
+
+    def metaclass
+      class << self
+        self
+      end
+    end
+    
+    def define_method( name , &body )
+      metaclass.send :define_method , name , &body
+    end
+    
+    def remove_method(name)
+      metaclass.send :remove_method , "#{setting}="
+    end
+    
+    def add_setter(name)
+      define_method "#{name}=" do |value|
+        @settings[name].value = @settings[name].postprocessing.call(value)
+      end
+    end
+    
+    def add_getter(name)
+      define_method(name) { @settings[name].value }
+    end
+    
+    def add_boolean_getter(name)
+      define_method("#{name}?") { !!@settings[name].value }
+    end
+    
+    def remove_setter(name)
+      metaclass.send :remove_method , "#{name}="
+    end
+    
+    def remove_getter(name)
+      metaclass.send :remove_method , name
+    end
+    
+    def remove_boolean_getter(name)
+      metaclass.send :remove_method , "#{name}?"
+    end
+    
+    def method_missing(name,*args)
+      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 '='}")
+      else
+        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)
+      record.postprocessing = PASSTHROUGH
+      name = record.name.to_sym
+      validate_name(name)
+      add_setter(name)
+      add_getter(name)
+      add_boolean_getter(name)
+      @settings[name] = record
+    end
+    
+  end
+end
+

data/lib/arsettings/settings_class_methods.rb

@@ -0,0 +1,39 @@
+module ARSettings
+  module SettingsClass_ClassMethods
+    
+    def reset_all
+      Packaged.instances(self).each { |name,package| package.reset }
+    end
+    
+    def package(package)
+      Packaged.instance self , package
+    end
+    
+    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
+     
+    def method_missing(name,*args)
+      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
+    
+  private
+  
+    def load_from_db
+      reset_all
+      all.each { |instance| add :record => instance , :package => instance.package }
+    end
+
+  end
+end

data/lib/arsettings/settings_instance_methods.rb

@@ -0,0 +1,45 @@
+module ARSettings
+    
+  module SettingsClass_InstanceMethods
+
+    # 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
+

data/lib/arsettings.rb

@@ -0,0 +1,13 @@
+require 'yaml'
+
+manifest = %w(
+  arsettings
+  settings_class_methods
+  settings_instance_methods
+  packaged
+  activerecord
+)
+
+manifest.each do |filename|
+  require File.dirname(__FILE__) << "/arsettings/#{filename}"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: arsettings
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Joshua Cheek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-07 01:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite-ruby
+  prerelease: false
+  requirement: &id002 !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
+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: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Readme.mdown
+files: 
+- Rakefile
+- Readme.mdown
+- lib/arsettings/activerecord.rb
+- lib/arsettings/arsettings.rb
+- lib/arsettings/packaged.rb
+- lib/arsettings/settings_class_methods.rb
+- lib/arsettings/settings_instance_methods.rb
+- lib/arsettings.rb
+has_rdoc: true
+homepage: https://github.com/JoshCheek/ARSettings
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- Readme.mdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Settings for ActiveRecord projects (ie Rails)
+test_files: []
+