json_array_serializer 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 759b6374e0d2f2f6b141dc720a08e358445a31ca
-  data.tar.gz: e129f2d357544ff607187baf39b43855665b6dd9
+  metadata.gz: 9e7a4e281f8c0cd7f9375760778ee6f8e6caaf76
+  data.tar.gz: 7db5e8490e317f3a57c95c8b787aa6d31aa07cdf
 SHA512:
-  metadata.gz: b521b7344f0f00622f628a3f293640daffbf3fae68508aabe7cc7be34cf3c26ceaf2a23422cb6ad71ef4fce5a18a6811e5af7908fca6473b571f24be90b80033
-  data.tar.gz: ece9d5e2a0c7905cb41a32f0931518d10ef9db77bbc023918b352dd989d6f04eda4afda9cc3a5c7abbb8716c4c1d462b980c4a7283e7d1c266ec6e2e419325be
+  metadata.gz: fa1c7b226056e7812621d8becbab7dc302117f054cef04ed77ce3cce04b2264b3a011169c135cfb963d6cb112241313925b9b5a5d8406a003c34504b82cc15f4
+  data.tar.gz: 10c856a3be1bc47e44d4359cb25584f6037643b94395b578887fb72143419e531bb124d9c645036f68b47789e65e02e3a61602856abcf49da08133483ab5ef32

data/README.md

@@ -1,24 +1,18 @@
 # JSONArraySerializer
 
-A class to serialize and deserialize arrays of JSON strings. This is useful when doing things like saving arrays of objects to a database or file, or sending them over the wire.
+A class to serialize and deserialize arrays of JSON strings. This is useful when doing things like saving arrays of objects to a database or file, or sending them over the wire. The main focus of this gem is aimed at Rails's `ActiveRecord::Base#serialize`.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'json_array_serializer'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install json_array_serializer
+```ruby
+gem 'json_array_serializer'
+```
 
 ## Usage
 
-You can use the `JSONArraySerizalizer` directly on a attribute of a Rails model as follows.
+You can use the `JSONArraySerizalizer` directly on a attribute of a Rails model as follows. This will save the `bar` attribute as a string of JSON in the database, where `bar` is an array of hashes.
 
 ```ruby
 class Foo < ActiveRecord::Base
@@ -71,7 +65,7 @@ The `array_class` you pass to `JSONArraySerializer.new` __must__ have the follow
 
 ```
 # A.new : Array -> A
-# a.to_a : -> Array (where a is an instance of A) ?????
+# a.to_a : -> Array (where a is an instance of A)
 ```
 
 ### Specifying the Database Type
@@ -102,4 +96,4 @@ end
 class Company < ActiveRecord::Base
   serialize :developers, JSONArraySerializer.new(array_class: DeveloperArray, element_class: Developer)
 end
-```
+```

data/lib/json_array_serializer/version.rb

@@ -1,3 +1,3 @@
 class JSONArraySerializer < Array
-  VERSION = "0.0.3"
+  VERSION = '0.0.4'
 end

data/lib/json_array_serializer.rb

@@ -9,45 +9,67 @@ class JSONArraySerializer
   # class. The element_class is what will be used to represent
   # each element of the stored JSON.
   #
-  # The element class MUST implement two methods:
+  # The option :array_class MUST implement two methods:
+  #
+  # A.new : Array -> A
+  # a.to_a : -> Array (where a is an instance of A)
+  #
+  # The option :element_class MUST implement two methods:
   #
   # A.new : Hash -> A
   # a.to_h : -> Hash (where a is an instance of A)
   #
-  def initialize(array_class: Array, element_class: Hash, column_type: :text)
-    @array_class   = array_class
-    @element_class = element_class
-    @column_type   = column_type
+  # The option :column_type MUST be one of :string | :text | :array.
+  #
+  # The option :allow_nil is a boolean which determines whether or not
+  # to load/dump nil values. If set to true (the default) it will load/dump
+  # nil when given nil. If set to false it will treat nil as an empty array.
+  #
+  def initialize(options = {})
+    options = {
+      array_class: Array,
+      element_class: Hash,
+      column_type: :text,
+      allow_nil: true
+    }.merge(options)
+
+    @array_class   = options[:array_class]
+    @element_class = options[:element_class]
+    @column_type   = options[:column_type]
+    @allow_nil     = options[:allow_nil]
   end
 
   # [JSON String] || JSON String -> array_class<element_class>
-  # Takes an array of JSON strings and loads them
-  # into an array of element_classes.
+  # Takes the data from the database, and loads them into an
+  # instance of `array_class` with elements of `element_class`.
   #
   def load(data)
-    return data if data.nil?
+    return (@allow_nil ? nil : []) if data.nil?
 
-    array = case @column_type
-    when :array
-      data.map do |json|
-        hash = JSON.load(json)
-        (element_class == Hash) ? hash : element_class.new(hash)
-      end
-    when :string, :text
-      JSON.load(data).map do |hash|
-        (element_class == Hash) ? hash : element_class.new(hash)
+    array =
+      case @column_type
+      when :array
+        data.map do |json|
+          hash = JSON.load(json)
+          (element_class == Hash) ? hash : element_class.new(hash)
+        end
+      when :string, :text
+        if element_class == Hash
+          JSON.load(data)
+        else
+          JSON.load(data).map { |hash| element_class.new(hash) }
+        end
       end
-    end
 
     (array_class == Array) ? array : array_class.new(array)
   end
 
   # array_class<element_class> -> [JSON String] || JSON String
-  # Takes an array of element_classes and dumps them
-  # into JSON Strings, and returns the array of them.
+  # Takes an instance of `array_class` with `element_class` elements
+  # and dumps them either a array of JSON or JSON itself for the database.
   #
   def dump(data)
-    return data if data.nil?
+    return (@allow_nil ? nil : []) if data.nil?
 
     case @column_type
     when :array

data/{ext → spec/ext}/hash.rb

@@ -7,14 +7,15 @@ class Hash
   #
   def stringify
     inject({}) do |acc, (key, value)|
-      acc[key.to_s] = case value
-      when Symbol
-        value.to_s
-      when Hash
-        value.stringify
-      else
-        value
-      end
+      acc[key.to_s] =
+        case value
+        when Symbol
+          value.to_s
+        when Hash
+          value.stringify
+        else
+          value
+        end
       acc
     end
   end

data/spec/json_array_serializer_spec.rb

@@ -125,6 +125,10 @@ describe JSONArraySerializer do
         expect(serializer.dump(array)).to be_a(String)
       end
 
+      it 'returns a string given an array of another class' do
+        expect(serializer.dump([OpenStruct.new(foo: 'bar')])).to be_a(String)
+      end
+
       it 'JSON can load it' do
         expect { JSON.load(serializer.dump(array)) }.not_to raise_error
       end
@@ -160,6 +164,10 @@ describe JSONArraySerializer do
         expect(serializer.dump(array)).to be_a(String)
       end
 
+      it 'returns a string given an array of hashes' do
+        expect(serializer.dump([{foo: 'bar'}])).to be_a(String)
+      end
+
       it 'JSON can load it' do
         expect { JSON.load(serializer.dump(array)) }.not_to raise_error
       end
@@ -215,4 +223,36 @@ describe JSONArraySerializer do
       end
     end
   end
+
+  context 'with allow_nil set to false' do
+    let(:serializer) { JSONArraySerializer.new(allow_nil: false) }
+
+    describe '#load' do
+      it 'loads nil as []' do
+        expect(serializer.load(nil)).to eq([])
+      end
+    end
+
+    describe '#dump' do
+      it 'dumps nil as []' do
+        expect(['[]', []]).to include(serializer.dump(nil))
+      end
+    end
+  end
+
+  context 'with allow_nil set to true' do
+    let(:serializer) { JSONArraySerializer.new(allow_nil: true) }
+
+    describe '#load' do
+      it 'loads nil as nil' do
+        expect(serializer.load(nil)).to eq(nil)
+      end
+    end
+
+    describe '#dump' do
+      it 'dumps nil as nil' do
+        expect(serializer.dump(nil)).to eq(nil)
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -3,8 +3,8 @@ require 'ostruct'
 require 'json_array_serializer'
 
 # Connivance extensions.
-require_relative '../ext/hash'
-require_relative '../ext/open_struct'
+require_relative 'ext/hash'
+require_relative 'ext/open_struct'
 
 RSpec.configure do |config|
   config.color_enabled = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_array_serializer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Nathan Lilienthal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-28 00:00:00.000000000 Z
+date: 2014-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,11 +65,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- ext/hash.rb
-- ext/open_struct.rb
 - json_array_serializer.gemspec
 - lib/json_array_serializer.rb
 - lib/json_array_serializer/version.rb
+- spec/ext/hash.rb
+- spec/ext/open_struct.rb
 - spec/json_array_serializer_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Americastestkitchen/json_array_serializer
@@ -97,5 +97,7 @@ signing_key:
 specification_version: 4
 summary: Simple serialization for arrays of things to arrays of JSON.
 test_files:
+- spec/ext/hash.rb
+- spec/ext/open_struct.rb
 - spec/json_array_serializer_spec.rb
 - spec/spec_helper.rb