servus 0.1.2 → 0.1.4

data/lib/servus/testing/example_extractor.rb

@@ -0,0 +1,309 @@
+# frozen_string_literal: true
+
+module Servus
+  module Testing
+    # Extracts example values from JSON Schema definitions for use in testing.
+    #
+    # This class understands both OpenAPI-style `example` (singular) and
+    # JSON Schema-style `examples` (plural, array) keywords. It can handle
+    # nested objects, arrays, and complex schema structures.
+    #
+    # @example Basic extraction
+    #   schema = {
+    #     type: 'object',
+    #     properties: {
+    #       name: { type: 'string', example: 'John Doe' },
+    #       age: { type: 'integer', example: 30 }
+    #     }
+    #   }
+    #
+    #   extractor = ExampleExtractor.new(schema)
+    #   extractor.extract
+    #   # => { name: 'John Doe', age: 30 }
+    #
+    # @example With service class
+    #   examples = ExampleExtractor.extract(MyService, :arguments)
+    #   # => { user_id: 123, amount: 100.0 }
+    #
+    # @see https://json-schema.org/understanding-json-schema/reference/annotations
+    # @see https://spec.openapis.org/oas/v3.1.0#schema-object
+    class ExampleExtractor
+      # Extracts example values from a service class's schema.
+      #
+      # This is a convenience class method that loads the schema via the
+      # Validator and extracts examples in one call.
+      #
+      # @param service_class [Class] The service class to extract examples from
+      # @param schema_type [Symbol] Either :arguments or :result
+      # @return [Hash<Symbol, Object>] Extracted example values with symbolized keys
+      #
+      # @example Extract argument examples
+      #   ExampleExtractor.extract(ProcessPayment::Service, :arguments)
+      #   # => { user_id: 123, amount: 100.0, currency: 'USD' }
+      #
+      # @example Extract result examples
+      #   ExampleExtractor.extract(ProcessPayment::Service, :result)
+      #   # => { transaction_id: 'txn_123', status: 'approved' }
+      def self.extract(service_class, schema_type)
+        schema = load_schema(service_class, schema_type)
+        return {} unless schema
+
+        new(schema).extract
+      end
+
+      # Initializes a new ExampleExtractor with a schema.
+      #
+      # The schema is deeply symbolized on initialization to normalize all keys,
+      # eliminating the need for double lookups throughout extraction.
+      #
+      # @param schema [Hash, nil] A JSON Schema hash with properties and examples
+      #
+      # @example
+      #   schema = { type: 'object', properties: { name: { example: 'Test' } } }
+      #   extractor = ExampleExtractor.new(schema)
+      def initialize(schema)
+        @schema = deep_symbolize_keys(schema)
+      end
+
+      # Extracts all example values from the schema.
+      #
+      # Traverses the schema structure and collects example values from:
+      # - Simple properties with `example` or `examples` keywords
+      # - Nested objects (recursively)
+      # - Arrays (using array-level examples or generating from item schemas)
+      #
+      # @return [Hash<Symbol, Object>] Hash of example values with symbolized keys
+      #
+      # @example Simple properties
+      #   schema = {
+      #     type: 'object',
+      #     properties: {
+      #       name: { type: 'string', example: 'John' },
+      #       age: { type: 'integer', examples: [30, 25, 40] }
+      #     }
+      #   }
+      #   extractor = ExampleExtractor.new(schema)
+      #   extractor.extract
+      #   # => { name: 'John', age: 30 }
+      #
+      # @example Nested objects
+      #   schema = {
+      #     type: 'object',
+      #     properties: {
+      #       user: {
+      #         type: 'object',
+      #         properties: {
+      #           id: { type: 'integer', example: 123 },
+      #           name: { type: 'string', example: 'Jane' }
+      #         }
+      #       }
+      #     }
+      #   }
+      #   extractor = ExampleExtractor.new(schema)
+      #   extractor.extract
+      #   # => { user: { id: 123, name: 'Jane' } }
+      def extract
+        return {} unless @schema.is_a?(Hash)
+
+        extract_examples_from_properties(@schema)
+      end
+
+      private
+
+      # Extracts examples from schema properties.
+      #
+      # Iterates through the properties hash and extracts example values
+      # for each property that has one defined.
+      #
+      # @param schema [Hash] Schema hash containing a :properties key
+      # @return [Hash<Symbol, Object>] Extracted examples with symbolized keys
+      #
+      # @api private
+      def extract_examples_from_properties(schema)
+        properties = schema[:properties]
+        return {} unless properties
+
+        properties.each_with_object({}) do |(key, property_schema), examples|
+          example_value = extract_example_value(property_schema)
+          examples[key.to_sym] = example_value unless example_value.nil? && !explicit_nil_example?(property_schema)
+        end
+      end
+
+      # Extracts a single example value from a property schema.
+      #
+      # Handles different types of properties:
+      # - Simple types with `example` or `examples` keywords
+      # - Nested objects (recursively extracts)
+      # - Arrays (uses array example or generates from items)
+      #
+      # @param property_schema [Hash] The schema for a single property
+      # @return [Object, nil] The example value, or nil if none found
+      #
+      # @api private
+      def extract_example_value(property_schema)
+        return nil unless property_schema.is_a?(Hash)
+
+        # Check for direct example keywords first
+        return get_example_from_keyword(property_schema) if example_keyword?(property_schema)
+
+        # Handle nested objects
+        return extract_examples_from_properties(property_schema) if nested_object?(property_schema)
+
+        # Handle arrays
+        return extract_array_example(property_schema) if array_type?(property_schema)
+
+        nil
+      end
+
+      # Checks if property has an example keyword (example or examples).
+      #
+      # @param property_schema [Hash] Property schema to check
+      # @return [Boolean] True if example or examples keyword exists
+      #
+      # @api private
+      def example_keyword?(property_schema)
+        property_schema.key?(:example) || property_schema.key?(:examples)
+      end
+
+      # Checks if property explicitly sets example to nil.
+      #
+      # This is important to distinguish between "no example" and "example is nil".
+      #
+      # @param property_schema [Hash] Property schema to check
+      # @return [Boolean] True if example is explicitly set to nil
+      #
+      # @api private
+      def explicit_nil_example?(property_schema)
+        property_schema.key?(:example) && property_schema[:example].nil?
+      end
+
+      # Gets the example value from the example/examples keyword.
+      #
+      # Handles both:
+      # - `:example` (singular): returns the value directly
+      # - `:examples` (plural): returns a value from the array
+      #
+      # @param property_schema [Hash] Property schema with example keyword
+      # @return [Object] The example value
+      #
+      # @api private
+      def get_example_from_keyword(property_schema)
+        # Check for :example (singular) first - OpenAPI style
+        return property_schema[:example] if property_schema.key?(:example)
+
+        # Check for :examples (plural) - JSON Schema style
+        examples = property_schema[:examples]
+        return nil unless examples.is_a?(Array) && examples.any?
+
+        examples.sample
+      end
+
+      # Checks if property is a nested object type.
+      #
+      # @param property_schema [Hash] Property schema to check
+      # @return [Boolean] True if type is object and has properties
+      #
+      # @api private
+      def nested_object?(property_schema)
+        property_schema[:type] == 'object' && property_schema[:properties]
+      end
+
+      # Checks if property is an array type.
+      #
+      # @param property_schema [Hash] Property schema to check
+      # @return [Boolean] True if type is array
+      #
+      # @api private
+      def array_type?(property_schema)
+        property_schema[:type] == 'array'
+      end
+
+      # Extracts example value for an array property.
+      #
+      # Handles two strategies:
+      # 1. If array has direct `example` keyword, use it
+      # 2. Otherwise, generate array with one item using item schema examples
+      #
+      # @param property_schema [Hash] Array property schema
+      # @return [Array, nil] Array example or nil if can't be generated
+      #
+      # @example Array with direct example
+      #   { type: 'array', example: [1, 2, 3] }
+      #   # => [1, 2, 3]
+      #
+      # @example Array with item schema examples
+      #   {
+      #     type: 'array',
+      #     items: {
+      #       type: 'object',
+      #       properties: {
+      #         id: { type: 'integer', examples: [1, 2] },
+      #         name: { type: 'string', examples: ['John', 'Jane'] }
+      #       }
+      #     }
+      #   }
+      #   # => [{ id: 1, name: 'John' }]
+      #
+      # @api private
+      def extract_array_example(property_schema)
+        # If array has direct example, use it
+        return get_example_from_keyword(property_schema) if example_keyword?(property_schema)
+
+        # Otherwise, try to generate an array with one item from the items schema
+        items_schema = property_schema[:items]
+        return nil unless items_schema
+
+        # Generate one example item from the items schema
+        if nested_object?(items_schema)
+          item_example = extract_examples_from_properties(items_schema)
+          return [item_example] if item_example.any?
+        elsif example_keyword?(items_schema)
+          return [get_example_from_keyword(items_schema)]
+        end
+
+        nil
+      end
+
+      # Recursively converts all hash keys to symbols.
+      #
+      # Handles nested hashes and arrays of hashes, ensuring consistent
+      # key types throughout the structure.
+      #
+      # @param value [Object] The value to process
+      # @return [Object] The value with all hash keys symbolized
+      #
+      # @api private
+      def deep_symbolize_keys(value)
+        case value
+        when Hash
+          value.each_with_object({}) do |(key, val), result|
+            result[key.to_sym] = deep_symbolize_keys(val)
+          end
+        when Array
+          value.map { |item| deep_symbolize_keys(item) }
+        else
+          value
+        end
+      end
+
+      # Loads schema from service class using Validator.
+      #
+      # Reuses the existing Validator schema loading logic which handles:
+      # - DSL-defined schemas
+      # - Constant-defined schemas
+      # - File-based schemas
+      # - Schema caching
+      #
+      # @param service_class [Class] The service class
+      # @param schema_type [Symbol] Either :arguments or :result
+      # @return [Hash, nil] The loaded schema or nil
+      #
+      # @api private
+      def self.load_schema(service_class, schema_type)
+        Servus::Support::Validator.load_schema(service_class, schema_type.to_s)
+      end
+
+      private_class_method :load_schema
+    end
+  end
+end

data/lib/servus/testing.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Servus
+  # Testing utilities for Servus services.
+  #
+  # This module provides helpers for extracting example values from JSON schemas
+  # to use in tests, making it easier to create test fixtures without manually
+  # maintaining separate factory files.
+  #
+  # @see Servus::Testing::ExampleBuilders
+  # @see Servus::Testing::ExampleExtractor
+  module Testing
+  end
+end
+
+require_relative 'testing/example_extractor'
+require_relative 'testing/example_builders'

data/lib/servus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Servus
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: servus
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Sebastian Scholl
@@ -13,59 +13,61 @@ dependencies:
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '8.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: A gem for managing service objects.
+        version: '8.0'
+description: Servus is a Ruby gem that provides a structured way to create and manage
+  service objects, promoting clean code architecture and separation of concerns in
+  your applications.
 email:
 - sebscholl@gmail.com
 executables: []
@@ -74,12 +76,107 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".yardopts"
 - CHANGELOG.md
+- IDEAS.md
 - LICENSE.txt
 - READme.md
 - Rakefile
 - builds/servus-0.0.1.gem
 - builds/servus-0.1.1.gem
+- builds/servus-0.1.2.gem
+- builds/servus-0.1.3.gem
+- builds/servus-0.1.4.gem
+- docs/core/1_overview.md
+- docs/core/2_architecture.md
+- docs/core/3_service_objects.md
+- docs/features/1_schema_validation.md
+- docs/features/2_error_handling.md
+- docs/features/3_async_execution.md
+- docs/features/4_logging.md
+- docs/guides/1_common_patterns.md
+- docs/guides/2_migration_guide.md
+- docs/integration/1_configuration.md
+- docs/integration/2_testing.md
+- docs/integration/3_rails_integration.md
+- docs/yard/Servus.html
+- docs/yard/Servus/Base.html
+- docs/yard/Servus/Config.html
+- docs/yard/Servus/Extensions.html
+- docs/yard/Servus/Extensions/Async.html
+- docs/yard/Servus/Extensions/Async/Call.html
+- docs/yard/Servus/Extensions/Async/Errors.html
+- docs/yard/Servus/Extensions/Async/Errors/AsyncError.html
+- docs/yard/Servus/Extensions/Async/Errors/JobEnqueueError.html
+- docs/yard/Servus/Extensions/Async/Errors/ServiceNotFoundError.html
+- docs/yard/Servus/Extensions/Async/Ext.html
+- docs/yard/Servus/Extensions/Async/Job.html
+- docs/yard/Servus/Generators.html
+- docs/yard/Servus/Generators/ServiceGenerator.html
+- docs/yard/Servus/Helpers.html
+- docs/yard/Servus/Helpers/ControllerHelpers.html
+- docs/yard/Servus/Railtie.html
+- docs/yard/Servus/Support.html
+- docs/yard/Servus/Support/Errors.html
+- docs/yard/Servus/Support/Errors/AuthenticationError.html
+- docs/yard/Servus/Support/Errors/BadRequestError.html
+- docs/yard/Servus/Support/Errors/ForbiddenError.html
+- docs/yard/Servus/Support/Errors/InternalServerError.html
+- docs/yard/Servus/Support/Errors/NotFoundError.html
+- docs/yard/Servus/Support/Errors/ServiceError.html
+- docs/yard/Servus/Support/Errors/ServiceUnavailableError.html
+- docs/yard/Servus/Support/Errors/UnauthorizedError.html
+- docs/yard/Servus/Support/Errors/UnprocessableEntityError.html
+- docs/yard/Servus/Support/Errors/ValidationError.html
+- docs/yard/Servus/Support/Logger.html
+- docs/yard/Servus/Support/Rescuer.html
+- docs/yard/Servus/Support/Rescuer/BlockContext.html
+- docs/yard/Servus/Support/Rescuer/CallOverride.html
+- docs/yard/Servus/Support/Rescuer/ClassMethods.html
+- docs/yard/Servus/Support/Response.html
+- docs/yard/Servus/Support/Validator.html
+- docs/yard/Servus/Testing.html
+- docs/yard/Servus/Testing/ExampleBuilders.html
+- docs/yard/Servus/Testing/ExampleExtractor.html
+- docs/yard/_index.html
+- docs/yard/class_list.html
+- docs/yard/css/common.css
+- docs/yard/css/full_list.css
+- docs/yard/css/style.css
+- docs/yard/file.1_common_patterns.html
+- docs/yard/file.1_configuration.html
+- docs/yard/file.1_overview.html
+- docs/yard/file.1_schema_validation.html
+- docs/yard/file.2_architecture.html
+- docs/yard/file.2_error_handling.html
+- docs/yard/file.2_migration_guide.html
+- docs/yard/file.2_testing.html
+- docs/yard/file.3_async_execution.html
+- docs/yard/file.3_rails_integration.html
+- docs/yard/file.3_service_objects.html
+- docs/yard/file.4_logging.html
+- docs/yard/file.ErrorHandling.html
+- docs/yard/file.READme.html
+- docs/yard/file.architecture.html
+- docs/yard/file.async_execution.html
+- docs/yard/file.common_patterns.html
+- docs/yard/file.configuration.html
+- docs/yard/file.error_handling.html
+- docs/yard/file.logging.html
+- docs/yard/file.migration_guide.html
+- docs/yard/file.overview.html
+- docs/yard/file.rails_integration.html
+- docs/yard/file.schema_validation.html
+- docs/yard/file.service_objects.html
+- docs/yard/file.testing.html
+- docs/yard/file_list.html
+- docs/yard/frames.html
+- docs/yard/index.html
+- docs/yard/js/app.js
+- docs/yard/js/full_list.js
+- docs/yard/js/jquery.js
+- docs/yard/method_list.html
+- docs/yard/top-level-namespace.html
 - lib/generators/servus/service/service_generator.rb
 - lib/generators/servus/service/templates/arguments.json.erb
 - lib/generators/servus/service/templates/result.json.erb
@@ -99,6 +196,9 @@ files:
 - lib/servus/support/rescuer.rb
 - lib/servus/support/response.rb
 - lib/servus/support/validator.rb
+- lib/servus/testing.rb
+- lib/servus/testing/example_builders.rb
+- lib/servus/testing/example_extractor.rb
 - lib/servus/version.rb
 - sig/servus.rbs
 homepage: https://github.com/zarpay/servus
@@ -106,7 +206,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/zarpay/servus
   source_code_uri: https://github.com/zarpay/servus
   changelog_uri: https://github.com/zarpay/servus/blob/main/CHANGELOG.md
 rdoc_options: []