Add hook for automatic pagination links. #35

beauby · 2017-07-15T05:17:22Z

Closes #28. On top of #34.

Introduces a jsonapi_pagination hook in ActionController::Base that can be used to inject a hash of pagination links.

Example:

class ApplicationController < ActionController::Base
  def jsonapi_pagination(collection)
    { first: ..., last: ..., prev: ..., next: ... } if collection.paginated?
  end
end

houndci-bot · 2017-07-15T05:17:32Z

lib/jsonapi/rails/railtie.rb

@@ -30,6 +30,12 @@ class Railtie < ::Rails::Railtie
          ::ActionController::Renderers.add(:jsonapi) do |resources, options|
            self.content_type ||= Mime[:jsonapi]

+            # Renderer proc is evaluated in the controller context, so it
+            # has access to the jsonapi_pagination method.
+            if pagination_links = jsonapi_pagination(resources)


Assignment in condition - you probably meant to use ==.

houndci-bot · 2017-07-15T05:17:32Z

lib/jsonapi/rails/action_controller.rb

@@ -33,6 +40,10 @@ def _deserializable(key, options, fallback, &block)
        end
      end

+      def jsonapi_pagination(collection)


Unused method argument - collection. If it's necessary, use _ or _collection as an argument name to indicate that it won't be used. You can also write as jsonapi_pagination(*) if you want the method to accept any arguments but don't care about them.

houndci-bot · 2017-07-15T05:17:32Z

lib/jsonapi/rails/action_controller.rb

+          { "#{key}_id".to_sym => id, "#{key}_type".to_sym => type }
+        end
+        has_many do |_rel, ids, types, key|
+          key  = key.to_s.singularize


Unnecessary spacing detected.
Operator = should be surrounded by a single space.

houndci-bot · 2017-07-15T05:17:32Z

lib/jsonapi/rails/action_controller.rb

@@ -3,26 +3,33 @@

 module JSONAPI
  module Rails
+    module Deserializable
+      class Resource < JSONAPI::Deserializable::Resource


Missing top-level class documentation comment.

houndci-bot · 2017-07-15T05:17:32Z

lib/jsonapi/rails/railtie.rb

@@ -30,6 +30,12 @@ class Railtie < ::Rails::Railtie
          ::ActionController::Renderers.add(:jsonapi) do |resources, options|
            self.content_type ||= Mime[:jsonapi]

+            # Renderer proc is evaluated in the controller context, so it
+            # has access to the jsonapi_pagination method.
+            if pagination_links = jsonapi_pagination(resources)


Assignment in condition - you probably meant to use ==.

houndci-bot · 2017-07-15T05:17:33Z

lib/jsonapi/rails/action_controller.rb

@@ -33,6 +40,10 @@ def _deserializable(key, options, fallback, &block)
        end
      end

+      def jsonapi_pagination(collection)


Unused method argument - collection. If it's necessary, use _ or _collection as an argument name to indicate that it won't be used. You can also write as jsonapi_pagination(*) if you want the method to accept any arguments but don't care about them.

houndci-bot · 2017-07-15T05:17:33Z

lib/jsonapi/rails/action_controller.rb

+          { "#{key}_id".to_sym => id, "#{key}_type".to_sym => type }
+        end
+        has_many do |_rel, ids, types, key|
+          key  = key.to_s.singularize


Unnecessary spacing detected.
Operator = should be surrounded by a single space.

houndci-bot · 2017-07-15T05:17:33Z

lib/jsonapi/rails/action_controller.rb

@@ -3,26 +3,33 @@

 module JSONAPI
  module Rails
+    module Deserializable
+      class Resource < JSONAPI::Deserializable::Resource


Missing top-level class documentation comment.

* upstream/master: Conditionally include controller mixin (jsonapi-rb#40) Add initializer generator. (jsonapi-rb#39) Add ActiveSupport::Notifications instrumentation. (jsonapi-rb#41) Add library configuration object (jsonapi-rb#17) Rename JSONAPI::Rails::ActionController to JSONAPI::Rails::Controller. (jsonapi-rb#38) Add hook for default jsonapi object. (jsonapi-rb#37) Add hook for default exposures. (jsonapi-rb#36) Add hook for automatic pagination links. (jsonapi-rb#35) Upgrade to new jsonapi-deserializable version. (jsonapi-rb#34) Prepare for v0.2.1 release

houndci-bot reviewed Jul 15, 2017

View reviewed changes

beauby force-pushed the pagination branch 2 times, most recently from 611b060 to c763af2 Compare July 15, 2017 05:20

beauby mentioned this pull request Jul 15, 2017

Add hook for default exposures. #36

Merged

beauby mentioned this pull request Jul 25, 2017

Pagination Links jsonapi-rb/jsonapi-serializable#52

Closed

Add hook for automatic pagination links.

8fc7474

beauby force-pushed the pagination branch from 8ab3ced to 8fc7474 Compare July 25, 2017 07:06

beauby merged commit 0cfadb5 into master Jul 25, 2017

beauby deleted the pagination branch July 25, 2017 07:06

misaka mentioned this pull request Jan 6, 2020

[2743] Add v3 /providers/courses endpoint DFE-Digital/publish-teacher-training#1099

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add hook for automatic pagination links. #35

Add hook for automatic pagination links. #35

beauby commented Jul 15, 2017 •

edited

Loading

houndci-bot Jul 15, 2017

houndci-bot Jul 15, 2017

houndci-bot Jul 15, 2017

houndci-bot Jul 15, 2017

houndci-bot Jul 15, 2017

houndci-bot Jul 15, 2017

houndci-bot Jul 15, 2017

houndci-bot Jul 15, 2017

Add hook for automatic pagination links. #35

Add hook for automatic pagination links. #35

Conversation

beauby commented Jul 15, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

beauby commented Jul 15, 2017 •

edited

Loading