json_path_attribute 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2b74d1b64eefe49f524f7204997ba6879177092ecaa50dd1f0a39ee1a5e1f9c
+  data.tar.gz: 5d27f669c336f92ff6144cd863175bbbfe139cf3c738a2fb2778157a48deebf0
+SHA512:
+  metadata.gz: 807da0b92649d4274798f2ea5d651e62533ef3e2b97866f5c3630ec9c13f4751ab9f8c5f2bc896f39761a72ab906ff34872880684b3000a7562dfe5024f52d62
+  data.tar.gz: 7c1753866d8d7583098d3c1a65a3ea2e5c2d36641da3864d1ce9c0382f6af2a0bbc0c51d2675675dec6d768254f05c587513fff191b0ef199992518e801f05cf

data/.rubocop.yml

@@ -0,0 +1,16 @@
+plugins:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  Exclude:
+    - 'test/**/*'
+    - 'vendor/**/*'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.0.1 - 2025-09-20
+
+Initial version

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Beequip B.V.
+
+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,86 @@
+# JsonPathAttribute
+
+JsonPathAttribute is a simple but powerful object mapper to map JSON or Hash data into Ruby objects, using [JsonPath](https://github.com/joshbuddy/jsonpath).
+
+Although this gem has been released fairly recently, it was originally developed for [Beequip](http://beequip.com) and a very similar version has been used for a few years.
+
+## Usage
+
+Given a JSON (or Ruby hash) like this:
+
+```json
+{
+  "post": {
+    "title": "How to drive on snow?",
+    "body": "Just use a low gear and slowly build up speed",
+    "likes": 12,
+    "comments": [
+      {
+        "body": "Thank you for the tip! It is very useful.",
+        "user": {
+          "name": "Charles Careful"
+        }
+      }
+    ]
+  }
+}
+```
+
+You can include `JsonPathAttribute` to a Ruby class:
+
+```ruby
+class Post
+  include JsonPathAttribute
+
+  json_path_attribute :title, path: 'post.title'
+  json_path_attribute :likes, path: 'post.likes', type: :integer
+  json_path_attribute :comments, path: 'post.comments[*]', type: Comment, array: true
+end
+
+class Comment
+  include JsonPathAttribute
+
+  json_path_attribute :body, path: 'body'
+  json_path_attribute :name, path: 'user.name'
+end
+```
+
+And it gets parsed like this
+
+```ruby
+post = Post.parse(json) # => <Post:...>
+post.title # => "How to drive on snow?"
+post.body # => "Just use a low gear and slowly build up speed"
+post.likes # => 12
+post.comments # => [#<Comment:0x000000011e4354d0 @body="Thank you for the tip! It is very useful.", @name="Charles Careful">]
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add json_path_attribute
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install json_path_attribute
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/BEEQUIP/json_path_attribute.
+
+## Acknowledgements
+
+Thanks to the original authors [jdongelmans](https://github.com/jdongelmans) and [jandintel](https://github.com/jandintel).
+
+Also thanks to [joshbuddy](https://github.com/joshbuddy) for creating [JsonPath](https://github.com/joshbuddy/jsonpath).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/json_path_attribute/attribute_definition.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module JsonPathAttribute
+  AttributeDefinition = Data.define(:type, :path_string, :array) do
+    def array? = !!array
+    def path = path_string.include?(" ") ? "'#{path_string}'" : path_string
+    def full_path = "$.#{path}"
+
+    def value(parsed)
+      value = JsonPath.on(parsed, full_path)
+      value = value.first unless full_path.include?("[*]") && value.present?
+      value = [] if value.nil? && array?
+      value
+    end
+  end
+end

data/lib/json_path_attribute/type.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "active_model"
+
+module JsonPathAttribute
+  # Provides a way to cast values to a specific type
+  # This class is intended to be used internally by JsonPathAttribute
+  class Type
+    class << self
+      def cast_attribute(type, value, array: false)
+        return value if type == :source
+        return cast_object_attribute(type, value, array: array) if type.is_a?(Class)
+
+        cast_to(type, value, array: array)
+      end
+
+      def cast_to(type, value, array: false)
+        return [] if value.nil? && array
+        return false if value.nil? && type == :boolean
+
+        cast_type = ActiveModel::Type.lookup(type)
+
+        if array
+          cast_array(value, type, cast_type)
+        else
+          cast_value(value, type, cast_type)
+        end
+      end
+
+      def cast_array(values, type, cast_type)
+        values.map do |value|
+          next false if value.nil? && type == :boolean
+
+          cast_type.cast(value)
+        end
+      end
+
+      def cast_value(value, type, cast_type)
+        value = value.to_s if type == :decimal && value.is_a?(Float)
+
+        cast_type.cast(value)
+      end
+
+      def cast_object_attribute(type, value, array:)
+        raise ArgumentError, "Unable to cast #{value.inspect} to #{type} object" if value.nil?
+
+        if array
+          value.map { |element| type.parse(element) }
+        else
+          type.parse(value)
+        end
+      end
+    end
+  end
+end

data/lib/json_path_attribute/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JsonPathAttribute
+  VERSION = "0.1.1"
+end

data/lib/json_path_attribute.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "json"
+require "jsonpath"
+require "active_support/core_ext/hash/keys"
+
+require_relative "json_path_attribute/attribute_definition"
+require_relative "json_path_attribute/type"
+require_relative "json_path_attribute/version"
+
+# Include this module
+#   class Post
+#     include JsonPathAttribute
+#
+#     json_path_attribute:title, path: 'title'
+#   end
+module JsonPathAttribute
+  class Error < StandardError; end
+  class TypeCastError < Error; end
+
+  ##
+  # This module includes the class methods:
+  #   .path_attribute
+  #   .path_attribute_definitions
+  #   .parse
+  #   .parse_collection
+  #   .parse_first
+  # See the respective methods for documentation
+  module ClassMethods
+    # This method is used to define an attribute expected at a specific path
+    # It also adds an instance variable with reader and setter method with the given name
+    # @name [Symbol] Also adds a reader and setter method with the given name
+    # @path [String] JSON Path
+    # @type [Symbol | Class] (optional) Casts the attribute to the defined type.
+    #       This argument can be a symbol, like `:integer` or `:string`, or another class
+    #       that includes JsonPathAttribute.
+    # @array [Boolean]
+    def json_path_attribute(name, path:, type: :source, array: false)
+      attribute_definitions[name] = AttributeDefinition.new(type: type, path_string: path, array: array)
+
+      define_method name do
+        instance_variable_get("@#{name}")
+      end
+
+      define_method "#{name}=" do |value|
+        instance_variable_set("@#{name}", Type.cast_attribute(type, value, array: array))
+      end
+    end
+
+    def attribute_definitions
+      @attribute_definitions ||= {}
+    end
+
+    def parse(json_or_hash)
+      parsed = parse_json_hash_or_array(json_or_hash)
+
+      attributes = attribute_definitions.each_with_object({}) do |(name, definition), hash|
+        value = definition.value(parsed)
+
+        next if value.nil?
+
+        hash[name] = value
+      end
+
+      new(attributes.merge(response: parsed))
+    end
+
+    def parse_collection(json_array_or_array)
+      array = parse_json_hash_or_array(json_array_or_array)
+      array.map do |item|
+        parse(item)
+      end
+    end
+
+    def parse_first(json_array_or_array)
+      array = parse_json_hash_or_array(json_array_or_array)
+      parse(array.first)
+    end
+
+    private
+
+    def parse_json_hash_or_array(json_hash_or_array)
+      json_hash_or_array = json_hash_or_array.deep_stringify_keys if json_hash_or_array.is_a?(Hash)
+      json_hash_or_array.is_a?(String) ? JSON.parse(json_hash_or_array) : json_hash_or_array
+    end
+  end
+
+  attr_accessor :response
+
+  def initialize(attributes = {})
+    attributes.each do |name, value|
+      public_send("#{name}=", value)
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+end

data/sig/path_attribute.rbs

@@ -0,0 +1,4 @@
+module JsonPathAttribute
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: json_path_attribute
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Daniël de Vries
+- Jan van der Pas
+- Marthyn Olthof
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: jsonpath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: JsonPathAttribute is an object mapper to create Ruby objects from JSON
+email:
+- daniel.devries@beequip.nl
+- jan.vanderpas@beequip.nl
+- marthyn.olthof@beequip.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/json_path_attribute.rb
+- lib/json_path_attribute/attribute_definition.rb
+- lib/json_path_attribute/type.rb
+- lib/json_path_attribute/version.rb
+- sig/path_attribute.rbs
+homepage: https://github.com/BEEQUIP/json_path_attribute
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/BEEQUIP/json_path_attribute
+  changelog_uri: https://github.com/BEEQUIP/json_path_attribute/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: An object mapper for mapping JSON data to a Ruby object
+test_files: []