godmin 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19ea145e85a221046da2c5f9bac8653bf16fa24f
-  data.tar.gz: 9fa954f22350d6891ba27cbc999f6f54572fbbb8
+  metadata.gz: 5485225c54b1b8d9dec2a7d5d01aafe12f6109fa
+  data.tar.gz: f9ccde13580100c1134bc45701bd4e06cd4222f7
 SHA512:
-  metadata.gz: 8468f4af31b9a57d6cf81429294e7d97140cd9609c607af195c792d9971b84138ec3fddab1259115de77b38a0404bf4538d368e023ba07ef350d22c802cc6dc7
-  data.tar.gz: c4d0f3a0f7dd3e76a7909682d0e40aa6f3b97a61746e72673ab1a724def65863cf2905a59c8d646b62f9ba823e456c2ccec2cf070573c54bf16d485210c74e9f
+  metadata.gz: f2312da3947f533300714a819f812d1d2bfbffafe20d93fbf6a74c8aff1262e3587218e3116d7edf64d16248ff78022f7fe2addf103adfe6e26c863aada8e297
+  data.tar.gz: 34df58f5528358d065426c1ffae18619b1f431ec341ab9bfc5de4344b2bfdfbd2c3590702674ddb8d3b76d9ccc20742ba71c1b0a4317644a99e955d0adc7205c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+### 1.2.0 - 2016-02-02
+Features
+- Adds support for custom ordering of columns (https://github.com/varvet/godmin/pull/168)
+- Adds passing of html options to association helper (https://github.com/varvet/godmin/pull/176)
+
+Bug fixes:
+- Fixes an issue with the template resolver and Rails 4.2.5.1 (https://github.com/varvet/godmin/pull/175)
+
 ### 1.1.0 - 2015-12-08
 Features
 - Adds locale for pt-BR (Brazilian Portuguese) (https://github.com/varvet/godmin/pull/141)

data/README.md

@@ -12,24 +12,25 @@ Godmin differs from tools like [ActiveAdmin](http://activeadmin.info/) and [Rail
 ![Screenshot](https://raw.githubusercontent.com/varvet/godmin/master/screenshot.png)
 
 - [Installation](#installation)
-	- [Standalone installation](#standalone-installation)
-	- [Engine installation](#engine-installation)
-	- [Installation artefacts](#installation-artefacts)
+  - [Standalone installation](#standalone-installation)
+  - [Engine installation](#engine-installation)
+  - [Installation artefacts](#installation-artefacts)
 - [Getting started](#getting-started)
 - [Resources](#resources)
-	- [Scopes](#scopes)
-	- [Filters](#filters)
-	- [Batch actions](#batch-actions)
-	- [Resource fetching, building and saving](#resource-fetching-building-and-saving)
-	- [Redirecting](#redirecting)
-	- [Pagination](#pagination)
-	- [Exporting](#exporting)
+  - [Scopes](#scopes)
+  - [Filters](#filters)
+  - [Batch actions](#batch-actions)
+  - [Custom ordering](#custom-ordering)
+  - [Resource fetching, building and saving](#resource-fetching-building-and-saving)
+  - [Redirecting](#redirecting)
+  - [Pagination](#pagination)
+  - [Exporting](#exporting)
 - [Views](#views)
   - [Forms](#forms)
   - [Navigation](#navigation)
 - [Authentication](#authentication)
-	- [Built in authentication](#built-in-authentication)
-	- [Shared authentication](#shared-authentication)
+  - [Built in authentication](#built-in-authentication)
+  - [Shared authentication](#shared-authentication)
 - [Authorization](#authorization)
 - [Localization](#localization)
 - [JavaScript](#javascript)
@@ -273,6 +274,24 @@ end
 
 If you are using Godmin's built in authorization functionality you must [authorize your batch actions in your policy](#batch-action-authorization).
 
+### Custom ordering
+
+By default, Godmin supports ordering of database columns in the index view table. However, it cannot automatically sort associations, custom attributes and so on.
+If you want to order something that Godmin doesn't support out of the box, or you just want to customize how a columns is ordered, you can implement your own ordering functionality in the service object by creating a `order_by_<attribute>` method.
+
+```ruby
+class ArticleService
+  include Godmin::Resources::ResourceService
+  attrs_for_index :title, :author
+
+  # resources is an ActiveRecord::Relation object
+  # direction is the order direction ("asc" or "desc")
+  def order_by_author(resources, direction)
+    resources.joins(:authors).order("authors.name #{direction}")
+  end
+end
+```
+
 ### Resource fetching, building and saving
 
 Resources are made available to the views through instance variables. The index view can access the resources using `@resources` while show, new and edit can access the single resource using `@resource`. In addition, the resource class is available as `@resource_class` and the service object is available as `@resource_service`.

data/lib/godmin/helpers/forms.rb

@@ -24,10 +24,12 @@ module Godmin
         end
       end
 
-      def association(attribute, options = {})
+      def association(attribute, options = {}, html_options = {})
         case association_type(attribute)
         when :belongs_to
-          select "#{attribute}_id", association_collection_for_select(attribute), {}, data: { behavior: "select-box" }
+          select("#{attribute}_id", association_collection_for_select(attribute), options, html_options.deep_merge(
+            data: { behavior: "select-box" }
+          ))
         else
           input(attribute, options)
         end

data/lib/godmin/helpers/tables.rb

@@ -2,13 +2,15 @@ module Godmin
   module Helpers
     module Tables
       def column_header(attribute)
-        if @resource_class.column_names.include?(attribute.to_s)
+        if @resource_service.orderable_column?(attribute.to_s)
           direction =
             if params[:order].present?
               if params[:order].match(/\A#{attribute.to_s}_(asc|desc)\z/)
                 $1 == "desc" ? "asc" : "desc"
               elsif params[:order].match(/\A\w+_(asc|desc)\z/)
                 $1
+              else
+                "desc"
               end
             else
               "desc"

data/lib/godmin/resolver.rb

@@ -13,14 +13,14 @@ module Godmin
       @engine_wrapper = engine_wrapper
     end
 
-    def find_templates(name, prefix, partial, details)
+    def find_templates(name, prefix, *args)
       templates = []
 
       template_paths(prefix).each do |path|
         if templates.present?
           break
         else
-          templates = super(name, path, partial, details)
+          templates = super(name, path, *args)
         end
       end
 

data/lib/godmin/resources/resource_service/ordering.rb

@@ -5,21 +5,35 @@ module Godmin
         extend ActiveSupport::Concern
 
         def apply_order(order_param, resources)
-          if order_param.present?
+          if order_param.present? && order_column_method?(order_column(order_param))
+            send("order_by_#{order_column(order_param)}", resources, order_direction(order_param))
+          elsif order_param.present? && order_column_column?(order_column(order_param))
             resources.order("#{resource_class.table_name}.#{order_column(order_param)} #{order_direction(order_param)}")
           else
             resources
           end
         end
 
+        def orderable_column?(column)
+          order_column_method?(column) || order_column_column?(column)
+        end
+
         protected
 
+        def order_column_method?(column)
+          respond_to?("order_by_#{column}")
+        end
+
+        def order_column_column?(column)
+          resource_class.column_names.include?(column)
+        end
+
         def order_column(order_param)
           order_param.rpartition("_").first
         end
 
         def order_direction(order_param)
-          order_param.rpartition("_").last
+          order_param.rpartition("_").last == "asc" ? "asc" : "desc"
         end
       end
     end

data/lib/godmin/version.rb

@@ -1,3 +1,3 @@
 module Godmin
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

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

@@ -0,0 +1,11 @@
+class AuthenticatedArticlesController < ArticlesController
+  include Godmin::Authentication
+
+  def admin_user_class
+    AdminUser
+  end
+
+  def resource_service_class
+    ArticleService
+  end
+end

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

@@ -0,0 +1,11 @@
+class AuthorizedArticlesController < ArticlesController
+  include Godmin::Authorization
+
+  def admin_user
+    "admin"
+  end
+
+  def resource_service_class
+    ArticleService
+  end
+end

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

@@ -1,3 +1,8 @@
-class SessionsController < SecretController
+class SessionsController < ApplicationController
   include Godmin::Authentication::SessionsController
+  include Godmin::Authentication
+
+  def admin_user_class
+    AdminUser
+  end
 end

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

@@ -1,2 +1,11 @@
 class Article < ActiveRecord::Base
+  belongs_to :admin_user
+
+  def non_orderable_column
+    "Not orderable"
+  end
+
+  def to_s
+    title
+  end
 end

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

@@ -0,0 +1,13 @@
+class ArticlePolicy < Godmin::Authorization::Policy
+  def index?
+    true
+  end
+
+  def show?
+    user == "admin"
+  end
+
+  def destroy?
+    false
+  end
+end

data/test/dummy/app/services/article_service.rb

@@ -1,9 +1,13 @@
 class ArticleService
   include Godmin::Resources::ResourceService
 
-  attrs_for_index :id, :title, :published, :created_at
-  attrs_for_show :id, :title, :body, :published
-  attrs_for_form :title, :body, :published
+  attrs_for_index :id, :title, :non_orderable_column, :admin_user, :published, :created_at
+  attrs_for_show :id, :title, :body, :admin_user, :published
+  attrs_for_form :title, :body, :admin_user, :published
+
+  def order_by_admin_user(resources, direction)
+    resources.joins(:admin_users).order("admin_users.email #{direction}")
+  end
 
   scope :unpublished
   scope :published

data/test/dummy/config/routes.rb

@@ -1,6 +1,7 @@
 Rails.application.routes.draw do
   resources :articles
-  resources :secret_articles
+  resources :authenticated_articles
+  resources :authorized_articles
   resource :session, only: [:new, :create, :destroy]
   root to: "application#welcome"
   mount Admin::Engine, at: "admin"

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

@@ -4,6 +4,7 @@ class CreateArticles < ActiveRecord::Migration
       t.string :title
       t.text :body
       t.boolean :published, default: false
+      t.references :admin_user
 
       t.timestamps null: false
     end

data/test/dummy/db/schema.rb

@@ -23,9 +23,10 @@ ActiveRecord::Schema.define(version: 20150907133753) do
   create_table "articles", force: :cascade do |t|
     t.string   "title"
     t.text     "body"
-    t.boolean  "published",  default: false
-    t.datetime "created_at",                 null: false
-    t.datetime "updated_at",                 null: false
+    t.boolean  "published",     default: false
+    t.integer  "admin_user_id"
+    t.datetime "created_at",                    null: false
+    t.datetime "updated_at",                    null: false
   end
 
 end

data/test/fakes/article.rb

@@ -1,4 +1,11 @@
 module Fakes
   class Article
+    def self.table_name
+      "articles"
+    end
+
+    def self.column_names
+      ["id", "title"]
+    end
   end
 end

data/test/fakes/article_service.rb

@@ -21,7 +21,7 @@ module Fakes
 
     def initialize(*)
       super
-      @called_methods = { scopes: {}, filters: {}, batch_actions: {} }
+      @called_methods = { scopes: {}, filters: {}, batch_actions: {}, ordering: {} }
     end
 
     def resource_class
@@ -32,6 +32,11 @@ module Fakes
       [:foo, :bar, :baz]
     end
 
+    def order_by_foobar(resources, direction)
+      called_methods[:ordering][:by_foobar] = [resources, direction]
+      resources
+    end
+
     def scope_unpublished(resources)
       called_methods[:scopes][:unpublished] = resources
       resources.slice(1, 3)

data/test/integration/authentication_test.rb

@@ -0,0 +1,17 @@
+require "test_helper"
+
+class AuthenticationTest < ActionDispatch::IntegrationTest
+  def test_sign_in_and_out
+    AdminUser.create!(email: "admin@example.com", password: "password")
+    visit authenticated_articles_path
+    assert_not_equal authenticated_articles_path, current_path
+    fill_in "Email", with: "admin@example.com"
+    fill_in "Password", with: "password"
+    click_button "Sign in"
+    visit authenticated_articles_path
+    assert_equal authenticated_articles_path, current_path
+    click_link "Sign out"
+    visit authenticated_articles_path
+    assert_not_equal authenticated_articles_path, current_path
+  end
+end

data/test/integration/authorization_test.rb

@@ -0,0 +1,32 @@
+require "test_helper"
+
+class AuthorizationTest < ActionDispatch::IntegrationTest
+  def test_can_index?
+    visit authorized_articles_path
+    assert_equal 200, page.status_code
+  end
+
+  def test_can_show?
+    article = Article.create! title: "foo"
+
+    visit authorized_articles_path
+    within "[data-resource-id='#{article.id}']" do
+      click_link "Show"
+    end
+
+    assert_equal article_path(article), current_path
+    assert_equal 200, page.status_code
+  end
+
+  def test_cannot_destroy?
+    article = Article.create! title: "foo"
+
+    visit authorized_articles_path
+    within "[data-resource-id='#{article.id}']" do
+      assert page.has_no_content? "Destroy"
+    end
+
+    page.driver.delete authorized_article_path(article)
+    assert_equal 403, page.status_code
+  end
+end

data/test/integration/column_ordering_test.rb

@@ -20,4 +20,16 @@ class ColumnOrderingTest < ActionDispatch::IntegrationTest
     link = find("#table th.column-created_at a")
     assert_equal "/articles?order=created_at_desc", link[:href]
   end
+
+  def test_order_links_when_not_orderable
+    visit articles_path
+    assert has_selector?("#table th.column-non_orderable_column")
+    assert has_no_link?("#table th.column-non_orderable_column a")
+  end
+
+  def test_order_links_when_custom_orderable
+    visit articles_path
+    link = find("#table th.column-admin_user a")
+    assert_equal "/articles?order=admin_user_desc", link[:href]
+  end
 end

data/test/integration/crud_test.rb

@@ -0,0 +1,67 @@
+require "test_helper"
+
+class CrudTest < ActionDispatch::IntegrationTest
+  def test_list_resources
+    Article.create! title: "foo"
+    Article.create! title: "bar"
+
+    visit articles_path
+
+    assert page.has_content? "foo"
+    assert page.has_content? "bar"
+  end
+
+  def test_show_resource
+    article = Article.create! title: "foo", body: "bar"
+
+    visit articles_path
+    within "[data-resource-id='#{article.id}']" do
+      click_link "Show"
+    end
+
+    assert_equal article_path(article), current_path
+    assert page.has_content? "Title foo"
+    assert page.has_content? "Body bar"
+  end
+
+  def test_create_resource
+    visit articles_path
+    click_link "Create Article"
+    fill_in "Title", with: "foo"
+    fill_in "Body", with: "bar"
+    click_button "Create Article"
+
+    assert_equal article_path(Article.last), current_path
+    assert page.has_content? "Title foo"
+    assert page.has_content? "Body bar"
+  end
+
+  def test_update_resource
+    article = Article.create! title: "foo", body: "bar"
+
+    visit articles_path
+    within "[data-resource-id='#{article.id}']" do
+      click_link "Edit"
+    end
+    fill_in "Title", with: "baz"
+    click_button "Update Article"
+
+    assert_equal article_path(article), current_path
+    assert page.has_content? "Title baz"
+    assert page.has_content? "Body bar"
+  end
+
+  def test_destroy_resource
+    article_1 = Article.create! title: "foo"
+    article_2 = Article.create! title: "bar"
+
+    visit articles_path
+    within "[data-resource-id='#{article_1.id}']" do
+      click_link "Destroy"
+    end
+
+    assert_equal articles_path, current_path
+    assert page.has_no_content? "foo"
+    assert page.has_content? "bar"
+  end
+end

data/test/lib/godmin/resources/resource_service/ordering_test.rb

@@ -4,12 +4,6 @@ module Godmin
   module ResourceService
     class OrderingTest < ActiveSupport::TestCase
       def setup
-        resource_class = Class.new do
-          def self.table_name
-            "articles"
-          end
-        end
-
         @resources_class = Class.new do
           attr_reader :order_param
 
@@ -18,7 +12,8 @@ module Godmin
           end
         end
 
-        @article_service = ArticleService.new(resource_class: resource_class)
+        @resources = @resources_class.new
+        @article_service = Fakes::ArticleService.new(resources: @resources)
       end
 
       def test_apply_order
@@ -32,6 +27,11 @@ module Godmin
         @article_service.apply_order("", resources)
         assert_equal nil, resources.order_param
       end
+
+      def test_apply_order_with_custom_ordering_method
+        @article_service.apply_order("foobar_desc", @resources)
+        assert_equal [@resources, "desc"], @article_service.called_methods[:ordering][:by_foobar]
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: godmin
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jens Ljungblad
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-08 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -378,18 +378,17 @@ files:
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/articles_controller.rb
+- test/dummy/app/controllers/authenticated_articles_controller.rb
+- test/dummy/app/controllers/authorized_articles_controller.rb
 - test/dummy/app/controllers/concerns/.keep
-- test/dummy/app/controllers/secret_articles_controller.rb
-- test/dummy/app/controllers/secret_controller.rb
 - test/dummy/app/controllers/sessions_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/models/.keep
 - test/dummy/app/models/admin_user.rb
 - test/dummy/app/models/article.rb
 - test/dummy/app/models/concerns/.keep
-- test/dummy/app/models/secret_article.rb
+- test/dummy/app/policies/article_policy.rb
 - test/dummy/app/services/article_service.rb
-- test/dummy/app/services/secret_article_service.rb
 - test/dummy/app/views/articles/.keep
 - test/dummy/app/views/articles/columns/.keep
 - test/dummy/app/views/articles/filters/.keep
@@ -426,15 +425,17 @@ files:
 - test/dummy/public/favicon.ico
 - test/fakes/article.rb
 - test/fakes/article_service.rb
+- test/integration/authentication_test.rb
+- test/integration/authorization_test.rb
 - test/integration/batch_actions_test.rb
 - test/integration/column_ordering_test.rb
-- test/integration/column_overriding_test.rb
-- test/integration/filter_overriding_test.rb
+- test/integration/crud_test.rb
 - test/integration/filters_test.rb
-- test/integration/partial_overriding_test.rb
 - test/integration/scopes_test.rb
-- test/integration/sign_in_test.rb
-- test/integration/template_overriding_test.rb
+- test/integration/view_overriding/column_overriding_test.rb
+- test/integration/view_overriding/filter_overriding_test.rb
+- test/integration/view_overriding/partial_overriding_test.rb
+- test/integration/view_overriding/template_overriding_test.rb
 - test/integration/welcome_test.rb
 - test/lib/godmin/engine_wrapper_test.rb
 - test/lib/godmin/helpers/filters_test.rb
@@ -500,18 +501,17 @@ test_files:
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/articles_controller.rb
+- test/dummy/app/controllers/authenticated_articles_controller.rb
+- test/dummy/app/controllers/authorized_articles_controller.rb
 - test/dummy/app/controllers/concerns/.keep
-- test/dummy/app/controllers/secret_articles_controller.rb
-- test/dummy/app/controllers/secret_controller.rb
 - test/dummy/app/controllers/sessions_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/models/.keep
 - test/dummy/app/models/admin_user.rb
 - test/dummy/app/models/article.rb
 - test/dummy/app/models/concerns/.keep
-- test/dummy/app/models/secret_article.rb
+- test/dummy/app/policies/article_policy.rb
 - test/dummy/app/services/article_service.rb
-- test/dummy/app/services/secret_article_service.rb
 - test/dummy/app/views/articles/.keep
 - test/dummy/app/views/articles/columns/.keep
 - test/dummy/app/views/articles/filters/.keep
@@ -548,15 +548,17 @@ test_files:
 - test/dummy/public/favicon.ico
 - test/fakes/article.rb
 - test/fakes/article_service.rb
+- test/integration/authentication_test.rb
+- test/integration/authorization_test.rb
 - test/integration/batch_actions_test.rb
 - test/integration/column_ordering_test.rb
-- test/integration/column_overriding_test.rb
-- test/integration/filter_overriding_test.rb
+- test/integration/crud_test.rb
 - test/integration/filters_test.rb
-- test/integration/partial_overriding_test.rb
 - test/integration/scopes_test.rb
-- test/integration/sign_in_test.rb
-- test/integration/template_overriding_test.rb
+- test/integration/view_overriding/column_overriding_test.rb
+- test/integration/view_overriding/filter_overriding_test.rb
+- test/integration/view_overriding/partial_overriding_test.rb
+- test/integration/view_overriding/template_overriding_test.rb
 - test/integration/welcome_test.rb
 - test/lib/godmin/engine_wrapper_test.rb
 - test/lib/godmin/helpers/filters_test.rb

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

@@ -1,3 +0,0 @@
-class SecretArticlesController < SecretController
-  include Godmin::Resources::ResourceController
-end

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

@@ -1,7 +0,0 @@
-class SecretController < ApplicationController
-  include Godmin::Authentication
-
-  def admin_user_class
-    AdminUser
-  end
-end

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

@@ -1,2 +0,0 @@
-class SecretArticle < Article
-end

data/test/dummy/app/services/secret_article_service.rb

@@ -1,2 +0,0 @@
-class SecretArticleService < ArticleService
-end

data/test/integration/sign_in_test.rb

@@ -1,17 +0,0 @@
-require "test_helper"
-
-class SignInTest < ActionDispatch::IntegrationTest
-  def test_sign_in_and_out
-    AdminUser.create!(email: "admin@example.com", password: "password")
-    visit secret_articles_path
-    assert_not_equal secret_articles_path, current_path
-    fill_in "Email", with: "admin@example.com"
-    fill_in "Password", with: "password"
-    click_button "Sign in"
-    visit secret_articles_path
-    assert_equal secret_articles_path, current_path
-    click_link "Sign out"
-    visit secret_articles_path
-    assert_not_equal secret_articles_path, current_path
-  end
-end