trinkets 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '018b1a7eeedc27c57853bd408ac7b698f1573f7b2646c7fdb8f36e2dce2b0add'
-  data.tar.gz: 50d9ec8927e0f127c17a410148c923e382b2749afe5ba87f13ef6d518349ecd4
+  metadata.gz: 1b95bff0eaa948f0edc0375709fd3ec786ad10e970f5b5abcd501247dceb1e74
+  data.tar.gz: 3d4d1bce01e034167209cad41d9bf4ad356d79ddf100cfc1968d16b9686a06f9
 SHA512:
-  metadata.gz: 73b50ad1d15f661512a2c1b230b993b6d4a9a56d5a8a72ebc9a7cd9cfe03989bd32897131f1991a071daaac50fdad2eaf8fb0cbfd4dd60430ea6de74c3cddbcc
-  data.tar.gz: 8643d7e712ef9798b459cb9dc28f35e72f4dc80215e2b860c7a23a06a4c029dac83d7271324f2605d6812d30c40ad96032d348fca2c1eeb62812c7923666e81f
+  metadata.gz: 5b3a7cc743fae16ee12cfab9d9efc4236b31d69d8a570fe1bbf009cc3558be08d3cef3a38aa110403fb40dea019a3236adbf4a00c983c5f1f4e148a909bfb884
+  data.tar.gz: e94881a3dc54ca93be7ea759b0b6aff8607b9d91d7d1247d3ec2f59d265ecb2ea4c7f014754ca9a4a351ee6994eabb2fcae0e93fe0d14d27a46b01985370c3f6

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 
+### [0.4.0](https://github.com/SilverPhoenix99/trinkets/tree/v0.4.0)
+* `Class::init`: Allow default values for keyword arguments.
+ 
+### [0.3.1](https://github.com/SilverPhoenix99/trinkets/tree/v0.3.1)
+* Fixed repeated arguments in `Class::init`.
+
 ### [0.3.0](https://github.com/SilverPhoenix99/trinkets/tree/v0.3.0)
 * Restructured folders to default to `/refine/`.
 * Added `Enumerable#each_with_hash`/`Enumerator#with_hash`.

data/README.md

@@ -4,10 +4,16 @@ It's the bootleg [facets](https://github.com/rubyworks/facets?tab=readme-ov-file
 
 ## Installation
 
+### RubyGems
 ```
 gem install trinkets
 ```
 
+### Bundler
+```ruby
+gem 'trinkets', require: false
+```
+
 ## Usage
 
 The trinkets are loaded with the following structure:
@@ -34,7 +40,7 @@ The `refine` subdirectory is the default, and it can be omitted from `require`.
 require 'trinkets/refine/class/init'
 ```
 
-### Extend
+### Extend / Include
 
 ```ruby
 require 'trinkets/extend/class/init'
@@ -44,6 +50,15 @@ class Test
 end
 ```
 
+```ruby
+require 'trinkets/include/enumerable/each_with_hash'
+
+class Test
+  include Enumerable
+  include ::Trinkets::Enumerable::WithHash
+end
+```
+
 ### Mokey Patching
 
 ```ruby

data/doc/class/init.md

@@ -9,6 +9,10 @@ To use it, define a class and call `::init` like you would call `::attr` methods
     * can be `:accessor`, `:reader`, `:writer` or `:none` 
     * defaults to `:accessor`
   * `kw` : if arguments are to be set as keyword arguments
+    * when `false`, it's a mandatory positional argument
+    * when `true`, it becomes a mandatory keyword argument, like `(a:)`
+    * when it's a hash, like `{ default: <VALUE> }`, it's an optional keyword argument
+    * an empty hash `{}` is equivalent to `{ default: nil }`
     * defaults to `false`
 
 The same options can be used per individual argument.
@@ -147,6 +151,33 @@ test.a = 5
 # => raises NoMethodError
 ```
 
+## Default values for keyword arguments
+
+```ruby
+class TestDefaultKw
+  init [:a, kw: true],
+       :b,
+       kw: {default: 3}
+end
+
+# would be the same as
+class TestDefaultKw
+  attr_accessor :a, :b
+  def initialize(a: , b: 3)
+    @a = a
+    @b = b
+  end
+end
+
+test = TestDefaultKw.new(a: 2)
+
+test.a
+# 2
+
+test.b
+# 3
+``` 
+
 ## Mixed together
 ```ruby
 class TestMixed

data/lib/explicit/trinkets/extend/class/init.rb

@@ -6,22 +6,9 @@ module Trinkets
       ATTR = %i[accessor reader writer none].freeze
 
       def init(*attrs, attr: ATTR.first, kw: false)
-        raise ArgumentError, 'At least 1 attribute is required.' if attrs.empty?
-        raise ArgumentError, '`attr` must be one of :accessor (default), :reader, :writer or :none' unless ATTR.include?(attr)
-
-        default_attr_options = { attr: attr, kw: kw }
-
-        # Normalize attrs into a hash: { :name => **options }
-        # @type [Hash[Symbol, Hash]]
-        attrs = attrs.map { |a| [*a] }
-          .map { |a| a.size == 1 ? a << {} : a }
-          .each_with_object({}) do |(name, opts), h|
-            # name, opts = a
-            name = name.to_s.sub(/^@/, '').to_sym
-            opts = default_attr_options.merge(opts)
-            h[name] = opts
-          end
+        attrs = Init.send(:sanitize_attrs, attrs, attr: attr, kw: kw)
 
+        # @type [Hash[Symbol, Method]]
         attr_methods = (ATTR - [:none])
           .each_with_object({}) do |name, h|
             h[name] = method("attr_#{name}")
@@ -30,57 +17,98 @@ module Trinkets
         # even though options like `kw` aren't used, they serve here to validate the `attrs` options
         attr_init = ->(name, attr: ATTR.first, kw: false) do
           unless ATTR.include?(attr)
-            raise ArgumentError, "attr `#{name}`, option attr` must be one of :accessor (default), :reader, :writer or :none"
+            raise ArgumentError, "wrong `attr` type for `#{name.inspect}` (given #{attr.inspect}, expected :accessor (default), :reader, :writer or :none)"
           end
           attr_methods[attr].call(name) unless attr == :none
         end
 
         attrs.each { |name, opts| attr_init.call(name, **opts) }
 
-        # 2 hashes: { :name => bool }
-        kw_attrs, attrs = attrs
-          .map  { |name, opts| [name, opts[:kw]] }
-          .partition { |_, kw_opt| kw_opt }
-          .map(&:to_h)
-
-        init_method = ::Trinkets::Class.send :define_initialize, attrs, kw_attrs
+        # hash with 3 keys: {
+        #   FalseClass => []  # positional args
+        #   TrueClass  => []  # mandatory kw args
+        #   Hash       => []  # optional kw args with default value
+        # }
+        grouped_params = attrs
+          .map { |name, opts| [name, opts[:kw] || false] }
+          .group_by { _1.last.class }
+
+        pos_params    = [*grouped_params[FalseClass]].map(&:first)
+        kw_params     = [*grouped_params[TrueClass]].map(&:first)
+        opt_kw_params = [*grouped_params[Hash]].to_h
+          .transform_values! { _1[:default] }
+
+        init_method = Init.send(:define_initialize, pos_params, kw_params, opt_kw_params)
         define_method :initialize, init_method
       end
-    end
 
-    class << self
-      # @param [Hash[Symbol  Boolean]] attrs
-      # @param [Hash[Symbol  Boolean]] kw_attrs
-      private def define_initialize(attrs, kw_attrs)
-        ->(*values, **kw_values) do
+      class << self
+        private def sanitize_attrs(attrs, **default_options)
 
-          unless attrs.size == values.size
-            raise ArgumentError, "wrong number of arguments (given #{values.size}, expected #{attrs.size})"
-          end
+          raise ArgumentError, 'At least 1 attribute is required.' if attrs.empty?
 
-          missing_keys = kw_attrs.except(*kw_values.keys)
-          unless missing_keys.empty?
-            missing_keys = missing_keys.keys.map(&:inspect).join(', ')
-            raise ArgumentError, "missing keywords: #{missing_keys}"
+          unless ::Trinkets::Class::Init::ATTR.include?(default_options[:attr])
+            attr = default_options[:attr].inspect
+            raise ArgumentError, "wrong `attr` type (given #{attr}, expected :accessor (default), :reader, :writer or :none)"
           end
 
-          unknown_keywords = kw_values.except(*kw_attrs.keys)
-          unless unknown_keywords.empty?
-            unknown_keywords = unknown_keywords.keys.map(&:to_sym).map(&:inspect).join(', ')
-            raise ArgumentError, "unknown keywords: #{unknown_keywords}"
+          # Normalize attrs into an array: [[:name, **options], ...]
+          # @type [Array[Array[Symbol, Hash]]]
+          attrs = attrs.map do |a|
+            name, opts = [*a]
+            name = name.to_s.sub(/^@/, '').to_sym
+            opts = default_options.merge(opts || {})
+            [name, opts]
           end
 
-          attrs.keys.zip(values).each do |name, value|
-            instance_variable_set "@#{name}", value
-          end
+          repeated_attrs = attrs.map(&:first)
+            .tally
+            .select { |_, count| count > 1 }
+            .keys
 
-          kw_values.each do |name, value|
-            instance_variable_set "@#{name}", value
-          end
+          raise ArgumentError, "duplicated argument names: #{repeated_attrs.join(', ')}" if repeated_attrs.any?
 
+          attrs.to_h
+        end
+
+        # @param [Array[Symbol]] pos_params
+        # @param [Array[Symbol]] kw_params
+        # @param [Hash[Symbol, Object]] opt_kw_params
+        private def define_initialize(pos_params, kw_params, opt_kw_params)
+          ->(*values, **kw_values) do
+
+            unless pos_params.size == values.size
+              raise ArgumentError, "wrong number of arguments (given #{values.size}, expected #{pos_params.size})"
+            end
+
+            missing_keys = kw_params - kw_values.keys
+            unless missing_keys.empty?
+              missing_keys = missing_keys.map(&:inspect).join(', ')
+              raise ArgumentError, "missing keywords: #{missing_keys}"
+            end
+
+            unknown_keywords = kw_values.except(*kw_params, *opt_kw_params.keys)
+            unless unknown_keywords.empty?
+              unknown_keywords = unknown_keywords.keys.map(&:to_sym).map(&:inspect).join(', ')
+              raise ArgumentError, "unknown keywords: #{unknown_keywords}"
+            end
+
+            pos_params.zip(values).each do |name, value|
+              instance_variable_set "@#{name}", value
+            end
+
+            kw_params.each do |name|
+              instance_variable_set "@#{name}", kw_values[name]
+            end
+
+            opt_kw_params.each do |name, default_value|
+              value = kw_values.include?(name) ? kw_values[name] : default_value
+              instance_variable_set "@#{name}", value
+            end
+
+          end
         end
       end
     end
-
   end
 end

data/lib/trinkets/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Trinkets
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trinkets
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - SilverPhoenix99
@@ -9,8 +9,36 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-03 00:00:00.000000000 Z
-dependencies: []
+date: 2024-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
 description: Truly outrageous bootleg facets in your trinkets box.
 email:
 - antoniopedrosilvapinto@gmail.com
@@ -37,7 +65,10 @@ homepage: https://github.com/SilverPhoenix99/trinkets
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/SilverPhoenix99/trinkets
+  source_code_uri: https://github.com/SilverPhoenix99/trinkets
+  changelog_uri: https://github.com/SilverPhoenix99/trinkets/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/SilverPhoenix99/trinkets/issues
+  documentation_uri: https://github.com/SilverPhoenix99/trinkets/blob/master/README.md
 post_install_message:
 rdoc_options: []
 require_paths: