ruby_jsonapi 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1456d716b6fbbdd605cad1e21b5fe37163e15bffd1c5ed6db5ffa32a45b1272
+  data.tar.gz: 05aeb4f437395d72b3b475880f083064e4b1480a1514fc26d531a36a72527638
+SHA512:
+  metadata.gz: 03d8549786379530fdd27e2eb207c4492a9a66fe296d2ea42c1348d746c0bc4264343f8b9f40970236618ac4742c39eb51007d724587ccefe30629a33eb956ac
+  data.tar.gz: 1d96628745580144c871883967278c714e9c9ca916985493d0a9d1eb34b83717fdf06cdb86314e8bc72540d56fdfb0836ac68fc8abc46849b6cbcd5853e864f9

data/LICENSE.txt

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+https://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "{}"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright {yyyy} {name of copyright owner}
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,129 @@
+# Ruby JSONAPI
+
+[![Gem Version](https://badge.fury.io/rb/ruby_jsonapi.svg)](https://badge.fury.io/rb/ruby_jsonapi)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+A fast and efficient [JSON:API](https://jsonapi.org/) serializer for Ruby objects.
+
+## Introduction
+
+Ruby JSONAPI is a fork of the [jsonapi-serializer](https://github.com/jsonapi-serializer/jsonapi-serializer) gem (which was itself forked from [Netflix's fast_jsonapi](https://github.com/Netflix/fast_jsonapi)).
+This library provides a simple and performant way to serialize your Ruby objects according to the [JSON:API specification](https://jsonapi.org/).
+
+### Why This Fork?
+
+The jsonapi-serializer gem provides excellent serialization performance but lacks full JSON:API specification support. This fork aims to:
+
+1. Complete the JSON:API specification implementation
+2. Add features for complex API requirements
+3. Maintain backward compatibility with jsonapi-serializer
+4. Preserve the performance benefits that made the original library valuable
+
+Our focus is to create a more complete toolset while ensuring existing code continues to work without major changes.
+
+## Features
+
+* Fast JSON:API serialization
+* ActiveModel Serializer-like DSL
+* Relationship support (`has_many`, `belongs_to`, `has_one`)
+* Compound documents (included resources)
+* Resource-level caching
+* Conditional attributes and relationships
+* Key transformation (camel, dash, underscore)
+* Rails integration with generators
+
+## Upcoming Features
+
+- [ ] **Complete Error Objects** - Full JSON:API error structure with source pointers
+- [ ] **Filtering** - Standard filtering with multiple operators and strategies
+- [ ] **Sorting & Pagination** - Multi-field sorting and standard pagination
+- [ ] **Enhanced Relationships** - Better handling of complex relationship structures
+- [ ] **Request Parsing** - Converting incoming JSON:API documents to Ruby objects
+- [ ] **Resource Permissions** - Field-level and relationship-level access controls
+- [ ] **HTTP Content Negotiation** - Standard media type and header support
+- [ ] **Atomic Operations** - Multiple create/update/delete operations in a single request
+- [ ] **Extensions Support** - Implementation of the extensions mechanism
+
+## Benchmarks
+
+Ruby JSONAPI is significantly faster than alternatives like ActiveModelSerializer:
+
+![Benchmarks](docs/images/benchmarks.png)
+
+> Benchmarks are inherited from jsonapi-serializer. See [performance methodology](docs/performance.md) for details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_jsonapi'
+```
+
+Then execute:
+
+```bash
+$ bundle install
+```
+
+## Quick Start
+
+Define your serializer:
+
+```ruby
+class MovieSerializer
+  include JSONAPI::Serializer
+
+  attributes :name, :year
+
+  has_many :actors
+  belongs_to :director
+end
+```
+
+Serialize your objects:
+
+```ruby
+# Single object
+serializer = MovieSerializer.new(movie)
+json_string = serializer.serializable_hash.to_json
+
+# Collection
+serializer = MovieSerializer.new(movies)
+json_string = serializer.serializable_hash.to_json
+```
+
+## Documentation
+
+For complete documentation, please visit our [GitHub Pages site](https://fkiene.github.io/ruby_jsonapi/):
+
+- [Installation](https://fkiene.github.io/ruby_jsonapi/installation.html)
+- [Usage](https://fkiene.github.io/ruby_jsonapi/usage/index.html)
+  - [Basic Serialization](https://fkiene.github.io/ruby_jsonapi/usage/basic-serialization.html)
+  - [Working with Relationships](https://fkiene.github.io/ruby_jsonapi/usage/relationships.html)
+  - [Customization Options](https://fkiene.github.io/ruby_jsonapi/usage/customization.html)
+  - [Advanced Features](https://fkiene.github.io/ruby_jsonapi/usage/advanced-features.html)
+- [Performance Considerations](https://fkiene.github.io/ruby_jsonapi/performance.html)
+- [Migration from fast_jsonapi](https://fkiene.github.io/ruby_jsonapi/migration.html)
+- [JSON Serialization](https://fkiene.github.io/ruby_jsonapi/json_serialization.html)
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run the tests (`rspec`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE.txt](LICENSE.txt) file for details.
+
+## Acknowledgments
+
+- [jsonapi-serializer](https://github.com/jsonapi-serializer/jsonapi-serializer) - The parent project
+- [Netflix fast_jsonapi](https://github.com/Netflix/fast_jsonapi) - The original project
+- All contributors to both projects

data/lib/extensions/has_one.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+ActiveRecord::Associations::Builder::HasOne.class_eval do
+  # Based on
+  # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/associations/builder/collection_association.rb#L50
+  # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/associations/builder/singular_association.rb#L11
+  def self.define_accessors(mixin, reflection)
+    super
+    name = reflection.name
+    mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
+      def #{name}_id
+        # if an attribute is already defined with this methods name we should just use it
+        return read_attribute(__method__) if has_attribute?(__method__)
+        association(:#{name}).reader.try(:id)
+      end
+    CODE
+  end
+end

data/lib/fast_jsonapi/attribute.rb

@@ -0,0 +1,5 @@
+require 'fast_jsonapi/scalar'
+
+module FastJsonapi
+  class Attribute < Scalar; end
+end

data/lib/fast_jsonapi/helpers.rb

@@ -0,0 +1,21 @@
+module FastJsonapi
+  class << self
+    # Calls either a Proc or a Lambda, making sure to never pass more parameters to it than it can receive
+    #
+    # @param [Proc] proc the Proc or Lambda to call
+    # @param [Array<Object>] *params any number of parameters to be passed to the Proc
+    # @return [Object] the result of the Proc call with the supplied parameters
+    def call_proc(proc, *params)
+      # The parameters array for a lambda created from a symbol (&:foo) differs
+      # from explictly defined procs/lambdas, so we can't deduce the number of
+      # parameters from the array length (and differs between Ruby 2.x and 3).
+      # In the case of negative arity -- unlimited/unknown argument count --
+      # just send the object to act as the method receiver.
+      if proc.arity.negative?
+        proc.call(params.first)
+      else
+        proc.call(*params.take(proc.parameters.length))
+      end
+    end
+  end
+end

data/lib/fast_jsonapi/instrumentation/skylight.rb

@@ -0,0 +1,3 @@
+require 'skylight'
+
+warn('DEPRECATION: Skylight support was moved into the `skylight` gem.')

data/lib/fast_jsonapi/instrumentation.rb

@@ -0,0 +1,7 @@
+require 'jsonapi/serializer/instrumentation'
+
+warn(
+  'DEPRECATION: Performance instrumentation is no longer automatic. See: ' \
+  'https://github.com/jsonapi-serializer/jsonapi-serializer' \
+  '#performance-instrumentation'
+)

data/lib/fast_jsonapi/link.rb

@@ -0,0 +1,5 @@
+require 'fast_jsonapi/scalar'
+
+module FastJsonapi
+  class Link < Scalar; end
+end