Initial commit

danieldevries · danieldevries · commit ae18bb00d355 · 2025-11-10T17:15:42.000+01:00
This is a near 1-to-1 extraction of the code we have been using in
production for over 5 years now.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,29 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.4.7'
+          - '3.3.10'
+          - '3.2.9'
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run the default task
+        run: bundle exec rake
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+/Gemfile.lock
+*.gem
diff --git a/.rubocop.yml b/.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
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.0.1 - 2025-09-20
+
+Initial version
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "debug", ">= 1.0.0"
+gem "irb"
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.16"
+
+gem "rubocop", "~> 1.21"
+gem "rubocop-minitest"
+gem "rubocop-rake"
diff --git a/LICENSE.txt b/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.
diff --git a/README.md b/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).
diff --git a/Rakefile b/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]
diff --git a/bin/console b/bin/console
@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "path_attribute"
+
+require "irb"
+IRB.start(__FILE__)
diff --git a/bin/setup b/bin/setup
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
diff --git a/json_path_attribute.gemspec b/json_path_attribute.gemspec
@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/json_path_attribute/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "json_path_attribute"
+  spec.version = JsonPathAttribute::VERSION
+  spec.authors = ["Daniël de Vries", "Jan van der Pas", "Marthyn Olthof"]
+  spec.email = %w[daniel.devries@beequip.nl jan.vanderpas@beequip.nl marthyn.olthof@beequip.nl]
+
+  spec.summary = "An object mapper for mapping JSON data to a Ruby object"
+  spec.description = "JsonPathAttribute is an object mapper to create Ruby objects from JSON"
+  spec.homepage = "https://github.com/BEEQUIP/json_path_attribute"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  gemspec = File.basename(__FILE__)
+  spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+    ls.readlines("\x0", chomp: true).reject do |f|
+      (f == gemspec) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel", "~> 7.2"
+  spec.add_dependency "activesupport", "~> 7.2"
+  spec.add_dependency "jsonpath", "~> 1.1"
+end
diff --git a/lib/json_path_attribute.rb b/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
diff --git a/lib/json_path_attribute/attribute_definition.rb b/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
diff --git a/lib/json_path_attribute/type.rb b/lib/json_path_attribute/type.rb
diff --git a/lib/json_path_attribute/version.rb b/lib/json_path_attribute/version.rb
diff --git a/sig/path_attribute.rbs b/sig/path_attribute.rbs
diff --git a/test/test_helper.rb b/test/test_helper.rb
diff --git a/test/test_json_path_attribute.rb b/test/test_json_path_attribute.rb
