Add filter_group to schema/diffing

Scenarios for diffing are best outlined in the spec, but should be
anything that would cause a client to break (for instance adding to the
group when all are required).

Author: Lee Richmond

lib/graphiti/schema.rb

@@ -99,6 +99,10 @@ def generate_resources
           relationships: relationships(r)
         }
 
+        if r.grouped_filters.any?
+          config[:filter_group] = r.grouped_filters
+        end
+
         if r.default_sort
           default_sort = r.default_sort.map { |s|
             {s.keys.first.to_s => s.values.first.to_s}
@@ -212,6 +216,10 @@ def filters(resource)
       end
     end
 
+    def filter_group(resource)
+      resource.config[:grouped_filters]
+    end
+
     def relationships(resource)
       {}.tap do |r|
         resource.sideloads.each_pair do |name, config|

lib/graphiti/schema_diff.rb

@@ -30,6 +30,7 @@ def compare_resources
           compare_extra_attributes(r, new_resource)
           compare_sorts(r, new_resource)
           compare_filters(r, new_resource)
+          compare_filter_group(r, new_resource)
           compare_relationships(r, new_resource)
         end
       end
@@ -204,6 +205,27 @@ def compare_filters(old_resource, new_resource)
       end
     end
 
+    def compare_filter_group(old_resource, new_resource)
+      if new_resource[:filter_group]
+        if old_resource[:filter_group]
+          new_names = new_resource[:filter_group][:names]
+          old_names = old_resource[:filter_group][:names]
+          diff = new_names - old_names
+          if !diff.empty? && new_resource[:filter_group][:required] == :all
+            @errors << "#{old_resource[:name]}: all required filter group #{old_names.inspect} added #{"member".pluralize(diff.length)} #{diff.inspect}."
+          end
+
+          old_required = old_resource[:filter_group][:required]
+          new_required = new_resource[:filter_group][:required]
+          if old_required == :any && new_required == :all
+            @errors << "#{old_resource[:name]}: filter group #{old_names.inspect} moved from required: :any to required: :all"
+          end
+        else
+          @errors << "#{old_resource[:name]}: filter group #{new_resource[:filter_group][:names].inspect} was added."
+        end
+      end
+    end
+
     def compare_endpoints
       @old[:endpoints].each_pair do |path, old_endpoint|
         unless (new_endpoint = @new[:endpoints][path])

spec/schema_diff_spec.rb

@@ -728,6 +728,112 @@ def self.name
       end
     end
 
+    context "when a filter group is added" do
+      before do
+        resource_b.filter_group [:first_name, :last_name], required: :any
+      end
+
+      it "returns error" do
+        expect(diff).to eq([
+          "SchemaDiff::EmployeeResource: filter group [:first_name, :last_name] was added."
+        ])
+      end
+    end
+
+    context "when a filter group is removed" do
+      before do
+        resource_b
+        resource_a.filter_group [:first_name, :last_name], required: :any
+      end
+
+      it "has no errors" do
+        expect(diff).to eq([])
+      end
+    end
+
+    context "when a filter group removes a name" do
+      before do
+        resource_b.filter_group [:last_name], required: :any
+        resource_a.filter_group [:first_name, :last_name], required: :any
+      end
+
+      it "has no errors" do
+        expect(diff).to eq([])
+      end
+    end
+
+    context "when a filter group adds a name" do
+      before do
+        resource_b.filter_group [:first_name, :last_name], required: required
+        resource_a.filter_group [:first_name], required: required
+      end
+
+      context "and any are required" do
+        let(:required) { :any }
+
+        it "has no errors" do
+          expect(diff).to eq([])
+        end
+      end
+
+      context "and all are required" do
+        let(:required) { :all }
+
+        it "returns error" do
+          expect(diff).to eq([
+            "SchemaDiff::EmployeeResource: all required filter group [:first_name] added member [:last_name]."
+          ])
+        end
+      end
+    end
+
+    context "when a filter group removes a name" do
+      before do
+        resource_b.filter_group [:first_name], required: required
+        resource_a.filter_group [:first_name, :last_name], required: required
+      end
+
+      context "and any are required" do
+        let(:required) { :any }
+
+        it "has no errors" do
+          expect(diff).to eq([])
+        end
+      end
+
+      context "and all are required" do
+        let(:required) { :all }
+
+        it "has no errors" do
+          expect(diff).to eq([])
+        end
+      end
+    end
+
+    context "when a filter group goes from :all to :any" do
+      before do
+        resource_b.filter_group [:first_name, :last_name], required: :any
+        resource_a.filter_group [:first_name, :last_name], required: :all
+      end
+
+      it "has no errors" do
+        expect(diff).to eq([])
+      end
+    end
+
+    context "when a filter group goes from :any to :all" do
+      before do
+        resource_b.filter_group [:first_name, :last_name], required: :all
+        resource_a.filter_group [:first_name, :last_name], required: :any
+      end
+
+      it "returns error" do
+        expect(diff).to eq([
+          "SchemaDiff::EmployeeResource: filter group [:first_name, :last_name] moved from required: :any to required: :all"
+        ])
+      end
+    end
+
     context "when filter goes unguarded to guarded" do
       before do
         resource_b.attribute :foo, :string, filterable: :admin?

spec/schema_spec.rb

@@ -475,6 +475,20 @@ def self.name
       end
     end
 
+    context "when a filter group" do
+      before do
+        employee_resource.filter_group [:first_name, :last_name],
+          required: :any
+      end
+
+      it "is present in the schema" do
+        expect(schema[:resources][0][:filter_group]).to eq({
+          names: [:first_name, :last_name],
+          required: :any
+        })
+      end
+    end
+
     context "when the attribute is a string enum" do
       before do
         employee_resource.class_eval do