pigeon_hole 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d0a69693e1ef17c571cae616b9f398a7abe2d57
-  data.tar.gz: 04c290bc512015a4322189249d7e725f2092ab39
+  metadata.gz: 0145686d84201c9a23404e48b87a1999ecce1269
+  data.tar.gz: cdadb67c03a83f767ab765e7236359ac396daea8
 SHA512:
-  metadata.gz: bdcbfca77cc2becdb833776e0b54da4c9c291571c08abadd65783f99a2da3cc0842f454d858b0c068be7f7f0e92868269e82d90d60a94be51925fdd8cd7e0f4d
-  data.tar.gz: 208b79c5a0b4b6b7b8cff757e3ebbb68d0a51655dea6f18a0621bd0f65adbb70a1eed216b103c467f23403f12a8423c8d590f3d9f1e71987ef46a6292ddc9d1b
+  metadata.gz: a7b86a2edc2a6dd8302533f92e6f02499c644027f8233185ef357a1f255fd97883d6f8a16aa933631dd6a36c05b7ffaec24865d173652cab75756240d98894d5
+  data.tar.gz: 7ccca3d7722de161c8dadd6af85d616253e7f67ebfe16ddbdaabd2d7cfa2618436504f72814f18c8e141084a28b2b5d026036f7744c67ee4807a1a949b9ef489

data/lib/pigeon_hole.rb

@@ -1,18 +1,17 @@
-module PigeonHole
-  require_relative 'pigeon_hole/typed_json'
-  require_relative 'pigeon_hole/json_date'
-  require_relative 'pigeon_hole/json_symbol'
-  require_relative 'pigeon_hole/json_time'
+require 'json'
 
-  def self.generate(obj, *args)
-    TypedJSON.generate(obj, *args)
-  end
+require_relative 'pigeon_hole/json_date'
+require_relative 'pigeon_hole/json_symbol'
+require_relative 'pigeon_hole/json_time'
 
-  def self.parse(string)
-    load(string)
+require_relative 'pigeon_hole/typed_json'
+
+module PigeonHole
+  def self.generate(obj)
+    TypedJSON.generate(obj)
   end
 
-  def self.load(string)
-    JSON.load(string)
+  def self.parse(string)
+    TypedJSON.parse(string)
   end
 end

data/lib/pigeon_hole/json_date.rb

@@ -1,29 +1,18 @@
 module PigeonHole
-  class JSONDate < SimpleDelegator
-    # Deserializes JSON string by converting Julian year <tt>y</tt>, month
-    # <tt>m</tt>, day <tt>d</tt> and Day of Calendar Reform <tt>sg</tt> to Date.
-    def self.json_create(object)
-      Date.civil(*object.values_at('y', 'm', 'd', 'sg'))
-    end
-
-    #alias start sg unless method_defined?(:start)
+  module JSONDate
+    TYPE_VALUE = 'date'.freeze
 
-    # Returns a hash, that will be turned into a JSON object and represent this
-    # object.
-    def as_json(*)
+    def self.serialize(date)
       {
-        JSON.create_id => self.class.name,
-        'y' => year,
-        'm' => month,
-        'd' => day,
-        'sg' => start,
+        TypedJSON::TYPE_KEY => TYPE_VALUE,
+        'y' => date.year,
+        'm' => date.month,
+        'd' => date.day,
       }
     end
 
-    # Stores class name (Date) with Julian year <tt>y</tt>, month <tt>m</tt>, day
-    # <tt>d</tt> and Day of Calendar Reform <tt>sg</tt> as JSON string
-    def to_json(*args)
-      as_json.to_json(*args)
+    def self.deserialize(hash)
+      Date.new(hash['y'], hash['m'], hash['d'])
     end
   end
 end

data/lib/pigeon_hole/json_symbol.rb

@@ -1,22 +1,16 @@
 module PigeonHole
-  class JSONSymbol < SimpleDelegator
-    # Returns a hash, that will be turned into a JSON object and represent this
-    # object.
-    def as_json(*)
+  module JSONSymbol
+    TYPE_VALUE = 'sym'.freeze
+
+    def self.serialize(symbol)
       {
-        JSON.create_id => self.class.name,
-        's'            => to_s,
+        TypedJSON::TYPE_KEY => TYPE_VALUE,
+        's' => symbol.to_s,
       }
     end
 
-    # Stores class name (Symbol) with String representation of Symbol as a JSON string.
-    def to_json(*a)
-      as_json.to_json(*a)
-    end
-
-    # Deserializes JSON string by converting the <tt>string</tt> value stored in the object to a Symbol
-    def self.json_create(o)
-      o['s'].to_sym
+    def self.deserialize(hash)
+      hash['s'].to_sym
     end
   end
 end

data/lib/pigeon_hole/json_time.rb

@@ -1,25 +1,18 @@
 module PigeonHole
-  class JSONTime < SimpleDelegator
-    # Deserializes JSON string by converting time since epoch to Time
-    def self.json_create(object)
-      ms_since_epoc = object['ms'].to_i
-      seconds, fragment = ms_since_epoc.divmod(1000)
-      Time.at(seconds, fragment * 1000).utc
-    end
+  module JSONTime
+    TYPE_VALUE = 'time'.freeze
 
-    # Returns a hash, that will be turned into a JSON object and represent this
-    # object.
-    def as_json(*)
+    def self.serialize(time)
       {
-        JSON.create_id => self.class.name,
-        'ms' => (tv_sec * 1000) + (usec / 1000),
+        TypedJSON::TYPE_KEY => TYPE_VALUE,
+        'ms' => (time.tv_sec * 1000) + (time.usec / 1000),
       }
     end
 
-    # Stores class name (Time) with number of seconds since epoch and number of
-    # microseconds for Time as JSON string
-    def to_json(*args)
-      as_json.to_json(*args)
+    def self.deserialize(hash)
+      ms_since_epoc = hash['ms'].to_i
+      seconds, fragment = ms_since_epoc.divmod(1000)
+      Time.at(seconds, fragment * 1000).utc
     end
   end
 end

data/lib/pigeon_hole/typed_json.rb

@@ -1,51 +1,89 @@
-require 'json'
-
 module PigeonHole
   class TypedJSON
+    class UnsupportedType < ArgumentError
+    end
+
+    BASIC_TYPES = [
+      NilClass,
+      String,
+      Integer,
+      Fixnum,
+      Bignum,
+      Float,
+      TrueClass,
+      FalseClass,
+    ].uniq.freeze
+
+    DESERIALIZERS = {
+      JSONDate::TYPE_VALUE => JSONDate,
+      JSONTime::TYPE_VALUE => JSONTime,
+      JSONSymbol::TYPE_VALUE => JSONSymbol,
+    }.freeze
+
+    SERIALIZERS = {
+      Date => JSONDate,
+      Time => JSONTime,
+      Symbol => JSONSymbol,
+    }.freeze
+
+    TYPE_KEY = '*'.freeze
+
     def self.generate(obj, *args)
-      hash_dup = each_with_parent(obj)
+      hash_dup = serialize_value(obj)
       JSON.generate(hash_dup, *args)
     end
 
-    def self.map_to_json(obj)
-      case obj
-      when Time
-        JSONTime.new(obj)
-      when Date
-        JSONDate.new(obj)
-      when Symbol
-        JSONSymbol.new(obj)
-      else
-        obj
-      end
+    def self.parse(value)
+      hash = JSON.parse(value)
+      translate(hash)
     end
 
-    def self.map_array_value(value)
+    def self.translate(hash)
+      deserialize_value(hash)
+    end
+
+    private
+
+    def self.deserialize_value(value)
       case value
       when Hash
-        each_with_parent(value)
+        if deserializer = DESERIALIZERS[value[TYPE_KEY]]
+          deserializer.deserialize(value)
+        else
+          value.each do |k, v|
+            value[k] = deserialize_value(v)
+          end
+
+          value
+        end
       when Array
-        value.map { |av| map_array_value(av) }
+        value.map! { |av| deserialize_value(av) }
       else
-        map_to_json(value)
+        value
       end
     end
 
-    def self.each_with_parent(hash, result=nil)
-      duplicated_hash = {} || result
+    def self.serialize_value(value)
+      case value
+      when *BASIC_TYPES
+        value
+      when Hash
+        hash = {}
 
-      hash.each do |k, v|
-        case v
-        when Hash
-          duplicated_hash[k] = each_with_parent(v, duplicated_hash)
-        when Array
-          duplicated_hash[k] = v.map { |av| map_array_value(av) }
-        else
-          duplicated_hash[k] = map_to_json(v)
+        value.each do |k, v|
+          hash[k] = serialize_value(v)
+        end
+
+        hash
+      when Array
+        value.map { |av| serialize_value(av) }
+      else
+        unless serializer = SERIALIZERS[value.class]
+          raise UnsupportedType.new(value.class)
         end
-      end
 
-      duplicated_hash
+        serializer.serialize(value)
+      end
     end
   end
 end

data/spec/integration_spec.rb

@@ -73,16 +73,16 @@ describe "serializing arrays" do
 end
 
 describe "serializing nested hashes" do
-  let(:expected) do
+  let(:input) do
     {
-      foo: {
-        bar: random_time,
-        baz: :temp
+      "foo" => {
+        "bar" => random_time,
+        "baz" => :temp,
       }
     }
   end
 
-  subject { PigeonHole.generate(expected) }
+  subject { PigeonHole.generate(input) }
 
   it "serializes hash into a string" do
     result = subject
@@ -93,6 +93,22 @@ describe "serializing nested hashes" do
     result = subject
     hash = PigeonHole.parse(result)
 
-    expect(symbolize_hash(hash)).to eq(expected)
+    expect(hash).to eq(input)
+  end
+end
+
+describe "serializing custom type" do
+  CustomType = Struct.new(:name)
+
+  let(:input) do
+    {
+      "custom" => CustomType.new("hello"),
+    }
+  end
+
+  subject { PigeonHole.generate(input) }
+
+  it "raises an unsupported type error" do
+    expect { subject }.to raise_error(PigeonHole::TypedJSON::UnsupportedType)
   end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,6 @@
-require 'rake'
-require 'rspec'
+require 'bundler'
 
-require "#{Rake.application.original_dir}/lib/pigeon_hole"
-
-include PigeonHole
+Bundler.require
 
 def random_integer
   rand(9999)
@@ -20,14 +17,3 @@ end
 def random_date_time
   DateTime.now
 end
-
-def symbolize_hash(obj)
-  if obj.is_a?(Hash)
-    obj.inject({}) do |memo, (k,v)|
-      memo[k.to_sym] = symbolize_hash(v)
-      memo
-    end
-  else
-    obj
-  end
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pigeon_hole
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Stephen Binns
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2016-07-29 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -18,72 +18,12 @@ extra_rdoc_files: []
 files:
 - lib/pigeon_hole.rb
 - lib/pigeon_hole/json_date.rb
-- lib/pigeon_hole/json_date_time.rb
 - lib/pigeon_hole/json_symbol.rb
 - lib/pigeon_hole/json_time.rb
-- lib/pigeon_hole/monster-vim-2016-07-25-16-44-46.rb
-- lib/pigeon_hole/monster-vim-2016-07-25-16-44-47.rb
-- lib/pigeon_hole/monster-vim-2016-07-25-16-44-58.rb
-- lib/pigeon_hole/monster-vim-2016-07-25-16-47-02.rb
-- lib/pigeon_hole/monster-vim-2016-07-25-16-47-08.rb
-- lib/pigeon_hole/monster-vim-2016-07-25-16-47-09.rb
-- lib/pigeon_hole/monster-vim-2016-07-25-16-47-10.rb
-- lib/pigeon_hole/monster-vim-2016-07-25-16-47-35.rb
-- lib/pigeon_hole/monster-vim-2016-07-25-16-47-36.rb
-- lib/pigeon_hole/monster-vim-2016-07-25-16-47-37.rb
-- lib/pigeon_hole/monster-vim-2016-07-25-16-47-38.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-09-11.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-09-41.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-09-42.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-11-26.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-15-33.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-15-46.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-15-57.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-16-03.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-16-04.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-16-05.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-17-22.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-17-23.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-19-14.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-20-50.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-20-52.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-20-53.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-26-57.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-26-58.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-27-58.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-27-59.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-33-40.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-33-41.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-33-42.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-33-53.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-37-07.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-37-08.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-37-09.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-37-20.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-37-21.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-37-22.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-37-23.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-37-24.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-37-25.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-38-26.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-38-27.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-38-28.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-38-29.rb
-- lib/pigeon_hole/monster-vim-2016-07-26-10-39-14.rb
 - lib/pigeon_hole/typed_json.rb
 - spec/integration_spec.rb
-- spec/monster-vim-2016-07-26-10-29-02.rb
-- spec/monster-vim-2016-07-26-10-29-53.rb
-- spec/monster-vim-2016-07-26-12-05-32.rb
-- spec/monster-vim-2016-07-26-12-05-33.rb
-- spec/monster-vim-2016-07-26-12-05-34.rb
-- spec/monster-vim-2016-07-26-12-05-35.rb
-- spec/monster-vim-2016-07-26-12-06-22.rb
-- spec/monster-vim-2016-07-26-12-06-32.rb
-- spec/monster-vim-2016-07-26-12-06-33.rb
-- spec/monster-vim-2016-07-26-12-06-34.rb
 - spec/spec_helper.rb
-homepage: http://www.cronofy.com
+homepage: https://github.com/cronofy/pigeon_hole
 licenses:
 - MIT
 metadata: {}
@@ -103,21 +43,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Opt-in typed serialization for complex JSON types
 test_files:
 - spec/integration_spec.rb
-- spec/monster-vim-2016-07-26-10-29-02.rb
-- spec/monster-vim-2016-07-26-10-29-53.rb
-- spec/monster-vim-2016-07-26-12-05-32.rb
-- spec/monster-vim-2016-07-26-12-05-33.rb
-- spec/monster-vim-2016-07-26-12-05-34.rb
-- spec/monster-vim-2016-07-26-12-05-35.rb
-- spec/monster-vim-2016-07-26-12-06-22.rb
-- spec/monster-vim-2016-07-26-12-06-32.rb
-- spec/monster-vim-2016-07-26-12-06-33.rb
-- spec/monster-vim-2016-07-26-12-06-34.rb
 - spec/spec_helper.rb
-has_rdoc: