Merge branch 'main' into keyword-field-options

Author: lessthanjacob

.github/workflows/release.yaml

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
       - name: Check if version has been updated
         id: check
-        uses: tj-actions/changed-files@480f49412651059a414a6a5c96887abb1877de8a # v44
+        uses: tj-actions/changed-files@db8d0bfea5a44e51abd5dc1454386c668ae901f9 # v44
         with:
           files: lib/blueprinter/version.rb
   release:

CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Unreleased
-- [BREAKING] Drops support for Ruby 3.0. See [#496](https://github.com/procore-oss/blueprinter/pull/496)
+--
+
+## 1.2.1 - 2025/09/11
+- 🐛 [BUGFIX] Adds back `Blueprinter.prepare` method with a deprecated warning. This method was previously public, but was removed as part of **1.2.0**.
+
+## [REMOVED] 1.2.0 - 2025/09/10
+- ‼️ [BREAKING] Drops support for Ruby 3.0. See [#496](https://github.com/procore-oss/blueprinter/pull/496)
+- 💅 [ENHANCEMENT] Allows for the current view to be accessible from within the `options` hash provided to the `field` block. See [#503](https://github.com/procore-oss/blueprinter/pull/503). Thanks to [@neo87cs](https://github.com/neo87cs).
+- 🐛 [BUGFIX] Fixes an issue where specifying fields using a mix of symbols and strings would cause an `ArgumentError` when rendering. See [#505](https://github.com/procore-oss/blueprinter/pull/505). Thanks to [@lessthanjacob](https://github.com/lessthanjacob).
+- 🚜 [REFACTOR] Reorganizes rendering/serialization logic and removes `BaseHelper` module. See [#476](https://github.com/procore-oss/blueprinter/pull/476). Thanks to [@lessthanjacob](https://github.com/lessthanjacob).
 
 ## 1.1.2 - 2024/10/3
 - 🐛 [BUGFIX] Fixes an issue where a `Blueprinter::BlueprinterError` would be raised on render when providing `view: nil`, instead of falling back on the `:default` view. See
@@ -10,7 +19,7 @@
 * 🐛 [BUGFIX] Fixes an issue when passing in a `Symbol` (representing a method) to the `if:` condition on an association. The provided `Symbol` would be erroneously sent to the association's Blueprint, instead of the Blueprint in which the association was defined within. See [#464](https://github.com/procore-oss/blueprinter/pull/464). Thanks to [@lessthanjacob](https://github.com/lessthanjacob).
 
 ## 1.1.0 - 2024/08/02
-* [BREAKING] Drops support for Ruby 2.7. See [#402](https://github.com/procore-oss/blueprinter/pull/402). Thanks to [@jmeridth](https://github.com/jmeridth)
+* ‼️ [BREAKING] Drops support for Ruby 2.7. See [#402](https://github.com/procore-oss/blueprinter/pull/402). Thanks to [@jmeridth](https://github.com/jmeridth)
 * 🚜 [REFACTOR] Cleans up Blueprint validation logic and implements an `Association` class with a clearer interface. See [#414](https://github.com/procore-oss/blueprinter/pull/414). Thanks to [@lessthanjacob](https://github.com/lessthanjacob).
 * 💅 [ENHANCEMENT] Updates **Transform Classes** documentation to provide a more understandable example. See [#415](https://github.com/procore-oss/blueprinter/pull/415). Thanks to [@SaxtonDrey](https://github.com/SaxtonDrey).
 * 💅 [ENHANCEMENT] Implements field-level configuration option for excluding an attribute from the result of a render if its value is `nil`. See [#425](https://github.com/procore-oss/blueprinter/pull/425). Thanks to [jamesst20](https://github.com/jamesst20).
@@ -24,7 +33,7 @@
 * 🐛 [BUGFIX] Fixes an issue where serialization performance would become degraded when using a Blueprint that leverages transformers. See [#381](https://github.com/procore-oss/blueprinter/pull/381). Thanks to [@Pritilender](https://github.com/Pritilender).
 
 ## 1.0.0 - 2024/01/17
-* 🚀 [BREAKING] Allow transformers to be included across views. See [README](https://github.com/procore-oss/blueprinter#transform-across-views), PR [#372](https://github.com/procore-oss/blueprinter/pull/372) and issue [#225](https://github.com/procore-oss/blueprinter/issues/225) for details. Note this changes the behavior of transformers which were previously only applied to the view they were defined on. Thanks to [@njbbaer](https://github.com/njbbaer) and [@bhooshiek-narendiran](https://github.com/bhooshiek-narendiran).
+* ‼️ [BREAKING] Allow transformers to be included across views. See [README](https://github.com/procore-oss/blueprinter#transform-across-views), PR [#372](https://github.com/procore-oss/blueprinter/pull/372) and issue [#225](https://github.com/procore-oss/blueprinter/issues/225) for details. Note this changes the behavior of transformers which were previously only applied to the view they were defined on. Thanks to [@njbbaer](https://github.com/njbbaer) and [@bhooshiek-narendiran](https://github.com/bhooshiek-narendiran).
 * 🚀 [FEATURE] Introduce extension API, with initial support for pre_render hook. See [#358](https://github.com/procore-oss/blueprinter/pull/358) for details. Thanks to [@jhollinger](https://github.com/jhollinger).
 * 💅 [ENHANCEMENT] Add reflection on views, fields, and associations. See PR [#357](https://github.com/procore-oss/blueprinter/pull/357), and issue [#341](https://github.com/procore-oss/blueprinter/issues/341) for details. Thanks to [@jhollinger](https://github.com/jhollinger).
 
@@ -34,7 +43,7 @@
 * 💅 [ENHANCEMENT] Introduce rubocop
 * 💅 [ENHANCEMENT] if/:unless procs with two arguments and invalid empty type deprecations are now removed
 ## 0.26.0  - 2023/08/17
-* 🐛 [BREAKING] Transition to GitHub Actions from CircleCI and update to handle Ruby versions 2.7, 3.0, 3.1, 3.2. Drop support for any ruby version less than 2.7. See [#307](https://github.com/procore-oss/blueprinter/pull/307)
+* ‼️ [BREAKING] Transition to GitHub Actions from CircleCI and update to handle Ruby versions 2.7, 3.0, 3.1, 3.2. Drop support for any ruby version less than 2.7. See [#307](https://github.com/procore-oss/blueprinter/pull/307)
 
 ## 0.25.3  - 2021/03/03
 * 🐛 [BUGFIX] Fixes issue where fields and associations that are redefined by later views were not properly overwritten. See [#201](https://github.com/procore-oss/blueprinter/pull/201) thanks to [@Berardpi](https://github.com/Berardpi).
@@ -175,7 +184,7 @@ a JSON String. See PR [#76](https://github.com/procore-oss/blueprinter/pull/76)
 
 ## 0.3.0  - 2018/04/05
 
-💥 [BREAKING] Sort of a breaking Change. Serializer classes has been renamed to Extractor. To upgrade, if you passed in a specific serializer to `field` or `identifier` such as:
+‼️ [BREAKING] Sort of a breaking Change. Serializer classes has been renamed to Extractor. To upgrade, if you passed in a specific serializer to `field` or `identifier` such as:
 
 ```
 field(:first_name, serializer: CustomSerializer)
@@ -192,7 +201,7 @@ field(:first_name, extractor: CustomExtractor)
 
 ## 0.2.0  - 2018/01/22
 
-💥 [BREAKING] Breaking Changes. To upgrade, ensure that any associated objects have a blueprint. For example:
+‼️ [BREAKING] Breaking Changes. To upgrade, ensure that any associated objects have a blueprint. For example:
 ```
 association :comments, blueprint: CommentsBlueprint
 ```

README.md

@@ -1051,7 +1051,7 @@ assoc[:category].options
 <details>
 <summary>Extensions</summary>
 
-Blueprinter offers an extension system to hook into and modify certain behavior.
+Blueprinter provides an extension system that enables certain behavior to be modified as needed.
 
 ```ruby
 Blueprinter.configure do |config|
@@ -1060,13 +1060,53 @@ Blueprinter.configure do |config|
 end
 ```
 
-Extension hooks:
+#### Available Hooks
+
+* **pre_render** - Intercept the object before rendering begins. This allows you to modify, transform, or replace the object that will be serialized.
+
+#### Creating Extensions
+
+To create an extension, simply subclass `Blueprinter::Extension` and override the method representing the desired hook:
+
+```ruby
+class ObfuscateNameExtension < Blueprinter::Extension
+  def pre_render(object, blueprint, view, options)
+    return object unless object.respond_to?(:name)
+
+    modified_object = object.dup
+    modified_object.name = ObsfuscateName.call(modified_object.name)
+
+    modified_object
+  end
+end
+```
+
+#### Extension Execution Order
+
+Extensions are executed in the order they are added to the configuration. Each extension receives the result from the previous extension, allowing for chained transformations:
+
+```ruby
+Blueprinter.configure do |config|
+  config.extensions << SecurityExtension.new           # Runs first
+  config.extensions << AssociationLoaderExtension.new  # Runs second
+  config.extensions << UserEnrichmentExtension.new     # Runs third
+end
+```
+
+#### Gem Extensions
+
+Gems can be created that enrich `blueprinter`'s core functionality via extensions.
+
+##### Procore Supported Gems
+
+* [blueprinter-activerecord](https://github.com/procore-oss/blueprinter-activerecord) - Provides ActiveRecord-specific optimizations and features
+
+##### Community Gems
+
+> **_NOTE:_** The following are not officially maintained/supported by Procore OSS.
 
-* [pre_render](https://github.com/procore-oss/blueprinter/blob/abca9ca8ed23edd65a0f4b5ae43e25b8e27a2afc/lib/blueprinter/extension.rb#L18): Intercept the object before rendering begins
 
-Some known extensions are:
 
-* [blueprinter-activerecord](https://github.com/procore-oss/blueprinter-activerecord)
 </details>
 
 <details>

lib/blueprinter/rendering.rb

@@ -96,6 +96,26 @@ def hashify(object, view_name:, local_options:)
       prepare_data(object, view_name, local_options)
     end
 
+    # @deprecated This method is no longer supported, and was not originally intended to be public. This will be removed
+    #   in the next minor release. If similar functionality is needed, use `.render_as_hash` instead.
+    #
+    # This is the magic method that converts complex objects into a simple hash
+    # ready for JSON conversion.
+    #
+    # Note: we accept view (public interface) that is in reality a view_name,
+    # so we rename it for clarity
+    #
+    # @api private
+    def prepare(object, view_name:, local_options:)
+      Blueprinter::Deprecation.report(
+        <<~MESSAGE
+          The `prepare` method is no longer supported will be removed in the next minor release.
+          If similar functionality is needed, use `.render_as_hash` instead.
+        MESSAGE
+      )
+      render_as_hash(object, view_name:, local_options:)
+    end
+
     private
 
     attr_reader :blueprint, :options

lib/blueprinter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Blueprinter
-  VERSION = '1.1.2'
+  VERSION = '1.2.1'
 end

spec/integrations/base_spec.rb

@@ -580,6 +580,23 @@ def self.has_cars?(_field_name, object, local_options)
     end
   end
 
+  describe '.prepare' do
+    subject { blueprint_with_block.prepare(object_with_attributes, view_name: :default, local_options: {}) }
+    it 'returns a hash with expected format' do
+      expect(subject).to eq({ id: object_with_attributes.id, position_and_company: "#{object_with_attributes.position} at #{object_with_attributes.company}"})
+    end
+
+    it 'logs a deprecation warning' do
+      expect(Blueprinter::Deprecation).to receive(:report).with(
+        <<~MESSAGE
+          The `prepare` method is no longer supported will be removed in the next minor release.
+          If similar functionality is needed, use `.render_as_hash` instead.
+        MESSAGE
+      )
+      subject
+    end
+  end
+
   describe '::render_as_json' do
     subject { blueprint_with_block.render_as_json(object_with_attributes) }
     context 'Outside Rails project' do