alba 1.5.0 → 2.0.0

data/lib/alba.rb

@@ -1,23 +1,15 @@
 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
+    attr_reader :backend, :encoder, :inferring
 
-    # Accessor for inflector, a module responsible for incflecting strings
+    # Accessor for inflector, a module responsible for inflecting strings
     attr_accessor :inflector
 
     # Set the backend, which actually serializes object into JSON
@@ -46,26 +38,24 @@ module Alba
     # 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
+    def serialize(object, root_key: nil, &block)
       klass = block ? resource_class(&block) : infer_resource_class(object.class.name)
 
       resource = klass.new(object)
-      resource.serialize(root_key: root_key || key)
+      resource.serialize(root_key: root_key)
     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.'
-      end
+    #
+    # @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:)
+      @inflector = inflector_from(with)
       @inferring = true
     end
 
@@ -74,38 +64,6 @@ module Alba
       @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
-    # @return [void]
-    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]
-    # @return [void]
-    def on_nil(&block)
-      @_on_nil = block
-    end
-
-    # Enable root key transformation
-    def enable_root_key_transformation!
-      @transforming_root_key = true
-    end
-
-    # Disable root key transformation
-    def disable_root_key_transformation!
-      @transforming_root_key = false
-    end
-
     # @param block [Block] resource body
     # @return [Class<Alba::Resource>] resource class
     def resource_class(&block)
@@ -119,9 +77,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
@@ -130,15 +89,28 @@ module Alba
       @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 :oj_default then try_oj(mode: :default)
                  when :active_support then try_active_support
                  when nil, :default, :json then default_encoder
                  else
@@ -148,7 +120,12 @@ module Alba
 
     def try_oj(mode: :strict)
       require 'oj'
-      ->(hash) { Oj.dump(hash, mode: mode) }
+      case mode
+      when :default
+        ->(hash) { Oj.dump(hash) }
+      else
+        ->(hash) { Oj.dump(hash, mode: mode) }
+      end
     rescue LoadError
       Kernel.warn '`Oj` is not installed, falling back to default JSON encoder.'
       default_encoder
@@ -164,8 +141,16 @@ module Alba
 
     def default_encoder
       lambda do |hash|
-        JSON.dump(hash)
+        JSON.generate(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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-28 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies: []
 description: Alba is the fastest JSON serializer for Ruby. It focuses on performance,
   flexibility and usability.
@@ -18,9 +18,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".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"
@@ -28,12 +30,15 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
+- HACKING.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - SECURITY.md
 - alba.gemspec
+- benchmark/README.md
 - benchmark/collection.rb
 - benchmark/single_resource.rb
 - bin/console
@@ -41,28 +46,33 @@ files:
 - codecov.yml
 - docs/migrate_from_active_model_serializers.md
 - docs/migrate_from_jbuilder.md
-- gemfiles/all.gemfile
+- docs/rails.md
 - gemfiles/without_active_support.gemfile
 - gemfiles/without_oj.gemfile
 - lib/alba.rb
 - lib/alba/association.rb
+- lib/alba/conditional_attribute.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/layout.rb
+- lib/alba/nested_attribute.rb
 - lib/alba/resource.rb
 - lib/alba/typed_attribute.rb
 - lib/alba/version.rb
+- logo/alba-card.png
+- logo/alba-sign.png
+- logo/alba-typography.png
 - script/perf_check.rb
-- sider.yml
 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:
@@ -71,14 +81,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.21
 signing_key:
 specification_version: 4
 summary: Alba is the fastest JSON serializer for Ruby.

data/gemfiles/all.gemfile

@@ -1,19 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'activesupport', require: false # For backend
-gem 'ffaker', require: false # For testing
-gem 'minitest', '~> 5.14' # For test
-gem 'rake', '~> 13.0' # For test and automation
-gem 'rubocop', '>= 0.79.0', require: false # For lint
-gem 'rubocop-minitest', '~> 0.11.0', require: false # For lint
-gem 'rubocop-performance', '~> 1.10.1', require: false # For lint
-gem 'rubocop-rake', '>= 0.5.1', require: false # For lint
-gem 'rubocop-sensible', '~> 0.3.0', require: false # For lint
-gem 'simplecov', '~> 0.21.0', require: false # For test coverage
-gem 'simplecov-cobertura', require: false # For test coverage
-gem 'yard', require: false # For documentation
-
-platforms :ruby do
-  gem 'oj', '~> 3.11', require: false # For backend
-  gem 'ruby-prof', require: false # For performance profiling
-end

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

data/sider.yml

@@ -1,60 +0,0 @@
-linter:
-# # https://help.sider.review/getting-started/custom-configuration
-
-#   # https://help.sider.review/tools/ruby/rubocop
-  rubocop:
-    gems:
-      - "rubocop-minitest"
-      - "rubocop-performance"
-      - "rubocop-sensible"
-      - "rubocop-rake"
-    safe: false
-
-#   # https://help.sider.review/tools/ruby/reek
-#   reek:
-#     gems:
-#       - name: "reek"
-#         version: "5.2.0"
-#     target:
-#       - lib/
-#       - test/
-#     config: config/.reek.yml
-
-#   # https://help.sider.review/tools/ruby/querly
-#   querly:
-#     gems:
-#       - "slim"
-
-#   # https://help.sider.review/tools/others/misspell
-#   misspell:
-#     exclude:
-#       - vendor
-#       - "**/*.min.js"
-#       - exclude_file.rb
-#     targets:
-#       - target_directory
-#       - another_target_directory/foo.rb
-#       - bar.rb
-#     locale: UK
-#     ignore: center,behavior
-
-#   # https://help.sider.review/tools/shellscript/shellcheck
-#   shellcheck:
-#     target: "src/**/*.{sh,bash}"
-#     include: "SC2104,SC2105"
-#     exclude: "SC1000,SC1118"
-#     enable: "all"
-#     shell: "bash"
-#     severity: "error"
-#     norc: true
-
-# # https://help.sider.review/getting-started/custom-configuration#ignore
-ignore:
-  - 'test/**/*'
-
-# # https://help.sider.review/getting-started/custom-configuration#branchesexclude
-# branches:
-#   exclude:
-#     - master
-#     - development
-#     - /^release-.*$/