obitum-rails_admin 0.0.1

data/lib/rails_admin/config.rb

@@ -0,0 +1,293 @@
+require 'rails_admin/config/model'
+require 'rails_admin/config/sections/list'
+require 'active_support/core_ext/class/attribute_accessors'
+
+module RailsAdmin
+  module Config
+    # RailsAdmin is setup to try and authenticate with warden
+    # If warden is found, then it will try to authenticate
+    #
+    # This is valid for custom warden setups, and also devise
+    # If you're using the admin setup for devise, you should set RailsAdmin to use the admin
+    #
+    # @see RailsAdmin::Config.authenticate_with
+    # @see RailsAdmin::Config.authorize_with
+    DEFAULT_AUTHENTICATION = Proc.new do
+      request.env['warden'].try(:authenticate!)
+    end
+
+    DEFAULT_ATTR_ACCESSIBLE_ROLE = Proc.new { :default }
+
+    DEFAULT_AUTHORIZE = Proc.new {}
+    
+    DEFAULT_AUDIT = Proc.new {}
+
+    DEFAULT_CURRENT_USER = Proc.new do
+      request.env["warden"].try(:user) || respond_to?(:current_user) && current_user
+    end
+
+
+    class << self
+      # Application title, can be an array of two elements
+      attr_accessor :main_app_name
+
+      # Configuration option to specify which models you want to exclude.
+      attr_accessor :excluded_models
+
+      # Configuration option to specify a whitelist of models you want to RailsAdmin to work with.
+      # The excluded_models list applies against the whitelist as well and further reduces the models
+      # RailsAdmin will use.
+      # If included_models is left empty ([]), then RailsAdmin will automatically use all the models
+      # in your application (less any excluded_models you may have specified).
+      attr_accessor :included_models
+
+      # Fields to be hidden in show, create and update views
+      attr_accessor :default_hidden_fields
+
+      # Default items per page value used if a model level option has not
+      # been configured
+      attr_accessor :default_items_per_page
+
+      attr_reader :default_search_operator
+
+      # Configuration option to specify which method names will be searched for
+      # to be used as a label for object records. This defaults to [:name, :title]
+      attr_accessor :label_methods
+
+      # hide blank fields in show view if true
+      attr_accessor :compact_show_view
+
+      # Set the max width of columns in list view before a new set is created
+      attr_accessor :total_columns_width
+
+      # Stores model configuration objects in a hash identified by model's class
+      # name.
+      #
+      # @see RailsAdmin::Config.model
+      attr_reader :registry
+
+      # Setup authentication to be run as a before filter
+      # This is run inside the controller instance so you can setup any authentication you need to
+      #
+      # By default, the authentication will run via warden if available
+      # and will run the default.
+      #
+      # If you use devise, this will authenticate the same as _authenticate_user!_
+      #
+      # @example Devise admin
+      #   RailsAdmin.config do |config|
+      #     config.authenticate_with do
+      #       authenticate_admin!
+      #     end
+      #   end
+      #
+      # @example Custom Warden
+      #   RailsAdmin.config do |config|
+      #     config.authenticate_with do
+      #       warden.authenticate! :scope => :paranoid
+      #     end
+      #   end
+      #
+      # @see RailsAdmin::Config::DEFAULT_AUTHENTICATION
+      def authenticate_with(&blk)
+        @authenticate = blk if blk
+        @authenticate || DEFAULT_AUTHENTICATION
+      end
+
+
+      def attr_accessible_role(&blk)
+        @attr_accessible_role = blk if blk
+        @attr_accessible_role || DEFAULT_ATTR_ACCESSIBLE_ROLE
+      end
+      
+      # Setup auditing/history/versioning provider that observe objects lifecycle
+      def audit_with(*args, &block)
+        extension = args.shift
+        if(extension)
+          @audit = Proc.new {
+            @auditing_adapter = RailsAdmin::AUDITING_ADAPTERS[extension].new(*([self] + args).compact)
+          }
+        else
+          @audit = block if block
+        end
+        @audit || DEFAULT_AUDIT
+      end
+      
+      # Setup authorization to be run as a before filter
+      # This is run inside the controller instance so you can setup any authorization you need to.
+      #
+      # By default, there is no authorization.
+      #
+      # @example Custom
+      #   RailsAdmin.config do |config|
+      #     config.authorize_with do
+      #       redirect_to root_path unless warden.user.is_admin?
+      #     end
+      #   end
+      #
+      # To use an authorization adapter, pass the name of the adapter. For example,
+      # to use with CanCan[https://github.com/ryanb/cancan], pass it like this.
+      #
+      # @example CanCan
+      #   RailsAdmin.config do |config|
+      #     config.authorize_with :cancan
+      #   end
+      #
+      # See the wiki[https://github.com/sferik/rails_admin/wiki] for more on authorization.
+      #
+      # @see RailsAdmin::Config::DEFAULT_AUTHORIZE
+      def authorize_with(*args, &block)
+        extension = args.shift
+        if(extension)
+          @authorize = Proc.new {
+            @authorization_adapter = RailsAdmin::AUTHORIZATION_ADAPTERS[extension].new(*([self] + args).compact)
+          }
+        else
+          @authorize = block if block
+        end
+        @authorize || DEFAULT_AUTHORIZE
+      end
+
+      # Setup configuration using an extension-provided ConfigurationAdapter
+      #
+      # @example Custom configuration for role-based setup.
+      #   RailsAdmin.config do |config|
+      #     config.configure_with(:custom) do |config|
+      #       config.models = ['User', 'Comment']
+      #       config.roles  = {
+      #         'Admin' => :all,
+      #         'User'  => ['User']
+      #       }
+      #     end
+      #   end
+      def configure_with(extension)
+        configuration = RailsAdmin::CONFIGURATION_ADAPTERS[extension].new
+        yield(configuration) if block_given?
+      end
+
+      # Setup a different method to determine the current user or admin logged in.
+      # This is run inside the controller instance and made available as a helper.
+      #
+      # By default, _request.env["warden"].user_ or _current_user_ will be used.
+      #
+      # @example Custom
+      #   RailsAdmin.config do |config|
+      #     config.current_user_method do
+      #       current_admin
+      #     end
+      #   end
+      #
+      # @see RailsAdmin::Config::DEFAULT_CURRENT_USER
+      def current_user_method(&block)
+        @current_user = block if block
+        @current_user || DEFAULT_CURRENT_USER
+      end
+
+      def default_search_operator=(operator)
+        if %w{ default like starts_with ends_with is = }.include? operator
+          @default_search_operator = operator
+        else
+          raise ArgumentError, "Search operator '#{operator}' not supported"
+        end
+      end
+
+      # Loads a model configuration instance from the registry or registers
+      # a new one if one is yet to be added.
+      #
+      # First argument can be an instance of requested model, its class object,
+      # its class name as a string or symbol or a RailsAdmin::AbstractModel
+      # instance.
+      #
+      # If a block is given it is evaluated in the context of configuration instance.
+      #
+      # Returns given model's configuration
+      #
+      # @see RailsAdmin::Config.registry
+      def model(entity, &block)
+        key = begin
+          if entity.kind_of?(RailsAdmin::AbstractModel)
+            entity.model.name.to_sym
+          elsif entity.kind_of?(Class)
+            entity.name.to_sym
+          elsif entity.kind_of?(String) || entity.kind_of?(Symbol)
+            entity.to_sym
+          else
+            entity.class.name.to_sym
+          end
+        end
+        config = @registry[key] ||= RailsAdmin::Config::Model.new(entity)
+        config.instance_eval(&block) if block
+        config
+      end
+            
+      def default_hidden_fields=(fields)
+        if fields.is_a?(Array)
+          @default_hidden_fields = {}
+          @default_hidden_fields[:edit] = fields
+          @default_hidden_fields[:show] = fields
+        else
+          @default_hidden_fields = fields
+        end
+      end
+      
+      # Returns action configuration object
+      def actions(&block)
+        RailsAdmin::Config::Actions.instance_eval(&block) if block
+      end
+      
+      # Returns all model configurations
+      #
+      # If a block is given it is evaluated in the context of configuration
+      # instances.
+      #
+      # @see RailsAdmin::Config.registry
+      def models(&block)
+        RailsAdmin::AbstractModel.all.map{|m| model(m, &block)}
+      end
+
+      # Reset all configurations to defaults.
+      #
+      # @see RailsAdmin::Config.registry
+      def reset
+        @compact_show_view = true
+        @authenticate = nil
+        @authorize = nil
+        @audit = nil
+        @current_user = nil
+        @default_hidden_fields = {}
+        @default_hidden_fields[:edit] = [:id, :created_at, :created_on, :deleted_at, :updated_at, :updated_on, :deleted_on]
+        @default_hidden_fields[:show] = [:id, :created_at, :created_on, :deleted_at, :updated_at, :updated_on, :deleted_on]
+        @default_items_per_page = 20
+        @default_search_operator = 'default'
+        @attr_accessible_role = nil
+        @excluded_models = []
+        @included_models = []
+        @total_columns_width = 697
+        @label_methods = [:name, :title]
+        @main_app_name = Proc.new { [Rails.application.engine_name.titleize.chomp(' Application'), 'Admin'] }
+        @registry = {}
+        RailsAdmin::Config::Actions.reset
+      end
+
+      # Reset a provided model's configuration.
+      #
+      # @see RailsAdmin::Config.registry
+      def reset_model(model)
+        key = model.kind_of?(Class) ? model.name.to_sym : model.to_sym
+        @registry.delete(key)
+      end
+
+      # Get all models that are configured as visible sorted by their weight and label.
+      #
+      # @see RailsAdmin::Config::Hideable
+      def visible_models
+        self.models.select {|m| m.visible? }.sort do |a, b|
+          (weight_order = a.weight <=> b.weight) == 0 ? a.label.downcase <=> b.label.downcase : weight_order
+        end
+      end
+    end
+
+    # Set default values for configuration options on load
+    self.reset
+  end
+end

data/lib/rails_admin/config/actions.rb

@@ -0,0 +1,121 @@
+module RailsAdmin
+  module Config
+    module Actions
+      
+      class << self
+        def all(scope = nil, bindings = {})
+          if scope.is_a?(Hash)
+            bindings = scope
+            scope = :all
+          end
+          scope ||= :all
+          init_actions!
+          actions = case scope
+          when :all
+            @@actions
+          when :root
+            @@actions.select(&:root?)
+          when :collection
+            @@actions.select(&:collection?)
+          when :bulkable
+            @@actions.select(&:bulkable?)
+          when :member
+            @@actions.select(&:member?)
+          end
+          
+          bindings[:controller] ? actions.map{ |action| action.with(bindings) }.select(&:visible?) : actions
+        end
+        
+        def find custom_key, bindings = {}
+          init_actions!
+          action = @@actions.find{ |a| a.custom_key == custom_key }
+          bindings[:controller] ? (action && action.with(bindings).try(:visible?) && action || nil) : action
+        end
+        
+        def collection key, parent_class = :base, &block
+          add_action key, parent_class, :collection, &block
+        end
+        
+        def member key, parent_class = :base, &block
+          add_action key, parent_class, :member, &block
+        end
+        
+        def root key, parent_class = :base, &block
+          add_action key, parent_class, :root, &block
+        end
+        
+        def add_action key, parent_class, parent, &block
+          a = "RailsAdmin::Config::Actions::#{parent_class.to_s.camelize}".constantize.new
+          a.instance_eval(%{
+            #{parent} true
+            def key
+              :#{key}
+            end
+          })
+          a.instance_eval(&block) if block
+          unless a.custom_key.in?((@@actions || []).map(&:custom_key))
+            (@@actions ||= []) << a
+          else
+            raise "Action #{a.custom_key} already exist. Please change its custom key"
+          end
+        end
+          
+        def reset
+          @@actions = nil
+        end
+        
+        def register(name, klass = nil)
+          if klass == nil && name.kind_of?(Class)
+            klass = name
+            name = klass.to_s.demodulize.underscore.to_sym
+          end
+        
+          instance_eval %{
+            def #{name}(&block)
+              action = #{klass}.new
+              action.instance_eval &block if block
+              unless action.custom_key.in?((@@actions || []).map(&:custom_key))
+                (@@actions ||= []) << action
+              else
+                raise "Action \#{action.custom_key} already exist. Please change its custom key"
+              end
+            end
+          }
+        end
+        
+        private 
+        
+        def init_actions!
+          @@actions ||= [
+            Dashboard.new,
+            Index.new,
+            Show.new,
+            New.new,
+            Edit.new,
+            Export.new,
+            Delete.new,
+            BulkDelete.new,
+            HistoryShow.new,
+            HistoryIndex.new,
+            ShowInApp.new,
+          ]
+        end
+
+      end
+    end
+  end
+end
+
+require 'rails_admin/config/actions/base'
+require 'rails_admin/config/actions/dashboard'
+require 'rails_admin/config/actions/index'
+require 'rails_admin/config/actions/show'
+require 'rails_admin/config/actions/show_in_app'
+require 'rails_admin/config/actions/history_show'
+require 'rails_admin/config/actions/history_index'
+require 'rails_admin/config/actions/new'
+require 'rails_admin/config/actions/edit'
+require 'rails_admin/config/actions/export'
+require 'rails_admin/config/actions/delete'
+require 'rails_admin/config/actions/bulk_delete'
+

data/lib/rails_admin/config/actions/base.rb

@@ -0,0 +1,105 @@
+require 'rails_admin/config/base'
+require 'rails_admin/config/hideable'
+
+module RailsAdmin
+  module Config
+    module Actions
+      class Base < RailsAdmin::Config::Base
+        include RailsAdmin::Config::Hideable
+        
+        # Should the action be visible
+        register_instance_option :visible? do
+          true
+        end
+        
+        # Is the action acting on the root level (Example: /admin/contact)
+        register_instance_option :root? do
+          false
+        end
+        
+        # Is the action on a model scope (Example: /admin/teams/export)
+        register_instance_option :collection? do
+          false
+        end
+        
+        # Is the action on an object scope (Example: /admin/teams/1/edit)
+        register_instance_option :member? do
+          false
+        end
+        
+        # This block is evaluated in the context of the controller when action is called
+        # You can access:
+        # - @abstract_model & @model_config if your on a model or object scope
+        # - @object if you're on an object scope
+        register_instance_option :controller do
+          Proc.new do
+            render :action => @action.template_name
+          end
+        end
+        
+        # Model scoped actions only. You will need to handle params[:bulk_ids] in controller
+        register_instance_option :bulkable? do
+          false
+        end
+        
+        # View partial name (called in default :controller block)
+        register_instance_option :template_name do
+          key.to_sym
+        end
+        
+        # For Cancan and the like
+        register_instance_option :authorization_key do
+          key.to_sym
+        end
+        
+        # List of methods allowed. Note that you are responsible for correctly handling them in :controller block
+        register_instance_option :http_methods do
+          [:get]
+        end
+        
+        # Url fragment
+        register_instance_option :route_fragment do
+          custom_key.to_s
+        end
+        
+        # Controller action name
+        register_instance_option :action_name do
+          custom_key.to_sym
+        end
+        
+        # I18n key
+        register_instance_option :i18n_key do
+          key
+        end
+        
+        # User should override only custom_key (action name and route fragment change, allows for duplicate actions)
+        register_instance_option :custom_key do
+          key
+        end
+        
+        # Breadcrumb parent
+        register_instance_option :breadcrumb_parent do
+          case 
+          when root?
+            :dashboard
+          when collection?
+            :index
+          when member?
+            :show
+          end
+        end
+        
+        
+        # Off API.
+        
+        def key
+          self.class.key
+        end
+        
+        def self.key
+          self.name.to_s.demodulize.underscore.to_sym
+        end
+      end
+    end
+  end
+end