graphiti 1.0.rc.21 → 1.0.rc.22

data/lib/graphiti/resource/documentation.rb

@@ -18,6 +18,7 @@ module Graphiti
             desc ||= ::I18n.t :description,
               scope: i18n_type_scope,
               default: nil
+            desc
           end
         end
 
@@ -43,13 +44,14 @@ module Graphiti
             desc ||= ::I18n.t :description,
               scope: [*i18n_resource_scope, field_type, name],
               default: nil
+            desc
           end
         end
 
         private
 
         def underscored_resource_name
-          self.name.gsub(/Resource$/, '').underscore
+          name.gsub(/Resource$/, "").underscore
         end
 
         def i18n_resource_scope
@@ -62,4 +64,4 @@ module Graphiti
       end
     end
   end
-end
+end

data/lib/graphiti/resource/dsl.rb

@@ -8,7 +8,7 @@ module Graphiti
           opts = args.extract_options!
           type_override = args[0]
 
-          if att = get_attr(name, :filterable, raise_error: :only_unsupported)
+          if (att = get_attr(name, :filterable, raise_error: :only_unsupported))
             aliases = [name, opts[:aliases]].flatten.compact
             operators = FilterOperators.build(self, att[:type], opts, &blk)
 
@@ -26,15 +26,13 @@ module Graphiti
               single: !!opts[:single],
               dependencies: opts[:dependent],
               required: required,
-              operators: operators.to_hash
+              operators: operators.to_hash,
             }
+          elsif (type = args[0])
+            attribute name, type, only: [:filterable]
+            filter(name, opts, &blk)
           else
-            if type = args[0]
-              attribute name, type, only: [:filterable]
-              filter(name, opts, &blk)
-            else
-              raise Errors::ImplicitFilterTypeMissing.new(self, name)
-            end
+            raise Errors::ImplicitFilterTypeMissing.new(self, name)
           end
         end
 
@@ -51,15 +49,13 @@ 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]
+            sort(name, opts, &blk)
           else
-            if type = args[0]
-              attribute name, type, only: [:sortable]
-              sort(name, opts, &blk)
-            else
-              raise Errors::ImplicitSortTypeMissing.new(self, name)
-            end
+            raise Errors::ImplicitSortTypeMissing.new(self, name)
           end
         end
 
@@ -76,7 +72,7 @@ module Graphiti
         def default_filter(name = nil, &blk)
           name ||= :__default
           config[:default_filters][name.to_sym] = {
-            filter: blk
+            filter: blk,
           }
         end
 
@@ -116,7 +112,7 @@ module Graphiti
             readable: true,
             writable: false,
             sortable: false,
-            filterable: false
+            filterable: false,
           }
           options = defaults.merge(options)
           config[:extra_attributes][name] = options
@@ -147,19 +143,19 @@ module Graphiti
 
         def attribute_option(options, name)
           if options[name] != false
-            default = if only = options[:only]
-                        Array(only).include?(name) ? true : false
-                      elsif except = options[:except]
-                        Array(except).include?(name) ? false : true
-                      else
-                        send(:"attributes_#{name}_by_default")
-                      end
+            default = if (only = options[:only])
+              Array(only).include?(name) ? true : false
+            elsif (except = options[:except])
+              Array(except).include?(name) ? false : true
+            else
+              send(:"attributes_#{name}_by_default")
+            end
             options[name] ||= default
           end
         end
         private :attribute_option
 
-       def relationship_option(options, name)
+        def relationship_option(options, name)
           if options[name] != false
             options[name] ||= send(:"relationships_#{name}_by_default")
           end

data/lib/graphiti/resource/interface.rb

@@ -25,7 +25,7 @@ module Graphiti
         def _find(params = {}, base_scope = nil)
           id = params[:data].try(:[], :id) || params.delete(:id)
           params[:filter] ||= {}
-          params[:filter].merge!(id: id) if id
+          params[:filter][:id] = id if id
 
           runner = Runner.new(self, params)
           runner.proxy(base_scope, single: true, raise_on_missing: true)
@@ -42,8 +42,8 @@ module Graphiti
         def validate!(params)
           return unless validate_endpoints?
 
-          if context && context.respond_to?(:request)
-            path = context.request.env['PATH_INFO']
+          if context&.respond_to?(:request)
+            path = context.request.env["PATH_INFO"]
             unless allow_request?(path, params, context_namespace)
               raise Errors::InvalidEndpoint.new(self, path, context_namespace)
             end

data/lib/graphiti/resource/links.rb

@@ -6,7 +6,7 @@ module Graphiti
 
     module Overrides
       def endpoint
-        if endpoint = super
+        if (endpoint = super)
           endpoint
         else
           self.endpoint = infer_endpoint
@@ -34,12 +34,12 @@ module Graphiti
       def infer_endpoint
         return unless name
 
-        path = "/#{name.gsub('Resource', '').pluralize.underscore}".to_sym
+        path = "/#{name.gsub("Resource", "").pluralize.underscore}".to_sym
         {
           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
 
@@ -68,29 +68,29 @@ module Graphiti
         ([endpoint] + secondary_endpoints).compact
       end
 
-      def allow_request?(path, params, action)
-        path = path.split('.')[0]
+      def allow_request?(request_path, params, action)
+        request_path = request_path.split(".")[0]
 
         endpoints.any? do |e|
           has_id = params[:id] || params[:data].try(:[], :id)
-          _path = path
+          path = request_path
           if [:update, :show, :destroy].include?(context_namespace) && has_id
-            _path = path.split('/')
-            _path.pop
-            _path = _path.join('/')
+            path = request_path.split("/")
+            path.pop
+            path = path.join("/")
           end
-          e[:full_path].to_s == _path && e[:actions].include?(context_namespace)
+          e[:full_path].to_s == path && e[:actions].include?(context_namespace)
         end
       end
 
       private
 
       def full_path_for(path)
-        [endpoint_namespace, path].join('').to_sym
+        [endpoint_namespace, path].join("").to_sym
       end
 
       def url_for(path)
-        [base_url, full_path_for(path)].join('').to_sym
+        [base_url, full_path_for(path)].join("").to_sym
       end
     end
   end

data/lib/graphiti/resource/persistence.rb

@@ -30,7 +30,7 @@ module Graphiti
 
         def around_attributes(method = nil, only: [:create, :update], &blk)
           if blk
-            raise Errors::AroundCallbackProc.new(self, 'around_attributes')
+            raise Errors::AroundCallbackProc.new(self, "around_attributes")
           else
             add_callback(:attributes, :around, method, only, &blk)
           end
@@ -38,7 +38,7 @@ module Graphiti
 
         def around_save(method = nil, only: [:create, :update], &blk)
           if blk
-            raise Errors::AroundCallbackProc.new(self, 'around_save')
+            raise Errors::AroundCallbackProc.new(self, "around_save")
           else
             add_callback(:save, :around, method, only, &blk)
           end
@@ -46,7 +46,7 @@ module Graphiti
 
         def around_persistence(method = nil, only: [:create, :update], &blk)
           if blk
-            raise Errors::AroundCallbackProc.new(self, 'around_persistence')
+            raise Errors::AroundCallbackProc.new(self, "around_persistence")
           else
             add_callback(:persistence, :around, method, only, &blk)
           end
@@ -54,7 +54,7 @@ module Graphiti
 
         def around_destroy(method = nil, &blk)
           if blk
-            raise Errors::AroundCallbackProc.new(self, 'around_destroy')
+            raise Errors::AroundCallbackProc.new(self, "around_destroy")
           else
             add_callback(:destroy, :around, method, [:destroy], &blk)
           end
@@ -62,10 +62,10 @@ module Graphiti
 
         private
 
-        def add_callback(kind, lifecycle, method = nil, only, &blk)
+        def add_callback(kind, lifecycle, method, only, &blk)
           config[:callbacks][kind] ||= {}
           config[:callbacks][kind][lifecycle] ||= []
-          config[:callbacks][kind][lifecycle] << { callback: (method || blk), only: Array(only) }
+          config[:callbacks][kind][lifecycle] << {callback: (method || blk), only: Array(only)}
         end
       end
 
@@ -136,13 +136,13 @@ module Graphiti
         fire_around_callbacks(kind, action, *args) do |*yieldargs|
           fire_callbacks(kind, :before, action, *yieldargs)
           result = yield(*yieldargs)
-          fire_callbacks(kind, :after, action, *[result, args.last])
+          fire_callbacks(kind, :after, action, result, args.last)
           result
         end
       end
 
       def fire_callbacks(kind, lifecycle, action, *args)
-        if callbacks = self.class.config[:callbacks][kind]
+        if (callbacks = self.class.config[:callbacks][kind])
           callbacks = callbacks[lifecycle] || []
           callbacks.each do |config|
             callback = config[:callback]
@@ -187,7 +187,7 @@ module Graphiti
             r = nil
             args = args[0..0] if method(method_name).arity == 1
             send(method_name, *args) do |r2|
-              wrapped = around_callback_proc(callbacks, index+1, r2, &blk)
+              wrapped = around_callback_proc(callbacks, index + 1, r2, &blk)
               r = instance_exec(r2, &wrapped)
             end
             r

data/lib/graphiti/resource/polymorphism.rb

@@ -45,16 +45,16 @@ module Graphiti
           sl = super
           if !polymorphic_child? && sl.nil?
             children.each do |c|
-              break if sl = c.sideloads[name]
+              break if (sl = c.sideloads[name])
             end
           end
           sl
         end
 
         def children
-          @children ||= polymorphic.map do |klass|
+          @children ||= polymorphic.map { |klass|
             klass.is_a?(String) ? klass.safe_constantize : klass
-          end
+          }
         end
 
         def resource_for_type(type)

data/lib/graphiti/resource/remote.rb

@@ -36,8 +36,8 @@ module Graphiti
         {}.tap do |headers|
           if defined?(Rails) && context
             raw = context.request.headers.to_h
-            if auth = raw['HTTP_AUTHORIZATION']
-              headers['Authorization'] = auth
+            if (auth = raw["HTTP_AUTHORIZATION"])
+              headers["Authorization"] = auth
             end
           end
         end
@@ -49,7 +49,7 @@ module Graphiti
 
       def make_request(url)
         headers = request_headers.dup
-        headers['Content-Type'] = 'application/vnd.api+json'
+        headers["Content-Type"] = "application/vnd.api+json"
         faraday.get(url, nil, headers) do |req|
           yield req if block_given? # for super do ... end
           req.options.timeout = timeout if timeout

data/lib/graphiti/resource/sideloading.rb

@@ -13,7 +13,7 @@ module Graphiti
           relationship_option(opts, :readable)
           relationship_option(opts, :writable)
           sideload = klass.new(name, opts)
-          if parent = opts[:parent]
+          if (parent = opts[:parent])
             parent.children[name] = sideload
           else
             config[:sideloads][name] = sideload
@@ -51,10 +51,10 @@ module Graphiti
         end
 
         def polymorphic_belongs_to(name, opts = {}, &blk)
-          opts[:resource] ||= Class.new(::Graphiti::Resource) do
+          opts[:resource] ||= Class.new(::Graphiti::Resource) {
             self.polymorphic = []
             self.abstract_class = true
-          end
+          }
           # adapters *probably* don't need to override this, but it's allowed
           opts[:class] ||= adapter.sideloading_classes[:polymorphic_belongs_to]
           opts[:class] ||= ::Graphiti::Sideload::PolymorphicBelongsTo
@@ -65,10 +65,10 @@ module Graphiti
           as = opts.delete(:as)
           opts[:foreign_key] ||= :"#{as}_id"
           opts[:polymorphic_as] ||= as
-          _model = model
+          model_ref = model
           has_many name, opts do
             params do |hash|
-              hash[:filter][:"#{as}_type"] = _model.name
+              hash[:filter][:"#{as}_type"] = model_ref.name
             end
 
             instance_eval(&blk) if block_given?

data/lib/graphiti/resource_proxy.rb

@@ -8,12 +8,12 @@ module Graphiti
       payload: nil,
       single: false,
       raise_on_missing: false)
-        @resource = resource
-        @scope = scope
-        @query = query
-        @payload = payload
-        @single = single
-        @raise_on_missing = raise_on_missing
+      @resource = resource
+      @scope = scope
+      @query = query
+      @payload = payload
+      @single = single
+      @raise_on_missing = raise_on_missing
     end
 
     def single?
@@ -62,7 +62,7 @@ module Graphiti
         records
       end
     end
-    alias :to_a :data
+    alias to_a data
 
     def each(&blk)
       to_a.each(&blk)
@@ -90,12 +90,12 @@ module Graphiti
       original = Graphiti.context[:namespace]
       begin
         Graphiti.context[:namespace] = action
-        validator = persist do
+        validator = persist {
           @resource.persist_with_relationships \
             @payload.meta(action: action),
             @payload.attributes,
             @payload.relationships
-        end
+        }
       ensure
         Graphiti.context[:namespace] = original
       end
@@ -115,7 +115,7 @@ module Graphiti
 
     def destroy
       transaction_response = @resource.transaction do
-        metadata = { method: :destroy }
+        metadata = {method: :destroy}
         model = @resource.destroy(@query.filters[:id], metadata)
         model.instance_variable_set(:@__serializer_klass, @resource.serializer)
         validator = ::Graphiti::Util::ValidationResponse.new \
@@ -123,7 +123,7 @@ module Graphiti
         validator.validate!
         @resource.before_commit(model, metadata)
 
-        { result: validator }
+        {result: validator}
       end
       @data, success = transaction_response[:result].to_a
       success
@@ -165,7 +165,7 @@ module Graphiti
         end
       end
 
-      data, success = transaction_response[:result].to_a
+      _data, success = transaction_response[:result].to_a
       if success
         transaction_response[:after_commit_hooks].each do |hook|
           hook.call

data/lib/graphiti/schema.rb

@@ -12,12 +12,12 @@ module Graphiti
     def self.generate!(resources = nil)
       schema = generate(resources)
 
-      if ENV['FORCE_SCHEMA'] != 'true' && File.exists?(Graphiti.config.schema_path)
+      if ENV["FORCE_SCHEMA"] != "true" && File.exist?(Graphiti.config.schema_path)
         old = JSON.parse(File.read(Graphiti.config.schema_path))
         errors = Graphiti::SchemaDiff.new(old, schema).compare
         return errors if errors.any?
       end
-      FileUtils.mkdir_p(Graphiti.config.schema_path.gsub('/schema.json', ''))
+      FileUtils.mkdir_p(Graphiti.config.schema_path.gsub("/schema.json", ""))
       File.write(Graphiti.config.schema_path, JSON.pretty_generate(schema))
       []
     end
@@ -32,7 +32,7 @@ module Graphiti
       {
         resources: generate_resources,
         endpoints: generate_endpoints,
-        types: generate_types
+        types: generate_types,
       }
     end
 
@@ -52,16 +52,16 @@ module Graphiti
           r.endpoints.each do |e|
             actions = {}
             e[:actions].each do |a|
-              next unless ctx = context_for(e[:full_path], a)
+              next unless (ctx = context_for(e[:full_path], a))
 
               existing = endpoints[e[:full_path]]
-              if existing && config = existing[:actions][a]
+              if existing && (config = existing[:actions][a])
                 raise Errors::ResourceEndpointConflict.new \
                   e[:full_path], a, r.name, config[:resource]
               end
 
-              actions[a] = { resource: r.name }
-              if allowlist = ctx.sideload_allowlist
+              actions[a] = {resource: r.name}
+              if (allowlist = ctx.sideload_allowlist)
                 if allowlist[a]
                   actions[a].merge!(sideload_allowlist: allowlist[a])
                 end
@@ -69,7 +69,7 @@ module Graphiti
             end
 
             unless actions.empty?
-              endpoints[e[:full_path]] ||= { actions: {} }
+              endpoints[e[:full_path]] ||= {actions: {}}
               endpoints[e[:full_path]][:actions].merge!(actions)
             end
           end
@@ -82,7 +82,7 @@ module Graphiti
     end
 
     def generate_resources
-      arr = @local_resources.map do |r|
+      arr = @local_resources.map { |r|
         config = {
           name: r.name,
           type: r.type.to_s,
@@ -91,13 +91,13 @@ module Graphiti
           extra_attributes: extra_attributes(r),
           sorts: sorts(r),
           filters: filters(r),
-          relationships: relationships(r)
+          relationships: relationships(r),
         }
 
         if r.default_sort
-          default_sort = r.default_sort.map do |s|
-            { s.keys.first.to_s => s.values.first.to_s }
-          end
+          default_sort = r.default_sort.map { |s|
+            {s.keys.first.to_s => s.values.first.to_s}
+          }
           config[:default_sort] = default_sort
         end
 
@@ -106,20 +106,21 @@ module Graphiti
         end
 
         if r.polymorphic?
-          config.merge!(polymorphic: true, children: r.children.map(&:name))
+          config[:polymorphic] = true
+          config[:children] = r.children.map(&:name)
         end
 
         config
-      end
+      }
 
-      arr |= @remote_resources.map do |r|
+      arr |= @remote_resources.map { |r|
         {
           name: r.name,
           description: r.description,
           remote: r.remote_url,
-          relationships: relationships(r)
+          relationships: relationships(r),
         }
-      end
+      }
 
       arr
     end
@@ -129,9 +130,9 @@ module Graphiti
         resource.attributes.each_pair do |name, config|
           if config.values_at(:readable, :writable).any?
             attrs[name] = {
-              type:       config[:type].to_s,
-              readable:   flag(config[:readable]),
-              writable:   flag(config[:writable]),
+              type: config[:type].to_s,
+              readable: flag(config[:readable]),
+              writable: flag(config[:writable]),
               description: resource.attribute_description(name),
             }
           end
@@ -143,7 +144,7 @@ module Graphiti
       {}.tap do |attrs|
         resource.extra_attributes.each_pair do |name, config|
           attrs[name] = {
-            type:     config[:type].to_s,
+            type: config[:type].to_s,
             readable: flag(config[:readable]),
             description: resource.attribute_description(name),
           }
@@ -151,9 +152,9 @@ module Graphiti
       end
     end
 
-    def flag(value)value
+    def flag(value)
       if value.is_a?(Symbol)
-        'guarded'
+        "guarded"
       else
         !!value
       end
@@ -178,7 +179,7 @@ module Graphiti
         resource.filters.each_pair do |name, filter|
           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]
@@ -202,7 +203,7 @@ module Graphiti
     def relationships(resource)
       {}.tap do |r|
         resource.sideloads.each_pair do |name, config|
-          schema = { type: config.type.to_s, description: config.description }
+          schema = {type: config.type.to_s, description: config.description}
           if config.type == :polymorphic_belongs_to
             schema[:resources] = config.children.values
               .map(&:resource).map(&:class).map(&:name)