Sha256: 30b974c0e45640347af75c504964173fd47e9f456aa8eeb7c1cc73b80f40d3a8

Contents?: true

Size: 731 Bytes

Versions: 11

Compression:

Stored size: 731 Bytes

Contents

module Restspec
  class << self
    # Shortcut for find a schema by name, create a {Restspec::Schema::SchemaExample} and call its {Restspec::Schema::SchemaExample#value value} method to get a example.
    #
    # @param schema_name [Symbol] The name of the schema.
    # @param extensions [Hash] A set of extensions for the example.
    #
    # @example Without extensions
    #   Restspec.example_for(:person) # { name: 'John', age: 25 }
    #
    # @example With extensions
    #   Restspec.example_for(:person, age: 18) # { name: 'John', age: 18 }
    def example_for(schema_name, extensions = {})
      schema = Restspec::SchemaStore.get(schema_name)
      Schema::SchemaExample.new(schema, extensions).value
    end
  end
end

Version data entries

11 entries across 11 versions & 1 rubygems

Version Path
restspec-0.3.2 lib/restspec/shortcuts.rb
restspec-0.3.1 lib/restspec/shortcuts.rb
restspec-0.3.0 lib/restspec/shortcuts.rb
restspec-0.2.6 lib/restspec/shortcuts.rb
restspec-0.2.5 lib/restspec/shortcuts.rb
restspec-0.2.4 lib/restspec/shortcuts.rb
restspec-0.2.3 lib/restspec/shortcuts.rb
restspec-0.2.2 lib/restspec/shortcuts.rb
restspec-0.2.1 lib/restspec/shortcuts.rb
restspec-0.2 lib/restspec/shortcuts.rb
restspec-0.1 lib/restspec/shortcuts.rb