shale-builder 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d245e494eafdbe7a026e2f9201840f844b2e351dfdf3168632bfd825d0d1bbb
-  data.tar.gz: db76f630562faabca941d8522fbe1deb3cd59abcb0664e7843e295e3b22435bd
+  metadata.gz: 4b0eb2f219fcd64c0f89f347f70e892e96f7b18490450a42557a39525e14fabe
+  data.tar.gz: c1f7b8a45efd094bc4f43028e56eae5d0da322357bbf0d6c1e882021a8da92e6
 SHA512:
-  metadata.gz: 67fb45e984b9c75e111f3a13aea88e5f6cb225de1d62a5e3e5bdc6c414b15cbc601d294b40e59a127b8861c2f8031ddf3da3377597acecf0dc33a2789b48d20c
-  data.tar.gz: d02c3045bd8cdba9d08ec65fc2a7014da13ece5c8c5803e2970d97fcf1c53415c3d91ac4258556232aaad56eb5d87512f2a2f530168467fa67d7598da9070ef8
+  metadata.gz: c02cb9e08061c9d978f2e64be2ede31a3a874cc4b5f9e420f00bfe39771e69d48930fd6c063d7a8d6d066a8a3bfcd3faf7c2e58983d081d1ee852c8a2d59c377
+  data.tar.gz: 69bd7e9e44ae49c0f9bc2a7c19b5b7472d28a56c841b215b8a4be2bbd49dc42f99b3b43bd2d782a87b86a93d1534957af4356184a9e50926ee423b8277ef4bac

data/.rubocop.yml

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

data/.ruby-version

@@ -1 +1 @@
-3.2.1
+3.2.2

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-## [Unreleased]
+## [0.1.3] - 2023-11-23
+
+- Change shale version dependency from `< 1.0` to `< 2.0`
+
+## [0.1.2] - 2023-10-11
+
+- Add support for collections
+- Drop support for Ruby 2.7
 
 ## [0.1.1] - 2023-02-22
 

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,8 +1,8 @@
 PATH
   remote: .
   specs:
-    shale-builder (0.1.1)
-      shale (< 1.0)
+    shale-builder (0.1.3)
+      shale (< 2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -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)
@@ -74,9 +75,11 @@ GEM
 
 PLATFORMS
   arm64-darwin-20
+  arm64-darwin-22
   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.1'
+    VERSION = '0.1.3'
   end
 end

data/lib/shale/builder.rb

@@ -89,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.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Mateusz Drewniak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-22 00:00:00.000000000 Z
+date: 2023-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shale
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 description: An addon to the shale Ruby gem which adds a simple yet powerful builder
   DSL.
 email:
@@ -59,14 +59,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: An addon to the shale Ruby gem which adds a simple yet powerful builder DSL.