require 'json' require_relative 'alba/version' require_relative 'alba/errors' require_relative 'alba/resource' require_relative 'alba/deprecation' # Core module module Alba class << self attr_reader :backend, :encoder, :inferring, :_on_error, :_on_nil, :transforming_root_key # Accessor for inflector, a module responsible for incflecting strings attr_accessor :inflector # Set the backend, which actually serializes object into JSON # # @param backend [#to_sym, nil] the name of the backend # Possible values are `oj`, `active_support`, `default`, `json` and nil # @return [Proc] the proc to encode object into JSON # @raise [Alba::UnsupportedBackend] if backend is not supported def backend=(backend) @backend = backend&.to_sym set_encoder_from_backend end # Set encoder, a Proc object that accepts an object and generates JSON from it # Set backend as `:custom` which indicates no preset encoder is used # # @param encoder [Proc] # @raise [ArgumentError] if given encoder is not a Proc or its arity is not one def encoder=(encoder) raise ArgumentError, 'Encoder must be a Proc accepting one argument' unless encoder.is_a?(Proc) && encoder.arity == 1 @encoder = encoder @backend = :custom end # Serialize the object with inline definitions # # @param object [Object] the object to be serialized # @param key [Symbol, nil, true] DEPRECATED, use root_key instead # @param root_key [Symbol, nil, true] # @param block [Block] resource block # @return [String] serialized JSON string # @raise [ArgumentError] if block is absent or `with` argument's type is wrong def serialize(object, key: nil, root_key: nil, &block) Alba::Deprecation.warn '`key` option to `serialize` method is deprecated, use `root_key` instead.' if key klass = block ? resource_class(&block) : infer_resource_class(object.class.name) resource = klass.new(object) resource.serialize(root_key: root_key || key) end # Enable inference for key and resource name # # @param with [Symbol, Class, Module] inflector # When it's a Symbol, it sets inflector with given name # When it's a Class or a Module, it sets given object to inflector def enable_inference!(with: :default) if with == :default Alba::Deprecation.warn 'Calling `enable_inference!` without `with` keyword argument is deprecated. Pass `:active_support` to keep current behavior.' end @inflector = inflector_from(with) @inferring = true end # Disable inference for key and resource name def disable_inference! @inferring = false end # Set error handler # # @param [Symbol] handler # @param [Block] # @raise [ArgumentError] if both handler and block params exist # @raise [ArgumentError] if both handler and block params don't exist # @deprecated Use `Resource.on_error` instead # @return [void] def on_error(handler = nil, &block) Alba::Deprecation.warn '`Alba.on_error` is deprecated, use `on_error` on resource class instead.' raise ArgumentError, 'You cannot specify error handler with both Symbol and block' if handler && block raise ArgumentError, 'You must specify error handler with either Symbol or block' unless handler || block @_on_error = handler || block end # Set nil handler # # @param block [Block] # @return [void] # @deprecated Use `Resource.on_nil` instead def on_nil(&block) Alba::Deprecation.warn '`Alba.on_nil` is deprecated, use `on_nil` on resource class instead.' @_on_nil = block end # Enable root key transformation # # @deprecated Use `Resource.transform_keys` with `root` option instead def enable_root_key_transformation! Alba::Deprecation.warn '`Alba.enable_root_key_transformation!` is deprecated, use `transform_keys` on resource class instead.' @transforming_root_key = true end # Disable root key transformation # # @deprecated Use `Resource.transform_keys` with `root` option instead def disable_root_key_transformation! Alba::Deprecation.warn '`Alba.disable_root_key_transformation!` is deprecated, use `transform_keys` on resource class instead.' @transforming_root_key = false end # @param block [Block] resource body # @return [Class] resource class def resource_class(&block) klass = Class.new klass.include(Alba::Resource) klass.class_eval(&block) klass end # @param name [String] a String Alba infers resource name with # @param nesting [String, nil] namespace Alba tries to find resource class in # @return [Class] resource class def infer_resource_class(name, nesting: nil) raise Alba::Error, 'Inference is disabled so Alba cannot infer resource name. Use `Alba.enable_inference!` before use.' unless Alba.inferring const_parent = nesting.nil? ? Object : Object.const_get(nesting) const_parent.const_get("#{inflector.classify(name)}Resource") end # Reset config variables # Useful for test cleanup def reset! @encoder = default_encoder @_on_error = :raise @_on_nil = nil @transforming_root_key = false # TODO: This will be true since 2.0 end private def inflector_from(name_or_module) case name_or_module when :default, :active_support require_relative 'alba/default_inflector' Alba::DefaultInflector when :dry require 'dry/inflector' Dry::Inflector.new else validate_inflector(name_or_module) end end def set_encoder_from_backend @encoder = case @backend when :oj, :oj_strict then try_oj when :oj_rails then try_oj(mode: :rails) when :active_support then try_active_support when nil, :default, :json then default_encoder else raise Alba::UnsupportedBackend, "Unsupported backend, #{backend}" end end def try_oj(mode: :strict) require 'oj' ->(hash) { Oj.dump(hash, mode: mode) } rescue LoadError Kernel.warn '`Oj` is not installed, falling back to default JSON encoder.' default_encoder end def try_active_support require 'active_support/json' ->(hash) { ActiveSupport::JSON.encode(hash) } rescue LoadError Kernel.warn '`ActiveSupport` is not installed, falling back to default JSON encoder.' default_encoder end def default_encoder lambda do |hash| JSON.dump(hash) end end def validate_inflector(inflector) unless %i[camelize camelize_lower dasherize classify].all? { |m| inflector.respond_to?(m) } raise Alba::Error, "Given inflector, #{inflector.inspect} is not valid. It must implement `camelize`, `camelize_lower`, `dasherize` and `classify`." end inflector end end reset! end