graphiti 1.2.16 → 1.3.9

data/lib/graphiti/resource/dsl.rb

@@ -5,10 +5,15 @@ module Graphiti
 
       class_methods do
         def filter(name, *args, &blk)
+          name = name.to_sym
           opts = args.extract_options!
           type_override = args[0]
 
-          if (att = get_attr(name, :filterable, raise_error: :only_unsupported))
+          if (att = (attributes[name] || extra_attributes[name]))
+            # We're opting in to filtering, so force this
+            # UNLESS the filter is guarded at the attribute level
+            att[:filterable] = true if att[:filterable] == false
+
             aliases = [name, opts[:aliases]].flatten.compact
             operators = FilterOperators.build(self, att[:type], opts, &blk)
 
@@ -22,6 +27,8 @@ module Graphiti
             end
 
             required = att[:filterable] == :required || !!opts[:required]
+            schema = !!opts[:via_attribute_dsl] ? att[:schema] : opts[:schema] != false
+
             config[:filters][name.to_sym] = {
               aliases: aliases,
               name: name.to_sym,
@@ -31,8 +38,10 @@ module Graphiti
               single: !!opts[:single],
               dependencies: opts[:dependent],
               required: required,
+              schema: schema,
               operators: operators.to_hash,
-              allow_nil: opts.fetch(:allow_nil, filters_accept_nil_by_default)
+              allow_nil: opts.fetch(:allow_nil, filters_accept_nil_by_default),
+              deny_empty: opts.fetch(:deny_empty, filters_deny_empty_by_default)
             }
           elsif (type = args[0])
             attribute name, type, only: [:filterable], allow: opts[:allow]
@@ -42,8 +51,19 @@ module Graphiti
           end
         end
 
+        def filter_group(filter_names, *args)
+          opts = args.extract_options!
+
+          Scoping::FilterGroupValidator.raise_unless_filter_group_requirement_valid!(self, opts[:required])
+
+          config[:grouped_filters] = {
+            names: filter_names,
+            required: opts[:required]
+          }
+        end
+
         def sort_all(&blk)
-          if block_given?
+          if blk
             config[:_sort_all] = blk
           else
             config[:_sort_all]
@@ -55,7 +75,7 @@ module Graphiti
 
           if get_attr(name, :sortable, raise_error: :only_unsupported)
             config[:sorts][name] = {
-              proc: blk,
+              proc: blk
             }.merge(opts.slice(:only))
           elsif (type = args[0])
             attribute name, type, only: [:sortable]
@@ -78,7 +98,7 @@ module Graphiti
         def default_filter(name = nil, &blk)
           name ||= :__default
           config[:default_filters][name.to_sym] = {
-            filter: blk,
+            filter: blk
           }
         end
 
@@ -117,7 +137,7 @@ module Graphiti
           options[:sortable] ? sort(name) : config[:sorts].delete(name)
 
           if options[:filterable]
-            filter(name, allow: options[:allow])
+            filter(name, allow: options[:allow], via_attribute_dsl: true)
           else
             config[:filters].delete(name)
           end
@@ -132,8 +152,10 @@ module Graphiti
             writable: false,
             sortable: false,
             filterable: false,
+            schema: true
           }
           options = defaults.merge(options)
+          attribute_option(options, :readable)
           config[:extra_attributes][name] = options
           apply_extra_attributes_to_serializer
         end
@@ -146,6 +168,10 @@ module Graphiti
           end
         end
 
+        def link(name, &blk)
+          config[:links][name.to_sym] = blk
+        end
+
         def all_attributes
           attributes.merge(extra_attributes)
         end
@@ -163,9 +189,9 @@ module Graphiti
         def attribute_option(options, name, exclusive = false)
           if options[name] != false
             default = if (only = options[:only]) && !exclusive
-              Array(only).include?(name) ? true : false
+              Array(only).include?(name)
             elsif (except = options[:except]) && !exclusive
-              Array(except).include?(name) ? false : true
+              !Array(except).include?(name)
             else
               send(:"attributes_#{name}_by_default")
             end

data/lib/graphiti/resource/interface.rb

@@ -11,7 +11,7 @@ module Graphiti
 
         # @api private
         def _all(params, opts, base_scope)
-          runner = Runner.new(self, params, opts.delete(:query))
+          runner = Runner.new(self, params, opts.delete(:query), :all)
           opts[:params] = params
           runner.proxy(base_scope, opts)
         end
@@ -23,11 +23,14 @@ module Graphiti
 
         # @api private
         def _find(params = {}, base_scope = nil)
+          guard_nil_id!(params[:data])
+          guard_nil_id!(params)
+
           id = params[:data].try(:[], :id) || params.delete(:id)
           params[:filter] ||= {}
           params[:filter][:id] = id if id
 
-          runner = Runner.new(self, params)
+          runner = Runner.new(self, params, nil, :find)
           runner.proxy base_scope,
             single: true,
             raise_on_missing: true,
@@ -43,7 +46,7 @@ module Graphiti
         private
 
         def validate!(params)
-          return unless validate_endpoints?
+          return if Graphiti.context[:graphql] || !validate_endpoints?
 
           if context&.respond_to?(:request)
             path = context.request.env["PATH_INFO"]
@@ -52,6 +55,13 @@ module Graphiti
             end
           end
         end
+
+        def guard_nil_id!(params)
+          return unless params
+          if params.key?(:id) && params[:id].nil?
+            raise Errors::UndefinedIDLookup.new(self)
+          end
+        end
       end
     end
   end

data/lib/graphiti/resource/links.rb

@@ -39,7 +39,7 @@ module Graphiti
           path: path,
           full_path: full_path_for(path),
           url: url_for(path),
-          actions: DEFAULT_ACTIONS.dup,
+          actions: DEFAULT_ACTIONS.dup
         }
       end
 
@@ -49,7 +49,7 @@ module Graphiti
           path: path,
           full_path: full_path_for(path),
           url: url_for(path),
-          actions: actions,
+          actions: actions
         }
       end
 
@@ -60,7 +60,7 @@ module Graphiti
           path: path,
           full_path: full_path_for(path),
           url: url_for(path),
-          actions: actions,
+          actions: actions
         }]
       end
 

data/lib/graphiti/resource/persistence.rb

@@ -89,7 +89,8 @@ module Graphiti
 
       def update(update_params, meta = nil)
         model_instance = nil
-        id = update_params.delete(:id)
+        id = update_params[:id]
+        update_params = update_params.except(:id)
 
         run_callbacks :persistence, :update, update_params, meta do
           run_callbacks :attributes, :update, update_params, meta do |params|

data/lib/graphiti/resource/polymorphism.rb

@@ -42,9 +42,14 @@ module Graphiti
         end
 
         def sideload(name)
-          sl = super
+          if (split_on = name.to_s.split(/^on__/)).length > 1
+            on_type, name = split_on[1].split("--").map(&:to_sym)
+          end
+
+          sl = super(name)
           if !polymorphic_child? && sl.nil?
             children.each do |c|
+              next if on_type && c.type != on_type
               break if (sl = c.sideloads[name])
             end
           end
@@ -67,7 +72,8 @@ module Graphiti
         end
 
         def resource_for_model(model)
-          resource = children.find { |c| model.is_a?(c.model) }
+          resource = children.find { |c| model.instance_of?(c.model) } ||
+            children.find { |c| model.is_a?(c.model) }
           if resource.nil?
             raise Errors::PolymorphicResourceChildNotFound.new(self, model: model)
           else

data/lib/graphiti/resource/remote.rb

@@ -19,7 +19,7 @@ module Graphiti
       end
 
       def save(model, meta)
-        if meta[:attributes] == {} && meta[:method] == :update
+        if meta[:attributes].except(:id) == {} && meta[:method] == :update
           model
         else
           raise Errors::RemoteWrite.new(self.class)
@@ -31,7 +31,7 @@ module Graphiti
       end
 
       def before_resolve(scope, query)
-        scope[:params] = Util::RemoteParams.generate(self, query)
+        scope[:params] = Util::RemoteParams.generate(self, query, scope[:foreign_key])
         scope
       end
 

data/lib/graphiti/resource/sideloading.rb

@@ -68,10 +68,10 @@ module Graphiti
           model_ref = model
           has_many name, opts do
             params do |hash|
-              hash[:filter][:"#{as}_type"] = model_ref.name
+              hash[:filter][:"#{as}_type"] = { eql: model_ref.name }
             end
 
-            instance_eval(&blk) if block_given?
+            instance_eval(&blk) if blk
           end
         end
 
@@ -82,10 +82,10 @@ module Graphiti
           model_ref = model
           has_one name, opts do
             params do |hash|
-              hash[:filter][:"#{as}_type"] = model_ref.name
+              hash[:filter][:"#{as}_type"] = { eql: model_ref.name }
             end
 
-            instance_eval(&blk) if block_given?
+            instance_eval(&blk) if blk
           end
         end
 

data/lib/graphiti/resource.rb

@@ -28,11 +28,12 @@ module Graphiti
       serializer
     end
 
-    def decorate_record(record)
+    def decorate_record(record, index = nil)
       unless record.instance_variable_get(:@__graphiti_serializer)
         serializer = serializer_for(record)
         record.instance_variable_set(:@__graphiti_serializer, serializer)
         record.instance_variable_set(:@__graphiti_resource, self)
+        record.instance_variable_set(:@__graphiti_index, index) if index
       end
     end
 
@@ -148,5 +149,15 @@ module Graphiti
       end
       response
     end
+
+    def links?
+      self.class.links.any?
+    end
+
+    def links(model)
+      self.class.links.each_with_object({}) do |(name, blk), memo|
+        memo[name] = instance_exec(model, &blk)
+      end
+    end
   end
 end

data/lib/graphiti/resource_proxy.rb

@@ -47,10 +47,22 @@ module Graphiti
       Renderer.new(self, options).to_json
     end
 
+    def as_json(options = {})
+      Renderer.new(self, options).as_json
+    end
+
     def to_xml(options = {})
       Renderer.new(self, options).to_xml
     end
 
+    def to_graphql(options = {})
+      Renderer.new(self, options).to_graphql
+    end
+
+    def as_graphql(options = {})
+      Renderer.new(self, options).as_graphql
+    end
+
     def data
       @data ||= begin
         records = @scope.resolve
@@ -61,7 +73,7 @@ module Graphiti
         records
       end
     end
-    alias to_a data
+    alias_method :to_a, :data
 
     def meta
       @meta ||= data.respond_to?(:meta) ? data.meta : {}
@@ -73,9 +85,15 @@ module Graphiti
 
     def stats
       @stats ||= if @query.hash[:stats]
+        scope = @scope.unpaginated_object
+        if resource.adapter.can_group?
+          if (group = @query.hash[:stats].delete(:group_by))
+            scope = resource.adapter.group(scope, group[0])
+          end
+        end
         payload = Stats::Payload.new @resource,
           @query,
-          @scope.unpaginated_object,
+          scope,
           data
         payload.generate
       else
@@ -93,7 +111,7 @@ module Graphiti
       original = Graphiti.context[:namespace]
       begin
         Graphiti.context[:namespace] = action
-        ::Graphiti::RequestValidator.new(@resource, @payload.params).validate!
+        ::Graphiti::RequestValidator.new(@resource, @payload.params, action).validate!
         validator = persist {
           @resource.persist_with_relationships \
             @payload.meta(action: action),
@@ -118,6 +136,7 @@ module Graphiti
     end
 
     def destroy
+      data
       transaction_response = @resource.transaction do
         metadata = {method: :destroy}
         model = @resource.destroy(@query.filters[:id], metadata)
@@ -135,6 +154,7 @@ module Graphiti
     end
 
     def update_attributes
+      data
       save(action: :update)
     end
 

data/lib/graphiti/runner.rb

@@ -3,13 +3,13 @@ module Graphiti
     attr_reader :params
     attr_reader :deserialized_payload
 
-    def initialize(resource_class, params, query = nil)
+    def initialize(resource_class, params, query = nil, action = nil)
       @resource_class = resource_class
       @params = params
       @query = query
+      @action = action
 
-      validator = RequestValidator.new(jsonapi_resource, params)
-
+      validator = RequestValidator.new(jsonapi_resource, params, action)
       validator.validate!
 
       @deserialized_payload = validator.deserialized_payload
@@ -30,7 +30,7 @@ module Graphiti
     end
 
     def query
-      @query ||= Query.new(jsonapi_resource, params)
+      @query ||= Query.new(jsonapi_resource, params, nil, nil, [], @action)
     end
 
     def query_hash
@@ -50,7 +50,7 @@ module Graphiti
     def jsonapi_render_options
       options = {}
       options.merge!(default_jsonapi_render_options)
-      options[:meta]   ||= {}
+      options[:meta] ||= {}
       options[:expose] ||= {}
       options[:expose][:context] = jsonapi_context
       options

data/lib/graphiti/schema.rb

@@ -7,6 +7,7 @@ module Graphiti
       ::Rails.application.eager_load! if defined?(::Rails)
       resources ||= Graphiti.resources.reject(&:abstract_class?)
       resources.reject! { |r| r.name.nil? }
+
       new(resources).generate
     end
 
@@ -25,7 +26,7 @@ module Graphiti
 
     def initialize(resources)
       @resources = resources.sort_by(&:name)
-      @remote_resources = resources.select(&:remote?)
+      @remote_resources = @resources.select(&:remote?)
       @local_resources = @resources - @remote_resources
     end
 
@@ -33,7 +34,7 @@ module Graphiti
       {
         resources: generate_resources,
         endpoints: generate_endpoints,
-        types: generate_types,
+        types: generate_types
       }
     end
 
@@ -89,14 +90,20 @@ module Graphiti
         config = {
           name: r.name,
           type: r.type.to_s,
+          graphql_entrypoint: r.graphql_entrypoint.to_s,
           description: r.description,
           attributes: attributes(r),
           extra_attributes: extra_attributes(r),
           sorts: sorts(r),
           filters: filters(r),
           relationships: relationships(r),
+          stats: stats(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}
@@ -108,7 +115,7 @@ module Graphiti
           config[:default_page_size] = r.default_page_size
         end
 
-        if r.polymorphic?
+        if r.polymorphic? && !r.polymorphic_child?
           config[:polymorphic] = true
           config[:children] = r.children.map(&:name)
         end
@@ -121,7 +128,7 @@ module Graphiti
           name: r.name,
           description: r.description,
           remote: r.remote_url,
-          relationships: relationships(r),
+          relationships: relationships(r)
         }
       }
 
@@ -136,7 +143,7 @@ module Graphiti
               type: config[:type].to_s,
               readable: flag(config[:readable]),
               writable: flag(config[:writable]),
-              description: resource.attribute_description(name),
+              description: resource.attribute_description(name)
             }
           end
         end
@@ -146,10 +153,12 @@ module Graphiti
     def extra_attributes(resource)
       {}.tap do |attrs|
         resource.extra_attributes.each_pair do |name, config|
+          next unless config[:schema]
+
           attrs[name] = {
             type: config[:type].to_s,
             readable: flag(config[:readable]),
-            description: resource.attribute_description(name),
+            description: resource.attribute_description(name)
           }
         end
       end
@@ -163,14 +172,22 @@ module Graphiti
       end
     end
 
+    def stats(resource)
+      {}.tap do |stats|
+        resource.stats.each_pair do |name, config|
+          stats[name] = config.calculations.keys
+        end
+      end
+    end
+
     def sorts(resource)
       {}.tap do |s|
         resource.sorts.each_pair do |name, sort|
-          next unless resource.attributes[name][:schema]
+          attr = resource.all_attributes[name]
+          next unless attr[:schema]
 
           config = {}
           config[:only] = sort[:only] if sort[:only]
-          attr = resource.attributes[name]
           if attr[:sortable].is_a?(Symbol)
             config[:guard] = true
           end
@@ -182,11 +199,11 @@ module Graphiti
     def filters(resource)
       {}.tap do |f|
         resource.filters.each_pair do |name, filter|
-          next unless resource.attributes[name][:schema]
+          next unless resource.filters[name][:schema]
 
           config = {
             type: filter[:type].to_s,
-            operators: filter[:operators].keys.map(&:to_s),
+            operators: filter[:operators].keys.map(&:to_s)
           }
 
           config[:single] = true if filter[:single]
@@ -194,7 +211,7 @@ module Graphiti
           config[:deny] = filter[:deny].map(&:to_s) if filter[:deny]
           config[:dependencies] = filter[:dependencies].map(&:to_s) if filter[:dependencies]
 
-          attr = resource.attributes[name]
+          attr = resource.all_attributes[name]
           if attr[:filterable].is_a?(Symbol)
             if attr[:filterable] == :required
               config[:required] = true
@@ -202,11 +219,18 @@ module Graphiti
               config[:guard] = true
             end
           end
+          if filter[:required] # one-off filter, not attribute
+            config[:required] = true
+          end
           f[name] = config
         end
       end
     end
 
+    def filter_group(resource)
+      resource.config[:grouped_filters]
+    end
+
     def relationships(resource)
       {}.tap do |r|
         resource.sideloads.each_pair do |name, config|
@@ -214,6 +238,7 @@ module Graphiti
           if config.type == :polymorphic_belongs_to
             schema[:resources] = config.children.values
               .map(&:resource).map(&:class).map(&:name)
+            schema[:parent_resource] = config.parent_resource.class.name
           else
             schema[:resource] = config.resource.class.name
           end

data/lib/graphiti/schema_diff.rb

@@ -1,8 +1,8 @@
 module Graphiti
   class SchemaDiff
     def initialize(old, new)
-      @old = old.deep_symbolize_keys
-      @new = new.deep_symbolize_keys
+      @old = JSON.parse(old.to_json).deep_symbolize_keys
+      @new = JSON.parse(new.to_json).deep_symbolize_keys
       @errors = []
     end
 
@@ -30,6 +30,8 @@ module Graphiti
           compare_extra_attributes(r, new_resource)
           compare_sorts(r, new_resource)
           compare_filters(r, new_resource)
+          compare_filter_group(r, new_resource)
+          compare_stats(r, new_resource)
           compare_relationships(r, new_resource)
         end
       end
@@ -133,12 +135,12 @@ module Graphiti
         end
 
         if new_sort[:only] && !old_sort[:only]
-          @errors << "#{old_resource[:name]}: sort #{name.inspect} now limited to only #{new_sort[:only].inspect}."
+          @errors << "#{old_resource[:name]}: sort #{name.inspect} now limited to only #{new_sort[:only].to_sym.inspect}."
         end
 
         if new_sort[:only] && old_sort[:only]
           if new_sort[:only] != old_sort[:only]
-            @errors << "#{old_resource[:name]}: sort #{name.inspect} was limited to only #{old_sort[:only].inspect}, now limited to only #{new_sort[:only].inspect}."
+            @errors << "#{old_resource[:name]}: sort #{name.inspect} was limited to only #{old_sort[:only].to_sym.inspect}, now limited to only #{new_sort[:only].to_sym.inspect}."
           end
         end
       end
@@ -204,6 +206,44 @@ module Graphiti
       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.map(&:to_sym).inspect} added #{"member".pluralize(diff.length)} #{diff.map(&:to_sym).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.map(&:to_sym).inspect} moved from required: :any to required: :all"
+          end
+        else
+          @errors << "#{old_resource[:name]}: filter group #{new_resource[:filter_group][:names].map(&:to_sym).inspect} was added."
+        end
+      end
+    end
+
+    def compare_stats(old_resource, new_resource)
+      return unless old_resource.key?(:stats)
+
+      old_resource[:stats].each_pair do |name, old_calculations|
+        new_calculations = new_resource[:stats][name]
+        if new_calculations
+          old_calculations.each do |calc|
+            unless new_calculations.include?(calc)
+              @errors << "#{old_resource[:name]}: calculation #{calc.to_sym.inspect} was removed from stat #{name.inspect}."
+            end
+          end
+        else
+          @errors << "#{old_resource[:name]}: stat #{name.inspect} was removed."
+        end
+      end
+    end
+
     def compare_endpoints
       @old[:endpoints].each_pair do |path, old_endpoint|
         unless (new_endpoint = @new[:endpoints][path])