json_struct_mapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e1a4c44ea87b099135a38beb8be6cf25462334d112b117317ad735335e6f72b
+  data.tar.gz: f036202b6da95d30cfc4daf23b10719190a9422d3151e7e5bc847b735f98c6b5
+SHA512:
+  metadata.gz: e366722a7e60c18cf09be666f5eb4017139d2880f242478e3ce76cb1571bd8ed26898d038e82357853923bdfc9317bfbff1007a68ab85e95d31f1a660d816a29
+  data.tar.gz: 982ba9aa76a859dd21ecf6ffbee6edcf4622d14b042dfbe544ed03edae46e2aeda1f4221b3ac0efe9c8e35e78a442de9b56502cdbe67ebafb9b686d5dbc2bf86

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Uppala Shivani
+
+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,99 @@
+# JsonStructMapper
+
+JsonStructMapper provides an easy way to convert JSON files and hashes into Ruby Struct objects, with support for nested structures and arrays. It also supports converting Structs back to hashes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_struct_mapper'
+```
+And then execute:
+```ruby
+$ bundle install
+```
+Or install it yourself as:
+```ruby
+$ gem install json_struct_mapper
+```
+## Usage
+### From a JSON file
+```ruby
+# Load entire JSON file
+converter = JsonStructMapper.from_file('data.json')
+
+# Load specific key from JSON file
+converter = JsonStructMapper.from_file('data.json', 'users')
+
+# Access data via struct
+converter.object.name
+converter.object.email
+```
+### From a Hash
+```ruby
+hash = { name: 'John', age: 30, address: { city: 'NYC' } }
+converter = JsonStructMapper.from_hash(hash)
+
+converter.object.name # => 'John'
+converter.object.address.city # => 'NYC'
+```
+### From a JSON string
+```ruby
+json_string = '{"name": "John", "age": 30}'
+converter = JsonStructMapper.from_json(json_string)
+
+converter.object.name # => 'John'
+```
+### Convert back to Hash or JSON
+```ruby
+# Convert to hash (removes nil values by default)
+hash = converter.to_hash
+
+# Keep nil values
+hash = converter.to_hash(compact: false)
+
+# Convert to JSON string
+json = converter.to_json
+
+# Pretty print JSON
+json = converter.to_json(pretty: true)
+```
+### Handling nested structures
+```ruby
+json = {
+  user: {
+    name: 'John',
+    contacts: [
+      { type: 'email', value: 'john@example.com' },
+      { type: 'phone', value: '123-456-7890' }
+    ]
+  }
+}
+
+converter = JsonStructMapper.from_hash(json)
+converter.object.user.contacts[0].value # => 'john@example.com'
+```
+## Error Handling
+The gem provides specific error classes:
+1. JsonStructMapper::FileNotFoundError - When file doesn't exist
+2. JsonStructMapper::InvalidJSONError - When JSON is malformed
+3. JsonStructMapper::InvalidKeyError - When specified key doesn't exist
+
+```ruby
+begin
+  converter = JsonStructMapper.from_file('missing.json')
+rescue JsonStructMapper::FileNotFoundError => e
+  puts "File error: #{e.message}"
+end
+```
+
+## Development
+After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
+To install this gem onto your local machine, run bundle exec rake install.
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/UppalaShivani/json_struct_mapper.
+
+## License
+The gem is available as open source under the terms of the MIT License.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/json_struct_mapper.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/json_struct_mapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'json_struct_mapper'
+  spec.version = JsonStructMapper::VERSION
+  spec.authors = ['Shivani Uppala', 'Sumit Ghosh']
+  spec.email = ['uppalashivani@gmail.com']
+
+  spec.summary = 'Convert JSON data into Ruby Struct objects with bidirectional mapping'
+  spec.description = 'JsonStructMapper provides an easy way to convert JSON files and hashes into Ruby Struct objects,
+                      with support for nested structures and arrays. It also supports converting Structs
+                      back to hashes.'
+  spec.homepage = 'https://github.com/UppalaShivani/json_struct_mapper/blob/main/README.md'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/UppalaShivani/json_struct_mapper'
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Dependencies
+  spec.add_dependency 'json', '~> 2.0'
+
+  # Development dependencies
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.21'
+end

data/lib/json_struct_mapper/converter.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module JsonStructMapper
+  # Converter class handles the conversion between JSON/Hash and Struct objects
+  class Converter
+    attr_reader :object
+
+    # Initialize with a file path and optional key to extract from JSON
+    #
+    # @param file_path [String] Path to the JSON file
+    # @param key [String, nil] Optional key to extract from the JSON root
+    # @raise [FileNotFoundError] if file doesn't exist
+    # @raise [InvalidJSONError] if JSON is malformed
+    # @raise [InvalidKeyError] if specified key doesn't exist
+    def initialize(file_path, key = nil)
+      @object = load_from_file(file_path, key)
+    end
+
+    # Create a Converter from a hash directly
+    #
+    # @param hash [Hash] Hash to convert to struct
+    # @return [Converter] new instance
+    def self.from_hash(hash)
+      instance = allocate
+      instance.instance_variable_set(:@object, instance.send(:hash_to_struct, hash))
+      instance
+    end
+
+    # Create a Converter from a JSON string
+    #
+    # @param json_string [String] JSON string to parse and convert
+    # @param key [String, nil] Optional key to extract from the JSON root
+    # @return [Converter] new instance
+    def self.from_json(json_string, key = nil)
+      data_hash = JSON.parse(json_string)
+      hash = key ? data_hash[key] : data_hash
+      raise InvalidKeyError, "Key '#{key}' not found in JSON" if key && hash.nil?
+
+      from_hash(hash)
+    rescue JSON::ParserError => e
+      raise InvalidJSONError, "Failed to parse JSON: #{e.message}"
+    end
+
+    # Convert the struct object back to a hash
+    #
+    # @param compact [Boolean] whether to remove nil values
+    # @return [Hash] converted hash
+    def to_hash(compact: true)
+      hash = struct_to_hash(@object)
+      compact ? compact_hash(hash) : hash
+    end
+
+    # Convert the struct object to JSON
+    #
+    # @param pretty [Boolean] whether to format with indentation
+    # @return [String] JSON string
+    def to_json(pretty: false)
+      hash = to_hash
+      pretty ? JSON.pretty_generate(hash) : JSON.generate(hash)
+    end
+
+    private
+
+    def load_from_file(file_path, key)
+      raise FileNotFoundError, "File not found: #{file_path}" unless File.exist?(file_path)
+
+      json_data = File.read(file_path)
+      data_hash = JSON.parse(json_data)
+
+      hash = key ? data_hash[key] : data_hash
+      raise InvalidKeyError, "Key '#{key}' not found in JSON" if key && hash.nil?
+
+      hash_to_struct(hash)
+    rescue JSON::ParserError => e
+      raise InvalidJSONError, "Failed to parse JSON: #{e.message}"
+    end
+
+    # Recursively converts a hash to a Struct
+    #
+    # @param hash [Hash] hash to convert
+    # @return [Struct] converted struct
+    def hash_to_struct(hash)
+      return hash unless hash.is_a?(Hash)
+
+      struct_class = Struct.new(*hash.keys.map(&:to_sym))
+      struct_class.new(*hash.values.map { |value| convert_value_to_struct(value) })
+    end
+
+    # Convert individual values (handles Hash, Array, and primitives)
+    def convert_value_to_struct(value)
+      case value
+      when Hash
+        hash_to_struct(value)
+      when Array
+        value.map { |v| convert_value_to_struct(v) }
+      else
+        value
+      end
+    end
+
+    # Converts a Struct back to a hash
+    #
+    # @param struct [Struct] struct to convert
+    # @return [Hash] converted hash
+    def struct_to_hash(struct)
+      return struct unless struct.is_a?(Struct)
+
+      struct.to_h.transform_values { |value| convert_value_to_hash(value) }
+    end
+
+    # Convert individual values back (handles Struct, Array, and primitives)
+    def convert_value_to_hash(value)
+      case value
+      when Struct
+        struct_to_hash(value)
+      when Array
+        value.map { |v| convert_value_to_hash(v) }
+      else
+        value
+      end
+    end
+
+    # Recursively removes nil values from a hash
+    #
+    # @param hash [Hash] hash to compact
+    # @return [Hash] compacted hash
+    def compact_hash(hash)
+      hash.each_with_object({}) do |(k, v), result|
+        next if v.nil?
+
+        result[k] = v.is_a?(Hash) ? compact_hash(v) : v
+      end
+    end
+  end
+end

data/lib/json_struct_mapper/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module JsonStructMapper
+  class Error < StandardError; end
+  class FileNotFoundError < Error; end
+  class InvalidJSONError < Error; end
+  class InvalidKeyError < Error; end
+end

data/lib/json_struct_mapper/version.rb

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

data/lib/json_struct_mapper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'json_struct_mapper/version'
+require_relative 'json_struct_mapper/errors'
+require_relative 'json_struct_mapper/converter'
+
+# JsonStructMapper provides an easy way to convert JSON data into Ruby Struct objects
+module JsonStructMapper
+  class << self
+    # Convenience method to create a converter from a file
+    def from_file(file_path, key = nil)
+      Converter.new(file_path, key)
+    end
+
+    # Convenience method to create a converter from a hash
+    def from_hash(hash)
+      Converter.from_hash(hash)
+    end
+
+    # Convenience method to create a converter from a JSON string
+    def from_json(json_string, key = nil)
+      Converter.from_json(json_string, key)
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: json_struct_mapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shivani Uppala
+- Sumit Ghosh
+bindir: exe
+cert_chain: []
+date: 2025-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: |-
+  JsonStructMapper provides an easy way to convert JSON files and hashes into Ruby Struct objects,
+                        with support for nested structures and arrays. It also supports converting Structs
+                        back to hashes.
+email:
+- uppalashivani@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- json_struct_mapper.gemspec
+- lib/json_struct_mapper.rb
+- lib/json_struct_mapper/converter.rb
+- lib/json_struct_mapper/errors.rb
+- lib/json_struct_mapper/version.rb
+homepage: https://github.com/UppalaShivani/json_struct_mapper/blob/main/README.md
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/UppalaShivani/json_struct_mapper/blob/main/README.md
+  source_code_uri: https://github.com/UppalaShivani/json_struct_mapper
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: Convert JSON data into Ruby Struct objects with bidirectional mapping
+test_files: []