yousty-activeadmin 1.0.0.pre

data/lib/active_admin/resource/action_items.rb

@@ -0,0 +1,91 @@
+require 'active_admin/helpers/optional_display'
+
+module ActiveAdmin
+
+  class Resource
+    module ActionItems
+
+      # Adds the default action items to a resource when it's initialized
+      def initialize(*args)
+        super
+        add_default_action_items
+      end
+
+      # @return [Array] The set of action items for this resource
+      def action_items
+        @action_items ||= []
+      end
+
+      # Add a new action item to a resource
+      #
+      # @param [Hash] options valid keys include:
+      #                 :only:  A single or array of controller actions to display
+      #                         this action item on.
+      #                 :except: A single or array of controller actions not to
+      #                          display this action item on.
+      def add_action_item(options = {}, &block)
+        self.action_items << ActiveAdmin::ActionItem.new(options, &block)
+      end
+
+      # Returns a set of action items to display for a specific controller action
+      #
+      # @param [String, Symbol] action the action to retrieve action items for
+      #
+      # @return [Array] Array of ActionItems for the controller actions
+      def action_items_for(action, render_context = nil)
+        action_items.select{ |item| item.display_on? action, render_context }
+      end
+
+      # Clears all the existing action items for this resource
+      def clear_action_items!
+        @action_items = []
+      end
+
+      # Used by active_admin Base view
+      def action_items?
+        !!@action_items && @action_items.any?
+      end
+
+      private
+
+      # Adds the default action items to each resource
+      def add_default_action_items
+        # New link on index
+        add_action_item only: :index do
+          if controller.action_methods.include?('new') && authorized?(ActiveAdmin::Auth::CREATE, active_admin_config.resource_class)
+            link_to I18n.t('active_admin.new_model', model: active_admin_config.resource_label), new_resource_path
+          end
+        end
+
+        # Edit link on show
+        add_action_item only: :show do
+          if controller.action_methods.include?('edit') && authorized?(ActiveAdmin::Auth::UPDATE, resource)
+            link_to I18n.t('active_admin.edit_model', model: active_admin_config.resource_label), edit_resource_path(resource)
+          end
+        end
+
+        # Destroy link on show
+        add_action_item only: :show do
+          if controller.action_methods.include?('destroy') && authorized?(ActiveAdmin::Auth::DESTROY, resource)
+            link_to I18n.t('active_admin.delete_model', model: active_admin_config.resource_label), resource_path(resource),
+              method: :delete, data: {confirm: I18n.t('active_admin.delete_confirmation')}
+          end
+        end
+      end
+
+    end
+  end
+
+  # Model class to store the data for ActionItems
+  class ActionItem
+    include ActiveAdmin::OptionalDisplay
+
+    attr_accessor :block
+
+    def initialize(options = {}, &block)
+      @options, @block = options, block
+      normalize_display_options!
+    end
+  end
+
+end

data/lib/active_admin/resource/belongs_to.rb

@@ -0,0 +1,36 @@
+require 'active_admin/resource'
+
+module ActiveAdmin
+  class Resource
+    class BelongsTo
+
+      class TargetNotFound < StandardError; end
+
+      # The resource which initiated this relationship
+      attr_reader :owner
+
+      def initialize(owner, target_name, options = {})
+        @owner, @target_name, @options = owner, target_name, options
+      end
+
+      # Returns the target resource class or raises an exception if it doesn't exist
+      def target
+        key = @target_name.to_s.camelize
+        namespace.resources[key] or raise TargetNotFound, "Could not find #{key} in" +
+          " #{namespace.name} with #{namespace.resources.map(&:resource_name)}"
+      end
+
+      def namespace
+        @owner.namespace
+      end
+
+      def optional?
+        @options[:optional]
+      end
+
+      def required?
+        !optional?
+      end
+    end
+  end
+end

data/lib/active_admin/resource/controllers.rb

@@ -0,0 +1,18 @@
+module ActiveAdmin
+  class Resource
+    module Controllers
+
+      # Returns a properly formatted controller name for this
+      # config within its namespace
+      def controller_name
+        [namespace.module_name, resource_name.plural.camelize + "Controller"].compact.join('::')
+      end
+
+      # Returns the controller for this config
+      def controller
+        @controller ||= controller_name.constantize
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/menu.rb

@@ -0,0 +1,64 @@
+module ActiveAdmin
+  class Resource
+
+    module Menu
+
+      # Set the menu options.
+      # To disable this menu item, call `menu(false)` from the DSL
+      def menu_item_options=(options)
+        if options == false
+          @include_in_menu   = false
+          @menu_item_options = {}
+        else
+          @navigation_menu_name = options[:menu_name]
+          @menu_item_options    = default_menu_options.merge options
+        end
+      end
+
+      def menu_item_options
+        @menu_item_options ||= default_menu_options
+      end
+
+      def default_menu_options
+        # These local variables are accessible to the procs.
+        menu_resource_class = respond_to?(:resource_class) ? resource_class : self
+        resource = self
+        {
+          :id    => resource_name.plural,
+          :label => proc{ resource.plural_resource_label },
+          :url   => proc{ resource.route_collection_path(params) },
+          :if    => proc{ authorized?(:read, menu_resource_class) }
+        }
+      end
+
+      attr_writer :navigation_menu_name
+
+      def navigation_menu_name
+        case @navigation_menu_name ||= DEFAULT_MENU
+        when Proc
+          controller.instance_eval(&@navigation_menu_name).to_sym
+        else
+          @navigation_menu_name
+        end
+      end
+
+      def navigation_menu
+        namespace.fetch_menu(navigation_menu_name)
+      end
+
+      def add_to_menu(menu_collection)
+        if include_in_menu?
+          @menu_item = menu_collection.add navigation_menu_name, menu_item_options
+        end
+      end
+
+      attr_reader :menu_item
+
+      # Should this resource be added to the menu system?
+      def include_in_menu?
+        @include_in_menu != false
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/naming.rb

@@ -0,0 +1,84 @@
+module ActiveAdmin
+  class Resource
+
+    module Naming
+
+      # Returns a name used to uniquely identify this resource
+      # this should be an instance of ActiveAdmin:Resource::Name, which responds to
+      # #singular, #plural, #route_key, #human etc.
+      def resource_name
+        custom_name = @options[:as] && @options[:as].gsub(/\s/,'')
+        @resource_name ||= if custom_name || !resource_class.respond_to?(:model_name)
+            Resource::Name.new(resource_class, custom_name)
+          else
+            Resource::Name.new(resource_class)
+          end
+      end
+
+      # Returns the name to call this resource such as "Bank Account"
+      def resource_label
+        resource_name.translate :count => 1, :default => resource_name.to_s.gsub('::', ' ').titleize
+      end
+
+      # Returns the plural version of this resource such as "Bank Accounts"
+      def plural_resource_label(options = {})
+        resource_name.translate ({:count => 1.1, :default => resource_label.pluralize.titleize}).merge(options)
+      end
+    end
+
+    # A subclass of ActiveModel::Name which supports the different APIs presented
+    # in Rails < 3.1 and > 3.1.
+    class Name < ActiveModel::Name
+
+      delegate :hash, :to => :to_str
+
+      def initialize(klass, name = nil)
+        if ActiveModel::Name.instance_method(:initialize).arity == 1
+          super(proxy_for_initializer(klass, name))
+        else
+          super(klass, nil, name)
+        end
+      end
+
+      def translate(options = {})
+        I18n.t i18n_key, {:scope => [:activerecord, :models]}.merge(options)
+      end
+
+      def proxy_for_initializer(klass, name)
+        return klass unless name
+        return StringClassProxy.new(klass, name) if klass
+
+        StringProxy.new(name)
+      end
+
+      def route_key
+        plural
+      end
+
+      def eql?(other)
+        to_str.eql?(other.to_str)
+      end
+
+      class StringProxy
+        def initialize(name)
+          @name = name
+        end
+
+        def name
+          @name
+        end
+      end
+
+      class StringClassProxy < StringProxy
+        delegate :lookup_ancestors, :i18n_scope, :to => :"@klass"
+
+        def initialize(klass, name)
+          @klass = klass || name
+          super(name)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/active_admin/resource/page_presenters.rb

@@ -0,0 +1,82 @@
+module ActiveAdmin
+  class Resource
+    module PagePresenters
+
+      # for setting default css class in admin ui
+      def default_index_class
+        @default_index
+      end
+
+      # A hash of page configurations for the controller indexed by action name
+      def page_presenters
+        @page_presenters ||= {}
+      end
+
+      # Sets a page config for a given action
+      #
+      # @param [String, Symbol] action The action to store this configuration for
+      # @param [PagePresenter] page_presenter The instance of PagePresenter to store
+      def set_page_presenter(action, page_presenter)
+
+        if action.to_s == "index" && page_presenter[:as]
+          index_class = find_index_class(page_presenter[:as])
+          page_presenter_key = index_class.index_name.to_sym
+          set_index_presenter page_presenter_key, page_presenter
+        else
+          page_presenters[action.to_sym] = page_presenter
+        end
+
+      end
+
+      # Returns a stored page config
+      #
+      # @param [Symbol, String] action The action to get the config for
+      # @param [String] type The string specified in the presenters index_name method
+      # @returns [PagePresenter, nil]
+      def get_page_presenter(action, type=nil)
+
+        if action.to_s == "index" && type && page_presenters[:index].kind_of?(Hash)
+          page_presenters[:index][type.to_sym]
+        elsif action.to_s == "index" && page_presenters[:index].kind_of?(Hash)
+          page_presenters[:index].default
+        else
+          page_presenters[action.to_sym]
+        end
+
+      end
+
+      protected
+
+      # Stores a config for all index actions supplied
+      #
+      # @param [Symbol] index_as The index type to store in the configuration
+      # @param [PagePresenter] page_presenter The intance of PagePresenter to store
+      def set_index_presenter(index_as, page_presenter)
+        page_presenters[:index] ||= {}
+
+        #set first index as default value or the index with default param set to to true
+        if page_presenters[:index].empty? || page_presenter[:default] == true
+          page_presenters[:index].default = page_presenter
+          @default_index = find_index_class(page_presenter[:as])
+        end
+
+        page_presenters[:index][index_as] = page_presenter
+      end
+
+      # Returns the actual class for renderering the main content on the index
+      # page. To set this, use the :as option in the page_presenter block.
+      #
+      # @param [Symbol, Class] symbol_or_class The component symbol or class
+      # @return [Class]
+      def find_index_class(symbol_or_class)
+        case symbol_or_class
+        when Symbol
+          ::ActiveAdmin::Views.const_get("IndexAs" + symbol_or_class.to_s.camelcase)
+        when Class
+          symbol_or_class
+        end
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/pagination.rb

@@ -0,0 +1,19 @@
+module ActiveAdmin
+
+  class Resource
+    module Pagination
+
+      # The default number of records to display per page
+      attr_accessor :per_page
+
+      # Enable / disable pagination (defaults to true)
+      attr_accessor :paginate
+
+      def initialize(*args)
+        super
+        @paginate = true
+        @per_page = namespace.default_per_page
+      end
+    end
+  end
+end

data/lib/active_admin/resource/routes.rb

@@ -0,0 +1,99 @@
+module ActiveAdmin
+  class Resource
+    module Routes
+      # @params params [Hash] of params: {study_id: 3}
+      # @return [String] the path to this resource collection page
+      # @example "/admin/posts"
+      def route_collection_path(params = {})
+        RouteBuilder.new(self).collection_path(params)
+      end
+      
+      # @param resource [ActiveRecord::Base] the instance we want the path of
+      # @return [String] the path to this resource collection page
+      # @example "/admin/posts/1"
+      def route_instance_path(resource)
+        RouteBuilder.new(self).instance_path(resource)
+      end
+
+      # Returns the routes prefix for this config
+      def route_prefix
+        namespace.module_name.try(:underscore)
+      end
+
+      def route_uncountable?
+        config = controller.resources_configuration[:self]
+
+        config[:route_collection_name] == config[:route_instance_name]
+      end
+
+      private
+
+      class RouteBuilder
+        def initialize(resource)
+          @resource = resource
+        end
+
+        def collection_path(params)
+          route_name = route_name(
+            resource.controller.resources_configuration[:self][:route_collection_name],
+            (resource.route_uncountable? ? 'index_path' : 'path')
+          )
+
+          routes.send(route_name, *route_collection_params(params))
+        end
+
+        # @return [String] the path to this resource collection page
+        # @param instance [ActiveRecord::Base] the instance we want the path of
+        # @example "/admin/posts/1"
+        def instance_path(instance)
+          route_name = route_name(resource.controller.resources_configuration[:self][:route_instance_name])
+
+          routes.send(route_name, *route_instance_params(instance))
+        end
+
+        private
+
+        attr_reader :resource
+
+        def route_name(resource_path_name, suffix = 'path')
+          route = []
+
+          route << resource.route_prefix      # "admin"
+          route << belongs_to_name if nested? # "category"
+          route << resource_path_name         # "posts" or "post"
+          route << suffix                     # "path" or "index path"
+
+          route.compact.join('_').to_sym      # :admin_category_posts_path
+        end
+
+
+        # @return params to pass to instance path
+        def route_instance_params(instance)
+          if nested?
+            [instance.send(belongs_to_name).to_param, instance.to_param]
+          else
+            instance.to_param
+          end
+        end
+
+        def route_collection_params(params)
+          if nested?
+            params[:"#{belongs_to_name}_id"]
+          end
+        end
+
+        def nested?
+          resource.belongs_to? && resource.belongs_to_config.required?
+        end
+
+        def belongs_to_name
+          resource.belongs_to_config.target.resource_name.singular if nested?
+        end
+
+        def routes
+          Rails.application.routes.url_helpers
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/resource/scope_to.rb

@@ -0,0 +1,74 @@
+module ActiveAdmin
+  class Resource
+    module ScopeTo
+
+      # Scope this controller to some object which has a relation
+      # to the resource. Can either accept a block or a symbol
+      # of a method to call.
+      #
+      # Eg:
+      #
+      #   ActiveAdmin.register Post do
+      #     scope_to :current_user
+      #   end
+      #
+      # Then every time we instantiate and object, it would call
+      #
+      #   current_user.posts.build
+      #
+      # By default Active Admin will use the resource name to build a
+      # method to call as the association. If its different, you can
+      # pass in the association_method as an option.
+      #
+      #   scope_to :current_user, :association_method => :blog_posts
+      #
+      # will result in the following
+      #
+      #   current_user.blog_posts.build
+      #
+      # To conditionally use this scope, you can use conditional procs
+      #
+      #   scope_to :current_user, :if => proc{ admin_user_signed_in? }
+      #
+      # or
+      #
+      #   scope_to :current_user, :unless => proc{ current_user.admin? }
+      #
+      def scope_to(*args, &block)
+        options = args.extract_options!
+        method = args.first
+
+        scope_to_config[:method]              = block || method
+        scope_to_config[:association_method]  = options[:association_method]
+        scope_to_config[:if]                  = options[:if]
+        scope_to_config[:unless]              = options[:unless]
+
+      end
+
+      def scope_to_association_method
+        scope_to_config[:association_method]
+      end
+
+      def scope_to_method
+        scope_to_config[:method]
+      end
+
+      def scope_to_config
+        @scope_to_config ||= {
+          :method               => nil,
+          :association_method   => nil,
+          :if                   => nil,
+          :unless               => nil
+        }
+      end
+
+      def scope_to?(context = nil)
+        return false if scope_to_method.nil?
+        return render_in_context(context, scope_to_config[:if]) unless scope_to_config[:if].nil?
+        return !render_in_context(context, scope_to_config[:unless]) unless scope_to_config[:unless].nil?
+        true
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/scopes.rb

@@ -0,0 +1,50 @@
+module ActiveAdmin
+  class Resource
+    module Scopes
+
+      # Return an array of scopes for this resource
+      def scopes
+        @scopes ||= []
+      end
+
+      # Returns a scope for this object by its identifier
+      def get_scope_by_id(id)
+        id = id.to_s
+        scopes.find{|s| s.id == id }
+      end
+
+      def default_scope(context = nil)
+        scopes.detect do |scope|
+          if scope.default_block.is_a?(Proc)
+            render_in_context(context, scope.default_block)
+          else
+            scope.default_block
+          end
+        end
+      end
+
+      # Create a new scope object for this resource.
+      # If you want to internationalize the scope name, you can add
+      # to your i18n files a key like "active_admin.scopes.scope_method".
+      def scope(*args, &block)
+        options = args.extract_options!
+        title = args[0] rescue nil
+        method = args[1] rescue nil
+
+        scope = ActiveAdmin::Scope.new(title, method, options, &block)
+
+        # Finds and replaces a scope by the same name if it already exists
+        existing_scope_index = scopes.index{|existing_scope| existing_scope.id == scope.id }
+        if existing_scope_index
+          scopes.delete_at(existing_scope_index)
+          scopes.insert(existing_scope_index, scope)
+        else
+          self.scopes << scope
+        end
+
+        scope
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/sidebars.rb

@@ -0,0 +1,27 @@
+require 'active_admin/helpers/optional_display'
+
+module ActiveAdmin
+
+  class Resource
+    module Sidebars
+
+      def sidebar_sections
+        @sidebar_sections ||= []
+      end
+
+      def clear_sidebar_sections!
+        @sidebar_sections = []
+      end
+
+      def sidebar_sections_for(action, render_context = nil)
+        sidebar_sections.select{|section| section.display_on?(action, render_context) }
+      end
+
+      def sidebar_sections?
+        !!@sidebar_sections && @sidebar_sections.any?
+      end
+
+    end
+  end
+
+end