graphiti 2.0.0.beta.6 → 2.0.0.beta.8

data/lib/graphiti/spec_helpers/errors_proxy.rb

@@ -62,7 +62,7 @@ module Graphiti
 
       def method_missing(id, *args, &blk)
         matches = @errors.select { |e| e.attribute.to_sym == id }
-        matches.length == 1 ? matches[0] : matches
+        (matches.length == 1) ? matches[0] : matches
       end
 
       # Any name is answered: an attribute with no matching error yields an empty

data/lib/graphiti/spec_helpers/matchers.rb

@@ -73,7 +73,7 @@ module Graphiti
         attr_reader :target, :opts, :resource
 
         def assert_opt(opt)
-          asserted_opt = opt == :resource ? :resource_class : opt
+          asserted_opt = (opt == :resource) ? :resource_class : opt
           return true if config.send(asserted_opt) == opts[opt]
 
           @opt_failures << opt_failure_message(opt, opts[opt], config.send(asserted_opt))

data/lib/graphiti/spec_helpers.rb

@@ -26,6 +26,11 @@ module Graphiti
     end
 
     module Sugar
+      def self.included(base)
+        Graphiti::DEPRECATOR.warn("Graphiti::SpecHelpers::Sugar is deprecated. Call jsonapi_data, jsonapi_included, jsonapi_errors, json_date and json_datetime directly.")
+        super
+      end
+
       def d
         jsonapi_data
       end

data/lib/graphiti/types.rb

@@ -82,6 +82,10 @@ module Graphiti
       Dry::Types["params.hash"][input]
     }
 
+    ParamArray = Dry::Types["strict.array"].constructor { |input|
+      input.is_a?(String) ? [input] : input
+    }
+
     REQUIRED_KEYS = [:params, :read, :write, :kind, :description]
 
     def self.map
@@ -193,7 +197,7 @@ module Graphiti
 
           arrays[:"array_of_#{name.to_s.pluralize}"] = {
             canonical_name: name,
-            params: Dry::Types["strict.array"].of(map[:params]),
+            params: ParamArray.of(map[:params]),
             read: Dry::Types["strict.array"].of(map[:read]),
             test: Dry::Types["strict.array"].of(map[:test]),
             write: Dry::Types["strict.array"].of(map[:write]),

data/lib/graphiti/util/cache_debug.rb

@@ -28,7 +28,7 @@ module Graphiti
           expires_in: proxy.cache_expires_in,
           etag: proxy.etag,
           miss_count: last_version[:miss_count].to_i + (changed_key? ? 1 : 0),
-          hit_count: last_version[:hit_count].to_i + (!changed_key? && !new_key? ? 1 : 0),
+          hit_count: last_version[:hit_count].to_i + ((!changed_key? && !new_key?) ? 1 : 0),
           request_count: last_version[:request_count].to_i + (last_version.present? ? 1 : 0)
         }
       end
@@ -76,8 +76,8 @@ module Graphiti
       end
 
       def changes
-        sub_keys_old = last_version[:cache_key]&.scan(/\w+\/query-[a-z0-9-]+\/args-[a-z0-9-]+/).to_a || []
-        sub_keys_new = current_version[:cache_key]&.scan(/\w+\/query-[a-z0-9-]+\/args-[a-z0-9-]+/).to_a || []
+        sub_keys_old = last_version[:cache_key]&.scan(/\w+\/query-[a-z0-9-]+\/args-[a-z0-9-]+/).to_a
+        sub_keys_new = current_version[:cache_key]&.scan(/\w+\/query-[a-z0-9-]+\/args-[a-z0-9-]+/).to_a
 
         [sub_keys_old, sub_keys_new]
       end

data/lib/graphiti/util/hash.rb

@@ -43,7 +43,7 @@ module Graphiti
       # @return [Hash] the merged hash
       # @api private
       def self.deep_merge!(hash, other)
-        merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+        merger = proc { |key, v1, v2| (Hash === v1 && Hash === v2) ? v1.merge(v2, &merger) : v2 }
         hash.merge!(other, &merger)
       end
 

data/lib/graphiti/util/persistence.rb

@@ -156,12 +156,12 @@ class Graphiti::Util::Persistence
 
   def persist_object(method, attributes)
     case method
-      when :destroy
-        call_resource_method(:destroy, attributes[:id], @caller_model)
-      when :update, nil, :disassociate
-        call_resource_method(:update, attributes, @caller_model)
-      else
-        call_resource_method(:create, attributes, @caller_model)
+    when :destroy
+      call_resource_method(:destroy, attributes[:id], @caller_model)
+    when :update, nil, :disassociate
+      call_resource_method(:update, attributes, @caller_model)
+    else
+      call_resource_method(:create, attributes, @caller_model)
     end
   end
 

data/lib/graphiti/util/serializer_relationships.rb

@@ -173,7 +173,7 @@ module Graphiti
       def validate_link_for_sideload!(sideload)
         return if sideload.resource.remote?
 
-        action = sideload.type == :belongs_to ? :show : :index
+        action = (sideload.type == :belongs_to) ? :show : :index
         cache_key = :"#{@sideload.object_id}-#{action}"
         return if self.class.validated_link_cache.include?(cache_key)
         prc = Graphiti.config.context_for_endpoint

data/lib/graphiti/version.rb

@@ -1,3 +1,3 @@
 module Graphiti
-  VERSION = "2.0.0.beta.6"
+  VERSION = "2.0.0.beta.8"
 end

data/lib/tasks/graphiti.rake

@@ -20,7 +20,7 @@ namespace :graphiti do
   task audit: [:environment] do
     helpers.setup_rails!
     rows = Graphiti::Audit.run
-    puts Graphiti::Audit::Report.new(rows).to_s
+    puts Graphiti::Audit::Report.new(rows)
 
     exit 1 if rows.any?(&:error?)
   end

data/package.json

@@ -22,6 +22,7 @@
   },
   "release": {
     "branches": [
+      "1.x",
       "main",
       {
         "name": "beta",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphiti
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.6
+  version: 2.0.0.beta.8
 platform: ruby
 authors:
 - Lee Richmond
@@ -129,30 +129,36 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -187,14 +193,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.56'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.56'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -209,6 +215,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -230,9 +250,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".git-blame-ignore-revs"
 - ".github/probots.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/docs.yml"
+- ".github/workflows/notify-example-app.yml"
 - ".github/workflows/release.yml"
 - ".gitignore"
 - ".npmrc"
@@ -255,52 +277,6 @@ files:
 - bin/console
 - bin/rspec
 - bin/setup
-- docs/concepts/backends-and-models.md
-- docs/concepts/endpoints.md
-- docs/concepts/links.md
-- docs/concepts/overview.md
-- docs/concepts/persisting.md
-- docs/concepts/relationships.md
-- docs/concepts/resources.md
-- docs/getting-started/first-api.md
-- docs/getting-started/installation.md
-- docs/intro.md
-- docs/js/authentication.md
-- docs/js/ddau.md
-- docs/js/extra-params.md
-- docs/js/index.md
-- docs/js/installation.md
-- docs/js/middleware.md
-- docs/js/models.md
-- docs/js/reads.md
-- docs/js/state-syncing.md
-- docs/js/writes.md
-- docs/reference/vandal.md
-- docs/reference/why.md
-- docs/topics/authorization.md
-- docs/topics/caching.md
-- docs/topics/customizing-sideloads.md
-- docs/topics/debugging.md
-- docs/topics/error-handling.md
-- docs/topics/etags.md
-- docs/topics/hopping-relationships.md
-- docs/topics/json-attributes.md
-- docs/topics/openstruct-models.md
-- docs/topics/remote-resources.md
-- docs/topics/testing.md
-- docs/topics/without-activerecord.md
-- docs/tutorial/index.md
-- docs/tutorial/step_0.md
-- docs/tutorial/step_1.md
-- docs/tutorial/step_2.md
-- docs/tutorial/step_3.md
-- docs/tutorial/step_4.md
-- docs/tutorial/step_5.md
-- docs/tutorial/step_6.md
-- docs/tutorial/step_7.md
-- docs/tutorial/step_8.md
-- docs/tutorial/step_9.md
-- docs/upgrading.md
 - exe/graphiti
 - gemfiles/.bundle/config
 - gemfiles/rails_7_1.gemfile
@@ -434,148 +410,6 @@ files:
 - lib/tasks/graphiti.rake
 - package-lock.json
 - package.json
-- website/.gitignore
-- website/README.md
-- website/docusaurus.config.js
-- website/package-lock.json
-- website/package.json
-- website/sidebars.js
-- website/src/css/custom.css
-- website/src/pages/markdown-page.mdx
-- website/static/.nojekyll
-- website/static/1.13/2019/03/31/graphiti-1-0.html
-- website/static/1.13/2019/05/08/graphiti-1-1.html
-- website/static/1.13/2019/05/20/graphiti-1-2.html
-- website/static/1.13/2019/10/14/tutorial.html
-- website/static/1.13/CNAME
-- website/static/1.13/README.md
-- website/static/1.13/assets/css/syntax.css
-- website/static/1.13/assets/favicons/android-chrome-192x192.png
-- website/static/1.13/assets/favicons/android-chrome-256x256.png
-- website/static/1.13/assets/favicons/apple-touch-icon.png
-- website/static/1.13/assets/favicons/browserconfig.xml
-- website/static/1.13/assets/favicons/favicon-16x16.png
-- website/static/1.13/assets/favicons/favicon-32x32.png
-- website/static/1.13/assets/favicons/favicon.ico
-- website/static/1.13/assets/favicons/mstile-150x150.png
-- website/static/1.13/assets/favicons/safari-pinned-tab.svg
-- website/static/1.13/assets/favicons/site.webmanifest
-- website/static/1.13/assets/img/backend.gif
-- website/static/1.13/assets/img/conformity.png
-- website/static/1.13/assets/img/error_payload.png
-- website/static/1.13/assets/img/fancy-cushion.png
-- website/static/1.13/assets/img/gh.png
-- website/static/1.13/assets/img/home-bg.jpg
-- website/static/1.13/assets/img/lifecycle.gif
-- website/static/1.13/assets/img/logo-500.png
-- website/static/1.13/assets/img/logo.png
-- website/static/1.13/assets/img/love-graffiti.jpg
-- website/static/1.13/assets/img/meta_total_count.png
-- website/static/1.13/assets/img/persist.jpg
-- website/static/1.13/assets/img/resource.gif
-- website/static/1.13/assets/img/rest-graffiti.jpg
-- website/static/1.13/assets/img/rest1.gif
-- website/static/1.13/assets/img/rest2.gif
-- website/static/1.13/assets/img/rest3.gif
-- website/static/1.13/assets/img/rethink-rest-graffiti.jpg
-- website/static/1.13/assets/img/sunrise.png
-- website/static/1.13/assets/img/why.png
-- website/static/1.13/assets/js/highlight.pack.js
-- website/static/1.13/assets/main.css
-- website/static/1.13/assets/main.css.map
-- website/static/1.13/bin/bundle
-- website/static/1.13/bin/jekyll
-- website/static/1.13/bin/kramdown
-- website/static/1.13/bin/listen
-- website/static/1.13/bin/rake
-- website/static/1.13/bin/rougify
-- website/static/1.13/bin/safe_yaml
-- website/static/1.13/bin/sass
-- website/static/1.13/bin/sass-convert
-- website/static/1.13/bin/scss
-- website/static/1.13/blog.html
-- website/static/1.13/cheatsheet.html
-- website/static/1.13/cookbooks/authorization.md
-- website/static/1.13/cookbooks/caching.md
-- website/static/1.13/cookbooks/customizing-sideloads.html
-- website/static/1.13/cookbooks/etags.md
-- website/static/1.13/cookbooks/hopping-relationships.html
-- website/static/1.13/cookbooks/json_attributes.md
-- website/static/1.13/cookbooks/openstruct-models.md
-- website/static/1.13/cookbooks/remote-resources.md
-- website/static/1.13/cookbooks/without-activerecord.html
-- website/static/1.13/features.html
-- website/static/1.13/feed.xml
-- website/static/1.13/guides/concepts/backends-and-models.html
-- website/static/1.13/guides/concepts/debugging.html
-- website/static/1.13/guides/concepts/endpoints.html
-- website/static/1.13/guides/concepts/error-handling.html
-- website/static/1.13/guides/concepts/links.html
-- website/static/1.13/guides/concepts/remote-resources.html
-- website/static/1.13/guides/concepts/resources.html
-- website/static/1.13/guides/concepts/testing.html
-- website/static/1.13/guides/getting-started/installation.html
-- website/static/1.13/guides/graphiti-rails-migration.html
-- website/static/1.13/guides/index.html
-- website/static/1.13/guides/overview.html
-- website/static/1.13/guides/upgrading-2-0.html
-- website/static/1.13/guides/upgrading.html
-- website/static/1.13/guides/vandal.html
-- website/static/1.13/guides/why.html
-- website/static/1.13/index.html
-- website/static/1.13/js/authentication.html
-- website/static/1.13/js/ddau.html
-- website/static/1.13/js/extra-params.html
-- website/static/1.13/js/index.html
-- website/static/1.13/js/installation.html
-- website/static/1.13/js/introduction.html
-- website/static/1.13/js/middleware.html
-- website/static/1.13/js/reads/fieldsets.html
-- website/static/1.13/js/reads/filtering.html
-- website/static/1.13/js/reads/includes.html
-- website/static/1.13/js/reads/index.html
-- website/static/1.13/js/reads/nested-queries.html
-- website/static/1.13/js/reads/pagination.html
-- website/static/1.13/js/reads/sorting.html
-- website/static/1.13/js/reads/statistics.html
-- website/static/1.13/js/state-syncing.html
-- website/static/1.13/js/writes/deferred.html
-- website/static/1.13/js/writes/dirty-tracking.html
-- website/static/1.13/js/writes/index.html
-- website/static/1.13/js/writes/nested.html
-- website/static/1.13/js/writes/validations.html
-- website/static/1.13/quickstart.html
-- website/static/1.13/template
-- website/static/1.13/tutorial/index.html
-- website/static/1.13/tutorial/step_0.html
-- website/static/1.13/tutorial/step_1.html
-- website/static/1.13/tutorial/step_2.html
-- website/static/1.13/tutorial/step_3.html
-- website/static/1.13/tutorial/step_4.html
-- website/static/1.13/tutorial/step_5.html
-- website/static/1.13/tutorial/step_6.html
-- website/static/1.13/tutorial/step_7.html
-- website/static/1.13/tutorial/step_8.html
-- website/static/1.13/tutorial/step_9.html
-- website/static/CNAME
-- website/static/assets/img/error_payload.png
-- website/static/assets/img/legacy/legacy-0378a3bb39.png
-- website/static/assets/img/legacy/legacy-05bbd3e5fd.png
-- website/static/assets/img/legacy/legacy-07aa104495.png
-- website/static/assets/img/legacy/legacy-0c75a16b3a.gif
-- website/static/assets/img/legacy/legacy-3076df6209.png
-- website/static/assets/img/legacy/legacy-7f6889bc89.png
-- website/static/assets/img/legacy/legacy-a2cc4363c3.png
-- website/static/assets/img/legacy/legacy-f67cfa89ab.png
-- website/static/assets/img/meta_total_count.png
-- website/static/img/docusaurus-social-card.jpg
-- website/static/img/docusaurus.png
-- website/static/img/favicon.ico
-- website/static/img/logo.png
-- website/static/img/logo.svg
-- website/static/img/undraw_docusaurus_mountain.svg
-- website/static/img/undraw_docusaurus_react.svg
-- website/static/img/undraw_docusaurus_tree.svg
 homepage: https://github.com/graphiti-api/graphiti
 licenses:
 - MIT

data/docs/concepts/backends-and-models.md

@@ -1,122 +0,0 @@
----
-title: 'Backends and Models'
----
-
-# Backends and Models
-
-A Resource queries a **Backend** and returns **Models** from what comes back. Graphiti serializes the Models.
-
-With ActiveRecord those are the same object. `Employee` is both the thing you query and the thing you render, and you can skip most of this page. It matters when they're separate: a search index, an HTTP service, a document store. Then the Backend is whatever you query, and the Model is whatever you hand back.
-
-## Scopes {#scopes}
-
-A **scope** is whatever your backend needs to run a query. Graphiti doesn't care what it is. For ActiveRecord it's an `ActiveRecord::Relation`. Here it's a plain hash:
-
-```ruby
-class EmployeeResource < ApplicationResource
-  self.adapter = Graphiti::Adapters::Null
-
-  attribute :name, :string
-
-  def base_scope
-    { conditions: {}, sort: {} }
-  end
-
-  filter :name do
-    eq do |scope, value|
-      scope[:conditions].merge!(value)
-      scope
-    end
-  end
-
-  sort :name do |scope, direction|
-    scope[:sort] = { name: direction }
-    scope
-  end
-
-  def resolve(scope)
-    results = Backend.query(scope)
-    results.map { |result| Employee.new(result) }
-  end
-end
-```
-
-`base_scope` is the starting point, each `filter` and `sort` block mutates it based on request params, and `resolve` runs the query and returns Models.
-
-**Every block must return the scope.** Returning the result of `merge!` or an assignment instead of the scope itself is the most common way to break this.
-
-Writing that per Resource gets old. Once the pattern stabilizes, move it into an [Adapter](/topics/without-activerecord#adapters) and Resources go back to being declarative:
-
-```ruby
-class EmployeeResource < ApplicationResource
-  self.adapter = BackendAdapter
-  attribute :name, :string
-end
-```
-
-## What a Model has to do {#model-requirements}
-
-**Respond to `id`, uniquely.** Graphiti uses `model.id` to tell records apart when rendering. Duplicate ids produce wrong output, not an error.
-
-If the underlying record has no id, generate one:
-
-```ruby
-def id
-  @id ||= SecureRandom.uuid
-end
-```
-
-**Respond to its readable attributes.** `attribute :name, :string` calls `model.name`. If your Model doesn't have that method, pass a block instead:
-
-```ruby
-attribute :name, :string do
-  @object.full_name
-end
-```
-
-**Include `ActiveModel::Validations` if you want validation errors.** Graphiti checks models on write requests and renders a [JSON:API errors payload](http://jsonapi.org/format/#errors) from `model.errors`. Without it, an invalid model saves silently:
-
-```ruby
-class Employee
-  include ActiveModel::Validations
-
-  validates :name, presence: true
-end
-```
-
-## Writing a Model {#model-implementations}
-
-Graphiti has no opinion here. A plain class works:
-
-```ruby
-class Employee
-  attr_accessor :id, :first_name, :last_name, :age
-
-  def initialize(attrs = {})
-    attrs.each_pair { |key, value| send(:"#{key}=", value) }
-  end
-end
-```
-
-[ActiveModel::Model](https://api.rubyonrails.org/classes/ActiveModel/Model.html) gives you the constructor and validations for free:
-
-```ruby
-class Employee
-  include ActiveModel::Model
-
-  attr_accessor :id, :first_name, :last_name, :age
-end
-```
-
-[Dry::Struct](https://dry-rb.org/gems/dry-struct) adds type enforcement, and dry-types is already a Graphiti dependency:
-
-```ruby
-class Employee < Dry::Struct
-  attribute :id, Types::Integer
-  attribute :first_name, Types::String
-  attribute :last_name, Types::String
-  attribute :age, Types::Integer
-end
-```
-
-`OpenStruct` also works and is what Graphiti uses internally for remote resources, but it fails quietly in ways the others don't. See [OpenStruct Models](/topics/openstruct-models) before reaching for it.