alba 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34c441cbc87f959f73c3e7a0175309f780b23ce840add4d53cf5083488390f1f
-  data.tar.gz: f78fb2eea40f502c6f7b3c905317616054bd397d30aa9ce979285003205c81af
+  metadata.gz: e445a59555f43f7c601699a3a2ceee967d33a37ea77f2b15a0e806dec0dfc5b8
+  data.tar.gz: 3506f93a8fd9c00c5d8d85566f41032f3bc23356c753d202ce48e9ba984f1acc
 SHA512:
-  metadata.gz: 326ac8e731f2b4e0fe4afbb8f690059ecd578ffcb9270b9779bdcb6bb50d57d063ec0a98fc488398915c39ca2978b41e79d53bb1f5a809f9272ad885c383a549
-  data.tar.gz: 2b36eb5d07749505b4ab377b56cc7e564bcd6e86d872e7cb2c45f62ae2cf91a41b2c6e0b70cdcbb8d2a5d802528e4d9bfb113b723a2be7b1bdbc207c0277df45
+  metadata.gz: 46251245a639ad19d4c75d9b3afee2f9afdd19380ae70c1a1113ccc96966402bfff6434ac2fef9cdef4785873438d6ba828ee64712a8757dc497798fd890337a
+  data.tar.gz: ce096713947ae541071331d67212dc1fb35957dd7849b8d87b98ce6a8eda05b867406ec4ffad2d64eb76fcfe2a5d8be16486f2f4cd2c88e82c259b0e58b37887

data/.codeclimate.yml

@@ -0,0 +1,11 @@
+version: "2"         # required to adjust maintainability checks
+
+checks:
+  method-complexity:
+    enabled: true
+    config:
+      threshold: 7
+
+exclude_patterns:
+  - "benchmark/**/*"
+  - "script/**/*"

data/.github/dependabot.yml

@@ -1,26 +1,12 @@
 version: 2
 updates:
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
 - 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/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '21 4 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.github/workflows/main.yml

@@ -8,7 +8,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        ruby: [2.5, 2.6, 2.7, 3.0, head, jruby, truffleruby]
+        ruby: [2.6, 2.7, 3.0, 3.1, head, jruby, truffleruby]
         gemfile: [all, without_active_support, without_oj]
         exclude:
           - os: windows-latest
@@ -17,9 +17,9 @@ jobs:
             ruby: truffleruby
     runs-on: ${{ matrix.os }}
     env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
-      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+      BUNDLE_GEMFILE: ${{ (matrix.gemfile == 'without_active_support' && 'gemfiles/without_active_support.gemfile') || (matrix.gemfile == 'without_oj' && 'gemfiles/without_oj.gemfile') || null }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -29,6 +29,6 @@ jobs:
       run: |
         bundle exec rake
     - name: CodeCov
-      uses: codecov/codecov-action@v1
+      uses: codecov/codecov-action@v3
       with:
         files: ./coverage/coverage.xml

data/.github/workflows/perf.yml

@@ -7,10 +7,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.5, 2.6, 2.7, 3.0]
+        ruby: [2.7, 3.0, 3.1]
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.rubocop.yml

@@ -16,7 +16,7 @@ AllCops:
     - 'script/**/*.rb'
   NewCops: enable
   EnabledByDefault: true
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
 
 # Items in Gemfile is dev dependencies and we don't have to specify versions.
 Bundler/GemVersion:
@@ -46,12 +46,15 @@ Metrics:
     - 'test/**/*.rb'
 
 # `Resource` module is a core module and its length tends to be long...
+# `Alba` main module is also long because it has all parts of configuration
 Metrics/ModuleLength:
   Exclude:
     - 'lib/alba/resource.rb'
+    - 'lib/alba.rb'
 
 # Resource class includes DSLs, which tend to accept long list of parameters
 Metrics/ParameterLists:
+  Max: 7
   Exclude:
     - 'test/**/*.rb'
 
@@ -63,6 +66,7 @@ Security/Eval:
 Style/ConstantVisibility:
   Exclude:
     - 'lib/alba/version.rb'
+    - 'test/**/*.rb'
 
 Style/Copyright:
   Enabled: false

data/CHANGELOG.md

@@ -6,6 +6,40 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0] 2022-10-21
+
+### Breaking changes
+
+- All Hash-related methods now return String key instead of Symbol key  
+    This affects all users, but you can use `deep_symbolize_keys` in Rails environment if you prefer Symbol keys
+    Some DSLs that take key argument such as `on_nil` and `on_error`, are also affected
+
+### New features
+
+- Passing an initial object to proc function in associations
+- Allow association resource to be Proc
+- `collection_key` to serialize collection into a Hash
+- params is now overridable
+- Key transformation now cascades
+- nested attribute
+- Implement `as_json`
+
+### Bugfix
+
+- fix the bug where nesting is empty string and invalid
+- `handle_error` now raises the same error
+- let Rails implicitly call `to_json`
+
+## [1.6.0] 2022-03-16
+
+- [Feat] Support instance method as an attribute
+- [Fix] Explicitly raise error when inference is disabled
+- [Improve] `enable_inference!` now takes inflector as argument
+- [Improve] `transform_keys` now accepts `:snake` and `:none`
+- [Deprecate] `to_hash` is special method and should not be used
+- [Deprecate] `ignoring` in favor of `attributes` overriding
+- [Deprecate] `Alba.on_nil`, `Alba.on_error` and `Alba.enable_root_key_transformation!`
+
 ## [1.5.0] 2021-11-28
 
 - [Feat] Add nil handler

data/CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# CONTRIBUTORS GUIDELINE
+
+## Welcome
+
+Welcome to Alba, and thank you for being interested in contributing to Alba. This document describes how to contribute to Alba.
+
+## Code of Conduct
+
+We have the [code of conduct](https://github.com/okuramasafumi/alba/blob/master/CODE_OF_CONDUCT.md) that all contributors are expected to adhere for Alba to be a safe and welcoming space.
+
+## Bugs and Issues
+
+If you find any bugs or issues, please submit an issue on [GitHub](https://github.com/okuramasafumi/alba/issues). Please follow the issue template as much as possible so that maintainers can find and fix it quickly.
+
+## Feature Request
+
+If you have any feature that you think Alba should have, please submit a feature request on [GitHub](https://github.com/okuramasafumi/alba/issues).
+
+## Pull Request
+
+You're more than welcomed to submit a Pull Request! You are expected to follow these rules before submitting:
+
+* You must split your Pull Request into multiple ones if you solve more than one problem
+* You must write tests if you implement a feature or fix a bug
+* You should provide reason(s) behind your change unless it's so simple
+
+## Documents
+
+* [code of conduct](https://github.com/okuramasafumi/alba/blob/master/CODE_OF_CONDUCT.md) for all contributors
+* [hacking document](https://github.com/okuramasafumi/alba/blob/master/DESIGN.md) for those who want to know the internal of Alba

data/Gemfile

@@ -4,17 +4,21 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'activesupport', require: false # For backend
+gem 'dry-inflector', require: false # For inflection
 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.17.0', require: false # For lint
-gem 'rubocop-performance', '~> 1.12.0', require: false # For lint
+gem 'rubocop-minitest', '~> 0.22.0', require: false # For lint
+gem 'rubocop-performance', '~> 1.15.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 'ruby-lsp', require: false # For language server
 gem 'simplecov', '~> 0.21.0', require: false # For test coverage
 gem 'simplecov-cobertura', require: false # For test coverage
+# gem 'steep', require: false # For language server and typing
+# gem 'typeprof', require: false # For language server and typing
 gem 'yard', require: false # For documentation
 
 platforms :ruby do

data/HACKING.md

@@ -0,0 +1,41 @@
+# Hacking document
+
+This document is intended to provide detailed information about the internal design and implementation of Alba. You are recommended to read through it if you want to hack Alba.
+
+## Design
+
+The design of Alba is simple. `Alba::Resource` module is the only interface end users use by `include`ing it. Other classes and modules are referenced by `Alba::Resource`.
+
+When a class `include`s `Alba::Resource` module it defines `ClassMethods` such as `attributes` and `InstanceMethods` such as `serialize`. Instance methods work with information collected by class methods.
+
+## Methods
+
+The main methods users directly use are listed below.
+
+Class methods (DSL):
+
+* `attribute` for block style attribute
+* `attributes` for symbol style attribute
+* `association` and its aliases such as `one` for association
+
+Instance methods:
+
+* `serializable_hash` and `to_h` for hash from target object
+* `serialize` and `to_json` for serialized JSON string
+
+Other methods are rather trivial. They'll be added to this list when it turned out it's important enough.
+
+## Implementation
+
+In `Alba::Resource` module there are some things to note.
+
+`@object` is an object for serialization. It's either singular object or collection.
+
+Attribute object can be either `Symbol`, `Proc`, `Alba::Association` or `Alba::TypedAttribute`.
+
+* `Symbol` attributes come from `attributes` method and are sent to `__send__` as method name
+* `Proc` attributes come from `attribute` method and are `instance_exec`uted
+* `Alba::Association` attributes come from `association` method and `to_h` method on the object is called
+* `Alba::TypedAttribute` attributes come when users specify `type` option and `value` method on the object is called
+
+When users provide `if` option, the attribute object becomes an `Array`. It contains two element, attribute itself and condition.