alba 0.12.0 → 1.1.0

data/lib/alba/association.rb

@@ -2,25 +2,40 @@ module Alba
   # Base class for `One` and `Many`
   # Child class should implement `to_hash` method
   class Association
+    attr_reader :object
+
     # @param name [Symbol] name of the method to fetch association
     # @param condition [Proc] a proc filtering data
     # @param resource [Class<Alba::Resource>] a resource class for the association
     # @param block [Block] used to define resource when resource arg is absent
-    def initialize(name:, condition: nil, resource: nil, &block)
+    def initialize(name:, condition: nil, resource: nil, nesting: nil, &block)
       @name = name
       @condition = condition
       @block = block
-      @resource = resource || resource_class
-      raise ArgumentError, 'resource or block is required' if @resource.nil? && @block.nil?
-    end
+      @resource = resource
+      return if @resource
 
-    # @abstract
-    def to_hash
-      :not_implemented
+      if @block
+        @resource = resource_class
+      elsif Alba.inferring
+        const_parent = nesting.nil? ? Object : Object.const_get(nesting)
+        @resource = const_parent.const_get("#{ActiveSupport::Inflector.classify(@name)}Resource")
+      else
+        raise ArgumentError, 'When Alba.inferring is false, either resource or block is required'
+      end
     end
 
     private
 
+    def constantize(resource)
+      case resource # rubocop:disable Style/MissingElse
+      when Class
+        resource
+      when Symbol, String
+        Object.const_get(resource)
+      end
+    end
+
     def resource_class
       klass = Class.new
       klass.include(Alba::Resource)

data/lib/alba/key_transformer.rb

@@ -0,0 +1,32 @@
+module Alba
+  # Transform keys using `ActiveSupport::Inflector`
+  module KeyTransformer
+    begin
+      require 'active_support/inflector'
+    rescue LoadError
+      raise ::Alba::Error, 'To use transform_keys, please install `ActiveSupport` gem.'
+    end
+
+    module_function
+
+    # Transform key as given transform_type
+    #
+    # @params key [String] key to be transformed
+    # @params transform_type [Symbol] transform type
+    # @return [String] transformed key
+    # @raise [Alba::Error] when transform_type is not supported
+    def transform(key, transform_type)
+      key = key.to_s
+      case transform_type
+      when :camel
+        ActiveSupport::Inflector.camelize(key)
+      when :lower_camel
+        ActiveSupport::Inflector.camelize(key, false)
+      when :dash
+        ActiveSupport::Inflector.dasherize(key)
+      else
+        raise ::Alba::Error, "Unknown transform_type: #{transform_type}. Supported transform_type are :camel, :lower_camel and :dash."
+      end
+    end
+  end
+end

data/lib/alba/many.rb

@@ -6,12 +6,16 @@ module Alba
     # Recursively converts objects into an Array of Hashes
     #
     # @param target [Object] the object having an association method
+    # @param within [Hash] determines what associations to be serialized. If not set, it serializes all associations.
     # @param params [Hash] user-given Hash for arbitrary data
     # @return [Array<Hash>]
-    def to_hash(target, params: {})
-      objects = target.public_send(@name)
-      objects = @condition.call(objects, params) if @condition
-      objects.map { |o| @resource.new(o, params: params).to_hash }
+    def to_hash(target, within: nil, params: {})
+      @object = target.public_send(@name)
+      @object = @condition.call(@object, params) if @condition
+      return if @object.nil?
+
+      @resource = constantize(@resource)
+      @object.map { |o| @resource.new(o, params: params, within: within).to_hash }
     end
   end
 end

data/lib/alba/one.rb

@@ -6,12 +6,16 @@ module Alba
     # Recursively converts an object into a Hash
     #
     # @param target [Object] the object having an association method
+    # @param within [Hash] determines what associations to be serialized. If not set, it serializes all associations.
     # @param params [Hash] user-given Hash for arbitrary data
     # @return [Hash]
-    def to_hash(target, params: {})
-      object = target.public_send(@name)
-      object = @condition.call(object, params) if @condition
-      @resource.new(object, params: params).to_hash
+    def to_hash(target, within: nil, params: {})
+      @object = target.public_send(@name)
+      @object = @condition.call(object, params) if @condition
+      return if @object.nil?
+
+      @resource = constantize(@resource)
+      @resource.new(object, params: params, within: within).to_hash
     end
   end
 end

data/lib/alba/resource.rb

@@ -1,4 +1,3 @@
-require_relative 'serializer'
 require_relative 'one'
 require_relative 'many'
 
@@ -7,7 +6,7 @@ module Alba
   module Resource
     # @!parse include InstanceMethods
     # @!parse extend ClassMethods
-    DSLS = {_attributes: {}, _serializer: nil, _key: nil}.freeze
+    DSLS = {_attributes: {}, _key: nil, _transform_keys: nil, _on_error: nil}.freeze
     private_constant :DSLS
 
     # @private
@@ -25,32 +24,26 @@ module Alba
 
     # Instance methods
     module InstanceMethods
-      attr_reader :object, :_key, :params
+      attr_reader :object, :params
 
       # @param object [Object] the object to be serialized
       # @param params [Hash] user-given Hash for arbitrary data
-      def initialize(object, params: {})
+      # @param within [Hash] determines what associations to be serialized. If not set, it serializes all associations.
+      def initialize(object, params: {}, within: true)
         @object = object
         @params = params.freeze
+        @within = within
         DSLS.each_key { |name| instance_variable_set("@#{name}", self.class.public_send(name)) }
       end
 
-      # Get serializer with `with` argument and serialize self with it
+      # Serialize object into JSON string
       #
-      # @param with [nil, Proc, Alba::Serializer] selializer
+      # @param key [Symbol]
       # @return [String] serialized JSON string
-      def serialize(with: nil)
-        serializer = case with
-                     when nil
-                       @_serializer || empty_serializer
-                     when ->(obj) { obj.is_a?(Class) && obj <= Alba::Serializer }
-                       with
-                     when Proc
-                       inline_extended_serializer(with)
-                     else
-                       raise ArgumentError, 'Unexpected type for with, possible types are Class or Proc'
-                     end
-        serializer.new(self).serialize
+      def serialize(key: nil)
+        key = key.nil? ? _key : key
+        hash = key && key != '' ? {key.to_s => serializable_hash} : serializable_hash
+        Alba.encoder.call(hash)
       end
 
       # A Hash for serialization
@@ -61,40 +54,108 @@ module Alba
       end
       alias to_hash serializable_hash
 
-      # @return [Symbol]
-      def key
-        @_key || self.class.name.delete_suffix('Resource').downcase.gsub(/:{2}/, '_').to_sym
-      end
-
       private
 
+      # @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
+      end
+
       def converter
-        lambda do |resource|
-          @_attributes.transform_values do |attribute|
-            case attribute
-            when Symbol
-              resource.public_send attribute
-            when Proc
-              instance_exec(resource, &attribute)
-            when Alba::One, Alba::Many
-              attribute.to_hash(resource, params: params)
+        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
-              raise ::Alba::Error, "Unsupported type of attribute: #{attribute.class}"
+              [key, fetch_attribute(object, attribute)]
             end
+          rescue ::Alba::Error, FrozenError
+            raise
+          rescue StandardError => e
+            handle_error(e, object, key, attribute)
           end
+          arrays.reject(&:empty?).to_h
+        end
+      end
+
+      def conditional_attribute(object, key, attribute)
+        condition = attribute.last
+        arity = condition.arity
+        return [] if arity <= 1 && !condition.call(object)
+
+        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)
+
+        [key, fetched_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)
+        else
+          raise ::Alba::Error, "Unknown on_error: #{on_error.inspect}"
         end
       end
 
-      def empty_serializer
-        klass = Class.new
-        klass.include Alba::Serializer
-        klass
+      # Override this method to supply custom key transform method
+      def transform_key(key)
+        return key unless @_transform_keys
+
+        require_relative 'key_transformer'
+        KeyTransformer.transform(key, @_transform_keys)
+      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
+
+          attribute.to_hash(object, params: params, within: within)
+        else
+          raise ::Alba::Error, "Unsupported type of attribute: #{attribute.class}"
+        end
       end
 
-      def inline_extended_serializer(with)
-        klass = empty_serializer
-        klass.class_eval(&with)
-        klass
+      def check_within
+        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
+        else
+          raise Alba::Error, "Unknown type for within option: #{@within.class}"
+        end
       end
 
       def collection?
@@ -115,19 +176,24 @@ module Alba
       # Set multiple attributes at once
       #
       # @param attrs [Array<String, Symbol>]
-      def attributes(*attrs)
-        attrs.each { |attr_name| @_attributes[attr_name.to_sym] = attr_name.to_sym }
+      # @param options [Hash] option hash including `if` that is a  condition to render these attributes
+      def attributes(*attrs, **options)
+        attrs.each do |attr_name|
+          attr = options[:if] ? [attr_name.to_sym, options[:if]] : attr_name.to_sym
+          @_attributes[attr_name.to_sym] = attr
+        end
       end
 
       # 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 block [Block] the block called during serialization
       # @raise [ArgumentError] if block is absent
-      def attribute(name, &block)
+      def attribute(name, **options, &block)
         raise ArgumentError, 'No block given in attribute method' unless block
 
-        @_attributes[name.to_sym] = block
+        @_attributes[name.to_sym] = options[:if] ? [block, options[:if]] : block
       end
 
       # Set One association
@@ -136,10 +202,13 @@ module Alba
       # @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 block [Block]
       # @see Alba::One#initialize
-      def one(name, condition = nil, resource: nil, key: nil, &block)
-        @_attributes[key&.to_sym || name.to_sym] = One.new(name: name, condition: condition, resource: resource, &block)
+      def one(name, condition = nil, resource: nil, key: nil, **options, &block)
+        nesting = self.name&.rpartition('::')&.first
+        one = One.new(name: name, condition: condition, resource: resource, nesting: nesting, &block)
+        @_attributes[key&.to_sym || name.to_sym] = options[:if] ? [one, options[:if]] : one
       end
       alias has_one one
 
@@ -149,25 +218,27 @@ module Alba
       # @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 block [Block]
       # @see Alba::Many#initialize
-      def many(name, condition = nil, resource: nil, key: nil, &block)
-        @_attributes[key&.to_sym || name.to_sym] = Many.new(name: name, condition: condition, resource: resource, &block)
+      def many(name, condition = nil, resource: nil, key: nil, **options, &block)
+        nesting = self.name&.rpartition('::')&.first
+        many = Many.new(name: name, condition: condition, resource: resource, nesting: nesting, &block)
+        @_attributes[key&.to_sym || name.to_sym] = options[:if] ? [many, options[:if]] : many
       end
       alias has_many many
 
-      # Set serializer for the resource
-      #
-      # @param name [Alba::Serializer]
-      def serializer(name)
-        @_serializer = name <= Alba::Serializer ? name : nil
-      end
-
       # Set key
       #
       # @param key [String, Symbol]
       def key(key)
-        @_key = key.to_sym
+        @_key = key.respond_to?(:to_sym) ? key.to_sym : key
+      end
+
+      # Set key to true
+      #
+      def key!
+        @_key = true
       end
 
       # Delete attributes
@@ -179,6 +250,24 @@ module Alba
           @_attributes.delete(attr_name.to_sym)
         end
       end
+
+      # Transform keys as specified type
+      #
+      # @param type [String, Symbol]
+      def transform_keys(type)
+        @_transform_keys = type.to_sym
+      end
+
+      # Set error handler
+      #
+      # @param [Symbol] handler
+      # @param [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
     end
   end
 end

data/lib/alba/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 1.1.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies: []
 description: Alba is designed to be a simple, easy to use and fast alternative to
   existing JSON serializers. Its performance is better than almost all gems which
@@ -19,25 +19,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - alba.gemspec
+- benchmark/local.rb
 - bin/console
 - bin/setup
+- codecov.yml
+- gemfiles/all.gemfile
+- gemfiles/without_active_support.gemfile
+- gemfiles/without_oj.gemfile
 - lib/alba.rb
 - lib/alba/association.rb
+- lib/alba/key_transformer.rb
 - lib/alba/many.rb
 - lib/alba/one.rb
 - lib/alba/resource.rb
-- lib/alba/serializer.rb
 - lib/alba/version.rb
 - sider.yml
 homepage: https://github.com/okuramasafumi/alba
@@ -46,7 +51,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/okuramasafumi/alba
   source_code_uri: https://github.com/okuramasafumi/alba
-  changelog_uri: https://github.com/okuramasafumi/alba/CHANGELOG.md
+  changelog_uri: https://github.com/okuramasafumi/alba/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -55,14 +60,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.7
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: Alba is the fastest JSON serializer for Ruby.