aa-rails4 0.6.0

data/lib/active_admin/page_presenter.rb

@@ -0,0 +1,32 @@
+module ActiveAdmin
+
+  # A simple object that gets used to present different aspects of views
+  #
+  # Initialize with a set of options and a block. The options become
+  # available using hash style syntax.
+  #
+  # Usage:
+  #
+  #     presenter = PagePresenter.new :as => :table do
+  #       # some awesome stuff
+  #     end
+  #
+  #     presenter[:as]    #=> :table
+  #     presenter.block   #=> The block passed in to new
+  #
+  class PagePresenter
+
+    attr_reader :block, :options
+
+    delegate :has_key?, :to => :options
+
+    def initialize(options = {}, &block)
+      @options, @block = options, block
+    end
+
+    def [](key)
+      @options[key]
+    end
+
+  end
+end

data/lib/active_admin/resource.rb

@@ -0,0 +1,160 @@
+require 'active_admin/resource/action_items'
+require 'active_admin/resource/controllers'
+require 'active_admin/resource/menu'
+require 'active_admin/resource/page_presenters'
+require 'active_admin/resource/pagination'
+require 'active_admin/resource/routes'
+require 'active_admin/resource/naming'
+require 'active_admin/resource/scopes'
+require 'active_admin/resource/scope_to'
+require 'active_admin/resource/sidebars'
+require 'active_admin/resource/belongs_to'
+
+module ActiveAdmin
+
+  # Resource is the primary data storage for resource configuration in Active Admin
+  #
+  # When you register a resource (ActiveAdmin.register Post) you are actually creating
+  # a new Resource instance within the given Namespace.
+  #
+  # The instance of the current resource is available in ResourceController and views
+  # by calling the #active_admin_config method.
+  #
+  class Resource
+
+    # Event dispatched when a new resource is registered
+    RegisterEvent = 'active_admin.resource.register'.freeze
+
+    # The namespace this config belongs to
+    attr_reader :namespace
+
+    # The name of the resource class
+    attr_reader :resource_class_name
+
+    # An array of member actions defined for this resource
+    attr_reader :member_actions
+
+    # An array of collection actions defined for this resource
+    attr_reader :collection_actions
+
+    # The default sort order to use in the controller
+    attr_writer :sort_order
+    def sort_order
+      @sort_order ||= (resource_class.respond_to?(:primary_key) ? resource_class.primary_key.to_s : 'id') + '_desc'
+    end
+
+    # Set the configuration for the CSV
+    attr_writer :csv_builder
+
+    # Set breadcrumb builder
+    attr_accessor :breadcrumb
+
+    # Store a reference to the DSL so that we can dereference it during garbage collection.
+    attr_accessor :dsl
+
+    # The string identifying a class to decorate our resource with for the view.
+    # nil to not decorate.
+    attr_accessor :decorator_class_name
+
+    module Base
+      def initialize(namespace, resource_class, options = {})
+        @namespace = namespace
+        @resource_class_name = "::#{resource_class.name}"
+        @options    = options
+        @sort_order = options[:sort_order]
+        @member_actions, @collection_actions = [], []
+      end
+    end
+
+    include MethodOrProcHelper
+
+    include Base
+    include ActionItems
+    include Authorization
+    include Controllers
+    include Menu
+    include Naming
+    include PagePresenters
+    include Pagination
+    include Scopes
+    include ScopeTo
+    include Sidebars
+    include Menu
+    include Routes
+
+    # The class this resource wraps. If you register the Post model, Resource#resource_class
+    # will point to the Post class
+    def resource_class
+      ActiveSupport::Dependencies.constantize(resource_class_name)
+    end
+
+    def decorator_class
+      ActiveSupport::Dependencies.constantize(decorator_class_name) if decorator_class_name
+    end
+
+    def resource_table_name
+      resource_class.quoted_table_name
+    end
+
+    def resource_column_names
+      resource_class.column_names
+    end
+
+    def resource_quoted_column_name(column)
+      resource_class.connection.quote_column_name(column)
+    end
+
+    # Clears all the member actions this resource knows about
+    def clear_member_actions!
+      @member_actions = []
+    end
+
+    def clear_collection_actions!
+      @collection_actions = []
+    end
+
+    # Return only defined resource actions
+    def defined_actions
+      controller.instance_methods.map(&:to_sym) & ResourceController::ACTIVE_ADMIN_ACTIONS
+    end
+
+    def belongs_to(target, options = {})
+      @belongs_to = Resource::BelongsTo.new(self, target, options)
+      self.navigation_menu_name = target unless @belongs_to.optional?
+      controller.send :belongs_to, target, options.dup
+    end
+
+    def belongs_to_config
+      @belongs_to
+    end
+
+    # Do we belong to another resource?
+    def belongs_to?
+      !!belongs_to_config
+    end
+
+    # The csv builder for this resource
+    def csv_builder
+      @csv_builder || default_csv_builder
+    end
+
+    def find_resource(id)
+      resource = resource_class.where(resource_class.primary_key => id).first
+      decorator_class ? decorator_class.new(resource) : resource
+    end
+
+    # @deprecated
+    def resource
+      resource_class
+    end
+    ActiveAdmin::Deprecation.deprecate self, :resource,
+      "ActiveAdmin::Resource#resource is deprecated. Please use #resource_class instead."
+
+    private
+
+    def default_csv_builder
+      @default_csv_builder ||= CSVBuilder.default_for_resource(resource_class)
+    end
+
+  end # class Resource
+end # module ActiveAdmin

data/lib/active_admin/resource/action_items.rb

@@ -0,0 +1,93 @@
+require 'active_admin/helpers/optional_display'
+
+module ActiveAdmin
+
+  class Resource
+    module ActionItems
+
+      # Add 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 all actions except :new and :show
+        add_action_item :except => [:new, :show] 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,78 @@
+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
+
+      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
+
+      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