durable_hash 1.0.1

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem 'activerecord', ENV['ACTIVE_RECORD_VERSION']
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+end
+
+group :test do
+  gem 'sqlite3'
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.10)
+      activesupport (= 2.3.10)
+    activesupport (2.3.10)
+    git (1.2.5)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    sqlite3 (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.0)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Francis Hwang
+
+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/Rakefile

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "durable_hash"
+  gem.homepage = "http://github.com/fhwang/durable_hash"
+  gem.license = "MIT"
+  gem.summary = %Q{Maybe you want something that acts like a hash but is backed by ActiveRecord.}
+  gem.description = %Q{Maybe you want something that acts like a hash but is backed by ActiveRecord.}
+  gem.email = "francis.hwang@profitably.com"
+  gem.authors = ["Francis Hwang"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+ActiveRecordVersions = %w(3.0.7 2.3.10)
+
+desc "Run all tests"
+task :test do
+  ActiveRecordVersions.each do |ar_version|
+    cmd = "ACTIVE_RECORD_VERSION=#{ar_version} ruby test/durable_hash_test.rb"
+    puts cmd
+    puts `cd . && #{cmd}`
+    puts
+  end
+end
+
+task :default => :test
+

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/durable_hash.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{durable_hash}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Francis Hwang"]
+  s.date = %q{2011-05-29}
+  s.description = %q{Maybe you want something that acts like a hash but is backed by ActiveRecord.}
+  s.email = %q{francis.hwang@profitably.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "durable_hash.gemspec",
+    "init.rb",
+    "lib/durable_hash.rb",
+    "test/durable_hash_test.rb"
+  ]
+  s.homepage = %q{http://github.com/fhwang/durable_hash}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Maybe you want something that acts like a hash but is backed by ActiveRecord.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require "#{File.dirname(__FILE__)}/lib/durable_hash"

data/lib/durable_hash.rb

@@ -0,0 +1,115 @@
+module DurableHash
+  mattr_accessor :deserializers
+  self.deserializers = Hash.new { |h,durable_hash_class|
+    h[durable_hash_class] = {}
+  }
+  
+  def self.deserializer(durable_hash_class, value_class)
+    deserializer = deserializers[durable_hash_class][value_class]
+    unless deserializer
+      match_class = deserializers[durable_hash_class].keys.detect { |klass|
+        value_class < klass
+      }
+      deserializer = deserializers[durable_hash_class][match_class]
+    end
+    deserializer
+  end
+  
+  mattr_accessor :serializers
+  self.serializers = Hash.new { |h,durable_hash_class|
+    h[durable_hash_class] = {}
+  }
+  
+  def self.serializer(durable_hash_class, value_class)
+    serializer = serializers[durable_hash_class][value_class]
+    unless serializer
+      match_class = serializers[durable_hash_class].keys.detect { |klass|
+        value_class < klass
+      }
+      serializer = serializers[durable_hash_class][match_class]
+    end
+    serializer
+  end
+  
+  def self.included(includer)
+    def includer.acts_as_durable_hash
+      self.validates_uniqueness_of :key
+      self.validates_presence_of :key, :value_class
+      self.serialize :value
+    
+      def self.[](key)
+        if record = find_by_key(key.to_s)
+          record.value
+        end
+      end
+      
+      def self.[]=(key, value)
+        if record = find_by_key(key.to_s)
+          record.value = value
+          record.save!
+        else
+          create! :key => key.to_s, :value => value
+        end
+      end
+      
+      self.before_validation do |record|
+        record.value_class = record.value.class.name
+        serializer = DurableHash.serializer(record.class, record.value.class)
+        record.value = serializer.call(record.value) if serializer
+      end
+      
+      if ActiveRecord::VERSION::MAJOR == 3
+        define_method(:durable_hash_after_find) do
+          if attributes['value_class']
+            serializer = DurableHash.deserializer(
+              self.class, value_class.constantize
+            )
+            if serializer
+              self.value = serializer.call self.value
+            elsif value_class == 'Fixnum'
+              self.value = self.value.to_i
+            elsif value_class == 'Float'
+              self.value = self.value.to_f
+            end
+          end
+        end
+        self.after_find :durable_hash_after_find
+      else
+        define_method(:after_find) do
+          if attributes['value_class']
+            serializer = DurableHash.deserializer(
+              self.class, value_class.constantize
+            )
+            if serializer
+              self.value = serializer.call self.value
+            elsif value_class == 'Fixnum'
+              self.value = self.value.to_i
+            elsif value_class == 'Float'
+              self.value = self.value.to_f
+            end
+          end
+        end
+      end
+      
+      if block_given?
+        yield DurableHash::Builder.new(self)
+      end
+    end
+  end
+  
+  class Builder
+    def initialize(klass); @klass = klass; end
+    
+    def deserialize(value_class, &block)
+      DurableHash.deserializers[@klass][value_class] = block
+    end
+    
+    def serialize(value_class, &block)
+      DurableHash.serializers[@klass][value_class] = block
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include DurableHash
+end

data/test/durable_hash_test.rb

@@ -0,0 +1,208 @@
+RAILS_ENV = 'test'
+require 'rubygems'
+require 'active_record'
+require 'active_record/base'
+require 'active_support/core_ext/logger'
+require File.dirname(__FILE__) + '/../lib/durable_hash'
+require 'test/unit'
+
+# Configure ActiveRecord
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + '/test.log')
+ActiveRecord::Base.establish_connection(
+  'timeout' => 5000, 'adapter' => 'sqlite3', 'database' => 'test/test.sqlite3', 
+  'pool' => 5
+)
+
+# Create the DB schema
+silence_stream(STDOUT) do
+  ActiveRecord::Schema.define do
+    create_table 'application_settings', :force => true do |app_setting|
+      app_setting.string 'key'
+      app_setting.string 'value'
+      app_setting.string 'value_class'
+    end
+    
+    create_table 'customized_settings', :force => true do |app_setting|
+      app_setting.string 'key'
+      app_setting.string 'value'
+      app_setting.string 'value_class'
+    end
+  end
+end
+
+# Define some sample classes
+class ApplicationSetting < ActiveRecord::Base
+  acts_as_durable_hash
+end
+
+module WrapperModule
+  class Custom
+    attr_accessor :value
+  
+    def initialize(value); @value = value; end
+  end
+  
+  class SonOfCustom < Custom
+  end
+end
+
+class CustomizedSetting < ActiveRecord::Base
+  acts_as_durable_hash do |dh|
+    dh.serialize(WrapperModule::Custom) do |custom|
+      custom.value
+    end
+    dh.deserialize(WrapperModule::Custom) do |data|
+      WrapperModule::Custom.new data
+    end
+  end
+end
+
+# Finally some tests
+class EmptyApplicationSettingTestCase < Test::Unit::TestCase
+  def setup
+    ApplicationSetting.destroy_all
+  end
+
+  def test_should_return_nil_for_most_everything
+    assert_nil(ApplicationSetting['foo'])
+  end
+end
+
+class ApplicationSettingReadingTestCase < Test::Unit::TestCase
+  def setup
+    as = ApplicationSetting.find_or_create_by_key 'foo'
+    as.value = 'bar'
+    as.save!
+  end
+  
+  def test_should_return_the_value
+    assert_equal(ApplicationSetting['foo'], 'bar')
+  end
+  
+  def test_should_return_the_value_with_a_symbol_too
+    assert_equal(ApplicationSetting[:foo], 'bar')
+  end
+end
+
+class ApplicationSettingCreatingTestCase < Test::Unit::TestCase
+  def setup
+    ApplicationSetting.destroy_all
+  end
+  
+  def test_it_should_handle_a_write
+    ApplicationSetting['foo'] = 'bar'
+    assert_equal(ApplicationSetting['foo'], 'bar')
+  end
+  
+  def test_should_handle_a_write_with_a_symbol
+    ApplicationSetting[:foo] = 'bar'
+    assert_equal(ApplicationSetting['foo'], 'bar')
+  end
+end
+
+class ApplicationSettingUpdatingTestCase < Test::Unit::TestCase
+  def setup
+    ApplicationSetting.destroy_all
+    ApplicationSetting.create! :key => 'foo', :value => 'bar'
+  end
+  
+  def test_should_handle_a_write
+    ApplicationSetting['foo'] = 'baz'
+    assert_equal(ApplicationSetting['foo'], 'baz')
+  end
+end
+
+class ApplicationSettingUniquenessTestCase < Test::Unit::TestCase
+  def setup
+    ApplicationSetting.destroy_all
+    ApplicationSetting.create! :key => 'foo', :value => 'bar'
+  end
+  
+  def test_should_be_set_on_key_automatically
+    assert_raises(ActiveRecord::RecordInvalid) {
+      ApplicationSetting.create!(:key => 'foo', :value => 'baz')
+    }
+  end
+  
+  def test_should_prevent_new_instances_from_being_seen_as_valid
+    assert(!ApplicationSetting.new(:key => 'foo', :value => 'baz').valid?)
+  end
+end
+
+class ApplicationSettingWithAnIntegerTestCase < Test::Unit::TestCase
+  def setup
+    ApplicationSetting.destroy_all
+  end
+  
+  def test_should_read_and_write_as_an_integer
+    ApplicationSetting['foo'] = 123
+    assert_equal(ApplicationSetting['foo'], 123)
+  end
+end
+
+class ApplicationSettingWithAFloatTestCase < Test::Unit::TestCase
+  def setup
+    ApplicationSetting.destroy_all
+  end
+  
+  def test_should_read_and_write_as_a_float
+    ApplicationSetting['foo'] = 123.0
+    assert_equal(ApplicationSetting['foo'].class, Float)
+    assert_in_delta(123.0, ApplicationSetting['foo'], 0.00001)
+  end
+end
+
+class ApplicationSettingWithAnArrayTestCase < Test::Unit::TestCase
+  def setup
+    ApplicationSetting.destroy_all
+  end
+  
+  def test_should_read_and_write_as_a_float
+    ApplicationSetting['foo'] = [1,2,3]
+    assert_equal(ApplicationSetting['foo'], [1,2,3])
+  end
+end
+
+class ApplicationSettingValidForANewInstanceCase < Test::Unit::TestCase
+  def setup
+    ApplicationSetting.destroy_all
+  end
+  
+  def test_should_not_need_a_value_class_to_be_explicitly_set
+    app_setting = ApplicationSetting.new :key => 'username', :value => 'bob'
+    assert(app_setting.valid?)
+  end
+end
+
+class CustomizedSettingCustomSerializationTestCase < Test::Unit::TestCase
+  def setup
+    CustomizedSetting.destroy_all
+  end
+  
+  def test_should_save_and_load_with_a_custom_serialization
+    value = WrapperModule::Custom.new('bar')
+    CustomizedSetting['foo'] = value
+    value_prime = CustomizedSetting['foo']
+    # let's make sure there's no in-Ruby caching going on which could give this
+    # test a false positive
+    assert_not_equal(value.object_id, value_prime.object_id)
+    assert_equal(value_prime.class, WrapperModule::Custom)
+    assert_equal(value_prime.value, 'bar')
+  end
+  
+  def test_should_not_try_to_mess_with_a_normal_value
+    CustomizedSetting['baz'] = 'fiz'
+    assert_equal(CustomizedSetting['baz'], 'fiz')
+  end
+  
+  def test_should_use_custom_serialization_for_any_subclasses_of_Custom_too
+    value = WrapperModule::SonOfCustom.new('bar')
+    CustomizedSetting['foo'] = value
+    value_prime = CustomizedSetting['foo']
+    # let's make sure there's no in-Ruby caching going on which could give this
+    # test a false positive
+    assert_not_equal(value.object_id, value_prime.object_id)
+    assert_equal(value_prime.class, WrapperModule::Custom)
+    assert_equal(value_prime.value, 'bar')
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: durable_hash
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Francis Hwang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-29 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: activerecord
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  name: bundler
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id003
+description: Maybe you want something that acts like a hash but is backed by ActiveRecord.
+email: francis.hwang@profitably.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README
+- Rakefile
+- VERSION
+- durable_hash.gemspec
+- init.rb
+- lib/durable_hash.rb
+- test/durable_hash_test.rb
+has_rdoc: true
+homepage: http://github.com/fhwang/durable_hash
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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: Maybe you want something that acts like a hash but is backed by ActiveRecord.
+test_files: []
+