json_struct_mapper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e1a4c44ea87b099135a38beb8be6cf25462334d112b117317ad735335e6f72b
-  data.tar.gz: f036202b6da95d30cfc4daf23b10719190a9422d3151e7e5bc847b735f98c6b5
+  metadata.gz: 3a3eedc414500a84c5c9bb68c9cf9a1cfa2ec77a19ef2c109e70fe1e5f5cc6f8
+  data.tar.gz: 5abf03d2e69b2e7489417d03d9abc6fbe1058eeb798fdcd772a0ec6675d7a33f
 SHA512:
-  metadata.gz: e366722a7e60c18cf09be666f5eb4017139d2880f242478e3ce76cb1571bd8ed26898d038e82357853923bdfc9317bfbff1007a68ab85e95d31f1a660d816a29
-  data.tar.gz: 982ba9aa76a859dd21ecf6ffbee6edcf4622d14b042dfbe544ed03edae46e2aeda1f4221b3ac0efe9c8e35e78a442de9b56502cdbe67ebafb9b686d5dbc2bf86
+  metadata.gz: 2baa59fbcc6ee1e2aa0a246a068542880852d23648bf0f1454202269a75ca0f7172fe6cb3502c7fa595f5bb642729072f78e8f7edc64afddb7b84f8288d7c912
+  data.tar.gz: 6c1ebc6c715a256441ea8a91432c60e628c73e88c5ea3ca805d08341ff52c669a040a7d44edcd180b704459d3ed1dd02bcf65597316436d4ace19ca8111f11a2

data/README.md

@@ -30,6 +30,19 @@ converter = JsonStructMapper.from_file('data.json', 'users')
 converter.object.name
 converter.object.email
 ```
+### From a JSON file and create a template of the json
+```ruby
+# Load entire JSON file
+converter = JsonStructMapper.from_json_file_to_template('data.json')
+
+# Load specific key from JSON file
+converter = JsonStructMapper.from_json_file_to_template('data.json', 'users')
+
+# Default struct values
+converter.object.name # => nil
+# Assign data via struct
+converter.object.name = 'Jhon'
+```
 ### From a Hash
 ```ruby
 hash = { name: 'John', age: 30, address: { city: 'NYC' } }
@@ -38,6 +51,13 @@ converter = JsonStructMapper.from_hash(hash)
 converter.object.name # => 'John'
 converter.object.address.city # => 'NYC'
 ```
+empty hash will return nil value
+```ruby
+hash = { name: 'John', age: 30, address: {} }
+converter = JsonStructMapper.from_hash(hash)
+
+converter.object.address # => nil
+```
 ### From a JSON string
 ```ruby
 json_string = '{"name": "John", "age": 30}'

data/lib/json_struct_mapper/converter.rb

@@ -43,6 +43,40 @@ module JsonStructMapper
       raise InvalidJSONError, "Failed to parse JSON: #{e.message}"
     end
 
+    # Create a Converter from a JSON file, initialising with nil values
+    # @param file_path [String] Path to the JSON file
+    # @return [Converter] new instance
+    # @raise [FileNotFoundError] if file doesn't exist
+    # @raise [InvalidJSONError] if JSON is malformed
+    def self.from_json_file_to_template(file_path, key = nil)
+      instance = new(file_path, key) # Create an instance of the class
+      struct = instance.send(:load_from_file, file_path, key) # Call the instance method
+      instance.instance_variable_set(:@object, instance.send(:reset_struct_values, struct))
+      instance
+    end
+
+    # Function to remove all values from a struct and initialize with nil
+    #
+    # @param struct [Struct] to convert
+    # @return [Struct] struct with nil values
+    def reset_struct_values(struct)
+      struct.members.each do |member|
+        value = struct[member]
+        if value.is_a?(Struct)
+          reset_struct_values(value) # Recursively reset nested structs
+        elsif value.is_a?(Array)
+          if value.any? { |item| item.is_a?(Struct) }
+            value.each { |item| reset_struct_values(item) if item.is_a?(Struct) } # Reset structs inside arrays
+          else
+            struct[member] = nil # Set the array to nil if it doesn't contain structs
+          end
+        else
+          struct[member] = nil
+        end
+      end
+      struct
+    end
+
     # Convert the struct object back to a hash
     #
     # @param compact [Boolean] whether to remove nil values
@@ -83,6 +117,7 @@ module JsonStructMapper
     # @return [Struct] converted struct
     def hash_to_struct(hash)
       return hash unless hash.is_a?(Hash)
+      return nil if hash.is_a?(Hash) && hash.empty? # Return nil for empty hashes
 
       struct_class = Struct.new(*hash.keys.map(&:to_sym))
       struct_class.new(*hash.values.map { |value| convert_value_to_struct(value) })

data/lib/json_struct_mapper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonStructMapper
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/json_struct_mapper.rb

@@ -21,5 +21,10 @@ module JsonStructMapper
     def from_json(json_string, key = nil)
       Converter.from_json(json_string, key)
     end
+
+    # Convenience method to create a converter from a JSON file and creating template of it
+    def from_json_file_to_template(file_path, key = nil)
+      Converter.from_json_file_to_template(file_path, key)
+    end
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: json_struct_mapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Shivani Uppala
 - Sumit Ghosh
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-12 00:00:00.000000000 Z
+date: 2025-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -90,6 +91,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/UppalaShivani/json_struct_mapper/blob/main/README.md
   source_code_uri: https://github.com/UppalaShivani/json_struct_mapper
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,7 +106,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Convert JSON data into Ruby Struct objects with bidirectional mapping
 test_files: []