trick_serial 0.2.0

data/spec/spec_helper.rb

@@ -0,0 +1,76 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'trick_serial'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+=begin
+if $DEBUG || ENV['DEBUG']
+  require 'rubygems'
+  gem 'ruby-debug'
+  require 'ruby-debug'
+end
+=end
+
+RSpec.configure do |config|
+  
+end
+
+######################################################################
+# Common test helpers
+#
+
+module TrickSerial
+  class Serializer
+    module Test
+      class A
+        attr_accessor :x, :y
+      end
+      class B
+        attr_accessor :x, :y
+      end
+      class PhonyActiveRecord
+        attr_accessor :id
+
+        @@find_map = { }
+        def self.find_map
+          @@find_map
+        end
+
+        @@id ||= 0
+        def initialize
+          @id = (@@id += 1)
+        end
+        def self.find(id)
+          obj = new
+          obj.id = id
+          # $stderr.puts "  #{self}.find(#{id.inspect}) => #{obj.inspect}"
+          # (@@find_map[id] ||= 0) += 1 # Shouldn't Ruby parse this?
+          @@find_map[id] ||= 0
+          @@find_map[id] += 1
+          obj
+        end
+
+        def to_s
+          super.sub!(/>$/, " id=#{@id.inspect}>")
+        end
+      end
+      
+      class Model < PhonyActiveRecord
+        attr_accessor :state
+        def initialize x = nil
+          super()
+          @state = x
+        end
+
+        def to_s
+          super.sub!(/>$/, " @state=#{@state.inspect}>")
+        end
+      end
+    end
+  end
+end
+

data/spec/trick_serial/cgi_session_spec.rb

@@ -0,0 +1,169 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+# Test Target:
+require 'trick_serial/serializer/cgi_session'
+
+# Test Helpers:
+require 'cgi'
+require 'cgi/session'
+require 'cgi/session/pstore'
+require 'fileutils'
+require 'stringio'
+
+$have_mem_cache_store = false
+begin
+  require 'action_controller/session/mem_cache_store'
+  require 'trick_serial/serializer/cgi_session'
+  $have_mem_cache_store = true
+rescue Exception => err
+  $stderr.puts "#{__FILE__}: #{err.inspect}\n  #{err.backtrace * "\n  "}"
+end
+
+
+TrickSerial::Serializer::CgiSession.activate!
+
+describe "TrickSerial::Serializer::Cgi::Session" do
+
+  before(:each) do 
+    @s = TrickSerial::Serializer.new
+    @s.class_option_map = { 
+      TrickSerial::Serializer::Test::PhonyActiveRecord => 
+      { :proxy_class => TrickSerial::Serializer::ActiveRecordProxy, },
+    }
+
+    TrickSerial::Serializer::Test::PhonyActiveRecord.find_map.clear
+    
+    @m = TrickSerial::Serializer::Test::Model.new(123)
+    @m_unsaved = TrickSerial::Serializer::Test::Model.new(:unsaved)
+    @m_unsaved.id = nil
+
+    TrickSerial::Serializer.default = @s
+  end
+
+  after(:each) do 
+    TrickSerial::Serializer.default = nil
+  end
+
+
+  attr_accessor :cgi, :session
+
+  def create_session! options
+    @cgi = CGI.new("html4")
+    def @cgi.env_table; @env_table ||= { }; end
+    def @cgi.stdinput; @stdinput ||= StringIO.new; end
+
+    @cgi.stdinput << @header if @header
+
+    yield if block_given?
+
+    options = {
+      'TrickSerial.database_manager' => @store,
+      'database_manager' => TrickSerial::Serializer::CgiSession::Store,
+      'tmpdir' => @tmpdir,
+      'session_id' => 'abc123',
+      'session_key' => '_test',
+      'session_expires' => Time.now + 30 + 30,
+      'prefix' => '_test',
+    }.merge(options)
+    @session = CGI::Session.new(cgi, options)
+  end
+
+  def test_store! store, options = { }
+    @tmpdir = "/tmp/#{File.basename(__FILE__)}-#{$$}"
+    FileUtils.mkdir_p(@tmpdir)
+
+    @store = store
+
+    create_session! options
+
+    @session['a'] = 1
+    @session['b'] = :b
+    @session['c'] = "aksjdfsd"
+    @session['m'] = @m
+    @session['m2'] = @m
+    @session['m_unsaved'] = @m_unsaved
+    @session['ary'] = [ 0, 1, @m, 3, 4, @m ]
+
+    @session.update
+    @session.close
+
+    create_session! options
+
+    fm = TrickSerial::Serializer::Test::PhonyActiveRecord.find_map
+    fm.clear
+    fm[@m.id].should == nil
+
+    @session['a'].should == 1
+    @session['b'].should == :b
+    @session['c'].should == "aksjdfsd"
+
+    fm[@m.id].should == nil
+
+    @session['m'].class.should == @m.class
+    @session['m'].object_id.should_not == @m.object_id
+    @session['m'].id.should == @m.id
+
+    fm[@m.id].should == 1
+
+    @session['m2'].object_id.should == @session['m'].object_id
+
+    fm[@m.id].should == 1
+
+    @session['ary'].class.should == Array
+
+    fm[@m.id].should == 1
+    fm.keys.size.should == 1
+
+  ensure
+    File.unlink(*Dir["#{@tmpdir}/*"])
+    FileUtils.rmdir(@tmpdir)
+  end
+
+  # FileStore can only handle String => String data.
+  it "should handle CGI::Session::FileStore" do
+    test_store! CGI::Session::FileStore
+  end
+
+=begin
+  # MemoryStore is completely transparent
+  it "should handle CGI::Session::MemoryStore" do
+    test_store! CGI::Session::MemoryStore
+  end
+=end
+
+  it "should handle CGI::Session::PStore" do
+    test_store! CGI::Session::PStore
+  end
+
+  if $have_mem_cache_store 
+    it "should handle CGI::Session::MemCacheStore" do
+      begin
+        memcache_pid = nil
+        memcache_port = 45328
+        memcache_host = '127.0.0.1'
+        memcache_args = [ "memcached", 
+                          "-p", memcache_port,
+                          "-l", memcache_host,
+                        ]
+        memcache_args << "-vvv" if $DEBUG
+
+        cache = ::MemCache.new(memcache_host)
+        cache.servers = "#{memcache_host}:#{memcache_port}"
+        session_opts = { 
+          'cache' => cache,
+        }
+        memcache_pid = Process.fork do
+          memcache_args.map!{|e| e.to_s}
+          $stderr.puts "#{__FILE__}: starting memcache #{memcache_args.inspect}" if $DEBUG
+          Process.exec(*memcache_args)
+        end
+        sleep 1
+        test_store! CGI::Session::MemCacheStore, session_opts
+      ensure
+        sleep 1
+        Process.kill(9, memcache_pid) if memcache_pid
+      end
+    end
+  end
+end
+

data/spec/trick_serial/serializer_simple_spec.rb

@@ -0,0 +1,268 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+require 'trick_serial/serializer/simple'
+
+######################################################################
+
+describe "TrickSerial::Serializer::Simple" do
+  def t
+    TrickSerial::Serializer::Test
+  end
+  before(:each) do 
+    @s = TrickSerial::Serializer::Simple.new
+    @s.class_option_map = {
+      t::PhonyActiveRecord => { :proxy_class => TrickSerial::Serializer::ActiveRecordProxy, },
+      t::A => { :instance_vars => true },
+      t::B => { :instance_vars => [ "@x" ] },
+    }
+    TrickSerial::Serializer::Test::PhonyActiveRecord.find_map.clear
+
+    @m = TrickSerial::Serializer::Test::Model.new(123)
+    @m2 = TrickSerial::Serializer::Test::Model.new(456)
+    @m_unsaved = TrickSerial::Serializer::Test::Model.new(:unsaved)
+    @m_unsaved.id = nil
+    @h = {
+      :a => 1,
+      'b' => 2,
+      :obj => Object.new,
+      :m => @m,
+      :a => [ 0, 1, @m, 3, 4, @m ],
+      :m_unsaved => @m_unsaved,
+    }
+    @h[:a2] = @h[:a]
+    @h[:h2] = @h
+  end
+
+  it "should handle #encode!" do
+    @h[:m].should == @m
+    @h[:a][2].should == @m
+
+    result = @s.encode!(@h)
+
+    result.object_id.should == @h.object_id
+  end
+
+  it "should handle #decode!" do
+    @h[:m].should == @m
+    @h[:a][2].should == @m
+
+    result = @s.decode!(@h)
+
+    result.object_id.should == @h.object_id
+  end
+
+  it "should honor #enabled?" do
+    enabled = true
+    @s.enabled = lambda { | | enabled }
+    result = @s.encode(@h)
+    result.object_id.should_not == @h.object_id
+  
+    enabled = false
+    result = @s.encode(@h)
+    result.object_id.should == @h.object_id
+  end
+
+  it "should proxy unsaved models" do
+    @o = @s.encode!(@h)
+    @o = @s.decode!(@o)
+    @o[:m].object_id.should_not == @m.object_id
+    @o[:m].class.should == @m.class
+    @o[:m].id.should == @m.id
+  end
+
+  it "should not proxy unsaved models" do
+    @o = @s.encode!(@h)
+    @o = @s.decode!(@o)
+    @o[:m_unsaved].object_id.should == @m_unsaved.object_id
+  end
+
+  it "should handle encode/decode through Hash#[]" do
+    @s.encode!(@h)
+    @s.decode!(@h)
+    p = @h[:m]
+    # pp [ :p=, p ]
+    p.class.should == @m.class
+  end
+
+  it "should handle encode/decode through Hash#values" do
+    @s.encode!(@h)
+    p = @h.values
+    p.select{|m| @m.class == m.class}.size.should == 1 # one of them is not proxyable.
+
+    @s.decode!(@h)
+    p = @h.values
+    p.select{|m| @m.class == m.class}.size.should == 2
+  end
+
+  it "should handle encode/decode through Array#[]" do
+    @s.encode!(@h)
+    p = @h[:a][2]
+    p.class.should_not == @m.class
+
+    @s.decode!(@h)
+    p = @h[:a][2]
+    p.class.should == @m.class
+  end
+
+  it "should handle encode/decode through Array#each" do
+    @s.encode!(@h)
+    p = @h[:m]
+    a = [ ]
+    @h[:a].each do | e |
+      a << e
+    end
+    a.should == [ 0, 1, p, 3, 4, p ]
+
+    @s.decode!(@h)
+    p = @h[:m]
+    a = [ ]
+    @h[:a].each do | e |
+      a << e
+    end
+    a.should == [ 0, 1, p, 3, 4, p ]
+  end
+
+  it "should handle encode/decode through Array#map" do
+    @s.encode!(@h)
+    @s.decode!(@h)
+    p = @h[:m]
+    a = @h[:a].each { | e | e }
+    a.should == [ 0, 1, p, 3, 4, p ]
+  end
+
+  it "should handle encode/decode through Array#map!" do
+    @s.encode!(@h)
+    @s.decode!(@h)
+    p = @h[:m]
+    a = @h[:a].map! { | e | 1; e }
+    a.should == [ 0, 1, p, 3, 4, p ]
+  end
+
+  it "should handle encode/decode through Array#select" do
+    @s.encode!(@h)
+    @s.decode!(@h)
+    p = @h[:m]
+    a = @h[:a].select { | e | @m.class == e.class }
+    a.should == [ p, p ]
+  end
+
+  it "should handle encode/decode through Array#find" do
+    @s.encode!(@h)
+    @s.decode!(@h)
+    p = @h[:m]
+    a = @h[:a].find { | e | @m.class == e.class }
+    a.should == p
+  end
+
+  it "should lazily traverse proxies" do
+    fm = TrickSerial::Serializer::Test::PhonyActiveRecord.find_map
+
+    fm[@m.id].should == nil
+
+    @s.encode!(@h)
+    @h = Marshal.load(Marshal.dump(@h))
+
+    fm[@m.id].should == nil
+
+    @s.decode!(@h)
+    fm[@m.id].should == 1
+
+    p = @h[:m]
+
+    fm[@m.id].should == 1
+
+    @h[:m].object_id.should == p.object_id
+    @h[:a][2].object_id.should == p.object_id
+    @h[:a][5].object_id.should == p.object_id
+
+    fm[@m.id].should == 1
+    fm.keys.size.should == 1
+  end
+
+  it "should preserve object identity" do
+    @s.encode!(@h)
+    @s.decode!(@h)
+
+    p = @h[:m]
+
+    @h[:m].object_id.should == p.object_id
+    @h[:a2].object_id.should == @h[:a].object_id
+    @h[:a][2].object_id.should == p.object_id
+    @h[:a][5].object_id.should == p.object_id
+  end
+
+  it "should produce a serializable result" do
+    @s.encode!(@h)
+
+    @o = Marshal.load(Marshal.dump(@h))
+    @o = @s.decode!(@o)
+
+    p = @o[:m]
+    p.class.should == @m.class
+
+    @o[:m].object_id.should == p.object_id
+    @o[:a][2].object_id.should == p.object_id
+    @o[:a][5].object_id.should == p.object_id
+    @o[:h2].object_id.should == @o.object_id
+  end
+
+  it "should copy core collections" do
+    @o = @s.encode(@h)
+    @o = @s.decode(@o)
+
+    @o.object_id.should_not == @h.object_id
+    @o[:a].object_id.should_not == @h[:a].object_id
+    @o[:a2].object_id.should == @o[:a].object_id
+
+    @o[:m].object_id.should_not == @h[:m].object_id
+    @o[:h2].object_id.should == @o.object_id
+  end
+
+  it "should honor :instance_vars option" do
+    obj = t::A.new
+    obj.x = @m
+    obj.y = @m
+    obj = @s.encode!(obj)
+    e = Marshal.load(str = Marshal.dump(obj))
+
+    e.class.should == t::A
+    e.instance_variable_get("@x").class.should == TrickSerial::Serializer::ActiveRecordProxy
+    e.instance_variable_get("@y").class.should == TrickSerial::Serializer::ActiveRecordProxy
+
+    @s.verbose = @s.debug = true
+    obj = @s.decode!(e)
+    # $stderr.puts "marshal = #{str.inspect}"
+
+    e.class.should == t::A
+    e.instance_variable_get("@x").class.should == TrickSerial::Serializer::Test::Model
+    e.instance_variable_get("@y").class.should == TrickSerial::Serializer::Test::Model
+    e.x.object_id.should == e.y.object_id
+
+    obj = t::B.new
+    obj.x = @m # should be encoded
+    obj.y = @m # should not be encoded
+    @s.verbose = @s.debug = false
+    obj = @s.encode!(obj)
+    e = Marshal.load(str = Marshal.dump(obj))
+
+    e.class.should == t::B
+    e.instance_variable_get("@x").class.should == TrickSerial::Serializer::ActiveRecordProxy
+    e.instance_variable_get("@y").class.should == TrickSerial::Serializer::Test::Model
+
+    @s.verbose = @s.debug = true
+    obj = @s.decode!(e)
+    # $stderr.puts "marshal = #{str.inspect}"
+
+    e.class.should == t::B
+    e.instance_variable_get("@x").class.should == TrickSerial::Serializer::Test::Model
+    e.x.class.should == @m.class
+    e.instance_variable_get("@y").class.should == TrickSerial::Serializer::Test::Model
+    e.y.class.should == @m.class
+    e.x.id.should == @m.id
+    e.y.id.should == @m.id
+    e.x.object_id.should_not == @m.object_id
+    e.x.object_id.should_not == e.y.object_id
+    e.y.object_id.should_not == @m.object_id
+  end
+
+end