u-struct 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bae44de8a2fcfcebd5838c5aa282a16ca45e96f373cfb914f84849d1f05b46d
-  data.tar.gz: 7c4aa02beaaebf9a455d707d5e7cc654e7b3d3932b4555588aad0db3eff04806
+  metadata.gz: fa40551d175dd0f2239b9c8a5c7fda5ea39e29b4293c23d8318744cf2f9df0b9
+  data.tar.gz: 5f5058d00fde571ed7fb972dd976dcae1dbe5e7469c2f069eeb29b6cdd01747a
 SHA512:
-  metadata.gz: d08cb82f8392d7f960cb570ca2ddea82e931dd97c2ab9b6125a56aaca5a231d100d1e5f15bafa482214d0d63cd5c7d4f14d01bbbed3d5d07a2b60dc7f46024e9
-  data.tar.gz: 5bdc2d780807cbf09be36ed2d79453396a756642d3b088af74a79dc1d755328fa78786ed94167a1f7e8292b417614d17c606693f46ee4d8244c69ff7675d5900
+  metadata.gz: ef1569d45a887c42dd1239a35a98fdb160c6d93ca5e6cd24cbac1f4763295ff4228c5343f64fdf33e91a51503597b66aa0222b0652fd7b723d2e35e3a3c2e4ca
+  data.tar.gz: 7c2747b2b46095461d6402a1a7f58d4a2b4b8396572c4e6bb7d36e986da1aec44a17f82603ec2c01bd62bbbe3a6127114a8023b6e04e0601df8be045daae9699

data/.github/workflows/ci.yml

@@ -6,20 +6,20 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1.0-preview1]
+        ruby: [2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 3.0.3, 3.1]
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-      - name: Test and generate coverage
-        run: bin/test
+      - name: Run sorbet, rubocop, tests and generate code coverage
+        run: bin/run_ci
       - name: Format coverage
-        if: ${{ matrix.ruby >= 3 && matrix.ruby < 3.1 }}
+        if: ${{ matrix.ruby >= 3.1 }}
         run: bin/prepare_coverage
       - uses: paambaati/codeclimate-action@v2.7.5
-        if: ${{ matrix.ruby >= 3 && matrix.ruby < 3.1 }}
+        if: ${{ matrix.ruby >= 3.1 }}
         env:
           CC_TEST_REPORTER_ID: 8ce350edeb0772e94ffd678bbaca30d9c1293b9d9051a1689c79b91c21f5afd5
         with:

data/.rubocop.yml

@@ -0,0 +1,129 @@
+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
+
+# == 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.1.0

data/CHANGELOG.md

@@ -6,47 +6,111 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.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)
+- [[1.1.0] - 2021-03-23](#110---2021-03-23)
   - [Added](#added)
-- [[0.11.0] - 2021-12-19](#0110---2021-12-19)
+- [[1.0.0] - 2021-01-19](#100---2021-01-19)
+- [[0.12.0] - 2021-12-22](#0120---2021-12-22)
   - [Added](#added-1)
+- [[0.11.0] - 2021-12-19](#0110---2021-12-19)
+  - [Added](#added-2)
 - [[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)
+  - [Added](#added-3)
   - [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)
+- [[0.7.0] - 2021-12-04](#070---2021-12-04)
+  - [Added](#added-5)
   - [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)
+- [[0.5.0] - 2021-12-02](#050---2021-12-02)
   - [Added](#added-7)
+- [[0.4.0] - 2021-12-02](#040---2021-12-02)
+  - [Added](#added-8)
 - [[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)
+- [[0.2.0] - 2021-12-02](#020---2021-12-02)
   - [Added](#added-10)
-
+- [[0.1.0] - 2021-12-02](#010---2021-12-02)
+  - [Added](#added-11)
 ## [Unreleased]
 
-[⬆️  Back to Top](#changelog-)
+[Diff](https://github.com/serradura/u-struct/compare/v1.1.0...main)
+
+## [1.1.0] - 2021-03-23
+
+[Diff](https://github.com/serradura/u-struct/compare/v1.0.0...v1.1.0) | [Tag](https://github.com/serradura/u-struct/tree/v1.1.0)
+### 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)
+
+  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>
+
+<p align="right">(<a href="#changelog-">⬆️ &nbsp;back to top</a>)</p>
 
 ## [1.0.0] - 2021-01-19
 
+[Diff](https://github.com/serradura/u-struct/compare/v0.12.0...v1.0.0) | [Tag](https://github.com/serradura/u-struct/tree/v1.0.0)
+
 - 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
 
+[Diff](https://github.com/serradura/u-struct/compare/v0.11.0...v0.12.0) | [Tag](https://github.com/serradura/u-struct/tree/v0.12.0)
+
 ### Added
 
 - Add `Micro::Struct.instance` to create a struct instance from a given hash.
@@ -115,20 +179,24 @@ 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
 
+[Diff](https://github.com/serradura/u-struct/compare/v0.10.0...v0.11.0) | [Tag](https://github.com/serradura/u-struct/tree/v0.11.0)
+
 ### Added
 
 - Reduce the required Ruby version to `>= 2.2.0`.
 - 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
 
+[Diff](https://github.com/serradura/u-struct/compare/v0.9.0...v0.10.0) | [Tag](https://github.com/serradura/u-struct/tree/v0.10.0)
+
 ### Changed
 
 - Make `Micro::Struct.new` return a Ruby struct instead of a module.
@@ -159,10 +227,12 @@ 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
 
+[Diff](https://github.com/serradura/u-struct/compare/v0.8.0...v0.9.0) | [Tag](https://github.com/serradura/u-struct/tree/v0.9.0)
+
 ### Added
 
 - Add `__new__` method and make `.new` its alias. You can use `__new__` when overwriting the module's `new`.
@@ -248,10 +318,12 @@ 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
 
+[Diff](https://github.com/serradura/u-struct/compare/v0.7.0...v0.8.0) | [Tag](https://github.com/serradura/u-struct/tree/v0.8.0)
+
 ### Added
 
 - Add `.===` to the module, it delegates the calling to its struct.
@@ -266,10 +338,12 @@ 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
 
+[Diff](https://github.com/serradura/u-struct/compare/v0.6.0...v0.7.0) | [Tag](https://github.com/serradura/u-struct/tree/v0.7.0)
+
 ### Added
 
 - Add `required:` option to define required struct members.
@@ -295,10 +369,12 @@ 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
 
+[Diff](https://github.com/serradura/u-struct/compare/v0.5.0...v0.6.0) | [Tag](https://github.com/serradura/u-struct/tree/v0.6.0)
+
 ### Added
 
 - Add the capability to create a struct with optional members.
@@ -320,10 +396,12 @@ 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
 
+[Diff](https://github.com/serradura/u-struct/compare/v0.4.0...v0.5.0) | [Tag](https://github.com/serradura/u-struct/tree/v0.5.0)
+
 ### Added
 
 - Add new feature `:instance_copy`. It instantiates a struct of the same kind from its current state.
@@ -371,10 +449,12 @@ 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
 
+[Diff](https://github.com/serradura/u-struct/compare/v0.3.1...v0.4.0) | [Tag](https://github.com/serradura/u-struct/tree/v0.4.0)
+
 ### Added
 
 - Add `.members` to the module, it delegates the calling to its struct.
@@ -400,26 +480,32 @@ 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
 
+[Diff](https://github.com/serradura/u-struct/compare/v0.3.0...v0.3.1) | [Tag](https://github.com/serradura/u-struct/tree/v0.3.1)
+
 ### Fixed
 
 - 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
 
+[Diff](https://github.com/serradura/u-struct/compare/v0.2.0...v0.3.0) | [Tag](https://github.com/serradura/u-struct/tree/v0.3.0)
+
 ### Added
 
 - 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
 
+[Diff](https://github.com/serradura/u-struct/compare/v0.1.0...v0.2.0) | [Tag](https://github.com/serradura/u-struct/tree/v0.2.0)
+
 ### Added
 
 - Add `to_hash` as an alias of Struct's `to_h`.
@@ -436,10 +522,12 @@ 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
 
+[Diff](https://github.com/serradura/u-struct/compare/19beceb97a9bc22f2a485b82e4002b6a2e20a73c...v0.1.0) | [Tag](https://github.com/serradura/u-struct/tree/v0.1.0)
+
 ### Added
 
 - Create a module containing a Ruby struct with some custom features.
@@ -499,4 +587,4 @@ 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>

data/Gemfile

@@ -5,7 +5,18 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in micro-struct.gemspec
 gemspec
 
-gem 'rake', '~> 13.0'
+gem 'rake', '13.0.6'
 
-gem 'minitest', '~> 5.0'
-gem 'simplecov', '~> 0.21.2' if RUBY_VERSION >= '2.5.0'
+gem 'minitest', '5.15.0'
+
+if RUBY_VERSION >= '2.5.0'
+  gem 'rubocop',          '1.26'
+  gem 'rubocop-minitest', '0.18.0'
+  gem 'rubocop-rake',     '0.6.0'
+  gem 'simplecov',        '0.21.2'
+end
+
+if RUBY_VERSION >= '2.7.0'
+  gem 'sorbet', '0.5.9775'
+  gem 'tapioca', '0.7.0'
+end