store_configurable 3.2.4 → 3.2.5

data/CHANGELOG

@@ -1,4 +1,9 @@
 
+= 3.2.5
+
+* Bypass ActiveRecord forcing all serialized attributes be saved.
+
+
 = 3.2.4
 
 * The loader will just not send to key names but always use :[] and :[]= for safety.

data/README.md

@@ -1,7 +1,7 @@
 
 # StoreConfigurable
 
-A zero-configuration recursive Hash for storing a tree of options in a serialized ActiveRecord column. Includes self aware hooks that delegate dirty/changed state to your configs owner.
+A zero-configuration recursive Hash for storing a tree of options in a serialized ActiveRecord column. Includes self aware hooks that delegate dirty/changed state to your configs owner. Read my article [*A Lesson In Recursion In Ruby*](http://metaskills.net/2012/03/12/store-configurable-a-lesson-in-recursion-in-ruby/) if you are interested in how this library works.
 
 <img src="http://cdn.actionmoniker.com/share/recursive_kitty_small.jpg" alt="Recursive Github Kitty" width="260" height="160" style="float:right; margin:-20px 35px 15px 15px; background-color:#fff; padding:13px; -moz-box-shadow: 5px 5px 5px rgba(0,0,0,0.5); -webkit-box-shadow: 5px 5px 5px rgba(0,0,0,0.5); box-shadow: 5px 5px 5px rgba(0,0,0,0.5); -moz-transform: rotate(-2deg); -webkit-transform: rotate(-2deg); transform: rotate(-2deg);">
 
@@ -18,7 +18,7 @@ gem 'store_configurable', '~> 3.2.0'
 
 ## Setup
 
-To use StoreConfigurable, you must create create a `_config` colun in the model's table. Make sure that you declare this column as a text type, so there's plenty of room.
+To use StoreConfigurable, you must create a `_config` column in the model's table. Make sure that you declare this column as a text type, so there's plenty of room.
 
 ```ruby
 class AddStoreConfigurableField < ActiveRecord::Migration
@@ -115,6 +115,15 @@ StoreConfigurable persists your configuration data in YAML format to the `_confi
             - :this: deep_value
 ```
 
+## Todo
+
+* Incorporate an option to compress serialized data. Gzip, [MessagePack](http://msgpack.org/), Etc...
+
+
+## Other Solutions
+
+* [StoreField](https://github.com/kenn/store_field) - Similar approach but no dirty tracking and still requires manual key configs.
+
 
 ## License
 

data/lib/store_configurable/read.rb

@@ -1,6 +1,6 @@
 module StoreConfigurable
   module Read
-    
+
     # Our main syntatic interface to the underlying +_config+ store. This method ensures that 
     # +self+, the store's owner, will allways be set in the config object. Hence allowing all 
     # other recursive options to get a handle back to the owner.
@@ -55,6 +55,12 @@ module StoreConfigurable
       config
       super
     end
+
+    # We never want the `_config` key in the list of attributes. This keeps practically keeps
+    # ActiveRecord from always saving this serialized column too
+    def attributes
+      super.tap { |x| x.delete('_config') }
+    end
     
   end
 end

data/lib/store_configurable/version.rb

@@ -1,6 +1,6 @@
 module StoreConfigurable
   
   # We track ActiveRecord's major and minor version and follow semantic versioning.
-  VERSION = '3.2.4'
+  VERSION = '3.2.5'
   
 end

data/test/cases/base_test.rb

@@ -46,7 +46,7 @@ class StoreConfigurable::BaseTest < StoreConfigurable::TestCase
     user_ken.config[:sortable_tables][:column].must_equal 'updated_at'
   end
   
-  it 'must be mark owner as dirty after missing getter since that inits a new namespace' do
+  it 'must mark owner as dirty after missing getter since that inits a new namespace' do
     user_ken.config.bar
     user_ken.must_be :config_changed?
   end
@@ -78,9 +78,22 @@ class StoreConfigurable::BaseTest < StoreConfigurable::TestCase
       user_ken.save!
       @user = User.find(user_ken.id)
     end
-    
+
     it 'wont be dirty after loading' do
       @user.wont_be :config_changed?
+      @user.wont_be :changed?
+    end
+
+    it 'does not update the _config column when not dirty, bypassing ActiveRecords always save serialized columns' do
+      assert_queries(0) { @user.save! }
+    end
+
+    it 'allows the dirty _config value to be persisted' do
+      new_color = '#f1f1f1'
+      @user.config.color = new_color
+      @user.must_be :changed?
+      assert_queries(1) { @user.save! }
+      User.find(@user.id).config.color.must_equal new_color
     end
     
     it 'can reconsitute saved values' do

data/test/helper.rb

@@ -1,9 +1,10 @@
 require 'rubygems'
 require 'bundler'
-require "bundler/setup"
+require 'bundler/setup'
 Bundler.require
 require 'store_configurable'
 require 'active_record/base'
+require 'support/activerecord'
 require 'minitest/autorun'
 require 'logger'
 
@@ -14,11 +15,14 @@ ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':me
 
 module StoreConfigurable
   class TestCase < MiniTest::Spec
+
+    include ActiveRecordTestHelper
     
     before { setup_environment }
     
     let(:new_user) { User.new }
     let(:user_ken) { User.find_by_email('ken@metaskills.net') }
+    let(:post_sc)  { Post.find_by_title('StoreConfigurable') }
     
     def setup_environment
       setup_database
@@ -34,12 +38,16 @@ module StoreConfigurable
             t.string  :name, :email
             t.text    :_config
           end
+          connection.create_table :posts, :force => true do |t|
+            t.string  :title, :body
+          end
         end
       end
     end
     
     def setup_data
       User.create :name => 'Ken Collins', :email => 'ken@metaskills.net'
+      Post.create :title => 'StoreConfigurable', :body => 'test'
     end
     
   end
@@ -54,3 +62,6 @@ end
 class User < ActiveRecord::Base
   store_configurable
 end
+
+class Post < ActiveRecord::Base  
+end

data/test/support/activerecord.rb

@@ -0,0 +1,51 @@
+module StoreConfigurable
+  module ActiveRecordTestHelper
+
+    protected
+
+    class SQLCounter
+      
+      class << self
+        attr_accessor :ignored_sql, :log
+      end
+
+      self.log = []
+      self.ignored_sql = [/^PRAGMA (?!(table_info))/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SAVEPOINT/, /^ROLLBACK TO SAVEPOINT/, /^RELEASE SAVEPOINT/, /^SHOW max_identifier_length/, /^BEGIN/i, /^COMMIT/i]
+
+      attr_reader :ignore
+
+      def initialize(ignore = Regexp.union(self.class.ignored_sql))
+        @ignore = ignore
+      end
+
+      def call(name, start, finish, message_id, values)
+        sql = values[:sql]
+        return if 'CACHE' == values[:name] || ignore =~ sql
+        self.class.log << sql
+      end
+      
+    end
+
+    def assert_sql(*patterns_to_match)
+      SQLCounter.log = []
+      yield
+      SQLCounter.log
+    ensure
+      failed_patterns = []
+      patterns_to_match.each do |pattern|
+        failed_patterns << pattern unless SQLCounter.log.any?{ |sql| pattern === sql }
+      end
+      assert failed_patterns.empty?, "Query pattern(s) #{failed_patterns.map{ |p| p.inspect }.join(', ')} not found.#{SQLCounter.log.size == 0 ? '' : "\nQueries:\n#{SQLCounter.log.join("\n")}"}"
+    end
+
+    def assert_queries(num = 1)
+      SQLCounter.log = []
+      yield
+    ensure
+      assert_equal num, SQLCounter.log.size, "#{SQLCounter.log.size} instead of #{num} queries were executed.#{SQLCounter.log.size == 0 ? '' : "\nQueries:\n#{SQLCounter.log.join("\n")}"}"
+    end
+
+    ActiveSupport::Notifications.subscribe 'sql.active_record', SQLCounter.new
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: store_configurable
 version: !ruby/object:Gem::Version
-  version: 3.2.4
+  version: 3.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-01 00:00:00.000000000 Z
+date: 2012-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70330795216880 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70330795216880
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70330795216380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70330795216380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70330795215920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70330795215920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70330795215420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +69,12 @@ dependencies:
         version: 2.8.1
   type: :development
   prerelease: false
-  version_requirements: *70330795215420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.1
 description: Grown up ActiveRecord::Store config options!
 email:
 - ken@metaskills.net
@@ -78,6 +98,7 @@ files:
 - lib/store_configurable/version.rb
 - test/cases/base_test.rb
 - test/helper.rb
+- test/support/activerecord.rb
 homepage: http://github.com/metaskills/store_configurable/
 licenses: []
 post_install_message: 
@@ -99,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A zero-configuration recursive Hash for storing a tree of options in a serialized
@@ -107,3 +128,5 @@ summary: A zero-configuration recursive Hash for storing a tree of options in a
 test_files:
 - test/cases/base_test.rb
 - test/helper.rb
+- test/support/activerecord.rb
+has_rdoc: