serialist 0.4.0 → 0.5.0

data/README.rdoc

@@ -3,7 +3,7 @@
 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.
 
-=== Before :
+=== Before!
 
   class Article < ActiveRecord::Base
     serialize :preferences
@@ -15,7 +15,7 @@ Add one serializable field in your table, and let serialist do the rest.
   >> a.preferences[:key]
   => "value"
   
-=== After : 
+=== After!
 
   class Article < ActiveRecord::Base
     serialist :preferences, [:key, :other_key, :yet_another_key]
@@ -33,17 +33,19 @@ Add one serializable field in your table, and let serialist do the rest.
 == Try the demo!
   
   $ sudo gem install sqlite3-ruby
-  $ rails -m http://gist.github.com/183689.txt serialist-example
+  $ rails -m http://github.com/bbenezech/serialist/raw/master/installation-template.txt serialist-example
   $ cd serialist-example
   $ ./script/server
-  $ GoTo localhost:3000 and create an article
+  open localhost:3000 and create an article
   
-== Or generate a migration for your existing programm
+== Or simply generate a migration for your existing rails app!
 
 ./script/generate serialist SerialistMigration MyModel my_serialist_attribute
+
 Ex : 
 
   ./script/generate serialist SerialistMigration Article slug
+  rake db:migrate
   
 Then hook Serialist into your ActiveRecord model : 
 
@@ -56,19 +58,25 @@ Then hook Serialist into your ActiveRecord model :
   validates_presence_of :bar
   # etc.
   
-== Serialist comes in 2 flavors:
+== Serialist comes in TWO flavors!
 
 === Specific declaration (safe, use define_method)
 
-  serialist :my_serializer_attribute, [:foo, :bar]
+  serialist :slug, [:foo, :bar]
 
 Allows you to serialize only the desired keys. ex : 
 
   $ ./script/console
   >> a = Article.new
   => #<Article id: nil, title: nil, created_at: nil, updated_at: nil, slug: nil>
+  >> a.foo?
+  => false
+  >> a.foo
+  => nil
   >> a.foo = "hello"
   => "hello"
+  >> a.foo?
+  => true
   >> a.taz = "hello"
   => NoMethodError: undefined method `taz=' ...
   >> a
@@ -76,30 +84,44 @@ Allows you to serialize only the desired keys. ex :
 
 === 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 (=== find_all_by_title_and_description kind of magic)
+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)
 
   # in your model. my_serializer_attribute is the one you specify in the migration
 
-  serialist :my_serializer_attribute              
+  serialist :slug
 
 Allows you to serialize anything. ex : 
 
   $ ./script/console
   >> a = Article.new
   => #<Article id: nil, title: nil, created_at: nil, updated_at: nil, slug: nil>
+  >> a.foo
+  => nil
+  >> a.foo?
+  => false
   >> a.foo = "hello"
   => "hello"
   >> a.foo?("hello")
   => true
+  >> a.foo?
+  => true
   >> a.foo
   => "hello"
+  >> a.baz?
+  => false
+  >> a.baz
+  => nil
   >> a
   => #<Article id: XX, title: nil, created_at: "..", updated_at: "..", slug: {:foo=>"hello"}>
 
-It's not a pure method_missing anyway, I cheated a bit, I use on-demand define_method before mass-assignements.
+== Beware!
+
+# Don't use method#2 with Serialist loaded before other ActiveRecord "automagicians" plugins
+
+# Watch out for conflict with existing attributes and methods!
 
-== Word of caution:
+# And of course don't serialize attributes you may want to search on, or index on, or use with any other database related stuff.
 
-Other than the specific notice about not using method1 with Serialist loaded before other ActiveRecord "automagicians" plugins, watch out for conflict with existing attributes and methods!
+Copyright (c) 2009 Benoit Bénézech, released under the MIT license
 
-Copyright (c) 2009 Benoit Bénézech, released under the MIT license
+http://rubyonrails.org/images/rails.png

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/serialist/serialist_module.rb

@@ -20,19 +20,19 @@ module Serialist
         @serialist_options.each do |field|
           define_method field.to_s do 
             return nil unless (slug = self.send(serialist_field))
-            slug[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])
             else
-              slug[field] == param.first
+              slug[field.to_sym] == param.first
             end
           end
           define_method field.to_s + "=" do |param|
             update_attribute(serialist_field, Hash.new) unless self.send(serialist_field)
-            self.send(serialist_field)[field] = param
+            self.send(serialist_field)[field.to_sym] = param
           end
         end
       end
@@ -55,7 +55,7 @@ module Serialist
         unless k.include?("(") || respond_to?(:"#{k}=")
           self.class.send(:define_method, :"#{k}=") do |param|
             update_attribute(self.class.serialist_field, Hash.new) unless self.send(self.class.serialist_field)
-            self.send(self.class.serialist_field)[k] = param
+            self.send(self.class.serialist_field)[k.to_sym] = param
           end
         end
       end
@@ -67,22 +67,19 @@ module Serialist
         super
       rescue NoMethodError
         slug = self.send(self.class.serialist_field)
-        
         case method.to_s.last
         when "?"
           slug && slug[method.to_s[0..-2].to_sym] == (args && args.first || "true")
-          
           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 "="
           update_attribute(self.class.serialist_field, Hash.new) unless slug
           self.send(self.class.serialist_field)[method.to_s[0..-2].to_sym] = args.first
         else
-          slug && slug[method]
+          slug && slug[method.to_sym]
         end
       end
     end

data/serialist.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{serialist}
-  s.version = "0.4.0"
+  s.version = "0.5.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-09-09}
+  s.date = %q{2009-09-16}
   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 = [
@@ -39,7 +39,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/bbenezech/serialist}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.4}
   s.summary = %q{Serialize any data, set and fetch it like any column attributes}
   s.test_files = [
     "test/acts_as_serializable_test.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: serialist
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - "Benoit B\xC3\xA9n\xC3\xA9zech"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-09 00:00:00 +02:00
+date: 2009-09-16 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -65,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
 summary: Serialize any data, set and fetch it like any column attributes