u-struct 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52450d53b7accc5aa4c83682dfc6557d3f5fa4d7879648c189701198548e0ace
-  data.tar.gz: 4a25f913523f7aa9e79e96e49cafd33cff2ec748dac79d0bca611cd67aa304e3
+  metadata.gz: f4b40b69da026b0f45f5514a8d340effc8f7d81489c4f1217237c16641186357
+  data.tar.gz: 6a5cd7b12d2d1b16830a805b9904e5c212c685d5a32108439e8f9f2b8235dfb8
 SHA512:
-  metadata.gz: 1bd5940255d259aeebbe5207a0a397bfade550bbc0e4bf719233ef18c2ba8f3fb483b96fb932fd775f7b98c35af184292b5f7392b32ebf0456888379b13c857c
-  data.tar.gz: 0ca2437cf6a48c090cc176324477b579c394b11c8c451a14a11c62a9509e5b3f6f722f1318d777e4db610cf4ab004b7f820dba169544fca0c31fb6033d03cf76
+  metadata.gz: 159075d6944696849893dd4f4860613b104b12f3e872c0cac65df62055af61309d9f9256a949693a01df7fb5b514e916755bf0f6f1295874d93b9bc1abb2a2b3
+  data.tar.gz: 12db20998fcd5b1688e4786766630cee699daffacfca72d18e3e769ac387931dd310a46ff511862c7d9d9f2a458ae8667dd3e7623dbfca55802caa41fd3cfbb8

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.7.0] - 2021-12-04
+
+- To-do
+
 ## [0.6.0] - 2021-12-03
 
 - To-do

data/Gemfile

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in micro-struct.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.0'
 
-gem "minitest", "~> 5.0"
+gem 'minitest', '~> 5.0'
+gem 'simplecov', '~> 0.21.2'

data/Gemfile.lock

@@ -1,13 +1,20 @@
 PATH
   remote: .
   specs:
-    u-struct (0.6.0)
+    u-struct (0.7.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
   x86_64-darwin-19
@@ -16,6 +23,7 @@ DEPENDENCIES
   bundler
   minitest (~> 5.0)
   rake (~> 13.0)
+  simplecov (~> 0.21.2)
   u-struct!
 
 BUNDLED WITH

data/README.md

@@ -26,13 +26,20 @@ Or install it yourself as:
 
 Micro::Struct.new(:first_name, :last_name, ...)
 
-# Use the `_optional:` arg if you want some optional attributes.
+# Use the `optional:` arg if you want some optional attributes.
 
-Micro::Struct.new(:first_name, :last_name, _optional: :gender)
+Micro::Struct.new(:first_name, :last_name, optional: :gender)
 
-# Using `_optional:` to define all attributes are optional.
+# Using `optional:` to define all attributes are optional.
 
-Micro::Struct.new(_optional: [:first_name, :last_name])
+Micro::Struct.new(optional: [:first_name, :last_name])
+
+# Use the `required:` arg to define required attributes.
+
+Micro::Struct.new(
+  required: [:first_name, :last_name],
+  optional: [:gender, :age]
+)
 
 # You can also pass a block to define custom methods.
 
@@ -52,11 +59,17 @@ Micro::Struct.with(:to_ary, :to_hash, :to_proc, :readonly, :instance_copy).new(:
 Micro::Struct.new(*required)
 Micro::Struct.new(*required) {}
 
-Micro::Struct.new(_optional: *)
-Micro::Struct.new(_optional: *) {}
+Micro::Struct.new(optional: *)
+Micro::Struct.new(optional: *) {}
+
+Micro::Struct.new(required: *)
+Micro::Struct.new(required: *) {}
+
+Micro::Struct.new(*required, optional: *)
+Micro::Struct.new(*required, optional: *) {}
 
-Micro::Struct.new(*required, _optional: *)
-Micro::Struct.new(*required, _optional: *) {}
+Micro::Struct.new(required: *, optional: *)
+Micro::Struct.new(required: *, optional: *) {}
 
 # Any options above can be used by the `.new()` method of the struct creator returned by the `.with()` method.
 

data/lib/micro/struct/creator/create_module.rb

@@ -23,7 +23,7 @@ class Micro::Struct::Creator
         method_arguments = [required, optional].reject(&:empty?).join(', ')
         struct_arguments = (required_members + optional_members).join(', ')
 
-        container.module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+        container.module_eval(<<-RUBY, __FILE__, __LINE__ + 1)
           # The .new() method will require all required keyword arguments.
           # We are doing this because the Struct constructor keyword init option treats everything as optional.
           #
@@ -38,7 +38,7 @@ class Micro::Struct::Creator
       end
 
       def def_to_proc(container)
-        container.module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+        container.module_eval(<<-RUBY, __FILE__, __LINE__ + 1)
           def self.to_proc
             ->(hash) { new(**hash) }
           end

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

@@ -31,7 +31,7 @@ class Micro::Struct::Creator
       end
 
       def def_instance_copy(struct)
-        struct.class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+        struct.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
           def with(**members)
             self.class.const_get(:Container, false).new(**to_h.merge(members))
           end

data/lib/micro/struct/creator.rb

@@ -9,13 +9,13 @@ module Micro::Struct
       @features = Features.require(features)
     end
 
-    ValidateMemberNames = ->(values) do
-      Validate::Names.(values, label: 'member')
+    NormalizeMemberNames = ->(values) do
+      NormalizeNames::AsSymbols.(values, context: 'member')
     end
 
-    def new(*members, _optional: nil, &block)
-      required_members = ValidateMemberNames[members]
-      optional_members = ValidateMemberNames[_optional]
+    def new(*members, required: nil, optional: nil, &block)
+      optional_members = NormalizeMemberNames[optional]
+      required_members = NormalizeMemberNames[members] + NormalizeMemberNames[required]
 
       container = CreateModule.with(required_members, optional_members, @features)
       struct = CreateStruct.with(required_members, optional_members, @features, &block)

data/lib/micro/struct/features.rb

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

data/lib/micro/struct/normalize_names.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Micro::Struct
+  module NormalizeNames
+    module AsSymbols
+      REGEXP = /\A[_A-Za-z]\w*\z/.freeze
+      Invalid = ->(context, val) { raise NameError.new("invalid #{context} name: #{val}") }
+      AsSymbol = ->(context, val) { REGEXP =~ val ? val.to_sym : Invalid[context, val] }.curry
+
+      def self.call(values, context:)
+        Array(values).map(&AsSymbol[context])
+      end
+    end
+  end
+
+  private_constant :NormalizeNames
+end

data/lib/micro/struct/version.rb

@@ -2,6 +2,6 @@
 
 module Micro
   module Struct
-    VERSION = '0.6.0'
+    VERSION = '0.7.0'
   end
 end

data/lib/micro/struct.rb

@@ -3,7 +3,7 @@
 require_relative 'struct/version'
 require_relative 'struct/features'
 require_relative 'struct/creator'
-require_relative 'struct/validate'
+require_relative 'struct/normalize_names'
 
 module Micro
   # Like in a regular Struct, you can define one or many attributes.
@@ -11,13 +11,20 @@ module Micro
   #
   #   Micro::Struct.new(:first_name, :last_name, ...)
   #
-  # Use the `_optional:` arg if you want some optional attributes.
+  # Use the `optional:` arg if you want some optional attributes.
   #
-  #   Micro::Struct.new(:first_name, :last_name, _optional: :gender)
+  #   Micro::Struct.new(:first_name, :last_name, optional: :gender)
   #
-  # Using `_optional:` to define all attributes are optional.
+  # Using `optional:` to define all attributes are optional.
   #
-  #   Micro::Struct.new(_optional: [:first_name, :last_name])
+  #   Micro::Struct.new(optional: [:first_name, :last_name])
+  #
+  # Use the `required:` arg to define required attributes.
+  #
+  #   Micro::Struct.new(
+  #     required: [:first_name, :last_name],
+  #     optional: [:gender, :age]
+  #   )
   #
   # You can also pass a block to define custom methods.
   #
@@ -34,21 +41,24 @@ module Micro
   #
   # All of the possible combinations to create a Ruby Struct. ;)
   #
-  #   Micro::Struct.new(*required)
-  #   Micro::Struct.new(*required) {}
+  #   Micro::Struct.new(optional: *)
+  #   Micro::Struct.new(optional: *) {}
+  #
+  #   Micro::Struct.new(required: *)
+  #   Micro::Struct.new(required: *) {}
   #
-  #   Micro::Struct.new(_optional: *)
-  #   Micro::Struct.new(_optional: *) {}
+  #   Micro::Struct.new(*required, optional: *)
+  #   Micro::Struct.new(*required, optional: *) {}
   #
-  #   Micro::Struct.new(*required, _optional: *)
-  #   Micro::Struct.new(*required, _optional: *) {}
+  #   Micro::Struct.new(required: *, optional: *)
+  #   Micro::Struct.new(required: *, optional: *) {}
   #
   # Any options above can be used by the `.new()` method of the struct creator returned by the `.with()` method.
   #
   #   Micro::Struct.with(*features).new(...) {}
   module Struct
-    def self.new(*members, _optional: nil, &block)
-      with.new(*members, _optional: _optional, &block)
+    def self.new(*members, required: nil, optional: nil, &block)
+      with.new(*members, required: required, optional: optional, &block)
     end
 
     def self.with(*features)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: u-struct
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Rodrigo Serradura
@@ -60,7 +60,7 @@ files:
 - lib/micro/struct/creator/create_module.rb
 - lib/micro/struct/creator/create_struct.rb
 - lib/micro/struct/features.rb
-- lib/micro/struct/validate.rb
+- lib/micro/struct/normalize_names.rb
 - lib/micro/struct/version.rb
 - lib/u-struct.rb
 - u-struct.gemspec

data/lib/micro/struct/validate.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Micro::Struct
-  module Validate
-    module Names
-      REGEXP = /\A[_A-Za-z]\w*\z/.freeze
-      Invalid = ->(label, val) { raise NameError.new("invalid #{label} name: #{val}") }
-      AsSymbol = ->(label, val) { REGEXP =~ val ? val.to_sym : Invalid[label, val] }.curry
-
-      def self.call(values, label:)
-        Array(values).map(&Names::AsSymbol[label])
-      end
-    end
-  end
-
-  private_constant :Validate
-end