json_array_serializer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9691f8acb8219c2c3ae074a50330d70dd16aa570
+  data.tar.gz: 5a2056392495edcfc40e09833ee5880a91967f6f
+SHA512:
+  metadata.gz: a469edf7288347abb45b33982da7b4e2985902212ff69d449397e9c0cc5d5f7b95a74b98bddba76c301714c55cca2ae9f8c5e41dfef9b4cfa142adf903120c0e
+  data.tar.gz: 8501d3e3829b0438f7b2fc8837a9c3b839804ba29333ecac0ad4fd9ebb067d497ee8af668230c0fd8db845b1ab1ffbebda6df295312466317c3cf4efd564030f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in json_array_serializer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathan Lilienthal
+
+MIT License
+
+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.md

@@ -0,0 +1,63 @@
+n# 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.
+
+## 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
+
+## Usage
+
+You can use the `JSONArraySerizalizer` directly on a attribute of a Rails model as follows.
+
+```ruby
+class Foo < ActiveRecord::Base
+  serialize :bar, JSONArraySerializer.new
+end
+```
+
+Or if you want to save object with more complexity, and custom functionality, simply extend `JSONArraySerizalizer`.
+
+```ruby
+# A class to hold a collection of commands.
+#
+class CommandArray < JSONArraySerizalizer
+  def perform
+    each do |command|
+      result = system(command.program)
+      raise "Error" if !result && command.raise_exception
+    end
+  end
+end
+```
+
+You can also pass in a class to load the individual JSON objects as when extending the base `JSONArraySerizalizer`.
+
+```ruby
+class Developer < OpenStruct
+  def develop(name)
+    # Write code.
+  end
+end
+
+class Company < ActiveRecord::Base
+  serialize :developers, JSONArraySerializer.new(Developer)
+end
+```
+
+The class you pass to `JSONArraySerializer.new` __must__ have the following two methods.
+
+```
+# A.new : Hash -> A
+# a.to_h : -> Hash (where a is an instance of A)
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/json_array_serializer.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_array_serializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_array_serializer"
+  spec.version       = JSONArraySerializer::VERSION
+  spec.authors       = ["Nathan Lilienthal"]
+  spec.email         = ["nathan@nixpulvis.com"]
+  spec.summary       = %q{Simple serialization for arrays of things to arrays of JSON.}
+  spec.description   = %q{Provides an common interface to convert between arrays of objects that implement .new and #to_h methods to arrays of JSON.}
+  spec.homepage      = "https://github.com/Americastestkitchen/json_array_serializer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/lib/json_array_serializer/version.rb

@@ -0,0 +1,3 @@
+class JSONArraySerializer
+  VERSION = "0.0.1"
+end

data/lib/json_array_serializer.rb

@@ -0,0 +1,57 @@
+require 'json'
+require 'json_array_serializer/version'
+
+class JSONArraySerializer
+  attr_accessor :element_class
+
+  # Class -> void (hook)
+  # Sets up the new JSONArraySerializer with it's elements
+  # class. The element_class is what will be used to represent
+  # each element of the stored JSON.
+  #
+  # The element class MUST implement two methods:
+  #
+  # A.new : Hash -> A
+  # a.to_h : -> Hash (where a is an instance of A)
+  #
+  def initialize(element_class = Hash, column_type = :text)
+    @element_class = element_class
+    @column_type   = column_type
+  end
+
+  # [JSON String] || JSON String -> [element_class]
+  # Takes an array of JSON strings and loads them
+  # into an array of element_classes.
+  #
+  def load(data)
+    array = case @column_type
+    when :array
+      data
+    when :string, :text
+      JSON.load(data)
+    end
+
+    array.map do |json|
+      hash = JSON.load(json)
+      (element_class == Hash) ? hash : element_class.new(hash)
+    end
+  end
+
+  # [element_class] -> [JSON String] || JSON String
+  # Takes an array of element_classes and dumps them
+  # into JSON Strings, and returns the array of them.
+  #
+  def dump(array)
+    serialized_array = array.map do |e|
+      hash = (element_class == Hash) ? e : e.to_h
+      JSON.dump(hash)
+    end
+
+    case @column_type
+    when :array
+      serialized_array
+    when :string, :text
+      JSON.dump(serialized_array)
+    end
+  end
+end

data/spec/json_array_serializer_spec.rb

@@ -0,0 +1,291 @@
+require 'spec_helper'
+
+describe JSONArraySerializer do
+
+  context 'text backed serialization' do
+    context 'default class (Hash)' do
+      let(:serializer) { JSONArraySerializer.new }
+
+      describe '.new' do
+        it 'sets it\'s element class to a Hash' do
+          expect(serializer.element_class).to eq(Hash)
+        end
+      end
+
+      describe '#load' do
+        it 'returns an empty array given an empty array' do
+          expect(serializer.load("[]")).to eq([])
+        end
+
+        it 'returns an array of the same length as it\'s given' do
+          array = Array.new(5, "{}")
+          expect(serializer.load(JSON.dump(array)).length).to eq(array.length)
+        end
+
+        it 'has elements that are in fact Hashs' do
+          array = Array.new(5, "{}")
+          expect(serializer.load(JSON.dump(array)).reject { |e| e.is_a? Hash }).to be_empty
+        end
+
+        it 'loads arrays of JSON with data' do
+          array = Array.new(5, "{\"foo\":\"bar\",\"baz\":1337}")
+          expect(serializer.load(JSON.dump(array)).first).to eq({'foo' => 'bar', 'baz' => 1337})
+        end
+      end
+
+      describe '#dump' do
+        it 'returns a string given an array' do
+          array = Array.new(5, {})
+          expect(serializer.dump(array)).to be_a(String)
+        end
+
+        it 'JSON can load it' do
+          array = Array.new(5, {foo: 'bar'})
+          expect { JSON.load(serializer.dump(array)) }.not_to raise_error
+        end
+      end
+
+      it 'dumps and loads equivalent arrays' do
+        array = [
+          { 'foo' => 'bar' },
+          { 'name' => 'nate', 'age' => 21 },
+          { 'ramble' => 'rara', 'float' => 21.13 }
+        ]
+        expect(serializer.load(serializer.dump(array))).to eq(array)
+      end
+
+      it 'converts symbols to strings' do
+        array = [
+          { foo: 'bar' },
+          { name: 'nate', age: 21 },
+          { ramble: 'rara', float: 21.13 },
+          { symbol: :very_symbol },
+          { hash: { 'foo' => 'bar' } },
+          { symbol_hash: { foo: 'bar' } }
+        ]
+        expected = array.map(&:stringify)
+        expect(serializer.load(serializer.dump(array))).to eq(expected)
+      end
+    end
+
+    context 'with OpenStruct class' do
+      let(:serializer) { JSONArraySerializer.new(OpenStruct) }
+
+      describe '.new' do
+        it 'sets it\'s element class to a OpenStruct' do
+          expect(serializer.element_class).to eq(OpenStruct)
+        end
+      end
+
+      describe '#load' do
+        it 'returns an empty array given an empty array' do
+          expect(serializer.load(JSON.dump([]))).to eq([])
+        end
+
+        it 'returns an array of the same length as it\'s given' do
+          array = Array.new(5, "{}")
+          expect(serializer.load(JSON.dump(array)).length).to eq(array.length)
+        end
+
+        it 'has elements that are in fact OpenStructs' do
+          array = Array.new(5, "{}")
+          expect(serializer.load(JSON.dump(array)).reject { |e| e.is_a? OpenStruct }).to be_empty
+        end
+
+        it 'loads arrays of JSON with data' do
+          array = Array.new(5, "{\"foo\":\"bar\",\"baz\":1337}")
+          expect(serializer.load(JSON.dump(array)).first).to eq(OpenStruct.new(foo: 'bar', baz: 1337))
+        end
+      end
+
+      describe '#dump' do
+        it 'returns a string given an array' do
+          array = Array.new(5, {})
+          expect(serializer.dump(array)).to be_a(String)
+        end
+
+        it 'JSON can load it' do
+          array = Array.new(5, {foo: 'bar'})
+          expect { JSON.load(serializer.dump(array)) }.not_to raise_error
+        end
+      end
+
+      it 'dumps and loads equivalent arrays' do
+        array = [
+          OpenStruct.new('foo' => 'bar'),
+          OpenStruct.new('name' => 'nate', 'age' => 21),
+          OpenStruct.new('ramble' => 'rara', 'float' => 21.13)
+        ]
+        expect(serializer.load(serializer.dump(array))).to eq(array)
+      end
+
+      it 'converts symbols to strings' do
+        array = [
+          OpenStruct.new(foo: 'bar'),
+          OpenStruct.new(name: 'nate', age: 21),
+          OpenStruct.new(ramble: 'rara', float: 21.13),
+          OpenStruct.new(symbol: :very_symbol),
+          OpenStruct.new(hash: { 'foo' => 'bar' }),
+          OpenStruct.new(symbol_hash: { foo: 'bar' })
+        ]
+        expected = array.map(&:stringify_values)
+        expect(serializer.load(serializer.dump(array))).to eq(expected)
+      end
+    end
+  end
+
+  context 'array backed serialization' do
+    context 'default class (Hash)' do
+      let(:serializer) { JSONArraySerializer.new(Hash, :array) }
+
+      describe '.new' do
+        it 'sets it\'s element class to a Hash' do
+          expect(serializer.element_class).to eq(Hash)
+        end
+      end
+
+      describe '#load' do
+        it 'returns an empty array given an empty array' do
+          expect(serializer.load([])).to eq([])
+        end
+
+        it 'returns an array of the same length as it\'s given' do
+          array = Array.new(5, "{}")
+          expect(serializer.load(array).length).to eq(array.length)
+        end
+
+        it 'has elements that are in fact Hashs' do
+          array = Array.new(5, "{}")
+          expect(serializer.load(array).reject { |e| e.is_a? Hash }).to be_empty
+        end
+
+        it 'loads arrays of JSON with data' do
+          array = Array.new(5, "{\"foo\":\"bar\",\"baz\":1337}")
+          expect(serializer.load(array).first).to eq({'foo' => 'bar', 'baz' => 1337})
+        end
+      end
+
+      describe '#dump' do
+        it 'returns an empty array given an empty array' do
+          expect(serializer.dump([])).to eq([])
+        end
+
+        it 'returns an array of the same length as it\'s given' do
+          array = Array.new(5, {})
+          expect(serializer.dump(array).length).to eq(array.length)
+        end
+
+        it 'has elements that are JSON strings' do
+          array = Array.new(5, {foo: 'bar'})
+          expect {
+            serializer.dump(array).map { |e| JSON.load(e) }
+          }.not_to raise_error
+        end
+
+        it 'dumps hashes with data' do
+          array = Array.new(5, {foo: 'bar', baz: 1337})
+          expect(serializer.dump(array).first).to eq("{\"foo\":\"bar\",\"baz\":1337}")
+        end
+      end
+
+      it 'dumps and loads equivalent arrays' do
+        array = [
+          { 'foo' => 'bar' },
+          { 'name' => 'nate', 'age' => 21 },
+          { 'ramble' => 'rara', 'float' => 21.13 }
+        ]
+        expect(serializer.load(serializer.dump(array))).to eq(array)
+      end
+
+      it 'converts symbols to strings' do
+        array = [
+          { foo: 'bar' },
+          { name: 'nate', age: 21 },
+          { ramble: 'rara', float: 21.13 },
+          { symbol: :very_symbol },
+          { hash: { 'foo' => 'bar' } },
+          { symbol_hash: { foo: 'bar' } }
+        ]
+        expected = array.map(&:stringify)
+        expect(serializer.load(serializer.dump(array))).to eq(expected)
+      end
+    end
+
+    context 'with OpenStruct class' do
+      let(:serializer) { JSONArraySerializer.new(OpenStruct, :array) }
+
+      describe '.new' do
+        it 'sets it\'s element class to a OpenStruct' do
+          expect(serializer.element_class).to eq(OpenStruct)
+        end
+      end
+
+      describe '#load' do
+        it 'returns an empty array given an empty array' do
+          expect(serializer.load([])).to eq([])
+        end
+
+        it 'returns an array of the same length as it\'s given' do
+          array = Array.new(5, "{}")
+          expect(serializer.load(array).length).to eq(array.length)
+        end
+
+        it 'has elements that are in fact OpenStructs' do
+          array = Array.new(5, "{}")
+          expect(serializer.load(array).reject { |e| e.is_a? OpenStruct }).to be_empty
+        end
+
+        it 'loads arrays of JSON with data' do
+          array = Array.new(5, "{\"foo\":\"bar\",\"baz\":1337}")
+          expect(serializer.load(array).first).to eq(OpenStruct.new(foo: 'bar', baz: 1337))
+        end
+      end
+
+      describe '#dump' do
+        it 'returns an empty array given an empty array' do
+          expect(serializer.dump([])).to eq([])
+        end
+
+        it 'returns an array of the same length as it\'s given' do
+          array = Array.new(5, OpenStruct.new)
+          expect(serializer.dump(array).length).to eq(array.length)
+        end
+
+        it 'has elements that are JSON strings' do
+          array = Array.new(5, OpenStruct.new({foo: 'bar'}))
+          expect {
+            serializer.dump(array).map { |e| JSON.load(e) }
+          }.not_to raise_error
+        end
+
+        it 'dumps OpenStructs with data' do
+          array = Array.new(5, OpenStruct.new(foo: 'bar', baz: 1337))
+          expect(serializer.dump(array).first).to eq("{\"foo\":\"bar\",\"baz\":1337}")
+        end
+      end
+
+      it 'dumps and loads equivalent arrays' do
+        array = [
+          OpenStruct.new('foo' => 'bar'),
+          OpenStruct.new('name' => 'nate', 'age' => 21),
+          OpenStruct.new('ramble' => 'rara', 'float' => 21.13),
+          OpenStruct.new(symbol: 'rara', 'float' => 21.13)
+        ]
+        expect(serializer.load(serializer.dump(array))).to eq(array)
+      end
+
+      it 'converts symbols to strings' do
+        array = [
+          OpenStruct.new(foo: 'bar'),
+          OpenStruct.new(name: 'nate', age: 21),
+          OpenStruct.new(ramble: 'rara', float: 21.13),
+          OpenStruct.new(symbol: :very_symbol),
+          OpenStruct.new(hash: { 'foo' => 'bar' }),
+          OpenStruct.new(symbol_hash: { foo: 'bar' })
+        ]
+        expected = array.map(&:stringify_values)
+        expect(serializer.load(serializer.dump(array))).to eq(expected)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'rspec'
+require 'ostruct'
+require 'json_array_serializer'
+
+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
+    end
+  end
+end
+
+class OpenStruct
+  def stringify_values
+    OpenStruct.new(marshal_dump.stringify)
+  end
+end
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: json_array_serializer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Lilienthal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: 'Provides an common interface to convert between arrays of objects that
+  implement .new and #to_h methods to arrays of JSON.'
+email:
+- nathan@nixpulvis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- json_array_serializer.gemspec
+- lib/json_array_serializer.rb
+- lib/json_array_serializer/version.rb
+- spec/json_array_serializer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Americastestkitchen/json_array_serializer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Simple serialization for arrays of things to arrays of JSON.
+test_files:
+- spec/json_array_serializer_spec.rb
+- spec/spec_helper.rb