jsoning 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab99aea4b1e32c8cb1dd3b9ef9629de18fe57af5
-  data.tar.gz: c33e1687f59d31bed9ddbf1d299b9ad9b1bc81e5
+  metadata.gz: 2edd1def968d6f13f1ba2cc36243718163cd7dcc
+  data.tar.gz: 2e18b982c6b0269727b827d782ea72695f904d7f
 SHA512:
-  metadata.gz: bf0371b9055dce314f1a4400f192de4dbe1f886761d2accf30816d6256db22a1aae8175d9ea755a5d8327bb88dfce74dd77920c13482d872940a292cd8f508c8
-  data.tar.gz: 5607608a6b053dfc67bd37952da6e590e56e015ce012fd7701e5702b85becbe651b61f8c203dc8e5f62276782a520cc9de58d1b4dca7190e0f1c379ef2564cc6
+  metadata.gz: c2799fd887a3db49f97de68228f5fc4a5634f7b91466a0f119b56b7c3565e10bbb4856d5896c0422bddc5767fcd32284031873ef7dae1d97c5d68faef45b57ab
+  data.tar.gz: 5622840a2c4ddf1efa7141fa17c01793aff7bde1468113e407d676a099e08616a14a17b8f0b1f5721aaf60d219e7a283de7716582da50e374d74c6cf0f1d69e3

data/README.md

@@ -12,7 +12,7 @@ any Ruby object there is. Kiss good bye to complexity
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'Jsoning'
+gem 'jsoning'
 ```
 
 And then execute:
@@ -187,6 +187,18 @@ The syntax above will return ruby hash object:
  "degree_detail"=>{"faculty"=>"School of IT", "degree"=>"B.Sc. (Hons) Computer Science"}}
 ```
 
+## Supporting custom data type
+
+JSON, by default support data type such as boolean, nil, string, and number. If you have class like
+`MyFancyString` and would tell Jsoning how to interpret and extract value from them, use this syntax:
+
+```ruby
+Jsoning.add_type MyFancyString, processor: { |fancy_string| fancy_string.get_string } 
+```
+
+Internally, it is how Jsoning convert date-like data type (`Date`, `DateTime`, `Time`, `ActiveSupport::TimeWithZone`) to
+ISO8601 which can be parsed by compliant JavaScript interpreter in the browser (or somewhere else).
+
 ## Changelog
 
 == Version 0.1.0
@@ -195,7 +207,12 @@ The syntax above will return ruby hash object:
 
 == Version 0.2.0
 
-2. Ability to turn object into a hash
+1. Ability to turn object into a hash
+
+== Version 0.3.0
+
+1. Allow user to specify how Jsoning would extract value from a custom data type
+2. Date, DateTime, Time, ActiveSupport::TimeWithZone now is by default parsed to ISO8601 format.
 
 ## License
 

data/lib/jsoning/foundations/mapper.rb

@@ -50,24 +50,30 @@ class Jsoning::Mapper
     def deep_parse(object)
       parsed_data = nil
 
-      if object.is_a?(Array)
-        parsed_data = []
-        object.each do |each_obj|
-          parsed_data << deep_parse(each_obj)
-        end
-      elsif object.is_a?(Hash)
-        parsed_data = {}
-        object.each do |obj_key_name, obj_val|
-          parsed_data[obj_key_name] = deep_parse(obj_val)
-        end
-      elsif object.is_a?(Integer) || object.is_a?(Float) || object.is_a?(String) ||
-        object.is_a?(TrueClass) || object.is_a?(FalseClass) || object.is_a?(NilClass)
-        parsed_data = object
+      value_extractor = Jsoning::TYPE_EXTENSIONS[object.class.to_s]
+      if value_extractor # is defined
+        parsed_data = value_extractor.(object)
       else
-        protocol = Jsoning.protocol_for!(object.class)
-        parsed_data = protocol.parse(object)
+        if object.is_a?(Array)
+          parsed_data = []
+          object.each do |each_obj|
+            parsed_data << deep_parse(each_obj)
+          end
+        elsif object.is_a?(Hash)
+          parsed_data = {}
+          object.each do |obj_key_name, obj_val|
+            parsed_data[obj_key_name] = deep_parse(obj_val)
+          end
+        elsif object.is_a?(Integer) || object.is_a?(Float) || object.is_a?(String) ||
+          object.is_a?(TrueClass) || object.is_a?(FalseClass) || object.is_a?(NilClass)
+          parsed_data = object
+        else
+          protocol = Jsoning.protocol_for!(object.class)
+          parsed_data = protocol.parse(object)
+        end
       end
 
+
       parsed_data
     end
 end

data/lib/jsoning/version.rb

@@ -1,3 +1,3 @@
 module Jsoning
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/jsoning.rb

@@ -9,6 +9,8 @@ require "json"
 
 module Jsoning
   PROTOCOLS = {}
+  # if type is defined here, we will use it to extract its value for the key
+  TYPE_EXTENSIONS = {}
 
   module_function
 
@@ -37,10 +39,57 @@ module Jsoning
   end
 
   def generate(object, options = {})
+    initialize_type_extensions 
     protocol = protocol_for!(object.class)
     protocol.generate(object, options)
   end
 
+  @@type_extension_initialized = false
+  def initialize_type_extensions
+    @@type_extension_initialized = true if !!@@type_extension_initialized
+    return if @@type_extension_initialized
+
+    begin
+      require "time"
+      ::Time
+      self.add_type Time, processor: proc { |time| time.iso8601 }
+    rescue
+    end
+
+    begin
+      # try to define value extractor for ActiveSupport::TimeWithZone which is in common use
+      # for AR model
+      ::ActiveSupport::TimeWithZone
+      self.add_type ActiveSupport::TimeWithZone, processor: proc { |time| time.send(:iso8601) }
+    rescue 
+      # nothing, don't add
+    end
+
+    begin
+      ::DateTime
+      self.add_type DateTime, processor: proc { |date| date.send(:iso8601) }
+    rescue => e 
+      # nothing, don't add
+    end
+
+    begin
+      ::Date
+      self.add_type Date, processor: proc { |date| date.send(:iso8601) }
+    rescue 
+      # nothing, don't add
+    end
+  end
+
+  class << self
+    def add_type(klass, options = {})
+      processor = options[:processor]
+      raise Jsoning::Error, "Pass in processor that is a proc explaining how to extract the value" unless processor.is_a?(Proc)
+
+      TYPE_EXTENSIONS[klass.to_s] = processor
+      nil
+    end
+  end
+  
   def self.[](object) 
     protocol = protocol_for!(object.class)
     protocol.parse(object)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsoning
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Adam Pahlevi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-01 00:00:00.000000000 Z
+date: 2015-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler