alba 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee2f8d482fedb98083c2acab37b425c7ecedb429ab7bae7698b4eea7949635d9
-  data.tar.gz: 1a44f23d425072253ba6743e18c6da9d8fa81de448b58720848c4e9667b12bfb
+  metadata.gz: f4a5b866825838f457bb17c0c1037f68c3e88a9b96c86dd9e0c456d101f69158
+  data.tar.gz: d1f451fff558385b3ae4610355a3abb9aced052ce138eff9913169a12c8a23c6
 SHA512:
-  metadata.gz: 9bf421fcd99f06cb56499ee31c88dda019e004c58a1880c03326f2a1ce395f7dc4b64be7cee012169c7039530194e85a312b3c53d964b1aaf5288cdf8cb78ae4
-  data.tar.gz: 02f20dd839f72f9d2c1859b48470595fff263939f41421e240d74452677edae2dc0569078823984144f630cbc2e6000b6ac3bd0d4161a9ef65bd95dbf311294f
+  metadata.gz: 71fdab1911c6fc9e1ba88e8cbdc553311b99aecd975462b05958e5be1e491aa10734b6b6f6f15f24ae98c8ab5a1b1021d6c544a172befcedd23ca80283529e98
+  data.tar.gz: 05f06f2e7f3ec93e0a616bec6e3d71a90590b68c7ce397050bb9c019d2bbf206b070ed1cf44603cd301fa5dd2634df50c4e08b75a8c478b2f0063b6551b5bdcc

data/.rubocop.yml

@@ -42,6 +42,10 @@ Style/ConstantVisibility:
 Style/Copyright:
   Enabled: false
 
+# I know what I do :)
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: false
+
 Style/FrozenStringLiteralComment:
   Enabled: false
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    alba (0.12.0)
+    alba (0.13.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -221,6 +221,38 @@ RestrictedFooResouce.new(foo).serialize
 end
 ```
 
+### Attribute key transformation
+
+** Note: You need to install `active_support` gem to use `transform_keys` DSL.
+
+With `active_support` installed, you can transform attribute keys.
+
+```ruby
+class User
+  attr_reader :id, :first_name, :last_name
+
+  def initialize(id, first_name, last_name)
+    @id = id
+    @first_name = first_name
+    @last_name = last_name
+  end
+end
+
+class UserResource
+  include Alba::Resource
+
+  attributes :id, :first_name, :last_name
+
+  transform_keys :lower_camel
+end
+
+user = User.new(1, 'Masafumi', 'Okura')
+UserResourceCamel.new(user).serialize
+# => '{"id":1,"firstName":"Masafumi","lastName":"Okura"}'
+```
+
+Supported transformation types are :camel, :lower_camel and :dash.
+
 ## Comparison
 
 Alba is faster than alternatives.

data/lib/alba/key_transformer.rb

@@ -0,0 +1,31 @@
+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)
+      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 and :dash."
+      end
+    end
+  end
+end

data/lib/alba/resource.rb

@@ -7,7 +7,7 @@ module Alba
   module Resource
     # @!parse include InstanceMethods
     # @!parse extend ClassMethods
-    DSLS = {_attributes: {}, _serializer: nil, _key: nil}.freeze
+    DSLS = {_attributes: {}, _serializer: nil, _key: nil, _transform_keys: nil}.freeze
     private_constant :DSLS
 
     # @private
@@ -68,20 +68,34 @@ module Alba
 
       private
 
+      # rubocop:disable Style/MethodCalledOnDoEndBlock
       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)
-            else
-              raise ::Alba::Error, "Unsupported type of attribute: #{attribute.class}"
-            end
-          end
+          @_attributes.map do |key, attribute|
+            [transform_key(key), fetch_attribute(resource, attribute)]
+          end.to_h
+        end
+      end
+      # rubocop:enable Style/MethodCalledOnDoEndBlock
+
+      # 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(resource, 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)
+        else
+          raise ::Alba::Error, "Unsupported type of attribute: #{attribute.class}"
         end
       end
 
@@ -179,6 +193,13 @@ module Alba
           @_attributes.delete(attr_name.to_sym)
         end
       end
+
+      # Transform keys as specified type
+      #
+      # @params type [String, Symbol]
+      def transform_keys(type)
+        @_transform_keys = type.to_sym
+      end
     end
   end
 end

data/lib/alba/serializer.rb

@@ -22,10 +22,10 @@ module Alba
         @resource = resource
         @hash = resource.serializable_hash
         @hash = {key.to_sym => @hash} if key
+        return if metadata.empty?
+
         # @hash is either Hash or Array
-        unless metadata.empty?
-          @hash.is_a?(Hash) ? @hash.merge!(metadata.to_h) : @hash << metadata
-        end
+        @hash.is_a?(Hash) ? @hash.merge!(metadata.to_h) : @hash << metadata
       end
 
       # Use real encoder to actually serialize to JSON

data/lib/alba/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-01-22 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
@@ -34,6 +34,7 @@ files:
 - bin/setup
 - lib/alba.rb
 - lib/alba/association.rb
+- lib/alba/key_transformer.rb
 - lib/alba/many.rb
 - lib/alba/one.rb
 - lib/alba/resource.rb