graphiti 1.0.rc.26 → 1.0.rc.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3914d079757237601c7908f6e1aa18ef2696eb95c5f5362b79c901da46c62676
-  data.tar.gz: 203b947f0bad1ed2ce4fb8538aa5e7e79e7ad727e8a068655b4a0219bbf0adab
+  metadata.gz: 8657023a3ffabe32824165c3bca07a95a9cb24fd9043d75a773f464674edccf8
+  data.tar.gz: 6fe6875932185fa63ddde8e21545b55e5aea7bca78d8079455be1d77d1e9fa0e
 SHA512:
-  metadata.gz: 8e10a7536f8ecd7c88f0c32b736927c6eccc6786327c4da65565a06862acf0ea221593758cc3d9a95702c5fc98f4463666690ed0be07d6d399e41657b0a84c2e
-  data.tar.gz: 154f6a7cb34432fcf1b1361e8793123c2d4280838d4c91addc7f13c5736f6f351a9bba9cb4a2596550b4bc58fd98ab0e4985985d6724aaaed33532c483fb39a1
+  metadata.gz: 354df547792b57898e0ef53e47e89e9c0f73499371d54dcb42bddea256b481e6d460f3860f6801dcce99fdd922557225671caf4957cd7756cdaa1097312e3f44
+  data.tar.gz: 9a2a57b65a0fce0863cdf473fb87e48452b92e3e201a1797d90f19ccf363b43e8a8fca332910e6095eb0eb7b6416aa9e92d00b3a1dc00d42b528914047608911

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 1.x
+
+### master (unreleased)
+
+<!-- ### [version (YYYY-MM-DD)](diff_link) -->
+<!-- Breaking changes:-->
+<!-- Features:-->
+<!-- Fixes:-->
+<!-- Misc:-->

data/README.md

@@ -1,10 +1,16 @@
-### Graphiti
-
 ![Build Status](https://travis-ci.org/graphiti-api/graphiti.svg?branch=master)
+[![Gem Version](https://badge.fury.io/rb/graphiti.svg)](https://badge.fury.io/rb/graphiti)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
+<p align="center">
+  <a href="https://www.graphiti.dev/guides">
+    <img " src="https://user-images.githubusercontent.com/55264/54884141-c10ada00-4e43-11e9-866b-e3c01e33a7c7.png" />
+  </a>                                                       
+</p>
+                                                           
 Stylish Graph APIs.
 
-[View Official Documentation](https://www.graphiti.dev/guides/)
+[Website](https://www.graphiti.dev/guides/)
 
 [Join the Slack Channel](https://join.slack.com/t/graphiti-api/shared_invite/enQtMjkyMTA3MDgxNTQzLWVkMDM3NTlmNTIwODY2YWFkMGNiNzUzZGMzOTY3YmNmZjBhYzIyZWZlZTk4YmI1YTI0Y2M0OTZmZGYwN2QxZjg)
 

data/lib/graphiti/adapters/abstract.rb

@@ -36,6 +36,7 @@ module Graphiti
             :not_match,
           ],
           uuid: [:eq, :not_eq],
+          enum: [:eq, :not_eq],
           integer_id: numerical_operators,
           integer: numerical_operators,
           big_decimal: numerical_operators,

data/lib/graphiti/adapters/active_record.rb

@@ -25,6 +25,7 @@ module Graphiti
       alias filter_date_eq filter_eq
       alias filter_boolean_eq filter_eq
       alias filter_uuid_eq filter_eq
+      alias filter_enum_eq filter_eq
 
       def filter_not_eq(scope, attribute, value)
         scope.where.not(attribute => value)
@@ -35,6 +36,7 @@ module Graphiti
       alias filter_date_not_eq filter_not_eq
       alias filter_boolean_not_eq filter_not_eq
       alias filter_uuid_not_eq filter_not_eq
+      alias filter_enum_not_eq filter_not_eq
 
       def filter_string_eq(scope, attribute, value, is_not: false)
         column = column_for(scope, attribute)

data/lib/graphiti/adapters/active_record/inferrence.rb

@@ -5,9 +5,20 @@ module Graphiti::Adapters::ActiveRecord::Inferrence
     parent_model = parent_resource_class.model
     reflection = parent_model.reflections[association_name.to_s]
     if reflection
+      reflection = proper_reflection(reflection)
       reflection.foreign_key.to_sym
     else
       super
     end
   end
+
+  private
+
+  def proper_reflection(reflection)
+    if (thru = reflection.through_reflection)
+      proper_reflection(thru)
+    else
+      reflection
+    end
+  end
 end

data/lib/graphiti/errors.rb

@@ -10,7 +10,7 @@ module Graphiti
       end
 
       def message
-        <<~MSG
+        <<-MSG
           The adapter #{@adapter.class} does not implement method '#{@method}', which was requested for attribute '#{@attribute}'. Add this method to your adapter to support this filter operator.
         MSG
       end
@@ -24,7 +24,7 @@ module Graphiti
       end
 
       def message
-        <<~MSG
+        <<-MSG
           #{@parent_resource_class} sideload :#{@name} - #{@message}
         MSG
       end
@@ -53,7 +53,7 @@ module Graphiti
       end
 
       def message
-        <<~MSG
+        <<-MSG
           #{@resource_class}: Tried to pass block to .#{@method_name}, which only accepts a method name.
         MSG
       end
@@ -65,7 +65,7 @@ module Graphiti
       end
 
       def message
-        <<~MSG
+        <<-MSG
           #{@resource_class}: Tried to perform write operation. Writes are not supported for remote resources - hit the endpoint directly.
         MSG
       end
@@ -80,7 +80,7 @@ module Graphiti
       end
 
       def message
-        <<~MSG
+        <<-MSG
           #{@resource.class}: Tried to filter #{@filter_name.inspect} on operator #{@operator.inspect}, but not supported! Supported operators are #{@supported}.
         MSG
       end
@@ -93,7 +93,7 @@ module Graphiti
       end
 
       def message
-        <<~MSG
+        <<-MSG
           #{@resource.class}: Tried to persist association #{@sideload.name.inspect} but marked writable: false
         MSG
       end
@@ -106,7 +106,7 @@ module Graphiti
       end
 
       def message
-        <<~MSG
+        <<-MSG
           #{@sideload.parent_resource.class.name}: tried to sideload #{@sideload.name.inspect}, but more than one #{@sideload.parent_resource.model.name} was passed!
 
           This is because you marked the sideload #{@sideload.name.inspect} with single: true
@@ -127,7 +127,7 @@ module Graphiti
       end
 
       def message
-        <<~MSG
+        <<-MSG
           #{@resource.class.name}: tried to sort on attribute #{@attribute.inspect}, but passed #{@direction.inspect} when only #{@allowlist.inspect} is supported.
         MSG
       end
@@ -140,7 +140,7 @@ module Graphiti
       end
 
       def message
-        <<~MSG
+        <<-MSG
           #{@resource_class.name}: called .on_extra_attribute #{@name.inspect}, but extra attribute #{@name.inspect} does not exist!
         MSG
       end
@@ -156,7 +156,7 @@ module Graphiti
       def message
         allow = @filter.values[0][:allow]
         deny = @filter.values[0][:deny]
-        msg = <<~MSG
+        msg = <<-MSG
           #{@resource.class.name}: tried to filter on #{@filter.keys[0].inspect}, but passed invalid value #{@value.inspect}.
         MSG
         msg << "\nAllowlist: #{allow.inspect}" if allow
@@ -165,6 +165,30 @@ module Graphiti
       end
     end
 
+    class MissingEnumAllowList < Base
+      def initialize(resource_class, filter_name, enum_type)
+        @resource_class = resource_class
+        @filter_name = filter_name
+        @enum_type = enum_type
+      end
+
+      def message
+        <<-MSG
+          #{@resource_class.name} You declared an attribute or filter of type "#{@enum_type}" without providing a list of permitted values, which is required.
+
+          When declaring an attribute:
+
+          attribute :status, :#{@enum_type}, allow: ['published', 'draft']
+
+          When declaring a filter:
+
+          filter :status, :#{@enum_type}, allow: ['published', 'draft'] do
+            # ...
+          end
+        MSG
+      end
+    end
+
     class InvalidLink < Base
       def initialize(resource_class, sideload, action)
         @resource_class = resource_class
@@ -173,7 +197,7 @@ module Graphiti
       end
 
       def message
-        <<~MSG
+        <<-MSG
           #{@resource_class.name}: Cannot link to sideload #{@sideload.name.inspect}!
 
           Make sure the endpoint "#{@sideload.resource.endpoint[:full_path]}" exists with action #{@action.inspect}, or customize the endpoint for #{@sideload.resource.class.name}.
@@ -191,7 +215,7 @@ module Graphiti
       end
 
       def message
-        <<~MSG
+        <<-MSG
           #{@resource.class.name}: passed multiple values to filter #{@filter.keys[0].inspect}, which was marked single: true.
 
           Value was: #{@value.inspect}
@@ -206,7 +230,7 @@ module Graphiti
       end
 
       def message
-        <<~MSG
+        <<-MSG
           #{@resource_class.name}: Tried to link sideload #{@sideload.name.inspect}, but cannot generate links!
 
           Graphiti.config.context_for_endpoint must be set to enable link generation:
@@ -216,6 +240,74 @@ module Graphiti
       end
     end
 
+    class SideloadParamsError < Base
+      def initialize(resource_class, sideload_name)
+        @resource_class = resource_class
+        @sideload_name = sideload_name
+      end
+
+      def message
+        <<-MSG
+          #{@resource_class.name}: error occurred while sideloading "#{@sideload_name}"!
+
+          The error was raised while attempting to build query parameters for the associated Resource.
+          Read more about sideload scoping here: www.graphiti.dev/guides/concepts/resources#customizing-scope
+
+          A good way to debug is to put a debugger within the 'params' block.
+
+          Here's the original, underlying error:
+
+          #{cause.class.name}: #{cause}
+          #{cause.backtrace.join("\n")}
+        MSG
+      end
+    end
+
+    class SideloadQueryBuildingError < Base
+      def initialize(resource_class, sideload_name)
+        @resource_class = resource_class
+        @sideload_name = sideload_name
+      end
+
+      def message
+        <<-MSG
+          #{@resource_class.name}: error occurred while sideloading "#{@sideload_name}"!
+
+          The error was raised while attempting to build the scope for the associated Resource.
+
+          Read more about sideload scoping here: www.graphiti.dev/guides/concepts/resources#customizing-scope
+
+          Here's the original, underlying error:
+
+          #{cause.class.name}: #{cause.message}
+          #{cause.backtrace.join("\n")}
+        MSG
+      end
+    end
+
+    class SideloadAssignError < Base
+      def initialize(resource_class, sideload_name)
+        @resource_class = resource_class
+        @sideload_name = sideload_name
+      end
+
+      def message
+        <<-MSG
+          #{@resource_class.name}: error occurred while sideloading "#{@sideload_name}"!
+
+          The error was raised while attempting to assign relevant model instances. Read
+          more about sideload assignment here: www.graphiti.dev/guides/concepts/resources#customizing-assignment
+
+          A good way to debug is to put a debugger within the 'assign' block.
+
+          Here's the original, underlying error:
+
+          #{cause.class.name}: #{cause.message}
+          #{cause.backtrace.join("\n")}
+        MSG
+      end
+    end
+
     class AttributeError < Base
       attr_reader :resource,
         :name,
@@ -282,7 +374,7 @@ module Graphiti
       end
 
       def message
-        <<~MSG
+        <<-MSG
           #{@resource.class.name}: passed filter with value #{@value.inspect}, and failed attempting to parse as JSON array.
         MSG
       end
@@ -296,7 +388,7 @@ module Graphiti
       end
 
       def message
-        <<~MSG
+        <<-MSG
           #{@resource_class.name} cannot be called directly from endpoint #{@path}##{@action}!
 
           Either set a primary endpoint for this resource:

data/lib/graphiti/resource/dsl.rb

@@ -12,8 +12,13 @@ module Graphiti
             aliases = [name, opts[:aliases]].flatten.compact
             operators = FilterOperators.build(self, att[:type], opts, &blk)
 
-            if Graphiti::Types[att[:type]][:canonical_name] == :boolean
+            case Graphiti::Types[att[:type]][:canonical_name]
+            when :boolean
               opts[:single] = true
+            when :enum
+              if opts[:allow].blank?
+                raise Errors::MissingEnumAllowList.new(self, name, att[:type])
+              end
             end
 
             required = att[:filterable] == :required || !!opts[:required]
@@ -29,7 +34,7 @@ module Graphiti
               operators: operators.to_hash,
             }
           elsif (type = args[0])
-            attribute name, type, only: [:filterable]
+            attribute name, type, only: [:filterable], allow: opts[:allow]
             filter(name, opts, &blk)
           else
             raise Errors::ImplicitFilterTypeMissing.new(self, name)
@@ -100,8 +105,13 @@ module Graphiti
           options[:proc] = blk
           config[:attributes][name] = options
           apply_attributes_to_serializer
-          options[:filterable] ? filter(name) : config[:filters].delete(name)
           options[:sortable] ? sort(name) : config[:sorts].delete(name)
+
+          if options[:filterable]
+            filter(name, allow: options[:allow])
+          else
+            config[:filters].delete(name)
+          end
         end
 
         def extra_attribute(name, type, options = {}, &blk)

data/lib/graphiti/scoping/filter.rb

@@ -90,7 +90,6 @@ module Graphiti
 
         [operator, value]
       end
-
     end
 
     def validate_operator(filter, operator)

data/lib/graphiti/sideload.rb

@@ -184,14 +184,22 @@ module Graphiti
     end
 
     def load(parents, query, graph_parent)
-      params = load_params(parents, query)
-      params_proc&.call(params, parents)
-      return [] if blank_query?(params)
-      opts = load_options(parents, query)
-      opts[:sideload] = self
-      opts[:parent] = graph_parent
-      proxy = resource.class._all(params, opts, base_scope)
-      pre_load_proc&.call(proxy, parents)
+      params, opts, proxy = nil, nil, nil
+
+      with_error_handling Errors::SideloadParamsError do
+        params = load_params(parents, query)
+        params_proc&.call(params, parents)
+        return [] if blank_query?(params)
+        opts = load_options(parents, query)
+        opts[:sideload] = self
+        opts[:parent] = graph_parent
+      end
+
+      with_error_handling(Errors::SideloadQueryBuildingError) do
+        proxy = resource.class._all(params, opts, base_scope)
+        pre_load_proc&.call(proxy, parents)
+      end
+
       proxy.to_a
     end
 
@@ -362,11 +370,22 @@ module Graphiti
     end
 
     def fire_assign(parents, children)
-      if self.class.assign_proc
-        instance_exec(parents, children, &self.class.assign_proc)
-      else
-        assign(parents, children)
+      with_error_handling Errors::SideloadAssignError do
+        if self.class.assign_proc
+          instance_exec(parents, children, &self.class.assign_proc)
+        else
+          assign(parents, children)
+        end
+      end
+    end
+
+    def with_error_handling(error_class)
+      begin
+        result = yield
+      rescue
+        raise error_class.new(parent_resource_class, name)
       end
+      result
     end
 
     def fire_scope(parents)

data/lib/graphiti/types.rb

@@ -101,6 +101,22 @@ module Graphiti
             kind: "scalar",
             description: "Base Type. Like a normal string, but by default only eq/!eq and case-sensitive.",
           },
+          string_enum: {
+            canonical_name: :enum,
+            params: Dry::Types["coercible.string"],
+            read: Dry::Types["coercible.string"],
+            write: Dry::Types["coercible.string"],
+            kind: "scalar",
+            description: "String enum type. Like a normal string, but only eq/!eq and case-sensitive. Limited to only the allowed values.",
+          },
+          integer_enum: {
+            canonical_name: :enum,
+            params: Dry::Types["coercible.integer"],
+            read: Dry::Types["coercible.integer"],
+            write: Dry::Types["coercible.integer"],
+            kind: "scalar",
+            description: "Integer enum type. Like a normal integer, but only eq/!eq filters. Limited to only the allowed values.",
+          },
           string: {
             params: Dry::Types["coercible.string"],
             read: Dry::Types["coercible.string"],

data/lib/graphiti/util/link.rb

@@ -11,6 +11,7 @@ module Graphiti
             @sideload = @sideload.children.values.find { |c|
               c.group_name == type.to_sym
             }
+            @polymorphic_sideload_not_found = true unless @sideload
           else
             @linkable = false
           end
@@ -26,6 +27,8 @@ module Graphiti
       private
 
       def linkable?
+        return false if @polymorphic_sideload_not_found
+
         if @sideload.type == :belongs_to
           !@model.send(@sideload.foreign_key).nil?
         else

data/lib/graphiti/version.rb

@@ -1,3 +1,3 @@
 module Graphiti
-  VERSION = "1.0.rc.26"
+  VERSION = "1.0.rc.27"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphiti
 version: !ruby/object:Gem::Version
-  version: 1.0.rc.26
+  version: 1.0.rc.27
 platform: ruby
 authors:
 - Lee Richmond
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-18 00:00:00.000000000 Z
+date: 2019-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializable
@@ -204,6 +204,7 @@ files:
 - ".travis.yml"
 - ".yardopts"
 - Appraisals
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -333,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: Easily build jsonapi.org-compatible APIs