serialist 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,85 @@
+= 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.
+
+=== Before :
+
+  class Article
+    serialize :preferences
+  end
+  
+  >> a = Article.new
+  >> a.preferences = {}
+  >> a.preferences[:key] = "value"
+  >> a.preferences[:key]
+  => "value"
+  
+=== After : 
+
+  class Article
+    serialist :preferences, [:key, :other_key, :yet_another_key]
+  end
+
+  >> a = Article.new
+  >> a.key = "value"
+  >> a.key
+  => "value"
+
+== Install the gem!
+
+  $ sudo gem install serialist
+
+== Try the demo!
+  
+  $ sudo gem install sqlite3-ruby
+  $ rails -m http://gist.github.com/183689.txt serialist-example
+  $ cd serialist-example
+  $ ./script/server
+  $ GoTo localhost:3000 and create an article
+  
+== Serialist comes in 2 flavors:
+
+=== Specific declaration (safe, use define_method)
+
+  serialist :my_serializer_attribute, [: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 = "hello"
+  => "hello"
+  >> a.taz = "hello"
+  => NoMethodError: undefined method `taz=' ...
+  >> 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 (=== find_all_by_title_and_description kind of magic)
+
+    # in your model. my_serializer_attribute is the one you specify in the migration
+
+    serialist :my_serializer_attribute              
+
+  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 = "hello"
+    => "hello"
+    >> a.foo?("hello")
+    => true
+    >> a.foo
+    => "hello"
+    >> a
+    => #<Article id: XX, title: nil, created_at: "..", updated_at: "..", slug: {:foo=>"hello"}>
+
+== Word of caution:
+
+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

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_serializable plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the acts_as_serializable plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsSerializable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "serialist"
+    gemspec.summary = "Serialize any data, set and fetch it like any column attributes"
+    gemspec.description = "Serialize any data, set and fetch it like any column attributes"
+    gemspec.email = "benoit.benezech@gmail.com"
+    gemspec.homepage = "http://github.com/bbenezech/serialist"
+    gemspec.authors = ["Benoit Bénézech"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/serialist.rb

@@ -0,0 +1,79 @@
+# ActsAsSerializable
+module Serialist
+  
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    attr_accessor :serialist_options
+    attr_accessor :serialist_field
+
+    def serialist(serialist_field, serialist_options = [])
+      
+      
+      @serialist_field ||= serialist_field
+      @serialist_options ||= []
+      @serialist_options = (@serialist_options + serialist_options).uniq
+      serialize(@serialist_field, Hash)
+      
+      if serialist_options.empty?
+        include Serialist::InstanceMethods
+      else
+        @serialist_options.each do |field|
+          define_method field.to_s do 
+            return nil unless (slug = self.send(serialist_field))
+            slug[field]
+          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
+            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
+          end
+        end
+      end
+    end
+    
+    def inherited(subclass)
+      super
+      subclass.instance_variable_set("@serialist_field", @serialist_field)
+      subclass.instance_variable_set("@serialist_options", @serialist_options)
+    end
+  end
+  
+  module InstanceMethods
+    def method_missing(method, *args, &block)
+      begin
+        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]
+        end
+      end
+    end
+  end
+end
+
+

data/test/acts_as_serializable_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class ActsAsSerializableTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: serialist
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Benoit B\xC3\xA9n\xC3\xA9zech"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-09 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Serialize any data, set and fetch it like any column attributes
+email: benoit.benezech@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- init.rb
+- install.rb
+- lib/serialist.rb
+- tasks/acts_as_serializable_tasks.rake
+- test/acts_as_serializable_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/bbenezech/serialist
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Serialize any data, set and fetch it like any column attributes
+test_files: 
+- test/acts_as_serializable_test.rb
+- test/test_helper.rb