godmin 0.9.0

data/lib/godmin/helpers/translations.rb

@@ -0,0 +1,19 @@
+module Godmin
+  module Helpers
+    module Translations
+      def translate_scoped(translate, scope: nil, default: nil, **options)
+        if @resource_class
+          scope ||= @resource_class.to_s.underscore
+        end
+
+        defaults = [
+          ["godmin", scope, translate].compact.join(".").to_sym,
+          ["godmin", translate].compact.join(".").to_sym,
+          default
+        ]
+
+        t(defaults.shift, default: defaults, **options)
+      end
+    end
+  end
+end

data/lib/godmin/rails.rb

@@ -0,0 +1,36 @@
+module ActionDispatch::Routing
+  class Mapper
+    def godmin
+      override_resources do
+        yield
+      end
+
+      unless has_named_route?(:root)
+        root to: "application#welcome"
+      end
+    end
+
+    private
+
+    def override_resources
+      def resources(*resources)
+        unless Godmin.resources.include?(resources.first)
+          Godmin.resources << resources.first
+        end
+
+        super(*resources) do
+          if block_given?
+            yield
+          end
+          post "batch_action", on: :collection
+        end
+      end
+
+      yield
+
+      def resources(*resources, &block)
+        super(*resources, &block)
+      end
+    end
+  end
+end

data/lib/godmin/resolver.rb

@@ -0,0 +1,46 @@
+module Godmin
+  class Resolver < ::ActionView::FileSystemResolver
+    attr_accessor :namespace, :controller_name
+
+    def find_templates(name, prefix, partial, details)
+      template = []
+
+      template_paths(prefix, partial).each do |path|
+        template = super(name, path, partial, details)
+
+        if template.present?
+          break
+        end
+      end
+
+      template
+    end
+
+    def template_paths(prefix, _partial)
+      [
+        [namespace, controller_name, prefix],
+        [namespace, controller_name],
+        [namespace, prefix],
+        [namespace, "resource", prefix],
+        [namespace, "resource"],
+        [namespace]
+      ].map { |path| path.compact.join("/") }.compact
+    end
+  end
+
+  class EngineResolver < Resolver
+    def initialize(controller_name)
+      super [Godmin.namespace, "app/views"].compact.join("/")
+      self.namespace       = Godmin.namespace
+      self.controller_name = controller_name
+    end
+  end
+
+  class GodminResolver < Resolver
+    def initialize(controller_name)
+      super [Godmin::Engine.root, "app/views"].compact.join("/")
+      self.namespace       = "godmin"
+      self.controller_name = controller_name
+    end
+  end
+end

data/lib/godmin/resource.rb

@@ -0,0 +1,126 @@
+require "godmin/helpers/batch_actions"
+require "godmin/helpers/filters"
+require "godmin/helpers/tables"
+require "godmin/resource/batch_actions"
+require "godmin/resource/filters"
+require "godmin/resource/ordering"
+require "godmin/resource/pagination"
+require "godmin/resource/scopes"
+
+module Godmin
+  module Resource
+    extend ActiveSupport::Concern
+
+    included do
+      helper Godmin::Helpers::BatchActions
+      helper Godmin::Helpers::Filters
+      helper Godmin::Helpers::Tables
+
+      include Godmin::Resource::BatchActions
+      include Godmin::Resource::Filters
+      include Godmin::Resource::Scopes
+      include Godmin::Resource::Ordering
+      include Godmin::Resource::Pagination
+
+      respond_to :html, :json
+
+      before_action :set_resource_class
+      before_action :set_resources, only: :index
+      before_action :set_resource, only: [:show, :new, :edit, :update, :destroy]
+
+      helper_method :attrs_for_index
+      helper_method :attrs_for_form
+    end
+
+    def resource_class
+      controller_name.classify.constantize
+    end
+
+    def resources_relation
+      resource_class.all
+    end
+
+    def resources
+      apply_pagination(
+        apply_order(
+          apply_filters(
+            apply_scope(
+              resources_relation
+            )
+          )
+        )
+      )
+    end
+
+    def resource
+      if params[:id]
+        resources_relation.find(params[:id])
+      else
+        resources_relation.new
+      end
+    end
+
+    def index
+      respond_with(@resources)
+    end
+
+    def show
+      respond_with(@resource)
+    end
+
+    def new
+      respond_with(@resource)
+    end
+
+    def edit
+      respond_with(@resource)
+    end
+
+    def create
+      @resource = resource_class.create(resource_params)
+      respond_with(@resource)
+    end
+
+    def update
+      @resource.update(resource_params)
+      respond_with(@resource)
+    end
+
+    def destroy
+      @resource.destroy
+      respond_with(@resource)
+    end
+
+    # Gives the view access to the list of column names
+    # to be printed in the index view
+    def attrs_for_index
+      []
+    end
+
+    # Gives the view access to the list of attributes
+    # to be included in the default form
+    def attrs_for_form
+      []
+    end
+
+    protected
+
+    def set_resource_class
+      @resource_class ||= resource_class
+    end
+
+    def set_resources
+      @resources ||= resources
+      authorize(@resources) if authorization_enabled?
+    end
+
+    def set_resource
+      @resource ||= resource
+      authorize(@resource) if authorization_enabled?
+    end
+
+    def resource_params
+      params.require(resource_class.name.downcase.to_sym).permit(attrs_for_form)
+    end
+  end
+end

data/lib/godmin/resource/batch_actions.rb

@@ -0,0 +1,45 @@
+module Godmin
+  module Resource
+    module BatchActions
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :batch_action_map
+      end
+
+      def batch_action_map
+        self.class.batch_action_map
+      end
+
+      def batch_action
+        action   = params[:batch_action][:action]
+        item_ids = params[:batch_action][:items].keys.map(&:to_i)
+
+        if batch_action_map.key?(action.to_sym)
+          # Store the batched item ids so they can be highlighted later
+          flash[:batch_actioned_ids] = item_ids
+
+          # If the batch action returns false, it is because it has implemented
+          # its own redirect. Therefore we return wihout redirecting.
+          return unless send("batch_action_#{action}", resource_class.find(item_ids))
+        end
+
+        redirect_to :back
+      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

data/lib/godmin/resource/filters.rb

@@ -0,0 +1,41 @@
+module Godmin
+  module Resource
+    module Filters
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :filter_map
+      end
+
+      def filter_map
+        self.class.filter_map
+      end
+
+      def apply_filters(resources)
+        if params[:filter].present?
+          params[:filter].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

data/lib/godmin/resource/ordering.rb

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

data/lib/godmin/resource/pagination.rb

@@ -0,0 +1,11 @@
+module Godmin
+  module Resource
+    module Pagination
+      extend ActiveSupport::Concern
+
+      def apply_pagination(resources)
+        resources.page(params[:page])
+      end
+    end
+  end
+end

data/lib/godmin/resource/scopes.rb

@@ -0,0 +1,49 @@
+module Godmin
+  module Resource
+    module Scopes
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :scope_map
+      end
+
+      def scope_map
+        self.class.scope_map
+      end
+
+      def apply_scope(resources)
+        if params[:scope].blank?
+          params[:scope] = default_scope
+        end
+
+        if params[:scope] && scope_map.key?(params[:scope].to_sym)
+          send("scope_#{params[:scope]}", resources)
+        else
+          resources
+        end
+      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

data/lib/godmin/version.rb

@@ -0,0 +1,3 @@
+module Godmin
+  VERSION = "0.9.0"
+end

data/lib/tasks/godmin_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :godmin do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.