jsoning 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b677bf0eef2f3f5ec7b07e6132e038ab33e4111
-  data.tar.gz: b7db25000fd4b3473d178b7cbaf488a7412d52e3
+  metadata.gz: fd577237f0bce4d654d6b0294a0d30ec12b3f060
+  data.tar.gz: 42951f8a06781a5565b61d417730dbb44411c06e
 SHA512:
-  metadata.gz: 4ebff10b0fa858c2c787d1f5c14f658fd272e4e99fd7d74880772e23da97a6001e4780a98418a23ce101f329a94780fc71c21f12b2bf5769f8134a4fe1073417
-  data.tar.gz: ca07af734f5508bb36218ae69c601ee636e8f8d379b9e08666ffacb154439ec530cda86c84a795d8c8db8426549eb52aa585e61ca53009cbd2cc2b5dd860afba
+  metadata.gz: 132eeb81dbe3fb5e5e33045d1c83fa00bb27cb0facfb3509ba9b0613a71af42fb55b52f61e0d2ecd0af8e3c5fe73b6dc25248dcc08986e940f1531129eebe246
+  data.tar.gz: 64eb70554da8b32ad0066e9993c2dbcd634b1826716c3fe77dee45b802477352df6532e4c330c8a95bd9233069e78a1f56b8fc64df88947774de7bab381b33a4

data/README.md

@@ -292,13 +292,21 @@ expect(Jsoning.generate(book, hash: true, version: :v1)).to eq({"name"=>"Harry P
 expect(Jsoning.generate(book, hash: true, version: :v2)).to eq({"book_name"=>"Harry Potter"})
 ```
 
-We can also generate the whole user json/hash, too:
+Notice that we can use `inherits` to save ourself from writing keys that have been defined somewhere when
+we do versioning:
 
 ```ruby
-json = Jsoning.generate(user, version: :v1)
-expect(JSON.parse(json)).to eq({"name"=>"Adam Baihaqi", "upcase_name"=>"ADAM BAIHAQI", "years_old"=>21, "gender"=>"male", "books"=>[{"name"=>"Quiet: The Power of Introvert"}, {"name"=>"Harry Potter and the Half-Blood Prince"}], "degree_detail"=>nil, "registered_at"=>"2015-11-01T14:41:09+0000"})
-json = Jsoning.generate(user, version: :v2)
-expect(JSON.parse(json)).to eq({"name"=>"Adam Baihaqi", "upcase_name"=>"ADAM BAIHAQI", "years_old"=>21, "gender"=>"male", "books"=>[{"book_name"=>"Quiet: The Power of Introvert"}, {"book_name"=>"Harry Potter and the Half-Blood Prince"}], "degree_detail"=>nil, "registered_at"=>"2015-11-01T14:41:09+0000"})
+Jsoning.for(My::User) do
+  version :v2 do
+    inherits :name, :age, :gender, :taken_degree, :books
+    key :upcase_name, from: :name, value: proc { |name| name.upcase }
+  end
+
+  version :v3 do
+    inherits :name, :age, :gender, :taken_degree, :books
+    inherits :upcase_name, from: :v2
+  end
+end
 ```
 
 If for when generating object, the requested versioning is undefined, the default version will be used.
@@ -337,6 +345,10 @@ If for when generating object, the requested versioning is undefined, the defaul
 
 1. Add value post-processor
 
+== Version 0.8.0
+
+1. Add `inherits` allowing versioned result to inherits key from default namespace
+
 ## License
 
 The gem is proudly available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/jsoning.rb

@@ -16,7 +16,7 @@ module Jsoning
   module_function
 
   # returns a protocol, or create one if none exists
-  def protocol_for(klass)
+  def protocol_for_or_create(klass)
     protocol = PROTOCOLS[klass.to_s]
     if protocol.nil?
       protocol = Jsoning::Protocol.new(klass)
@@ -39,7 +39,7 @@ module Jsoning
 
   # define the protocol
   def for(klass, &block)
-    Jsoning::ForDsl.new(protocol_for(klass)).instance_eval(&block)
+    Jsoning::ForDsl.new(protocol_for_or_create(klass)).instance_eval(&block)
   end
 
   # generate the json document
@@ -91,7 +91,7 @@ module Jsoning
 
     begin
       ::Time
-      self.add_type Time, processor: proc { |time| time.strftime("%FT%T%z") }
+      self.add_type ::Time, processor: proc { |time| time.strftime("%FT%T%z") }
     rescue
     end
 
@@ -106,14 +106,14 @@ module Jsoning
 
     begin
       ::DateTime
-      self.add_type DateTime, processor: proc { |date| date.strftime("%FT%T%z") }
+      self.add_type ::DateTime, processor: proc { |date| date.strftime("%FT%T%z") }
     rescue => e 
       # nothing, don't add
     end
 
     begin
       ::Date
-      self.add_type Date, processor: proc { |date| date.strftime("%FT%T%z") }
+      self.add_type ::Date, processor: proc { |date| date.strftime("%FT%T%z") }
     rescue 
       # nothing, don't add
     end

data/lib/jsoning/dsl/for_dsl.rb

@@ -7,6 +7,35 @@ class Jsoning::ForDsl
     @protocol = protocol
   end
 
+  # inherits can happen inside version block
+  # it allows version to inherit specific key from parents
+  def inherits(*args)
+    fail 'Must be inside version block' unless current_version_object
+    all_keys = []
+    options = {}
+
+    args.each do |arg|
+      if arg.is_a?(String) || arg.is_a?(Symbol)
+        all_keys << arg
+      elsif arg.is_a?(Hash)
+        options = arg
+      end
+    end
+
+    current_version = self.current_version_object
+    if options[:from] || options['from']
+      parent_version = current_version.protocol.get_version(options[:from] || options['from'])
+    else
+      parent_version = current_version.protocol.get_version(:default)
+    end
+
+    all_keys.each do |key_name|
+      mapper = parent_version.mapper_for(key_name)
+      current_version.add_mapper(mapper)
+    end
+    all_keys
+  end
+
   # specify the version under which key will be executed
   def version(version_name)
     @@mutex.synchronize do
@@ -20,6 +49,7 @@ class Jsoning::ForDsl
 
       self.current_version_object = version
       yield
+      self.current_version_object = nil
     end
   end
 

data/lib/jsoning/foundations/mapper.rb

@@ -39,7 +39,7 @@ class Jsoning::Mapper
 
     if object.respond_to?(parallel_variable)
       parallel_val = object.send(parallel_variable)
-      target_value = deep_parse(parallel_val, requested_version_name)
+      target_value = parallel_val
     end
 
     if target_value.nil?
@@ -49,22 +49,23 @@ class Jsoning::Mapper
       end
     end
 
-    extracted_value = deep_parse(target_value, requested_version_name)
-
     # apply extractor to extracted value, if processor is defined
     if value_processor
-      extracted_value = value_processor.(extracted_value)
+      target_value = deep_parse(target_value, requested_version_name, false)
+      target_value = value_processor.(target_value)
+    else
+      target_value = deep_parse(target_value, requested_version_name, true)
     end
 
-    target_hash[name] = extracted_value
+    target_hash[name] = target_value
   end
 
   def default_value(version_name = self.version.version_name)
     if @default_value
       if @default_value.is_a?(Proc)
-        return deep_parse(@default_value.(), version_name)
+        return deep_parse(@default_value.(), version_name, true)
       else
-        return deep_parse(@default_value, version_name)
+        return deep_parse(@default_value, version_name, true)
       end
     else
       nil
@@ -72,29 +73,40 @@ class Jsoning::Mapper
   end
 
   private
-    def deep_parse(object, version_name)
+    def deep_parse(object, version_name, run_value_extractor)
       parsed_data = nil
 
       value_extractor = Jsoning::TYPE_EXTENSIONS[object.class.to_s]
-      if value_extractor # is defined
+      if value_extractor && run_value_extractor # is defined
         parsed_data = value_extractor.(object)
       else
         if object.is_a?(Array)
           parsed_data = []
           object.each do |each_obj|
-            parsed_data << deep_parse(each_obj, version_name)
+            parsed_data << deep_parse(each_obj, version_name, run_value_extractor)
           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, version_name)
+            parsed_data[obj_key_name] = deep_parse(obj_val, version_name, run_value_extractor)
           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.retrieve_values_from(object, {version: version_name})
+          if run_value_extractor
+            protocol = Jsoning.protocol_for!(object.class)
+            parsed_data = protocol.retrieve_values_from(object, {version: version_name})
+          else
+            # if value extractor is false, don't raise error if protocol is undefined.
+            # value processor is exactly way for user to customly extract data in-line
+            protocol = Jsoning::PROTOCOLS[object.class]
+            if protocol
+              parsed_data = protocol.retrieve_values_from(object, {version: version_name})
+            else
+              parsed_data = object
+            end
+          end
         end
       end
 

data/lib/jsoning/version.rb

@@ -1,3 +1,3 @@
 module Jsoning
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsoning
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Adam Pahlevi