godmin 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a084849cf4dd5f729b2f5ca0dabdcec727ef1172eb1cb19baf9de27ca822950
-  data.tar.gz: 8b655c6dad3b1a1fc95d88b08cf2f25e848b646266fd63808dffad77b47f767e
+  metadata.gz: 11671dfd7c0219abf4626b93f1f7273ee5769486e48a43b82889fe43601f3370
+  data.tar.gz: 0bb8078a5792d05b7fbf4543fd20d924432571e22dc87e00beafc6309a4cae08
 SHA512:
-  metadata.gz: f0fec37368ae0548a3e3adb1b662f214aff97756f916d11da1907acbc7caa43304b920844f9a1f8ebb500a35d7f261c060fd8e605e5cb841e7fdafb9da8a744b
-  data.tar.gz: d6a218a707bafe5ac68611b13c74e6975c13702562d5a804514faad4af0100544b5bf722e252077af89653f2702deb932e36f1c5131855b2604af86247b069fe
+  metadata.gz: 7f02e2821b7bae9cd0611a97292f6cb8159e9bcaac1f871e7077ddf0f1ad553be98804e4385c434de5326ca12138310032fa52e459db0b9c6572eeac381dbc51
+  data.tar.gz: 166aef398cffb04a6b38560b177f991cdaf5e9cec4be9bf8d2025188d3b83a7c8763502b183ca891bb32b5e2ce7a4a8bc3ba90b7e464164b3be90400bd6b22b6

data/.travis.yml

@@ -4,9 +4,16 @@ script: bundle exec rake test
 rvm:
   - 2.6.7
   - 2.7.3
+  - 3.0.1
 gemfile:
   - gemfiles/rails_5.gemfile
   - gemfiles/rails_6.gemfile
+
+matrix:
+  exclude:
+    - rvm: 3.0.1
+      gemfile: gemfiles/rails_5.gemfile
+
 addons:
   code_climate:
     repo_token:

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+### 2.2.0 - 2021-05-20
+
+Other
+- Build and test against Ruby 3.0
+
+Bug fixes
+- Regression: within an Engine, always look for Pundit policies in the engine (https://github.com/varvet/godmin/pull/259)
+
 ### 2.1.0 - 2021-05-10
 
 Bug fixes

data/README.md

@@ -2,9 +2,8 @@
 
 [![Gem Version](http://img.shields.io/gem/v/godmin.svg)](https://rubygems.org/gems/godmin)
 [![Build Status](https://img.shields.io/travis/varvet/godmin/master.svg)](https://travis-ci.org/varvet/godmin)
-[![Code Climate](https://img.shields.io/codeclimate/github/varvet/godmin.svg)](https://codeclimate.com/github/varvet/godmin)
-
-**If you are looking for the current stable version, which is Rails 4+ compatible, see the [v1.5](https://github.com/varvet/godmin/tree/v1.5) branch**
+[![Code Climate](https://api.codeclimate.com/v1/badges/d8e5c7c54c1dba073689/maintainability)](https://codeclimate.com/github/varvet/godmin)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/d8e5c7c54c1dba073689/test_coverage)](https://codeclimate.com/github/varvet/godmin)
 
 Godmin is an admin framework for Rails 5+. Use it to build dedicated admin sections for your apps, or stand alone admin apps such as internal tools. It has support for common features such as scoping, filtering and performing batch actions on your models. Check out the [demo app](http://godmin-sandbox.herokuapp.com) and its [source code](https://github.com/varvet/godmin-sandbox) to get a feel for how it works.
 
@@ -873,6 +872,51 @@ class ArticlesController < ApplicationController
 end
 ```
 
+### Authorization in Engines
+
+When Godmin is installed as an engine, it expects policies to be defined
+within the engine: eg. `Admin::ArticlePolicy` defined in
+`admin/app/policies/article_policy.rb`.
+
+If your admin application is itself broken up into several engines, then
+either
+
+1. the policies for those engines need to live in the main engine, or
+2. those engines need to be namespaced under the namespace of the main engine.
+
+Here is one example of a directory structure for approach 2:
+
+```
+admin
+  ├── app
+  │   └── policies
+  │       └── admin
+  │           └── article_policy.rb
+  └── engines
+      └── content
+          └── policies
+              └── admin
+                  └── content
+                      └── text_block_policy.rb
+app
+  └── models
+      └── article.rb
+engines
+  └── content
+        └── models
+            └── content
+                └── text_block.rb
+```
+```ruby
+# admin/engines/content/policies/admin/content/text_block_policy.rb
+module Admin
+  module Content
+    class TextBlockPolicy < ::Admin::ApplicationPolicy
+    end
+  end
+end
+```
+
 ## Localization
 
 Godmin supports localization out of the box. For a list of translatable strings, [look here](https://github.com/varvet/godmin/blob/master/config/locales/en.yml).

data/app/views/godmin/resource/_pagination.html.erb

@@ -27,14 +27,14 @@
 </div>
 <div class="pagination-entries pull-right hidden-xs">
   <% if @resources.length == 0 %>
-    <%= translate_scoped("pagination.entries.zero", {
+    <%= translate_scoped("pagination.entries.zero",
       resource: @resource_class.model_name.human(count: @resources.length).downcase
-    }) %>
+    ) %>
   <% else %>
-    <%= translate_scoped("pagination.entries.other", {
+    <%= translate_scoped("pagination.entries.other",
       resource: @resource_class.model_name.human(count: @resources.length).downcase,
       count: @resources.length,
       total: @resource_service.paginator.total_resources
-    }) %>
+    ) %>
   <% end %>
 </div>

data/lib/godmin/authorization.rb

@@ -13,8 +13,42 @@ module Godmin
       end
     end
 
+    def policy(record)
+      policies[record] ||= Pundit.policy!(pundit_user, namespaced_record(record))
+    end
+
     def pundit_user
       admin_user
     end
+
+    def namespaced_record(record)
+      return record unless engine_wrapper.namespaced?
+
+      class_name = find_class_name(record)
+      if already_namespaced?(class_name)
+        record
+      else
+        engine_wrapper.namespaced_path.map(&:to_sym) << record
+      end
+    end
+
+    # Borrowed from Pundit::PolicyFinder
+    def find_class_name(subject)
+      if subject.respond_to?(:model_name)
+        subject.model_name
+      elsif subject.class.respond_to?(:model_name)
+        subject.class.model_name
+      elsif subject.is_a?(Class)
+        subject
+      elsif subject.is_a?(Symbol)
+        subject.to_s.camelize
+      else
+        subject.class
+      end
+    end
+
+    def already_namespaced?(subject)
+      subject.to_s.start_with?("#{engine_wrapper.namespace.name}::")
+    end
   end
 end

data/lib/godmin/version.rb

@@ -1,3 +1,3 @@
 module Godmin
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

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

@@ -8,6 +8,20 @@ module Admin
       "admin"
     end
 
+    def new
+      # The following calls to #policy are to check that the Authorization
+      # module can handle various different scenarios:
+      policy(Magazine).index?
+      policy(::Magazine).index?
+      policy(Magazine.new).index?
+      policy(Magazine.all).index?
+      policy(Admin::Magazine).index?
+      policy(Admin::Magazine.new).index?
+      policy(Admin::Magazine.where(name: "name")).index?
+
+      super
+    end
+
     def resource_service_class
       Admin::ArticleService
     end

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

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

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

@@ -3,5 +3,9 @@ module Admin
     def index?
       false
     end
+
+    def new?
+      true
+    end
   end
 end

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

@@ -0,0 +1,4 @@
+module Admin
+  class MagazinePolicy < Godmin::Authorization::Policy
+  end
+end

data/test/dummy/admin/app/views/admin/shared/_navigation.html.erb

@@ -1 +1,6 @@
 <%= navbar_item Article %>
+<% if policy(Article).index? %>
+  Can index
+<% else %>
+  Can't index
+<% end %>

data/test/dummy/app/models/magazine.rb

@@ -0,0 +1,2 @@
+class Magazine < ActiveRecord::Base
+end

data/test/dummy/db/migrate/20210519215502_create_magazines.rb

@@ -0,0 +1,9 @@
+class CreateMagazines < ActiveRecord::Migration[6.1]
+  def change
+    create_table :magazines do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/schema.rb

@@ -2,15 +2,15 @@
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
 #
-# Note that this schema.rb definition is the authoritative source for your
-# database schema. If you need to create the application database on another
-# system, you should be using db:schema:load, not running all the migrations
-# from scratch. The latter is a flawed and unsustainable approach (the more migrations
-# you'll amass, the slower it'll run and the greater likelihood for issues).
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20170207081043) do
+ActiveRecord::Schema.define(version: 2021_05_19_215502) do
 
   create_table "admin_users", force: :cascade do |t|
     t.string "email"
@@ -43,4 +43,11 @@ ActiveRecord::Schema.define(version: 20170207081043) do
     t.index ["article_id"], name: "index_comments_on_article_id"
   end
 
+  create_table "magazines", force: :cascade do |t|
+    t.string "name"
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+  end
+
+  add_foreign_key "comments", "articles"
 end

data/test/generators/resource_generator_test.rb

@@ -6,6 +6,7 @@ module Godmin
     tests ResourceGenerator
     destination File.expand_path("../../tmp", __FILE__)
     setup :prepare_destination
+    teardown :prepare_destination
 
     def test_resource_generator_in_standalone_install
       system "cd #{destination_root} && rails new . --skip-test --skip-spring --skip-bundle --skip-git --quiet"

data/test/integration/authorization_test.rb

@@ -34,4 +34,12 @@ class AuthorizationTest < ActionDispatch::IntegrationTest
     visit admin.authorized_articles_path
     assert_equal 403, page.status_code
   end
+
+  def test_uses_engine_policy_in_engine?
+    visit admin.new_authorized_article_path
+
+    assert_equal 200, page.status_code
+
+    assert page.has_content?("Can't index"), "when used in an engine, the `policy` method is using the policy from the main app, not the engine"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: godmin
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Jens Ljungblad
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-09 00:00:00.000000000 Z
+date: 2021-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -432,7 +432,9 @@ files:
 - test/dummy/admin/app/controllers/admin/articles_controller.rb
 - test/dummy/admin/app/controllers/admin/authorized_articles_controller.rb
 - test/dummy/admin/app/models/admin/article.rb
+- test/dummy/admin/app/models/admin/magazine.rb
 - test/dummy/admin/app/policies/admin/article_policy.rb
+- test/dummy/admin/app/policies/admin/magazine_policy.rb
 - test/dummy/admin/app/services/admin/article_service.rb
 - test/dummy/admin/app/views/admin/articles/.keep
 - test/dummy/admin/app/views/admin/articles/columns/.keep
@@ -461,6 +463,7 @@ files:
 - test/dummy/app/models/another_admin_user.rb
 - test/dummy/app/models/article.rb
 - test/dummy/app/models/comment.rb
+- test/dummy/app/models/magazine.rb
 - test/dummy/app/policies/article_policy.rb
 - test/dummy/app/services/article_service.rb
 - test/dummy/app/services/comment_service.rb
@@ -494,6 +497,7 @@ files:
 - test/dummy/db/migrate/20150907133753_create_admin_users.rb
 - test/dummy/db/migrate/20160713134238_create_comment.rb
 - test/dummy/db/migrate/20170207081043_create_another_admin_user.rb
+- test/dummy/db/migrate/20210519215502_create_magazines.rb
 - test/dummy/db/schema.rb
 - test/dummy/lib/assets/.keep
 - test/dummy/log/.keep
@@ -562,7 +566,9 @@ test_files:
 - test/dummy/admin/app/controllers/admin/articles_controller.rb
 - test/dummy/admin/app/controllers/admin/authorized_articles_controller.rb
 - test/dummy/admin/app/models/admin/article.rb
+- test/dummy/admin/app/models/admin/magazine.rb
 - test/dummy/admin/app/policies/admin/article_policy.rb
+- test/dummy/admin/app/policies/admin/magazine_policy.rb
 - test/dummy/admin/app/services/admin/article_service.rb
 - test/dummy/admin/app/views/admin/articles/.keep
 - test/dummy/admin/app/views/admin/articles/columns/.keep
@@ -591,6 +597,7 @@ test_files:
 - test/dummy/app/models/another_admin_user.rb
 - test/dummy/app/models/article.rb
 - test/dummy/app/models/comment.rb
+- test/dummy/app/models/magazine.rb
 - test/dummy/app/policies/article_policy.rb
 - test/dummy/app/services/article_service.rb
 - test/dummy/app/services/comment_service.rb
@@ -624,6 +631,7 @@ test_files:
 - test/dummy/db/migrate/20150907133753_create_admin_users.rb
 - test/dummy/db/migrate/20160713134238_create_comment.rb
 - test/dummy/db/migrate/20170207081043_create_another_admin_user.rb
+- test/dummy/db/migrate/20210519215502_create_magazines.rb
 - test/dummy/db/schema.rb
 - test/dummy/lib/assets/.keep
 - test/dummy/log/.keep