brainstem 2.0.0 → 2.1.0

data/spec/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/endpoint_param_formatter_spec.rb

@@ -0,0 +1,335 @@
+require 'spec_helper'
+require 'brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/endpoint_param_formatter'
+
+module Brainstem
+  module ApiDocs
+    module Formatters
+      module OpenApiSpecification
+        module Version2
+          module FieldDefinitions
+            describe EndpointParamFormatter do
+              describe '#format' do
+                let(:endpoint) { OpenStruct.new(controller_name: 'Test', action: 'create') }
+                let(:field_name) { 'sprocket' }
+                let(:configuration_tree) { field_configuration_tree.with_indifferent_access }
+
+                subject { described_class.new(endpoint, field_name, configuration_tree).format }
+
+                context 'when formatting nested field' do
+                  context 'when formatting a nested array field with objects' do
+                    let(:field_configuration_tree) do
+                      {
+                        _config: {
+                          type: 'array',
+                          nested_levels: 2,
+                          item_type: 'hash',
+                        },
+                        widget_name: {
+                          _config: {
+                            required: true,
+                            type: 'string',
+                            info: 'the name of the widget',
+                            nodoc: false
+                          },
+                        },
+                        support_email: {
+                          _config: {
+                            required: true,
+                            type: 'string',
+                            info: 'contact support',
+                            nodoc: false
+                          },
+                        },
+                        version: {
+                          _config: {
+                            type: 'string',
+                            info: 'the version of the widget',
+                            nodoc: false
+                          },
+                        },
+                        widget_permissions: {
+                          _config: {
+                            type: 'array',
+                            item_type: 'hash',
+                            info: 'the permissions of the widget',
+                            nodoc: false
+                          },
+                          can_edit: {
+                            _config: {
+                              required: true,
+                              type: 'array',
+                              item_type: 'boolean',
+                              nodoc: false
+                            },
+                          },
+                          can_delete: {
+                            _config: {
+                              type: 'boolean',
+                              nodoc: false
+                            },
+                          },
+                          can_rename: {
+                            _config: {
+                              type: 'boolean',
+                              info: 'can rename the widget',
+                              nodoc: false
+                            },
+                          },
+                        },
+                      }
+                    end
+
+                    it 'formats a complicated tree with arrays and hashes as children' do
+                      expect(subject).to eq(
+                        'type' => 'array',
+                        'items' => {
+                          'type' => 'array',
+                          'items' => {
+                            'type' => 'object',
+                            'required' => ['widget_name', 'support_email'],
+                            'properties' => {
+                              'widget_name' => {
+                                'type' => 'string',
+                                'description' => 'The name of the widget.',
+                              },
+                              'support_email' => {
+                                'type' => 'string',
+                                'description' => 'Contact support.',
+                              },
+                              'version' => {
+                                'type' => 'string',
+                                'description' => 'The version of the widget.',
+                              },
+                              'widget_permissions' => {
+                                'type' => 'array',
+                                'description' => 'The permissions of the widget.',
+                                'items' => {
+                                  'type' => 'object',
+                                  'required' => ['can_edit'],
+                                  'properties' => {
+                                    'can_edit' => {
+                                      'type' => 'array',
+                                      'items' => {
+                                        'type' => 'boolean',
+                                      }
+                                    },
+                                    'can_delete' => {
+                                      'type' => 'boolean',
+                                    },
+                                    'can_rename' => {
+                                      'type' => 'boolean',
+                                      'description' => 'Can rename the widget.',
+                                    },
+                                  },
+                                },
+                              },
+                            },
+                          }
+                        }
+                      )
+                    end
+                  end
+
+                  context 'when formatting a hash field' do
+                    let(:field_configuration_tree) do
+                      {
+                        _config: {
+                          type: 'hash',
+                          info: 'Details about the widget',
+                        },
+                        widget_name: {
+                          _config: {
+                            required: true,
+                            type: 'string',
+                            info: 'the name of the widget',
+                            nodoc: false
+                          },
+                        },
+                        widget_permissions: {
+                          _config: {
+                            type: 'array',
+                            item_type: 'string',
+                            info: 'the permissions of the widget',
+                            nodoc: false
+                          },
+                        },
+                      }
+                    end
+
+                    it 'returns the formatted field schema' do
+                      expect(subject).to eq(
+                        'type' => 'object',
+                        'description' => 'Details about the widget.',
+                        'required' => ['widget_name'],
+                        'properties' => {
+                          'widget_name' => {
+                            'type' => 'string',
+                            'description' => 'The name of the widget.',
+                          },
+                          'widget_permissions' => {
+                            'type' => 'array',
+                            'description' => 'The permissions of the widget.',
+                            'items' => {
+                              'type' => 'string',
+                            }
+                          }
+                        }
+                      )
+                    end
+                  end
+                end
+
+                context 'when formatting params with dynamic keys' do
+                  context 'when formatting a hash param' do
+                    let(:field_configuration_tree) do
+                      {
+                        _config: {
+                          type: 'hash',
+                          info: 'Dynamic keys hash.',
+                        },
+                        _dynamic_key: {
+                          _config: {
+                            nodoc: false,
+                            type: 'hash',
+                            dynamic_key: true,
+                            info: 'a dynamic description.'
+                          },
+                          blah: {
+                            _config: {
+                              nodoc: false,
+                              type: 'string',
+                            },
+                          },
+                        },
+                      }
+                    end
+
+                    it 'returns the formatted field schema' do
+                      expect(subject).to eq({
+                        'type' => 'object',
+                        'description' => 'Dynamic keys hash.',
+                        'additionalProperties' => {
+                          'type' => 'object',
+                          'description' => 'A dynamic description.',
+                          'properties' => {
+                            'blah' => {
+                              'type' => 'string',
+                            },
+                          },
+                        },
+                      })
+                    end
+                  end
+
+                  context 'when formatting a nested hash field' do
+                    let(:field_configuration_tree) do
+                      {
+                        _config: {
+                          type: 'hash',
+                          info: 'Dynamic keys hash.',
+                        },
+                        non_dynamic_key: {
+                          _config: {
+                            nodoc: false,
+                            type: 'hash',
+                            info: 'A non-dynamic description.'
+                          },
+                          non_dynamic_property: {
+                            _config: {
+                              nodoc: false,
+                              type: 'string',
+                            },
+                          },
+                        },
+                        _dynamic_key: {
+                          _config: {
+                            nodoc: false,
+                            type: 'hash',
+                            dynamic_key: true,
+                            required: true,
+                            info: 'A dynamic description.'
+                          },
+                          dynamic_property1: {
+                            _config: {
+                              nodoc: false,
+                              type: 'string',
+                              required: true,
+                            },
+                          },
+                          _dynamic_key: {
+                            _config: {
+                              nodoc: false,
+                              type: 'hash',
+                              dynamic_key: true,
+                              info: 'A 2nd dynamic description.'
+                            },
+                            _dynamic_key: {
+                              _config: {
+                                nodoc: false,
+                                type: 'string',
+                                dynamic_key: true,
+                                info: 'A dynamic string.',
+                                required: true,
+                              },
+                            },
+                            dynamic_property2: {
+                              _config: {
+                                nodoc: false,
+                                type: 'string',
+                              },
+                            },
+                          },
+                        },
+                      }
+                    end
+
+                    it 'returns the formatted field schema' do
+                      expect(subject).to eq({
+                        'type' => 'object',
+                        'description' => 'Dynamic keys hash.',
+                        'properties' => {
+                          'non_dynamic_key' => {
+                            'type' => 'object',
+                            'description' => 'A non-dynamic description.',
+                            'properties' => {
+                              'non_dynamic_property' => {
+                                'type' => 'string',
+                              }
+                            }
+                          },
+                        },
+                        'additionalProperties' => {
+                          'type' => 'object',
+                          'description' => 'A dynamic description.',
+                          'required' => ['dynamic_property1'],
+                          'properties' => {
+                            'dynamic_property1' => {
+                              'type' => 'string',
+                            },
+                          },
+                          'additionalProperties' => {
+                            'type' => 'object',
+                            'description' => 'A 2nd dynamic description.',
+                            'properties' => {
+                              'dynamic_property2' => {
+                                'type' => 'string',
+                              },
+                            },
+                            'additionalProperties' => {
+                              'type' => 'string',
+                              'description' => 'A dynamic string.',
+                            },
+                          },
+                        },
+                      })
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/presenter_field_formatter_spec.rb

@@ -0,0 +1,237 @@
+require 'spec_helper'
+require 'brainstem/api_docs/presenter'
+require 'brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/presenter_field_formatter'
+
+module Brainstem
+  module ApiDocs
+    module Formatters
+      module OpenApiSpecification
+        module Version2
+          module FieldDefinitions
+            describe PresenterFieldFormatter do
+              describe '#format' do
+                let(:presenter_class) do
+                  Class.new(Brainstem::Presenter) do
+                    presents Workspace
+                  end
+                end
+                let(:presenter)    { Presenter.new(Object.new, const: presenter_class, target_class: 'Workspace') }
+                let(:conditionals) { {} }
+                let(:field)        { presenter.valid_fields.values.first }
+                
+
+                subject { described_class.new(presenter, field).format }
+
+                before do
+                  stub(presenter).conditionals { conditionals }
+                end
+
+                context 'when formatting non-nested field' do
+                  before do
+                    presenter_class.fields do
+                      field :sprocket_name, :string, via: :name, info: 'The name of the sprocket'
+                    end
+                  end
+
+                  it 'returns the formatted field schema' do
+                    expect(subject).to eq(
+                      'type' => 'string',
+                      'description' => 'The name of the sprocket.',
+                    )
+                  end
+                end
+
+                context 'when formatting nested field' do
+                  context 'when formatting an array field' do
+                    before do
+                      presenter_class.fields do
+                        field :sprocket_names, :array, info: 'All the names for the sprocket'
+                      end
+                    end
+
+                    it 'returns the formatted field schema' do
+                      expect(subject).to eq(
+                        'type' => 'array',
+                        'description' => 'All the names for the sprocket.',
+                        'items' => {
+                          'type' => 'string',
+                        }
+                      )
+                    end
+                  end
+
+                  context 'when formatting a nested array field with non nested data type' do
+                    before do
+                      presenter_class.fields do
+                        field :sprocket_usages, :array,
+                          item_type: :decimal,
+                          nested_levels: 3,
+                          info: 'All the names for the sprocket'
+                      end
+                    end
+
+                    it 'returns the formatted field schema' do
+                      expect(subject).to eq(
+                        'type' => 'array',
+                        'description' => 'All the names for the sprocket.',
+                        'items' => {
+                          'type' => 'array',
+                          'items' => {
+                            'type' => 'array',
+                            'items' => {
+                              'type' => 'number',
+                              'format' => 'float'
+                            }
+                          }
+                        }
+                      )
+                    end
+                  end
+
+                  context 'when formatting a nested array field with objects' do
+                    before do
+                      presenter_class.fields do
+                        fields :sprockets, :array, nested_levels: 2, info: 'I am a sprocket' do
+                          field :widget_name, :string,
+                            info: 'the name of the widget'
+
+                          fields :widget_permissions, :array, info: 'the permissions of the widget' do
+                            field :can_edit, :array,
+                              nested_levels: 3,
+                              item_type: 'boolean',
+                              info: 'the ethos of the widget'
+                          end
+                        end
+                      end
+                    end
+
+                    it 'formats a complicated tree with arrays and hashes as children' do
+                      expect(subject).to eq(
+                        'type' => 'array',
+                        'description' => 'I am a sprocket.',
+                        'items' => {
+                          'type' => 'array',
+                          'items' => {
+                            'type' => 'object',
+                            'properties' => {
+                              'widget_name' => {
+                                'type' => 'string',
+                                'description' => 'The name of the widget.',
+                              },
+                              'widget_permissions' => {
+                                'type' => 'array',
+                                'description' => 'The permissions of the widget.',
+                                'items' => {
+                                  'type' => 'object',
+                                  'properties' => {
+                                    'can_edit' => {
+                                      'type' => 'array',
+                                      'description' => 'The ethos of the widget.',
+                                      'items' => {
+                                        'type' => 'array',
+                                        'items' => {
+                                          'type' => 'array',
+                                          'items' => {
+                                            'type' => 'boolean'
+                                          }
+                                        }
+                                      }
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      )
+                    end
+                  end
+
+                  context 'when formatting a hash field' do
+                    before do
+                      presenter_class.fields do
+                        fields :sprockets, :hash, info: 'Details about the widget' do
+                          field :widget_name, :string,
+                            info: 'the name of the widget'
+
+                          fields :widget_permissions, :array, info: 'the permissions of the widget' do
+                            field :can_edit, :boolean,
+                              info: 'can edit the widget'
+                          end
+                        end
+                      end
+                    end
+
+                    it 'returns the formatted field schema' do
+                      expect(subject).to eq(
+                        'type' => 'object',
+                        'description' => 'Details about the widget.',
+                        'properties' => {
+                          'widget_name' => {
+                            'type' => 'string',
+                            'description' => 'The name of the widget.',
+                          },
+                          'widget_permissions' => {
+                            'type' => 'array',
+                            'description' => 'The permissions of the widget.',
+                            'items' => {
+                              'type' => 'object',
+                              'properties' => {
+                                'can_edit' => {
+                                  'type' => 'boolean',
+                                  'description' => 'Can edit the widget.'
+                                }
+                              }
+                            }
+                          }
+                        }
+                      )
+                    end
+                  end
+
+                  context 'when formatting a multi nested hash field' do
+                    before do
+                      presenter_class.fields do
+                        fields :sprockets do
+                          field :widget_name, :string,
+                            info: 'the name of the widget'
+
+                          fields :widget_permissions, :hash, info: 'the permissions of the widget' do
+                            field :can_edit, :boolean,
+                              info: 'can edit the widget'
+                          end
+                        end
+                      end
+                    end
+
+                    it 'returns the formatted field schema' do
+                      expect(subject).to eq(
+                        'type' => 'object',
+                        'properties' => {
+                          'widget_name' => {
+                            'type' => 'string',
+                            'description' => 'The name of the widget.',
+                          },
+                          'widget_permissions' => {
+                            'type' => 'object',
+                            'description' => 'The permissions of the widget.',
+                            'properties' => {
+                              'can_edit' => {
+                                'type' => 'boolean',
+                                'description' => 'Can edit the widget.',
+                              }
+                            }
+                          }
+                        }
+                      )
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end