godmin 0.9.0

data/lib/godmin.rb

@@ -0,0 +1,24 @@
+require "bootstrap-sass"
+require "kaminari"
+require "select2-rails"
+require "simple_form"
+require "godmin/application"
+require "godmin/authentication"
+require "godmin/authorization"
+require "godmin/engine"
+require "godmin/rails"
+require "godmin/resolver"
+require "godmin/resource"
+require "godmin/version"
+
+module Godmin
+  mattr_accessor :namespace
+  self.namespace = nil
+
+  mattr_accessor :resources
+  self.resources = []
+
+  def self.configure
+    yield self
+  end
+end

data/lib/godmin/application.rb

@@ -0,0 +1,37 @@
+require "godmin/helpers/application"
+require "godmin/helpers/translations"
+
+module Godmin
+  module Application
+    extend ActiveSupport::Concern
+
+    included do
+      helper Godmin::Helpers::Application
+      helper Godmin::Helpers::Translations
+
+      helper_method :authentication_enabled?
+      helper_method :authorization_enabled?
+
+      before_action :append_view_paths
+
+      layout "godmin/application"
+    end
+
+    def welcome; end
+
+    private
+
+    def append_view_paths
+      append_view_path Godmin::EngineResolver.new(controller_name)
+      append_view_path Godmin::GodminResolver.new(controller_name)
+    end
+
+    def authentication_enabled?
+      singleton_class.include?(Godmin::Authentication)
+    end
+
+    def authorization_enabled?
+      singleton_class.include?(Godmin::Authorization)
+    end
+  end
+end

data/lib/godmin/authentication.rb

@@ -0,0 +1,35 @@
+require "godmin/authentication/sessions"
+require "godmin/authentication/user"
+
+module Godmin
+  module Authentication
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :authenticate_admin_user
+
+      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, alert: "Authentication needed"
+      end
+    end
+
+    def admin_user_class
+      raise NotImplementedError, "Must define the 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
+    end
+
+    def admin_user_signed_in?
+      admin_user.present?
+    end
+  end
+end

data/lib/godmin/authentication/sessions.rb

@@ -0,0 +1,45 @@
+module Godmin
+  module Authentication
+    module Sessions
+      extend ActiveSupport::Concern
+
+      included do
+        layout "godmin/login"
+      end
+
+      def new
+        @admin_user = admin_user_class.new
+      end
+
+      def create
+        @admin_user = admin_user_class.find_by_login(admin_user_login)
+
+        if @admin_user && @admin_user.authenticate(admin_user_params[:password])
+          session[:admin_user_id] = @admin_user.id
+          redirect_to root_path, notice: t("godmin.sessions.signed_in")
+        else
+          redirect_to new_session_path, alert: t("godmin.sessions.failed_sign_in")
+        end
+      end
+
+      def destroy
+        session[:admin_user_id] = nil
+        redirect_to new_session_path, notice: t("godmin.sessions.signed_out")
+      end
+
+      private
+
+      def admin_user_login
+        admin_user_params[admin_user_class.login_column]
+      end
+
+      def admin_user_params
+        params.require(:admin_user).permit(
+          admin_user_class.login_column,
+          :password,
+          :password_confirm
+        )
+      end
+    end
+  end
+end

data/lib/godmin/authentication/user.rb

@@ -0,0 +1,27 @@
+module Godmin
+  module Authentication
+    module User
+      extend ActiveSupport::Concern
+
+      included do
+        has_secure_password
+
+        validates :password, length: { minimum: 8 }, allow_nil: true
+      end
+
+      def login
+        send(self.class.login_column)
+      end
+
+      module ClassMethods
+        def find_by_login(login)
+          find_by(login_column => login)
+        end
+
+        def login_column
+          raise NotImplementedError, "Must define the admin user login column"
+        end
+      end
+    end
+  end
+end

data/lib/godmin/authorization.rb

@@ -0,0 +1,30 @@
+require "godmin/authorization/policy"
+require "godmin/authorization/policy_finder"
+
+module Godmin
+  module Authorization
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :policy
+    end
+
+    def authorize(record)
+      policy = policy(record)
+
+      unless policy.public_send(action_name + "?")
+        raise NotAuthorizedError
+      end
+    end
+
+    def policy(record)
+      policies[record] ||= PolicyFinder.find(record).constantize.new(admin_user, record)
+    end
+
+    def policies
+      @_policies ||= {}
+    end
+
+    class NotAuthorizedError < StandardError; end
+  end
+end

data/lib/godmin/authorization/policy.rb

@@ -0,0 +1,40 @@
+module Godmin
+  module Authorization
+    class Policy
+      attr_reader :user, :record
+
+      def initialize(user, record)
+        @user = user
+        @record = record
+      end
+
+      def index?
+        false
+      end
+
+      def show?
+        false
+      end
+
+      def new?
+        create?
+      end
+
+      def edit?
+        update?
+      end
+
+      def create?
+        false
+      end
+
+      def update?
+        false
+      end
+
+      def destroy?
+        false
+      end
+    end
+  end
+end

data/lib/godmin/authorization/policy_finder.rb

@@ -0,0 +1,28 @@
+module Godmin
+  module Authorization
+    class PolicyFinder
+      class << self
+        def find(object)
+          klass =
+            if object.respond_to?(:model_name)
+              object.model_name
+            elsif object.class.respond_to?(:model_name)
+              object.class.model_name
+            elsif object.is_a?(Class)
+              object
+            elsif object.is_a?(Symbol)
+              object.to_s.classify
+            else
+              object.class
+            end
+
+          if Godmin.namespace
+            "#{Godmin.namespace.classify}::#{klass}Policy"
+          else
+            "#{klass}Policy"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/godmin/engine.rb

@@ -0,0 +1,4 @@
+module Godmin
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/godmin/generators/base.rb

@@ -0,0 +1,13 @@
+require "active_support/all"
+
+module Godmin
+  module Generators
+    class Base < Rails::Generators::Base
+      private
+
+      def namespace
+        Rails::Generators.namespace.to_s.underscore.presence
+      end
+    end
+  end
+end

data/lib/godmin/helpers/application.rb

@@ -0,0 +1,6 @@
+module Godmin
+  module Helpers
+    module Application
+    end
+  end
+end

data/lib/godmin/helpers/batch_actions.rb

@@ -0,0 +1,17 @@
+module Godmin
+  module Helpers
+    module BatchActions
+      def batch_action_link(name, options)
+        if (options[:only].nil? && options[:except].nil?) ||
+           (options[:only] && options[:only].include?(params[:scope].to_sym)) ||
+           (options[:except] && !options[:except].include?(params[:scope].to_sym))
+
+          link_to(translate_scoped("batch_actions.#{name}", default: name.to_s.titleize), "#", class: "btn btn-default batch-actions-action-link hidden", data: {
+            value: name,
+            confirm: options[:confirm] ? translate_scoped("batch_actions.confirm_message") : false
+          })
+        end
+      end
+    end
+  end
+end

data/lib/godmin/helpers/filters.rb

@@ -0,0 +1,108 @@
+module Godmin
+  module Helpers
+    module Filters
+      def filter_input_tag(name, options)
+        case options[:as]
+        when :string
+          filter_string_tag(name, options)
+        when :select
+          filter_select_tag(name, options)
+        when :multiselect
+          filter_multiselect_tag(name, options)
+        when :checkboxes
+          filter_checkbox_tags(name, options)
+        end
+      end
+
+      private
+
+      def filter_string_tag(name, _options)
+        text_field_tag(
+          name,
+          default_filter_value(name),
+          name: "filter[#{name}]",
+          class: "form-control",
+          placeholder: translate_scoped("filters.labels.#{name}", default: name.to_s.titleize)
+        )
+      end
+
+      def filter_select_tag(name, options)
+        filter_select_tag_helper(
+          name,
+          options,
+          name: "filter[#{name}]",
+          include_blank: true,
+          class: "form-control select-tag",
+          data: {
+            placeholder: translate_scoped("filters.select.placeholder.one")
+          }
+        )
+      end
+
+      def filter_multiselect_tag(name, options)
+        filter_select_tag_helper(
+          name,
+          options,
+          name: "filter[#{name}][]",
+          multiple: true,
+          class: "form-control select-tag",
+          data: {
+            placeholder: translate_scoped("filters.select.placeholder.many")
+          }
+        )
+      end
+
+      def filter_select_tag_helper(name, options, html_options)
+        unless options[:collection].is_a? Proc
+          raise "A collection proc must be specified for select filters"
+        end
+
+        collection = options[:collection].call
+
+        if collection.is_a? ActiveRecord::Relation
+          choices = options_from_collection_for_select(
+            collection,
+            options[:option_value],
+            options[:option_text],
+            selected: default_filter_value(name)
+          )
+        else
+          choices = options_for_select(
+            collection,
+            selected: default_filter_value(name)
+          )
+        end
+
+        select_tag(name, choices, html_options)
+      end
+
+      def filter_checkbox_tags(name, options)
+        unless options[:collection].is_a? Proc
+          raise "A collection proc must be specified for checkbox filters"
+        end
+
+        collection = options[:collection].call
+
+        collection.map do |item|
+          text, value = if !item.is_a?(String) && item.respond_to?(:first) && item.respond_to?(:last)
+            [item.first.to_s, item.last.to_s]
+          else
+            [item.to_s, item.to_s]
+          end
+
+          is_checked = default_filter_value(name) ? default_filter_value(name).include?(value) : false
+
+          content_tag :div, class: "checkbox" do
+            label_tag("#{name}_#{value}") do
+              check_box_tag("filter[#{name}][]", value, is_checked, id: "#{name}_#{value}") << text
+            end
+          end
+        end.join("\n").html_safe
+      end
+
+      def default_filter_value(name)
+        params[:filter] ? params[:filter][name] : nil
+      end
+    end
+  end
+end

data/lib/godmin/helpers/tables.rb

@@ -0,0 +1,41 @@
+module Godmin
+  module Helpers
+    module Tables
+      def column_header(attribute)
+        if @resource_class.column_names.include?(attribute.to_s)
+          direction =
+            if params[:order]
+              if params[:order].split("_").first == attribute.to_s
+                params[:order].split("_").last == "desc" ? "asc" : "desc"
+              else
+                params[:order].split("_").last
+              end
+            else
+              "desc"
+            end
+          link_to @resource_class.human_attribute_name(attribute.to_s), url_for(params.merge(order: "#{attribute}_#{direction}"))
+        else
+          @resource_class.human_attribute_name(attribute.to_s)
+        end
+      end
+
+      def column_value(resource, attribute)
+        if lookup_context.exists?("columns/#{attribute}", nil, true)
+          render partial: "columns/#{attribute}", locals: { resource: resource }
+        else
+          column_value = resource.send(attribute)
+
+          if column_value.is_a?(Date) || column_value.is_a?(Time)
+            column_value = l(column_value, format: :long)
+          end
+
+          if column_value.is_a?(TrueClass) || column_value.is_a?(FalseClass)
+            column_value = t(column_value.to_s)
+          end
+
+          column_value
+        end
+      end
+    end
+  end
+end