alba 3.5.0 → 3.7.0

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.

data/alba.gemspec

@@ -1,33 +0,0 @@
-require_relative 'lib/alba/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'alba'
-  spec.version       = Alba::VERSION
-  spec.authors       = ['OKURA Masafumi']
-  spec.email         = ['masafumi.o1988@gmail.com']
-
-  spec.summary       = 'Alba is the fastest JSON serializer for Ruby.'
-  spec.description   = "Alba is the fastest JSON serializer for Ruby. It focuses on performance, flexibility and usability."
-  spec.homepage      = 'https://github.com/okuramasafumi/alba'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
-
-  spec.metadata = {
-    'bug_tracker_uri' => 'https://github.com/okuramasafumi/alba/issues',
-    'changelog_uri' => 'https://github.com/okuramasafumi/alba/blob/main/CHANGELOG.md',
-    'documentation_uri' => 'https://rubydoc.info/github/okuramasafumi/alba',
-    'source_code_uri' => 'https://github.com/okuramasafumi/alba',
-    'rubygems_mfa_required' => 'true'
-  }
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_dependency "ostruct", "~> 0.6"
-end

data/benchmark/Gemfile

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-gem 'active_model_serializers'
-gem 'activerecord', '~> 7.1'
-gem 'alba', path: '../'
-gem 'benchmark-ips'
-gem 'benchmark-memory'
-gem 'blueprinter'
-gem 'csv'
-gem 'fast_serializer_ruby'
-gem 'jbuilder'
-gem 'jserializer'
-gem 'json'
-gem 'multi_json'
-gem 'oj'
-gem 'oj_serializers'
-gem 'panko_serializer'
-gem 'pg'
-gem 'primalize'
-gem 'representable'
-gem 'simple_ams'
-gem 'sqlite3', '~> 1.4'
-gem 'turbostreamer'

data/benchmark/README.md

@@ -1,137 +0,0 @@
-## Benchmark for json serializers
-
-This directory contains a few different benchmark scripts.
-
-## How to run
-
-```
-bundle install
-
-# with `Oj.optimize_rails`
-bundle exec ruby collection.rb
-
-# without `Oj.optimize_rails`
-NO_OJ_OPTIMIZE_RAILS=1 bundle exec ruby collection.rb
-
-# with `Oj.optimize_rails` and YJIT
-YJIT=1 bundle exec ruby collection.rb
-
-# with YJIT and without `Oj.optimize_rails`
-YJIT=1 NO_OJ_OPTIMIZE_RAILS=1 bundle exec ruby collection.rb
-```
-
-## Result
-
-As a reference, here's the benchmark result run in my (@okuramasafumi) machine.
-
-Machine spec:
-
-|Key|Value|
-|---|---|
-|OS|macOS 14.7|
-|CPU|Apple M1 Pro|
-|RAM|16GB|
-|Ruby|ruby 3.3.5 (2024-09-03 revision ef084cc8f4) [arm64-darwin23]|
-
-Library versions:
-
-|Library|Version|
-|---|---|
-|alba|3.2.0|
-|blueprinter|1.1.0|
-|fast_serializer_ruby|0.6.9|
-|jserializer|0.2.1|
-|oj|3.16.6|
-|simple_ams|0.2.6|
-|representable|3.2.0|
-|turbostreamer|1.11.0|
-|jbuilder|2.13.0|
-|panko_serializer|0.8.2|
-|active_model_serializers|0.10.14|
-
-`benchmark-ips` with `Oj.optimize_rails`:
-
-```
-Comparison:
-               panko:      447.0 i/s
-         jserializer:      168.9 i/s - 2.65x  slower
-         alba_inline:      149.4 i/s - 2.99x  slower
-                alba:      146.5 i/s - 3.05x  slower
-       turbostreamer:      138.7 i/s - 3.22x  slower
-               rails:      105.6 i/s - 4.23x  slower
-     fast_serializer:       97.6 i/s - 4.58x  slower
-         blueprinter:       66.7 i/s - 6.70x  slower
-       representable:       50.6 i/s - 8.83x  slower
-          simple_ams:       35.5 i/s - 12.57x  slower
-                 ams:       14.8 i/s - 30.25x  slower
-```
-
-`benchmark-ips` without `Oj.optimize_rails`:
-
-```
-Comparison:
-               panko:      457.9 i/s
-         jserializer:      165.9 i/s - 2.76x  slower
-                alba:      160.1 i/s - 2.86x  slower
-         alba_inline:      158.5 i/s - 2.89x  slower
-       turbostreamer:      141.7 i/s - 3.23x  slower
-     fast_serializer:       96.2 i/s - 4.76x  slower
-               rails:       87.2 i/s - 5.25x  slower
-         blueprinter:       67.4 i/s - 6.80x  slower
-       representable:       43.4 i/s - 10.55x  slower
-          simple_ams:       34.7 i/s - 13.20x  slower
-                 ams:       14.2 i/s - 32.28x  slower
-```
-
-`benchmark-ips` with `Oj.optimize_rails` and YJIT:
-
-```
-Comparison:
-               panko:      676.6 i/s
-         jserializer:      285.3 i/s - 2.37x  slower
-       turbostreamer:      264.2 i/s - 2.56x  slower
-                alba:      258.9 i/s - 2.61x  slower
-     fast_serializer:      179.0 i/s - 3.78x  slower
-               rails:      150.7 i/s - 4.49x  slower
-         alba_inline:      131.5 i/s - 5.15x  slower
-         blueprinter:      110.0 i/s - 6.15x  slower
-       representable:       73.5 i/s - 9.21x  slower
-          simple_ams:       62.8 i/s - 10.77x  slower
-                 ams:       20.4 i/s - 33.10x  slower
-```
-
-`benchmark-ips` with YJIT and without `Oj.optimize_rails`:
-
-```
-Comparison:
-               panko:      701.9 i/s
-                alba:      311.1 i/s - 2.26x  slower
-         jserializer:      281.6 i/s - 2.49x  slower
-       turbostreamer:      240.4 i/s - 2.92x  slower
-     fast_serializer:      180.5 i/s - 3.89x  slower
-         alba_inline:      135.6 i/s - 5.18x  slower
-               rails:      131.4 i/s - 5.34x  slower
-         blueprinter:      110.7 i/s - 6.34x  slower
-       representable:       70.5 i/s - 9.96x  slower
-          simple_ams:       57.3 i/s - 12.24x  slower
-                 ams:       20.3 i/s - 34.51x  slower
-```
-
-`benchmark-memory`:
-
-```
-Comparison:
-               panko:     259178 allocated
-       turbostreamer:     817800 allocated - 3.16x more
-         jserializer:     826425 allocated - 3.19x more
-                alba:     846465 allocated - 3.27x more
-         alba_inline:     867361 allocated - 3.35x more
-     fast_serializer:    1474345 allocated - 5.69x more
-               rails:    2265905 allocated - 8.74x more
-         blueprinter:    2469905 allocated - 9.53x more
-       representable:    4994281 allocated - 19.27x more
-                 ams:    5233265 allocated - 20.19x more
-          simple_ams:    9506817 allocated - 36.68x more
-```
-
-Conclusion: panko is extremely fast but it's a C extension gem. As pure Ruby gems, Alba, `turbostreamer` and `jserializer` are notably faster than others, but Alba is slightly slower than other two. With `Oj.optimize_rails`, `jbuilder` and Rails standard serialization are also fast.