feat: allow using objects as top level fieldsets

Author: adamcooke

lib/apia/definitions/endpoint.rb

@@ -36,6 +36,19 @@ def potential_errors
         @potential_errors ||= Apia::ErrorSet.new
       end
 
+      def fields=(fieldset)
+        unless @fields.empty?
+          raise Apia::StandardError, 'Cannot set the fieldset on an endpoint that already has fields defined'
+        end
+
+        @fields = fieldset
+        @fields_overriden = true
+      end
+
+      def fields_overriden?
+        @fields_overriden == true
+      end
+
       def dsl
         @dsl ||= DSLs::Endpoint.new(self)
       end

lib/apia/dsls/endpoint.rb

@@ -41,6 +41,10 @@ def http_status(status)
       end
 
       def field(name, *args, type: nil, **options, &block)
+        if @definition.fields_overriden?
+          raise Apia::StandardError, 'Cannot add fields to an endpoint that has a separate fieldset'
+        end
+
         if pagination_options = options.delete(:paginate)
 
           unless @definition.paginated_field.nil?
@@ -64,6 +68,10 @@ def field(name, *args, type: nil, **options, &block)
         super(name, *args, type: type, **options, &block)
       end
 
+      def fields(fieldset)
+        @definition.fields = fieldset
+      end
+
       def scopes(*names)
         names.each { |name| scope(name) }
       end

spec/specs/apia/dsls/endpoint_spec.rb

@@ -89,6 +89,13 @@
   end
 
   context '#field' do
+    context 'when an existing fieldset has been provided' do
+      it 'raises an error if another field is defined' do
+        dsl.fields Apia::FieldSet.new
+        expect { dsl.field :name, type: :string }.to raise_error Apia::StandardError
+      end
+    end
+
     context 'when paginated' do
       it 'should add a `page` argument' do
         dsl.field :widgets, type: [:string], paginate: true
@@ -125,6 +132,19 @@
     end
   end
 
+  context '#fields' do
+    it 'sets the endpoints fieldset to the given field set' do
+      fieldset = Apia::FieldSet.new
+      dsl.fields fieldset
+      expect(endpoint.fields).to eq fieldset
+    end
+
+    it 'raises an error if fields have already been defined' do
+      dsl.field :example, :string
+      expect { dsl.fields Apia::FieldSet.new }.to raise_error Apia::StandardError
+    end
+  end
+
   context '#scope' do
     it 'should add a scope' do
       dsl.scope 'example:read'