kb-configurator 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Brennan Dunn
+
+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/README.rdoc

@@ -0,0 +1,114 @@
+= Configurator
+ 
+== Expalanation
+ 
+Unleash your models and quickly and easily annotate anything. Store booleans, strings, or optionally serialized objects (hashes, custom classes, whatever) without extra migrations.
+ 
+Configurator is meant to store basic things. There's no easy way to query for models that match a particular criteria, so don't go overboard. This satisfies some of my needs, but I don't recommend relying on it as a replacement for traditional model fields.
+ 
+Want your users to be able to define custom settings?
+ 
+  class User < ActiveRecord::Base
+    include Configurator
+  end
+ 
+=== Basics
+ 
+Now you can do things like:
+ 
+  @user.config[:receive_email_alerts?] = true
+  
+or
+  
+  @user.config[:notification_address] = 'user@gmail.com'
+
+
+You can set configurations to either instances or classes. Setting key/value pairs to classes is especially useful for setting up application-wide settings.
+
+Think of it as just a giant hash.
+ 
+  @user.config = { :favorite_animal => 'dog', :favorite_color => 'blue' }
+ 
+  
+=== Namespaces
+ 
+Support for one level of namespacing:
+ 
+  @user.config[:animals, :favorite] = 'cat'
+  
+Namespaces within hash assignments:
+  
+  @user.config = { :animals => { :favorite => 'cat', :likes_elephants? => true }, :artists => { :favorite => 'Radiohead' } }
+ 
+Querying namespaces:
+ 
+  @user.config = { :animals => { :cat => 'Toby', :dog => 'Gabby' } }
+  @user.config.namespace(:animals)  # => { :cat => 'Toby', :dog => 'Gabby' }
+  
+ 
+=== Form support  
+ 
+Easy to use in views:
+ 
+  <% fields_for :config, @user.config do |c| %>
+ 
+    <%= c.select :favorite_color, %w(red green blue) %>
+ 
+  <% end %>
+ 
+ 
+=== Default Options
+ 
+Databases don't come filled, so there's an easy way to set defaults on your models. The default values will be added to the config table used by the plugin when loaded.
+ 
+  class User < ActiveRecord::Base
+    include Configurator
+ 
+    default_configuration :favorite_color => 'red', :receive_email_alerts? => true, :salary => { :default_for_manager => '$55,000', :default_for_employee => '$25,000' }
+  end
+ 
+  @user.config[:favorite_color] # => 'red'
+  @user.config[:favorite_color] = 'green'
+  @user.config[:favorite_color] # => 'green'
+  
+
+== Global Settings
+
+Sometimes you don't want to be restricted to configuring records, and would like to apply Configurator to a class or to something even more global. Well, now you can.
+
+=== Per Model
+
+  User.config[:notification_email] = 'Welcome new user!'
+  
+=== Globally
+
+  Configurator[:default_notification_email] = 'Welcome to our website!'
+  
+
+Example of a database driven view layer:
+  
+  <h1><%= Configurator[:login_page, :headline] %></h1>
+  
+  <p><%= Configurator[:login_page, :username] %></p>
+  <%= text_field_tag :username %>
+  
+  <p><%= Configurator[:login_page, :password] %></p>
+  ...
+  
+Simply store the above values, and you're now able to quickly attach a form to those different values, and satisfy your clients need to have every single aspect of the application. I'm sure there are plugins that do just this, but this is an example of Configurators global reach.
+  
+ 
+== Setup
+
+- Install the gem
+- Run the config_table generator
+- Migrate your database
+- Include Configurator into the models you need it in, and that's it.
+ 
+If you need to be able to store complex objects, or strings greater than 255 characters, change the 'value' column to text. You can add to the ConfigurationHash class:
+  
+  serialize :value
+  
+I haven't tried this yet, but it should work fine.
+
+Copyright (c) 2009 Brennan Dunn, released under the MIT license

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "configurator"
+    s.summary = %Q{Fatten your models with key/value pairs}
+    s.email = "me@brennandunn.com"
+    s.homepage = "http://github.com/brennandunn/configurator"
+    s.description = "Fatten your models with key/value pairs"
+    s.authors = ["Brennan Dunn"]
+    s.files = %w(MIT-LICENSE README.rdoc Rakefile) + Dir.glob("{lib,test,generators}/**/*")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+    t.verbose = true
+  end
+rescue LoadError
+  puts "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+end
+
+task :default => :test

data/generators/config_table/config_table_generator.rb

@@ -0,0 +1,11 @@
+class ConfigTableGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template "migration/create_config_table.rb", "db/migrate"
+    end
+  end
+  
+  def file_name
+    "create_config_table"
+  end
+end

data/generators/config_table/templates/migration/create_config_table.rb

@@ -0,0 +1,15 @@
+class CreateConfigTable < ActiveRecord::Migration
+  def self.up
+    create_table :config do |t|
+      t.references    :associated, :polymorphic => true
+      t.string        :namespace
+      t.string        :key,         :limit => 40,     :null => false
+      t.string        :value
+      t.string        :data_type,   :limit => 40
+    end
+  end
+
+  def self.down
+    drop_table :config
+  end
+end

data/lib/configurator/configuration_hash.rb

@@ -0,0 +1,37 @@
+class ConfigurationHash < ActiveRecord::Base
+  set_table_name 'config'
+  
+  belongs_to :associated, :polymorphic => true
+  
+  class << self
+    
+    def find_by_key_and_owner(call_type, key, owner, namespace = nil)
+      options = namespace ? { :namespace => namespace } : {}
+      find(:first, :conditions => { :key => key, 
+                                    :associated_id => call_type == :instance ? owner.id : nil, 
+                                    :associated_type => call_type == :instance ? owner.class.name : owner.name
+                                   }.merge(options))
+    end
+    
+    def find_all_by_owner(call_type, owner, namespace = nil)
+      options = namespace ? { :namespace => namespace } : {}
+      find(:all, :conditions => { :associated_id => call_type == :instance ? owner.id : nil, 
+                                  :associated_type => call_type == :instance ? owner.class.name : owner.name 
+                                  }.merge(options))
+    end
+    
+  end
+  
+  def value=(param)
+    write_attribute :value, param.to_s
+  end
+  
+  def value
+    if key.ends_with? "?"
+      read_attribute(:value) == "true"
+    else
+      read_attribute(:value)
+    end
+  end
+  
+end

data/lib/configurator/configurator.rb

@@ -0,0 +1,145 @@
+module Configurator
+  mattr_accessor :config
+  
+  def self.[](*keys)
+    self.config ||= ConfigProxy.new(:class, self)
+    self.config[*keys]
+  end
+  
+  def self.[]=(*keys)
+    self.config ||= ConfigProxy.new(:class, self)
+    value = *keys.pop
+    self.config[*keys] = value
+  end
+  
+  def self.from_hash(hsh)
+    self.config ||= ConfigProxy.new(:class, self)
+    self.config.from_hash(hsh)
+    self.config
+  end
+  
+  module ClassMethods
+    
+    def default_configuration(hsh = {})
+      hsh.symbolize_keys!
+      @@default_configuration = hsh
+      hsh.each do |key, value|
+        config[key] = value
+      end
+    end
+    
+    def get_default_configuration
+      @@default_configuration rescue {}
+    end
+    
+    def config
+      @config_proxy ||= ConfigProxy.new(:class, self)
+    end
+    
+    def config=(hsh)
+      config.from_hash(hsh)
+      config
+    end
+  
+  end
+  
+  module InstanceMethods
+    
+    def config
+      @config_proxy ||= ConfigProxy.new(:instance, self)
+    end
+ 
+    def config=(hsh)
+      config.from_hash(hsh)
+      config
+    end
+    
+  end
+  
+  class ConfigProxy
+
+    attr_reader :defaults
+
+    def initialize(call_type, reference)
+      @reference, @call_type = reference, call_type
+      case call_type
+      when :instance
+        @options = { :associated_id => reference.id, :associated_type => reference.class.name }
+        @defaults = reference.class.get_default_configuration rescue {}
+      when :class
+        @options = { :associated_type => reference.name }
+        @defaults = reference.get_default_configuration rescue {}
+      end
+    end
+
+    def [](*keys)
+      namespace, key = [keys].flatten
+      if key.nil?
+        key = namespace
+        namespace = nil
+      end
+
+      pair = ConfigurationHash.find_by_key_and_owner(@call_type, key.to_s, @reference, namespace ? namespace.to_s : nil)
+      if pair.nil?
+        namespace ? @defaults[namespace][key] : @defaults[key] rescue nil
+      else
+        pair.value
+      end
+      
+    end
+
+    def []=(*keys)
+      if keys.size == 3
+        namespace, key = keys[0], keys[1]
+        value = keys[2]
+      else
+        key, value = keys[0], keys[1]
+      end
+              
+      pair = ConfigurationHash.find_by_key_and_owner(@call_type, key.to_s, @reference, namespace ? namespace.to_s : nil)
+      unless pair
+        pair = ConfigurationHash.new(@options)
+        pair.key, pair.value = key.to_s, value
+        pair.namespace = namespace.to_s if namespace
+        pair.save
+      else
+        pair.value = value
+        pair.save
+      end
+      value
+    end
+    
+    def namespace(ns)
+      configs = ConfigurationHash.find_all_by_owner(@call_type, @reference, ns ? ns.to_s : nil)
+      configs.inject({}) { |hsh, c| hsh[c.key.intern] = c.value; hsh }
+    end
+
+    def to_hash(with_defaults = false)
+      Hash[ *ConfigurationHash.find_all_by_owner(@reference).map { |pair| [pair.key, pair.value] }.flatten ]
+    end
+
+    def from_hash(hsh)
+      hsh.each do |key, value|
+        if value.is_a?(Hash)
+          namespace = key
+          value.each do |key, value|
+            self[namespace, key] = value
+          end
+        else
+          self[key] = value
+        end
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      self[method.to_s]
+    end
+
+  end
+  
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+    receiver.send :include, InstanceMethods
+  end
+  
+end

data/lib/configurator.rb

@@ -0,0 +1,2 @@
+require 'configurator/configurator'
+require 'configurator/configuration_hash'

data/test/configurator_test.rb

@@ -0,0 +1,95 @@
+require File.join(File.dirname(__FILE__), 'helper')
+ 
+class ConfiguratorTest < Test::Unit::TestCase
+ 
+  def setup
+    setup_db
+    @user = User.create
+    @company = Company.create
+  end
+  
+  context 'setting configurator values on objects' do
+    
+    should 'not accept either strings or symbols as keys' do
+      @user.config[:favorite_color] = 'red'
+      assert_equal 'red', @user.config[:favorite_color]
+      @user.config['favorite_city'] = 'New York'
+      assert_equal 'New York', @user.config[:favorite_city]
+    end
+
+    should 'test for TRUE values when supplying an inquiry key' do
+      @user.config[:likes_cats?] = 'true'
+      assert_equal true, @user.config[:likes_cats?]
+      @user.config[:likes_dogs?] = true
+      assert_equal true, @user.config[:likes_dogs?]
+    end
+
+    should 'handle two levels of namespaces as keys' do
+      @other_user = User.create
+      @user.config[:animals, :likes_cats?] = true
+      @user.config[:animals, :favorite] = 'cat'
+      @other_user.config[:animals, :likes_cats?] = false
+      @other_user.config[:animals, :favorite] = 'dog'
+      assert_equal true, @user.config[:animals, :likes_cats?]
+      assert_equal 'cat', @user.config[:animals, :favorite]
+      assert_equal false, @other_user.config[:animals, :likes_cats?]
+      assert_equal 'dog', @other_user.config[:animals, :favorite]
+      assert_equal true, @user.config.namespace(:animals)[:likes_cats?]
+      assert_equal 'cat', @user.config.namespace(:animals)[:favorite]
+      assert_equal false, @other_user.config.namespace(:animals)[:likes_cats?]
+      assert_equal 'dog', @other_user.config.namespace(:animals)[:favorite]
+    end
+
+    should 'return a hash when querying a namespace with #namespace' do
+      @user.config[:animals, :cat] = 'Toby'
+      @user.config[:animals, :dog] = 'Gabby'
+      @user.config[:animals, :mouse] = 'Mickey'
+      hsh = { :cat => 'Toby', :dog => 'Gabby', :mouse => 'Mickey' }
+      assert_equal hsh, @user.config.namespace(:animals)
+    end
+
+    context 'when querying and attempting to write to a key that is a namespace' do
+
+    end
+
+    should 'honor default configuration settings' do
+      assert_equal '$55,000', @company.config[:salary, :default_for_manager]
+      @company.config[:salary, :default_for_manager] = '$65,000'
+      assert_equal '$65,000', @company.config[:salary, :default_for_manager]
+    end
+
+    should 'allow for mass assignment of flat/nested hashes' do
+      hash = { :favorite_color => 'red', :favorite_city => 'New York', :favorite_artist => 'Radiohead', :animals => { :favorite => 'cat', :likes_elephants? => true } }
+      @user.config = hash
+      assert_equal @user.config[:favorite_color], 'red'
+      assert_equal @user.config[:animals, :favorite], 'cat'
+      assert_equal @user.config[:animals, :likes_elephants?], true
+    end
+
+    should 'support default values on a class' do
+      User.config[:default_salary] = '$55,000'
+      assert_equal '$55,000', User.config[:default_salary]
+    end
+
+    should 'support default namespaced values on a class' do
+      assert_equal Company.config[:salary, :default_for_manager], '$55,000'
+    end
+
+    should 'allow for mass assignment on a class' do
+      hash = { :favorite_color => 'red', :favorite_city => 'New York', :favorite_artist => 'Radiohead', :animals => { :favorite => 'cat', :likes_elephants? => true } }
+      User.config = hash
+      assert_equal User.config[:favorite_color], 'red'
+      assert_equal User.config[:animals, :favorite], 'cat'
+      assert_equal User.config[:animals, :likes_elephants?], true
+    end
+
+    should 'support setting global values' do
+      Configurator[:enable_quantum_accelerator?] = true
+      assert Configurator[:enable_quantum_accelerator?]
+      Configurator[:colors, :favorite] = 'red'
+      assert_equal Configurator[:colors, :favorite], 'red'
+    end
+    
+  end
+ 
+end

data/test/helper.rb

@@ -0,0 +1,52 @@
+begin
+  require File.dirname(__FILE__) + '/../../../../config/environment'
+rescue LoadError
+  require 'rubygems'
+  require 'activerecord'
+end
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__)+'/../lib')
+require 'configurator'
+require 'configuration_hash'
+
+class User < ActiveRecord::Base
+  include Configurator
+end
+
+class Company < ActiveRecord::Base
+  include Configurator
+  
+  default_configuration :notify_users? => true, :salary => { :default_for_manager => '$55,000', :default_for_employee => '$25,000' }
+end
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+ 
+def setup_db
+  ::ActiveRecord::Base.class_eval do
+    silence do
+      connection.create_table :config, :force => true do |t|
+        t.references    :associated, :polymorphic => true
+        t.string        :namespace
+        t.string        :key,         :limit => 40,     :null => false
+        t.string        :value
+      end
+    
+      connection.create_table :users, :force => true do |t|
+        t.string        :handle
+      end
+    
+      connection.create_table :companies, :force => true do |t|
+        t.string        :name
+      end
+    end
+  end
+end
+ 
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: kb-configurator
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Brennan Dunn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-13 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Fatten your models with key/value pairs
+email: me@brennandunn.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- generators/config_table/config_table_generator.rb
+- generators/config_table/templates/migration/create_config_table.rb
+- lib/configurator.rb
+- lib/configurator/configuration_hash.rb
+- lib/configurator/configurator.rb
+- test/configurator_test.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/brennandunn/configurator
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Fatten your models with key/value pairs
+test_files: 
+- test/configurator_test.rb
+- test/helper.rb