alba 1.1.0 → 1.5.0

data/lib/alba/key_transform_factory.rb

@@ -0,0 +1,33 @@
+module Alba
+  # This module creates key transform functions
+  module KeyTransformFactory
+    class << self
+      # Create key transform function for given transform_type
+      #
+      # @param transform_type [Symbol] transform type
+      # @return [Proc] transform function
+      # @raise [Alba::Error] when transform_type is not supported
+      def create(transform_type)
+        case transform_type
+        when :camel
+          ->(key) { _inflector.camelize(key) }
+        when :lower_camel
+          ->(key) { _inflector.camelize_lower(key) }
+        when :dash
+          ->(key) { _inflector.dasherize(key) }
+        else
+          raise ::Alba::Error, "Unknown transform_type: #{transform_type}. Supported transform_type are :camel, :lower_camel and :dash."
+        end
+      end
+
+      private
+
+      def _inflector
+        Alba.inflector || begin
+          require_relative './default_inflector'
+          Alba::DefaultInflector
+        end
+      end
+    end
+  end
+end

data/lib/alba/many.rb

@@ -15,7 +15,7 @@ module Alba
       return if @object.nil?
 
       @resource = constantize(@resource)
-      @object.map { |o| @resource.new(o, params: params, within: within).to_hash }
+      @resource.new(@object, params: params, within: within).to_hash
     end
   end
 end

data/lib/alba/resource.rb

@@ -1,14 +1,20 @@
 require_relative 'one'
 require_relative 'many'
+require_relative 'key_transform_factory'
+require_relative 'typed_attribute'
+require_relative 'deprecation'
 
 module Alba
   # This module represents what should be serialized
   module Resource
     # @!parse include InstanceMethods
     # @!parse extend ClassMethods
-    DSLS = {_attributes: {}, _key: nil, _transform_keys: nil, _on_error: nil}.freeze
+    DSLS = {_attributes: {}, _key: nil, _key_for_collection: nil, _meta: nil, _transform_key_function: nil, _transforming_root_key: false, _on_error: nil, _on_nil: nil, _layout: nil}.freeze # rubocop:disable Layout/LineLength
     private_constant :DSLS
 
+    WITHIN_DEFAULT = Object.new.freeze
+    private_constant :WITHIN_DEFAULT
+
     # @private
     def self.included(base)
       super
@@ -28,8 +34,8 @@ module Alba
 
       # @param object [Object] the object to be serialized
       # @param params [Hash] user-given Hash for arbitrary data
-      # @param within [Hash] determines what associations to be serialized. If not set, it serializes all associations.
-      def initialize(object, params: {}, within: true)
+      # @param within [Object, nil, false, true] determines what associations to be serialized. If not set, it serializes all associations.
+      def initialize(object, params: {}, within: WITHIN_DEFAULT)
         @object = object
         @params = params.freeze
         @within = within
@@ -38,13 +44,22 @@ module Alba
 
       # Serialize object into JSON string
       #
-      # @param key [Symbol]
+      # @param key [Symbol, nil, true] DEPRECATED, use root_key instead
+      # @param root_key [Symbol, nil, true]
+      # @param meta [Hash] metadata for this seialization
       # @return [String] serialized JSON string
-      def serialize(key: nil)
-        key = key.nil? ? _key : key
-        hash = key && key != '' ? {key.to_s => serializable_hash} : serializable_hash
-        Alba.encoder.call(hash)
+      def serialize(key: nil, root_key: nil, meta: {})
+        Alba::Deprecation.warn '`key` option to `serialize` method is deprecated, use `root_key` instead.' if key
+        key = key.nil? && root_key.nil? ? fetch_key : root_key || key
+        hash = if key && key != ''
+                 h = {key.to_s => serializable_hash}
+                 hash_with_metadata(h, meta)
+               else
+                 serializable_hash
+               end
+        serialize_with(hash)
       end
+      alias to_json serialize
 
       # A Hash for serialization
       #
@@ -56,27 +71,63 @@ module Alba
 
       private
 
+      attr_reader :serialized_json # Mainly for layout
+
+      def encode(hash)
+        Alba.encoder.call(hash)
+      end
+
+      def serialize_with(hash)
+        @serialized_json = encode(hash)
+        case @_layout
+        when String # file
+          ERB.new(File.read(@_layout)).result(binding)
+        when Proc # inline
+          inline = instance_eval(&@_layout)
+          inline.is_a?(Hash) ? encode(inline) : inline
+        else # no layout
+          @serialized_json
+        end
+      end
+
+      def hash_with_metadata(hash, meta)
+        base = @_meta ? instance_eval(&@_meta) : {}
+        metadata = base.merge(meta)
+        hash[:meta] = metadata unless metadata.empty?
+        hash
+      end
+
+      def fetch_key
+        collection? ? _key_for_collection : _key
+      end
+
+      def _key_for_collection
+        return @_key_for_collection.to_s unless @_key_for_collection == true && Alba.inferring
+
+        key = resource_name.pluralize
+        transforming_root_key? ? transform_key(key) : key
+      end
+
       # @return [String]
       def _key
-        if @_key == true && Alba.inferring
-          demodulized = ActiveSupport::Inflector.demodulize(self.class.name)
-          meth = collection? ? :tableize : :singularize
-          ActiveSupport::Inflector.public_send(meth, demodulized.delete_suffix('Resource').downcase)
-        else
-          @_key.to_s
-        end
+        return @_key.to_s unless @_key == true && Alba.inferring
+
+        transforming_root_key? ? transform_key(resource_name) : resource_name
+      end
+
+      def resource_name
+        self.class.name.demodulize.delete_suffix('Resource').underscore
+      end
+
+      def transforming_root_key?
+        @_transforming_root_key.nil? ? Alba.transforming_root_key : @_transforming_root_key
       end
 
       def converter
         lambda do |object|
           arrays = @_attributes.map do |key, attribute|
-            key = transform_key(key)
-            if attribute.is_a?(Array) # Conditional
-              conditional_attribute(object, key, attribute)
-            else
-              [key, fetch_attribute(object, attribute)]
-            end
-          rescue ::Alba::Error, FrozenError
+            key_and_attribute_body_from(object, key, attribute)
+          rescue ::Alba::Error, FrozenError, TypeError
             raise
           rescue StandardError => e
             handle_error(e, object, key, attribute)
@@ -85,33 +136,50 @@ module Alba
         end
       end
 
+      def key_and_attribute_body_from(object, key, attribute)
+        key = transform_key(key)
+        if attribute.is_a?(Array) # Conditional
+          conditional_attribute(object, key, attribute)
+        else
+          fetched_attribute = fetch_attribute(object, key, attribute)
+          [key, fetched_attribute]
+        end
+      end
+
       def conditional_attribute(object, key, attribute)
         condition = attribute.last
+        if condition.is_a?(Proc)
+          conditional_attribute_with_proc(object, key, attribute.first, condition)
+        else
+          conditional_attribute_with_symbol(object, key, attribute.first, condition)
+        end
+      end
+
+      def conditional_attribute_with_proc(object, key, attribute, condition)
         arity = condition.arity
-        return [] if arity <= 1 && !condition.call(object)
+        # We can return early to skip fetch_attribute
+        return [] if arity <= 1 && !instance_exec(object, &condition)
 
-        fetched_attribute = fetch_attribute(object, attribute.first)
-        attr = if attribute.first.is_a?(Alba::Association)
-                 attribute.first.object
-               else
-                 fetched_attribute
-               end
-        return [] if arity >= 2 && !condition.call(object, attr)
+        fetched_attribute = fetch_attribute(object, key, attribute)
+        attr = attribute.is_a?(Alba::Association) ? attribute.object : fetched_attribute
+        return [] if arity >= 2 && !instance_exec(object, attr, &condition)
 
         [key, fetched_attribute]
       end
 
+      def conditional_attribute_with_symbol(object, key, attribute, condition)
+        return [] unless __send__(condition)
+
+        [key, fetch_attribute(object, key, attribute)]
+      end
+
       def handle_error(error, object, key, attribute)
         on_error = @_on_error || Alba._on_error
         case on_error
-        when :raise, nil
-          raise
-        when :nullify
-          [key, nil]
-        when :ignore
-          []
-        when Proc
-          on_error.call(error, object, key, attribute, self.class)
+        when :raise, nil then raise
+        when :nullify then [key, nil]
+        when :ignore then []
+        when Proc then on_error.call(error, object, key, attribute, self.class)
         else
           raise ::Alba::Error, "Unknown on_error: #{on_error.inspect}"
         end
@@ -119,40 +187,39 @@ module Alba
 
       # Override this method to supply custom key transform method
       def transform_key(key)
-        return key unless @_transform_keys
+        return key if @_transform_key_function.nil?
 
-        require_relative 'key_transformer'
-        KeyTransformer.transform(key, @_transform_keys)
+        @_transform_key_function.call(key.to_s)
       end
 
-      def fetch_attribute(object, attribute)
-        case attribute
-        when Symbol
-          object.public_send attribute
-        when Proc
-          instance_exec(object, &attribute)
-        when Alba::One, Alba::Many
-          within = check_within
-          return unless within
+      def fetch_attribute(object, key, attribute)
+        value = case attribute
+                when Symbol then object.public_send attribute
+                when Proc then instance_exec(object, &attribute)
+                when Alba::One, Alba::Many then yield_if_within(attribute.name.to_sym) { |within| attribute.to_hash(object, params: params, within: within) }
+                when TypedAttribute then attribute.value(object)
+                else
+                  raise ::Alba::Error, "Unsupported type of attribute: #{attribute.class}"
+                end
+        value.nil? && nil_handler ? instance_exec(object, key, attribute, &nil_handler) : value
+      end
 
-          attribute.to_hash(object, params: params, within: within)
-        else
-          raise ::Alba::Error, "Unsupported type of attribute: #{attribute.class}"
-        end
+      def nil_handler
+        @nil_handler ||= (@_on_nil || Alba._on_nil)
       end
 
-      def check_within
+      def yield_if_within(association_name)
+        within = check_within(association_name)
+        yield(within) if within
+      end
+
+      def check_within(association_name)
         case @within
-        when Hash # Traverse within tree
-          @within.fetch(_key.to_sym, nil)
-        when Array # within tree ends with Array
-          @within.find { |item| item.to_sym == _key.to_sym } # Check if at least one item in the array matches current resource
-        when Symbol # within tree could end with Symbol
-          @within == _key.to_sym # Check if the symbol matches current resource
-        when true # In this case, Alba serializes all associations.
-          true
-        when nil, false # In these cases, Alba stops serialization here.
-          false
+        when WITHIN_DEFAULT then WITHIN_DEFAULT # Default value, doesn't check within tree
+        when Hash then @within.fetch(association_name, nil) # Traverse within tree
+        when Array then @within.find { |item| item.to_sym == association_name }
+        when Symbol then @within == association_name
+        when nil, true, false then false # Stop here
         else
           raise Alba::Error, "Unknown type for within option: #{@within.class}"
         end
@@ -173,23 +240,49 @@ module Alba
         DSLS.each_key { |name| subclass.instance_variable_set("@#{name}", instance_variable_get("@#{name}").clone) }
       end
 
+      # Defining methods for DSLs and disable parameter number check since for users' benefits increasing params is fine
+      # rubocop:disable Metrics/ParameterLists
+
       # Set multiple attributes at once
       #
       # @param attrs [Array<String, Symbol>]
-      # @param options [Hash] option hash including `if` that is a  condition to render these attributes
-      def attributes(*attrs, **options)
+      # @param if [Proc] condition to decide if it should serialize these attributes
+      # @param attrs_with_types [Hash<[Symbol, String], [Array<Symbol, Proc>, Symbol]>]
+      #   attributes with name in its key and type and optional type converter in its value
+      # @return [void]
+      def attributes(*attrs, if: nil, **attrs_with_types) # rubocop:disable Naming/MethodParameterName
+        if_value = binding.local_variable_get(:if)
+        assign_attributes(attrs, if_value)
+        assign_attributes_with_types(attrs_with_types, if_value)
+      end
+
+      def assign_attributes(attrs, if_value)
         attrs.each do |attr_name|
-          attr = options[:if] ? [attr_name.to_sym, options[:if]] : attr_name.to_sym
+          attr = if_value ? [attr_name.to_sym, if_value] : attr_name.to_sym
           @_attributes[attr_name.to_sym] = attr
         end
       end
+      private :assign_attributes
+
+      def assign_attributes_with_types(attrs_with_types, if_value)
+        attrs_with_types.each do |attr_name, type_and_converter|
+          attr_name = attr_name.to_sym
+          type, type_converter = type_and_converter
+          typed_attr = TypedAttribute.new(name: attr_name, type: type, converter: type_converter)
+          attr = if_value ? [typed_attr, if_value] : typed_attr
+          @_attributes[attr_name] = attr
+        end
+      end
+      private :assign_attributes_with_types
 
       # Set an attribute with the given block
       #
       # @param name [String, Symbol] key name
-      # @param options [Hash] option hash including `if` that is a  condition to render
+      # @param options [Hash<Symbol, Proc>]
+      # @option options [Proc] if a condition to decide if this attribute should be serialized
       # @param block [Block] the block called during serialization
       # @raise [ArgumentError] if block is absent
+      # @return [void]
       def attribute(name, **options, &block)
         raise ArgumentError, 'No block given in attribute method' unless block
 
@@ -198,12 +291,14 @@ module Alba
 
       # Set One association
       #
-      # @param name [String, Symbol]
-      # @param condition [Proc]
-      # @param resource [Class<Alba::Resource>]
-      # @param key [String, Symbol] used as key when given
-      # @param options [Hash] option hash including `if` that is a  condition to render
+      # @param name [String, Symbol] name of the association, used as key when `key` param doesn't exist
+      # @param condition [Proc, nil] a Proc to modify the association
+      # @param resource [Class<Alba::Resource>, String, nil] representing resource for this association
+      # @param key [String, Symbol, nil] used as key when given
+      # @param options [Hash<Symbol, Proc>]
+      # @option options [Proc] if a condition to decide if this association should be serialized
       # @param block [Block]
+      # @return [void]
       # @see Alba::One#initialize
       def one(name, condition = nil, resource: nil, key: nil, **options, &block)
         nesting = self.name&.rpartition('::')&.first
@@ -214,12 +309,14 @@ module Alba
 
       # Set Many association
       #
-      # @param name [String, Symbol]
-      # @param condition [Proc]
-      # @param resource [Class<Alba::Resource>]
-      # @param key [String, Symbol] used as key when given
-      # @param options [Hash] option hash including `if` that is a  condition to render
+      # @param name [String, Symbol] name of the association, used as key when `key` param doesn't exist
+      # @param condition [Proc, nil] a Proc to filter the collection
+      # @param resource [Class<Alba::Resource>, String, nil] representing resource for this association
+      # @param key [String, Symbol, nil] used as key when given
+      # @param options [Hash<Symbol, Proc>]
+      # @option options [Proc] if a condition to decide if this association should be serialized
       # @param block [Block]
+      # @return [void]
       # @see Alba::Many#initialize
       def many(name, condition = nil, resource: nil, key: nil, **options, &block)
         nesting = self.name&.rpartition('::')&.first
@@ -231,14 +328,48 @@ module Alba
       # Set key
       #
       # @param key [String, Symbol]
+      # @deprecated Use {#root_key} instead
       def key(key)
+        Alba::Deprecation.warn '[DEPRECATION] `key` is deprecated, use `root_key` instead.'
         @_key = key.respond_to?(:to_sym) ? key.to_sym : key
       end
 
+      # Set root key
+      #
+      # @param key [String, Symbol]
+      # @param key_for_collection [String, Symbol]
+      # @raise [NoMethodError] when key doesn't respond to `to_sym` method
+      def root_key(key, key_for_collection = nil)
+        @_key = key.to_sym
+        @_key_for_collection = key_for_collection&.to_sym
+      end
+
       # Set key to true
       #
+      # @deprecated Use {#root_key!} instead
       def key!
+        Alba::Deprecation.warn '[DEPRECATION] `key!` is deprecated, use `root_key!` instead.'
+        @_key = true
+        @_key_for_collection = true
+      end
+
+      # Set root key to true
+      def root_key!
         @_key = true
+        @_key_for_collection = true
+      end
+
+      # Set metadata
+      def meta(&block)
+        @_meta = block
+      end
+
+      # Set layout
+      #
+      # @params file [String] name of the layout file
+      # @params inline [Proc] a proc returning JSON string or a Hash representing JSON
+      def layout(file: nil, inline: nil)
+        @_layout = file || inline
       end
 
       # Delete attributes
@@ -254,20 +385,32 @@ module Alba
       # Transform keys as specified type
       #
       # @param type [String, Symbol]
-      def transform_keys(type)
-        @_transform_keys = type.to_sym
+      # @param root [Boolean] decides if root key also should be transformed
+      def transform_keys(type, root: nil)
+        @_transform_key_function = KeyTransformFactory.create(type.to_sym)
+        @_transforming_root_key = root
       end
 
       # Set error handler
+      # If this is set it's used as a error handler overriding global one
       #
-      # @param [Symbol] handler
-      # @param [Block]
+      # @param handler [Symbol] `:raise`, `:ignore` or `:nullify`
+      # @param block [Block]
       def on_error(handler = nil, &block)
         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]
+      def on_nil(&block)
+        @_on_nil = block
+      end
+
+      # rubocop:enable Metrics/ParameterLists
     end
   end
 end

data/lib/alba/typed_attribute.rb

@@ -0,0 +1,61 @@
+module Alba
+  # Representing typed attributes to encapsulate logic about types
+  class TypedAttribute
+    # @param name [Symbol, String]
+    # @param type [Symbol, Class]
+    # @param converter [Proc]
+    def initialize(name:, type:, converter:)
+      @name = name
+      @type = type
+      @converter = case converter
+                   when true then default_converter
+                   when false, nil then null_converter
+                   else converter
+                   end
+    end
+
+    # @param object [Object] target to check and convert type with
+    # @return [String, Integer, Boolean] type-checked or type-converted object
+    def value(object)
+      value, result = check(object)
+      result ? value : @converter.call(value)
+    rescue TypeError
+      raise TypeError, "Attribute #{@name} is expected to be #{@type} but actually #{display_value_for(value)}."
+    end
+
+    private
+
+    def check(object)
+      value = object.public_send(@name)
+      type_correct = case @type
+                     when :String, ->(klass) { klass == String } then value.is_a?(String)
+                     when :Integer, ->(klass) { klass == Integer } then value.is_a?(Integer)
+                     when :Boolean then [true, false].include?(value)
+                     else
+                       raise Alba::UnsupportedType, "Unknown type: #{@type}"
+                     end
+      [value, type_correct]
+    end
+
+    def default_converter
+      case @type
+      when :String, ->(klass) { klass == String }
+        ->(object) { object.to_s }
+      when :Integer, ->(klass) { klass == Integer }
+        ->(object) { Integer(object) }
+      when :Boolean
+        ->(object) { !!object }
+      else
+        raise Alba::UnsupportedType, "Unknown type: #{@type}"
+      end
+    end
+
+    def null_converter
+      ->(_) { raise TypeError }
+    end
+
+    def display_value_for(value)
+      value.nil? ? 'nil' : value.class.name
+    end
+  end
+end

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.5.0'.freeze
 end