kvc 0.0.3 → 0.1.0

data/{History.txt → History.rdoc}

@@ -1,3 +1,10 @@
+=== 0.1.0 / 2009-12-10
+
+* 1 enhancement
+
+  * Reload database records by default.
+
+
 === 0.0.3 / 2009-06-27
 
 * 1 minor enhancement

data/{README.txt → README.rdoc}

@@ -61,14 +61,12 @@ If need be, validate specific key values in an initializer:
 
 Install:
 
-  % gem install stephencelis-kvc --source=http://gems.github.com
+  % gem install kvc
 
 
 And configure:
 
-  config.gem "stephencelis-kvc",
-    :lib => "kvc",
-    :source => "http://gems.github.com"
+  config.gem "kvc"
 
 
 === As a plugin
@@ -98,11 +96,11 @@ the table at any time, execute the "kvc:drop_table" Rake task).
 
 (c) 2009-* Stephen Celis, stephen@stephencelis.com.
 
-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 
+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

data/Rakefile

@@ -1,14 +1,8 @@
 $: << File.dirname(__FILE__) + "/lib"
 require "rubygems"
-require "hoe"
 require "active_record"
 require "kvc"
 
-Hoe.new("kvc", KVC::VERSION) do |p|
-  p.developer("Stephen Celis", "stephen@stephencelis.com")
-  p.remote_rdoc_dir = ''
-end
-
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'

data/lib/kvc.rb

@@ -18,7 +18,7 @@
 # Or get creative:
 #
 #   KVC["Chad's expensive guitar"] = Fender::Stratocaster.new(1957)
-# 
+#
 # By default, nonexistent keys return +nil+ values, but you can be stricter if
 # you want to avoid typo-based bugs:
 #
@@ -35,7 +35,7 @@
 #
 # Failed validations will raise <tt>ActiveRecord::RecordInvalid</tt>.
 module KVC
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 
   class << self
     def [](key)
@@ -65,3 +65,7 @@ module KVC
     end
   end
 end
+
+def KVC(key)
+  KVC[key]
+end

data/lib/kvc/settings.rb

@@ -13,10 +13,16 @@ class KVC::Settings < ActiveRecord::Base
   @@strict_keys = false
   cattr_accessor :strict_keys
 
+  # Reload serialized <tt>ActiveRecord::Base</tt> records.
+  @@reload_records = true
+  cattr_accessor :reload_records
+
   @@validations = HashWithIndifferentAccess.new []
   cattr_reader :validations
+
   class << self
-    alias strict_keys? strict_keys
+    alias strict_keys?    strict_keys
+    alias reload_records? reload_records
 
     # Config takes a block for configuration. For now, this provides
     # rudimentary validation. E.g.:
@@ -33,6 +39,23 @@ class KVC::Settings < ActiveRecord::Base
         self
       end.instance_eval(&block)
     end
+
+    # Recursively reload saved records. To short-circuit record reloading, set
+    # <tt>KVC::Settings.reload_records = false</tt>.
+    def deserialize(object)
+      return object unless reload_records?
+
+      case object
+      when ActiveRecord::Base
+        object.new_record? ? object : object.reload
+      when Array
+        object.map { |o| deserialize(o) }
+      when Hash
+        object.each { |k, v| object[k] = deserialize(v) }
+      else
+        object
+      end
+    end
   end
 
   # Active Record does not automatically namespace tables.
@@ -43,7 +66,7 @@ class KVC::Settings < ActiveRecord::Base
 
   # Deserializes value from database.
   def value
-    @value ||= YAML.load read_attribute(:value)
+    @value ||= KVC::Settings.deserialize YAML.load(read_attribute(:value))
   end
 
   # Serializes value for database.

data/lib/kvc/settings_proxy.rb

@@ -7,6 +7,8 @@
 class KVC::SettingsProxy
   undef_method *instance_methods.grep(/^(?!__|nil\?|send)/)
 
+  attr_reader :setting
+
   def initialize(setting)
     @setting = setting
   end
@@ -14,11 +16,13 @@ class KVC::SettingsProxy
   private
 
   def method_missing(method, *args, &block)
-    return @setting.send(method) if [:created_at, :updated_at].include? method
+    return setting.send(method) if [:created_at, :updated_at].include? method
+
+    return_value = setting.value.send(method, *args, &block)
+    stored_value = KVC::Settings.deserialize YAML.load(setting[:value])
 
-    return_value = @setting.value.send(method, *args, &block)
-    if @setting.value != YAML.load(@setting.read_attribute(:value))
-      @setting.update_attribute :value, @setting.value
+    if setting.value != stored_value
+      setting.update_attribute :value, setting.value
       return self # Allow for chaining.
     end
 

data/test/kvc_test.rb

@@ -3,12 +3,25 @@ require 'rubygems'
 require 'active_record'
 require 'active_support'
 require 'active_support/test_case'
+ActiveRecord::Migration.verbose = false
 
 $: << File.expand_path(File.dirname(__FILE__) + "/../lib") <<
       File.expand_path(File.dirname(__FILE__) + "/../app/models")
 
 ActiveRecord::Base.establish_connection :adapter => 'sqlite3',
-                                        :dbfile => ':memory:'
+                                        :database => ':memory:'
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :guitars do |t|
+    t.string :make, :model
+    t.timestamps
+  end
+
+  create_table :keyboards do |t|
+    t.string :make, :model
+    t.timestamps
+  end
+end
 
 require "kvc"
 require "kvc/settings"
@@ -16,6 +29,13 @@ require "kvc/settings_proxy"
 
 logger = Logger.new(STDOUT)
 
+class Guitar < ActiveRecord::Base
+end
+
+class Keyboard < ActiveRecord::Base
+  validates_presence_of :make
+end
+
 class KVCTest < ActiveSupport::TestCase
   teardown do
     KVC::Settings.destroy_all
@@ -80,6 +100,55 @@ class KVCTest < ActiveSupport::TestCase
     assert_kind_of Integer, KVC.favorite_year
   end
 
+  test "models should serialize and deserialize updated versions" do
+    instruments = {
+      :guitars => {
+        :favorites => [
+          Guitar.create(:make => "Gibson", :model => "Melody Maker"),
+          Guitar.create(:make => "Epiphone", :model => "Les Paul"),
+        ],
+        :not_so_good => [
+          Guitar.create(:make => "Samick")
+        ]
+      },
+      :keyboard => Keyboard.create(:make => "Yamaha")
+    }
+
+    KVC.instruments = Marshal.load Marshal.dump(instruments) # Deep copy.
+    instruments[:keyboard].update_attribute(:model, "Privia PX-130")
+
+    assert_equal instruments, KVC.instruments
+    assert_equal instruments[:keyboard].model, KVC.instruments[:keyboard].model
+  end
+
+  test "should not reload records if record reloading is off" do
+    begin
+      KVC::Settings.reload_records = false
+      KVC.guitar = Guitar.create(:make => "Yamaha")
+      guitar = Guitar.last
+      guitar.update_attribute :make, "Yamahahaha"
+      assert_not_equal guitar.make, KVC.guitar.make
+    ensure
+      KVC::Settings.reload_records = true
+    end
+  end
+
+  test "unsaved models should deserialize" do
+    keyboard = Keyboard.new :model => "Some kind of synthesizer."
+    assert_nil keyboard.id
+    KVC["Which make was it again?"] = keyboard.clone # Unsaved copy.
+    assert_equal keyboard, KVC["Which make was it again?"]
+  end
+
+  test "missing models should raise exceptions" do
+    guitar = Guitar.create
+    KVC.ghost_guitar = guitar
+    guitar.destroy
+    assert_raise ActiveRecord::RecordNotFound do
+      KVC.ghost_guitar.touch
+    end
+  end
+
   test "can set attributes with whitespace and symbols" do
     assert KVC["uses_git?"] = true
     assert KVC.uses_git?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kvc
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Stephen Celis
@@ -9,19 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-27 00:00:00 -05:00
+date: 2009-12-10 00:00:00 -06:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.0.0
-    version: 
+dependencies: []
+
 description: |-
   KVC (Key-Value Configuration) provides a powerful, transparent way to maintain
   mutable app settings in the database.
@@ -32,13 +23,13 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
+- History.rdoc
 - Manifest.txt
-- README.txt
+- README.rdoc
 files: 
-- History.txt
+- History.rdoc
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - lib/kvc.rb
 - lib/kvc/settings.rb
@@ -53,7 +44,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement