alba 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36890dfa4b9b73b60f1d6a09cf674de7ff7a6dd495ff4b74bbb3d048f9cf5a85
-  data.tar.gz: 3e3d49619f646be866262e14e21e5fba11e2caafbc24064d57eb9c549cb64e4d
+  metadata.gz: bbb5260b5a6f3697f2e9c42ba198e3e17a1b0dc2aa0ea1bd2feb9ed4b18364a2
+  data.tar.gz: 794c146a493068865d7284de00bedda11c3b2fabd2ce7dccaa781e72181d957e
 SHA512:
-  metadata.gz: fc7e025a035b41dadaab5300096cf920eb3557a4be900d31b514dfc66e8ae803b0fb63d77ec06174d72d70ad2e07da81c491502c8462ad306f2379720222fc65
-  data.tar.gz: 741f5c1c69b2809aec51d2a2a139d4d8e00060c9aa174bf5fb68d5dbcec7996096aced5fb377d77fa147d7b6086a65191c8c764802c65bbd88d3806751ec0eb4
+  metadata.gz: 46d179154f3981879a4cda7f5ea0360d7eeb3481788d895acefcbb5df156fde10ee1b0eb78bd399ab247449ea85100aceaa2dcb757a54ba64cce9450d82d1825
+  data.tar.gz: a3ee5f28b7bbc626d4dcf92db32017eba85f60df42df02f07d464cdaa8c190f5c07914db5e9f7db21f73fd1356529add373ef2c79ac82038d22f2c5dd5ee273c

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+## Describe the bug
+A clear and concise description of what the bug is.
+
+## To Reproduce
+Steps to reproduce the behavior:
+
+## Expected behavior
+A clear and concise description of what you expected to happen.
+
+## Actual behavior
+A clear and concise description of what actually happened.
+
+## Environment
+- Ruby version: 
+
+## Additional context
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+## Is your feature request related to a problem? Please describe.
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+## Describe the solution you'd like
+A clear and concise description of what you want to happen.
+
+## Describe alternatives you've considered
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Additional context
+Add any other context or screenshots about the feature request here.

data/.github/dependabot.yml

@@ -0,0 +1,26 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "20:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: rubocop
+    versions:
+    - 1.12.0
+    - 1.9.0
+  - dependency-name: rubocop-performance
+    versions:
+    - 1.10.0
+    - 1.10.2
+  - dependency-name: oj
+    versions:
+    - 3.11.3
+  - dependency-name: minitest
+    versions:
+    - 5.14.4
+  - dependency-name: activesupport
+    versions:
+    - 6.1.2

data/.rubocop.yml

@@ -21,6 +21,15 @@ AllCops:
 Bundler/GemComment:
   Enabled: false
 
+# We'd like to write something like:
+#   assert_equal(
+#     expected,
+#     actual
+#   )
+Layout/RedundantLineBreak:
+  Exclude:
+    - 'test/**/*'
+
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 

data/.yardopts

@@ -1,2 +1,4 @@
 --no-private
 --exclude lib/alba/version.rb
+--embed-mixin ClassMethods
+--embed-mixin InstanceMethods

data/CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.0] 2021-05-09
+
+- [Fix] multiple word key inference [6c18e73]
+  - https://github.com/okuramasafumi/alba/pull/120
+  - Thank you @alfonsojimenez !
+- [Feat] Add `Alba.enable_root_key_transformation!` [f172839]
+  - https://github.com/okuramasafumi/alba/pull/121
+- [Feat] Implement type validation and auto conversion [cbe00c7]
+  - https://github.com/okuramasafumi/alba/pull/122
+
 ## [1.1.0] - 2021-04-23
 
 - [Feat] Implement circular associations control [71e1543]

data/Gemfile

@@ -8,7 +8,7 @@ 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-minitest', '~> 0.12.0', require: false # For lint
 gem 'rubocop-performance', '~> 1.11.0', require: false # For lint
 gem 'rubocop-rake', '>= 0.5.1', require: false # For lint
 gem 'rubocop-sensible', '~> 0.3.0', require: false # For lint

data/README.md

@@ -59,11 +59,6 @@ You can find the documentation on [RubyDoc](https://rubydoc.info/github/okuramas
 
 ## Features
 
-* Resource-based serialization
-* Arbitrary attribute definition
-* One and many association with the ability to define them inline
-* Adding condition and filter to association
-* Parameters can be injected and used in attributes and associations
 * Conditional attributes and associations
 * Selectable backend
 * Key transformation
@@ -71,6 +66,7 @@ You can find the documentation on [RubyDoc](https://rubydoc.info/github/okuramas
 * Error handling
 * Resource name inflection based on association name
 * Circular associations control
+* Types for validation and conversion
 * No runtime dependencies
 
 ## Anti features
@@ -248,7 +244,7 @@ RestrictedFooResouce.new(foo).serialize
 end
 ```
 
-### Attribute key transformation
+### Key transformation
 
 ** Note: You need to install `active_support` gem to use `transform_keys` DSL.
 
@@ -278,6 +274,39 @@ UserResourceCamel.new(user).serialize
 # => '{"id":1,"firstName":"Masafumi","lastName":"Okura"}'
 ```
 
+You can also transform root key when:
+
+* `Alba.enable_inference!` is called
+* `key!` is called in Resource class
+* `root` option of `transform_keys` is set to true or `Alba.enable_root_key_transformation!` is called.
+
+```ruby
+Alba.enable_inference!
+
+class BankAccount
+  attr_reader :account_number
+
+  def initialize(account_number)
+    @account_number = account_number
+  end
+end
+
+class BankAccountResource
+  include Alba::Resource
+
+  key!
+
+  attributes :account_number
+  transform_keys :dash, root: true
+end
+
+bank_account = BankAccount.new(123_456_789)
+BankAccountResource.new(bank_account).serialize
+# => '{"bank-account":{"account-number":123456789}}'
+```
+
+This behavior to transform root key will become default at version 2.
+
 Supported transformation types are :camel, :lower_camel and :dash.
 
 ### Filtering attributes
@@ -457,6 +486,45 @@ You can control circular associations with `within` option. `within` option is a
 
 For more details, please refer to [test code](https://github.com/okuramasafumi/alba/blob/master/test/usecases/circular_association_test.rb)
 
+### Types
+
+You can validate and convert input with types.
+
+```ruby
+class User
+  attr_reader :id, :name, :age, :bio, :admin, :created_at
+
+  def initialize(id, name, age, bio = '', admin = false) # rubocop:disable Style/OptionalBooleanParameter
+    @id = id
+    @name = name
+    @age = age
+    @admin = admin
+    @bio = bio
+    @created_at = Time.new(2020, 10, 10)
+  end
+end
+
+class UserResource
+  include Alba::Resource
+
+  attributes :name, id: [String, true], age: [Integer, true], bio: String, admin: [:Boolean, true], created_at: [String, ->(object) { object.strftime('%F') }]
+end
+
+user = User.new(1, 'Masafumi OKURA', '32', 'Ruby dev')
+UserResource.new(user).serialize
+# => '{"name":"Masafumi OKURA","id":"1","age":32,"bio":"Ruby dev","admin":false,"created_at":"2020-10-10"}'
+```
+
+Notice that `id` and `created_at` are converted to String and `age` is converted to Integer.
+
+If type is not correct and auto conversion is disabled (default), `TypeError` occurs.
+
+```ruby
+user = User.new(1, 'Masafumi OKURA', '32', nil) # bio is nil and auto conversion is disabled for bio
+UserResource.new(user).serialize
+# => TypeError, 'Attribute bio is expected to be String but actually nil.'
+```
+
 ### Caching
 
 Currently, Alba doesn't support caching, primarily due to the behavior of `ActiveRecord::Relation`'s cache. See [the issue](https://github.com/rails/rails/issues/41784).

data/SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x.y   | :white_check_mark: |
+| < 1.0   | :x:                |
+
+## Reporting a Vulnerability
+
+If you find a vulnerability of Alba, please contact me (OKURA Masafumi) via [email](masafumi.o1988@gmail.com). I'll report back within a few days.

data/benchmark/local.rb

@@ -17,6 +17,7 @@ gemfile(true) do
   gem "jbuilder"
   gem "jsonapi-serializer" # successor of fast_jsonapi
   gem "multi_json"
+  gem "primalize"
   gem "oj"
   gem "representable"
   gem "sqlite3"
@@ -213,6 +214,27 @@ class JsonApiSameFormatPostSerializer < JsonApiSameFormatSerializer
   end
 end
 
+# --- Primalize serializers ---
+#
+class PrimalizeCommentResource < Primalize::Single
+  attributes id: integer, body: string
+end
+
+class PrimalizePostResource < Primalize::Single
+  alias post object
+
+  attributes(
+    id: integer,
+    body: string,
+    comments: array(primalize(PrimalizeCommentResource)),
+    commenter_names: array(string),
+  )
+
+  def commenter_names
+    post.commenters.pluck(:name)
+  end
+end
+
 # --- Representable serializers ---
 
 require "representable"
@@ -265,6 +287,7 @@ blueprinter = Proc.new { PostBlueprint.render(post) }
 jbuilder = Proc.new { post.to_builder.target! }
 jsonapi = proc { JsonApiStandardPostSerializer.new(post).to_json }
 jsonapi_same_format = proc { JsonApiSameFormatPostSerializer.new(post).to_json }
+primalize = proc { PrimalizePostResource.new(post).to_json }
 rails = Proc.new { ActiveSupport::JSON.encode(post.serializable_hash(include: :comments)) }
 representable = Proc.new { PostRepresenter.new(post).to_json }
 
@@ -279,6 +302,7 @@ puts "Serializer outputs ----------------------------------"
   jbuilder: jbuilder, # different order
   jsonapi: jsonapi, # nested JSON:API format
   jsonapi_same_format: jsonapi_same_format,
+  primalize: primalize,
   rails: rails,
   representable: representable
 }.each { |name, serializer| puts "#{name.to_s.ljust(24, ' ')} #{serializer.call}" }
@@ -295,6 +319,7 @@ Benchmark.bmbm do |x|
   x.report(:jbuilder) { time.times(&jbuilder) }
   x.report(:jsonapi) { time.times(&jsonapi) }
   x.report(:jsonapi_same_format) { time.times(&jsonapi_same_format) }
+  x.report(:primalize) { time.times(&primalize) }
   x.report(:rails) { time.times(&rails) }
   x.report(:representable) { time.times(&representable) }
 end
@@ -308,6 +333,7 @@ Benchmark.ips do |x|
   x.report(:jbuilder, &jbuilder)
   x.report(:jsonapi, &jsonapi)
   x.report(:jsonapi_same_format, &jsonapi_same_format)
+  x.report(:primalize, &primalize)
   x.report(:rails, &rails)
   x.report(:representable, &representable)
 

data/codecov.yml

@@ -3,3 +3,6 @@ coverage:
     project:
       default:
         informational: true
+    patch:
+      default:
+        target: 90%

data/lib/alba.rb

@@ -9,8 +9,11 @@ module Alba
   # 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
+    attr_reader :backend, :encoder, :inferring, :_on_error, :transforming_root_key
 
     # Set the backend, which actually serializes object into JSON
     #
@@ -66,6 +69,16 @@ module Alba
       @_on_error = handler || 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
+
     private
 
     def set_encoder
@@ -109,4 +122,5 @@ module Alba
 
   @encoder = default_encoder
   @_on_error = :raise
+  @transforming_root_key = false # TODO: This will be true since 2.0
 end

data/lib/alba/resource.rb

@@ -6,7 +6,7 @@ module Alba
   module Resource
     # @!parse include InstanceMethods
     # @!parse extend ClassMethods
-    DSLS = {_attributes: {}, _key: nil, _transform_keys: nil, _on_error: nil}.freeze
+    DSLS = {_attributes: {}, _key: nil, _transform_keys: nil, _transforming_root_key: false, _on_error: nil}.freeze
     private_constant :DSLS
 
     # @private
@@ -58,13 +58,12 @@ module Alba
 
       # @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
+
+        resource_name = self.class.name.demodulize.delete_suffix('Resource').underscore
+        key = collection? ? resource_name.pluralize : resource_name
+        transforming_root_key = @_transforming_root_key.nil? ? Alba.transforming_root_key : @_transforming_root_key
+        transforming_root_key ? transform_key(key) : key
       end
 
       def converter
@@ -76,7 +75,7 @@ module Alba
             else
               [key, fetch_attribute(object, attribute)]
             end
-          rescue ::Alba::Error, FrozenError
+          rescue ::Alba::Error, FrozenError, TypeError
             raise
           rescue StandardError => e
             handle_error(e, object, key, attribute)
@@ -136,11 +135,55 @@ module Alba
           return unless within
 
           attribute.to_hash(object, params: params, within: within)
+        when Hash # Typed Attribute
+          typed_attribute(object, attribute)
         else
           raise ::Alba::Error, "Unsupported type of attribute: #{attribute.class}"
         end
       end
 
+      def typed_attribute(object, hash)
+        attr_name = hash[:attr_name]
+        type = hash[:type]
+        type_converter = hash[:type_converter]
+        value, result = type_check(object, attr_name, type)
+        return value if result
+        raise TypeError if !result && !type_converter
+
+        type_converter = type_converter_for(type) if type_converter == true
+        type_converter.call(value)
+      rescue TypeError
+        raise TypeError, "Attribute #{attr_name} is expected to be #{type} but actually #{value.nil? ? 'nil' : value.class.name}."
+      end
+
+      def type_check(object, attr_name, type)
+        value = object.public_send(attr_name)
+        type_correct = case type
+                       when :String, ->(klass) { klass == String }
+                         value.is_a?(String)
+                       when :Integer, ->(klass) { klass == Integer }
+                         value.is_a?(Integer)
+                       when :Boolean
+                         [true, false].include?(attr_name)
+                       else
+                         raise Alba::UnsupportedType, "Unknown type: #{type}"
+                       end
+        [value, type_correct]
+      end
+
+      def type_converter_for(type)
+        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 check_within
         case @within
         when Hash # Traverse within tree
@@ -177,11 +220,19 @@ module Alba
       #
       # @param attrs [Array<String, Symbol>]
       # @param options [Hash] option hash including `if` that is a  condition to render these attributes
-      def attributes(*attrs, **options)
+      def attributes(*attrs, if: nil, **attrs_with_types) # rubocop:disable Naming/MethodParameterName
+        if_value = binding.local_variable_get(:if)
         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
+        attrs_with_types.each do |attr_name, type_and_converter|
+          attr_name = attr_name.to_sym
+          type, type_converter = type_and_converter
+          typed_attr = {attr_name: attr_name, type: type, type_converter: type_converter}
+          attr = if_value ? [typed_attr, if_value] : typed_attr
+          @_attributes[attr_name] = attr
+        end
       end
 
       # Set an attribute with the given block
@@ -254,8 +305,10 @@ module Alba
       # Transform keys as specified type
       #
       # @param type [String, Symbol]
-      def transform_keys(type)
+      # @param root [Boolean] decides if root key also should be transformed
+      def transform_keys(type, root: nil)
         @_transform_keys = type.to_sym
+        @_transforming_root_key = root
       end
 
       # Set error handler

data/lib/alba/version.rb

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

data/sider.yml

@@ -49,10 +49,8 @@ linter:
 #     norc: true
 
 # # https://help.sider.review/getting-started/custom-configuration#ignore
-# ignore:
-#   - "*.pdf"
-#   - "*.mp4"
-#   - "images/**"
+ignore:
+  - 'test/**/*'
 
 # # https://help.sider.review/getting-started/custom-configuration#branchesexclude
 # branches:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-05-09 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,6 +19,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/dependabot.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -29,6 +32,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - alba.gemspec
 - benchmark/local.rb
 - bin/console