activerecord-coders 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0443f7ecbcf79a4de2f4ca7cf5ec8be43966529
-  data.tar.gz: 2e7bc347184f9f47d873003977c7ef547ed8aafa
+  metadata.gz: 69ed667d4c5aa7f424697642e982a7d94565503d
+  data.tar.gz: e04d00fb744922fe51b00caefae6c049677dd696
 SHA512:
-  metadata.gz: 408ac253ac427d05ec629998d57d9f0363f88eaacdbd2b040caa26f4d843fd58b7d851f18459f98f1c2b4395c07da9469c8ca4d060f77a656c39b7b9a3a8850e
-  data.tar.gz: 227c693cbe4703be29f4f6e8a854f05135b9d3638ed8011d7c1bba886e64438b7979a9e39bc45e6ce0ee276daafda945b4fcc351b48509d6f66979c6670041c3
+  metadata.gz: a3cfc19ffe58017d176461ecc0f48c75e1119a4fec116567951d654cbe3916eab35815d602812a613ccbc79001563d8184fa232fb195240c477b21a64e8ac756
+  data.tar.gz: 4b278b6297a35f9a60bc8743d177c7485b49d67ea17111c3857f0c5f6ee233c1b3e758e01fe64b657245c071c796e41bf31a630371b9db054540b7edf69c98e4

data/activerecord-coders.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   # 3rd party libaries for coders
   spec.add_development_dependency "gibberish"
   spec.add_development_dependency "msgpack"
+  spec.add_development_dependency "oj"
 
   # Testing libraries
   spec.add_development_dependency "rspec"

data/lib/active_record/coders/compressors/base.rb

@@ -9,14 +9,10 @@ class ActiveRecord::Coders::Compressors::Base
   end
 
   def dump(data)
-    self.class.dump.call(data)
-  rescue
-    String.new
+    self.class.dump.call(data) if data
   end
 
   def load(data)
-    self.class.load.call(data)
-  rescue
-    nil
+    self.class.load.call(data) if data
   end
 end

data/lib/active_record/coders/encryptors/aes.rb

@@ -12,14 +12,10 @@ class ActiveRecord::Coders::Encryptors::AES
   end
 
   def dump(data)
-    cipher.encrypt(data, options)
-  rescue
-    String.new
+    cipher.encrypt(data, options) if data && !data.empty?
   end
 
   def load(data)
-    cipher.decrypt(data, options)
-  rescue
-    nil
+    cipher.decrypt(data, options) if data
   end
 end

data/lib/active_record/coders/serializers.rb

@@ -3,5 +3,6 @@ module ActiveRecord::Coders::Serializers
   require_relative "serializers/marshal"
   require_relative "serializers/yaml"
   require_relative "serializers/json"
+  require_relative "serializers/oj"
   require_relative "serializers/message_pack"
 end

data/lib/active_record/coders/serializers/base.rb

@@ -15,14 +15,10 @@ class ActiveRecord::Coders::Serializers::Base
   end
 
   def load(data)
-    self.class.load.call(data, options)
-  rescue
-    nil
+    self.class.load.call(data, options) if data
   end
 
   def dump(data)
-    self.class.dump.call(data, options)
-  rescue
-    String.new
+    self.class.dump.call(data, options) if data
   end
 end

data/lib/active_record/coders/serializers/oj.rb

@@ -0,0 +1,24 @@
+module ActiveRecord::Coders::Serializers
+  class Oj < Base
+
+    serialize_with do |s|
+      s.load = ->(data, options){
+        case options[:mode]
+        when :strict
+          ::Oj.strict_load(data)
+        when :compat, :null, :object, nil
+          ::Oj.load(data)
+        end
+      }
+
+      s.dump = ->(data, options){
+        case options[:mode]
+        when :strict, :compat, :null, :object
+          ::Oj.dump(data, mode: options[:mode])
+        when nil
+          ::Oj.dump(data, mode: :object)
+        end
+      }
+    end
+  end
+end

data/lib/active_record/coders/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Coders
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/lib/active_record/coders/compressors/gzip_spec.rb

@@ -13,11 +13,11 @@ describe ActiveRecord::Coders::Compressors::Gzip do
     gzip.reload.data.should == nil
   end
 
-  it "should not compress invalid data" do
+  it "should raise exception when receiving invalid data" do
     gzip = DbGzip.new
     gzip.data = {}
-    gzip.save
-    gzip.reload.data.should == nil
+    expect { gzip.save }.to raise_error(TypeError)
+    expect { gzip.reload }.to raise_error(ActiveRecord::RecordNotFound)
   end
 
   it "should (de)compress" do

data/spec/lib/active_record/coders/encryptors/aes_spec.rb

@@ -15,7 +15,7 @@ describe ActiveRecord::Coders::Encryptors::AES do
       aes256.reload.binary_data.should == nil
     end
 
-    it "should handle empty string values" do
+    it "should treat empty string as nil" do
       aes256 = DbAes.new
       aes256.binary_data = ""
       aes256.save
@@ -44,7 +44,7 @@ describe ActiveRecord::Coders::Encryptors::AES do
       aes256.reload.text_data.should == nil
     end
 
-    it "should handle empty string values" do
+    it "should treat empty string as nil" do
       aes256 = DbAes.new
       aes256.text_data = ""
       aes256.save

data/spec/lib/active_record/coders/pipeline_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe ActiveRecord::Coders::Pipeline do
 
-  it "create a blank record" do
+  it "should create blank" do
     DbPipeline.create
   end
 

data/spec/lib/active_record/coders/serializers/json_spec.rb

@@ -2,11 +2,11 @@ require "spec_helper"
 
 describe ActiveRecord::Coders::Serializers::JSON do
 
-  it "should create" do
+  it "should create blank" do
     DbJSON.create
   end
 
-  it "should (de)serialize nil" do
+  it "should handle nil values" do
     json = DbJSON.new
     json.data = nil
     json.save
@@ -20,10 +20,10 @@ describe ActiveRecord::Coders::Serializers::JSON do
     json.reload.data.should == { "some" => "data", "with" => %w[a r r a y] }
   end
 
-  it "should not serialize invalid data" do
+  it "should raise exception when receiving invalid data" do
     json = DbJSON.new
     json.data = 1
-    json.save
-    json.reload.data.should == nil
+    expect { json.save }.to raise_error(JSON::GeneratorError)
+    expect { json.reload }.to raise_error(ActiveRecord::RecordNotFound)
   end
 end

data/spec/lib/active_record/coders/serializers/marshal_spec.rb

@@ -4,11 +4,11 @@ describe ActiveRecord::Coders::Serializers::Marshal do
 
   context "binary" do
 
-    it "should create" do
+    it "should create blank" do
       DbMarshal.create
     end
 
-    it "should (de)serialize nil" do
+    it "should handle nil values" do
       marshal = DbMarshal.new
       marshal.binary_data = nil
       marshal.save
@@ -21,24 +21,24 @@ describe ActiveRecord::Coders::Serializers::Marshal do
       marshal.save
       marshal.reload.binary_data.should == { some: "data", with: %w[a r r a y] }
       marshal.reload.instance_variable_get("@attributes")["binary_data"]
-        .value.bytesize.should == 70
+      .value.bytesize.should == 70
     end
 
-    it "should not serialize invalid data" do
+    it "should raise exception when receiving invalid data" do
       marshal = DbMarshal.new
       marshal.binary_data = proc {}
-      marshal.save
-      marshal.reload.binary_data.should == nil
+      expect { marshal.save }.to raise_error(TypeError)
+      expect { marshal.reload }.to raise_error(ActiveRecord::RecordNotFound)
     end
   end
 
   context "text" do
 
-    it "should create" do
+    it "should create blank" do
       DbMarshal.create
     end
 
-    it "should (de)serialize nil" do
+    it "should handle nil values" do
       marshal = DbMarshal.new
       marshal.text_data = nil
       marshal.save
@@ -51,14 +51,14 @@ describe ActiveRecord::Coders::Serializers::Marshal do
       marshal.save
       marshal.reload.text_data.should == { some: "data", with: %w[a r r a y] }
       marshal.reload.instance_variable_get("@attributes")["text_data"]
-        .value.bytesize.should == 98
+      .value.bytesize.should == 98
     end
 
-    it "should not serialize invalid data" do
+    it "should raise exception when receiving invalid data" do
       marshal = DbMarshal.new
       marshal.text_data = proc {}
-      marshal.save
-      marshal.reload.text_data.should == nil
+      expect { marshal.save }.to raise_error(TypeError)
+      expect { marshal.reload }.to raise_error(ActiveRecord::RecordNotFound)
     end
   end
 end

data/spec/lib/active_record/coders/serializers/message_pack_spec.rb

@@ -4,11 +4,11 @@ describe ActiveRecord::Coders::Serializers::MessagePack do
 
   context "binary" do
 
-    it "should create" do
+    it "should create blank" do
       DbMessagePack.create
     end
 
-    it "should (de)serialize nil" do
+    it "should handle nil values" do
       msgpack = DbMessagePack.new
       msgpack.binary_data = nil
       msgpack.save
@@ -22,24 +22,24 @@ describe ActiveRecord::Coders::Serializers::MessagePack do
       msgpack.reload.binary_data.should ==
         { "some" => "data", "with" => %w[a r r a y] }
       msgpack.reload.instance_variable_get("@attributes")["binary_data"]
-        .value.bytesize.should == 27
+      .value.bytesize.should == 27
     end
 
-    it "should not serialize invalid data" do
+    it "should raise exception when receiving invalid data" do
       msgpack = DbMessagePack.new
       msgpack.binary_data = proc {}
-      msgpack.save
-      msgpack.reload.binary_data.should == nil
+      expect { msgpack.save }.to raise_error(NoMethodError)
+      expect { msgpack.reload }.to raise_error(ActiveRecord::RecordNotFound)
     end
   end
 
   context "text" do
 
-    it "should create" do
+    it "should create blank" do
       DbMessagePack.create
     end
 
-    it "should (de)serialize nil" do
+    it "should handle nil values" do
       msgpack = DbMessagePack.new
       msgpack.text_data = nil
       msgpack.save
@@ -53,14 +53,14 @@ describe ActiveRecord::Coders::Serializers::MessagePack do
       msgpack.reload.text_data.should ==
         { "some" => "data", "with" => %w[a r r a y] }
       msgpack.reload.instance_variable_get("@attributes")["text_data"]
-        .value.bytesize.should == 37
+      .value.bytesize.should == 37
     end
 
-    it "should not serialize invalid data" do
+    it "should raise exception when receiving invalid data" do
       msgpack = DbMessagePack.new
       msgpack.text_data = proc {}
-      msgpack.save
-      msgpack.reload.text_data.should == nil
+      expect { msgpack.save }.to raise_error(NoMethodError)
+      expect { msgpack.reload }.to raise_error(ActiveRecord::RecordNotFound)
     end
   end
 end

data/spec/lib/active_record/coders/serializers/oj_spec.rb

@@ -0,0 +1,108 @@
+require "spec_helper"
+
+describe ActiveRecord::Coders::Serializers::Oj do
+
+  it "should create blank" do
+    DbOj.create
+  end
+
+  context "default, object" do
+
+    it "should handle nil values" do
+      oj = DbOj.new
+      oj.default_data = nil
+      oj.object_data = nil
+      oj.save
+      oj.reload.default_data.should == nil
+      oj.reload.object_data.should == nil
+    end
+
+    it "should (de)serialize" do
+      data = OpenStruct.new(
+        name: "Michael",
+        colors: %w[red white blue]
+      )
+
+      oj = DbOj.new
+      oj.default_data = data
+      oj.object_data = data
+      oj.save
+      oj.reload.default_data.should == data
+      oj.reload.object_data.should == data
+    end
+
+    it "should replace unknown types with JSON null values" do
+      oj = DbOj.new
+      oj.default_data = { "example" => 1, "test" => proc{} }
+      oj.object_data = { "example" => 1, "test" => proc{} }
+      oj.save
+      oj.reload.default_data.should == { "example" => 1, "test" => nil }
+      oj.reload.object_data.should == { "example" => 1, "test" => nil }
+    end
+  end
+
+  context "strict" do
+
+    it "should handle nil values" do
+      oj = DbOj.new
+      oj.strict_data = nil
+      oj.save
+      oj.reload.strict_data.should == nil
+    end
+
+    it "should (de)serialize" do
+      oj = DbOj.new
+      oj.strict_data = { "some" => "data", "with" => %w[a r r a y] }
+      oj.save
+      oj.reload.strict_data.should == { "some" => "data", "with" => %w[a r r a y] }
+    end
+
+    it "should raise exception when receiving invalid data" do
+      oj = DbOj.new
+      oj.strict_data = { some:  "data", with: %w[a r r a y] }
+      expect { oj.save }.to raise_error(TypeError)
+      expect { oj.reload }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+
+  context "compat" do
+
+    it "should handle nil values" do
+      oj = DbOj.new
+      oj.compat_data = nil
+      oj.save
+      oj.reload.compat_data.should == nil
+    end
+
+    it "should (de)serialize" do
+      oj = DbOj.new
+      oj.compat_data = { some:  "data", with: %w[a r r a y] }
+      oj.save
+      oj.reload.compat_data.should == { "some" => "data", "with" => %w[a r r a y] }
+    end
+  end
+
+  context "null" do
+
+    it "should handle nil values" do
+      oj = DbOj.new
+      oj.null_data = nil
+      oj.save
+      oj.reload.null_data.should == nil
+    end
+
+    it "should (de)serialize" do
+      oj = DbOj.new
+      oj.null_data = { "some" => "data", "with" => %w[a r r a y] }
+      oj.save
+      oj.reload.null_data.should == { "some" => "data", "with" => %w[a r r a y] }
+    end
+
+    it "should replace unknown types with JSON null values" do
+      oj = DbOj.new
+      oj.null_data = { "example" => 1, "test" => proc{} }
+      oj.save
+      oj.reload.null_data.should == { "example" => 1, "test" => nil }
+    end
+  end
+end

data/spec/lib/active_record/coders/serializers/yaml_spec.rb

@@ -2,11 +2,11 @@ require "spec_helper"
 
 describe ActiveRecord::Coders::Serializers::YAML do
 
-  it "should create" do
+  it "should create blank" do
     DbYAML.create
   end
 
-  it "should (de)serialize nil" do
+  it "should handle nil values" do
     json = DbYAML.new
     json.data = nil
     json.save
@@ -20,10 +20,10 @@ describe ActiveRecord::Coders::Serializers::YAML do
     json.reload.data.should == { some: "data", with: %w[a r r a y] }
   end
 
-  it "should deserialize invalid data" do
+  it "should raise exception when receiving invalid data" do
     yaml = DbYAML.new
     yaml.data = proc {}
-    yaml.save
-    yaml.reload.data.should == nil
+    expect { yaml.save }.to raise_error(TypeError)
+    expect { yaml.reload }.to raise_error(ActiveRecord::RecordNotFound)
   end
 end

data/spec/support/db/migrate/08_create_db_ojs.rb

@@ -0,0 +1,10 @@
+class CreateDbOjs < ActiveRecord::Migration
+
+  def change
+    create_table :db_ojs do |t|
+      [:default, :object, :strict, :compat, :null].each do |type|
+        t.text :"#{type}_data"
+      end
+    end
+  end
+end

data/spec/support/models/db_oj.rb

@@ -0,0 +1,9 @@
+class DbOj < ActiveRecord::Base
+  serialize :default_data,
+    ActiveRecord::Coders::Serializers::Oj.new
+
+  [:object, :strict, :compat, :null].each do |type|
+    serialize :"#{type}_data",
+      ActiveRecord::Coders::Serializers::Oj.new(mode: type)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-coders
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Michael van Rooijen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +190,7 @@ files:
 - lib/active_record/coders/serializers/json.rb
 - lib/active_record/coders/serializers/marshal.rb
 - lib/active_record/coders/serializers/message_pack.rb
+- lib/active_record/coders/serializers/oj.rb
 - lib/active_record/coders/serializers/yaml.rb
 - lib/active_record/coders/version.rb
 - lib/activerecord-coders.rb
@@ -186,6 +201,7 @@ files:
 - spec/lib/active_record/coders/serializers/json_spec.rb
 - spec/lib/active_record/coders/serializers/marshal_spec.rb
 - spec/lib/active_record/coders/serializers/message_pack_spec.rb
+- spec/lib/active_record/coders/serializers/oj_spec.rb
 - spec/lib/active_record/coders/serializers/yaml_spec.rb
 - spec/spec_helper.rb
 - spec/support/db/migrate/01_create_db_gzips.rb
@@ -195,12 +211,14 @@ files:
 - spec/support/db/migrate/05_create_db_marshals.rb
 - spec/support/db/migrate/06_create_db_aes.rb
 - spec/support/db/migrate/07_create_db_pipelines.rb
+- spec/support/db/migrate/08_create_db_ojs.rb
 - spec/support/fixtures/lipsum.txt
 - spec/support/models/db_aes.rb
 - spec/support/models/db_gzip.rb
 - spec/support/models/db_json.rb
 - spec/support/models/db_marshal.rb
 - spec/support/models/db_message_pack.rb
+- spec/support/models/db_oj.rb
 - spec/support/models/db_pipeline.rb
 - spec/support/models/db_yaml.rb
 homepage: http://michael.vanrooijen.io
@@ -236,6 +254,7 @@ test_files:
 - spec/lib/active_record/coders/serializers/json_spec.rb
 - spec/lib/active_record/coders/serializers/marshal_spec.rb
 - spec/lib/active_record/coders/serializers/message_pack_spec.rb
+- spec/lib/active_record/coders/serializers/oj_spec.rb
 - spec/lib/active_record/coders/serializers/yaml_spec.rb
 - spec/spec_helper.rb
 - spec/support/db/migrate/01_create_db_gzips.rb
@@ -245,11 +264,13 @@ test_files:
 - spec/support/db/migrate/05_create_db_marshals.rb
 - spec/support/db/migrate/06_create_db_aes.rb
 - spec/support/db/migrate/07_create_db_pipelines.rb
+- spec/support/db/migrate/08_create_db_ojs.rb
 - spec/support/fixtures/lipsum.txt
 - spec/support/models/db_aes.rb
 - spec/support/models/db_gzip.rb
 - spec/support/models/db_json.rb
 - spec/support/models/db_marshal.rb
 - spec/support/models/db_message_pack.rb
+- spec/support/models/db_oj.rb
 - spec/support/models/db_pipeline.rb
 - spec/support/models/db_yaml.rb