godmin 0.10.3 → 0.11.0

data/lib/godmin/resources/resource_service.rb

@@ -0,0 +1,82 @@
+require "godmin/resources/resource_service/batch_actions"
+require "godmin/resources/resource_service/filters"
+require "godmin/resources/resource_service/ordering"
+require "godmin/resources/resource_service/pagination"
+require "godmin/resources/resource_service/scopes"
+
+module Godmin
+  module Resources
+    module ResourceService
+      extend ActiveSupport::Concern
+
+      include BatchActions
+      include Filters
+      include Ordering
+      include Pagination
+      include Scopes
+
+      attr_reader :options
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      # TODO: should this raise its own error?
+      def resource_class
+        @options[:resource_class] || self.class.name.demodulize.chomp("Service").constantize
+      end
+
+      def resources_relation
+        resource_class.all
+      end
+
+      def resources(params)
+        apply_pagination(params[:page],
+          apply_order(params[:order],
+            apply_filters(params[:filter],
+              apply_scope(params[:scope],
+                resources_relation
+              )
+            )
+          )
+        )
+      end
+
+      def find_resource(id)
+        resources_relation.find(id)
+      end
+
+      def build_resource(params)
+        resources_relation.new(params)
+      end
+
+      def create_resource(resource)
+        resource.save
+      end
+
+      def update_resource(resource, params)
+        resource.update(params)
+      end
+
+      def attrs_for_index
+        self.class.attrs_for_index
+      end
+
+      def attrs_for_form
+        self.class.attrs_for_form
+      end
+
+      module ClassMethods
+        def attrs_for_index(*attrs)
+          @attrs_for_index = attrs if attrs.present?
+          @attrs_for_index || []
+        end
+
+        def attrs_for_form(*attrs)
+          @attrs_for_form = attrs if attrs.present?
+          @attrs_for_form || []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Godmin
+  module Resources
+    module ResourceService
+      module BatchActions
+        extend ActiveSupport::Concern
+
+        delegate :batch_action_map, to: "self.class"
+
+        def batch_action(action, item_ids)
+          if batch_action?(action)
+            send("batch_action_#{action}", resource_class.find(item_ids))
+            true
+          else
+            false
+          end
+        end
+
+        def batch_action?(action)
+          batch_action_map.key?(action.to_sym)
+        end
+
+        module ClassMethods
+          def batch_action_map
+            @batch_action_map ||= {}
+          end
+
+          def batch_action(attr, options = {})
+            batch_action_map[attr] = {
+              only: nil,
+              except: nil,
+              confirm: false
+            }.merge(options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Godmin
+  module Resources
+    module ResourceService
+      module Filters
+        extend ActiveSupport::Concern
+
+        delegate :filter_map, to: "self.class"
+
+        def apply_filters(filter_params, resources)
+          if filter_params.present?
+            filter_params.each do |name, value|
+              if filter_map.key?(name.to_sym) && value.present?
+                resources = send("filter_#{name}", resources, value)
+              end
+            end
+          end
+          resources
+        end
+
+        module ClassMethods
+          def filter_map
+            @filter_map ||= {}
+          end
+
+          def filter(attr, options = {})
+            filter_map[attr] = {
+              as: :string,
+              option_text: "to_s",
+              option_value: "id",
+              collection: nil
+            }.merge(options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Godmin
+  module Resources
+    module ResourceService
+      module Ordering
+        extend ActiveSupport::Concern
+
+        def apply_order(order_param, resources)
+          if order_param.present?
+            resources.order("#{resource_class.table_name}.#{order_column(order_param)} #{order_direction(order_param)}")
+          else
+            resources
+          end
+        end
+
+        protected
+
+        def order_column(order_param)
+          order_param.rpartition("_").first
+        end
+
+        def order_direction(order_param)
+          order_param.rpartition("_").last
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Godmin
+  module Resources
+    module ResourceService
+      module Pagination
+        extend ActiveSupport::Concern
+
+        def apply_pagination(page_param, resources)
+          @paginator = Paginator.new(resources, per_page: per_page, current_page: page_param)
+          @paginator.paginate
+        end
+
+        def paginator
+          @paginator
+        end
+
+        def per_page
+          25
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module Godmin
+  module Resources
+    module ResourceService
+      module Scopes
+        extend ActiveSupport::Concern
+
+        delegate :scope_map, to: "self.class"
+
+        def apply_scope(scope_param, resources)
+          return resources if scope_map.empty?
+
+          self.scope = scope_param
+
+          if scope && scope_map.key?(scope.to_sym)
+            send("scope_#{@scope}", resources)
+          else
+            fail NotImplementedError, "Scope #{@scope} not implemented"
+          end
+        end
+
+        def scope=(scope)
+          @scope = scope.blank? ? default_scope : scope
+        end
+
+        def scope
+          @scope
+        end
+
+        def scoped_by?(name)
+          @scope == name.to_s
+        end
+
+        def scope_count(scope)
+          send("scope_#{scope}", resources_relation).count
+        end
+
+        protected
+
+        def default_scope
+          scope = scope_map.find -> { scope_map.first } do |_key, value|
+            value[:default] == true
+          end
+
+          scope ? scope[0].to_s : nil
+        end
+
+        module ClassMethods
+          def scope_map
+            @scope_map ||= {}
+          end
+
+          def scope(attr, options = {})
+            scope_map[attr] = {
+              default: false
+            }.merge(options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/godmin/version.rb

@@ -1,3 +1,3 @@
 module Godmin
-  VERSION = "0.10.3"
+  VERSION = "0.11.0"
 end

data/test/dummy/config/environments/production.rb

@@ -20,7 +20,7 @@ Dummy::Application.configure do
   # config.action_dispatch.rack_cache = true
 
   # Disable Rails's static asset server (Apache or nginx will already do this).
-  config.serve_static_assets = false
+  config.serve_static_files = false
 
   # Compress JavaScripts and CSS.
   config.assets.js_compressor = :uglifier

data/test/dummy/config/environments/test.rb

@@ -13,7 +13,7 @@ Dummy::Application.configure do
   config.eager_load = false
 
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_assets  = true
+  config.serve_static_files = true
   config.static_cache_control = "public, max-age=3600"
 
   # Show full error reports and disable caching.

data/test/dummy/db/schema.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# 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).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 0) do
+
+end

data/test/lib/godmin/helpers/filters_test.rb

@@ -0,0 +1,26 @@
+require "test_helper"
+
+module Godmin
+  module Helpers
+    class FiltersTest < ActionView::TestCase
+      include BootstrapForm::Helper
+      include Godmin::Helpers::Filters
+      include Godmin::Helpers::Translations
+
+      def test_filter_form_is_a_bootstrap_form_builder
+        filter_form url: "/" do |f|
+          assert f.is_a? BootstrapForm::FormBuilder
+        end
+      end
+
+      # TODO: actually implement this test properly, apparently
+      # assert_select can be used if the helper output is parsed
+      # with HTML::Document first...
+      def test_string_filter_field
+        form = filter_form url: "/" do |f|
+          f.filter_field :foo, as: :string
+        end
+      end
+    end
+  end
+end

data/test/lib/godmin/paginator_test.rb

@@ -0,0 +1,84 @@
+require "test_helper"
+
+module Godmin
+  class PaginatorTest < ActiveSupport::TestCase
+    def setup
+      resources_class = Class.new do
+        attr_reader :limit_param
+        attr_reader :offset_param
+
+        def count
+          50
+        end
+
+        def limit(limit_param)
+          @limit_param = limit_param
+          self
+        end
+
+        def offset(offset_param)
+          @offset_param = offset_param
+          self
+        end
+      end
+
+      @resources = resources_class.new
+    end
+
+    def test_paginate
+      paginator = Paginator.new(@resources, per_page: 10, current_page: 1)
+
+      assert_equal @resources, paginator.paginate
+      assert_equal 10, @resources.limit_param
+      assert_equal 0, @resources.offset_param
+    end
+
+    def test_paginate_with_offset
+      paginator = Paginator.new(@resources, per_page: 10, current_page: 2)
+
+      assert_equal @resources, paginator.paginate
+      assert_equal 10, @resources.limit_param
+      assert_equal 10, @resources.offset_param
+    end
+
+    def test_current_page
+      paginator = Paginator.new(nil, current_page: 2)
+      assert_equal 2, paginator.current_page
+    end
+
+    def test_current_page_when_no_page
+      paginator = Paginator.new(nil)
+      assert_equal 1, paginator.current_page
+    end
+
+    def test_pages_when_pages_all_fit
+      paginator = Paginator.new(@resources, per_page: 10, current_page: 1)
+      assert_equal [1, 2, 3, 4, 5], paginator.pages
+    end
+
+    def test_pages_when_pages_dont_fit_and_on_first_page
+      paginator = Paginator.new(@resources, per_page: 2, current_page: 1)
+      assert_equal [1, 2, 3, 4, 5, 6, 7], paginator.pages
+    end
+
+    def test_pages_when_pages_dont_fit_and_on_middle_page
+      paginator = Paginator.new(@resources, per_page: 2, current_page: 7)
+      assert_equal [4, 5, 6, 7, 8, 9, 10], paginator.pages
+    end
+
+    def test_pages_when_pages_dont_fit_and_on_last_page
+      paginator = Paginator.new(@resources, per_page: 2, current_page: 25)
+      assert_equal [19, 20, 21, 22, 23, 24, 25], paginator.pages
+    end
+
+    def test_total_pages
+      paginator = Paginator.new(@resources, per_page: 10)
+      assert_equal 5, paginator.total_pages
+    end
+
+    def test_total_resources
+      paginator = Paginator.new(@resources)
+      assert_equal 50, paginator.total_resources
+    end
+  end
+end

data/test/lib/godmin/policy_finder_test.rb

@@ -1,28 +1,57 @@
 require "test_helper"
 
-class Article; extend ActiveModel::Naming; end
+module Namespace
+  class ArticlePolicyTestPolicy; end
+  class ObjectPolicy; end
+end
+
+class ArticlePolicyTest; extend ActiveModel::Naming; end
+class OverriddenPolicyTest
+  extend ActiveModel::Naming
+  def self.policy_class
+    Namespace::ObjectPolicy
+  end
+
+  def policy_class
+    Namespace::ObjectPolicy
+  end
+end
 
 module Godmin
   module Authorization
     class PolicyFinderTest < ActiveSupport::TestCase
       def test_find_by_model
         namespaced_as "namespace" do
-          policy = PolicyFinder.find(Article)
-          assert_equal "Namespace::ArticlePolicy", policy
+          policy = PolicyFinder.find(ArticlePolicyTest)
+          assert_equal Namespace::ArticlePolicyTestPolicy, policy
         end
       end
 
       def test_find_by_class
         namespaced_as "namespace" do
           policy = PolicyFinder.find(Object)
-          assert_equal "Namespace::ObjectPolicy", policy
+          assert_equal Namespace::ObjectPolicy, policy
         end
       end
 
       def test_find_by_symbol
         namespaced_as "namespace" do
-          policy = PolicyFinder.find(:article)
-          assert_equal "Namespace::ArticlePolicy", policy
+          policy = PolicyFinder.find(:article_policy_test)
+          assert_equal Namespace::ArticlePolicyTestPolicy, policy
+        end
+      end
+
+      def test_override_policy_class_on_class
+        namespaced_as "namespace" do
+          policy = PolicyFinder.find(OverriddenPolicyTest)
+          assert_equal Namespace::ObjectPolicy, policy
+        end
+      end
+
+      def test_override_policy_class_on_instance
+        namespaced_as "namespace" do
+          policy = PolicyFinder.find(OverriddenPolicyTest.new)
+          assert_equal Namespace::ObjectPolicy, policy
         end
       end
     end