serialist 1.0.0 → 1.1.0

data/README.rdoc

@@ -1,12 +1,15 @@
 = Serialist
 
 Serialize anything. Why waste time migrating your table for yet another dumb attribute you won't search on?
-Add one serializable field in your table, and let serialist do the rest.
+Add one serialization field in your table, and let serialist do the rest : validate and mass_assign all your serialized stuff, transparently.
+Now in version 1.0.0, fully tested.
 
 === Before!
 
   class Article < ActiveRecord::Base
     serialize :preferences
+    # impossible...
+    # validates_presence_of :key
   end
   
   >> a = Article.new
@@ -14,17 +17,25 @@ Add one serializable field in your table, and let serialist do the rest.
   >> a.preferences[:key] = "value"
   >> a.preferences[:key]
   => "value"
+  >> Article.create({:preferences => {:key => "value"}})
+  => #<Article id: ##, preferences: {:key=>"value"}>
   
 === After!
 
   class Article < ActiveRecord::Base
     serialist :preferences, [:key, :other_key, :yet_another_key]
+    validates_presence_of :key
   end
 
   >> a = Article.new
   >> a.key = "value"
   >> a.key
   => "value"
+  >> Article.create!
+  => "key cannot be blank"
+  >> Article.create({:key => "value"})
+  => #<Article id: ##, preferences: {:key=>"value"}>
+  
 
 == Install the gem!
 
@@ -58,15 +69,21 @@ Then hook Serialist into your ActiveRecord model :
   validates_presence_of :bar
   # etc.
   
-== Serialist comes in TWO flavors!
+== Serialist comes in 2 flavors!
 
-=== Specific declaration (safe, use define_method)
+=== Declarative, use define_method as your model load.
 
-  serialist :slug, [:foo, :bar]
+  class Article
+    serialist :slug, [:foo, :bar]
+    validates_presence_of :foo
+  end
+  
 
 Allows you to serialize only the desired keys. ex : 
 
   $ ./script/console
+  >> Article.create!
+  => 'foo cannot be blank'
   >> a = Article.new
   => #<Article id: nil, title: nil, created_at: nil, updated_at: nil, slug: nil>
   >> a.foo?
@@ -82,17 +99,18 @@ Allows you to serialize only the desired keys. ex :
   >> a
   => #<Article id: XX, title: nil, created_at: "..", updated_at: "..", slug: {:foo=>"hello"}>
 
-=== Catch-all with method_missing
-
-You should probably choose to load serialist after your other plugins/gems, because ActiveRecord won't fire NoMethodError anymore on Serialisted models, and some plugin may want to catch it to implement their own auto-magic (aka find_all_by_title_and_description magic)
+=== Catch-all, use define_method lazily at access time (hooked in your model method_missing)
 
-  # in your model. my_serializer_attribute is the one you specify in the migration
-
-  serialist :slug
+  class Article
+    serialist :slug
+    validates_presence_of :foo
+  end
 
 Allows you to serialize anything. ex : 
 
   $ ./script/console
+  >> Article.create!
+  => 'foo cannot be blank'
   >> a = Article.new
   => #<Article id: nil, title: nil, created_at: nil, updated_at: nil, slug: nil>
   >> a.foo
@@ -114,14 +132,14 @@ Allows you to serialize anything. ex :
   >> a
   => #<Article id: XX, title: nil, created_at: "..", updated_at: "..", slug: {:foo=>"hello"}>
 
-== Beware!
+=== But be aware...
 
 # Don't use method#2 with Serialist loaded before other ActiveRecord "automagicians" plugins
 
-# Watch out for conflict with existing attributes and methods!
-
 # And of course don't serialize attributes you may want to search on, or index on, or use with any other database related stuff.
 
+# run the tests with your version of ActiveRecord (tested with rails 2.3.4) (go to the unpacked gem and simply run 'rake', watch for errors. Send a bug report if any, specifying you ActiveRecord or rails version, thanks)
+
 Copyright (c) 2009 Benoit Bénézech, released under the MIT license
 
 http://rubyonrails.org/images/rails.png

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/serialist/serialist_module.rb

@@ -20,26 +20,31 @@ module Serialist
         @serialist_options.each do |field|
           cols = self.columns.map{|c|c.name.to_s}
           raise Exception.new("Column #{field} already exist for #{self.name}") if cols.include?(field.to_s)
-          define_method field.to_s do 
-            return nil unless (slug = self.send(serialist_field))
-            slug[field.to_sym]
-          end
-          define_method field.to_s + "?" do |*param|
-            return false unless (slug = self.send(serialist_field))
-            if param.empty?
-              ![nil, false, "false", :false].include?(slug[field.to_sym])
-            else
-              slug[field.to_sym] == param.first
-            end
-          end
-          define_method field.to_s + "=" do |param|
-            self.send(serialist_field.to_s + "=", Hash.new) unless self.send(serialist_field)
-            self.send(serialist_field)[field.to_sym] = param
-          end
+          define_access_methods(field)
         end
       end
     end
     
+    def define_access_methods(field)
+      serialist_field = self.serialist_field
+      define_method field.to_s do 
+        return nil unless (slug = self.send(serialist_field))
+        slug[field.to_sym]
+      end
+      define_method field.to_s + "?" do |*param|
+        return false unless (slug = self.send(serialist_field))
+        if param.empty?
+          ![nil, false, "false", :false, "0"].include?(slug[field.to_sym])
+        else
+          slug[field.to_sym] == param.first
+        end
+      end
+      define_method field.to_s + "=" do |param|
+        self.send(serialist_field.to_s + "=", Hash.new) unless self.send(serialist_field)
+        self.send(serialist_field)[field.to_sym] = param
+      end
+    end
+    
     def inherited(subclass)
       super
       subclass.instance_variable_set("@serialist_field", @serialist_field)
@@ -53,14 +58,8 @@ module Serialist
       attributes = new_attributes.dup
       attributes.stringify_keys!
       attributes.each do |k, v|
-        unless k.include?("(") || respond_to?(:"#{k}")
-          self.class.send(:define_method, :"#{k}=") do |param|
-            self.send(self.class.serialist_field.to_s + "=", Hash.new) unless self.send(self.class.serialist_field)
-            self.send(self.class.serialist_field)[k.to_sym] = param
-          end
-          self.class.send(:define_method, :"#{k}") do 
-            self.send(self.class.serialist_field)[k.to_sym]
-          end
+        unless k.include?("(") || respond_to?(k)
+          self.class.define_access_methods(k)
         end
       end
       super
@@ -70,20 +69,8 @@ module Serialist
       begin
         super
       rescue NoMethodError
-        slug = self.send(self.class.serialist_field)
-        case method.to_s.last
-        when "?"
-          if args.empty?
-            slug && ![nil, false, "false", :false].include?(slug[method.to_s[0..-2].to_sym])
-          else
-            slug && (slug[method.to_s[0..-2].to_sym] == args.first)
-          end
-        when "="
-          self.send(self.class.serialist_field.to_s + "=", Hash.new) unless slug
-          self.send(self.class.serialist_field)[method.to_s[0..-2].to_sym] = args.first
-        else
-          slug && slug[method.to_sym]
-        end
+        self.class.define_access_methods(method.to_s.chomp("=").chomp("?"))
+        self.send(method, *args, &block)
       end
     end
   end

data/serialist.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{serialist}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Benoit B\303\251n\303\251zech"]
-  s.date = %q{2009-10-27}
+  s.date = %q{2009-10-29}
   s.description = %q{Serialize any data, set and fetch it like any column attributes}
   s.email = %q{benoit.benezech@gmail.com}
   s.extra_rdoc_files = [
@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
     "MIT-LICENSE",
      "README.rdoc",
      "Rakefile",
-     "TODO.txt",
      "VERSION",
      "generators/serialist/serialist_generator.rb",
      "generators/serialist/templates/USAGE",
@@ -32,6 +31,7 @@ Gem::Specification.new do |s|
      "rails/init.rb",
      "serialist.gemspec",
      "tasks/acts_as_serializable_tasks.rake",
+     "test/serialist_test.rb",
      "uninstall.rb"
   ]
   s.homepage = %q{http://github.com/bbenezech/serialist}

data/test/serialist_test.rb

@@ -86,6 +86,13 @@ class SerialistTest < Test::Unit::TestCase
     @serialisted.save
     @serialisted.reload
     assert_equal @serialisted.foo, "foo2"
+    @serialisted.baz = "baz"
+    @serialisted.save
+    @serialisted.reload
+    assert_equal @serialisted.baz, "baz"
+    assert_equal @serialisted.baz?, true
+    assert_equal @serialisted.baz?("baz"), true
+    assert_equal @serialisted.baz?("bar"), false
     @serialisted.bar = nil
     @serialisted.save
     @serialisted.reload

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: serialist
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - "Benoit B\xC3\xA9n\xC3\xA9zech"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-27 00:00:00 +01:00
+date: 2009-10-29 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -25,7 +25,6 @@ files:
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
-- TODO.txt
 - VERSION
 - generators/serialist/serialist_generator.rb
 - generators/serialist/templates/USAGE
@@ -38,6 +37,7 @@ files:
 - rails/init.rb
 - serialist.gemspec
 - tasks/acts_as_serializable_tasks.rake
+- test/serialist_test.rb
 - uninstall.rb
 has_rdoc: true
 homepage: http://github.com/bbenezech/serialist

data/TODO.txt

@@ -1 +0,0 @@
-* tests