structure 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af5b8b6dc3dacef6201847123b04742310441ded70ec7952b42d07a668d83f2f
-  data.tar.gz: '00385227416285e5a4d1f2cfcf2cc0e5cb94bb368cf8995b014a7bf3fd91d9c6'
+  metadata.gz: 91e04b84b8e6a19728bf6212bdfd08895187bbe59ebf56b47288697962ed31b2
+  data.tar.gz: '028e8df792d344faa2850f82504d223a6691c195203c51acd53581ee9e97064c'
 SHA512:
-  metadata.gz: ba80d09a4867a1497133026cc4d4654e03586f677d44d07a7f2387b40fce16e8fc188bc46cc8c768663ded6387b580d3dc210ae884d14530bf62e7e56ec4ace4
-  data.tar.gz: 8a0c8e7d5f9585a946817cc31a3cd831ea0332833030798d178ce81ee1737809226321ac105f106559358aa4ae24753368d808007ef6ab37230b6d6fc98ffe69
+  metadata.gz: 4e6fbbd3104fc0ed9001d66395606ab436a907cf3b1ab09f692c458b99e999e648e7b558dd0b2e8e4fb298d2c1c25decf51bef0ad5889bc9ff14f6d821c62ede
+  data.tar.gz: 74752c31b2898fea6c7d5c94e568f7fa9ca2724e116aa62e9d9c30f0da77d3f6f7de7b73540a8837834536bc2aa9b87f9d5b596ddd0bfd2089222e3fbec07334

data/lib/structure/builder.rb

@@ -13,6 +13,25 @@ module Structure
       @defaults = {}
     end
 
+    # DSL method for defining attributes with optional type coercion
+    #
+    # @param name [Symbol] The attribute name
+    # @param type [Class, Symbol, Array, nil] Type for coercion (e.g., String, :boolean, [String])
+    # @param from [String, nil] Source key in the data hash (defaults to name.to_s)
+    # @param default [Object, nil] Default value if attribute is missing
+    # @yield [value] Block for custom transformation
+    # @raise [ArgumentError] If both type and block are provided
+    #
+    # @example With type coercion
+    #   attribute :age, Integer
+    #
+    # @example With custom source key
+    #   attribute :created_at, Time, from: "CreatedAt"
+    #
+    # @example With transformation block
+    #   attribute :price do |value|
+    #     Money.new(value["amount"], value["currency"])
+    #   end
     def attribute(name, type = nil, from: nil, default: nil, &block)
       # Always store in mappings - use attribute name as default source
       @mappings[name] = from || name.to_s
@@ -27,23 +46,30 @@ module Structure
       end
     end
 
-    # Deduced from mappings - maintains order of definition
+    # Defines a callback to run after parsing
+    #
+    # @yield [instance] Block that receives the parsed instance
+    # @return [void]
+    #
+    # @example Validation
+    #   after_parse do |order|
+    #     raise "Invalid order" if order.total < 0
+    #   end
+    def after_parse(&block)
+      @after_parse_callback = block
+    end
+
     def attributes
       @mappings.keys
     end
 
-    # Deduced from types that are boolean
     def predicate_methods
       @types.filter_map do |name, type_lambda|
-        if type_lambda == Types.boolean
+        if type_lambda == Types.boolean && !name.to_s.end_with?("?")
           predicate_name = "#{name}?"
           [predicate_name.to_sym, name]
         end
       end.to_h
     end
-
-    def after_parse(&block)
-      @after_parse_callback = block
-    end
   end
 end

data/lib/structure/types.rb

@@ -10,29 +10,26 @@ module Structure
     BOOLEAN_TRUTHY = [true, 1, "1", "t", "T", "true", "TRUE", "on", "ON"].freeze
     private_constant :BOOLEAN_TRUTHY
 
-    # Boolean conversion
-    # Memoized so predicate method detection works via object identity comparison
     def boolean
       @boolean ||= ->(val) { BOOLEAN_TRUTHY.include?(val) }
     end
 
-    # Generic handler for classes with kernel methods (String, Integer, Float, etc.)
-    def kernel(type)
-      ->(val) { Kernel.send(type.name, val) }
-    end
-
-    # Handler for classes with parse methods (e.g., Date, Time, URI, nested Structure classes)
-    def parseable(type)
-      ->(val) { type.parse(val) }
-    end
-
-    # Create coercer for array elements
-    def array(element_type)
-      element_coercer = coerce(element_type)
-      ->(array) { array.map { |element| element_coercer.call(element) } }
-    end
-
     # Main factory method for creating type coercers
+    #
+    # @param type [Class, Symbol, Array] Type specification
+    # @return [Proc, Object] Coercion proc or the type itself if no coercion available
+    #
+    # @example Boolean type
+    #   coerce(:boolean) # => boolean proc
+    #
+    # @example Kernel types
+    #   coerce(Integer) # => proc that calls Kernel.Integer
+    #
+    # @example Parseable types
+    #   coerce(Date) # => proc that calls Date.parse
+    #
+    # @example Array types
+    #   coerce([String]) # => proc that coerces array elements to String
     def coerce(type)
       case type
       when :boolean
@@ -55,5 +52,20 @@ module Structure
         type
       end
     end
+
+    private
+
+    def kernel(type)
+      ->(val) { Kernel.send(type.name, val) }
+    end
+
+    def parseable(type)
+      ->(val) { type.parse(val) }
+    end
+
+    def array(element_type)
+      element_coercer = coerce(element_type)
+      ->(array) { array.map { |element| element_coercer.call(element) } }
+    end
   end
 end

data/lib/structure/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Structure
-  VERSION = "3.1.0"
+  VERSION = "3.1.1"
 end

data/lib/structure.rb

@@ -5,6 +5,20 @@ require "structure/builder"
 # A library for parsing data into immutable Ruby Data objects with type coercion
 module Structure
   class << self
+    # Creates a new Data class with attribute definitions and type coercion
+    #
+    # @yield [Builder] Block for defining attributes using the DSL
+    # @return [Class] A Data class with a parse method
+    #
+    # @example Basic usage
+    #   Person = Structure.new do
+    #     attribute :name, String
+    #     attribute :age, Integer
+    #   end
+    #
+    #   person = Person.parse(name: "Alice", age: "30")
+    #   person.name # => "Alice"
+    #   person.age  # => 30
     def new(&block)
       builder = Builder.new
       builder.instance_eval(&block) if block

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: structure
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Hakan Ensari