administrate-base_controller 0.2.0 → 0.6.0

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 Derk-Jan Karrenbeld
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2019 Derk-Jan Karrenbeld
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -24,7 +24,9 @@ Or install it yourself as:
 
 ## Usage
 
-When you require this gem, the base controller functionality will be added to the `administrate/application_controller`.
+When you require this gem, you can `include Administrate::BaseController` in your admin `ApplicationController`. 
+Alternatively require `administrate/base_controller/engine` instead (e.g. in your Gemfile). The base controller 
+functionality will be added to the `administrate/application_controller`.
 
 You get the following _protected_ methods for free, which you may override:
 
@@ -41,6 +43,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 +66,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 +79,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 +97,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 +113,7 @@ module Admin
   class BookController < ::Admin::ApplicationController
     def index_scoped_resource
       super.where(author: Current.author)
-    end 
+    end
   end
 end
 ```
@@ -124,7 +130,7 @@ module Admin
   class BookController < ::Admin::ApplicationController
     def new_resource
       resource_class.new(author: Current.author)
-    end 
+    end
   end
 end
 ```
@@ -138,12 +144,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 +158,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/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task :default => :test
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/administrate-base_controller.gemspec

@@ -1,42 +1,42 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'administrate/base_controller/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'administrate-base_controller'
-  spec.version       = Administrate::BaseController::VERSION
-  spec.authors       = ['Derk-Jan Karrenbeld']
-  spec.email         = ['derk-jan@xpbytes.com']
-
-  spec.summary       = 'Extends the ApplicationController in Administrate'
-  spec.homepage      = 'https://github.com/XPBytes/administrate-base_controller'
-  spec.license       = 'MIT'
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    # spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
-
-    spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = spec.homepage
-    spec.metadata['changelog_uri'] = spec.homepage + '/CHANGELOG.md'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'administrate', '>= 0.11.0', '< 1'
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rails'
-end
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'administrate/base_controller/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'administrate-base_controller'
+  spec.version       = Administrate::BaseController::VERSION
+  spec.authors       = ['Derk-Jan Karrenbeld']
+  spec.email         = ['derk-jan@xpbytes.com']
+
+  spec.summary       = 'Extends the ApplicationController in Administrate'
+  spec.homepage      = 'https://github.com/XPBytes/administrate-base_controller'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = spec.homepage + '/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'administrate', '~> 0.13.0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rails', '~> 6.0'
+end

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "administrate/default_order"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "administrate/default_order"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/administrate/base_controller.rb

@@ -1,96 +1,141 @@
 require 'administrate/base_controller/version'
-require 'administrate/engine'
 
 module Administrate
-  class Engine < Rails::Engine
-    config.after_initialize do
-      ::Administrate::ApplicationController.class_eval do
-        def index
-          resources = index_resources
-          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?,
-          }
-        end
+  module BaseController
+    def index
+      resources = index_resources
+      resources = apply_collection_includes(resources)
+      resources = order.apply(resources)
+      resources = resources.page(params[:page]).per(records_per_page)
+
+      respond_to do |format|
+        format.json { render_index_json(resources) }
+        format.any { render_index_any(resources, format: format) }
+      end
+    end
 
-        def new
-          resource = new_resource
-          authorize_resource(resource)
-          render locals: { page: new_page(resource) }
-        end
+    def new
+      resource = new_resource
+      authorize_resource(resource)
+      render locals: { page: new_page(resource) }
+    end
 
-        def edit
-          render locals: { page: edit_page(requested_resource) }
-        end
+    def edit
+      render locals: { page: edit_page(requested_resource) }
+    end
 
-        def show
-          render locals: { page: show_page }
-        end
+    def show
+      respond_to do |format|
+        format.json { render_show_json(requested_resource) }
+        format.any { render_show_any(requested_resource, format: format) }
+      end
+    end
 
-        protected
+    protected
 
-        def search_term
-          @search_term ||= params[:search].to_s.strip
-        end
+    def search_term
+      @search_term ||= params[:search].to_s.strip
+    end
 
-        def index_scoped_resource
-          scoped_resource
-        end
+    ##
+    # The resource scope only used for +index+.
+    #
+    # By default this calls +scoped_resource+ but it's common to overwrite this in controllers that would like a scoped
+    # view on the index page only. This way a subset of resources is shown, based on some state such as the path or a
+    # cookie or the current user, but +find_resource+ still works as intended when accessing the show path.
+    #
+    def index_scoped_resource
+      scoped_resource
+    end
 
-        def index_resources
-          Administrate::Search.new(index_scoped_resource, dashboard_class, search_term).run
-        end
+    ##
+    # Wraps the +index_scoped_resource+.
+    #
+    # By default this constructs the +Administrate::Search+ decorator, wraps the resources and runs it with the
+    # +dashboard_class+ and +search_term+. Overwrite this to turn off search.
+    #
+    def index_resources
+      Administrate::Search.new(index_scoped_resource, dashboard_class, search_term).run
+    end
 
-        def index_page
-          Administrate::Page::Collection.new(dashboard, order: order)
-        end
+    ##
+    # The page used for +index+.
+    #
+    def index_page
+      Administrate::Page::Collection.new(dashboard, order: order)
+    end
 
-        def show_page
-          Administrate::Page::Show.new(dashboard, requested_resource)
-        end
+    ##
+    # The page used for +show+
+    #
+    def show_page(resource = requested_resource)
+      Administrate::Page::Show.new(dashboard, resource)
+    end
 
-        def new_page(resource)
-          Administrate::Page::Form.new(dashboard, resource)
-        end
+    ##
+    # The page used for +new+
+    #
+    def new_page(resource)
+      Administrate::Page::Form.new(dashboard, resource)
+    end
 
-        def edit_page(resource)
-          new_page(resource)
-        end
+    ##
+    # The page used for +edit+
+    #
+    def edit_page(resource)
+      new_page(resource)
+    end
 
-        def authorize_resource(resource)
-          return if show_action?(action_name.to_sym, resource)
-          raise "That's not a valid action."
-        end
+    def authorize_resource(resource)
+      return if show_action?(action_name.to_sym, resource)
+      raise "That's not a valid action."
+    end
 
-        def resource_params
-          permitted = params.require(resource_class.model_name.param_key)
-                          .permit(dashboard.permitted_attributes)
-                          .to_h
+    def resource_params
+      permitted = params.require(resource_class.model_name.param_key)
+                      .permit(dashboard.permitted_attributes)
+                      .to_h
 
-          permitted.each_with_object(permitted) do |(k, v), result|
-            result[k] = read_param(k, v)
-          end
+      permitted.each_with_object(permitted) do |(k, v), result|
+        result[k] = read_param(k, v)
+      end
+    end
+
+    def read_param(_, data)
+      if data.is_a?(Hash) && data[:type]
+        if data[:type] == Administrate::Field::Polymorphic.to_s
+          return GlobalID::Locator.locate(data[:value])
         end
+      end
 
-        def read_param(_, data)
-          if data.is_a?(ActionController::Parameters) && data[:type]
-            return read_param_value(data)
-          end
+      data
+    end
 
-          data
-        end
+    def render_index_json(resources)
+      render json: resources
+    end
 
-        private
+    def render_index_any(resources, format:)
+      page = index_page
 
-        attr_writer :search_term
-      end
+      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
   end
 end