alba 1.1.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36890dfa4b9b73b60f1d6a09cf674de7ff7a6dd495ff4b74bbb3d048f9cf5a85
-  data.tar.gz: 3e3d49619f646be866262e14e21e5fba11e2caafbc24064d57eb9c549cb64e4d
+  metadata.gz: 34c441cbc87f959f73c3e7a0175309f780b23ce840add4d53cf5083488390f1f
+  data.tar.gz: f78fb2eea40f502c6f7b3c905317616054bd397d30aa9ce979285003205c81af
 SHA512:
-  metadata.gz: fc7e025a035b41dadaab5300096cf920eb3557a4be900d31b514dfc66e8ae803b0fb63d77ec06174d72d70ad2e07da81c491502c8462ad306f2379720222fc65
-  data.tar.gz: 741f5c1c69b2809aec51d2a2a139d4d8e00060c9aa174bf5fb68d5dbcec7996096aced5fb377d77fa147d7b6086a65191c8c764802c65bbd88d3806751ec0eb4
+  metadata.gz: 326ac8e731f2b4e0fe4afbb8f690059ecd578ffcb9270b9779bdcb6bb50d57d063ec0a98fc488398915c39ca2978b41e79d53bb1f5a809f9272ad885c383a549
+  data.tar.gz: 2b36eb5d07749505b4ab377b56cc7e564bcd6e86d872e7cb2c45f62ae2cf91a41b2c6e0b70cdcbb8d2a5d802528e4d9bfb113b723a2be7b1bdbc207c0277df45

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/.github/workflows/perf.yml

@@ -0,0 +1,21 @@
+name: Performance Check
+
+on: [pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7, 3.0]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run benchmark
+      run: |
+        ruby script/perf_check.rb

data/.rubocop.yml

@@ -13,14 +13,24 @@ AllCops:
     - 'Rakefile'
     - 'alba.gemspec'
     - 'benchmark/**/*.rb'
+    - 'script/**/*.rb'
   NewCops: enable
   EnabledByDefault: true
   TargetRubyVersion: 2.5
 
-# Oneline comment is not valid so until it gets valid, we disable it
-Bundler/GemComment:
+# Items in Gemfile is dev dependencies and we don't have to specify versions.
+Bundler/GemVersion:
   Enabled: false
 
+# We'd like to write something like:
+#   assert_equal(
+#     expected,
+#     actual
+#   )
+Layout/RedundantLineBreak:
+  Exclude:
+    - 'test/**/*'
+
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
@@ -35,17 +45,14 @@ Metrics:
   Exclude:
     - 'test/**/*.rb'
 
-Metrics/MethodLength:
-  Max: 15
-
 # `Resource` module is a core module and its length tends to be long...
 Metrics/ModuleLength:
-  Max: 150
+  Exclude:
+    - 'lib/alba/resource.rb'
 
 # Resource class includes DSLs, which tend to accept long list of parameters
 Metrics/ParameterLists:
   Exclude:
-    - 'lib/alba/resource.rb'
     - 'test/**/*.rb'
 
 # We need to eval resource code to test errors on resource classes
@@ -71,7 +78,10 @@ Style/InlineComment:
   Enabled: false
 
 Style/MethodCallWithArgsParentheses:
-  Enabled: false
+  IgnoredMethods: ['require', 'require_relative', 'include', 'extend', 'puts', 'p', 'warn', 'raise', 'send', 'public_send']
+  Exclude:
+    # There are so many `attributes` call without parenthese and that's absolutely fine
+    - 'test/**/*.rb'
 
 # There are so many cases we just want `if` expression!
 Style/MissingElse:

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,46 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.5.0] 2021-11-28
+
+- [Feat] Add nil handler
+- [Feat] Implement layout feature
+- [Improve] if option now works with Symbol
+- [Improve] Add an alias for serialize
+- [Improve] Deprecation warning now printed with caller
+
+## [1.4.0] 2021-06-30
+
+- [Feat] Add a config method to set encoder directly
+- [Feat] Implement `meta` method and option for metadata
+- [Feat] Add `root_key` option to `Resource#serialize`
+- [Feat] Enable setting key for collection with `root_key`
+- [Feat] Add `Resource.root_key` and `Resource.root_key!`
+- [Feat] `Alba.serialize` now infers resource class
+- [Deprecated] `Resource.key` and `Resource.key!` are deprecated
+
+## [1.3.0] 2021-05-31
+
+- [Perf] Improve performance for `many` [641d8f9]
+  - https://github.com/okuramasafumi/alba/pull/125
+- [Feat] Add custom inflector feature (#126) [ad73291]
+  - https://github.com/okuramasafumi/alba/pull/126
+  - Thank you @wuarmin !
+- [Feat] Support params in if condition [6e9915e]
+  - https://github.com/okuramasafumi/alba/pull/128
+- [Fix] fundamentally broken "circular association control" [fbbc9a1]
+  - https://github.com/okuramasafumi/alba/pull/130
+
+## [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

@@ -5,16 +5,17 @@ gemspec
 
 gem 'activesupport', require: false # For backend
 gem 'ffaker', require: false # For testing
+gem 'inch', require: false # For inline documents
 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.11.0', require: false # For lint
+gem 'rubocop-minitest', '~> 0.17.0', require: false # For lint
+gem 'rubocop-performance', '~> 1.12.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
 gem 'simplecov', '~> 0.21.0', require: false # For test coverage
 gem 'simplecov-cobertura', require: false # For test coverage
-gem 'yard', require: false
+gem 'yard', require: false # For documentation
 
 platforms :ruby do
   gem 'oj', '~> 3.11', require: false # For backend