administrate-base_controller 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21f4165f46349b93a8dc74edf92e906db55833b900d32ec1a7e19e33e14dcc50
-  data.tar.gz: 36f6d49ffb71ae71268324341600f106db12f1cffc51a845105ca892742cf109
+  metadata.gz: c3d86a463b8de9a3ac555327f413d273ec996e1f5381c47deb98732166777a29
+  data.tar.gz: 360287eb7fc408e9d7044ac2238997cb4cb647cd8b78486265661213b5bb484e
 SHA512:
-  metadata.gz: f1dd8d6a755aeef649810168e200a1f44eddb407441044f58e8e57b9c55079df50ca7b5de45292dbf2c7303b2a5b521a8098cb1c3901aa6e1de2d24b0a70ff77
-  data.tar.gz: 2f9c350f7122e5a54a2f5e065ae9ddaa7d2c8f4dd45194c88a134547185d070c71c2c8e49e498f2697a0a9332b0cf5605e62f868cc800ef245db6639fd8c771d
+  metadata.gz: d52269f57a761867001fc0f550cbee434b70a8ee3eeac9fae9ceea6fb29d0311770192465b352867b818cd99608a27ad3e4e3b566b3edba7bd408693ed2881d2
+  data.tar.gz: c31ae9246857a214d329572ae3d72ec65e0f0f505a108096faaf07159786f9d2180c5b516db2044e519a82bb27ccbb97e19b160ffb76e717bdef7efa27f043ac

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.3.0
+
+- Add json rendering for index and show paths
+- Add `render_index_json(resources)` to easily override json responses on the index route
+- Add `render_index_any(resources, format:)` to easily override non-json responses on the index route
+- Add `render_show_json(resource)` to easily override json responses on the show route
+- Add `render_show_any(resource, format:)` to easily override non-json responses on the show route
+
 ## 0.2.0
 
 Load on after_initialize hook

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    administrate-base_controller (0.2.0)
+    administrate-base_controller (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -41,6 +41,10 @@ You get the following _protected_ methods for free, which you may override:
 | `authorize_resource` | `show_action?(action_name.to_sym, resource)` | Allows you to change how resources are authorized |
 | `resource_params` | Calls `read_param(k, v)` for each instead of `transform_values` | Allows you to change how params are read |
 | `read_param` | Calls `read_param_value` if applicable | Allows you to change how a param is read based on its key |
+| `render_index_json` | `json: resources.to_json` | Easily override json responses on the index route without changing the resources logic |
+| `render_index_any` | `locals: resources, page, ...` | Easily override any responses on the index route without changing the resources logic |
+| `render_show_json` | `json: resource.to_json` | Easily override json responses on the show route without changing the resources logic |
+| `render_show_any` | `locals: resource, page, ...` | Easily override any responses on the show route without changing the resources logic |
 
 ```ruby
 module Admin
@@ -60,7 +64,7 @@ module Admin
     def current_ability
       @_current_ability ||= Ability.new(current_admin_user)
      end
-    
+
     def show_action?(action, resource)
       current_ability.can?(action.to_sym, resource)
     end
@@ -73,13 +77,13 @@ Additionally you can correctly hide resources the `current_ability` can not `act
 ```ruby
 module Admin
   class ApplicationController < Administrate::ApplicationController
-    
+
     # ...
-     
+
     def scoped_resource
       super.accessible_by(current_ability, action_name.to_sym)
     end
-  end 
+  end
 end
 ```
 
@@ -91,8 +95,8 @@ This works without this gem, but this gem allows you to changed `scoped_resource
 module Admin
   class BookController < ::Admin::ApplicationController
     def find_resource(param)
-      scoped_resource.friendly.find(param)  
-    end 
+      scoped_resource.friendly.find(param)
+    end
   end
 end
 ```
@@ -107,7 +111,7 @@ module Admin
   class BookController < ::Admin::ApplicationController
     def index_scoped_resource
       super.where(author: Current.author)
-    end 
+    end
   end
 end
 ```
@@ -124,7 +128,7 @@ module Admin
   class BookController < ::Admin::ApplicationController
     def new_resource
       resource_class.new(author: Current.author)
-    end 
+    end
   end
 end
 ```
@@ -138,12 +142,12 @@ field, which contents have been serialized, you can overwrite `read_param`:
 module Admin
   class BookController < ::Admin::ApplicationController
     JSON_FIELDS = %w[options content].freeze
-    
+
     def read_param(key, value)
       return Oj.load(value) if JSON_FIELDS.include?(String(key))
       super(key, value)
     end
-  end 
+  end
 end
 ```
 
@@ -152,21 +156,21 @@ Alternatively you can use the [`administrate-serialized_fields`](https://github.
 ## Related
 
 - [`Administrate`](https://github.com/thoughtbot/administrate): A Rails engine that helps you put together a super-flexible admin dashboard.
-<!-- - [`Administrate::BaseController`](https://github.com/XPBytes/administrate-base_controller): A set of application controller improvements. -->
 
 ### Concerns
 
-- [`Administrate::DefaultOrder`](https://github.com/XPBytes/administrate-default_order): Sets the default order for a resource in a administrate controller.
-- [`Administrate::SerializedFields`](https://github.com/XPBytes/administrate-serialized_fields): Automatically deserialize administrate fields on form submit.
+- [`Administrate::DefaultOrder`](https://github.com/XPBytes/administrate-default_order): :1234: Sets the default order for a resource in a administrate controller.
+- [`Administrate::SerializedFields`](https://github.com/XPBytes/administrate-serialized_fields): :ab: Automatically deserialize administrate fields on form submit.
 
 ### Fields
 
-- [`Administrate::Field::Code`](https://github.com/XPBytes/administrate-field-code): A `text` field that shows code.
-- [`Administrate::Field::Hyperlink`](https://github.com/XPBytes/administrate-field-hyperlink): A `string` field that is shows a hyperlink.
-- [`Adminisrtate::Field::JsonEditor`](https://github.com/XPBytes/administrate-field-json_editor): A `text` field that shows a [JSON editor](https://github.com/josdejong/jsoneditor).
-- [`Administrate::Field::ScopedBelongsTo`](https://github.com/XPBytes/administrate-field-scoped_belongs_to): A `belongs_to` field that yields itself to the scope `lambda`.
-- [`Administrate::Field::ScopedHasMany`](https://github.com/XPBytes/administrate-field-scoped_has_many): A `has_many` field that yields itself to the scope `lambda`.
-- [`Administrate::Field::TimeAgo`](https://github.com/XPBytes/administrate-field-time_ago): A `date_time` field that shows its data as `time_ago` since.
+- [`Administrate::Field::Code`](https://github.com/XPBytes/administrate-field-code): :pencil: A `text` field that shows code.
+- [`Administrate::Field::Hyperlink`](https://github.com/XPBytes/administrate-field-hyperlink): :pencil: A `string` field that is shows a hyperlink.
+- [`Adminisrtate::Field::JsonEditor`](https://github.com/XPBytes/administrate-field-json_editor): :pencil: A `text` field that shows a [JSON editor](https://github.com/josdejong/jsoneditor).
+- [`Administrate::Field::LazyBelongsTo`](https://github.com/XPBytes/administrate-field-lazy_belongs_to): :pencil: An input field that lazy loads `belongs_to` values.
+- [`Administrate::Field::ScopedBelongsTo`](https://github.com/XPBytes/administrate-field-scoped_belongs_to): :pencil: A `belongs_to` field that yields itself to the scope `lambda`.
+- [`Administrate::Field::ScopedHasMany`](https://github.com/XPBytes/administrate-field-scoped_has_many): :pencil: A `has_many` field that yields itself to the scope `lambda`.
+- [`Administrate::Field::TimeAgo`](https://github.com/XPBytes/administrate-field-time_ago): :pencil: A `date_time` field that shows its data as `time_ago` since.
 
 ## Development
 

data/lib/administrate/base_controller.rb

@@ -10,14 +10,11 @@ module Administrate
           resources = apply_resource_includes(resources)
           resources = order.apply(resources)
           resources = resources.page(params[:page]).per(records_per_page)
-          page = index_page
 
-          render locals: {
-              resources: resources,
-              search_term: search_term,
-              page: page,
-              show_search_bar: show_search_bar?,
-          }
+          respond_to do |format|
+            format.json { render_index_json(resources) }
+            format.any { render_index_any(resources, format: format) }
+          end
         end
 
         def new
@@ -31,7 +28,10 @@ module Administrate
         end
 
         def show
-          render locals: { page: show_page }
+          respond_to do |format|
+            format.json { render_show_json(requested_resource) }
+            format.any { render_show_any(requested_resource, format: format) }
+          end
         end
 
         protected
@@ -52,8 +52,8 @@ module Administrate
           Administrate::Page::Collection.new(dashboard, order: order)
         end
 
-        def show_page
-          Administrate::Page::Show.new(dashboard, requested_resource)
+        def show_page(resource = requested_resource)
+          Administrate::Page::Show.new(dashboard, resource)
         end
 
         def new_page(resource)
@@ -87,6 +87,29 @@ module Administrate
           data
         end
 
+        def render_index_json(resources)
+          render json: resources
+        end
+
+        def render_index_any(resources, format:)
+          page = index_page
+
+          render locals: {
+            resources: resources,
+            search_term: search_term,
+            page: page,
+            show_search_bar: show_search_bar?,
+          }
+        end
+
+        def render_show_json(resource = requested_resource)
+          render json: resource
+        end
+
+        def render_show_any(resource = requested_resource, format:)
+          render locals: { page: show_page(resource) }
+        end
+
         private
 
         attr_writer :search_term

data/lib/administrate/base_controller/version.rb

@@ -1,5 +1,5 @@
 module Administrate
   module BaseController
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: administrate-base_controller
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-15 00:00:00.000000000 Z
+date: 2019-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: administrate