emp_json 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c980a0bd41e0236610d10af6521e6e41ed39329973c51acdaf48a5567e6162a
+  data.tar.gz: a260ad775292dfbdc03c25a2d9472164687b918d73f85af4706a1cad7e31f367
+SHA512:
+  metadata.gz: 2b7c38569fc8700ea138d1fb0fc6dfb82caee3b8c3e805f50d5c06a7912f1bba3233c568980b4614d9d8ac4477ced6fb07dfdb3482fa00ec4eafbb69722500af
+  data.tar.gz: 591b643b63e2d0e497c7ba8c0989518a357b34d0b3d36b04b72872d9c11637bf5a28215aeb23f779ba5066c939bd72ad680d7e68d3d00c1b70d0dc27fb5c92e3

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 20
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-05-09
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1 @@
+Be civil

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in emp_json_rb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "activemodel", "~> 7"
+
+gem "activesupport", "~> 7"
+
+gem "rdf"

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    emp_json (1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.3)
+      activesupport (= 7.0.3)
+    activesupport (7.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    link_header (0.0.8)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rdf (3.2.7)
+      link_header (~> 0.0, >= 0.0.8)
+    regexp_parser (2.3.1)
+    rexml (3.2.5)
+    rubocop (1.29.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  activemodel (~> 7)
+  activesupport (~> 7)
+  emp_json!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rdf
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Thom van Kalkeren
+
+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,33 @@
+# Empathy::Json
+
+A gem to serialize and manipulate [EmpJson](https://empathy.tools/specifications/emp-json) slices.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add emp_json_rb
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install emp_json_rb
+
+## Usage
+
+The module was built to work with [rdf-serializers](https://github.com/ontola/rdf-serializers), and uses serializer descriptions from that gem.
+
+Include the `Empathy::Json::Slices` module and call `emp_json_hash(resource)` for a hash representation or `render_emp_json(resource)` for a stringified version.
+
+## 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/empathy-tools/emp_json_rb. Contributors are expected to adhere to the [code of conduct](https://github.com/empathy-tools/emp_json_rb/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/emp-json-rb.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/empathy/emp_json/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "emp_json"
+  spec.version = Empathy::EmpJson::VERSION
+  spec.authors = ["Thom van Kalkeren"]
+  spec.email = ["thom@ontola.io"]
+
+  spec.summary = "Serializer for the EmpJson specification."
+  spec.description = "Serializer for the EmpJson specification."
+  spec.homepage = "https://empathy.tools/tools/emp-json"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0.preview1"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/empathy-tools/emp_json_rb"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/empathy-tools/emp_json_rb/issues"
+  spec.metadata["changelog_uri"] = "https://github.com/empathy-tools/emp_json_rb/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/lib/empathy/emp_json/helpers/primitives.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require "active_support/time_with_zone"
+
+module Empathy
+  module EmpJson
+    module Helpers
+      # Functions relating to serializing primitives.
+      module Primitives # rubocop:disable Metrics/ModuleLength
+        EMP_TYPE_GLOBAL_ID = "id"
+        EMP_TYPE_LOCAL_ID = "lid"
+        EMP_TYPE_DATETIME = "dt"
+        EMP_TYPE_STRING = "s"
+        EMP_TYPE_BOOL = "b"
+        EMP_TYPE_INTEGER = "i"
+        EMP_TYPE_LONG = "l"
+        EMP_TYPE_PRIMITIVE = "p"
+        EMP_TYPE_LANGSTRING = "ls"
+
+        RDF_RDFV = "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+        RDF_RDFV_LANGSTRING = "#{RDF_RDFV}langString"
+        RDF_RDFS = "http://www.w3.org/2000/01/rdf-schema#"
+        RDF_XSD = "http://www.w3.org/2001/XMLSchema#"
+        RDF_XSD_TOKEN = "#{RDF_XSD}token"
+        RDF_XSD_STRING = "#{RDF_XSD}string"
+        RDF_XSD_DATETIME = "#{RDF_XSD}dateTime"
+        RDF_XSD_BOOLEAN = "#{RDF_XSD}boolean"
+        RDF_XSD_INTEGER = "#{RDF_XSD}integer"
+
+        def object_to_value(value)
+          return primitive_to_value(value.iri) if value.respond_to?(:iri)
+
+          return primitive_to_value(value.subject) if value.is_a?(RDF::List)
+
+          primitive_to_value(value)
+        end
+
+        def node_to_local_id(value)
+          shorthand(EMP_TYPE_LOCAL_ID, "_:#{value.id}")
+        end
+
+        def primitive_to_value(value) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/AbcSize
+          throw_unknown_ruby_object(value) if value.nil?
+
+          case value
+          when RDF::Node
+            node_to_local_id(value)
+          when RDF::URI, URI
+            shorthand(EMP_TYPE_GLOBAL_ID, value.to_s)
+          when DateTime, ActiveSupport::TimeWithZone
+            shorthand(EMP_TYPE_DATETIME, value.iso8601)
+          when String
+            shorthand(EMP_TYPE_STRING, value)
+          when true, false
+            shorthand(EMP_TYPE_BOOL, value.to_s)
+          when Symbol
+            primitive(RDF_XSD_TOKEN, value.to_s)
+          when Integer
+            integer_to_value(value)
+          when Float, Numeric
+            use_rdf_rb_for_primitive(value)
+          when RDF::Literal
+            rdf_literal_to_value(value)
+          else
+            throw_unknown_ruby_object(value)
+          end
+        end
+
+        def integer_to_value(value)
+          size = value.bit_length
+          if size <= 32
+            shorthand(EMP_TYPE_INTEGER, value.to_s)
+          elsif size > 32 && size <= 64
+            shorthand(EMP_TYPE_LONG, value.to_s)
+          else
+            use_rdf_rb_for_primitive(value)
+          end
+        end
+
+        def rdf_literal_to_value(value)
+          case value.datatype.to_s
+          when RDF_RDFV_LANGSTRING
+            {
+              type: EMP_TYPE_LANGSTRING,
+              l: value.language.to_s,
+              v: value.value
+            }
+          when RDF_XSD_STRING
+            shorthand(EMP_TYPE_STRING, value.value)
+          when RDF_XSD_DATETIME
+            shorthand(EMP_TYPE_DATETIME, value.value)
+          when RDF_XSD_BOOLEAN
+            shorthand(EMP_TYPE_BOOL, value.value)
+          when RDF_XSD_INTEGER
+            integer_to_value(value.to_i)
+          else
+            throw "unknown RDF::Literal"
+          end
+        end
+
+        def use_rdf_rb_for_primitive(value)
+          rdf = RDF::Literal(value)
+          primitive(rdf.datatype.to_s, rdf.value)
+        end
+
+        def shorthand(type, value)
+          {
+            type: type,
+            v: value
+          }
+        end
+
+        def primitive(datatype, value)
+          {
+            type: EMP_TYPE_PRIMITIVE,
+            dt: datatype,
+            v: value
+          }
+        end
+
+        def throw_unknown_ruby_object(value)
+          throw "unknown ruby object: #{value} (#{value.class})"
+        end
+      end
+    end
+  end
+end

data/lib/empathy/emp_json/helpers/rdf_list.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Empathy
+  module EmpJson
+    module Helpers
+      # Functions relating to serializing RDF::List records
+      module RDFList
+        def add_rdf_list_to_slice(slice, symbolize, **options)
+          elem = options.delete(:resource)
+          loop do
+            list_item_to_record(slice, elem, symbolize)
+
+            break if elem.rest_subject == NS.rdfv.nil
+
+            elem = elem.rest
+          end
+        end
+
+        def list_item_to_record(slice, elem, symbolize) # rubocop:disable Metrics/AbcSize
+          rid = add_record_to_slice(slice, elem)
+          add_attribute_to_record(slice, rid, NS.rdfv.type, NS.rdfv.List, symbolize)
+          first = elem.first.is_a?(RDF::Term) ? elem.first : retrieve_id(elem.first)
+          add_attribute_to_record(slice, rid, NS.rdfv.first, first, symbolize)
+          add_attribute_to_record(slice, rid, NS.rdfv.rest, elem.rest_subject, symbolize)
+        end
+      end
+    end
+  end
+end

data/lib/empathy/emp_json/helpers/slices.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/indifferent_access"
+
+module Empathy
+  module EmpJson
+    module Helpers
+      # Additional functions for working with slices
+      module Slices
+        # Retrieves all values for the given [field].
+        def all_values_from_slice(slice, field, _website_iri = nil)
+          slice
+            .values
+            .flat_map { |record| field_from_record(record, field) }
+            .map { |values| normalise_slice_values(values) }
+            .compact
+        end
+
+        def add_record_to_slice(slice, resource)
+          id = resource.is_a?(RDF::Resource) ? resource : retrieve_id(resource)
+          value = primitive_to_value(id)
+
+          unless slice_includes_record?(slice, resource)
+            slice[value[:v]] = {
+              _id: value
+            }
+          end
+
+          value[:v]
+        end
+
+        # Returns a normalised fields array for a record from a slice.
+        def values_from_slice(slice, id, field, website_iri = nil)
+          values = field_from_slice(slice, id, field, website_iri)
+
+          normalise_slice_values(values)
+        end
+
+        # Returns the fields for a record from a slice.
+        def field_from_slice(slice, id, field, website_iri = nil)
+          record = record_from_slice(slice, id, website_iri)
+          return unless record.present?
+
+          field_from_record(record, field)
+        end
+
+        # Returns a record from a slice.
+        def record_from_slice(slice, id, website_iri = nil)
+          slice[absolutized_id(retrieve_id(id), website_iri)] || slice[retrieve_id(id)]
+        end
+
+        def field_from_record(record, field)
+          field = URI(field.to_s)
+          symbolized = (field.fragment || field.path.split("/").last).camelize(:lower)
+          (record[field.to_s] || record[symbolized])&.compact
+        end
+
+        def retrieve_id(resource)
+          return resource.to_s if resource.is_a?(URI) || resource.is_a?(RDF::URI)
+
+          resource.try(:iri) || resource.try(:subject) || resource.try(:id) || resource
+        end
+
+        def absolutized_id(id, website_iri = nil)
+          return id.to_s.delete_prefix(website_iri) if website_iri.present?
+
+          id.to_s
+        end
+
+        def normalise_slice_values(values)
+          values.is_a?(Array) ? values.map(&:with_indifferent_access) : values&.with_indifferent_access
+        end
+
+        def expand(slice, website_iri = current_tenant)
+          return slice unless website_iri.present?
+
+          slice.transform_keys { |k| k.start_with?("/") ? website_iri + k : k }
+        end
+
+        def field_to_symbol(uri)
+          (uri.fragment || uri.path.split("/").last).camelize(:lower)
+        end
+
+        def slice_includes_record?(slice, resource)
+          slice.key?(object_to_value(resource)[:v])
+        end
+      end
+    end
+  end
+end

data/lib/empathy/emp_json/helpers/values.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Empathy
+  module EmpJson
+    module Helpers
+      # Functions relating to adding values to records
+      module Values
+        def add_attribute_to_record(slice, rid, key, value, symbolize)
+          return if value.nil?
+
+          symbol = uri_to_symbol(key, symbolize)
+          emp_value = value_to_emp_value(value)
+          current_value = slice[rid][symbol]
+
+          slice[rid][symbol] =
+            if current_value.is_a?(Array)
+              [*current_value, *(emp_value.is_a?(Array) ? emp_value : [emp_value])]
+            elsif current_value
+              [current_value, *(emp_value.is_a?(Array) ? emp_value : [emp_value])]
+            else
+              emp_value
+            end
+        end
+
+        def wrap_relation_in_sequence(value, resource)
+          LinkedRails::Sequence.new(
+            value.is_a?(Array) ? value : [value],
+            parent: resource,
+            scope: false
+          )
+        end
+
+        def uri_to_symbol(uri, symbolize)
+          return uri.to_s unless symbolize
+
+          casing = symbolize == :class ? :upper : :lower
+
+          (uri.fragment || uri.path.split("/").last).camelize(casing)
+        end
+
+        def value_to_emp_value(value)
+          return object_to_value(value) if value.nil?
+
+          case value
+          when SUPPORTS_SEQUENCE ? LinkedRails::Sequence : nil
+            object_to_value(value.iri)
+          when SUPPORTS_RDF_RB ? RDF::List : nil
+            object_to_value(value.subject)
+          when Array, *(SUPPORTS_AR ? [ActiveRecord::Associations::CollectionProxy, ActiveRecord::Relation] : [])
+            value.map { |v| object_to_value(v) }.compact
+          else
+            object_to_value(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/empathy/emp_json/serializer/fields.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Empathy
+  module EmpJson
+    module Serializer
+      # Functions relating to serializing attributes, relations and statements
+      module Fields
+        # Modifies the record parameter
+        def serialize_attributes_to_record(serializer, slice, resource, rid, serialization_params)
+          return [] if serializer.attributes_to_serialize.blank?
+
+          nested_resources = []
+          serializer.attributes_to_serialize.each do |_, attr|
+            next if attr.predicate.blank? || !attr.conditionally_allowed?(resource, serialization_params)
+
+            value = value_for_attribute(attr, resource, serialization_params)
+            symbol = predicate_to_symbol(attr)
+            add_attribute_to_record(slice, rid, symbol, value, false)
+            collect_nested_resources(nested_resources, slice, resource, value, serialization_params) if value.present?
+          end
+
+          nested_resources
+        end
+
+        # Modifies the slice parameter
+        def serialize_statements(serializer, slice, resource, serialization_params)
+          serializer._statements&.each do |key|
+            serializer.send(key, resource, serialization_params).each do |statement|
+              subject, predicate, value = unpack_statement(statement)
+
+              next if value.nil?
+
+              symbol = uri_to_symbol(predicate, symbolize)
+              rid = add_record_to_slice(slice, subject)
+              add_attribute_to_record(slice, rid, symbol, value, false)
+            end
+          end
+        end
+
+        # Modifies the record parameter
+        def serialize_relations_to_record(serializer, slice, resource, rid, serialization_params)
+          return [] if serializer.relationships_to_serialize.blank?
+
+          nested_resources = []
+          serializer.relationships_to_serialize.each do |_, relationship|
+            next unless relationship.include_relationship?(resource, serialization_params)
+
+            value = value_for_relation(relationship, resource, serialization_params)
+            next if value.nil?
+
+            symbol = predicate_to_symbol(relationship)
+            add_attribute_to_record(slice, rid, symbol, value, false)
+
+            collect_nested_resources(nested_resources, slice, resource, value, serialization_params)
+          end
+
+          nested_resources
+        end
+
+        def value_for_attribute(attr, resource, serialization_params)
+          return resource.try(attr.method) if attr.method.is_a?(Symbol)
+
+          FastJsonapi.call_proc(attr.method, resource, serialization_params)
+        end
+
+        def value_for_relation(relation, resource, serialization_params)
+          value = unpack_relation_value(relation, resource, serialization_params)
+
+          return if value.nil?
+
+          if SUPPORTS_SEQUENCE && relation.sequence
+            wrap_relation_in_sequence(value, resource)
+          else
+            value
+          end
+        end
+
+        def unpack_relation_value(relation, resource, serialization_params)
+          if relation.object_block
+            FastJsonapi.call_proc(relation.object_block, resource, serialization_params)
+          else
+            resource.try(relation.key)
+          end
+        end
+
+        def unpack_statement(statement)
+          subject = statement.try(:subject) || statement[0]
+          predicate = statement.try(:predicate) || statement[1]
+          value = statement.try(:object) || statement[2]
+
+          [subject, predicate, value]
+        end
+
+        def predicate_to_symbol(attr)
+          return uri_to_symbol(attr.predicate, symbolize) if attr.predicate.present?
+
+          attr.key
+        end
+      end
+    end
+  end
+end

data/lib/empathy/emp_json/serializer/inclusion.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Empathy
+  module EmpJson
+    module Serializer
+      # Functions relating to determining inclusion of records during serialization.
+      module Inclusion
+        # Modifies the nested_resources parameter
+        def collect_nested_resources(nested_resources, slice, resource, value, serialization_params)
+          case value
+          when LinkedRails::Sequence
+            collect_sequence_and_members(nested_resources, slice, resource, value, serialization_params)
+          when RDF::List
+            nested_resources.push value unless value.subject == NS.rdfv.nil
+          when Array
+            collect_array_members(nested_resources, slice, resource, value, serialization_params)
+          else
+            nested_resources.push value if blank_value?(value) || nested_resource?(resource, value)
+          end
+        end
+
+        def collect_sequence_and_members(nested_resources, slice, resource, value, serialization_params)
+          value.members.map { |m| collect_nested_resources(nested_resources, slice, resource, m, serialization_params) }
+          add_sequence_to_slice(slice, serialization_params, resource: value) unless slice[value.iri.to_s]
+        end
+
+        def collect_array_members(nested_resources, slice, resource, value, serialization_params)
+          value.each { |m| collect_nested_resources(nested_resources, slice, resource, m, serialization_params) }
+        end
+
+        def blank_value?(value)
+          value.try(:iri)&.is_a?(RDF::Node)
+        end
+
+        def nested_resource?(resource, value)
+          value.try(:iri)&.to_s&.include?("#") &&
+            !resource.iri.to_s.include?("#") &&
+            value.iri.to_s.starts_with?(resource.iri.to_s)
+        end
+
+        def process_includes(slice, serialization_params, **options)
+          includes = options.delete(:includes)
+          resource = options.delete(:resource)
+
+          includes.each do |prop, nested|
+            value = resource.try(prop)
+            next if value.blank?
+
+            (value.is_a?(Array) || value.is_a?(ActiveRecord::Relation) ? value : [value]).each do |v|
+              next if slice_includes_record?(slice, v)
+
+              resource_to_emp_json(slice, serialization_params, resource: v, includes: nested, **options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/empathy/emp_json/serializer/records.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext/object/try"
+
+module Empathy
+  module EmpJson
+    module Serializer
+      # Functions relating to serializing records
+      module Records
+        def serialize_record(slice, serialization_params, **options)
+          resource = options.delete(:resource)
+          serializer = options.delete(:serializer_class) || RDF::Serializers.serializer_for(resource)
+
+          rid = add_record_to_slice(slice, resource)
+
+          nested = serialize_record_fields(serializer, slice, resource, rid, serialization_params)
+
+          nested
+            .reject { |r| slice_includes_record?(slice, r) }
+            .each { |r| resource_to_emp_json(slice, serialization_params, resource: r) }
+          process_includes(slice, serialization_params, resource: resource, **options) if options[:includes]
+        end
+
+        def serialize_record_fields(serializer, slice, resource, rid, serialization_params)
+          nested = serialize_attributes_to_record(serializer, slice, resource, rid, serialization_params)
+          nested += serialize_relations_to_record(serializer, slice, resource, rid, serialization_params)
+
+          serialize_statements(serializer, slice, resource, serialization_params)
+
+          nested
+        end
+      end
+    end
+  end
+end

data/lib/empathy/emp_json/serializer/sequence.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Empathy
+  module EmpJson
+    module Serializer
+      # Functions relating to serializing RDF::Sequence records
+      module Sequence
+        def add_sequence_to_slice(slice, serialization_params, **options)
+          resource = options.delete(:resource)
+          serializer = options[:serializer_class] || RDF::Serializers.serializer_for(resource)
+
+          rid = add_record_to_slice(slice, resource)
+
+          serialize_attributes_to_record(serializer, slice, resource, rid, serialization_params)
+          process_sequence_members(serializer, slice, resource, rid, serialization_params, **options)
+        end
+
+        def process_sequence_members(serializer, slice, resource, rid, serialization_params, **options) # rubocop:disable Metrics/ParameterLists
+          nested = []
+          resource.members.each_with_index.map do |m, i|
+            process_sequence_member(m, i, nested, serializer, slice, resource, rid, serialization_params)
+          end
+          nested.each do |r|
+            resource_to_emp_json(slice, serialization_params, resource: r, includes: options[:includes])
+          end
+        end
+
+        def process_sequence_member(member, index, nested, serializer, slice, resource, rid, serialization_params) # rubocop:disable Metrics/ParameterLists
+          index_predicate = serializer.relationships_to_serialize[:members].predicate
+          symbol = uri_to_symbol(index_predicate.call(self, index), symbolize)
+          slice[rid][symbol] = value_to_emp_value(member)
+          collect_nested_resources(nested, slice, resource, member, serialization_params)
+        end
+      end
+    end
+  end
+end

data/lib/empathy/emp_json/serializer/serializing.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Empathy
+  module EmpJson
+    module Serializer
+      # Module for serializing records to slices.
+      module Serializing
+        def render_emp_json(resource = @resource)
+          Oj.fast_generate(emp_json_hash(resource))
+        end
+
+        def emp_json_hash(_resource = @resource)
+          create_slice(@resource)
+        end
+
+        def create_slice(resources)
+          slice = {}
+
+          (resources.is_a?(Array) ? resources : [resources]).each do |resource|
+            resource_to_emp_json(
+              slice,
+              @params,
+              resource: resource,
+              serializer_class: self.class,
+              includes: @rdf_includes
+            )
+          end
+
+          slice
+        end
+
+        def resource_to_emp_json(slice, serialization_params, **options) # rubocop:disable Metrics/AbcSize
+          return if options[:resource].blank? || retrieve_id(options[:resource]).is_a?(Proc)
+
+          if SUPPORTS_SEQUENCE && options[:resource].is_a?(LinkedRails::Sequence)
+            add_sequence_to_slice(
+              slice,
+              serialization_params,
+              **options
+            )
+          elsif SUPPORTS_RDF_RB && options[:resource].is_a?(RDF::List)
+            add_rdf_list_to_slice(slice, symbolize, **options)
+          else
+            if options[:serializer_class] == RDF::Serializers::ListSerializer
+              raise("Trying to serialize mixed resources")
+            end
+
+            serialize_record(
+              slice,
+              serialization_params,
+              **options
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/empathy/emp_json/serializer.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "serializer/fields"
+require_relative "serializer/inclusion"
+require_relative "serializer/records"
+require_relative "serializer/sequence"
+require_relative "serializer/serializing"
+
+module Empathy
+  module EmpJson
+    # Module to use with the rdf-serializers gem.
+    module Serializer
+      extend ActiveSupport::Concern
+
+      include Helpers::Primitives
+      include Helpers::RDFList
+      include Helpers::Slices
+      include Helpers::Values
+      include Fields
+      include Inclusion
+      include Records
+      include Sequence
+      include Serializing
+
+      included do
+        attr_accessor :symbolize
+      end
+
+      def initialize(resource, opts = {})
+        self.symbolize = opts.delete(:symbolize)
+
+        super
+      end
+
+      def dump(*args, **options)
+        case args.first
+        when :empjson
+          render_emp_json
+        else
+          super(*args, **options)
+        end
+      end
+    end
+  end
+end

data/lib/empathy/emp_json/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Empathy
+  module EmpJson
+    VERSION = "1.1.0"
+  end
+end

data/lib/empathy/emp_json.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "empathy/emp_json/helpers/primitives"
+require "empathy/emp_json/helpers/rdf_list"
+require "empathy/emp_json/helpers/slices"
+require "empathy/emp_json/helpers/values"
+require "empathy/emp_json/serializer"
+
+module Empathy
+  module EmpJson
+    SUPPORTS_RDF_RB = Object.const_defined?("RDF")
+    SUPPORTS_SEQUENCE = Object.const_defined?("LinkedRails")
+    SUPPORTS_AR = Object.const_defined?("ActiveRecord")
+
+    class Error < StandardError; end
+  end
+end

data/sig/emp/json/rb.rbs

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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: emp_json
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Thom van Kalkeren
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-31 00:00:00.000000000 Z
+dependencies: []
+description: Serializer for the EmpJson specification.
+email:
+- thom@ontola.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- emp-json-rb.gemspec
+- lib/empathy/emp_json.rb
+- lib/empathy/emp_json/helpers/primitives.rb
+- lib/empathy/emp_json/helpers/rdf_list.rb
+- lib/empathy/emp_json/helpers/slices.rb
+- lib/empathy/emp_json/helpers/values.rb
+- lib/empathy/emp_json/serializer.rb
+- lib/empathy/emp_json/serializer/fields.rb
+- lib/empathy/emp_json/serializer/inclusion.rb
+- lib/empathy/emp_json/serializer/records.rb
+- lib/empathy/emp_json/serializer/sequence.rb
+- lib/empathy/emp_json/serializer/serializing.rb
+- lib/empathy/emp_json/version.rb
+- sig/emp/json/rb.rbs
+homepage: https://empathy.tools/tools/emp-json
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://empathy.tools/tools/emp-json
+  source_code_uri: https://github.com/empathy-tools/emp_json_rb
+  bug_tracker_uri: https://github.com/empathy-tools/emp_json_rb/issues
+  changelog_uri: https://github.com/empathy-tools/emp_json_rb/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0.preview1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Serializer for the EmpJson specification.
+test_files: []