cerealize 0.8.0 → 0.8.1

data/CHANGES

@@ -1,4 +1,23 @@
 = cerealize changes history
 
-=== cerealize 0.8.0, 2010-04-18
- * release early, release often
+== cerealize 0.8.1 -- 2010-07-16
+* module_eval is a lot faster than define_method with a block,
+  I think it's all about closure.
+
+* Now we're creating cerealize methods inside a saperate,
+  this makes it easier to override things, thus doing extension.
+  An example:
+
+    class Dog < ActiveRecord::Base
+      include Cerealize
+
+      cerealize :mood, String
+      def mood
+        "mood: #{super}"
+      end
+    end
+
+  Previously, this would break things. (Please avoid alias_method_chain.)
+
+== cerealize 0.8.0 -- 2010-04-18
+* release early, release often

data/{README → README.rdoc}

@@ -1,32 +1,34 @@
-= cerealize 0.8.0
+= cerealize 0.8.1
 by Cardinal Blue ( http://cardinalblue.com )
 
 == LINKS:
 
-* github[http://github.com/cardinalblue/cerealize]
-* rubygems[http://rubygems.org/gems/cerealize]
+* {github}[http://github.com/cardinalblue/cerealize]
+* {rubygems}[http://rubygems.org/gems/cerealize]
+* {rdoc}[http://rdoc.info/projects/cardinalblue/cerealize]
 
 == DESCRIPTION:
 
-  Serialize out of the Cerealize Box
-  - a drop-in replacement for ActiveRecord's serialize
+ Serialize out of the Cerealize Box
+ - a drop-in replacement for ActiveRecord's serialize
 
-  It can auto transcode old encoding (yaml if you're using AR's serialize),
-  to new encoding (marshal, json, you name it) without any migration.
+ It can auto transcode old encoding (yaml if you're using AR's serialize),
+ to new encoding (marshal, json, you name it) without any migration.
 
-  Current supported encoding:
-  1. YAML
-  2. Marshal
-  3. JSON (planned)
+ Current supported encoding:
+ 1. YAML
+ 2. Marshal
+ 3. JSON (planned)
 
-  Current supported ORM:
-  1. ActiveRecord (tested with 2.3.5)
-  2. DataMapper (planned)
+ Current supported ORM:
+ 1. ActiveRecord (tested with 2.3.5)
+ 2. DataMapper (planned)
 
 == SYNOPSIS:
 
  require 'cerealize'
  class User < ActiveRecord::Base
+   include Cerealize
    # when force_encoding set to false (this is default), cerealize is
    # smart enough to transcode old encoding (e.g. yaml) to new encoding
    # (i.e. marshal)
@@ -40,9 +42,9 @@ by Cardinal Blue ( http://cardinalblue.com )
 
 == INSTALL:
 
-> gem install cerealize
-or
-> script/plugin install git://github.com/cardinalblue/cerealize.git
+ > gem install cerealize
+ # or if you want rails plugin and bleeding edge
+ > script/plugin install git://github.com/cardinalblue/cerealize.git
 
 == LICENSE:
 

data/Rakefile

@@ -17,16 +17,18 @@ Bones{
 
   depend_on 'activerecord',                       :version => '>=2.3.5'
   # depend_on 'activerecord', :development => true, :version => '>=2.3.5'
+  depend_on 'sqlite3-ruby', :development => true
 
   name    proj
   url     "http://github.com/cardinalblue/#{proj}"
-  authors 'Cardinal Blue'
+  authors ['Cardinal Blue', 'Lin Jen-Shin (aka godfat 真常)', 'Jaime Cham']
   email   'dev (XD) cardinalblue.com'
 
   history_file   'CHANGES'
-   readme_file   'README'
+   readme_file   'README.rdoc'
    ignore_file   '.gitignore'
   rdoc.include   ['\w+']
+  rdoc.exclude   ['test', 'doc', 'Rakefile']
 }
 
 CLEAN.include Dir['**/*.rbc']

data/TODO

@@ -1,7 +1,17 @@
 = cerealize todo list
 
-* cleanup test cases... use proper way to setup encoding
-* extract options, instead of hardcoded into method closure (block)
+= ?
+
+* cleanup test cases...
+
+= 1.1+
+
+* json support
+
+= 1.2+
+
 * extract base64 decorator, then we can use pure marshal
+
+= 1.3+
+
 * datamapper support
-* json support

data/bench/simple.rb

@@ -0,0 +1,99 @@
+
+require 'benchmark'
+
+require 'active_record'
+require 'cerealize'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => ':memory:'
+)
+
+[:hats, :cats].each{ |table|
+  ActiveRecord::Base.connection.create_table table, :force => true do |t|
+    t.text :box
+  end
+}
+
+class Hat < ActiveRecord::Base
+  serialize :box, Hash
+end
+
+class Cat < ActiveRecord::Base
+  include Cerealize
+  cerealize :box, Hash
+end
+
+def simple klass
+  box = Hash[(0..300).zip(301..600)]
+  mox = box.invert
+  klass.find(klass.create(:box => box).id).
+        update_attributes(:box => mox)
+end
+
+Times = 100
+
+Benchmark.bmbm{ |bm|
+  bm.report('serialize (build in ActiveRecord)') do
+    Times.times{ simple(Hat) }
+  end
+
+  bm.report('cerealize') do
+    Times.times{ simple(Cat) }
+  end
+}
+
+__END__
+> system_profiler -detailLevel mini | grep -A 15 'Hardware Overview:'
+    Hardware Overview:
+
+      Model Name: MacBook
+      Model Identifier: MacBook2,1
+      Processor Name: Intel Core 2 Duo
+      Processor Speed: 2.16 GHz
+      Number Of Processors: 1
+      Total Number Of Cores: 2
+      L2 Cache: 4 MB
+      Memory: 3 GB
+      Bus Speed: 667 MHz
+      Boot ROM Version: MB21.00A5.B07
+      SMC Version (system): 1.17f0
+      Sudden Motion Sensor:
+          State: Enabled
+
+> uname -a
+Darwin godfat.local 10.3.0 Darwin Kernel Version 10.3.0: Fri Feb 26 11:58:09 PST 2010; root:xnu-1504.3.12~1/RELEASE_I386 i386 i386
+
+> ruby -v
+ruby 1.9.1p378 (2010-01-10 revision 26273) [i386-darwin10]
+
+
+
+
+
+> ruby -I lib bench/simple.rb
+Rehearsal ---------------------------------------------------------------------
+serialize (build in ActiveRecord)   4.050000   0.080000   4.130000 (  4.459223)
+cerealize                           0.810000   0.010000   0.820000 (  1.119697)
+------------------------------------------------------------ total: 4.950000sec
+
+                                        user     system      total        real
+serialize (build in ActiveRecord)   3.870000   0.070000   3.940000 (  4.299835)
+cerealize                           0.690000   0.010000   0.700000 (  0.733006)
+
+
+
+
+
+http://chart.apis.google.com/chart?cht=bvg&chs=350x650&chd=t:85.9967,14.66012&chxl=0:|serialize|cerealize&chxt=x,y&chbh=150&chxr=1,0,5&chma=25
+
+http://code.google.com/apis/chart/docs/chart_playground.html
+
+cht=bvg
+chs=350x650
+chd=t:85.9967,14.66012
+chxl=0:|serialize|cerealize
+chxt=x,y
+chbh=150
+chxr=1,0,5
+chma=25

data/cerealize.gemspec

@@ -0,0 +1,53 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cerealize}
+  s.version = "0.8.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Cardinal Blue", "Lin Jen-Shin (aka godfat 真常)", "Jaime Cham"]
+  s.date = %q{2010-07-16}
+  s.description = %q{ Serialize out of the Cerealize Box
+ - a drop-in replacement for ActiveRecord's serialize
+
+ It can auto transcode old encoding (yaml if you're using AR's serialize),
+ to new encoding (marshal, json, you name it) without any migration.
+
+ Current supported encoding:
+ 1. YAML
+ 2. Marshal
+ 3. JSON (planned)
+
+ Current supported ORM:
+ 1. ActiveRecord (tested with 2.3.5)
+ 2. DataMapper (planned)}
+  s.email = %q{dev (XD) cardinalblue.com}
+  s.extra_rdoc_files = ["CHANGES", "LICENSE", "TODO", "bench/simple.png", "cerealize.gemspec", "slide/2010-04-24-cerealize.key/Contents/PkgInfo", "slide/2010-04-24-cerealize.key/QuickLook/Thumbnail.jpg", "slide/2010-04-24-cerealize.key/background.png", "slide/2010-04-24-cerealize.key/cardinal-blue-black_200.png", "slide/2010-04-24-cerealize.key/cereal-box.png", "slide/2010-04-24-cerealize.key/color-profile", "slide/2010-04-24-cerealize.key/index.apxl.gz", "slide/2010-04-24-cerealize.key/simple.png", "slide/2010-04-24-cerealize.key/thumbs/st0-11.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-16.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-19.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-2.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-22.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-27.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-29.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-30.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-32.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-34.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-38.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-40.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-46.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-50.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-51.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-52.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-54.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-7.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0.tiff", "slide/2010-04-24-cerealize.pdf", "slide/cereal-box.ai", "slide/cereal-box.jpg", "slide/cereal-box.png"]
+  s.files = ["CHANGES", "LICENSE", "README.rdoc", "Rakefile", "TODO", "bench/simple.png", "bench/simple.rb", "cerealize.gemspec", "init.rb", "lib/cerealize.rb", "lib/cerealize/codec/marshal.rb", "lib/cerealize/codec/yaml.rb", "lib/cerealize/version.rb", "slide/2010-04-24-cerealize.key/Contents/PkgInfo", "slide/2010-04-24-cerealize.key/QuickLook/Thumbnail.jpg", "slide/2010-04-24-cerealize.key/background.png", "slide/2010-04-24-cerealize.key/cardinal-blue-black_200.png", "slide/2010-04-24-cerealize.key/cereal-box.png", "slide/2010-04-24-cerealize.key/color-profile", "slide/2010-04-24-cerealize.key/index.apxl.gz", "slide/2010-04-24-cerealize.key/simple.png", "slide/2010-04-24-cerealize.key/thumbs/st0-11.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-16.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-19.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-2.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-22.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-27.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-29.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-30.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-32.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-34.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-38.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-40.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-46.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-50.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-51.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-52.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-54.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0-7.tiff", "slide/2010-04-24-cerealize.key/thumbs/st0.tiff", "slide/2010-04-24-cerealize.pdf", "slide/cereal-box.ai", "slide/cereal-box.jpg", "slide/cereal-box.png", "test/helper.rb", "test/helper_active_record.rb", "test/stub.rb", "test/test_all_codec.rb", "test/test_basic.rb", "test/test_transcode.rb"]
+  s.homepage = %q{http://github.com/cardinalblue/cerealize}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{cerealize}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Serialize out of the Cerealize Box - a drop-in replacement for ActiveRecord's serialize  It can auto transcode old encoding (yaml if you're using AR's serialize), to new encoding (marshal, json, you name it) without any migration}
+  s.test_files = ["test/test_all_codec.rb", "test/test_basic.rb", "test/test_transcode.rb"]
+
+  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>, [">= 2.3.5"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 1.3.1"])
+      s.add_development_dependency(%q<bones>, [">= 3.4.7"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 1.3.1"])
+      s.add_dependency(%q<bones>, [">= 3.4.7"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 1.3.1"])
+    s.add_dependency(%q<bones>, [">= 3.4.7"])
+  end
+end

data/lib/cerealize.rb

@@ -17,20 +17,19 @@ module Cerealize
   #
 
   def self.included(base)
-    base.send :extend, ClassMethods
+    base.send( :extend,    ClassMethods)
+    base.send(:include, InstanceMethods)
   end
 
   module_function
   def codecs
-    @codecs ||= Codec.constants.sort.map{ |codec_name|
-                  Codec.const_get(codec_name)
+    @codecs ||= codec_names.map{ |codec_name|
+                  codec_get(codec_name)
                 }
   end
 
   def codec_names
-    @codec_names ||= codecs.map{ |codec|
-                       codec.to_s.sub(/(\w+::)+/, '').downcase.to_sym
-                     }
+    @codec_names ||= [:yaml, :marshal]
   end
 
   def codec_detect(str)
@@ -59,13 +58,56 @@ module Cerealize
     end
   end
 
+  module InstanceMethods
+    def cerealize_decode property, value
+      opt = self.class.cerealize_option[property]
+      Cerealize.decode( value, opt[:force_encoding] && opt[:codec] )
+    end
+
+    def cerealize_encode property, value
+      opt = self.class.cerealize_option[property]
+      Cerealize.encode( value, opt[:codec] )
+    end
+  end
+
   module ClassMethods
+    def cerealize_option
+      @cerealize_option ||= {}
+    end
 
-    def cerealize property, klass=nil, options={}
-      field_pre   = "@#{property}_pre".to_sym
-      field_cache = "@#{property}".to_sym
-      codec       = Cerealize.codec_get(options[:encoding] || :marshal)
-      force_encoding  = options[:force_encoding]
+    def cerealize_update_codec_cache
+      cerealize_option.each{ |(property, opt)|
+        opt.merge!(:codec => Cerealize.codec_get(opt[:encoding]))
+      }
+    end
+
+    def cerealize property, klass=nil, opt={}
+      opt[:encoding] ||= :marshal
+      cerealize_option[property] =
+        opt.merge(:class => klass,
+                  :codec => Cerealize.codec_get(opt[:encoding]))
+
+      field_orig  = "#{property}_orig"
+      field_cache = "#{property}_cache"
+
+      attr_accessor field_orig
+      private field_orig, "#{field_orig}="
+
+      mod = if const_defined?('CerealizeMethods')
+              const_get('CerealizeMethods')
+            else
+              const_set('CerealizeMethods', Module.new)
+            end
+
+      mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{field_cache}
+          @#{property}
+        end
+
+        def #{field_cache}=(new_value)
+          @#{property} = new_value
+        end
+      RUBY
 
       # Invariants:
       #   - instance_variable_defined?(field_cache)  IFF the READER or WRITER has been called
@@ -74,61 +116,59 @@ module Cerealize
 
       # READER method
       #
-      define_method property do
-        # Rails.logger.debug "#{property} (READER)"
+      mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{property}
+          # Return cached
+          return #{field_cache} if #{field_cache}
 
-        # See if no assignment yet
-        if !instance_variable_defined?(field_cache)
-
-          # Save property if not already saved
-          if !instance_variable_defined?(field_pre)
-            instance_variable_set(field_pre, read_attribute(property))
-          end
+          # No assignment yet, save property if not already saved
+          self.#{field_orig}= self[:#{property}] if !#{field_orig}
 
           # Set cached from pre
-          v = Cerealize.decode(instance_variable_get(field_pre),
-                               force_encoding && codec )
-          raise ActiveRecord::SerializationTypeMismatch, "expected #{klass}, got #{v.class}" \
-            if klass && !v.nil? && !v.kind_of?(klass)
-          instance_variable_set(field_cache, v)
-        end
+          value = cerealize_decode(:#{property}, #{field_orig})
 
-        # Return cached
-        instance_variable_get(field_cache)
-      end
+          raise ActiveRecord::SerializationTypeMismatch, "expected #{klass}, got \#{value.class}" \\
+            if #{klass.inspect} && !value.nil? && !value.kind_of?(#{klass})
+
+          self.#{field_cache} = value
+        end
+      RUBY
 
       # WRITER method
       #
-      define_method "#{property}=" do |v|
-        # Rails.logger.debug "#{property}=#{v}"
-        send "#{property}_will_change!" if instance_variable_get(field_cache) != v
-        instance_variable_set(field_cache, v)
-      end
+      mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{property}=(value)
+          #{property}_will_change! if #{field_cache} != value
+          self.#{field_cache} = value
+        end
+      RUBY
 
       # Callback for before_save
       #
-      define_method "#{property}_update_if_dirty" do
-        # Rails.logger.debug "#{property}_update_if_dirty"
-
-        # See if we have a new cur value
-        if instance_variable_defined?(field_cache)
-          v = instance_variable_get(field_cache)
-          v_enc = Cerealize.encode(v, codec)
-
-          # See if no pre at all (i.e. it was written to before being read),
-          # or if different. When comparing, compare both marshalized string,
-          # and Object ==.
-          #
-          if !instance_variable_defined?(field_pre) ||
-            (v_enc != instance_variable_get(field_pre) &&
-              v != Cerealize.decode(instance_variable_get(field_pre),
-                                    force_encoding && codec ))
-            write_attribute(property, v_enc)
+      mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{property}_update_if_dirty
+          # See if we have a new cur value
+          if #{field_cache}
+            value     = #{field_cache}
+            value_enc = cerealize_encode(:#{property}, value)
+
+            # See if no orig at all (i.e. it was written to before
+            # being read), or if different. When comparing, compare
+            # both marshalized string, and Object ==.
+            #
+            if !#{field_orig} ||
+              (value_enc != #{field_orig} &&
+               value     != cerealize_decode(:#{property}, #{field_orig}))
+              self[:#{property}] = value_enc
+            end
           end
+
+          self.#{field_orig}  = nil
+          self.#{field_cache} = nil
         end
-        remove_instance_variable(field_pre)   if instance_variable_defined?(field_pre)
-        remove_instance_variable(field_cache) if instance_variable_defined?(field_cache)
-      end
+      RUBY
+
+      include mod unless self < mod
       before_save("#{property}_update_if_dirty")
     end
   end