u-struct 0.8.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bebaeb99b56b26288a87f8907532e194a4388563a11ed486c90d203c34d9e951
-  data.tar.gz: 66d1f615dcaa99c713d24b7ea375f00293396fe91d2314be223a487cfa90caa8
+  metadata.gz: 7788d4a3412a447721c8d375a1844b9f000816ade2780925835e2a6ca222329c
+  data.tar.gz: 938d1c98f2f495aeca842a29a352e62a5f6565e96d7aed9ad01f27e8cadd08a8
 SHA512:
-  metadata.gz: 4131a340a7a5981a60a177a2a1c59846f12693053eb80cd77e289e83a3602e10df31b694c8bb8a0fbb9a8d60886ce4b0e27424cce27a1ae2e513570d981c0c67
-  data.tar.gz: 2ed2f7a1a80265ace687639e575f5395f3cb1c663ac0c4b5dc044a52a2ba321540942523a6a7f0b9377df6d2a4569e029b35a8f1345e861ab23cd0f5cd0d885b
+  metadata.gz: a9c449b61842f114a0d90ce5b8c69d07c33599727cfb26e15a9d1455f79f7cd308d15b3d7d85f508a30c8b6717bf182b5a00dd960fb814d9cc648823fc882f01
+  data.tar.gz: b201b72d06fde813dfca89ff231a742c1d6fba92883133c4f12419e924830238c507d85f6d8e2e06c303033d3812df42e147acabe7742d5bfbc360163c739d34

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+
+name: build
+on: [push]
+jobs:
+  test:
+    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]
+    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: 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
+        with:
+          debug: true
+          coverageLocations: coverage/.resultset.json:simplecov

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+Gemfile.lock

data/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "cSpell.enabled": true,
+  "cSpell.ignoreWords": [
+    "paambaati",
+    "resultset",
+    "simplecov"
+  ]
+}

data/CHANGELOG.md

@@ -1,37 +1,496 @@
+# Changelog <!-- omit in toc -->
+
+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/),
+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]
 
+[⬆️ &nbsp;Back to Top](#changelog-)
+
+## [0.12.0] - 2021-12-22
+
+### Added 
+
+- Add `Micro::Struct.instance` to create a struct instance from a given hash. 
+  This could be useful to create constants or a singleton value.
+
+  ```ruby
+  person1 = Micro::Struct.instance(first_name: 'Rodrigo', last_name: 'Serradura')
+  # => #<struct  first_name="Rodrigo", last_name="Serradura">
+
+  person1.first_name = 'John'
+
+  person1.first_name # => "John" 
+  ```
+
+  You can use the instance method after defining some struct feature.
+
+  ```ruby
+  person2 = Micro::Struct.with(:readonly).instance(first_name: 'Rodrigo', last_name: 'Serradura')
+  # => #<struct  first_name="Rodrigo", last_name="Serradura">
+
+  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
+  person3 = Micro::Struct.instance(first_name: 'Rodrigo', last_name: 'Serradura') do
+    def name
+      "#{first_name} #{last_name}"
+    end
+  end
+
+  person4 = Micro::Struct.with(:readonly).instance(first_name: 'Rodrigo', last_name: 'Serradura') do
+    def name
+      "#{first_name} #{last_name}"
+    end
+  end
+
+  person3.name # => "Rodrigo Serradura"
+  person4.name # => "Rodrigo Serradura"
+  ```
+
+- Add `Micro::Struct.with(:exposed_features)` to expose the struct's configured features. 
+  Via the methods: `.features` and `.__features__`.
+
+```ruby
+Person = Micro::Struct.with(:exposed_features, :readonly, :to_proc).new(:name)
+
+Person.features
+# => #<struct Micro::Struct::Features::Exposed
+#      names=[:readonly, :to_proc],
+#      options={:to_ary=>false, :to_hash=>false, :to_proc=>true, :readonly=>true, :instance_copy=>false}>
+
+Person.__features__.equal?(Person.features) # `.__features__` is an alias of `.features` method
+
+Person.features.names   # => [:readonly, :to_proc]
+Person.features.options # => {:to_ary=>false, :to_hash=>false, :to_proc=>true, :readonly=>true, :instance_copy=>false}
+
+Person.features.option?(:to_proc)  # => true
+Person.features.option?(:readonly) # => true
+
+Person.features.options?(:to_proc)  # => true
+Person.features.options?(:readonly) # => true
+
+Person.features.options?(:to_proc, :readonly) # => true
+Person.features.options?(:to_ary, :readonly)  # => false
+```
+
+[⬆️ &nbsp;Back to Top](#changelog-)
+
+## [0.11.0] - 2021-12-19
+
+### 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-)
+
+## [0.10.0] - 2021-12-15
+
+### Changed
+
+- Make `Micro::Struct.new` return a Ruby struct instead of a module.
+
+```ruby
+module RGB
+  Number = ::Struct.new(:value) { def to_s; '%02x' % value; end }
+
+  Color = Micro::Struct.new(:red, :green, :blue) do
+    def self.new(r, g, b)
+      __new__(
+        red: Number.new(r),
+        green: Number.new(g),
+        blue: Number.new(b),
+      )
+    end
+
+    def to_hex
+      "##{red}#{green}#{blue}"
+    end
+  end
+end
+
+rgb_color = RGB::Color.new(1,5,255)
+# => #<struct RGB::Color red=#<struct RGB::Number value=1>, green=#<struct RGB::Number value=5>, blue=#<struct RGB::Number value=255>>
+
+rgb_color.to_hex
+# => "#0105ff"
+```
+
+[⬆️ &nbsp;Back to Top](#changelog-)
+
+## [0.9.0] - 2021-12-14
+
+### Added
+
+- Add `__new__` method and make `.new` its alias. You can use `__new__` when overwriting the module's `new`.
+
+```ruby
+module RGB
+  Number = ::Struct.new(:value) { def to_s; '%02x' % value; end }
+
+  Color = Micro::Struct.new(:red, :green, :blue) do
+    def to_hex
+      "##{red}#{green}#{blue}"
+    end
+  end
+
+  module Color
+    def self.new(r, g, b)
+      __new__(
+        red: Number.new(r),
+        green: Number.new(g),
+        blue: Number.new(b),
+      )
+    end
+  end
+end
+
+rgb_color = RGB::Color.new(1,5,255)
+# => #<struct RGB::Color::Struct red=#<struct RGB::Number value=1>, green=#<struct RGB::Number value=5>, blue=#<struct RGB::Number value=255>>
+
+rgb_color.to_hex
+# => "#0105ff"
+```
+
+### Changed
+
+- Change `:readonly` feature, now it doesn't require the `:instance_copy` by default.
+  So, If you want both features, you will need to declare them together.
+
+```ruby
+Person = Micro::Struct.with(:readonly).new(:name)
+Persona = Micro::Struct.with(:readonly, :instance_copy).new(:name)
+
+person = Person.new(name: 'Rodrigo')
+persona = Persona.new(name: 'Serradura')
+
+person.respond_to?(:name=)  # false
+persona.respond_to?(:name=) # false
+
+person.respond_to?(:with)  # false
+persona.respond_to?(:with) # true
+```
+
+- Change `:to_ary` to invoke the `#to_a` method instead of defining it as an alias.
+- Change `:to_hash` to invoke the `#to_h` method instead of defining it as an alias.
+
+```ruby
+module RGB
+  Number = ::Struct.new(:value) { def to_s; '%02x' % value; end }
+
+  Color = Micro::Struct.with(:readonly, :to_ary, :to_hash).new(:red, :green, :blue) do
+    def initialize(r, g, b)
+      super(Number.new(r), Number.new(g), Number.new(b))
+    end
+
+    def to_hex
+      "##{red}#{green}#{blue}"
+    end
+
+    def to_a
+      [red, green, blue].map(&:value)
+    end
+
+    def to_h
+      { r: red.value, g: green.value, b: blue.value }
+    end
+  end
+end
+
+rgb_color = RGB::Color.new(red: 1, green: 5, blue: 255)
+#  => #<struct RGB::Color::Struct red=#<struct RGB::Number value=1>, green=#<struct RGB::Number value=5>, blue=#<struct RGB::Number value=255>>
+
+rgb_color.to_hex  # => "#0105ff"
+rgb_color.to_ary  # => [1, 5, 255]
+rgb_color.to_hash # => {:r=>1, :g=>5, :b=>255}
+```
+
+[⬆️ &nbsp;Back to Top](#changelog-)
+
 ## [0.8.0] - 2021-12-05
 
-- To-do
+### Added
+
+- Add `.===` to the module, it delegates the calling to its struct.
+
+```ruby
+Person = Micro::Struct.new(:name)
+
+person = Person.new(name: 'Rodrigo Serradura')
+# => #<struct Person::Struct name="Rodrigo Serradura">
+
+Person === person
+# => true
+```
+
+[⬆️ &nbsp;Back to Top](#changelog-)
 
 ## [0.7.0] - 2021-12-04
 
-- To-do
+### Added
+
+- Add `required:` option to define required struct members.
+
+```ruby
+# All of the alternatives have the same equivalence.
+
+Person = Micro::Struct.new(:first_name, :last_name)
+
+Person = Micro::Struct.new(required: [:first_name, :last_name])
+
+Person = Micro::Struct.new(:first_name, required: :last_name)
+```
+
+### Changed
+
+- Remove the `_` from the `optional:` option.
+
+```ruby
+Person = Micro::Struct.new(
+  required: [:first_name, :last_name],
+  optional: :age
+)
+```
+
+[⬆️ &nbsp;Back to Top](#changelog-)
 
 ## [0.6.0] - 2021-12-03
 
-- To-do
+### Added
+
+- Add the capability to create a struct with optional members.
+
+```ruby
+Person = Micro::Struct.new(:first_name, _optional: :last_name)
+
+Person.new
+# ArgumentError (missing keyword: :first_name)
+
+Person.new(first_name: 'Rodrigo')
+# => #<struct Person::Struct first_name="Rodrigo", last_name=nil>
+
+# --
+
+Persona = Micro::Struct.new(_optional: [:first_name, :last_name])
+
+Persona.new
+# => #<struct Persona::Struct first_name=nil, last_name=nil>
+```
+
+[⬆️ &nbsp;Back to Top](#changelog-)
+
+## [0.5.0] - 2021-12-02
+
+### Added
+
+- Add new feature `:instance_copy`. It instantiates a struct of the same kind from its current state.
+
+```ruby
+Person = Micro::Struct.with(:instance_copy).new(:first_name, :last_name)
+
+person = Person.new(first_name: 'Rodrigo', last_name: 'Serradura')
+# => #<struct Person::Struct first_name="Rodrigo", last_name="Serradura">
+
+person.first_name = 'John'
+# => "John"
+
+person.inspect
+# => #<struct Person::Struct first_name="John", last_name="Serradura">
+
+new_person = person.with(last_name: 'Doe')
+# => #<struct Person::Struct first_name="John", last_name="Doe">
+
+person === new_person     # => false
+person.equal?(new_person) # => false
+
+person.last_name     # => "Serradura"
+new_person.last_name # => "Doe"
+```
+
+- Add new feature `:readonly`. It sets members' writers private and requires the `:instance_copy` feature.
+
+```ruby
+Person = Micro::Struct.with(:readonly).new(:name)
+
+person = Person.new(name: 'Rodrigo Serradura')
+# => #<struct Person::Struct name="Rodrigo Serradura">
+
+person.name = 'John Doe'
+# NoMethodError (private method `name=' called for #<struct Person::Struct name="Rodrigo Serradura">)
+
+new_person = person.with(name: 'John Doe')
+# => #<struct Person::Struct name="John Doe">
+
+person === new_person     # => false
+person.equal?(new_person) # => false
+
+person.name     # => "Rodrigo Serradura"
+new_person.name # => "John Doe"
+```
+
+[⬆️ &nbsp;Back to Top](#changelog-)
+
+## [0.4.0] - 2021-12-02
 
-## [0.5.0] - 2021-12-03
+### Added
 
-- To-do
+- Add `.members` to the module, it delegates the calling to its struct.
 
-## [0.4.0] - 2021-12-03
+```ruby
+Person = Micro::Struct.new(:first_name, :last_name)
 
-- To-do
+Person.members # => [:first_name, :last_name]
+```
+
+- Add `Micro::Struct.with()` to enable or disable the creation of structs with custom features.
+  So now, you can create the structs with one, some, or all features. They are: `to_ary`, `to_hash`, `to_proc`.
+
+```ruby
+Person = Micro::Struct.with(:to_ary).new(:name)
+
+person = Person.new(name: 'Rodrigo')
+# => #<struct Person::Struct name="Rodrigo">
+
+person.respond_to?(:to_ary)  # => true
+person.respond_to?(:to_hash) # => false
+
+Person.respond_to?(:to_proc) # => false
+```
+
+[⬆️ &nbsp;Back to Top](#changelog-)
 
 ## [0.3.1] - 2021-12-02
 
-- To-do
+### Fixed
+
+- Fix the spec.files config of `u-struct.gemspec`.
+
+[⬆️ &nbsp;Back to Top](#changelog-)
 
 ## [0.3.0] - 2021-12-02
 
-- To-do
+### Added
+
+- Add `lib/u-struct.rb` to allow the bundler to require the gem in an automatic way.
+
+[⬆️ &nbsp;Back to Top](#changelog-)
 
 ## [0.2.0] - 2021-12-02
 
-- To-do
+### Added
+
+- Add `to_hash` as an alias of Struct's `to_h`.
+
+```ruby
+Person = Micro::Struct.new(:first_name, :last_name)
+
+def print_first_and_last_name(first_name:, last_name:)
+  puts "#{first_name} #{last_name}"
+end
+
+person = Person.new(first_name: 'Rodrigo', last_name: 'Serradura')
+
+print_first_and_last_name(**person) # Rodrigo Serradura
+```
+
+[⬆️ &nbsp;Back to Top](#changelog-)
 
 ## [0.1.0] - 2021-12-02
 
-- Initial release
+### Added
+
+- Create a module containing a Ruby struct with some custom features.
+  - The module's `.new` method receives the struct arguments as keyword arguments.
+  - The module's `.new` can receive a block as a regular `Struct` to add some custom behavior.
+  - The module's `to_proc` can instantiate the struct by receiving a hash.
+  - The module's struct has its initializer set up as private.
+  - Add `to_ary` as an alias of module's struct `to_a`.
+
+```ruby
+Person = Micro::Struct.new(:first_name, :last_name) do
+  def name
+    "#{first_name} #{last_name}"
+  end
+end
+
+# == Module's .new ==
+
+Person.new
+# ArgumentError (missing keywords: :first_name, :last_name)
+
+Person.new(first_name: 'Rodrigo')
+# ArgumentError (missing keyword: :last_name)
+
+person = Person.new(first_name: 'Rodrigo', last_name: 'Serradura')
+# => #<struct Person::Struct first_name="Rodrigo", last_name="Serradura">
+
+# == Struct's block - it sets up custom behavior ==
+
+person.name # => "Rodrigo Serradura"
+
+# == Struct's #to_ary ==
+
+first_name, last_name = person
+
+p first_name # => "Rodrigo"
+p last_name  # => "Serradura"
+
+*first_and_last_name = person
+
+p first_and_last_name # => ["Rodrigo", "Serradura"]
+
+# == Module's .to_proc ==
+
+[
+  {first_name: 'John', last_name: 'Doe'},
+  {first_name: 'Mary', last_name: 'Doe'}
+].map(&Person)
+# => [
+#  #<struct Person::Struct first_name="John", last_name="Doe">,
+#  #<struct Person::Struct first_name="Mary", last_name="Doe">
+# ]
+
+# == Struct's private initializer ==
+
+Person::Struct.new
+# => NoMethodError (private method `new' called for Person::Struct:Class)
+```
+
+[⬆️ &nbsp;Back to Top](#changelog-)

data/Gemfile

@@ -8,4 +8,4 @@ gemspec
 gem 'rake', '~> 13.0'
 
 gem 'minitest', '~> 5.0'
-gem 'simplecov', '~> 0.21.2'
+gem 'simplecov', '~> 0.21.2' if RUBY_VERSION >= '2.5.0'

data/README.md

@@ -1,6 +1,24 @@
-# Micro::Struct
-
-Create powered Ruby structs.
+<p align="center">
+  <h1 align="center">🧱 μ-struct</h1>
+  <p align="center"><i>Create powered Ruby structs.</i></p>
+  <br>
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/ruby%20%3E=%202.2,%20%3C%203.2-ruby.svg?colorA=99004d&colorB=cc0066" alt="Ruby">
+  <a href="https://rubygems.org/gems/u-struct">
+    <img alt="Gem" src="https://img.shields.io/gem/v/u-struct.svg?style=flat-square">
+  </a>
+  <a href="https://github.com/serradura/u-struct/actions/workflows/ci.yml">
+    <img alt="Build Status" src="https://github.com/serradura/u-struct/actions/workflows/ci.yml/badge.svg">
+  </a>
+  <a href="https://codeclimate.com/github/serradura/u-struct/maintainability">
+    <img alt="Maintainability" src="https://api.codeclimate.com/v1/badges/2cc0204411cc2b392b7a/maintainability">
+  </a>
+  <a href="https://codeclimate.com/github/serradura/u-struct/test_coverage">
+    <img alt="Test Coverage" src="https://api.codeclimate.com/v1/badges/2cc0204411cc2b392b7a/test_coverage">
+  </a>
+</p>
 
 ## Installation
 
@@ -46,13 +64,14 @@ Micro::Struct.new(
 Micro::Struct.new(:name) {}
 
 # Available features (use one, many, or all) to create Structs with a special behavior:
-# .with(:to_ary, :to_hash, :to_proc, :readonly, :instance_copy)
+# .with(:to_ary, :to_hash, :to_proc, :readonly, :instance_copy, :exposed_features)
 
 Micro::Struct.with(:to_ary).new(:name)
 Micro::Struct.with(:to_ary, :to_hash).new(:name)
 Micro::Struct.with(:to_ary, :to_hash, :to_proc).new(:name)
 Micro::Struct.with(:to_ary, :to_hash, :to_proc, :readonly).new(:name)
 Micro::Struct.with(:to_ary, :to_hash, :to_proc, :readonly, :instance_copy).new(:name)
+Micro::Struct.with(:to_ary, :to_hash, :to_proc, :readonly, :instance_copy, :exposed_features).new(:name)
 
 # All of the possible combinations to create a Ruby Struct. ;)
 

data/bin/prepare_coverage

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# Borrowed from https://gist.github.com/qortex/7e7c49f3731391a91ee898336183acef
+
+# Temporary hack to get CodeClimate to work with SimpleCov 0.18 JSON format until issue is fixed
+# upstream: https://github.com/codeclimate/test-reporter/issues/413
+
+require "json"
+
+filename = "coverage/.resultset.json"
+contents = JSON.parse(File.read(filename))
+
+def remove_lines_key(obj)
+  case obj
+  when Hash
+    obj.transform_values do |val|
+      val.is_a?(Hash) && val.key?("lines") ? val["lines"] : remove_lines_key(val)
+    end
+  else
+    obj
+  end
+end
+
+# overwrite
+File.write(filename, JSON.generate(remove_lines_key(contents)))
+
+puts Dir['coverage/.*.json']

data/bin/test

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+set -e
+
+rm Gemfile.lock
+
+bundle update
+bundle exec rake test

data/examples/person_1.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'u-struct', path: '..'
+end
+
+Person = Micro::Struct.new(:first_name, :last_name, optional: :age) do
+  def name
+    "#{first_name} #{last_name}"
+  end
+end
+
+person = Person.new(first_name: 'Rodrigo', last_name: 'Serradura')
+
+puts format('first_name: %p', person.first_name)
+puts format('last_name: %p', person.last_name)
+puts format('name: %p', person.name)
+puts format('age: %p', person.age)
+puts
+
+person.age = rand(18..100)
+
+puts format('age: %p', person.age)