u-struct 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bae44de8a2fcfcebd5838c5aa282a16ca45e96f373cfb914f84849d1f05b46d
-  data.tar.gz: 7c4aa02beaaebf9a455d707d5e7cc654e7b3d3932b4555588aad0db3eff04806
+  metadata.gz: 8253f1eefa995a1bb88ffd06463a7868bd9891191d287e4146afc2017c0152a0
+  data.tar.gz: bcda03d7c0d4d6e3fb8a523be53ee297afac42e9d2c76cff6ecda4cf5857bbe4
 SHA512:
-  metadata.gz: d08cb82f8392d7f960cb570ca2ddea82e931dd97c2ab9b6125a56aaca5a231d100d1e5f15bafa482214d0d63cd5c7d4f14d01bbbed3d5d07a2b60dc7f46024e9
-  data.tar.gz: 5bdc2d780807cbf09be36ed2d79453396a756642d3b088af74a79dc1d755328fa78786ed94167a1f7e8292b417614d17c606693f46ee4d8244c69ff7675d5900
+  metadata.gz: 72c2639605ff42489c6914e8f3b6d7add9931327e3a7f78acad7f865e3c29dd711e5fc23201e724e0d1d85c014a438e846e9681547fb505acb8756986eb176e6
+  data.tar.gz: f98014a72acc88d90ca4e48f53a977b3bc9762faa4435a34fa30a6422a6f78d6365d795a3a182c96ca915fab537a681e5555f852acc1efaa5eee4c6eba1d59c8

data/.github/workflows/ci.yml

@@ -1,27 +1,72 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
 
-name: build
-on: [push]
 jobs:
   test:
     runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    permissions:
+      contents: read
     strategy:
+      fail-fast: false
       matrix:
-        ruby: [2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1.0-preview1]
+        ruby: ["2.7", "3.0", "3.1", "3.2", "3.3", "3.4", "4.0", head]
     steps:
-      - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@v1
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - name: Test and generate coverage
-        run: bin/test
-      - name: Format coverage
-        if: ${{ matrix.ruby >= 3 && matrix.ruby < 3.1 }}
-        run: bin/prepare_coverage
-      - uses: paambaati/codeclimate-action@v2.7.5
-        if: ${{ matrix.ruby >= 3 && matrix.ruby < 3.1 }}
-        env:
-          CC_TEST_REPORTER_ID: 8ce350edeb0772e94ffd678bbaca30d9c1293b9d9051a1689c79b91c21f5afd5
+      - name: Install bundler
+        run: gem install bundler -v 2.4.22
+        if: ${{ matrix.ruby == '2.7' || matrix.ruby == '3.0' }}
+      - name: Bundle install
+        run: bundle install
+      - name: Setup project
+        run: bundle exec appraisal install
+      - name: Run RuboCop
+        run: bundle exec rubocop
+        if: ${{ matrix.ruby == '3.1' }}
+      - name: Run Sorbet typecheck
+        run: bundle exec srb tc
+        if: ${{ matrix.ruby == '3.1' }}
+      - name: Run baseline tests (no activemodel)
+        run: bundle exec rake test
+      - name: Run tests for Rails 6.0
+        run: bundle exec appraisal rails-6-0 rake test
+        if: ${{ matrix.ruby == '2.7' || matrix.ruby == '3.0' }}
+      - name: Run tests for Rails 6.1
+        run: bundle exec appraisal rails-6-1 rake test
+        if: ${{ matrix.ruby == '2.7' || matrix.ruby == '3.0' }}
+      - name: Run tests for Rails 7.0
+        run: bundle exec appraisal rails-7-0 rake test
+        if: ${{ matrix.ruby == '2.7' || matrix.ruby == '3.0' || matrix.ruby == '3.1' || matrix.ruby == '3.2' || matrix.ruby == '3.3' }}
+      - name: Run tests for Rails 7.1
+        run: bundle exec appraisal rails-7-1 rake test
+        if: ${{ matrix.ruby == '2.7' || matrix.ruby == '3.0' || matrix.ruby == '3.1' || matrix.ruby == '3.2' || matrix.ruby == '3.3' }}
+      - name: Run tests for Rails 7.2
+        run: bundle exec appraisal rails-7-2 rake test
+        if: ${{ matrix.ruby == '3.1' || matrix.ruby == '3.2' || matrix.ruby == '3.3' || matrix.ruby == '3.4' }}
+      - name: Run tests for Rails 8.0
+        run: bundle exec appraisal rails-8-0 rake test
+        if: ${{ matrix.ruby == '3.2' || matrix.ruby == '3.3' || matrix.ruby == '3.4' }}
+      - name: Run tests for Rails 8.1
+        run: bundle exec appraisal rails-8-1 rake test
+        if: ${{ matrix.ruby == '3.3' || matrix.ruby == '3.4' || matrix.ruby == '4.0' }}
+      - name: Run tests for Rails edge
+        run: bundle exec appraisal rails-edge rake test
+        if: ${{ matrix.ruby == '4.0' || matrix.ruby == 'head' }}
+      - name: Upload coverage to Qlty
+        uses: qltysh/qlty-action/coverage@v2
+        if: ${{ matrix.ruby == '3.4' && !github.base_ref }}
         with:
-          debug: true
-          coverageLocations: coverage/.resultset.json:simplecov
+          token: ${{ secrets.QLTY_COVERAGE_TOKEN }}
+          files: coverage/.resultset.json

data/.gitignore

@@ -8,3 +8,6 @@
 /tmp/
 
 Gemfile.lock
+
+gemfiles/*.lock
+gemfiles/.bundle/

data/.rubocop.yml

@@ -0,0 +1,137 @@
+inherit_from: .rubocop_todo.yml
+
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+require:
+  - rubocop-rake
+  - rubocop-minitest
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+  # Appraisal config + the gemfiles it generates; these mirror the canonical
+  # kind layout (double-quoted) and aren't linted as project source.
+  Exclude:
+    - 'Appraisals'
+    - 'gemfiles/**/*'
+  inherit_mode:
+    merge:
+      - Exclude
+
+# == Gemspec ==
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+# == Style ==
+
+Style/Alias:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/CombinableLoops:
+  Exclude:
+    - test/**/*.rb
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatStringToken:
+  EnforcedStyle: annotated
+
+Style/Lambda:
+  Enabled: false
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# == Layout ==
+
+Layout/ArrayAlignment:
+  Enabled: false
+
+Layout/ExtraSpacing:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBrackets: no_space
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# == Lint ==
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+Lint/NestedMethodDefinition:
+  Exclude:
+    - test/micro/struct/instance_method_test.rb
+
+# == Naming ==
+
+Naming/ClassAndModuleCamelCase:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/u-struct.rb
+
+Naming/MethodParameterName:
+  Exclude:
+    - examples/**/*.rb
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: exception
+
+# == Metrics ==
+
+Metrics/AbcSize:
+  Exclude:
+    - test/**/*.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - test/**/*.rb
+
+Metrics/ClassLength:
+  Exclude:
+    - test/**/*.rb
+
+# == Minitest ==
+
+Minitest/AssertWithExpectedArgument:
+  Enabled: false
+
+Minitest/MultipleAssertions:
+  Max: 21

data/.rubocop_todo.yml

@@ -0,0 +1,10 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-01-27 11:53:52 UTC using RuboCop version 1.25.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+Gemspec/RequireMFA:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.11

data/Appraisals

@@ -0,0 +1,84 @@
+if RUBY_VERSION < "3.1"
+  appraise "rails-6-0" do
+    group :test do
+      gem "logger", "~> 1.6", ">= 1.6.6"
+      gem "stringio", "~> 3.2"
+
+      gem "minitest", "5.26.1"
+      gem "activemodel", "~> 6.0.0"
+    end
+  end
+
+  appraise "rails-6-1" do
+    group :test do
+      gem "logger", "~> 1.6", ">= 1.6.6"
+      gem "stringio", "~> 3.2"
+
+      gem "minitest", "5.26.1"
+      gem "activemodel", "~> 6.1.0"
+    end
+  end
+end
+
+if RUBY_VERSION >= "2.7" && RUBY_VERSION < "3.4"
+  appraise "rails-7-0" do
+    group :test do
+      gem "logger", "~> 1.6", ">= 1.6.6"
+      gem "stringio", "~> 3.2"
+      gem "securerandom", "~> 0.3.2"
+
+      gem "minitest", "5.26.1"
+      gem "activemodel", "~> 7.0.0"
+    end
+  end
+
+  appraise "rails-7-1" do
+    group :test do
+      gem "logger", "~> 1.6", ">= 1.6.6"
+      gem "stringio", "~> 3.2"
+      gem "securerandom", "~> 0.3.2"
+
+      gem "minitest", "5.26.1"
+      gem "activemodel", "~> 7.1.0"
+    end
+  end
+end
+
+if RUBY_VERSION >= "3.1" && RUBY_VERSION < "4.0"
+  appraise "rails-7-2" do
+    group :test do
+      gem "minitest", "~> 5.27"
+      gem "activemodel", "~> 7.2.0"
+    end
+  end
+end
+
+if RUBY_VERSION >= "3.2" && RUBY_VERSION < "4.0"
+  appraise "rails-8-0" do
+    group :test do
+      gem "ostruct", "~> 0.6.3"
+      gem "minitest", "~> 5.27"
+      gem "activemodel", "~> 8.0.0"
+    end
+  end
+end
+
+if RUBY_VERSION >= "3.3.0"
+  minitest_version = (RUBY_VERSION >= "4.0.0") ? "~> 6.0" : "~> 5.27"
+
+  appraise "rails-8-1" do
+    group :test do
+      gem "ostruct", "~> 0.6.3"
+      gem "minitest", minitest_version
+      gem "activemodel", "~> 8.1.0"
+    end
+  end
+
+  appraise "rails-edge" do
+    group :test do
+      gem "ostruct", "~> 0.6.3"
+      gem "minitest", minitest_version
+      gem "activemodel", github: "rails/rails", branch: "main"
+    end
+  end
+end

data/CHANGELOG.md

@@ -2,48 +2,83 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-- [[Unreleased]](#unreleased)
-- [[0.12.0] - 2021-12-22](#0120---2021-12-22)
-  - [Added](#added)
-- [[0.11.0] - 2021-12-19](#0110---2021-12-19)
-  - [Added](#added-1)
-- [[0.10.0] - 2021-12-15](#0100---2021-12-15)
-  - [Changed](#changed)
-- [[0.9.0] - 2021-12-14](#090---2021-12-14)
-  - [Added](#added-2)
-  - [Changed](#changed-1)
-- [[0.8.0] - 2021-12-05](#080---2021-12-05)
-  - [Added](#added-3)
-- [[0.7.0] - 2021-12-04](#070---2021-12-04)
-  - [Added](#added-4)
-  - [Changed](#changed-2)
-- [[0.6.0] - 2021-12-03](#060---2021-12-03)
-  - [Added](#added-5)
-- [[0.5.0] - 2021-12-02](#050---2021-12-02)
-  - [Added](#added-6)
-- [[0.4.0] - 2021-12-02](#040---2021-12-02)
-  - [Added](#added-7)
-- [[0.3.1] - 2021-12-02](#031---2021-12-02)
-  - [Fixed](#fixed)
-- [[0.3.0] - 2021-12-02](#030---2021-12-02)
-  - [Added](#added-8)
-- [[0.2.0] - 2021-12-02](#020---2021-12-02)
-  - [Added](#added-9)
-- [[0.1.0] - 2021-12-02](#010---2021-12-02)
-  - [Added](#added-10)
-
 ## [Unreleased]
 
-[⬆️  Back to Top](#changelog-)
+## [2.0.0] - 2026-06-01
+
+### Changed
+
+- Bump the minimum supported Ruby to `>= 2.7.0` (was `>= 2.2.0`).
+- Modernize the CI: test against Ruby 2.7 → 4.0 + head and, via Appraisal,
+  against ActiveModel 6.0 → 8.1 + edge (Rails `>= 6.0`).
+
+## [1.1.0] - 2022-03-23
+
+### Added
+
+- Add `Micro::Struct[]` as an alias of `Micro::Struct.with`.
+
+  ```ruby
+  Micro::Struct[:readonly] # is the same as Micro::Struct.with(:readonly)
+  ```
+
+- Add `Micro::Struct.immutable` method as a shortcut to `Micro::Struct.with(:readonly, :instance_copy)`.
+  It also accepts the `with:` option, which can be used to define additional features.
+
+  ```ruby
+  Micro::Struct.immutable.new(:name)
+
+  Micro::Struct.immutable.new(:name) do
+    def hi(other_name)
+      "Hi, #{other_name}! My name is #{name}"
+    end
+  end
+
+  Micro::Struct.immutable(with: :to_hash).new(:name)
+
+  Micro::Struct.immutable(with: [:to_hash, :to_proc]).new(:name)
 
-## [1.0.0] - 2021-01-19
+  Micro::Struct.immutable.instance(name: 'Rodrigo')
+
+  Micro::Struct.immutable(with: [:to_hash]).instance(name: 'Serradura')
+  ```
+
+- Add `Micro::Struct.readonly` method as a shortcut to `Micro::Struct.with(:readonly)`.
+  It has the same properties of `Micro::Struct.immutable`.
+
+  ```ruby
+  Micro::Struct.readonly.new(:name)
+
+  Micro::Struct.readonly.new(:name) do
+    def hi(other_name)
+      "Hi, #{other_name}! My name is #{name}"
+    end
+  end
+
+  Micro::Struct.readonly(with: :to_hash).new(:name)
+
+  Micro::Struct.readonly(with: [:to_hash, :to_proc]).new(:name)
+
+  Micro::Struct.readonly.instance(name: 'Rodrigo')
+
+  Micro::Struct.readonly(with: [:to_hash]).instance(name: 'Serradura')
+  ```
+
+  **Development stuff**
+
+- Set up Rubocop.
+- Add `.rbi` files, and set up sorbet to be used in development.
+
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
+
+## [1.0.0] - 2022-01-20
 
 - Review and update docs and examples. ;)
 
-[⬆️ &nbsp;Back to Top](#changelog-)
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
 
 ## [0.12.0] - 2021-12-22
 
@@ -70,6 +105,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   person2.first_name = 'John'
   # NoMethodError (private method `first_name=' called for #<struct first_name="Rodrigo", last_name="Serradura">)
   ```
+
   You can use pass a block to define some custom behavior to the struct instance.
 
   ```ruby
@@ -115,7 +151,7 @@ Person.features.options?(:to_proc, :readonly) # => true
 Person.features.options?(:to_ary, :readonly)  # => false
 ```
 
-[⬆️ &nbsp;Back to Top](#changelog-)
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
 
 ## [0.11.0] - 2021-12-19
 
@@ -125,7 +161,7 @@ Person.features.options?(:to_ary, :readonly)  # => false
 - Set up a CI with Github actions.
 - Test the codebase against the Ruby versions: `2.2`, `2.3`, `2.4`, `2.5`, `2.6`, `2.7`, `3.0` and `3.1.0-preview1`.
 
-[⬆️ &nbsp;Back to Top](#changelog-)
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
 
 ## [0.10.0] - 2021-12-15
 
@@ -159,7 +195,7 @@ rgb_color.to_hex
 # => "#0105ff"
 ```
 
-[⬆️ &nbsp;Back to Top](#changelog-)
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
 
 ## [0.9.0] - 2021-12-14
 
@@ -248,7 +284,7 @@ rgb_color.to_ary  # => [1, 5, 255]
 rgb_color.to_hash # => {:r=>1, :g=>5, :b=>255}
 ```
 
-[⬆️ &nbsp;Back to Top](#changelog-)
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
 
 ## [0.8.0] - 2021-12-05
 
@@ -266,7 +302,7 @@ Person === person
 # => true
 ```
 
-[⬆️ &nbsp;Back to Top](#changelog-)
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
 
 ## [0.7.0] - 2021-12-04
 
@@ -295,7 +331,7 @@ Person = Micro::Struct.new(
 )
 ```
 
-[⬆️ &nbsp;Back to Top](#changelog-)
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
 
 ## [0.6.0] - 2021-12-03
 
@@ -320,7 +356,7 @@ Persona.new
 # => #<struct Persona::Struct first_name=nil, last_name=nil>
 ```
 
-[⬆️ &nbsp;Back to Top](#changelog-)
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
 
 ## [0.5.0] - 2021-12-02
 
@@ -371,7 +407,7 @@ person.name     # => "Rodrigo Serradura"
 new_person.name # => "John Doe"
 ```
 
-[⬆️ &nbsp;Back to Top](#changelog-)
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
 
 ## [0.4.0] - 2021-12-02
 
@@ -400,7 +436,7 @@ person.respond_to?(:to_hash) # => false
 Person.respond_to?(:to_proc) # => false
 ```
 
-[⬆️ &nbsp;Back to Top](#changelog-)
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
 
 ## [0.3.1] - 2021-12-02
 
@@ -408,7 +444,7 @@ Person.respond_to?(:to_proc) # => false
 
 - Fix the spec.files config of `u-struct.gemspec`.
 
-[⬆️ &nbsp;Back to Top](#changelog-)
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
 
 ## [0.3.0] - 2021-12-02
 
@@ -416,7 +452,7 @@ Person.respond_to?(:to_proc) # => false
 
 - Add `lib/u-struct.rb` to allow the bundler to require the gem in an automatic way.
 
-[⬆️ &nbsp;Back to Top](#changelog-)
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
 
 ## [0.2.0] - 2021-12-02
 
@@ -436,7 +472,7 @@ person = Person.new(first_name: 'Rodrigo', last_name: 'Serradura')
 print_first_and_last_name(**person) # Rodrigo Serradura
 ```
 
-[⬆️ &nbsp;Back to Top](#changelog-)
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
 
 ## [0.1.0] - 2021-12-02
 
@@ -499,4 +535,22 @@ Person::Struct.new
 # => NoMethodError (private method `new' called for Person::Struct:Class)
 ```
 
-[⬆️ &nbsp;Back to Top](#changelog-)
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
+
+[Unreleased]: https://github.com/u-gems/u-struct/compare/v2.0.0...HEAD
+[2.0.0]: https://github.com/u-gems/u-struct/compare/v1.1.0...v2.0.0
+[1.1.0]: https://github.com/u-gems/u-struct/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/u-gems/u-struct/compare/v0.12.0...v1.0.0
+[0.12.0]: https://github.com/u-gems/u-struct/compare/v0.11.0...v0.12.0
+[0.11.0]: https://github.com/u-gems/u-struct/compare/v0.10.0...v0.11.0
+[0.10.0]: https://github.com/u-gems/u-struct/compare/v0.9.0...v0.10.0
+[0.9.0]: https://github.com/u-gems/u-struct/compare/v0.8.0...v0.9.0
+[0.8.0]: https://github.com/u-gems/u-struct/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/u-gems/u-struct/compare/v0.6.0...v0.7.0
+[0.6.0]: https://github.com/u-gems/u-struct/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/u-gems/u-struct/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/u-gems/u-struct/compare/v0.3.1...v0.4.0
+[0.3.1]: https://github.com/u-gems/u-struct/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/u-gems/u-struct/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/u-gems/u-struct/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/u-gems/u-struct/releases/tag/v0.1.0