activeadmin-rb 1.4.0

data/lib/active_admin/views/components/columns.rb

@@ -0,0 +1,161 @@
+module ActiveAdmin
+  module Views
+
+    # = Columns Component
+    #
+    # The Columns component allows you draw content into scalable columns. All
+    # you need to do is define the number of columns and the component will
+    # take care of the rest.
+    #
+    # == Simple Columns
+    #
+    # To display columns, use the #columns method. Within the block, call the
+    # #column method to create a new column.
+    #
+    # To create a two column layout:
+    #
+    #     columns do
+    #       column do
+    #         span "Column # 1
+    #       end
+    #       column do
+    #         span "Column # 2
+    #       end
+    #     end
+    #
+    #
+    # == Multiple Span Columns
+    #
+    # To make a column span multiple, pass the :span option to the column method:
+    #
+    #     columns do
+    #       column span: 2 do
+    #         span "Column # 1
+    #       end
+    #       column do
+    #         span "Column # 2
+    #       end
+    #     end
+    #
+    # By default, each column spans 1 column. So the above layout would have 2 columns,
+    # the first being 2 time bigger than the second.
+    #
+    #
+    # == Max and Min Column Sizes
+    #
+    # Active Admin is a fluid width layout, which means that columns are all defined
+    # using percentages. Sometimes this can cause issues if you don't want a column
+    # to shrink or expand past a certain point.
+    #
+    # To overcome this, columns include a :max_width and :min_width option.
+    #
+    #     columns do
+    #       column max_width: "200px", min_width: "100px" do
+    #         span "Column # 1
+    #       end
+    #       column do
+    #         span "Column # 2
+    #       end
+    #     end
+    #
+    # Now the first column will not grow bigger than 200px and will not shrink smaller
+    # than 100px.
+    class Columns < ActiveAdmin::Component
+      builder_method :columns
+
+      # For documentation, please take a look at Column#build
+      def column(*args, &block)
+        insert_tag Column, *args, &block
+      end
+
+      # Override add child to set widths
+      def add_child(*)
+        super
+        calculate_columns!
+      end
+
+      protected
+
+      # Override the closing tag to include a clear
+      def closing_tag
+        "<div style=\"clear:both;\"></div>" + super
+      end
+
+      def margin_size
+        2
+      end
+
+      # Calculate our columns sizes and margins
+      def calculate_columns!
+        span_count = columns_span_count
+        columns_count = children.size
+
+        all_margins_width = margin_size * (span_count - 1)
+        column_width = (100.00 - all_margins_width) / span_count
+
+        columns.each_with_index do |column, i|
+          is_last_column = i == (columns_count - 1)
+          column.set_column_styles(column_width, margin_size, is_last_column)
+        end
+      end
+
+      def columns_span_count
+        count = 0
+        columns.each do |column|
+          count += column.span_size
+        end
+
+        count
+      end
+
+      def columns
+        children.select { |child| child.is_a?(Column) }
+      end
+    end
+
+    class Column < ActiveAdmin::Component
+
+      attr_accessor :span_size, :max_width, :min_width
+
+      # @param [Hash] options An options hash for the column
+      #
+      # @option options [Integer] :span The columns this column should span
+      def build(options = {})
+        options = options.dup
+        @span_size = options.delete(:span) || 1
+        @max_width = options.delete(:max_width)
+        @min_width = options.delete(:min_width)
+
+        super(options)
+      end
+
+      def set_column_styles(column_width, margin_width, is_last_column = false)
+        column_with_span_width = (span_size * column_width) + ((span_size - 1) * margin_width)
+
+        styles = []
+
+        styles << "width: #{column_with_span_width}%;"
+
+        if max_width
+          styles << "max-width: #{safe_width(max_width)};"
+        end
+
+        if min_width
+          styles << "min-width: #{safe_width(min_width)};"
+        end
+
+        styles << "margin-right: #{margin_width}%;" unless is_last_column
+
+        set_attribute :style, styles.join(" ")
+      end
+
+      private
+
+      # Converts values without a '%' or 'px' suffix to a pixel value
+      def safe_width(width)
+        width.to_s.gsub(/\A(\d+)\z/, '\1px')
+      end
+
+    end
+  end
+end

data/lib/active_admin/views/components/dropdown_menu.rb

@@ -0,0 +1,71 @@
+module ActiveAdmin
+  module Views
+
+    # Action List - A button with a drop down menu of links
+    #
+    # Creating a new action list:
+    #
+    #     dropdown_menu "Administration" do
+    #       item "Edit Details", edit_details_path
+    #       item "Edit My Account", edit_my_account_path
+    #     end
+    #
+    # This will create a button with the label "Administration" and
+    # a drop down once clicked with 2 options.
+    #
+    class DropdownMenu < ActiveAdmin::Component
+      builder_method :dropdown_menu
+
+      # Build a new action list
+      #
+      # @param [String] name  The name to display in the button
+      #
+      # @param [Hash] options A set of options that get passed along to
+      #                       to the parent dom element.
+      def build(name, options = {})
+        options = options.dup
+
+        # Easily set options for the button or menu
+        button_options = options.delete(:button) || {}
+        menu_options = options.delete(:menu) || {}
+
+        @button = build_button(name, button_options)
+        @menu = build_menu(menu_options)
+
+        super(options)
+      end
+
+      def item(*args)
+        within @menu do
+          li link_to(*args)
+        end
+      end
+
+      private
+
+      def build_button(name, button_options)
+        button_options[:class] ||= ''
+        button_options[:class] << ' dropdown_menu_button'
+
+        button_options[:href] = '#'
+
+        a name, button_options
+      end
+
+      def build_menu(options)
+        options[:class] ||= ''
+        options[:class] << ' dropdown_menu_list'
+
+        menu_list = nil
+
+        div class: 'dropdown_menu_list_wrapper' do
+          menu_list = ul(options)
+        end
+
+        menu_list
+      end
+
+    end
+
+  end
+end

data/lib/active_admin/views/components/index_list.rb

@@ -0,0 +1,69 @@
+require 'active_admin/helpers/collection'
+
+module ActiveAdmin
+  module Views
+
+    # Renders a collection of index views available to the resource
+    # as a list with a separator
+    class IndexList < ActiveAdmin::Component
+      builder_method :index_list_renderer
+
+      include ::ActiveAdmin::Helpers::Collection
+
+      def default_class_name
+        "indexes table_tools_segmented_control"
+      end
+
+      def tag_name
+        'ul'
+      end
+
+      # Builds the links for presenting different index views to the user
+      #
+      # @param [Array] index_classes The class constants that represent index page presenters
+      def build(index_classes)
+        unless current_filter_search_empty?
+          index_classes.each do |index_class|
+            build_index_list(index_class)
+          end
+        end
+      end
+
+      protected
+
+      # Builds the individual link and HTML classes for each index page presenter
+      #
+      # @param [Class] index_class The class on which to build the link and html classes
+      def build_index_list(index_class)
+        li class: classes_for_index(index_class) do
+          params = request.query_parameters.except :page, :commit, :format
+          url_with_params = url_for(params.merge(as: index_class.index_name.to_sym))
+
+          a href: url_with_params, class: "table_tools_button" do
+            name = index_class.index_name
+            I18n.t("active_admin.index_list.#{name}", default: name.to_s.titleize)
+          end
+        end
+      end
+
+      def classes_for_index(index_class)
+        classes = ["index"]
+        classes << "selected" if current_index?(index_class)
+        classes.join(" ")
+      end
+
+      def current_index?(index_class)
+        if params[:as]
+          params[:as] == index_class.index_name
+        else
+          active_admin_config.default_index_class == index_class
+        end
+      end
+
+      def current_filter_search_empty?
+        params.include?(:q) && collection_is_empty?
+      end
+
+    end
+  end
+end

data/lib/active_admin/views/components/menu.rb

@@ -0,0 +1,32 @@
+module ActiveAdmin
+  module Views
+
+    # Renders an ActiveAdmin::Menu as a set of unordered list items.
+    #
+    # This component takes cares of deciding which items should be
+    # displayed given the current context and renders them appropriately.
+    #
+    # The entire component is rendered within one ul element.
+    class Menu < Component
+      attr_reader :menu
+      builder_method :menu
+
+      # @param [ActiveAdmin::Menu] menu the Menu to render
+      # @param [Hash] options the options as passed to the underlying ul element.
+      #
+      def build(menu, options = {})
+        @menu = menu
+        super(options)
+
+        menu.items.each do |item|
+          menu_item(item) if helpers.render_in_context self, item.should_display
+        end
+        children.sort!
+      end
+
+      def tag_name
+        'ul'
+      end
+    end
+  end
+end

data/lib/active_admin/views/components/menu_item.rb

@@ -0,0 +1,58 @@
+module ActiveAdmin
+  module Views
+
+    # Arbre component used to render ActiveAdmin::MenuItem
+    class MenuItem < Component
+      builder_method :menu_item
+      attr_reader :label
+      attr_reader :url
+      attr_reader :priority
+
+      def build(item, options = {})
+        super(options.merge(id: item.id))
+        @label = helpers.render_in_context self, item.label
+        @url = helpers.render_in_context self, item.url
+        @priority = item.priority
+        @submenu = nil
+
+        add_class "current" if item.current? assigns[:current_tab]
+
+        if url
+          text_node link_to label, url, item.html_options
+        else
+          span label, item.html_options
+        end
+
+        if item.items.any?
+          add_class "has_nested"
+          @submenu = menu(item)
+        end
+      end
+
+      def tag_name
+        'li'
+      end
+
+      # Sorts by priority first, then alphabetically by label if needed.
+      def <=>(other)
+        result = priority <=> other.priority
+        result == 0 ? label <=> other.label : result
+      end
+
+      def visible?
+        url.nil? || real_url? || @submenu && @submenu.children.any?
+      end
+
+      def to_s
+        visible? ? super : ''
+      end
+
+      private
+
+      # URL is not nil, empty, or '#'
+      def real_url?
+        url && url.present? && url != '#'
+      end
+    end
+  end
+end

data/lib/active_admin/views/components/paginated_collection.rb

@@ -0,0 +1,159 @@
+require 'active_admin/helpers/collection'
+require 'active_admin/view_helpers/download_format_links_helper'
+
+module ActiveAdmin
+  module Views
+
+    # Wraps the content with pagination and available formats.
+    #
+    # *Example:*
+    #
+    #   paginated_collection collection, entry_name: "Post" do
+    #     div do
+    #       h2 "Inside the
+    #     end
+    #   end
+    #
+    # This will create a div with a sentence describing the number of
+    # posts in one of the following formats:
+    #
+    # * "No Posts found"
+    # * "Displaying all 10 Posts"
+    # * "Displaying Posts 1 - 30 of 31 in total"
+    #
+    # It will also generate pagination links.
+    #
+    class PaginatedCollection < ActiveAdmin::Component
+      builder_method :paginated_collection
+
+      attr_reader :collection
+
+      # Builds a new paginated collection component
+      #
+      # collection => A paginated collection from kaminari
+      # options    => These options will be passed to `page_entries_info`
+      #   entry_name     => The name to display for this resource collection
+      #   params         => Extra parameters for pagination (e.g. { anchor: 'details' })
+      #   param_name     => Parameter name for page number in the links (:page by default)
+      #   download_links => Download links override (false or [:csv, :pdf])
+      #
+      def build(collection, options = {})
+        @collection     = collection
+        @params         = options.delete(:params)
+        @param_name     = options.delete(:param_name)
+        @download_links = options.delete(:download_links)
+        @display_total  = options.delete(:pagination_total) { true }
+        @per_page       = options.delete(:per_page)
+
+        unless collection.respond_to?(:total_pages)
+          raise(StandardError, "Collection is not a paginated scope. Set collection.page(params[:page]).per(10) before calling :paginated_collection.")
+        end
+
+        @contents = div(class: "paginated_collection_contents")
+        build_pagination_with_formats(options)
+        @built = true
+      end
+
+      # Override add_child to insert all children into the @contents div
+      def add_child(*args, &block)
+        if @built
+          @contents.add_child(*args, &block)
+        else
+          super
+        end
+      end
+
+      protected
+
+      def build_pagination_with_formats(options)
+        div id: "index_footer" do
+          build_per_page_select if @per_page.is_a?(Array)
+          build_pagination
+          div(page_entries_info(options).html_safe, class: "pagination_information")
+
+          formats = build_download_formats @download_links
+          build_download_format_links formats if formats.any?
+        end
+      end
+
+      def build_per_page_select
+        div class: "pagination_per_page" do
+          text_node I18n.t("active_admin.pagination.per_page")
+          select do
+            @per_page.each do |per_page|
+              option(
+                per_page,
+                value: per_page,
+                selected: collection.limit_value == per_page ? "selected" : nil
+              )
+            end
+          end
+        end
+      end
+
+      def build_pagination
+        options = { theme: 'active_admin' }
+        options[:params]     = @params     if @params
+        options[:param_name] = @param_name if @param_name
+
+        if !@display_total && collection.respond_to?(:offset)
+          # The #paginate method in kaminari will query the resource with a
+          # count(*) to determine how many pages there should be unless
+          # you pass in the :total_pages option. We issue a query to determine
+          # if there is another page or not, but the limit/offset make this
+          # query fast.
+          offset = collection.offset(collection.current_page * @per_page.to_i).limit(1).count
+          options[:total_pages] = collection.current_page + offset
+          options[:right] = 0
+        end
+
+        text_node paginate collection, options
+      end
+
+      include ::ActiveAdmin::Helpers::Collection
+      include ::ActiveAdmin::ViewHelpers::DownloadFormatLinksHelper
+
+      # modified from will_paginate
+      def page_entries_info(options = {})
+        if options[:entry_name]
+          entry_name   = options[:entry_name]
+          entries_name = options[:entries_name] || entry_name.pluralize
+        elsif collection_is_empty?
+          entry_name   = I18n.t "active_admin.pagination.entry", count: 1, default: 'entry'
+          entries_name = I18n.t "active_admin.pagination.entry", count: 2, default: 'entries'
+        else
+          key = "activerecord.models." + collection.first.class.model_name.i18n_key.to_s
+          entry_name   = I18n.translate key, count: 1,               default: collection.first.class.name.underscore.sub('_', ' ')
+          entries_name = I18n.translate key, count: collection.size, default: entry_name.pluralize
+        end
+
+        if @display_total
+          if collection.total_pages < 2
+            case collection_size
+            when 0; I18n.t("active_admin.pagination.empty",    model: entries_name)
+            when 1; I18n.t("active_admin.pagination.one",      model: entry_name)
+            else;   I18n.t("active_admin.pagination.one_page", model: entries_name, n: collection.total_count)
+            end
+          else
+            offset = (collection.current_page - 1) * collection.limit_value
+            total  = collection.total_count
+            I18n.t "active_admin.pagination.multiple",
+                   model: entries_name,
+                   total: total,
+                   from: offset + 1,
+                   to: offset + collection_size
+          end
+        else
+          # Do not display total count, in order to prevent a `SELECT count(*)`.
+          # To do so we must not call `collection.total_pages`
+          offset = (collection.current_page - 1) * collection.limit_value
+          I18n.t "active_admin.pagination.multiple_without_total",
+                 model: entries_name,
+                 from: offset + 1,
+                 to: offset + collection_size
+        end
+      end
+
+    end
+  end
+end