apiwork 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7614067b7732803415ef2038394b28590c02e63734cdf9b879aab126dcb1caee
-  data.tar.gz: 2a7399c16a27c51c64e92811e7c020b863de65e4fdaaa7f4e400d7c8c308a94b
+  metadata.gz: 5949ff5143ec3bdd3c0349b639eb17306ce00d32c6567a618bdd1f8f3474d9fc
+  data.tar.gz: 3d8e835b75f3c85725e17459ae24c6b6154002b7733f76315826a776799a9860
 SHA512:
-  metadata.gz: 58e21417d9e0fa2e6d4bd05106f4619282fc2925af365433902392f2d841eda8e4035ffb4800e0dbd96a09cf513a507237b6ec0bb31de2f648c48d8e6bd00b38
-  data.tar.gz: de1ce6873f0c20373ce9bab1cd8e70b4b1787b6ae9adbf2f5fcb1c65720df33e45ad05aea524a8720837a777b7e50059c8a9d02240a1ddff57e9d69ad6422caf
+  metadata.gz: 93ac9cbc50161930b09f247309256590241180080a710c2e49621874a654a0d70d02888a9972ed342058047312371b5de9f47f0039f4f09525991e2a3ba252a7
+  data.tar.gz: 757058cf4777c10627862c7dd4142473c76027f340042d636978a805c8adaa82e2c74963e366d168cb2140273e5e845bc3fba8bb9fe76d5d5f5a21d5ad9ce208

data/README.md

@@ -1,7 +1,12 @@
 # Apiwork
 
-![Apiwork](docs/public/logo-light.svg#gh-light-mode-only)
-![Apiwork](docs/public/logo-dark.svg#gh-dark-mode-only)
+![Apiwork](docs/public/banner.svg)
+
+---
+
+> 🚧 **Apiwork is pre-1.0 and working toward a stable 1.0.** Minor versions can still bring breaking changes, so follow the [changelog](./CHANGELOG.md).
+
+---
 
 [![Gem Version](https://img.shields.io/gem/v/apiwork)](https://rubygems.org/gems/apiwork)
 [![CI](https://github.com/skiftle/apiwork/actions/workflows/ci.yml/badge.svg)](https://github.com/skiftle/apiwork/actions/workflows/ci.yml)

data/lib/apiwork/api/object.rb

@@ -37,7 +37,7 @@ module Apiwork
       # @param as [Symbol, nil] (nil)
       #   The target attribute name.
       # @param default [Object] (UNSET)
-      #   The default value. Omit to declare no default. Pass `nil` for an explicit null default.
+      #   The default value. Omit to declare no default. Pass `nil` for an explicit null default. A param with a default is always optional.
       # @param deprecated [Boolean] (false)
       #   Whether deprecated. Metadata included in exports.
       # @param description [String, nil] (nil)
@@ -61,7 +61,7 @@ module Apiwork
       # @param of [Symbol, Hash, nil] (nil)
       #   The element or value type. Arrays and records only.
       # @param optional [Boolean] (false)
-      #   Whether the param is optional.
+      #   Whether the param is optional. Always `true` for params with a `default`.
       # @param required [Boolean] (false)
       #   Whether the param is required.
       # @param shape [API::Object, API::Union, nil] (nil)
@@ -103,6 +103,7 @@ module Apiwork
         value: nil,
         &block
       )
+        optional = normalize_optional(optional, default)
         resolved_of = resolve_of(of, type, &block)
         resolved_shape = [:array, :record].include?(type) ? nil : (shape || build_shape(type, discriminator, &block))
         discriminator = resolved_of&.discriminator if type == :array
@@ -140,7 +141,7 @@ module Apiwork
       # @param as [Symbol, nil] (nil)
       #   The target attribute name.
       # @param default [Object] (UNSET)
-      #   The default value. Omit to declare no default. Pass `nil` for an explicit null default.
+      #   The default value. Omit to declare no default. Pass `nil` for an explicit null default. A param with a default is always optional.
       # @param deprecated [Boolean] (false)
       #   Whether deprecated. Metadata included in exports.
       # @param description [String, nil] (nil)
@@ -148,7 +149,7 @@ module Apiwork
       # @param nullable [Boolean] (false)
       #   Whether the value can be `null`.
       # @param optional [Boolean] (false)
-      #   Whether the param is optional.
+      #   Whether the param is optional. Always `true` for params with a `default`.
       # @param required [Boolean] (false)
       #   Whether the param is required.
       # @yield block for defining element type
@@ -203,7 +204,7 @@ module Apiwork
       # @param as [Symbol, nil] (nil)
       #   The target attribute name.
       # @param default [Object] (UNSET)
-      #   The default value. Omit to declare no default. Pass `nil` for an explicit null default.
+      #   The default value. Omit to declare no default. Pass `nil` for an explicit null default. A param with a default is always optional.
       # @param deprecated [Boolean] (false)
       #   Whether deprecated. Metadata included in exports.
       # @param description [String, nil] (nil)
@@ -211,7 +212,7 @@ module Apiwork
       # @param nullable [Boolean] (false)
       #   Whether the value can be `null`.
       # @param optional [Boolean] (false)
-      #   Whether the param is optional.
+      #   Whether the param is optional. Always `true` for params with a `default`.
       # @param required [Boolean] (false)
       #   Whether the param is required.
       # @yield block for defining value type

data/lib/apiwork/contract/object/validator.rb

@@ -76,7 +76,7 @@ module Apiwork
           required_error = validate_required(name, value, param_options, data, field_path)
           return [[required_error], NOT_SET] if required_error
 
-          value = param_options[:default] if value.nil? && param_options[:default]
+          value = param_options[:default] if value.nil? && param_options.key?(:default)
 
           nullable_error = validate_nullable(name, value, param_options, data, field_path)
           return [[nullable_error], NOT_SET] if nullable_error

data/lib/apiwork/contract/object.rb

@@ -61,7 +61,7 @@ module Apiwork
       # @param as [Symbol, nil] (nil)
       #   The target attribute name.
       # @param default [Object] (UNSET)
-      #   The default value. Omit to declare no default. Pass `nil` for an explicit null default.
+      #   The default value. Omit to declare no default. Pass `nil` for an explicit null default. A param with a default is always optional.
       # @param deprecated [Boolean] (false)
       #   Whether deprecated. Metadata included in exports.
       # @param description [String, nil] (nil)
@@ -85,7 +85,7 @@ module Apiwork
       # @param of [Symbol, Hash, nil] (nil)
       #   The element or value type. Arrays and records only.
       # @param optional [Boolean] (false)
-      #   Whether the param is optional.
+      #   Whether the param is optional. Always `true` for params with a `default`.
       # @param required [Boolean] (false)
       #   Whether the param is required.
       # @param shape [Contract::Object, Contract::Union, nil] (nil)
@@ -140,6 +140,8 @@ module Apiwork
 
         raise ConfigurationError, 'discriminator can only be used with type: :union' if discriminator && type != :union
 
+        optional = normalize_optional(optional, default)
+
         visited_types ||= @visited_types
         visited_types ||= Set.new
 
@@ -184,7 +186,7 @@ module Apiwork
       # @param as [Symbol, nil] (nil)
       #   The target attribute name.
       # @param default [Object] (UNSET)
-      #   The default value. Omit to declare no default. Pass `nil` for an explicit null default.
+      #   The default value. Omit to declare no default. Pass `nil` for an explicit null default. A param with a default is always optional.
       # @param deprecated [Boolean] (false)
       #   Whether deprecated. Metadata included in exports.
       # @param description [String, nil] (nil)
@@ -196,7 +198,7 @@ module Apiwork
       # @param nullable [Boolean] (false)
       #   Whether the value can be `null`.
       # @param optional [Boolean] (false)
-      #   Whether the param is optional.
+      #   Whether the param is optional. Always `true` for params with a `default`.
       # @param required [Boolean] (false)
       #   Whether the param is required.
       # @yield block for defining element type
@@ -255,7 +257,7 @@ module Apiwork
       # @param as [Symbol, nil] (nil)
       #   The target attribute name.
       # @param default [Object] (UNSET)
-      #   The default value. Omit to declare no default. Pass `nil` for an explicit null default.
+      #   The default value. Omit to declare no default. Pass `nil` for an explicit null default. A param with a default is always optional.
       # @param deprecated [Boolean] (false)
       #   Whether deprecated. Metadata included in exports.
       # @param description [String, nil] (nil)
@@ -263,7 +265,7 @@ module Apiwork
       # @param nullable [Boolean] (false)
       #   Whether the value can be `null`.
       # @param optional [Boolean] (false)
-      #   Whether the param is optional.
+      #   Whether the param is optional. Always `true` for params with a `default`.
       # @param required [Boolean] (false)
       #   Whether the param is required.
       # @yield block for defining value type

data/lib/apiwork/object.rb

@@ -157,8 +157,8 @@ module Apiwork
     #   Whether the param is required.
     # @return [void]
     #
-    # @example Optional string with default
-    #   string? :nickname, default: 'Anonymous'
+    # @example Optional string
+    #   string? :nickname
     def string?(
       name,
       as: nil,
@@ -284,7 +284,7 @@ module Apiwork
     # @return [void]
     #
     # @example Optional page number
-    #   integer? :page, min: 1, default: 1
+    #   integer? :page, min: 1
     def integer?(
       name,
       as: nil,
@@ -619,7 +619,7 @@ module Apiwork
     # @return [void]
     #
     # @example Optional notification flag
-    #   boolean? :notify, default: true
+    #   boolean? :notify
     def boolean?(
       name,
       as: nil,
@@ -1864,5 +1864,13 @@ module Apiwork
     def param(name, type: nil, **options, &block)
       raise NotImplementedError, "#{self.class} must implement #param"
     end
+
+    private
+
+    def normalize_optional(optional, default)
+      return true unless UNSET.equal?(default)
+
+      optional
+    end
   end
 end

data/lib/apiwork/representation/attribute.rb

@@ -351,7 +351,7 @@ module Apiwork
         column = column_for(name)
         return false unless column
 
-        return true if column.default.present?
+        return true unless column.default.nil?
 
         column.null
       end

data/lib/apiwork/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Apiwork
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apiwork
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - skiftle
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-17 00:00:00.000000000 Z
+date: 2026-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '8.0'
-- !ruby/object:Gem::Dependency
-  name: bundler-audit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: lefthook
   requirement: !ruby/object:Gem::Requirement