apiwork 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb5f681a0f08e4bebe2d0f5ebf4edac733f3787e4144f019bc4babfa7a7ef84a
-  data.tar.gz: e5d1d87115d2902295d66567c324d73ef15d01b0ac106c1fa9739b56a276aeb3
+  metadata.gz: 61f7ef3c54d36ed6bced4d7e84233b2ab4879c697a29468202c09b811074e2f6
+  data.tar.gz: 0b285cc8cd1b5e5ad64b85d8e1bbe17cb82d281b2b69bf7b51a5468db2a9e43a
 SHA512:
-  metadata.gz: bb539d87fcd3b065d643711616f7f9f5589d574cbf12bcc06c69aafe7000f6fafa4e19d7fd34cd165d2734076d3b192472a6f51459074241fabbf5dd3faece42
-  data.tar.gz: 692745d73d86c3f5c377ae2a7962b38efe351b1fc893df6af45bd8de025622f61257307dedcd1b6aac15df8f3112874e92c54d3b3e316ef9aaa59ef6fcca0338
+  metadata.gz: 31a41407721690942c50e1db93d5e602e67ee4dde083ff3e44b3a86e4935f874463856ee0217306156d4c7e29c994c46c9a21da9b185b9c6477a0b96b71aa6bd
+  data.tar.gz: 4e197e9a7d1301ca771867b0ab85a777fdf0ab1e2951871ec156370f8118805cf0c502c65da8e6ed629d52eaab4ea8c7222639d2a6f0802077d401bb6c49588a

data/README.md

@@ -1,5 +1,8 @@
 # Apiwork
 
+![Apiwork](docs/public/logo-light.svg#gh-light-mode-only)
+![Apiwork](docs/public/logo-dark.svg#gh-dark-mode-only)
+
 [![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)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)

data/lib/apiwork/introspection/dump/contract.rb

@@ -44,7 +44,7 @@ module Apiwork
             .reject { |_, type_definition| type_definition.fragment? }
             .sort_by { |name, _type_definition| name.to_s }
             .each_with_object({}) do |(name, type_definition), result|
-              result[name] = @type_dump.build_type(name, type_definition)
+            result[name] = @type_dump.build_type(name, type_definition)
           end
         end
 
@@ -53,7 +53,7 @@ module Apiwork
             .select { |_name, enum_definition| enum_definition.scope == @contract_class }
             .sort_by { |name, _enum_definition| name.to_s }
             .each_with_object({}) do |(name, enum_definition), result|
-              result[name] = @type_dump.build_enum(name, enum_definition)
+            result[name] = @type_dump.build_enum(name, enum_definition)
           end
         end
 

data/lib/apiwork/introspection/dump/param.rb

@@ -4,9 +4,8 @@ module Apiwork
   module Introspection
     module Dump
       class Param
-        def initialize(contract_param, visited: Set.new)
+        def initialize(contract_param)
           @contract_param = contract_param
-          @visited = visited
           @import_prefix_cache = {}
         end
 
@@ -247,7 +246,7 @@ module Apiwork
           elsif shape.is_a?(Apiwork::API::Union)
             dump_api_union(shape)
           else
-            Param.new(shape, visited: @visited).to_h
+            Param.new(shape).to_h
           end
         end
 

data/lib/apiwork/introspection/dump/resource.rb

@@ -4,11 +4,12 @@ module Apiwork
   module Introspection
     module Dump
       class Resource
-        def initialize(resource, api_class, parent_identifiers: [], parent_param: nil)
+        def initialize(resource, api_class, parent_identifiers: [], parent_param: nil, parent_singular: false)
           @resource = resource
           @api_class = api_class
           @parent_identifiers = parent_identifiers
           @parent_param = parent_param
+          @parent_singular = parent_singular
         end
 
         def to_h
@@ -57,6 +58,7 @@ module Apiwork
 
         def build_resource_path(formatted_segment)
           return formatted_segment if @parent_identifiers.empty?
+          return formatted_segment if @parent_singular
 
           ":#{@parent_param || "#{@parent_identifiers.last.singularize}_id"}/#{formatted_segment}"
         end
@@ -65,15 +67,15 @@ module Apiwork
           return {} unless @resource.resources.any?
 
           child_parent_identifiers = @parent_identifiers + [@resource.name.to_s]
-          child_parent_param = @resource.param&.to_s || "#{@resource.name.to_s.singularize}_id"
+
+          nested_options = {
+            parent_identifiers: child_parent_identifiers,
+            parent_singular: @resource.singular,
+          }
+          nested_options[:parent_param] = @resource.param&.to_s || "#{@resource.name.to_s.singularize}_id" unless @resource.singular
 
           @resource.resources.transform_values do |nested_resource|
-            Resource.new(
-              nested_resource,
-              @api_class,
-              parent_identifiers: child_parent_identifiers,
-              parent_param: child_parent_param,
-            ).to_h
+            Resource.new(nested_resource, @api_class, **nested_options).to_h
           end
         end
 
@@ -82,17 +84,23 @@ module Apiwork
         end
 
         def action_path_segment(action_name, adapter_action)
+          param = @resource.param || :id
+
           if adapter_action.crud?
             case action_name
             when :index, :create
               ''
             when :show, :update, :destroy
-              '/:id'
+              @resource.singular ? '' : "/:#{param}"
             else
               ''
             end
           elsif adapter_action.member?
-            "/:id/#{@api_class.transform_path(action_name)}"
+            if @resource.singular
+              "/#{@api_class.transform_path(action_name)}"
+            else
+              "/:#{param}/#{@api_class.transform_path(action_name)}"
+            end
           elsif adapter_action.collection?
             "/#{@api_class.transform_path(action_name)}"
           else

data/lib/apiwork/introspection/dump/type.rb

@@ -19,7 +19,7 @@ module Apiwork
           @api_class.type_registry.each_pair
             .reject { |_, type_definition| type_definition.fragment? }
             .sort_by do |name, _type_definition|
-              name.to_s
+            name.to_s
           end.each_with_object({}) do |(qualified_name, type_definition), result|
             result[qualified_name] = build_type(qualified_name, type_definition)
           end

data/lib/apiwork/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apiwork
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - skiftle
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-28 00:00:00.000000000 Z
+date: 2026-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: lefthook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +142,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
 - README.md
 - Rakefile
 - app/controllers/apiwork/errors_controller.rb

data/LICENSE.txt

@@ -1,21 +0,0 @@
-Copyright (c) 2026 skiftle
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.