alba 1.5.0 → 1.6.0

data/lib/alba.rb

@@ -1,19 +1,11 @@
 require 'json'
 require_relative 'alba/version'
+require_relative 'alba/errors'
 require_relative 'alba/resource'
 require_relative 'alba/deprecation'
 
 # Core module
 module Alba
-  # Base class for Errors
-  class Error < StandardError; end
-
-  # Error class for backend which is not supported
-  class UnsupportedBackend < Error; end
-
-  # Error class for type which is not supported
-  class UnsupportedType < Error; end
-
   class << self
     attr_reader :backend, :encoder, :inferring, :_on_error, :_on_nil, :transforming_root_key
 
@@ -60,12 +52,16 @@ module Alba
     end
 
     # Enable inference for key and resource name
-    def enable_inference!
-      begin
-        require 'active_support/inflector'
-      rescue LoadError
-        raise ::Alba::Error, 'To enable inference, please install `ActiveSupport` gem.'
+    #
+    # @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
 
@@ -80,8 +76,10 @@ module Alba
     # @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
 
@@ -92,17 +90,25 @@ module Alba
     #
     # @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
 
@@ -119,9 +125,10 @@ module Alba
     # @param nesting [String, nil] namespace Alba tries to find resource class in
     # @return [Class<Alba::Resource>] resource class
     def infer_resource_class(name, nesting: nil)
-      enable_inference!
+      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("#{ActiveSupport::Inflector.classify(name)}Resource")
+      const_parent.const_get("#{inflector.classify(name)}Resource")
     end
 
     # Reset config variables
@@ -135,6 +142,19 @@ module Alba
 
     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
@@ -167,6 +187,14 @@ module Alba
         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!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-28 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies: []
 description: Alba is the fastest JSON serializer for Ruby. It focuses on performance,
   flexibility and usability.
@@ -21,6 +21,7 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/dependabot.yml"
+- ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/main.yml"
 - ".github/workflows/perf.yml"
 - ".gitignore"
@@ -48,9 +49,7 @@ files:
 - lib/alba/association.rb
 - lib/alba/default_inflector.rb
 - lib/alba/deprecation.rb
-- lib/alba/key_transform_factory.rb
-- lib/alba/many.rb
-- lib/alba/one.rb
+- lib/alba/errors.rb
 - lib/alba/resource.rb
 - lib/alba/typed_attribute.rb
 - lib/alba/version.rb
@@ -60,9 +59,11 @@ homepage: https://github.com/okuramasafumi/alba
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/okuramasafumi/alba
-  source_code_uri: https://github.com/okuramasafumi/alba
+  bug_tracker_uri: https://github.com/okuramasafumi/issues
   changelog_uri: https://github.com/okuramasafumi/alba/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/github/okuramasafumi/alba
+  source_code_uri: https://github.com/okuramasafumi/alba
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -78,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.5
 signing_key:
 specification_version: 4
 summary: Alba is the fastest JSON serializer for Ruby.

data/lib/alba/key_transform_factory.rb

@@ -1,33 +0,0 @@
-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

@@ -1,21 +0,0 @@
-require_relative 'association'
-
-module Alba
-  # Representing many association
-  class Many < Association
-    # 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, 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/one.rb

@@ -1,21 +0,0 @@
-require_relative 'association'
-
-module Alba
-  # Representing one association
-  class One < Association
-    # 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, 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