activeadministration 0.0.1

data/lib/active_admin/version.rb

@@ -0,0 +1,3 @@
+module ActiveAdmin
+  VERSION = '0.0.1'
+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,
+              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,
+              action_list_popover: ActiveAdmin::Views::ActionListPopover
+
+    # 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,21 @@
+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 AssignsWithIndifferentAccessHelper
+    include ActiveAdminApplicationHelper
+    include AutoLinkHelper
+    include BreadcrumbHelper
+    include DisplayHelper
+    include IconHelper
+    include MethodOrProcHelper
+    include SidebarHelper
+    include FormHelper
+    include TitleHelper
+    include ViewFactoryHelper
+    include FlashHelper
+
+  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/assigns_with_indifferent_access_helper.rb

@@ -0,0 +1,7 @@
+module AssignsWithIndifferentAccessHelper
+
+  def assigns
+    @assigns_with_indifferent_access_helper ||= HashWithIndifferentAccess.new(super)
+  end
+
+end

data/lib/active_admin/view_helpers/auto_link_helper.rb

@@ -0,0 +1,37 @@
+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 Content")
+      #
+      def auto_link(resource, link_content = nil)
+        content = link_content || display_name(resource)
+        if url = auto_url_for(resource)
+          content = link_to(content, url)
+        end
+        content
+      end
+
+      # Like `auto_link`, except that it only returns a URL instead of a full <a> tag
+      def auto_url_for(resource)
+        if config = active_admin_resource_for(resource.class)
+          url_for config.route_instance_path resource
+        end
+      end
+
+      # Returns the ActiveAdmin::Resource instance for a class
+      def active_admin_resource_for(klass)
+        return nil unless respond_to?(:active_admin_namespace)
+        active_admin_namespace.resource_for(klass)
+      end
+
+    end
+  end
+end

data/lib/active_admin/view_helpers/breadcrumb_helper.rb

@@ -0,0 +1,27 @@
+module ActiveAdmin
+  module ViewHelpers
+    module BreadcrumbHelper
+
+      # Returns an array of links to use in a breadcrumb
+      def breadcrumb_links(path = request.path)
+        parts = path[1..-1].split('/') # remove leading "/" and split up the URL
+        parts.pop                      # remove last since it's used as the page title
+
+        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})\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
+
+          link_to name, '/' + parts[0..index].join('/')
+        end
+      end
+
+    end
+  end
+end

data/lib/active_admin/view_helpers/display_helper.rb

@@ -0,0 +1,64 @@
+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)
+        render_in_context resource, display_name_method_for(resource) if resource
+      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
+
+      # Return a pretty string for any object
+      # Date Time are formatted via #localize with format: :long
+      # ActiveRecord and Mongoid objects are formatted via #auto_link
+      # We attempt to #display_name of any other objects
+      def pretty_format(object)
+        case object
+        when String, Numeric, Arbre::Element
+          object.to_s
+        when Date, Time
+          localize(object, format: :long)
+        when ->(obj){defined?(::ActiveRecord) && obj.is_a?(ActiveRecord::Base)}
+          auto_link(object)
+        when ->(obj){defined?(::Mongoid) && obj.class.included_modules.include?(Mongoid::Document)}
+          auto_link(object)
+        else
+          display_name(object)
+        end
+      end
+
+    end
+  end
+end

data/lib/active_admin/view_helpers/download_format_links_helper.rb

@@ -0,0 +1,49 @@
+module ActiveAdmin
+  module ViewHelpers
+    module DownloadFormatLinksHelper
+
+      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 extension to the list of available formats.
+        # You must register the extension prior to adding it to the list
+        # of avilable formats. This should be used by plugins that want
+        # to add additional formats to the download format links.
+        # @param [Symbol] extension the mime extension to add
+        # @return [Array] A copy of the updated formats array.
+        def add_format extension
+          unless formats.include?(extension)
+            if Mime::Type.lookup_by_extension(extension).nil?
+              raise ArgumentError, "The mime extension you defined: #{extension} is not registered. Please register it via Mime::Type.register before adding it to the available formats."
+            end
+          @formats << extension
+          end
+          formats
+        end
+      end
+
+      # TODO: Refactor to new HTML DSL
+      def build_download_format_links(formats = self.class.formats)
+        params = request.query_parameters.except :format, :commit
+        links = formats.map { |format| link_to format.to_s.upcase, params: params, format: format }
+        div class: "download_links" do
+          text_node [I18n.t('active_admin.download'), links].flatten.join("&nbsp;").html_safe
+        end
+      end
+
+      def self.included base
+        base.extend ClassMethods
+      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 = options[:except].is_a?(Array) ? options[:except] : [options[:except]]
+
+        params.map do |k, v|
+          next if namespace.nil? && %w(controller action commit utf8).include?(k.to_s)
+          next if except.map(&:to_s).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.flatten.compact
+      end
+    end
+  end
+end

data/lib/active_admin/view_helpers/flash_helper.rb

@@ -0,0 +1,13 @@
+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
+      def active_admin_flash_messages
+        @active_admin_flash_messages ||= flash.to_hash.except(:timedout)
+      end
+
+    end
+  end
+end

data/lib/active_admin/view_helpers/form_helper.rb

@@ -0,0 +1,21 @@
+module ActiveAdmin
+  module ViewHelpers
+    module FormHelper
+
+      def active_admin_form_for(resource, options = {}, &block)
+        options = Marshal.load( Marshal.dump(options) )
+        options[:builder] ||= ActiveAdmin::FormBuilder
+
+        semantic_form_for resource, options, &block
+      end
+
+      def hidden_field_tags_for(params, options={})
+        fields_for_params(params, 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

data/lib/active_admin/view_helpers/icon_helper.rb

@@ -0,0 +1,12 @@
+module ActiveAdmin
+  module ViewHelpers
+    module IconHelper
+
+      # Render an icon from the Iconic icon set
+      def icon(*args)
+        ActiveAdmin::Iconic.icon(*args)
+      end
+
+    end
+  end
+end

data/lib/active_admin/view_helpers/method_or_proc_helper.rb

@@ -0,0 +1,93 @@
+module MethodOrProcHelper
+
+  # This method will either call the symbol on self or instance_exec the Proc
+  # within self. Any args will be passed along to the method dispatch.
+  #
+  # Calling with a Symbol:
+  #
+  #     call_method_or_exec_proc(:to_s) #=> will call #to_s
+  #
+  # Calling with a Proc
+  #
+  #     my_proc = Proc.new{ to_s }
+  #     call_method_or_exec_proc(my_proc) #=> will instance_exec in self
+  #
+  def call_method_or_exec_proc(symbol_or_proc, *args)
+    case symbol_or_proc
+    when Symbol, String
+      send(symbol_or_proc, *args)
+    when Proc
+      instance_exec(*args, &symbol_or_proc)
+    end
+  end
+
+  # Many times throughout the views we want to either call a method on an object
+  # or instance_exec a proc passing in the object as the first parameter. This
+  # method wraps that pattern.
+  #
+  # Calling with a String or Symbol:
+  #
+  #     call_method_or_proc_on(@my_obj, :size) same as @my_obj.size
+  #
+  # Calling with a Proc:
+  #
+  #     proc = Proc.new{|s| s.size }
+  #     call_method_or_proc_on(@my_obj, proc)
+  #
+  # By default, the Proc will be instance_exec'd within self. If you would rather
+  # not instance exec, but just call the Proc, then pass along `exec: false` in
+  # the options hash.
+  #
+  #     proc = Proc.new{|s| s.size }
+  #     call_method_or_proc_on(@my_obj, proc, exec: false)
+  #
+  # You can pass along any necessary arguments to the method / Proc as arguments. For
+  # example:
+  #
+  #     call_method_or_proc_on(@my_obj, :find, 1) #=> @my_obj.find(1)
+  #
+  def call_method_or_proc_on(receiver, *args)
+    options = { exec: true }.merge(args.extract_options!)
+
+    symbol_or_proc = args.shift
+
+    case symbol_or_proc
+    when Symbol, String
+      receiver.send(symbol_or_proc.to_sym, *args)
+    when Proc
+      if options[:exec]
+        instance_exec(receiver, *args, &symbol_or_proc)
+      else
+        symbol_or_proc.call(receiver, *args)
+      end
+    end
+  end
+
+  # Many configuration options (Ex: site_title, title_image) could either be
+  # static (String), methods (Symbol) or procs (Proc). This helper takes care of
+  # returning the content when String or call call_method_or_proc_on when Symbol or Proc.
+  #
+  def render_or_call_method_or_proc_on(obj, string_symbol_or_proc, options = {})
+    case string_symbol_or_proc
+    when Symbol, Proc
+      call_method_or_proc_on(obj, string_symbol_or_proc, options)
+    when String
+      string_symbol_or_proc
+    end
+  end
+
+  # This method is different from the others in that it calls `instance_exec` on the reciever,
+  # passing it the proc. This evaluates the proc in the context of the reciever, thus changing
+  # what `self` means inside the proc.
+  def render_in_context(context, obj, *args)
+    context ||= self # default to `self`
+    case obj
+    when Proc
+      context.instance_exec *args, &obj
+    when Symbol
+      context.send obj, *args
+    else
+      obj
+    end
+  end
+end