activeadmin-rb 1.4.0

data/lib/active_admin/settings_node.rb

@@ -0,0 +1,19 @@
+module ActiveAdmin
+
+  class SettingsNode
+    class << self
+      # Never instantiated.  Variables are stored in the singleton_class.
+      private_class_method :new
+
+      # @returns anonymous class with same accessors as the superclass.
+      def build(superclass = self)
+        Class.new(superclass)
+      end
+
+      def register(name, value)
+        class_attribute name
+        send "#{name}=", value
+      end
+    end
+  end
+end

data/lib/active_admin/sidebar_section.rb

@@ -0,0 +1,37 @@
+module ActiveAdmin
+
+  class SidebarSection
+    include ActiveAdmin::OptionalDisplay
+
+    attr_accessor :name, :options, :block
+
+    def initialize(name, options = {}, &block)
+      @name, @options, @block = name.to_s, options, block
+      normalize_display_options!
+    end
+
+    # The id gets used for the div in the view
+    def id
+      "#{name.downcase.underscore}_sidebar_section".parameterize
+    end
+
+    # The title gets displayed within the section in the view
+    def title
+      I18n.t("active_admin.sidebars.#{name}", default: name.titlecase)
+    end
+
+    # If a block is not passed in, the name of the partial to render
+    def partial_name
+      options[:partial] || "#{name.downcase.tr(' ', '_')}_sidebar"
+    end
+
+    def custom_class
+      options[:class]
+    end
+
+    def priority
+      options[:priority] || 10
+    end
+  end
+
+end

data/lib/active_admin/version.rb

@@ -0,0 +1,3 @@
+module ActiveAdmin
+  VERSION = '1.4.0'
+end

data/lib/active_admin/view_factory.rb

@@ -0,0 +1,27 @@
+require 'active_admin/abstract_view_factory'
+
+module ActiveAdmin
+  class ViewFactory < AbstractViewFactory
+
+    # Register Helper Renderers
+    register  global_navigation:   ActiveAdmin::Views::TabbedNavigation,
+              utility_navigation:  ActiveAdmin::Views::TabbedNavigation,
+              site_title:          ActiveAdmin::Views::SiteTitle,
+              unsupported_browser: ActiveAdmin::Views::UnsupportedBrowser,
+              action_items:        ActiveAdmin::Views::ActionItems,
+              title_bar:           ActiveAdmin::Views::TitleBar,
+              header:              ActiveAdmin::Views::Header,
+              footer:              ActiveAdmin::Views::Footer,
+              index_scopes:        ActiveAdmin::Views::Scopes,
+              blank_slate:         ActiveAdmin::Views::BlankSlate
+
+    # Register All The Pages
+    register  index_page: ActiveAdmin::Views::Pages::Index,
+              show_page:  ActiveAdmin::Views::Pages::Show,
+              new_page:   ActiveAdmin::Views::Pages::Form,
+              edit_page:  ActiveAdmin::Views::Pages::Form,
+              layout:     ActiveAdmin::Views::Pages::Layout,
+              page:       ActiveAdmin::Views::Pages::Page
+
+  end
+end

data/lib/active_admin/view_helpers.rb

@@ -0,0 +1,20 @@
+module ActiveAdmin
+  module ViewHelpers
+
+    # Require all ruby files in the view helpers dir
+    Dir[File.expand_path('../view_helpers', __FILE__) + "/*.rb"].each{|f| require f }
+
+    include ActiveAdminApplicationHelper
+    include AutoLinkHelper
+    include BreadcrumbHelper
+    include DisplayHelper
+    include MethodOrProcHelper
+    include SidebarHelper
+    include FormHelper
+    include TitleHelper
+    include ViewFactoryHelper
+    include FlashHelper
+    include ScopeNameHelper
+
+  end
+end

data/lib/active_admin/view_helpers/active_admin_application_helper.rb

@@ -0,0 +1,12 @@
+module ActiveAdmin
+  module ViewHelpers
+    module ActiveAdminApplicationHelper
+
+      # Returns the current Active Admin application instance
+      def active_admin_application
+        ActiveAdmin.application
+      end
+
+    end
+  end
+end

data/lib/active_admin/view_helpers/auto_link_helper.rb

@@ -0,0 +1,45 @@
+module ActiveAdmin
+  module ViewHelpers
+    module AutoLinkHelper
+
+      # Automatically links objects to their resource controllers. If
+      # the resource has not been registered, a string representation of
+      # the object is returned.
+      #
+      # The default content in the link is returned from ActiveAdmin::ViewHelpers::DisplayHelper#display_name
+      #
+      # You can pass in the content to display
+      #   eg: auto_link(@post, "My Link")
+      #
+      def auto_link(resource, content = display_name(resource))
+        if url = auto_url_for(resource)
+          link_to content, url
+        else
+          content
+        end
+      end
+
+      # Like `auto_link`, except that it only returns a URL instead of a full <a> tag
+      def auto_url_for(resource)
+        config = active_admin_resource_for(resource.class)
+        return unless config
+
+        if config.controller.action_methods.include?("show") &&
+          authorized?(ActiveAdmin::Auth::READ, resource)
+          url_for config.route_instance_path resource, url_options
+        elsif config.controller.action_methods.include?("edit") &&
+          authorized?(ActiveAdmin::Auth::UPDATE, resource)
+          url_for config.route_edit_instance_path resource, url_options
+        end
+      end
+
+      # Returns the ActiveAdmin::Resource instance for a class
+      def active_admin_resource_for(klass)
+        if respond_to? :active_admin_namespace
+          active_admin_namespace.resource_for klass
+        end
+      end
+
+    end
+  end
+end

data/lib/active_admin/view_helpers/breadcrumb_helper.rb

@@ -0,0 +1,33 @@
+module ActiveAdmin
+  module ViewHelpers
+    module BreadcrumbHelper
+
+      # Returns an array of links to use in a breadcrumb
+      def breadcrumb_links(path = request.path)
+        # remove leading "/" and split up the URL
+        # and remove last since it's used as the page title
+        parts = path.split('/').select(&:present?)[0..-2]
+
+        parts.each_with_index.map do |part, index|
+          # 1. try using `display_name` if we can locate a DB object
+          # 2. try using the model name translation
+          # 3. default to calling `titlecase` on the URL fragment
+          if part =~ /\A(\d+|[a-f0-9]{24}|(?:[a-f0-9]{8}-(?:[a-f0-9]{4}-){3}[a-f0-9]{12}))\z/ && parts[index-1]
+            parent = active_admin_config.belongs_to_config.try :target
+            config = parent && parent.resource_name.route_key == parts[index-1] ? parent : active_admin_config
+            name   = display_name config.find_resource part
+          end
+          name ||= I18n.t "activerecord.models.#{part.singularize}", count: ::ActiveAdmin::Helpers::I18n::PLURAL_MANY_COUNT, default: part.titlecase
+
+          # Don't create a link if the resource's show action is disabled
+          if !config || config.defined_actions.include?(:show)
+            link_to name, '/' + parts[0..index].join('/')
+          else
+            name
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/active_admin/view_helpers/display_helper.rb

@@ -0,0 +1,95 @@
+module ActiveAdmin
+  module ViewHelpers
+    module DisplayHelper
+
+      DISPLAY_NAME_FALLBACK = ->{
+        name, klass = "", self.class
+        name << klass.model_name.human         if klass.respond_to? :model_name
+        name << " ##{send(klass.primary_key)}" if klass.respond_to? :primary_key
+        name.present? ? name : to_s
+      }
+      def DISPLAY_NAME_FALLBACK.inspect
+        'DISPLAY_NAME_FALLBACK'
+      end
+
+      # Attempts to call any known display name methods on the resource.
+      # See the setting in `application.rb` for the list of methods and their priority.
+      def display_name(resource)
+        sanitize(render_in_context(resource, display_name_method_for(resource)).to_s) unless resource.nil?
+      end
+
+      # Looks up and caches the first available display name method.
+      # To prevent conflicts, we exclude any methods that happen to be associations.
+      # If no methods are available and we're about to use the Kernel's `to_s`, provide our own.
+      def display_name_method_for(resource)
+        @@display_name_methods_cache ||= {}
+        @@display_name_methods_cache[resource.class] ||= begin
+          methods = active_admin_application.display_name_methods - association_methods_for(resource)
+          method  = methods.detect{ |method| resource.respond_to? method }
+
+          if method != :to_s || resource.method(method).source_location
+            method
+          else
+            DISPLAY_NAME_FALLBACK
+          end
+        end
+      end
+
+      def association_methods_for(resource)
+        return [] unless resource.class.respond_to? :reflect_on_all_associations
+        resource.class.reflect_on_all_associations.map(&:name)
+      end
+
+      def format_attribute(resource, attr)
+        value = find_value resource, attr
+
+        if value.is_a?(Arbre::Element)
+          value
+        elsif boolean_attr?(resource, attr, value)
+          Arbre::Context.new { status_tag value }
+        else
+          pretty_format value
+        end
+      end
+
+      def find_value(resource, attr)
+        if attr.is_a? Proc
+          attr.call resource
+        elsif resource.respond_to? attr
+          resource.public_send attr
+        elsif resource.respond_to? :[]
+          resource[attr]
+        end
+      end
+
+      # Attempts to create a human-readable string for any object
+      def pretty_format(object)
+        case object
+        when String, Numeric, Symbol, Arbre::Element
+          object.to_s
+        when Date, Time
+          I18n.localize object, format: active_admin_application.localize_format
+        else
+          if defined?(::ActiveRecord) && object.is_a?(ActiveRecord::Base) ||
+             defined?(::Mongoid)      && object.class.include?(Mongoid::Document)
+            auto_link object
+          else
+            display_name object
+          end
+        end
+      end
+
+      def boolean_attr?(resource, attr, value)
+        case value
+        when TrueClass, FalseClass
+          true
+        else
+          if resource.class.respond_to? :columns_hash
+            column = resource.class.columns_hash[attr.to_s] and column.type == :boolean
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/active_admin/view_helpers/download_format_links_helper.rb

@@ -0,0 +1,58 @@
+module ActiveAdmin
+  module ViewHelpers
+    module DownloadFormatLinksHelper
+
+      def build_download_formats(download_links)
+        download_links = instance_exec(&download_links) if download_links.is_a?(Proc)
+
+        if download_links.is_a?(Array) && !download_links.empty?
+          download_links
+        elsif download_links == false
+          []
+        else
+          self.class.formats
+        end
+      end
+
+      def build_download_format_links(formats = self.class.formats)
+        params = request.query_parameters.except :format, :commit
+        div class: "download_links" do
+          span I18n.t('active_admin.download')
+          formats.each do |format|
+            a format.upcase, href: url_for(params: params, format: format)
+          end
+        end
+      end
+
+      def self.included base
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+
+        # A ready only of formats to make available in index/paginated
+        # collection view.
+        # @return [Array]
+        # @see add_format for information on adding custom download link
+        # formats
+        def formats
+          @formats ||= [:csv, :xml, :json]
+          @formats.clone
+        end
+
+        # Adds a mime type to the list of available formats available for data
+        # export. You must register the extension prior to adding it here.
+        # @param [Symbol] format the mime type to add
+        # @return [Array] A copy of the updated formats array.
+        def add_format(format)
+          unless Mime::Type.lookup_by_extension format
+            raise ArgumentError, "Please register the #{format} mime type with `Mime::Type.register`"
+          end
+          @formats << format unless formats.include? format
+          formats
+        end
+      end
+
+    end
+  end
+end

data/lib/active_admin/view_helpers/fields_for.rb

@@ -0,0 +1,50 @@
+module ActiveAdmin
+  module ViewHelpers
+    module FormHelper
+
+      # Flatten a params Hash to an array of fields.
+      #
+      # @param params [Hash]
+      # @param options [Hash] :namespace and :except
+      #
+      # @return [Array] of [Hash] with one element.
+      #
+      # @example
+      #   fields_for_params(scope: "all", users: ["greg"])
+      #     => [ {"scope" => "all"} , {"users[]" => "greg"} ]
+      #
+      def fields_for_params(params, options = {})
+        namespace = options[:namespace]
+        except    = Array.wrap(options[:except]).map &:to_s
+
+        params.flat_map do |k, v|
+          next if namespace.nil? && %w(controller action commit utf8).include?(k.to_s)
+          next if except.include?(k.to_s)
+
+          if namespace
+            k = "#{namespace}[#{k}]"
+          end
+
+          case v
+          when String
+            { k => v }
+          when Symbol
+            { k => v.to_s }
+          when Hash
+            fields_for_params(v, namespace: k)
+          when Array
+            v.map do |v|
+              { "#{k}[]" => v }
+            end
+          when nil
+            { k => '' }
+          when TrueClass, FalseClass
+            { k => v }
+          else
+            raise "I don't know what to do with #{v.class} params: #{v.inspect}"
+          end
+        end.compact
+      end
+    end
+  end
+end

data/lib/active_admin/view_helpers/flash_helper.rb

@@ -0,0 +1,14 @@
+module ActiveAdmin
+  module ViewHelpers
+    module FlashHelper
+
+      # Returns all the flash keys to display in any Active Admin view.
+      # This method removes the :timedout key that Devise uses by default.
+      # Note Rails >= 4.1 normalizes keys to strings automatically.
+      def flash_messages
+        @flash_messages ||= flash.to_hash.with_indifferent_access.except(*active_admin_application.flash_keys_to_except)
+      end
+
+    end
+  end
+end

data/lib/active_admin/view_helpers/form_helper.rb

@@ -0,0 +1,20 @@
+module ActiveAdmin
+  module ViewHelpers
+    module FormHelper
+
+      def active_admin_form_for(resource, options = {}, &block)
+        Arbre::Context.new({}, self) do
+          active_admin_form_for resource, options, &block
+        end.content
+      end
+
+      def hidden_field_tags_for(params, options = {})
+        fields_for_params(params.to_unsafe_hash, options).map do |kv|
+          k, v = kv.first
+          hidden_field_tag k, v, id: sanitize_to_id("hidden_active_admin_#{k}")
+        end.join("\n").html_safe
+      end
+
+    end
+  end
+end