u-struct 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed0c19c23a4cbdd7282390be2590b7b9ae8b025badd32ffbaae9adf128d79667
-  data.tar.gz: b18729b71798828d9ba517f635e3b2b8e6baff640724b0837bac66be14e72ed8
+  metadata.gz: 0150b18cb61a38d042a0ad2f22c9588c7269c8362a708a8ebf156cc927a312dd
+  data.tar.gz: 0fc97adb461433c7382ee524d3a58c4d134624013c4afa974cade30b46f09109
 SHA512:
-  metadata.gz: '0519e4b525fb8e62021c8ec5e518f503c6f14d865f48942c9dd145864f08ca2c3cbfb5c65fae703c3f91c3730ffd04881890d950c335ecc14789cdb28f24a541'
-  data.tar.gz: c0068d5051527141d7d1bfd59de4cd5e7b026abbbb5abe2d0a9b45b0a74de674e51bda16d483400f1cdeb9284a7bdb6093ba5989d8eb940e4a431e70bed12ee7
+  metadata.gz: 708cbec302ef69ec3d6f465ebca2d07eff62ff1a3746b4e7034b21a571e693b27b9e4dad1ada934f4ac37f2565212cc83f111d384eb84573209578aab77beac6
+  data.tar.gz: cec5b4750bcc98d9955fbe27bcca952b2139c36dd90d6f6c98fd3b107f9ef577fdb2e72f34c78871e15d608cdab06c034427efeab67caa5bc2c869bbaeee8026

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/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
 

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/rgb/color.rb

@@ -2,20 +2,20 @@
 
 module RGB
   Color = Micro::Struct.with(:readonly, :to_ary).new(:red, :green, :blue) do
-    def self.new(r:, g:, b:)
-      __new__(
-        red:   Number.new(r, label: 'r'),
-        green: Number.new(g, label: 'g'),
-        blue:  Number.new(b, label: 'b')
+    def initialize(r, g, b)
+      super(
+        Number.new(value: r, label: 'red'),
+        Number.new(value: g, label: 'green'),
+        Number.new(value: b, label: 'blue')
       )
     end
 
     def to_a
-      super.map(&:value)
+      @to_a ||= super.map(&:value)
     end
 
     def to_hex
-      "##{red}#{green}#{blue}"
+      @to_hex ||= "##{red}#{green}#{blue}"
     end
   end
 end

data/examples/rgb/number.rb

@@ -1,17 +1,21 @@
 # frozen_string_literal: true
 
 module RGB
-  Number = Micro::Struct.with(:readonly).new(:value) do
+  Number = Micro::Struct.with(:readonly).new(:value, :label) do
     Input = Kind.object(name: 'Integer(>= 0 and <= 255)') do |value|
       value.is_a?(::Integer) && value >= 0 && value <= 255
     end
 
-    def self.new(value, label:)
-      __new__(value: Input[value, label: label])
+    def initialize(value, label)
+      super(Input[value, label: label])
     end
 
     def to_s
-      value.to_s(16)
+      @to_s ||= '%02x' % value
+    end
+
+    def inspect
+      "#<RGB::Number #{value}>"
     end
   end
 end

data/examples/rgb_1.rb

@@ -14,26 +14,24 @@ RGBColor = Micro::Struct.with(:readonly, :to_ary).new(:red, :green, :blue) do
     value.is_a?(::Integer) && value >= 0 && value <= 255
   end
 
-  def self.new(r:, g:, b:)
-    __new__(
-      red:   Number[r, label: 'r'],
-      green: Number[g, label: 'g'],
-      blue:  Number[b, label: 'b']
-    )
+  def initialize(r, g, b)
+    super(Number[r], Number[g], Number[b])
   end
 
   def to_hex
-    "##{red.to_s(16)}#{green.to_s(16)}#{blue.to_s(16)}"
+    '#%02x%02x%02x' % self
   end
 end
 
-rgb_color = RGBColor.new(r: 1, g: 1, b: 255)
+puts
+
+rgb_color = RGBColor.new(red: 1, green: 1, blue: 255)
 
 p rgb_color
 
 puts
-puts format('to_hex: %p', rgb_color.to_hex)
 puts format('to_a: %p', rgb_color.to_a)
+puts format('to_hex: %p', rgb_color.to_hex)
 puts
 
 r, g, b = rgb_color
@@ -41,5 +39,15 @@ r, g, b = rgb_color
 puts format('red: %p', r)
 puts format('green: %p', g)
 puts format('blue: %p', b)
+puts
 
-RGBColor.new(r: 1, g: -1, b: 255) # Kind::Error (g: -1 expected to be a kind of Integer(>= 0 and <= 255))
+*rgb = rgb_color
+
+puts rgb.inspect
+puts
+
+begin
+  RGBColor.new(red: 1, green: -1, blue: 255)
+rescue => exception
+  puts exception # Kind::Error (-1 expected to be a kind of Integer(>= 0 and <= 255))
+end

data/examples/rgb_2.rb

@@ -14,21 +14,25 @@ RGBNumber = Micro::Struct.with(:readonly).new(:value) do
     value.is_a?(::Integer) && value >= 0 && value <= 255
   end
 
-  def self.new(value, label:)
-    __new__(value: Input[value, label: label])
+  def initialize(value)
+    super(Input[value])
   end
 
   def to_s
-    value.to_s(16)
+    '%02x' % value
+  end
+
+  def inspect
+    "#<RGBNumber #{value}>"
   end
 end
 
 RGBColor = Micro::Struct.with(:readonly, :to_ary).new(:red, :green, :blue) do
   def self.new(r:, g:, b:)
     __new__(
-      red:   RGBNumber.new(r, label: 'r'),
-      green: RGBNumber.new(g, label: 'g'),
-      blue:  RGBNumber.new(b, label: 'b')
+      red:   RGBNumber.new(value: r),
+      green: RGBNumber.new(value: g),
+      blue:  RGBNumber.new(value: b)
     )
   end
 
@@ -41,13 +45,15 @@ RGBColor = Micro::Struct.with(:readonly, :to_ary).new(:red, :green, :blue) do
   end
 end
 
+puts
+
 rgb_color = RGBColor.new(r: 1, g: 1, b: 255)
 
 p rgb_color
 
 puts
-puts format('to_hex: %p', rgb_color.to_hex)
 puts format('to_a: %p', rgb_color.to_a)
+puts format('to_hex: %p', rgb_color.to_hex)
 puts
 
 r, g, b = rgb_color
@@ -55,5 +61,15 @@ r, g, b = rgb_color
 puts format('red: %p', r)
 puts format('green: %p', g)
 puts format('blue: %p', b)
+puts
+
+*rgb = rgb_color
 
-RGB::Color.new(r: 1, g: -1, b: 255) # Kind::Error (g: -1 expected to be a kind of Integer(>= 0 and <= 255))
+puts rgb.inspect
+puts
+
+begin
+  RGBColor.new(r: 1, g: -1, b: 255)
+rescue => exception
+  puts exception # Kind::Error (-1 expected to be a kind of Integer(>= 0 and <= 255))
+end

data/examples/rgb_3.rb

@@ -12,13 +12,15 @@ end
 require_relative 'rgb/number'
 require_relative 'rgb/color'
 
-rgb_color = RGB::Color.new(r: 1, g: 1, b: 255)
+puts
+
+rgb_color = RGB::Color.new(red: 1, green: 1, blue: 255)
 
 p rgb_color
 
 puts
-puts format('to_hex: %p', rgb_color.to_hex)
 puts format('to_a: %p', rgb_color.to_a)
+puts format('to_hex: %p', rgb_color.to_hex)
 puts
 
 r, g, b = rgb_color
@@ -26,5 +28,15 @@ r, g, b = rgb_color
 puts format('red: %p', r)
 puts format('green: %p', g)
 puts format('blue: %p', b)
+puts
 
-RGB::Color.new(r: 1, g: -1, b: 255) # Kind::Error (g: -1 expected to be a kind of Integer(>= 0 and <= 255))
+*rgb = rgb_color
+
+puts rgb.inspect
+puts
+
+begin
+  RGB::Color.new(red: 1, green: -1, blue: 255)
+rescue => exception
+  puts exception # Kind::Error (green: -1 expected to be a kind of Integer(>= 0 and <= 255))
+end

data/lib/micro/struct/factory/create_struct.rb

@@ -4,30 +4,24 @@ class Micro::Struct::Factory
   module CreateStruct
     extend self
 
-    def with(required_members, optional_members, features, &block)
-      struct = ::Struct.new(*(required_members + optional_members))
+    def with(members, block, features)
+      struct = ::Struct.new(*members.required_and_optional)
 
-      def_initialize(struct, required_members, optional_members)
-      def_to_ary(struct) if features[:to_ary]
-      def_to_hash(struct) if features[:to_hash]
-      def_to_proc(struct) if features[:to_proc]
-      def_readonly(struct) if features[:readonly]
-      def_instance_copy(struct) if features[:instance_copy]
+      ClassScope.def_new(struct, members)
+      ClassScope.def_to_proc(struct)         if features[:to_proc]
+      ClassScope.def_private_writers(struct) if features[:readonly]
 
-      struct.class_eval(&block) if block
+      InstanceScope.def_with(struct)    if features[:instance_copy]
+      InstanceScope.def_to_ary(struct)  if features[:to_ary]
+      InstanceScope.def_to_hash(struct) if features[:to_hash]
+
+      ClassScope.evaluate(struct, block)
 
       struct
     end
 
-    private
-
-      def def_initialize(struct, required_members, optional_members)
-        required = "#{required_members.join(':, ')}#{':' unless required_members.empty?}"
-        optional = "#{optional_members.join(': nil, ')}#{': nil' unless optional_members.empty?}"
-
-        keywords_arguments = [required, optional].reject(&:empty?).join(', ')
-        positional_arguments = (required_members + optional_members).join(', ')
-
+    module ClassScope
+      def self.def_new(struct, members)
         # The .new() method will require all required keyword arguments.
         # We are doing this because the Struct constructor keyword init option treats everything as optional.
         #
@@ -35,18 +29,36 @@ class Micro::Struct::Factory
           class << self
             undef_method :new
 
-            def new(#{keywords_arguments})                        # def new(a:, b:, c: nil) do
-              instance = allocate                                 #   instance = allocate
-              instance.send(:initialize, #{positional_arguments}) #   instance.send(:initialize, a, b, c)
-              instance                                            #   instance
-            end                                                   # end
+            def new(#{members.to_eval.keyword_args})                         # def new(a:, b:, c: nil) do
+              instance = allocate                                            #   instance = allocate
+              instance.send(:initialize, #{members.to_eval.positional_args}) #   instance.send(:initialize, a, b, c)
+              instance                                                       #   instance
+            end                                                              # end
 
             alias __new__ new
           end
         RUBY
       end
 
-      def def_to_ary(struct)
+      def self.def_to_proc(struct)
+        struct.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+          def self.to_proc
+            ->(hash) { new(**hash) }
+          end
+        RUBY
+      end
+
+      def self.def_private_writers(struct)
+        struct.send(:private, *struct.members.map { |member| "#{member}=" })
+      end
+
+      def self.evaluate(struct, block)
+        struct.class_eval(&block) if block
+      end
+    end
+
+    module InstanceScope
+      def self.def_to_ary(struct)
         struct.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
           def to_ary
             to_a
@@ -54,7 +66,7 @@ class Micro::Struct::Factory
         RUBY
       end
 
-      def def_to_hash(struct)
+      def self.def_to_hash(struct)
         struct.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
           def to_hash
             to_h
@@ -62,25 +74,14 @@ class Micro::Struct::Factory
         RUBY
       end
 
-      def def_readonly(struct)
-        struct.send(:private, *struct.members.map { |member| "#{member}=" })
-      end
-
-      def def_instance_copy(struct)
+      def self.def_with(struct)
         struct.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
           def with(**members)
             self.class.new(**to_h.merge(members))
           end
         RUBY
       end
-
-      def def_to_proc(struct)
-        struct.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-          def self.to_proc
-            ->(hash) { new(**hash) }
-          end
-        RUBY
-      end
+    end
   end
 
   private_constant :CreateStruct

data/lib/micro/struct/factory/members.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Micro::Struct
+  class Factory
+    class Members
+      attr_reader :required_and_optional
+
+      Names = ->(values) { NormalizeNames::AsSymbols.(values, context: 'member') }
+
+      def initialize(required_members, required_option, optional_option)
+        @required = Names[required_members] + Names[required_option]
+        @optional = Names[optional_option]
+
+        @required_and_optional = @required + @optional
+      end
+
+      ToEval = ::Struct.new(:required, :optional, :required_and_optional) do
+        def keyword_args
+          required_kargs = "#{required.join(':, ')}#{':' unless required.empty?}"
+          optional_kargs = "#{optional.join(': nil, ')}#{': nil' unless optional.empty?}"
+
+          [required_kargs, optional_kargs].reject(&:empty?).join(', ')
+        end
+
+        def positional_args
+          required_and_optional.join(', ')
+        end
+      end
+
+      def to_eval
+        @to_eval ||= ToEval.new(@required, @optional, required_and_optional)
+      end
+    end
+
+    private_constant :Members
+  end
+end

data/lib/micro/struct/factory.rb

@@ -2,21 +2,17 @@
 
 module Micro::Struct
   class Factory
+    require_relative 'factory/members'
     require_relative 'factory/create_struct'
 
     def initialize(features)
       @features = Features.require(features)
     end
 
-    NormalizeMemberNames = ->(values) do
-      NormalizeNames::AsSymbols.(values, context: 'member')
-    end
-
-    def new(*members, required: nil, optional: nil, &block)
-      optional_members = NormalizeMemberNames[optional]
-      required_members = NormalizeMemberNames[members] + NormalizeMemberNames[required]
+    def new(*required_members, required: nil, optional: nil, &struct_block)
+      members = Members.new(required_members, required, optional)
 
-      CreateStruct.with(required_members, optional_members, @features, &block)
+      CreateStruct.with(members, struct_block, @features)
     end
   end
 

data/lib/micro/struct/features.rb

@@ -17,13 +17,12 @@ module Micro::Struct
         instance_copy: instance_copy }
     end
 
-    NormalizeFeatureNames = ->(values) do
+    Names = ->(values) do
       NormalizeNames::AsSymbols.(values, context: 'feature')
     end
 
-    def self.require(names)
-      to_enable =
-        NormalizeFeatureNames[names].each_with_object({}) { |name, memo| memo[name] = true }
+    def self.require(values)
+      to_enable = Names[values].each_with_object({}) { |name, memo| memo[name] = true }
 
       Check.(**DISABLED.merge(to_enable))
     end

data/lib/micro/struct/version.rb

@@ -2,6 +2,6 @@
 
 module Micro
   module Struct
-    VERSION = '0.10.0'
+    VERSION = '0.11.0'
   end
 end

data/u-struct.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Create powered Ruby structs.}
   spec.homepage      = 'https://github.com/serradura/u-struct'
   spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.required_ruby_version = '>= 2.2.0'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/serradura/u-struct'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: u-struct
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2021-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,16 +45,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/prepare_coverage
 - bin/setup
+- bin/test
 - examples/person_1.rb
 - examples/person_2.rb
 - examples/rgb/color.rb
@@ -65,6 +68,7 @@ files:
 - lib/micro/struct.rb
 - lib/micro/struct/factory.rb
 - lib/micro/struct/factory/create_struct.rb
+- lib/micro/struct/factory/members.rb
 - lib/micro/struct/features.rb
 - lib/micro/struct/normalize_names.rb
 - lib/micro/struct/version.rb
@@ -85,14 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Create powered Ruby structs.

data/Gemfile.lock

@@ -1,31 +0,0 @@
-PATH
-  remote: .
-  specs:
-    u-struct (0.10.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    docile (1.4.0)
-    minitest (5.14.4)
-    rake (13.0.6)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
-
-PLATFORMS
-  ruby
-  x86_64-darwin-19
-
-DEPENDENCIES
-  bundler
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  simplecov (~> 0.21.2)
-  u-struct!
-
-BUNDLED WITH
-   2.2.32