serialize_with_coder 0.1.0

data/lib/coders/csv_coder.rb

@@ -0,0 +1,13 @@
+module SerializeWithCoder
+
+  class CSVCoder
+    def load(data)
+      data.to_s.split(',')
+    end
+
+    def dump(obj)
+      obj.to_a.join(',')
+    end
+  end
+
+end

data/lib/coders/json_coder.rb

@@ -0,0 +1,15 @@
+require 'json'
+
+module SerializeWithCoder
+
+  class JSONCoder
+    def load(data)
+      JSON.parse(data) rescue nil
+    end
+
+    def dump(obj)
+      obj.to_json rescue nil
+    end
+  end
+
+end

data/lib/serialize_with_coder.rb

@@ -0,0 +1,68 @@
+module SerializeWithCoder
+
+  module ClassMethods
+
+    def serialize_with_coder(attr_name, class_name)
+      self.class_eval do
+        @@serialized_with_coder_fields ||= {}
+        @@serialized_with_coder_fields.merge!(
+          attr_name => class_name
+        )
+
+        before_save :synchronize_serialized_fields
+
+        define_method("reload_serialized_fields") do
+          @@serialized_with_coder_fields.each do |column, coder|
+            instance_variable_set("@#{column}", nil)
+          end
+        end
+
+        define_method("reload") do |*options|
+          reload_serialized_fields
+          super(options)
+        end
+      end
+
+      if column_names.include?(attr_name.to_s)
+        self.class_eval do
+          define_method("#{attr_name}=") do |val|
+            instance_variable_set("@#{attr_name}", val)
+          end
+
+          define_method(attr_name) do
+            instance_variable_get("@#{attr_name}") ?
+              instance_variable_get("@#{attr_name}") :
+              instance_variable_set("@#{attr_name}", class_name.load( read_attribute(attr_name) ))
+          end
+
+          define_method("#{attr_name}_changed?") do
+            class_name.load( read_attribute(attr_name) ) != send(attr_name)
+          end
+        end
+      else
+        raise "There is no column named #{attr_name}!"
+      end
+
+      define_method("attribute_for_inspect") do |attr_name|
+        value = @@serialized_with_coder_fields[attr_name.to_sym] ?
+          send(attr_name) :
+          read_attribute(attr_name)
+
+        if value.is_a?(String) && value.length > 50
+          "#{value[0..50]}...".inspect
+        elsif value.is_a?(Date) || value.is_a?(Time)
+          %("#{value.to_s(:db)}")
+        else
+          value.inspect
+        end
+      end
+
+      define_method("synchronize_serialized_fields") do
+        @@serialized_with_coder_fields.each do |column, coder|
+          write_attribute(column, coder.dump( instance_variable_get("@#{column}") )) if send("#{column}_changed?")
+        end
+      end
+
+    end
+  end
+end

data/test/serialize_with_coder_test.rb

@@ -0,0 +1,101 @@
+require 'test_helper'
+
+class User < ActiveRecord::Base
+
+  serialize_with_coder :newsletters, SerializeWithCoder::CSVCoder.new
+  serialize_with_coder :notes,       SerializeWithCoder::JSONCoder.new
+
+  def inspect
+    attributes_as_nice_string = self.class.column_names.collect { |name|
+      if has_attribute?(name)
+        "#{name}: #{attribute_for_inspect(name)}"
+      end
+    }.compact.join(", ")
+    "#<#{self.class} #{attributes_as_nice_string}>"
+  end
+
+end
+
+class SerializeWithCoderTest < Test::Unit::TestCase
+
+  def setup
+    @user = User.create(:name => "Dhalsim")
+  end
+
+  def setup_notes
+    @note = {
+      'title' => 'First',
+      'body' => 'Perfect body'
+    }
+
+    @note2 = {
+      'title' => 'Second',
+      'body' => 'Score!'
+    }
+  end
+
+  # Serialize with CSV coder
+
+  def test_serialize_to_csv
+    @user.newsletters = ["FREE", "PREMIUM"]
+    @user.save
+
+    assert_equal "FREE,PREMIUM", @user.read_attribute(:newsletters)
+  end
+
+  def test_deserialized_from_csv
+    @user.newsletters = ["FREE", "PREMIUM"]
+    @user.save
+
+    user = User.find(@user.id)
+
+    assert_equal ["FREE", "PREMIUM"], user.newsletters
+  end
+
+  # Serialize with JSON coder
+
+  def test_serialize_to_json
+    setup_notes
+
+    @user.notes = [@note, @note2]
+    @user.save
+
+    assert_match /\[.+\]/, @user.read_attribute(:notes)
+
+    assert_match /\"title\":\"First\"/, @user.read_attribute(:notes)
+    assert_match /\"body\":\"Perfect body\"/, @user.read_attribute(:notes)
+    assert_match /\"title\":\"Second\"/, @user.read_attribute(:notes)
+    assert_match /\"body\":\"Score!\"/, @user.read_attribute(:notes)
+  end
+
+  def test_deserialized_from_json
+    setup_notes
+
+    @user.notes = [@note, @note2]
+    @user.save
+
+    user = User.find(@user.id)
+
+    assert user.notes.include?(@note)
+    assert user.notes.include?(@note2)
+  end
+
+  # Serialize with both coders
+
+  def test_serialize_with_both_coders
+    setup_notes
+
+    @user.newsletters = ["FREE", "PREMIUM"]
+    @user.notes = [@note, @note2]
+
+    @user.save
+
+    user = User.find(@user.id)
+
+    assert_equal ["FREE", "PREMIUM"], user.newsletters
+
+    assert user.notes.include?(@note)
+    assert user.notes.include?(@note2)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+$:.unshift(File.dirname(__FILE__) + '/..')
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'active_record'
+require 'test/unit'
+
+require 'serialize_with_coder'
+require 'coders/csv_coder'
+require 'coders/json_coder'
+
+require 'init'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+[:users].each do |table|
+  ActiveRecord::Base.connection.drop_table table rescue nil
+end
+
+ActiveRecord::Base.connection.create_table :users do |t|
+  t.string :name
+  t.text :newsletters
+  t.text :notes
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: serialize_with_coder
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Maciej Gajek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-12 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: serialize_with_coder is an ActiveRecord extended serialize function which acts like Rails 3.1 one - you can use custom coder as storing engine. Including 2 sample coders - CSV and JSON.
+email: maltize@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/coders/csv_coder.rb
+- lib/coders/json_coder.rb
+- lib/serialize_with_coder.rb
+- test/serialize_with_coder_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/maltize/serialize_with_coder
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Serialize with Coder
+test_files: 
+- test/serialize_with_coder_test.rb
+- test/test_helper.rb