activeadministration 0.0.1

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: ::ActiveAdmin::Helpers::I18n::PLURAL_MANY_COUNT, 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,28 @@
+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) }
+          .sort_by(&:priority)
+      end
+
+      def sidebar_sections?
+        !!@sidebar_sections && @sidebar_sections.any?
+      end
+
+    end
+  end
+
+end

data/lib/active_admin/resource_collection.rb

@@ -0,0 +1,70 @@
+module ActiveAdmin
+  # This is a container for resources, which acts much like a Hash.
+  # It's assumed that an added resource responds to `resource_name`.
+  class ResourceCollection
+    include Enumerable
+    extend Forwardable
+    def_delegators :@collection, :empty?, :has_key?, :keys, :values, :size
+
+    def initialize
+      @collection = {}
+    end
+
+    def add(resource)
+      if match = @collection[resource.resource_name]
+        raise_if_mismatched! match, resource
+        match
+      else
+        @collection[resource.resource_name] = resource
+      end
+    end
+
+    # Changes `each` to pass in the value, instead of both the key and value.
+    def each(&block)
+      values.each &block
+    end
+
+    def [](obj)
+      @collection[obj] || find_resource(obj)
+    end
+
+    private
+
+    # Finds a resource based on the resource name, resource class, or base class.
+    def find_resource(obj)
+      resources.detect do |r|
+        r.resource_name.to_s == obj.to_s || r.resource_class.to_s == obj.to_s
+      end ||
+      if obj.respond_to? :base_class
+        resources.detect{ |r| r.resource_class.to_s == obj.base_class.to_s }
+      end
+    end
+
+    def resources
+      select{ |r| r.class <= Resource } # can otherwise be a Page
+    end
+
+    def raise_if_mismatched!(existing, given)
+      if existing.class != given.class
+        raise IncorrectClass.new existing, given
+      elsif given.class <= Resource && existing.resource_class != given.resource_class
+        raise ConfigMismatch.new existing, given
+      end
+    end
+
+    class IncorrectClass < StandardError
+      def initialize(existing, given)
+        super "You're trying to register #{given.resource_name} which is a #{given.class}, " +
+              "but #{existing.resource_name}, a #{existing.class} has already claimed that name."
+      end
+    end
+
+    class ConfigMismatch < StandardError
+      def initialize(existing, given)
+        super "You're trying to register #{given.resource_class} as #{given.resource_name}, " +
+              "but the existing #{existing.class} config was built for #{existing.resource_class}!"
+      end
+    end
+
+  end
+end