cerealize 0.8.1 → 0.8.2

data/CHANGES

@@ -1,5 +1,25 @@
 = cerealize changes history
 
+== cerealize 0.8.2 -- 2010-08-04
+* Added attr_hash feature, create virtual properties inside a hash.
+  An example:
+
+    require 'cerealize'
+
+    class User < ActiveRecord::Base
+      include Cerealize
+      cerealize :data
+      attr_hash :data, [:name, :mail]
+    end
+
+    user = User.new
+    user.name = 'ham'
+
+    # which is equivalent to:
+
+    user.data ||= {}
+    user.data[:name] = 'ham'
+
 == 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.

data/README

@@ -0,0 +1,77 @@
+= cerealize 0.8.2
+by Cardinal Blue ( http://cardinalblue.com )
+
+== LINKS:
+
+* {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
+
+ 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)
+
+== 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)
+   cerealize :data, Hash, :encoding => :marshal, :force_encoding => false
+
+   # and this could create accessors for values store in the hash
+   attr_hash :data, [:name, :mail]
+
+   # which makes below two equivalent:
+
+   # user.name = 'ham'
+
+   # which is equivalent to:
+
+   # user.data ||= {}
+   # user.data[:name] = 'ham'
+ end
+
+== REQUIREMENTS:
+
+* tested with MRI 1.8.7 and 1.9.1
+* one of your desired ORM
+
+== INSTALL:
+
+ > gem install cerealize
+ # or if you want rails plugin and bleeding edge
+ > script/plugin install git://github.com/cardinalblue/cerealize.git
+
+== LICENSE:
+
+  Apache License 2.0
+
+  Copyright (c) 2010, Cardinal Blue
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.

data/README.rdoc

@@ -1,4 +1,4 @@
-= cerealize 0.8.1
+= cerealize 0.8.2
 by Cardinal Blue ( http://cardinalblue.com )
 
 == LINKS:
@@ -33,6 +33,18 @@ by Cardinal Blue ( http://cardinalblue.com )
    # smart enough to transcode old encoding (e.g. yaml) to new encoding
    # (i.e. marshal)
    cerealize :data, Hash, :encoding => :marshal, :force_encoding => false
+
+   # and this could create accessors for values store in the hash
+   attr_hash :data, [:name, :mail]
+
+   # which makes below two equivalent:
+
+   # user.name = 'ham'
+
+   # which is equivalent to:
+
+   # user.data ||= {}
+   # user.data[:name] = 'ham'
  end
 
 == REQUIREMENTS:

data/Rakefile

@@ -25,10 +25,10 @@ Bones{
   email   'dev (XD) cardinalblue.com'
 
   history_file   'CHANGES'
-   readme_file   'README.rdoc'
+   readme_file   'README'
    ignore_file   '.gitignore'
   rdoc.include   ['\w+']
-  rdoc.exclude   ['test', 'doc', 'Rakefile']
+  rdoc.exclude   ['test', 'doc', 'Rakefile', 'slide']
 }
 
 CLEAN.include Dir['**/*.rbc']

data/cerealize.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
 
   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.date = %q{2010-08-04}
   s.description = %q{ Serialize out of the Cerealize Box
  - a drop-in replacement for ActiveRecord's serialize
 
@@ -22,15 +22,15 @@ Gem::Specification.new do |s|
  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.extra_rdoc_files = ["CHANGES", "LICENSE", "README", "TODO", "bench/simple.png", "cerealize.gemspec"]
+  s.files = ["CHANGES", "LICENSE", "README", "README.rdoc", "Rakefile", "TODO", "bench/simple.png", "bench/simple.rb", "cerealize.gemspec", "init.rb", "lib/cerealize.rb", "lib/cerealize/attr_hash.rb", "lib/cerealize/codec/marshal.rb", "lib/cerealize/codec/yaml.rb", "lib/cerealize/version.rb", "test/common.rb", "test/real.rb", "test/stub.rb", "test/test_all_codec.rb", "test/test_attr_hash.rb", "test/test_basic.rb", "test/test_transcode.rb"]
   s.homepage = %q{http://github.com/cardinalblue/cerealize}
-  s.rdoc_options = ["--main", "README.rdoc"]
+  s.rdoc_options = ["--main", "README"]
   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"]
+  s.test_files = ["test/test_all_codec.rb", "test/test_attr_hash.rb", "test/test_basic.rb", "test/test_transcode.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/cerealize.rb

@@ -1,9 +1,13 @@
 # encoding: utf-8
 
+require 'cerealize/attr_hash'
+
 require 'active_record'
 autoload :YAML, 'yaml'
 
 module Cerealize
+  InternalName = 'CerealizeMethods'
+
   module Codec
     autoload 'Yaml',    'cerealize/codec/yaml'
     autoload 'Marshal', 'cerealize/codec/marshal'
@@ -93,10 +97,10 @@ module Cerealize
       attr_accessor field_orig
       private field_orig, "#{field_orig}="
 
-      mod = if const_defined?('CerealizeMethods')
-              const_get('CerealizeMethods')
+      mod = if const_defined?(Cerealize::InternalName)
+              const_get(Cerealize::InternalName)
             else
-              const_set('CerealizeMethods', Module.new)
+              const_set(Cerealize::InternalName, Module.new)
             end
 
       mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1

data/lib/cerealize/attr_hash.rb

@@ -0,0 +1,32 @@
+
+module Cerealize
+  module ClassMethods
+    def attr_hash property, attrs
+      ruby = attrs.inject([]){ |codes, attr|
+        codes << <<-RUBY
+          def #{attr}
+            if #{property}
+              #{property}[:#{attr}]
+            else
+              nil
+            end
+          end
+
+          def #{attr}= value
+            self.#{property} ||= {}
+            #{property}[:#{attr}] = value
+          end
+        RUBY
+      }.join("\n")
+
+      mod = if const_defined?(Cerealize::InternalName)
+              const_get(Cerealize::InternalName)
+            else
+              const_set(Cerealize::InternalName, Module.new)
+            end
+
+      mod.module_eval ruby
+      include mod unless self < mod
+    end
+  end
+end

data/lib/cerealize/version.rb

@@ -1,4 +1,4 @@
 
 module Cerealize
-  VERSION = '0.8.1'
+  VERSION = '0.8.2'
 end

data/test/{helper.rb → common.rb}

@@ -1,5 +1,13 @@
 # encoding: utf-8
 
+require 'rubygems' if RUBY_VERSION < '1.9.1'
+require 'cerealize'
+
+require_relative 'stub'
+require_relative 'real'
+
+require 'test/unit'
+
 def set_encoding(encoding)
   Boat.cerealize_option[:captain] = {:class    => nil,
                                      :encoding => encoding}

data/test/{helper_active_record.rb → real.rb}

@@ -5,6 +5,8 @@ ActiveRecord::Base.establish_connection(
   :database => ':memory:'
 )
 
+# ===================================================================
+
 class Boat < ActiveRecord::Base
   include Cerealize
   cerealize :captain
@@ -18,7 +20,7 @@ ActiveRecord::Base.connection.create_table :boats, :force => true do |t|
   t.string  :cargo
 end
 
-
+# ===================================================================
 
 class Cat < ActiveRecord::Base
   include Cerealize
@@ -33,7 +35,7 @@ ActiveRecord::Base.connection.create_table :cats, :force => true do |t|
   t.text :food
 end
 
-
+# ===================================================================
 
 class Dog < ActiveRecord::Base
   include Cerealize
@@ -47,3 +49,15 @@ end
 ActiveRecord::Base.connection.create_table :dogs, :force => true do |t|
   t.text :mood
 end
+
+# ===================================================================
+
+class Apple < ActiveRecord::Base
+  include Cerealize
+  cerealize :data
+  attr_hash :data, [:name, :size]
+end
+
+ActiveRecord::Base.connection.create_table :apples, :force => true do |t|
+  t.text :data
+end

data/test/test_all_codec.rb

@@ -1,13 +1,12 @@
 # encoding: utf-8
 
-require 'rubygems' if RUBY_VERSION < '1.9.1'
-require 'cerealize'
-
-require 'test/stub'
-require 'test/helper'
-require 'test/helper_active_record'
+unless respond_to?(:require_relative, true)
+  def require_relative path
+    require "#{File.dirname(__FILE__)}/#{path}"
+  end
+end
 
-require 'test/unit'
+require_relative 'common'
 
 class AllCodecTest < Test::Unit::TestCase
   def setup

data/test/test_attr_hash.rb

@@ -0,0 +1,33 @@
+
+unless respond_to?(:require_relative, true)
+  def require_relative path
+    require "#{File.dirname(__FILE__)}/#{path}"
+  end
+end
+
+require_relative 'common'
+
+class AttrHashTest < Test::Unit::TestCase
+  def test_simple
+    hh = {:name => 'wane', :size => 123456}
+    ah = Apple.new(hh)
+
+    simple_case(hh, ah)
+
+    ah.name  , ah.size   = ah.size  , ah.name
+    hh[:name], hh[:size] = hh[:size], hh[:name]
+
+    simple_case(hh, ah)
+  end
+
+  def test_nil
+    assert_nil Apple.new.name
+    assert_nil Apple.new.data
+  end
+
+  def simple_case hh, ah
+    assert_equal hh[:name], ah.name
+    assert_equal hh[:size], ah.size
+    assert_equal hh       , ah.data
+  end
+end

data/test/test_basic.rb

@@ -1,13 +1,12 @@
 # encoding: utf-8
 
-require 'rubygems' if RUBY_VERSION < '1.9.1'
-require 'cerealize'
-
-require 'test/stub'
-require 'test/helper'
-require 'test/helper_active_record'
+unless respond_to?(:require_relative, true)
+  def require_relative path
+    require "#{File.dirname(__FILE__)}/#{path}"
+  end
+end
 
-require 'test/unit'
+require_relative 'common'
 
 class BasicTest < Test::Unit::TestCase
   def setup

data/test/test_transcode.rb

@@ -1,13 +1,12 @@
 # encoding: utf-8
 
-require 'rubygems' if RUBY_VERSION < '1.9.1'
-require 'cerealize'
-
-require 'test/stub'
-require 'test/helper'
-require 'test/helper_active_record'
+unless respond_to?(:require_relative, true)
+  def require_relative path
+    require "#{File.dirname(__FILE__)}/#{path}"
+  end
+end
 
-require 'test/unit'
+require_relative 'common'
 
 class TranscodeTest < Test::Unit::TestCase
   def setup

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cerealize
 version: !ruby/object:Gem::Version 
-  hash: 61
+  hash: 59
   prerelease: false
   segments: 
   - 0
   - 8
-  - 1
-  version: 0.8.1
+  - 2
+  version: 0.8.2
 platform: ruby
 authors: 
 - Cardinal Blue
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-16 00:00:00 +08:00
+date: 2010-08-04 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -77,43 +77,14 @@ extensions: []
 extra_rdoc_files: 
 - CHANGES
 - LICENSE
+- README
 - 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
 files: 
 - CHANGES
 - LICENSE
+- README
 - README.rdoc
 - Rakefile
 - TODO
@@ -122,44 +93,15 @@ files:
 - cerealize.gemspec
 - init.rb
 - lib/cerealize.rb
+- lib/cerealize/attr_hash.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/common.rb
+- test/real.rb
 - test/stub.rb
 - test/test_all_codec.rb
+- test/test_attr_hash.rb
 - test/test_basic.rb
 - test/test_transcode.rb
 has_rdoc: true
@@ -169,7 +111,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --main
-- README.rdoc
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -199,5 +141,6 @@ specification_version: 3
 summary: 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
 test_files: 
 - test/test_all_codec.rb
+- test/test_attr_hash.rb
 - test/test_basic.rb
 - test/test_transcode.rb