alba 3.5.0 → 3.6.0

data/.editorconfig

@@ -1,10 +0,0 @@
-[*]
-end_of_line              = lf
-insert_final_newline     = true
-charset                  = utf-8
-trim_trailing_whitespace = true
-indent_style = space
-indent_size  = 2
-
-[*.{md,markdown}]
-trim_trailing_whitespace = false

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,26 +0,0 @@
----
-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

@@ -1,20 +0,0 @@
----
-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

@@ -1,12 +0,0 @@
-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

data/.github/workflows/codeql-analysis.yml

@@ -1,70 +0,0 @@
-# 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@v4
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
-      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@v3
-
-    # ℹ️ 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@v3

data/.github/workflows/lint.yml

@@ -1,17 +0,0 @@
-name: Lint
-
-on: [push,pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.0 # The lowest version Alba supports
-        bundler-cache: true
-    - name: Run RuboCop
-      run: |
-        bundle exec rubocop

data/.github/workflows/main.yml

@@ -1,41 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-
-jobs:
-  build:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        ruby: ['3.0', 3.1, 3.2, 3.3, 3.4, head, jruby, truffleruby]
-        gemfile: [all, without_active_support, without_oj]
-        exclude:
-          - os: windows-latest
-            ruby: 3.4
-          - os: windows-latest
-            ruby: jruby
-          - os: windows-latest
-            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: ${{ (matrix.gemfile == 'without_active_support' && 'gemfiles/without_active_support.gemfile') || (matrix.gemfile == 'without_oj' && 'gemfiles/without_oj.gemfile') || null }}
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    - name: Run the default task
-      run: |
-        bundle exec rake
-    - name: CodeCov
-      uses: codecov/codecov-action@v5
-      with:
-        files: ./coverage/coverage.xml
-        token: ${{ secrets.CODECOV_TOKEN }}

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-Gemfile.lock
-/gemfiles/*.lock

data/.rubocop.yml

@@ -1,156 +0,0 @@
----
-
-inherit_gem:
-  rubocop-gem_dev: 'config/rubocop.yml'
-
-inherit_mode:
-  merge:
-    - Exclude
-
-require:
-  - rubocop-md
-  - rubocop-minitest
-  - rubocop-performance
-  - rubocop-rake
-
-AllCops:
-  Exclude:
-    - 'alba.gemspec'
-    - 'benchmark/**/*.rb'
-    - 'docs/**/*'
-    - 'script/**/*.rb'
-  NewCops: enable
-  EnabledByDefault: true
-  TargetRubyVersion: 3.0
-
-Bundler/GemComment:
-  Exclude:
-    - 'benchmark/**/*'
-
-# Items in Gemfile is dev dependencies and we don't have to specify versions.
-Bundler/GemVersion:
-  Enabled: false
-
-# Test class is a class, but not really
-Layout/ClassStructure:
-  Exclude:
-    - 'test/**/*'
-
-# LineLength 80 comes from restrictions in good old days.
-Layout/LineLength:
-  Max: 160
-
-# We'd like to write something like:
-#   assert_equal(
-#     expected,
-#     actual
-#   )
-Layout/RedundantLineBreak:
-  Exclude:
-    - 'test/**/*'
-
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-
-Layout/MultilineAssignmentLayout:
-  EnforcedStyle: same_line
-
-Lint/ConstantResolution:
-  Enabled: false
-
-# In test code we don't care about the metrics!
-Metrics:
-  Exclude:
-    - '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/ClassLength:
-  Exclude:
-    - 'lib/alba/resource.rb'
-    - 'lib/alba.rb'
-    - 'test/**/*.rb' # Neec to specify this
-
-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'
-
-# Putting extra empty line is not valuable in test
-# We prefer shorter test code
-Minitest/EmptyLineBeforeAssertionMethods:
-  Enabled: false
-
-# By nature of that test
-Minitest/NoTestCases:
-  Exclude:
-    - 'test/dependencies/test_dependencies.rb'
-
-# We need to use `OpenStruct` to wrap object in ConfitionalAttribute
-Performance/OpenStruct:
-  Exclude:
-    - 'lib/alba/conditional_attribute.rb'
-
-# We need to eval resource code to test errors on resource classes
-Security/Eval:
-  Exclude:
-    - 'test/**/*.rb'
-
-Style/ConstantVisibility:
-  Exclude:
-    - 'lib/alba/version.rb'
-    - 'test/**/*.rb'
-
-# Copyright is in README
-Style/Copyright:
-  Enabled: false
-
-# I know what I do :)
-Style/DisableCopsWithinSourceCodeDirective:
-  Enabled: false
-
-# Test files doesn't need to have documentation
-Style/Documentation:
-  Exclude:
-    - 'test/**/*'
-
-# In README it's so obvious
-Style/DocumentationMethod:
-  Exclude:
-    - 'README.md'
-
-# I don't want to think about error class in example code
-Style/ImplicitRuntimeError:
-  Exclude:
-    - 'README.md'
-
-# We use it, don't we?
-Style/InlineComment:
-  Enabled: false
-
-Style/MethodCallWithArgsParentheses:
-  AllowedMethods: ['require', 'require_relative', 'include', 'extend', 'puts', 'p', 'warn', 'raise', 'send', 'public_send', 'alias_method']
-  Exclude:
-    # There are so many calls like `attributes` and `register_type` without parenthese and that's absolutely fine
-    - 'test/**/*.rb'
-    - 'README.md'
-
-# There are so many cases we just want `if` expression!
-Style/MissingElse:
-  EnforcedStyle: case
-
-# We need to use `OpenStruct` to wrap object in ConfitionalAttribute
-Style/OpenStructUse:
-  Exclude:
-    - 'lib/alba/conditional_attribute.rb'
-
-# It's example code, please forgive us
-Style/OptionalBooleanParameter:
-  Exclude:
-    - 'README.md'

data/.yardopts

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

data/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at masafumi.o1988@gmail.com .
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

data/CONTRIBUTING.md

@@ -1,30 +0,0 @@
-# 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/main/HACKING.md) for those who want to know the internal of Alba

data/Gemfile

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in alba.gemspec
-gemspec
-
-gem 'activesupport', require: false # For backend
-gem 'dry-inflector', require: false # For inflection
-gem 'ffaker', require: false # For testing
-gem 'minitest', '~> 5.14' # For test
-gem 'railties', require: false # For Rails integration testing
-gem 'rake', '~> 13.0' # For test and automation
-gem 'rubocop', '~> 1.69.0', require: false # For lint
-gem 'rubocop-gem_dev', '>= 0.3.0', require: false # For lint
-gem 'rubocop-md', '~> 1.0', require: false # For lint
-gem 'rubocop-minitest', '~> 0.36.0', require: false # For lint
-gem 'rubocop-performance', '~> 1.23.0', require: false # For lint
-gem 'rubocop-rake', '~> 0.6.0', require: false # For lint
-gem 'simplecov', '~> 0.22.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
-
-# FIXME: There is an upstream JRuby 9.4.9.0 issue with `psych` and the latest
-# version of `jar-dependencies`. The issue will be resolved with the release of
-# 9.4.10.0. Then, we can remove this `jar-dependencies` dependency lock.
-#
-# For more information, see: https://github.com/jruby/jruby/issues/8488
-#
-if defined?(JRUBY_VERSION) && Gem::Version.new(JRUBY_VERSION) < Gem::Version.new('9.4.10.0')
-  gem 'jar-dependencies', '< 0.5' # Fix
-end
-
-platforms :ruby do
-  gem 'oj', '~> 3.11', require: false # For backend
-  gem 'ruby-prof', require: false # For performance profiling
-end

data/HACKING.md

@@ -1,42 +0,0 @@
-# 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
-* `nested` for nested attribute
-
-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 a singular object or a 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.

data/Rakefile

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-if ENV['BUNDLE_GEMFILE'] == File.expand_path('Gemfile') || ENV['BUNDLE_GEMFILE'].empty? || ENV['BUNDLE_GEMFILE'].nil?
-  ENV['BUNDLE_GEMFILE'] = File.expand_path('Gemfile')
-end
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  file_list = ENV['BUNDLE_GEMFILE'] == File.expand_path('Gemfile') ? FileList['test/**/*_test.rb'] : FileList['test/dependencies/test_dependencies.rb']
-  t.test_files = file_list
-end
-
-task default: :test

data/SECURITY.md

@@ -1,12 +0,0 @@
-# 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.