shale-builder 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a79ea1df97f6d5d49af0d596144d931b5aacea98e142866d7e322497fbeaae5
-  data.tar.gz: 59f671f470be89ed4854798843657160c87163de286a867be73c4832bb4a2df2
+  metadata.gz: 5129b4e45147ec672d0e23aaf17ad57290bdc9f1f4a81b9d1756ebd44a738df3
+  data.tar.gz: 0e47f511519fe4003622c862799ccd34e51bf61bba7bbce3ca6d8e81bdac95d8
 SHA512:
-  metadata.gz: f763a5973d2d15c2a2c314ae61ed61f7455724f624f38852f8cd4d174fe2bf12af7bee2eb37a847b5940f9779fa4ad2960eff6a99259c12d0445d16fb63b8775
-  data.tar.gz: e872ffe315cec734fa77af67b1be80efded4b750194e66c2e41d069302b5dc18cc4bd0f3da2932528661cc2fa1d84ff90a08f3326c7052a65030987f5c4685eb
+  metadata.gz: 4682a5bf3469eec462ad9a191434bb761c633cf21117e2443dba85cefc4a2e2641104c4966cd113d76200b95954206b3292fc1182836b550a085cf4d144625c6
+  data.tar.gz: 349e8086105a41ee0b5decb2ebbedcb810f7a331ae8b0e2b6a1bdab051eeafb9939e5d36f7d4b841062d7eab3269f85fb0b07d77eb63d3abfdae24ea9b774b7d

data/CHANGELOG.md

@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.1] - 2025-10-15
+
+[Diff](https://github.com/Verseth/ruby-shale-builder/compare/v0.5.0...v0.5.1)
+
+### Changes
+- Add `return_type` and `setter_type` overrides per attribute
+
+## [0.5.0] - 2025-10-15
+
+[Diff](https://github.com/Verseth/ruby-shale-builder/compare/v0.4.1...v0.5.0)
+
+### Changes
+- Add `Shale::Builder::AssignedAttributes` module which grants a shale mapper class with the ability to record which attributes have been assigned
+- Add `Shale::Builder::Value` which represents a value of a shale attribute.
+- Add `Shale::Builder#attribute_values`, a method that returns an array of `Shale::Builder::Value` objects for each attribute.
+
 ## [0.4.1] - 2025-10-14
 
 [Diff](https://github.com/Verseth/ruby-shale-builder/compare/v0.4.0...v0.4.1)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shale-builder (0.4.1)
+    shale-builder (0.5.1)
       booleans (>= 0.1)
       shale (< 2.0)
       sorbet-runtime (> 0.5)

data/README.md

@@ -263,6 +263,41 @@ obj.errors.messages #=> {cvv_code: ["can't be blank"], "amount.value": ["can't b
 
 You MUST include `ActiveModel::Validations` before `Shale::Builder::NestedValidations`.
 
+### Recording Assigned Attributes
+
+There is an additional module `Shale::Builder::AssignedAttributes` that provides
+support for recording which attributes have been assigned in a shale mapper object.
+
+In order to load it do:
+
+```rb
+require 'shale/builder/assigned_attributes'
+```
+
+Then you can use it like so
+
+```rb
+class AmountType < ::Shale::Mapper
+    include ::Shale::Builder
+    include ::Shale::Builder::AssignedAttributes
+
+    attribute :value, ::Shale::Type::Float
+    attribute :currency, ::Shale::Type::String
+end
+
+obj = AmountType.new
+obj.assigned_attribute_names #=> #<Set: {}>
+
+obj.value = 3
+obj.assigned_attribute_names #=> #<Set: {:value}>
+obj.assigned_attributes #=> [#<Shale::Attribute:0x000000011e959b50 @collection=false, @default=nil, @doc=nil, @name=:value, @setter="value=", @type=Shale::Type::Float>]
+obj.assigned_values #=> [#<Shale::Builder::Value:0x000000011d693318 @attribute=#<Shale::Attribute:0x000000011e959b50 @collection=false, @default=nil, @doc=nil, @name=:value, @setter="value=", @type=Shale::Type::Float>, @value=3.0>]
+```
+
+- `assigned_attribute_names` returns a set of attribute names
+- `assigned_attributes` returns an array of attribute definitions
+- `assigned_values` returns an array of `Shale::Builder::Value`, which contains the current value of an attribute and a reference to its definition
+
 ### Attribute aliases
 
 You can easily create aliases for attributes using `alias_attribute`

data/lib/shale/attribute.rb

@@ -7,17 +7,23 @@ module Shale
   class Attribute # rubocop:disable Style/Documentation
     extend T::Sig
 
+    #: untyped
+    attr_accessor :setter_type
+
+    #: untyped
+    attr_accessor :return_type
+
     # Contains the documentation comment for the shale attribute
     # in a Ruby String.
-    sig { returns(T.nilable(String)) }
+    #: String?
     attr_accessor :doc
 
     # Contains the documentation comment for the shale attribute
     # in a Ruby String.
-    sig { returns(T.nilable(T::Array[Symbol])) }
+    #: Array[Symbol]?
     attr_accessor :aliases
 
-    sig { returns(T::Array[Symbol]) }
+    #: -> Array[Symbol]
     def all_names
       names = [name]
       aliases = self.aliases
@@ -25,5 +31,12 @@ module Shale
 
       names + aliases
     end
+
+    # Returns `true` if the attribute is handled by a shale mapper.
+    #
+    #: -> bool
+    def mapper?
+      type.is_a?(Class) && type < Shale::Mapper
+    end
   end
 end

data/lib/shale/builder/assigned_attributes.rb

@@ -0,0 +1,94 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'shale'
+require 'booleans'
+
+module Shale
+  module Builder
+    # Include in a class that already includes `Shale::Builder` to add support
+    # for getting a list of attributes that have been assigned.
+    #
+    # @requires_ancestor: Object
+    module AssignedAttributes
+      extend T::Sig
+      extend T::Helpers
+
+      class << self
+        extend T::Sig
+
+        # Gets called after including this module in a module or class.
+        #: (Module mod) -> void
+        def included(mod)
+          mod.extend ClassMethods
+          AssignedAttributes.prepare_mod(mod)
+        end
+
+        # Prepares the received module or class
+        # for dynamic method definition.
+        #: (Module mod) -> void
+        def prepare_mod(mod)
+          assigned_attributes_methods_module = ::Module.new
+          mod.instance_variable_set :@assigned_attributes_methods_module, assigned_attributes_methods_module
+          mod.include assigned_attributes_methods_module
+        end
+      end
+
+      # @requires_ancestor: singleton(Shale::Mapper)
+      module ClassMethods
+        extend T::Sig
+
+        # Contains overridden getter methods for attributes
+        # with complex types (so that they accept a block for building)
+        #: Module
+        attr_reader :assigned_attributes_methods_module
+
+        #: (String | Symbol name, Class type, ?collection: bool, ?default: Proc?, ?doc: String?, **untyped kwargs) ?{ -> void } -> void
+        def attribute(name, type, collection: false, default: nil, doc: nil, **kwargs, &block)
+          super
+
+          @assigned_attributes_methods_module.class_eval <<~RUBY, __FILE__, __LINE__ + 1
+            def #{name}=(val)
+              super
+              return unless @__initialized
+
+              self.assigned_attribute_names << #{name.to_sym.inspect}
+            end
+          RUBY
+        end
+      end
+      mixes_in_class_methods ClassMethods
+
+      # Returns a set of names of assigned shale attributes.
+      #
+      #: -> Set[Symbol]
+      def assigned_attribute_names
+        @assigned_attribute_names ||= Set.new
+      end
+
+      # Returns an array of shale attributes
+      # that have been assigned.
+      #
+      #: -> Array[Shale::Attribute]
+      def assigned_attributes
+        klass = self.class #: as untyped
+        assigned_attribute_names.map do |name|
+          klass.attributes.fetch(name)
+        end
+      end
+
+      # Returns an array of shale values
+      # that have been assigned.
+      #
+      #: -> Array[Shale::Builder::Value]
+      def assigned_values
+        klass = self.class #: as untyped
+        assigned_attribute_names.map do |name|
+          attr = klass.attributes.fetch(name)
+          Shale::Builder::Value.new(attr, public_send(attr.name))
+        end
+      end
+
+    end
+  end
+end

data/lib/shale/builder/nested_validations.rb

@@ -6,7 +6,7 @@ require 'booleans'
 
 module Shale
   module Builder
-    # Include in a class tha already includes `Shale::Builder` to add support
+    # Include in a class that already includes `Shale::Builder` to add support
     # for nested ActiveModel validations.
     #
     # @requires_ancestor: Object

data/lib/shale/builder/value.rb

@@ -0,0 +1,30 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'shale'
+
+module Shale
+  module Builder
+    # Represents a value of a particular shale attribute.
+    # Hold the value and a reference to the attribute definition.
+    class Value
+      extend T::Sig
+
+      # Shale attribute definition
+      #
+      #: Shale::Attribute
+      attr_reader :attribute
+
+      # Value of the attribute.
+      #
+      #: untyped
+      attr_reader :value
+
+      #: (Shale::Attribute, untyped) -> void
+      def initialize(attribute, value)
+        @attribute = attribute
+        @value = value
+      end
+    end
+  end
+end

data/lib/shale/builder/version.rb

@@ -2,6 +2,6 @@
 
 module Shale
   module Builder
-    VERSION = '0.4.1'
+    VERSION = '0.5.1'
   end
 end

data/lib/shale/builder.rb

@@ -39,6 +39,7 @@ module Shale
   #           end
   #       end
   #
+  # @requires_ancestor: Object
   module Builder
     extend T::Sig
     extend T::Helpers
@@ -47,7 +48,7 @@ module Shale
       extend T::Sig
 
       # Gets called after including this module in a module or class.
-      sig { params(mod: Module).void }
+      #: (Module mod) -> void
       def included(mod)
         mod.extend ClassMethods
         Builder.prepare_mod(mod)
@@ -55,7 +56,7 @@ module Shale
 
       # Prepares the received module or class
       # for dynamic method definition.
-      sig { params(mod: Module).void }
+      #: (Module mod) -> void
       def prepare_mod(mod)
         builder_methods_module = ::Module.new
         mod.instance_variable_set :@builder_methods_module, builder_methods_module
@@ -71,7 +72,7 @@ module Shale
       abstract!
       has_attached_class!
 
-      sig { params(subclass: Class).void }
+      #: (Class subclass) -> void
       def inherited(subclass)
         super
         Builder.prepare_mod(subclass)
@@ -79,10 +80,10 @@ module Shale
 
       # Contains overridden getter methods for attributes
       # with complex types (so that they accept a block for building)
-      sig { returns(Module) }
+      #: Module
       attr_reader :builder_methods_module
 
-      sig { params(_block: T.proc.params(arg0: T.attached_class).void).returns(T.attached_class) }
+      #: { (instance arg0) -> void } -> instance
       def build(&_block)
         body = new
         yield(body)
@@ -96,23 +97,34 @@ module Shale
       sig { abstract.returns(T::Hash[Symbol, Shale::Attribute]) }
       def attributes; end
 
-      sig do
-        params(
-          name:       T.any(String, Symbol),
-          type:       Class,
-          collection: T::Boolean,
-          default:    T.nilable(Proc),
-          doc:        T.nilable(String),
-          kwargs:     Object,
-          block:      T.nilable(T.proc.void),
-        ).void
-      end
-      def attribute(name, type, collection: false, default: nil, doc: nil, **kwargs, &block)
-        super(name, type, collection:, default:, **kwargs, &block)
+      #: (
+      #|  String | Symbol name,
+      #|  Class shale_mapper,
+      #|  ?collection: bool,
+      #|  ?default: Proc?,
+      #|  ?doc: String?,
+      #|  ?return_type: untyped,
+      #|  ?setter_type: untyped,
+      #|  **Object kwargs
+      #| ) ?{ -> void } -> void
+      def attribute(
+        name,
+        shale_mapper,
+        collection: false,
+        default: nil,
+        doc: nil,
+        return_type: nil,
+        setter_type: nil,
+        **kwargs,
+        &block
+      )
+        super(name, shale_mapper, collection:, default:, **kwargs, &block)
         if (attr_def = attributes[name.to_sym])
           attr_def.doc = doc
+          attr_def.return_type = return_type
+          attr_def.setter_type = setter_type
         end
-        return unless type < ::Shale::Mapper
+        return unless shale_mapper < ::Shale::Mapper
 
         if collection
           @builder_methods_module.class_eval <<~RUBY, __FILE__, __LINE__ + 1
@@ -120,7 +132,7 @@ module Shale
               return super unless block_given?    #   return super unless block_given?
                                                   #
               arr = self.#{name} ||= []           #   arr = self.clients ||= []
-              object = #{type}.new                #   object = Client.new
+              object = #{shale_mapper}.new                #   object = Client.new
               yield(object)                       #   yield(object)
               arr << object                       #   arr << object
               object                              #   object
@@ -133,7 +145,7 @@ module Shale
           def #{name}                                   # def amount
             return super unless block_given?            #   return super unless block_given?
                                                         #
-            object = #{type}.new                        #   object = Amount.new
+            object = #{shale_mapper}.new                        #   object = Amount.new
             yield(object)                               #   yield(object)
             self.#{name} = object                       #   self.amount = object
           end                                           # end
@@ -141,7 +153,7 @@ module Shale
       end
 
       # Create an alias for the getter and setter of an attribute.
-      sig { params(new_name: Symbol, old_name: Symbol).void }
+      #: (Symbol new_name, Symbol old_name) -> void
       def alias_attribute(new_name, old_name)
         attr = attributes.fetch(old_name)
         (attr.aliases ||= []) << new_name
@@ -160,5 +172,26 @@ module Shale
     end
     mixes_in_class_methods(ClassMethods)
 
+    def initialize(*args, **kwargs, &block)
+      super
+      @__initialized = true
+    end
+
+    #: bool?
+    attr_reader :__initialized
+
+    # Returns an array of shale values
+    # that have been assigned.
+    #
+    #: -> Array[Shale::Builder::Value]
+    def attribute_values
+      klass = self.class #: as untyped
+      klass.attributes.map do |name, attr|
+        Shale::Builder::Value.new(attr, public_send(name))
+      end
+    end
+
   end
 end
+
+require_relative 'builder/value'

data/lib/tapioca/dsl/compilers/shale.rb

@@ -37,9 +37,13 @@ module Tapioca
           # For each attribute defined in the class
           attribute_names = constant.attributes.keys.sort
           attribute_names.each do |attribute_name|
-            attribute = T.let(constant.attributes[attribute_name], ::Shale::Attribute)
-            return_type, nilable = shale_type_to_sorbet_return_type(attribute)
-            comments = T.let([], T::Array[RBI::Comment])
+            attribute = constant.attributes[attribute_name] #: ::Shale::Attribute
+            if (type = attribute.return_type)
+              return_type = type
+            else
+              return_type, nilable = shale_type_to_sorbet_return_type(attribute)
+            end
+            comments = [] #: T::Array[RBI::Comment]
             if shale_builder_defined? && attribute.doc
               comments << RBI::Comment.new(T.must(attribute.doc))
             end
@@ -52,7 +56,11 @@ module Tapioca
               getter_without_block_type = return_type.to_s
             end
 
-            setter_type, nilable = shale_type_to_sorbet_setter_type(attribute)
+            if (type = attribute.return_type || attribute.setter_type)
+              setter_type = type
+            else
+              setter_type, nilable = shale_type_to_sorbet_setter_type(attribute)
+            end
             if attribute.collection?
               setter_type_str = "T.nilable(T::Array[#{setter_type}])"
             elsif nilable

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shale-builder
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Mateusz Drewniak
@@ -69,7 +69,9 @@ files:
 - Rakefile
 - lib/shale/attribute.rb
 - lib/shale/builder.rb
+- lib/shale/builder/assigned_attributes.rb
 - lib/shale/builder/nested_validations.rb
+- lib/shale/builder/value.rb
 - lib/shale/builder/version.rb
 - lib/shale/mapper.rbi
 - lib/tapioca/dsl/compilers/shale.rb