shale-builder 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7749b75b69a25526581d8b071fd93b44a7b6d9cc1a953fec8fbb0815fe3d86a
-  data.tar.gz: 30ce0be01b5290da4a5960c1993f3372edc251209477205fcedeb0cc0f4fabd9
+  metadata.gz: 5173a85d5d039ce2e3207ce624bd40d15eea0910f4ee07d24bafa0a73306e6ae
+  data.tar.gz: 9a703d6acb6d821a57254bca2af2716ead533d650a74d3e6b87e09a18fb380b2
 SHA512:
-  metadata.gz: 5f846398c26ed0afa0641bb9a912f357d446082ff11d71b738027916c4af16561f8767898d002b3f8af5396fe5f47d1ba31dc6bb3f75e22d847ae41e432ab337
-  data.tar.gz: 960fa9d1138ce59b5d859659b5aa713f263831328105d73ee403a631a4fbfe1c3ea34c758a4cecd10d9b01ab5d16db3016aecd2abe6960e3c0ca71cecb095915
+  metadata.gz: db1d70904eb858eb841b10373ae2c14889552eeda5764785d70c8e430955e659c259ca91499a772a885653201526f2e229b11dcd4ce0d4449217d7c77b83b1e1
+  data.tar.gz: e5e744a3a88ad1feb0a0f8606392403d8b2c15a06d9d5e133bea8d8c8e8c4eacc4edf204f4f2677044ff12980340ccadc9d8f94949f51819fab7e29f2ea5eb86

data/.rubocop.yml

@@ -2,4 +2,4 @@ inherit_gem:
   rubocop-espago: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-## [Unreleased]
+## [0.1.2] - 2023-10-11
+
+- Add support for collections
+- Drop support for Ruby 2.7
+
+## [0.1.1] - 2023-02-22
+
+- Add support for inheritance
 
 ## [0.1.0] - 2023-02-21
 

data/Gemfile

@@ -5,6 +5,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in diggable.gemspec
 gemspec
 
+gem 'byebug', '~> 11.1' # debugger
 gem 'minitest', '~> 5.0' # test framework
 gem 'rake', '~> 13.0' # automation tasks
 gem 'rubocop-espago', '~> 1.0' # ruby linter

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shale-builder (0.1.0)
+    shale-builder (0.1.2)
       shale (< 1.0)
 
 GEM
@@ -10,6 +10,7 @@ GEM
     ast (2.4.2)
     backport (1.2.0)
     benchmark (0.2.1)
+    byebug (11.1.3)
     diff-lcs (1.5.0)
     e2mmap (0.1.0)
     jaro_winkler (1.5.4)
@@ -77,6 +78,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  byebug (~> 11.1)
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop-espago (~> 1.0)

data/README.md

@@ -90,7 +90,7 @@ class PaymentInstrument < Shale::Mapper
     attribute :expiration_month, ::Shale::Type::Integer
 end
 
-class Transaction < ::Shale::Mapper
+class Transaction < Shale::Mapper
     include Shale::Builder
 
     attribute :cvv_code, Shale::Type::String
@@ -142,6 +142,52 @@ non-primitive types have been overridden to accept blocks.
 When a block is given to such a getter, it instantiates an empty object
 of its type and yields it to the block.
 
+### Collections
+
+Whenever you call a getter with a block for a collection attribute, the built object will be appended to the array.
+
+Let's define a schema like this.
+
+```rb
+class Client < Shale::Mapper
+    include Shale::Builder
+
+    attribute :first_name, Shale::Type::String
+    attribute :last_name, Shale::Type::String
+    attribute :email, Shale::Type::String
+end
+
+class Transaction < Shale::Mapper
+    include Shale::Builder
+
+    attribute :clients, Client, collection: true
+end
+```
+
+You can easily build add new clients to the collection like so:
+
+```rb
+transaction = Transaction.build do |t|
+  # this will be added as the first element of the collection
+  t.clients do |c|
+    c.first_name = 'Foo'
+    c.last_name = 'Bar'
+  end
+
+  # this will be added as the second element of the collection
+  t.clients do |c|
+    c.first_name = 'Grant'
+    c.last_name = 'Taylor'
+  end
+end
+
+p transaction.clients
+# [
+#    #<Client:0x00000001066c2828 @first_name="Foo", @last_name="Bar", @email=nil>,
+#    #<Client:0x00000001066c24b8 @first_name="Grant", @last_name="Taylor", @email=nil>
+# ]
+```
+
 ### Conditional building
 
 This DSL makes it extremely easy to build nested

data/lib/shale/builder/version.rb

@@ -3,6 +3,6 @@
 module Shale
   module Builder
     # @return [String]
-    VERSION = '0.1.0'
+    VERSION = '0.1.2'
   end
 end

data/lib/shale/builder.rb

@@ -38,11 +38,21 @@ module Shale
   #
   module Builder
     class << self
-      # Gets called after including this module.
+      # Gets called after including this module in a module or class.
       #
-      # @param mod [Module]
+      # @param mod [Module, Class]
+      # @return [void]
       def included(mod)
         mod.extend ClassMethods
+        Builder.prepare_mod(mod)
+      end
+
+      # Prepares the received module or class
+      # for dynamic method definition.
+      #
+      # @param mod [Module, Class]
+      # @return [void]
+      def prepare_mod(mod)
         builder_methods_module = ::Module.new
         mod.instance_variable_set :@builder_methods_module, builder_methods_module
         mod.include builder_methods_module
@@ -51,6 +61,13 @@ module Shale
 
     # Class methods provided by `Shale::Builder`
     module ClassMethods
+      # @param subclass [Class]
+      # @return [void]
+      def inherited(subclass)
+        super
+        Builder.prepare_mod(subclass)
+      end
+
       # Contains overridden getter methods for attributes
       # with complex types (so that they accept a block for building)
       #
@@ -72,10 +89,25 @@ module Shale
       # @param name [String, Symbol]
       # @param type [Class]
       # @return [void]
-      def attribute(name, type, *args, **kwargs, &block)
+      def attribute(name, type, *args, collection: false, **kwargs, &block)
         super
         return unless type < ::Shale::Mapper
 
+        if collection
+          @builder_methods_module.class_eval <<~RUBY, __FILE__, __LINE__ + 1
+            def #{name}                           # def clients
+              return super unless block_given?    #   return super unless block_given?
+                                                  #
+              arr = self.#{name} ||= []           #   arr = self.clients ||= []
+              object = #{type}.new                #   object = Client.new
+              yield(object)                       #   yield(object)
+              arr << object                       #   arr << object
+              object                              #   object
+            end                                   # end
+          RUBY
+          return
+        end
+
         @builder_methods_module.class_eval <<~RUBY, __FILE__, __LINE__ + 1
           def #{name}                                   # def amount
             return super unless block_given?            #   return super unless block_given?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shale-builder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Mateusz Drewniak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shale
@@ -49,6 +49,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/Verseth/ruby-shale-builder
   source_code_uri: https://github.com/Verseth/ruby-shale-builder
+  changelog_uri: https://github.com/Verseth/ruby-shale-builder/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -58,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="