oj_serializers 2.0.1 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8fd87262444d89cfbbe11a1b6ae6201de6d71ed996edcd8a4a9ae224320ad7c
-  data.tar.gz: bfe507b6e02c01087d99381ab8ef971547e0062085eb4bfb9c9551ceb2796c18
+  metadata.gz: f9532d127e357231931f57cda2531743fe4064d0f9e0371cb2aac81a39dedb35
+  data.tar.gz: 8465a8f1f8e39fb48cd07a6c6156ff744f7e094a2985e01a1a13445957f2b3f0
 SHA512:
-  metadata.gz: 060b791a7d8c2f204adab9313873b950b89eb1a80400b26355b1382ab6e08d0efa3e48efeef1ececc96cb8f42729f8f4cea50b37d579ab1acc333b393b060c0d
-  data.tar.gz: a7ea8370d3155f8bfd99f9d1cffe67fe05f896930277a0e69a81b3e4eda2b0088a8901730ec2fb910e564dcf3f29ea3200f5cc70d8321dd1892b72c9f9b75bf4
+  metadata.gz: 176c981929972198d8cbaf9548cc9238b60f51010fbd33415a70c25ed8f167885e8cfa494820cc668a03eb9cf96664bb40ba4b2cc69efc4e229763e621aa7190
+  data.tar.gz: d0d7ea0e5fc50b993b7439e50be0c59f6da26c23ac542c69838b5c145197d598186ae162ce9bc82711942b8e94631acb99acfe4739e04b1e25e28e1f6b70f260

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## Oj Serializers 2.0.3 (2023-04-19)
+
+### Features ✨
+
+- [Allow `key` and `unless` in AMS-compat mode](https://github.com/ElMassimo/oj_serializers/commit/5050710e199651cc2c0e9d9d6395f2c2ac9b1875)
+
+### Fixes 🐞
+
+- [Allow using `active_model_serializers` in associations](https://github.com/ElMassimo/oj_serializers/commit/501ed4014b564e6f103d2f52d15832fe6706d6a8)
+
+## Oj Serializers 2.0.2 (2023-04-02)
+
+### Features ✨
+
+- [Automatically remove `?` when using `transform_keys :camelize`](https://github.com/ElMassimo/oj_serializers/commit/79758a0)
+
+### Fixes 🐞
+
+- [Error when defining attributes with options](https://github.com/ElMassimo/oj_serializers/commit/680ab47)
+
 ## Oj Serializers 2.0.1 (2023-04-02)
 
 ### Features ✨

data/README.md

@@ -22,6 +22,8 @@ Faster JSON serializers for Ruby, built on top of the powerful [`oj`][oj] librar
 [sugar]: https://github.com/ElMassimo/oj_serializers/blob/main/lib/oj_serializers/sugar.rb#L14
 [migration guide]: https://github.com/ElMassimo/oj_serializers/blob/main/MIGRATION_GUIDE.md
 [design]: https://github.com/ElMassimo/oj_serializers#design-
+[associations]: https://github.com/ElMassimo/oj_serializers#associations-
+[compose]: https://github.com/ElMassimo/oj_serializers#composing-serializers-
 [raw_json]: https://github.com/ohler55/oj/issues/542
 [trailing_commas]: https://maximomussini.com/posts/trailing-commas/
 [render dsl]: https://github.com/ElMassimo/oj_serializers#render-dsl-
@@ -29,6 +31,7 @@ Faster JSON serializers for Ruby, built on top of the powerful [`oj`][oj] librar
 [Discussion]: https://github.com/ElMassimo/oj_serializers/discussions
 [TypeScript]: https://www.typescriptlang.org/
 [types_from_serializers]: https://github.com/ElMassimo/types_from_serializers
+[inheritance]: https://github.com/ElMassimo/types_from_serializers/blob/main/playground/vanilla/app/serializers/song_with_videos_serializer.rb#L1
 
 ## Why? 🤔
 
@@ -41,12 +44,12 @@ Learn more about [how this library achieves its performance][design].
 
 ## Features ⚡️
 
-- Declaration syntax [similar to Active Model Serializers][migration guide]
+- Intuitive declaration syntax, supporting mixins and inheritance
 - Reduced [memory allocation][benchmarks] and [improved performance][benchmarks]
-- Support for `has_one` and `has_many`, compose with `flat_one`
+- Generate [TypeScript interfaces automatically][types_from_serializers]
+- Support for [`has_one`][associations] and [`has_many`][associations], compose with [`flat_one`][compose]
 - Useful development checks to avoid typos and mistakes
-- Integrates nicely with Rails controllers
-- [Generate TypeScript interfaces automatically][types_from_serializers]
+- [Migrate easily from Active Model Serializers][migration guide]
 
 ## Installation 💿
 
@@ -155,6 +158,24 @@ class AlbumsController < ApplicationController
 end
 ```
 
+<details>
+  <summary>Active Model Serializers style</summary>
+
+```ruby
+require "oj_serializers/sugar" # In an initializer
+
+class AlbumsController < ApplicationController
+  def show
+    render json: album, serializer: AlbumSerializer
+  end
+  
+  def index
+    render json: albums, root: :albums, each_serializer: AlbumSerializer
+  end
+end
+```
+</details>
+
 ## Rendering 🖨
 
 Use `one` to serialize objects, and `many` to serialize enumerables:
@@ -170,7 +191,7 @@ Serializers can be rendered arrays, hashes, or even inside `ActiveModel::Seriali
 by using a method in the serializer, making it very easy to combine with other
 libraries and migrate incrementally.
 
-You can use `render` as a shortcut for `one` and `many`, but it might be less readable:
+`render` is a shortcut for `one` and `many`:
 
 ```ruby
 render json: {
@@ -378,6 +399,43 @@ It's easy for the backend and the frontend to become out of sync. Traditionally,
 
 As a result, it's posible to easily detect mismatches between the backend and the frontend, as well as make the fields more discoverable and provide great autocompletion in the frontend, without having to manually write the types.
 
+### Composing serializers 🧱
+
+There are three options to [compose serializers](https://github.com/ElMassimo/oj_serializers/discussions/10#discussioncomment-5523921): [inheritance], mixins, and `flat_one`.
+
+Use `flat_one` to include all attributes from a different serializer:
+
+```ruby
+class AttachmentSerializer < BaseSerializer
+  identifier
+
+  class BlobSerializer < BaseSerializer
+    attributes :filename, :byte_size, :content_type, :created_at
+  end
+
+  flat_one :blob, serializer: BlobSerializer
+end
+```
+
+Think of it as `has_one` without a "root", all the attributes are added directly.
+
+<details>
+  <summary>Example Output</summary>
+
+```ruby
+{
+  id: 5,
+  filename: "image.jpg,
+  byte_size: 256074,
+  content_type: "image/jpeg",
+  created_at: "2022-08-04T17:25:12.637-07:00",
+}
+```
+</details>
+
+This is especially convenient when using [`types_from_serializers`][types_from_serializers],
+as it enables automatic type inference for the included attributes.
+
 ### Memoization & local state
 
 Serializers are designed to be stateless so that an instanced can be reused, but
@@ -480,10 +538,8 @@ end
 This will change the default shortcuts (`render`, `one`, `one_if`, and `many`),
 so that the serializer writes directly to JSON instead of returning a Hash.
 
-> **Note**
->
-> This was the default behavior in `oj_serializers` v1, but was replaced with
-`default_format :hash` in v2.
+Even when using this mode, you can still use rendered values inside arrays,
+hashes, and other serializers, thanks to [the `raw_json` extensions][raw_json].
 
 <details>
   <summary>Example Output</summary>
@@ -569,9 +625,6 @@ so that the serializer writes directly to JSON instead of returning a Hash.
 ```
 </details>
 
-Even when using this mode, you can still use rendered values inside arrays,
-hashes, and other serializers, thanks to [the `raw_json` extensions][raw_json].
-
 ## Design 📐
 
 Unlike `ActiveModel::Serializer`, which builds a Hash that then gets encoded to

data/lib/oj_serializers/compat.rb

@@ -14,7 +14,53 @@ class ActiveModel::Serializer
   def self.many(array, options = nil)
     array.map { |object| new(object, options) }
   end
+
+  # OjSerializer: Used internally to write a single object association in :hash mode.
+  #
+  # Returns nothing.
+  def self.one_as_hash(object)
+    new(object)
+  end
+
+  # OjSerializer: Used internally to write an association in :hash mode.
+  #
+  # Returns nothing.
+  def self.many_as_hash(array)
+    array.map { |object| new(object) }
+  end
+
+  # OjSerializer: Used internally to write a single object association in :json mode.
+  #
+  # Returns nothing.
+  def self.write_one(writer, object)
+    writer.push_value(new(object))
+  end
+
+  # OjSerializer: Used internally to write an association in :json mode.
+  #
+  # Returns nothing.
+  def self.write_many(writer, array)
+    writer.push_array
+    array.each do |object|
+      write_one(writer, object)
+    end
+    writer.pop
+  end
+
+  module OjOptionsCompat
+    def add_attribute(value_from, key: nil, **options)
+      options[:as] ||= key if key
+
+      if (unless_proc = options.delete(:unless))
+        options[:if] = -> { !instance_exec(&unless_proc) }
+      end
+
+      super(value_from, **options)
+    end
+  end
 end
 
 require 'oj_serializers'
 require 'oj_serializers/sugar'
+
+Oj::Serializer.singleton_class.prepend(ActiveModel::Serializer::OjOptionsCompat)

data/lib/oj_serializers/serializer.rb

@@ -126,7 +126,7 @@ protected
     # This setting is inherited from parent classes.
     def transform_keys(strategy = nil, &block)
       transformer = case (strategy ||= block)
-      when :camelize, :camel_case then ->(key) { key.camelize(:lower) }
+      when :camelize, :camel_case then ->(key) { key.camelize(:lower).chomp('?') }
       when :none then nil
       when Symbol then strategy.to_proc
       when Proc then strategy
@@ -376,7 +376,7 @@ protected
     #
     # See ./benchmarks/document_benchmark.rb
     def mongo_attributes(*attr_names, **options)
-      identifier(:_id, as: :id, attribute: :mongoid, **options) if attr_names.delete(:id)
+      identifier(:_id, as: :id, attribute: :mongoid, **options.slice(:if)) if attr_names.delete(:id)
       attributes(*attr_names, **options, attribute: :mongoid)
     end
 
@@ -392,6 +392,7 @@ protected
 
       methods_with_options.each do |attr_name, options|
         options = { as: options } if options.is_a?(Symbol)
+        options[:attribute] ||= attr_options[:attribute]
         add_attribute(attr_name, **options)
       end
     end

data/lib/oj_serializers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OjSerializers
-  VERSION = '2.0.1'
+  VERSION = '2.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oj_serializers
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.3
 platform: ruby
 authors:
 - Maximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-02 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj