godmin 1.5.0 → 2.0.0

data/lib/generators/godmin/resource/resource_generator.rb

@@ -4,7 +4,7 @@ class Godmin::ResourceGenerator < Godmin::Generators::NamedBase
   argument :attributes, type: :array, default: [], banner: "attribute attribute"
 
   def add_route
-    route "resources :#{file_name.pluralize}"
+    invoke "resource_route"
   end
 
   def add_navigation
@@ -15,6 +15,12 @@ class Godmin::ResourceGenerator < Godmin::Generators::NamedBase
     end
   end
 
+  def create_model
+    if namespaced?
+      template "resource_model.rb", File.join("app/models", class_path, "#{file_name}.rb")
+    end
+  end
+
   def create_controller
     template "resource_controller.rb", File.join("app/controllers", class_path, "#{file_name.pluralize}_controller.rb")
   end

data/lib/generators/godmin/resource/templates/resource_model.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class <%= class_name %> < ::<%= class_name %>
+end
+<% end -%>

data/lib/godmin/application_controller.rb

@@ -28,15 +28,6 @@ module Godmin
 
     protected
 
-    def redirect_back
-      case Rails::VERSION::MAJOR
-      when 4
-        redirect_to :back
-      when 5
-        super(fallback_location: root_path)
-      end
-    end
-
     private
 
     def engine_wrapper
@@ -47,12 +38,20 @@ module Godmin
       append_view_path Godmin::Resolver.resolvers(controller_path, engine_wrapper)
     end
 
+    def disable_authentication
+      @_disable_authentication = true
+    end
+
+    def disable_authorization
+      @_disable_authorization = true
+    end
+
     def authentication_enabled?
-      singleton_class.include?(Godmin::Authentication)
+      !@_disable_authentication && singleton_class.include?(Godmin::Authentication)
     end
 
     def authorization_enabled?
-      singleton_class.include?(Godmin::Authorization)
+      !@_disable_authorization && singleton_class.include?(Godmin::Authorization)
     end
   end
 end

data/lib/godmin/authentication.rb

@@ -6,26 +6,26 @@ module Godmin
     extend ActiveSupport::Concern
 
     included do
-      before_action :authenticate_admin_user
+      before_action :authenticate
 
       helper_method :admin_user
       helper_method :admin_user_signed_in?
     end
 
-    def authenticate_admin_user
-      unless admin_user_signed_in? || controller_name == "sessions"
-        redirect_to new_session_path
-      end
-    end
+    def authenticate
+      return unless authentication_enabled?
+      return if admin_user_signed_in?
 
-    def admin_user_class
-      raise NotImplementedError, "Must define the admin user class"
+      redirect_to new_session_path
     end
 
+    def admin_user_class; end
+
     def admin_user
-      if session[:admin_user_id]
-        @admin_user ||= admin_user_class.find_by(id: session[:admin_user_id])
-      end
+      return unless admin_user_class
+      return unless session[:admin_user_id]
+
+      @_admin_user ||= admin_user_class.find_by(id: session[:admin_user_id])
     end
 
     def admin_user_signed_in?

data/lib/godmin/authentication/sessions_controller.rb

@@ -5,6 +5,7 @@ module Godmin
 
       included do
         layout "godmin/login"
+        prepend_before_action :disable_authentication
       end
 
       def new

data/lib/godmin/authorization.rb

@@ -1,34 +1,20 @@
+require "pundit"
 require "godmin/authorization/policy"
-require "godmin/authorization/policy_finder"
 
 module Godmin
   module Authorization
     extend ActiveSupport::Concern
 
-    included do
-      helper_method :policy
+    include Pundit
 
-      rescue_from NotAuthorizedError do
+    included do
+      rescue_from Pundit::NotAuthorizedError do
         render plain: "You are not authorized to do this", status: 403, layout: "godmin/login"
       end
     end
 
-    def authorize(record, query = nil)
-      policy = policy(record)
-
-      unless policy.public_send(query || action_name + "?")
-        fail NotAuthorizedError
-      end
+    def pundit_user
+      admin_user
     end
-
-    def policy(record)
-      policies[record] ||= PolicyFinder.find(record, engine_wrapper.namespace).new(admin_user, record)
-    end
-
-    def policies
-      @_policies ||= {}
-    end
-
-    class NotAuthorizedError < StandardError; end
   end
 end

data/lib/godmin/engine_wrapper.rb

@@ -40,8 +40,17 @@ module Godmin
       end
     end
 
+    # Some gymnastics because the `parents` function is slated for deprecation
+    # and being replaced by `module_parents` and we don't want to clutter our
+    # log with a million warnings
+    def parents_of(controller)
+      return controller.module_parents if controller.respond_to?(:module_parents)
+
+      controller.parents
+    end
+
     def find_engine_module(controller)
-      controller.parents.find do |parent|
+      parents_of(controller).find do |parent|
         parent.respond_to?(:use_relative_model_naming?) && parent.use_relative_model_naming?
       end
     end

data/lib/godmin/generators/base.rb

@@ -4,7 +4,7 @@ module Godmin
   module Generators
     class Base < Rails::Generators::Base
       def self.source_paths
-        %w(authentication install policy resource).map do |path|
+        %w[authentication install policy resource].map do |path|
           File.expand_path("../../../generators/godmin/#{path}/templates", __FILE__)
         end
       end
@@ -12,15 +12,15 @@ module Godmin
       private
 
       def namespace
-        @namespace ||= Rails::Generators.namespace
+        @_namespace ||= Rails::Generators.namespace
       end
 
       def namespaced?
-        @namespaced ||= namespace.present?
+        @_namespaced ||= namespace.present?
       end
 
       def namespaced_path
-        @namespaced_path ||= begin
+        @_namespaced_path ||= begin
           if namespaced?
             namespace.name.split("::").map(&:underscore)
           else

data/lib/godmin/generators/named_base.rb

@@ -8,7 +8,7 @@ module Godmin
       private
 
       def full_class_name
-        if namespace
+        if namespaced?
           "#{namespace}::#{class_name}"
         else
           class_name
@@ -16,15 +16,15 @@ module Godmin
       end
 
       def class_name
-        @class_name ||= name.classify
+        @_class_name ||= name.classify
       end
 
       def class_path
-        @class_path ||= namespaced_path + name.classify.deconstantize.split("::").map(&:underscore)
+        @_class_path ||= namespaced_path + name.classify.deconstantize.split("::").map(&:underscore)
       end
 
       def file_name
-        @file_name ||= class_name.demodulize.underscore
+        @_file_name ||= class_name.demodulize.underscore
       end
     end
   end

data/lib/godmin/helpers/application.rb

@@ -4,17 +4,17 @@ module Godmin
       # Renders the provided partial with locals if it exists, otherwise
       # yields the given block. The lookup context call is cached for
       # each partial.
-      def partial_override(partial, locals = {})
+      def partial_override(partial, locals = {}, &block)
         @_partial_override ||= {}
 
-        if @_partial_override[partial].nil?
+        unless @_partial_override.key?(partial)
           @_partial_override[partial] = lookup_context.exists?(partial, nil, true)
         end
 
         if @_partial_override[partial]
           render partial: partial, locals: locals
         else
-          yield
+          capture(&block)
         end
       end
 

data/lib/godmin/resolver.rb

@@ -16,15 +16,30 @@ module Godmin
       @engine_wrapper = engine_wrapper
     end
 
+    # This function is for Rails 6 and up since the `find_templates` function
+    # is deprecated. It does the same thing, just a little differently. It's
+    # not being run by versions previous to Rails 6.
+    def _find_all(name, prefix, partial, details, key, locals)
+      templates = []
+
+      template_paths(prefix).each do |p|
+        break if templates.present?
+
+        path = Path.build(name, "#{@path}/#{p}", partial)
+        templates = query(path, details, details[:formats], locals, cache: !!key)
+      end
+
+      templates
+    end
+
+    # This is how we find templates in Rails 5 and below.
     def find_templates(name, prefix, *args)
       templates = []
 
       template_paths(prefix).each do |path|
-        if templates.present?
-          break
-        else
-          templates = super(name, path, *args)
-        end
+        break if templates.present?
+
+        templates = super(name, path, *args)
       end
 
       templates

data/lib/godmin/resources/resource_controller/batch_actions.rb

@@ -33,7 +33,7 @@ module Godmin
             end
           end
 
-          redirect_back
+          redirect_back(fallback_location: root_path)
         end
 
         def batch_action_ids

data/lib/godmin/resources/resource_service.rb

@@ -24,11 +24,7 @@ module Godmin
       end
 
       def resource_class
-        @options[:resource_class] || resource_class_name.constantize
-      end
-
-      def resource_class_name
-        self.class.name.demodulize.chomp("Service")
+        self.class.name.chomp("Service").constantize
       end
 
       def resources_relation

data/lib/godmin/version.rb

@@ -1,3 +1,3 @@
 module Godmin
-  VERSION = "1.5.0"
+  VERSION = "2.0.0"
 end

data/template.rb

@@ -3,7 +3,7 @@ require "active_support/all"
 def install_standalone
   set_ruby_version
 
-  gem "godmin", "1.3.1"
+  gem "godmin", "1.5.0"
 
   after_bundle do
     create_database
@@ -36,7 +36,7 @@ def install_engine
 
   inject_into_file "admin/admin.gemspec", before: /^end/ do
     <<-END.strip_heredoc.indent(2)
-      s.add_dependency "godmin", "~> 1.3.1"
+      s.add_dependency "godmin", "~> 1.5.0"
     END
   end
 
@@ -71,7 +71,7 @@ end
 
 def set_ruby_version
   prepend_to_file "Gemfile" do
-    "ruby '2.2.2'\n"
+    "ruby '2.3.5'\n"
   end
 end
 

data/test/dummy/admin/app/controllers/admin/authorized_articles_controller.rb

@@ -0,0 +1,15 @@
+require_dependency "admin/articles_controller"
+
+module Admin
+  class AuthorizedArticlesController < ArticlesController
+    include Godmin::Authorization
+
+    def admin_user
+      "admin"
+    end
+
+    def resource_service_class
+      Admin::ArticleService
+    end
+  end
+end

data/test/dummy/admin/app/models/admin/article.rb

@@ -0,0 +1,4 @@
+module Admin
+  class Article < ::Article
+  end
+end

data/test/dummy/admin/app/policies/admin/article_policy.rb

@@ -0,0 +1,7 @@
+module Admin
+  class ArticlePolicy < Godmin::Authorization::Policy
+    def index?
+      false
+    end
+  end
+end

data/test/dummy/admin/config/routes.rb

@@ -1,4 +1,5 @@
 Admin::Engine.routes.draw do
   resources :articles
+  resources :authorized_articles
   root to: "application#welcome"
 end

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+//= link application.css
+//= link application.js
+//= link admin/application.css
+//= link admin/application.js

data/test/dummy/app/controllers/another_admin_sessions_controller.rb

@@ -2,8 +2,6 @@ class AnotherAdminSessionsController < ApplicationController
   include Godmin::Authentication::SessionsController
   include Godmin::Authentication
 
-  skip_before_action :authenticate_admin_user
-
   def admin_user_class
     AnotherAdminUser
   end

data/test/dummy/db/migrate/20150717121532_create_articles.rb

@@ -1,4 +1,4 @@
-class CreateArticles < ActiveRecord::Migration
+class CreateArticles < ActiveRecord::Migration[5.0]
   def change
     create_table :articles do |t|
       t.string :title

data/test/dummy/db/migrate/20150907133753_create_admin_users.rb

@@ -1,4 +1,4 @@
-class CreateAdminUsers < ActiveRecord::Migration
+class CreateAdminUsers < ActiveRecord::Migration[5.0]
   def change
     create_table :admin_users do |t|
       t.string :email

data/test/dummy/db/migrate/20160713134238_create_comment.rb

@@ -1,4 +1,4 @@
-class CreateComment < ActiveRecord::Migration
+class CreateComment < ActiveRecord::Migration[5.0]
   def change
     create_table :comments do |t|
       t.references :article, index: true, foreign_key: true

data/test/dummy/db/schema.rb

@@ -13,32 +13,33 @@
 ActiveRecord::Schema.define(version: 20170207081043) do
 
   create_table "admin_users", force: :cascade do |t|
-    t.string   "email"
-    t.text     "password_digest"
-    t.datetime "created_at",      null: false
-    t.datetime "updated_at",      null: false
+    t.string "email"
+    t.text "password_digest"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 
   create_table "another_admin_users", force: :cascade do |t|
-    t.string   "email"
-    t.text     "password_digest"
-    t.datetime "created_at",      null: false
-    t.datetime "updated_at",      null: false
+    t.string "email"
+    t.text "password_digest"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 
   create_table "articles", force: :cascade do |t|
-    t.string   "title"
-    t.text     "body"
-    t.boolean  "published",     default: false
-    t.integer  "admin_user_id"
-    t.datetime "created_at",                    null: false
-    t.datetime "updated_at",                    null: false
+    t.string "title"
+    t.text "body"
+    t.boolean "published", default: false
+    t.integer "admin_user_id"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["admin_user_id"], name: "index_articles_on_admin_user_id"
   end
 
   create_table "comments", force: :cascade do |t|
     t.integer "article_id"
-    t.string  "title"
-    t.text    "body"
+    t.string "title"
+    t.text "body"
     t.index ["article_id"], name: "index_comments_on_article_id"
   end