u-struct 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ebbd60464f2e2d2efd428b0091d68820ef2b5d1a4bc73bed1a474d22f2f0fac
-  data.tar.gz: 1965a2b7bd8da50c6c5c31acff5c950590146c060ced14e732d3a5b646dafd8f
+  metadata.gz: 393ba5215b21bf91ef0229de920ca0980c44168fcc0e65d539a0f6b4f6a7caa2
+  data.tar.gz: e1ad5cfbd6215982aa8f6e5708d4a6f8cea0a046da9ad82568d0ed8136d58629
 SHA512:
-  metadata.gz: b7274b8401d134cc21408447b87a54472f5f5cdea5263c3ca24e1a4feab6c0104deea8ff1985edb49a3e58d6e91e27f52b908d6fa2974b26ed6472916ebc4cb9
-  data.tar.gz: 62238f702e13aaa61d13bcb6213819d79b67e373b3f768cf0675526baa7bf73aa7d1e6c8130d84072f8a6a124923de28318b34b2a44ae17b0de573513c557acf
+  metadata.gz: 2d86bb3a75737927e5f74d56e16c7760b8c7b9c3dce7642ebdef058122212dd21c38aec04573722842ea081995b5e03c6a094a1548bf63f1ed709762c6e5ad2c
+  data.tar.gz: 6dee9c1ab9cd6ba5675cf7c1e6cedc128e70fe45aabf52a2b1beb77fb63e9b01c1d70b0775b4393167132371923b5d56a2efed099048e0e3e594b5c199d95ab3

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 ## [Unreleased]
 
+## [0.5.0] - 2021-12-03
+
+- To-do
+
+## [0.4.0] - 2021-12-03
+
+- To-do
+
+## [0.3.1] - 2021-12-02
+
+- To-do
+
+## [0.3.0] - 2021-12-02
+
+- To-do
+
+## [0.2.0] - 2021-12-02
+
+- To-do
+
 ## [0.1.0] - 2021-12-02
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    u-struct (0.4.0)
+    u-struct (0.5.0)
 
 GEM
   remote: https://rubygems.org/
@@ -19,4 +19,4 @@ DEPENDENCIES
   u-struct!
 
 BUNDLED WITH
-   2.2.26
+   2.2.32

data/README.md

@@ -1,8 +1,6 @@
 # Micro::Struct
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/micro/struct`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Create powered Ruby structs.
 
 ## Installation
 
@@ -22,7 +20,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# Like in a regular Struct, you can define one or many attributes.
+Micro::Struct.new(:first_name, :last_name, ...)
+
+# You can also pass a block to define custom methods.
+Micro::Struct.new(:name) {}
+
+# Available features (use one, many or all):
+#   .with(:to_ary, :to_hash, :to_proc, :readonly, :instance_copy)
+
+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(...).new(...) {}
+```
 
 ## Development
 

data/lib/micro/struct/version.rb

@@ -2,6 +2,6 @@
 
 module Micro
   module Struct
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

data/lib/micro/struct.rb

@@ -3,29 +3,37 @@
 require_relative 'struct/version'
 
 module Micro
-  # Micro::Struct.new(:first_name, :last_name, ...)
+  # Like in a regular Struct, you can define one or many attributes.
+  #   Micro::Struct.new(:first_name, :last_name, ...)
   #
-  # Micro::Struct.with(:to_ary).new(:name) # or .with(:to_hash), .with(:to_proc)
+  # You can also pass a block to define custom methods.
+  #   Micro::Struct.new(:name) {}
   #
-  # Micro::Struct.with(:to_ary, :to_hash).new(:name)
+  # Available features (use one, many or all):
+  # .with(:to_ary, :to_hash, :to_proc, :readonly, :instance_copy)
   #
-  # Micro::Struct.with(:to_ary, :to_hash, :to_proc).new(:name)
+  #   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.new(:name) {}
-  #
-  # Micro::Struct.with(...).new(:name) {}
+  #   Micro::Struct.with(...).new(...) {}
   module Struct
     class Creator
       module Features
         DISABLED =
           { to_ary: false,
             to_hash: false,
-            to_proc: false }.freeze
+            to_proc: false,
+            readonly: false,
+            instance_copy: false
+          }.freeze
 
-        Expose = ->(to_ary:, to_hash:, to_proc:) do
+        Expose = ->(to_ary:, to_hash:, to_proc:, readonly:, instance_copy:) do
           { to_ary: to_ary,
             to_hash: to_hash,
-            to_proc: to_proc }
+            to_proc: to_proc,
+            readonly: readonly,
+            instance_copy: instance_copy }
         end
 
         def self.check(names)
@@ -41,35 +49,40 @@ module Micro
       end
 
       def new(*members, &block)
-        def_module do |mod|
-          def_struct(mod, members, block) do |struct|
-            def_initialize(mod, struct)
+        def_container do |container|
+          def_struct(container, members, block) do |struct|
+            def_initialize(container, struct)
+
             def_to_ary(struct)
             def_to_hash(struct)
-            def_to_proc(mod)
+            def_readonly(struct)
+            def_instance_copy(struct)
           end
+
+          def_to_proc(container)
         end
       end
 
       private
 
-      def def_module(&block)
+      def def_container(&block)
         Module.new.tap(&block)
       end
 
-      def def_struct(mod, members, block)
+      def def_struct(container, members, block)
         struct = ::Struct.new(*members, &block)
+        struct.const_set(:Container, container)
         struct.send(:private_class_method, :new)
 
-        mod.const_set(:Struct, struct)
+        container.const_set(:Struct, struct)
 
         yield struct
       end
 
-      def def_initialize(mod, struct)
+      def def_initialize(container, struct)
         # The .new() method will require all of the Struct's keyword arguments.
         # We are doing this because Struct's keyword_init option doesn't do that.
-        mod.module_eval(<<~RUBY, __FILE__, __LINE__ + 1)    #
+        container.module_eval(<<~RUBY, __FILE__, __LINE__ + 1)    #
           def self.new(#{struct.members.join(':, ')}:)      # def self.new(a:, b:) do
             Struct.send(:new, #{struct.members.join(', ')}) #   Struct.send(:new, a, b)
           end                                               # end
@@ -88,10 +101,26 @@ module Micro
         struct.send(:alias_method, :to_hash, :to_h) if @features[:to_hash]
       end
 
-      def def_to_proc(mod)
+      def def_readonly(struct)
+        return unless @features[:readonly]
+
+        struct.send(:private, *struct.members.map { |member| "#{member}=" })
+      end
+
+      def def_instance_copy(struct)
+        return unless (@features[:readonly] || @features[:instance_copy])
+
+        struct.class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+          def with(**members)
+            self.class.const_get(:Container, false).new(**to_h.merge(members))
+          end
+        RUBY
+      end
+
+      def def_to_proc(container)
         return unless @features[:to_proc]
 
-        mod.module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+        container.module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
           def self.to_proc
             ->(hash) { new(**hash) }
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: u-struct
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Rodrigo Serradura