administrate-base_controller 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3d86a463b8de9a3ac555327f413d273ec996e1f5381c47deb98732166777a29
-  data.tar.gz: 360287eb7fc408e9d7044ac2238997cb4cb647cd8b78486265661213b5bb484e
+  metadata.gz: 7fde5133218cd1044607f58848e8d3ef6348832d66578578de5dd0cedd04b112
+  data.tar.gz: 60c1aedb3a89c6113e583b5c1ad2803895eb32594e2983e99eb511e5179c8219
 SHA512:
-  metadata.gz: d52269f57a761867001fc0f550cbee434b70a8ee3eeac9fae9ceea6fb29d0311770192465b352867b818cd99608a27ad3e4e3b566b3edba7bd408693ed2881d2
-  data.tar.gz: c31ae9246857a214d329572ae3d72ec65e0f0f505a108096faaf07159786f9d2180c5b516db2044e519a82bb27ccbb97e19b160ffb76e717bdef7efa27f043ac
+  metadata.gz: afd6361c383b4b3a515a3025da5015b8e52644dc72aa267033063d812a6b9cc08a80188cf3d8a257323c0fb4b8bcf307511a805db9517ee22ef5f76fabc80a90
+  data.tar.gz: 2924d3caa5a94a0d71d51aa8561aa9281da010ffb078a1d8cce05dc52ba2bfb164946f65ddb8ece0fe82331b15c3e94ea48cb715892f429be667ec9e251e63d0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.4.0
+
+- Extract all methods into a module `BaseController`
+- Remove default `after_initialize` evaluation. You may require `administrate/base_controller/engine` instead
+- Add some annotations to some of the methods
+
 ## 0.3.0
 
 - Add json rendering for index and show paths

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    administrate-base_controller (0.3.0)
+    administrate-base_controller (0.4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -173,7 +173,7 @@ PLATFORMS
   x64-mingw32
 
 DEPENDENCIES
-  administrate (>= 0.11.0, < 1)
+  administrate (~> 0.11.0)
   administrate-base_controller!
   bundler (~> 2.0)
   minitest (~> 5.0)

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 Adminstrate::BaseControll` 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:
 

data/administrate-base_controller.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   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 'administrate', '~> 0.11.0'
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/administrate/base_controller.rb

@@ -1,119 +1,139 @@
 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)
-
-          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 edit
-          render locals: { page: edit_page(requested_resource) }
-        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
-
-        def search_term
-          @search_term ||= params[:search].to_s.strip
-        end
-
-        def index_scoped_resource
-          scoped_resource
-        end
-
-        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
-
-        def show_page(resource = requested_resource)
-          Administrate::Page::Show.new(dashboard, resource)
-        end
-
-        def new_page(resource)
-          Administrate::Page::Form.new(dashboard, resource)
-        end
-
-        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 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
-        end
-
-        def read_param(_, data)
-          if data.is_a?(ActionController::Parameters) && data[:type]
-            return read_param_value(data)
-          end
-
-          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
+  module BaseController
+    def index
+      resources = index_resources
+      resources = apply_resource_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 edit
+      render locals: { page: edit_page(requested_resource) }
+    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
+
+    def search_term
+      @search_term ||= params[:search].to_s.strip
+    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
+
+    ##
+    # 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
+
+    ##
+    # The page used for +index+.
+    #
+    def index_page
+      Administrate::Page::Collection.new(dashboard, order: order)
+    end
+
+    ##
+    # The page used for +show+
+    #
+    def show_page(resource = requested_resource)
+      Administrate::Page::Show.new(dashboard, resource)
+    end
+
+    ##
+    # The page used for +new+
+    #
+    def new_page(resource)
+      Administrate::Page::Form.new(dashboard, 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 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
+    end
+
+    def read_param(_, data)
+      if data.is_a?(ActionController::Parameters) && data[:type]
+        return read_param_value(data)
+      end
+
+      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
   end
 end

data/lib/administrate/base_controller/engine.rb

@@ -0,0 +1,14 @@
+require 'administrate/base_controller/version'
+require 'administrate/engine'
+
+require_relative '../base_controller'
+
+module Administrate
+  class Engine < Rails::Engine
+    config.after_initialize do
+      ::Administrate::ApplicationController.class_eval do
+        include BaseController
+      end
+    end
+  end
+end

data/lib/administrate/base_controller/version.rb

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

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: administrate-base_controller
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-22 00:00:00.000000000 Z
+date: 2019-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: administrate
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.11.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.11.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +106,7 @@ files:
 - bin/console
 - bin/setup
 - lib/administrate/base_controller.rb
+- lib/administrate/base_controller/engine.rb
 - lib/administrate/base_controller/version.rb
 homepage: https://github.com/XPBytes/administrate-base_controller
 licenses: