Match or exceed v1 performance

lib/blueprinter/base.rb

@@ -6,7 +6,6 @@
 require_relative 'reflection'
 require_relative 'rendering'
 require_relative 'view_collection'
-require_relative 'view_wrapper'
 
 module Blueprinter
   class Base
@@ -372,6 +371,17 @@ def view_collection
         @_view_collection ||= ViewCollection.new
       end
 
+      # For compatibility with V2's DSL
+      #
+      # @return [Blueprinter::Base] An anonymous subclass that renders a specific view
+      def [](view_name)
+        raise Errors::UnknownView, "View '#{view_name}' could not be found in Blueprint '#{name}'" unless view? view_name
+
+        Class.new(self) do
+          @forced_view_name = view_name
+        end
+      end
+
       private
 
       attr_accessor :view_scope
@@ -389,14 +399,5 @@ def association_extractor
         @_association_extractor ||= AssociationExtractor.new
       end
     end
-
-    # For compatibility with V2
-    #
-    # @return [Blueprinter::ViewWrapper]
-    def self.[](view_name)
-      raise Errors::UnknownView, "View '#{view_name}' could not be found in Blueprint '#{name}'" unless view? view_name
-
-      ViewWrapper.new(self, view_name)
-    end
   end
 end

lib/blueprinter/empty_types.rb

@@ -9,6 +9,7 @@ module Blueprinter
 
   module EmptyTypes
     include TypeHelpers
+    extend self
 
     private
 

lib/blueprinter/extension.rb

@@ -18,8 +18,6 @@ module Blueprinter
   #  - pre_render
   #
   class Extension
-    include V2::Helpers
-
     HOOKS = %i[
       around_hook
       around_result
@@ -41,53 +39,13 @@ def self.hooks
     # If this returns true, around_hook will not be called when this extension's hooks are run. Used by core extensions.
     def hidden? = false
 
-    # around_result TODO
-    # @param context [Blueprinter::V2::Context::Result]
-
-    # around_serialize_object: Runs around serialization of a Blueprint object.
-    # @param context [Blueprinter::V2::Context::Object]
-
-    # around_serialize_collection: Runs around serialization of a Blueprint collection.
-    # @param context [Blueprinter::V2::Context::Object]
-
-    # around_blueprint: Runs around serialization of every Blueprint.
-    # @param context [Blueprinter::V2::Context::Object]
-
-    # around_field_value TODO
-
-    # around_object_value TODO
-
-    # around_collection_value TODO
-
-    # blueprint_fields: Returns the fields that should be included in the correct order. Default is all fields in the order
-    # in which they were defined.
-    # NOTE If there are multiple blueprint_fields hooks, only the last one is called.
-    # NOTE Only runs once per Blueprint per render.
-    # @param context [Blueprinter::V2::Context::Render]
-    # @return [Array<Blueprinter::V2::Fields::Field|Blueprinter::V2::Fields::Object|Blueprinter::V2::Fields::Collection>]
-
-    # blueprint_setup: Called once per blueprint per render. A common use is to pre-calculate certain options
-    # and cache them in context.data, so we don't have to recalculate them for every field.
-    # @param context [Blueprinter::V2::Context::Render]
-
-    # around_hook: Instrument extension hook calls. MUST yield!
-    # @param extension [Blueprinter::Extension] Instance of the extension
-    # @param hook [Symbol] Name of hook being called
-
-    # pre_render: Called eary during "render" in V1, this method receives the object to be rendered and
-    # may return a modified (or new) object to be rendered.
-    # @param object [Object] The object to be rendered
-    # @param blueprint [Class] The Blueprinter class
-    # @param view [Symbol] The blueprint view
-    # @param options [Hash] Options passed to "render"
-    # @return [Object] The object to continue rendering
-
-    private
+    # Skip the current field and halt further field hooks
+    def skip! = throw V2::Serializer::SIGNAL, V2::Serializer::SIG_SKIP
 
     # Helper for around_result hooks to declare that a result is "final"
-    def final(val) = V2::Context::Final.new(val)
+    def serialized(val) = V2::Context::Serialized.new(val)
 
-    # Helper for around_result hooks to check if a previous hook has declared a result "final"
-    def final?(val) = val.is_a? V2::Context::Final
+    # Helper for around_result hooks to check if a previous hook has declared a result "serialized"
+    def serialized?(val) = val.is_a? V2::Context::Serialized
   end
 end

lib/blueprinter/extensions.rb

@@ -4,6 +4,12 @@ module Blueprinter
   # Optional extensions for applications to pull in
   module Extensions
     autoload :FieldOrder, 'blueprinter/extensions/field_order'
+    autoload :LegacyConditionals, 'blueprinter/extensions/legacy_conditionals'
+    autoload :LegacyDefaultIf, 'blueprinter/extensions/legacy_default_if'
+    autoload :LegacyDynamicOptions, 'blueprinter/extensions/legacy_dynamic_options'
+    autoload :LegacyExtractorOption, 'blueprinter/extensions/legacy_extractor_option'
+    autoload :LegacyRenameField, 'blueprinter/extensions/legacy_rename_field'
+    autoload :LegacyTransformer, 'blueprinter/extensions/legacy_transformer'
     autoload :MultiJson, 'blueprinter/extensions/multi_json'
     autoload :OpenTelemetry, 'blueprinter/extensions/open_telemetry'
     autoload :ViewOption, 'blueprinter/extensions/view_option'

lib/blueprinter/extensions/field_order.rb

@@ -16,7 +16,7 @@ def initialize(&sorter)
         @sorter = sorter
       end
 
-      # @param ctx [Blueprinter::V2::Context::Render]
+      # @param ctx [Blueprinter::V2::Context::Init]
       def around_blueprint_init(ctx)
         ctx.fields = ctx.fields.sort(&@sorter)
         yield ctx

lib/blueprinter/extensions/legacy_conditionals.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Blueprinter
+  module Extensions
+    #
+    # Support for Legacy/V1's legacy conditionals. V2 continue to work.
+    #
+    class LegacyConditionals < Extension
+      # @!visibility private
+      V1_ARITY = 3
+
+      # @param ctx [Blueprinter::V2::Context::Init]
+      # @!visibility private
+      def around_blueprint_init(ctx)
+        # Convert blueprint if/unless options
+        ctx.blueprint.options[:if] = convert_v1(ctx.blueprint.options[:if]) if ctx.blueprint.options[:if]
+        ctx.blueprint.options[:unless] = convert_v1(ctx.blueprint.options[:unless]) if ctx.blueprint.options[:unless]
+
+        # Convert field if/unless options
+        ctx.fields.each do |field|
+          field.options[:if] = convert_v1(field.options[:if]) if field.options[:if]
+          field.options[:unless] = convert_v1(field.options[:unless]) if field.options[:unless]
+        end
+
+        yield ctx
+      end
+
+      private
+
+      def convert_v1(cond)
+        if cond.arity == V1_ARITY
+          ->(ctx) { cond.call(ctx.field.source, ctx.object, ctx.options) }
+        else
+          cond
+        end
+      end
+    end
+  end
+end

lib/blueprinter/extensions/legacy_default_if.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Blueprinter
+  module Extensions
+    #
+    # Support for Legacy/V1's `default_if` options.
+    #
+    class LegacyDefaultIf < Extension
+      # @param ctx [Blueprinter::V2::Context::Init]
+      # @!visibility private
+      def around_blueprint_init(ctx)
+        if (default_if = ctx.blueprint.options[:default_if])
+          ctx.blueprint.options[:default_if] = convert_v1(default_if)
+        end
+
+        ctx.fields.each do |field|
+          if (default_if = field.options[:default_if])
+            field.options[:default_if] = convert_v1(default_if)
+          end
+        end
+
+        yield ctx
+      end
+
+      private
+
+      def convert_v1(cond)
+        case cond
+        when ::Blueprinter::EMPTY_COLLECTION, ::Blueprinter::EMPTY_HASH, ::Blueprinter::EMPTY_STRING
+          ->(_ctx, value) { EmptyTypes.send(:use_default_value?, value, cond) }
+        else
+          cond
+        end
+      end
+    end
+  end
+end

lib/blueprinter/extensions/legacy_dynamic_options.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Blueprinter
+  module Extensions
+    #
+    # Support for Legacy/V1's `:options` option on associations.
+    #
+    class LegacyDynamicOptions < Extension
+      # @!visibility private
+      def apply(ctx)
+        ctx.fields.each do |field|
+          additional_opts =
+            case (opts = field.options[:options])
+            when Hash then opts
+            when Proc then opts.call(ctx.object)
+            end
+          ctx.options = ctx.options.merge(additional_opts).freeze if additional_opts
+        end
+        yield ctx
+      end
+
+      # @!visibility private
+      alias around_serialize_object apply
+
+      # @!visibility private
+      alias around_serialize_collection apply
+    end
+  end
+end

lib/blueprinter/extensions/legacy_extractor_option.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Blueprinter
+  module Extensions
+    #
+    # Support for Legacy/V1's `extractor` option.
+    #
+    class LegacyExtractorOption < Extension
+      # @!visibility private
+      def extract(ctx)
+        extractor_class = ctx.field.options[:extractor] || ctx.blueprint.options[:extractor]
+        return yield ctx if extractor_class.nil?
+
+        extractor = ctx.store[extractor_class.object_id] ||= extractor_class.new
+        extractor.extract(ctx.field.source, ctx.object, ctx.options, ctx.field.options)
+      end
+
+      # @!visibility private
+      alias around_field_value extract
+
+      # @!visibility private
+      alias around_object_value extract
+
+      # @!visibility private
+      alias around_collection_value extract
+    end
+  end
+end

lib/blueprinter/extensions/legacy_rename_field.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Blueprinter
+  module Extensions
+    #
+    # Support for Legacy/V1's `name` option.
+    #
+    class LegacyRenameField < Extension
+      # @param ctx [Blueprinter::V2::Context::Init]
+      # @!visibility private
+      def around_blueprint_init(ctx)
+        ctx.fields.each do |field|
+          if (name = field.options[:name])
+            field.source = field.name
+            field.name = name
+          end
+        end
+        yield ctx
+      end
+    end
+  end
+end

lib/blueprinter/extensions/legacy_transformer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Blueprinter
+  module Extensions
+    #
+    # Support for Legacy/V1's transformers.
+    #
+    class LegacyTransformer < Extension
+      # @param *transformers [Class] One or more transformers (Blueprinter::Transformer)
+      def initialize(*transformers)
+        @transformers = transformers
+      end
+
+      # @param ctx [Blueprinter::V2::Context::Object]
+      # @!visibility private
+      def around_blueprint(ctx)
+        hash = yield ctx
+        @transformers.each do |klass|
+          transformer = ctx.store[klass.object_id] ||= klass.new
+          transformer.transform(hash, ctx.object, ctx.options)
+        end
+        hash
+      end
+    end
+  end
+end

lib/blueprinter/extensions/multi_json.rb

@@ -17,15 +17,11 @@ def initialize(options = {})
 
       # @param ctx [Blueprinter::V2::Context::Result]
       def around_result(ctx)
-        case ctx.format
-        when :json
-          ctx.format = :hash
-          result = yield ctx
-          opts = ctx.options[:multi_json] ? @options.merge(ctx.options[:multi_json]) : @options
-          final ::MultiJson.dump(result, opts)
-        else
-          yield ctx
-        end
+        result = yield ctx
+        return result unless ctx.format == :json
+
+        opts = ctx.options[:multi_json] ? @options.merge(ctx.options[:multi_json]) : @options
+        serialized ::MultiJson.dump(result, opts)
       end
     end
   end

lib/blueprinter/extensions/view_option.rb

@@ -3,7 +3,7 @@
 module Blueprinter
   module Extensions
     #
-    # An optional, built-in extension for a ":view" option on render.
+    # Support for Legacy/V1's `:view` option on `render`.
     #
     class ViewOption < Extension
       # @param ctx [Blueprinter::V2::Context::Result]

lib/blueprinter/extractors/association_extractor.rb

@@ -53,11 +53,10 @@ def extract_v2(value, blueprint, local_options, options)
       store = local_options[:v2_store] || {}
       depth = local_options[:v2_depth] || 1
       instances = local_options[:v2_instances] || V2::InstanceCache.new
-      serializer = instances.serializer(blueprint[view], local_options.except(:v2_instances), store, depth + 1)
       if value.is_a?(Enumerable) && !value.is_a?(Hash)
-        serializer.collection(value, depth: depth + 1)
+        blueprint[view].serializer.collection(value, local_options, instances:, store:, depth: depth + 1)
       else
-        serializer.object(value, depth: depth + 1)
+        blueprint[view].serializer.object(value, local_options, instances:, store:, depth: depth + 1)
       end
     end