andrewroth_activeadmin 0.3.4

data/lib/active_admin/callbacks.rb

@@ -0,0 +1,89 @@
+module ActiveAdmin
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    module InstanceMethods
+      protected
+
+      # Simple callback system. Implements before and after callbacks for
+      # use within the controllers.
+      #
+      # We didn't use the ActiveSupport callbacks becuase they do not support
+      # passing in any arbitrary object into the callback method (which we
+      # need to do)
+      
+      def call_callback_with(method, *args)
+        case method
+        when Symbol
+          send(method, *args)
+        when Proc
+          instance_exec(*args, &method)
+        else
+          raise "Please register with callbacks using a symbol or a block/proc."
+        end
+      end
+    end
+
+    module ClassMethods
+
+      # Define a new callback.
+      #
+      # Example:
+      #
+      #   class MyClassWithCallbacks
+      #     include ActiveAdmin::Callbacks
+      #
+      #     define_active_admin_callbacks :save
+      #
+      #     before_save do |arg1, arg2|
+      #       # runs before save
+      #     end
+      #
+      #     after_save :call_after_save
+      #
+      #     def save
+      #       # Will run before, yield, then after
+      #       run_save_callbacks :arg1, :arg2 do
+      #         save!
+      #       end
+      #     end
+      #
+      #     protected
+      #
+      #     def call_after_save(arg1, arg2)
+      #       # runs after save
+      #     end
+      #   end
+      #     
+      def define_active_admin_callbacks(*names)
+        names.each do |name|
+          [:before, :after].each do |type|
+
+            # Define a method to set the callback
+            class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+              # def self.before_create_callbacks
+              def self.#{type}_#{name}_callbacks
+                @#{type}_#{name}_callbacks ||= []
+              end
+
+              # def self.before_create
+              def self.#{type}_#{name}(method = nil, &block)
+                #{type}_#{name}_callbacks << (method || block)
+              end
+            EOS
+          end
+
+          # Define a method to run the callbacks
+          class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+            def run_#{name}_callbacks(*args)
+              self.class.before_#{name}_callbacks.each{|callback| call_callback_with(callback, *args)}
+              value = yield if block_given?
+              self.class.after_#{name}_callbacks.each{|callback| call_callback_with(callback, *args)}
+              return value
+            end
+            EOS
+         end
+       end
+    end
+  end
+end

data/lib/active_admin/comments.rb

@@ -0,0 +1,88 @@
+require 'active_admin/comments/configuration'
+require 'active_admin/comments/comment'
+require 'active_admin/comments/views'
+require 'active_admin/comments/show_page_helper'
+require 'active_admin/comments/namespace_helper'
+require 'active_admin/comments/resource_helper'
+
+# Add the comments configuration
+ActiveAdmin::Application.send :include, ActiveAdmin::Comments::Configuration
+
+# Add the comments module to ActiveAdmin::Namespace
+ActiveAdmin::Namespace.send :include, ActiveAdmin::Comments::NamespaceHelper
+
+# Add the comments module to ActiveAdmin::Resource
+ActiveAdmin::Resource.send :include, ActiveAdmin::Comments::ResourceHelper
+
+# Add the module to the show page
+ActiveAdmin.application.view_factory.show_page.send :include, ActiveAdmin::Comments::ShowPageHelper
+
+# Generate a Comment resource when namespaces are registered
+ActiveAdmin::Event.subscribe ActiveAdmin::Namespace::RegisterEvent do |namespace|
+  if namespace.comments?
+    namespace.register ActiveAdmin::Comment, :as => 'Comment' do
+      actions :index, :show, :create
+
+      # Don't display in the menu
+      menu false
+
+      # Don't allow comments on comments
+      config.comments = false
+
+      # Filter Comments by date
+      filter :resource_type
+      filter :body
+      filter :created_at
+
+      # Only view comments in this namespace
+      scope :all, :default => true do |comments|
+        comments.where(:namespace => active_admin_config.namespace.name.to_s)
+      end
+
+      # Always redirect to the resource on show
+      before_filter :only => :show do
+        flash[:notice] = flash[:notice].dup if flash[:notice]
+        comment = ActiveAdmin::Comment.find(params[:id])
+        resource_config = active_admin_config.namespace.resource_for(comment.resource.class)
+        redirect_to send(resource_config.route_instance_path, comment.resource)
+      end
+
+      # Store the author and namespace
+      before_save do |comment|
+        comment.namespace = active_admin_config.namespace.name
+        comment.author = current_active_admin_user
+      end
+
+      # Redirect to the resource show page when failing to add a comment
+      # TODO: Provide helpers to make such kind of customization much simpler
+      controller do
+        def create
+          create! do |success, failure|
+            failure.html do 
+              resource_config = active_admin_config.namespace.resource_for(@comment.resource.class)
+              flash[:error] = "Comment wasn't saved, text was empty."
+              redirect_to send(resource_config.route_instance_path, @comment.resource)
+            end
+          end
+        end
+      end
+
+
+      # Display as a table
+      index do
+        column("Resource"){|comment| auto_link(comment.resource) }
+        column("Author"){|comment| auto_link(comment.author) }
+        column :body
+      end
+    end
+  end
+end
+
+# Register for comments when new resources are registered
+ActiveAdmin::Event.subscribe ActiveAdmin::Resource::RegisterEvent do |resource|
+  if resource.comments?
+    resource.resource.has_many :active_admin_comments, :class_name => "ActiveAdmin::Comment",
+                                                       :as         => :resource, 
+                                                       :dependent  => :destroy
+  end
+end

data/lib/active_admin/comments/comment.rb

@@ -0,0 +1,21 @@
+require 'kaminari/models/active_record_extension'
+
+module ActiveAdmin
+
+  # manually initialize kaminari for this model
+  ::ActiveRecord::Base.send :include, Kaminari::ActiveRecordExtension
+
+  class Comment < ActiveRecord::Base
+    self.table_name = "active_admin_comments"
+
+    belongs_to :resource, :polymorphic => true
+    belongs_to :author, :polymorphic => true
+
+    validates_presence_of :resource_id
+    validates_presence_of :resource_type
+    validates_presence_of :body
+    validates_presence_of :namespace
+  end
+
+end
+

data/lib/active_admin/comments/configuration.rb

@@ -0,0 +1,18 @@
+module ActiveAdmin
+  module Comments
+
+    module Configuration
+      extend ActiveSupport::Concern
+
+      included do
+        # Set the namespaces that can create and view comments
+        #
+        #   config.allow_comments_in = [:admin, :root]
+        #
+        setting :allow_comments_in, [:admin]
+      end
+
+    end
+
+  end
+end

data/lib/active_admin/comments/namespace_helper.rb

@@ -0,0 +1,14 @@
+module ActiveAdmin
+  module Comments
+
+    module NamespaceHelper
+
+      # Returns true of the namespace allows comments
+      def comments?
+        application.allow_comments_in && application.allow_comments_in.include?(name)
+      end
+
+    end
+
+  end
+end

data/lib/active_admin/comments/resource_helper.rb

@@ -0,0 +1,17 @@
+module ActiveAdmin
+  module Comments
+
+    module ResourceHelper
+      extend ActiveSupport::Concern
+
+      included do
+        attr_accessor :comments
+      end
+
+      def comments?
+        namespace.comments? && comments != false
+      end
+    end
+
+  end
+end

data/lib/active_admin/comments/show_page_helper.rb

@@ -0,0 +1,23 @@
+module ActiveAdmin
+  module Comments
+
+    # Adds #active_admin_comments to the show page for use
+    # and sets it up on the default main content
+    module ShowPageHelper
+
+      # Add admin comments to the main content if they are
+      # turned on for the current resource
+      def default_main_content
+        super
+        active_admin_comments if active_admin_config.comments?
+      end
+
+      # Display the comments for the resource. Same as calling
+      # #active_admin_comments_for with the current resource
+      def active_admin_comments(*args, &block)
+        active_admin_comments_for(resource, *args, &block)
+      end
+    end
+
+  end
+end

data/lib/active_admin/comments/views.rb

@@ -0,0 +1,3 @@
+require 'active_admin/views'
+require 'active_admin/comments/views/active_admin_comments'
+require 'active_admin/comments/views/active_admin_comment'

data/lib/active_admin/comments/views/active_admin_comments.rb

@@ -0,0 +1,82 @@
+require 'active_admin/views'
+require 'active_admin/views/components/panel'
+
+module ActiveAdmin
+  module Comments
+    module Views
+
+      class Comments < ActiveAdmin::Views::Panel
+        builder_method :active_admin_comments_for
+
+        def build(record)
+          @record = record
+          super(title_content, :for => record)
+          build_comments
+        end
+
+        protected
+
+        def title_content
+          "Comments (#{record_comments.count})"
+        end
+
+        def record_comments
+          @record_comments ||= @record.active_admin_comments.where(:namespace => active_admin_namespace.name.to_s)
+        end
+
+        def build_comments
+          if record_comments.count > 0
+            record_comments.each do |comment|
+              build_comment(comment)
+            end
+          else
+            build_empty_message
+          end
+          build_comment_form
+        end
+
+        def build_comment(comment)
+          div :for => comment do
+            div :class => "active_admin_comment_meta" do
+              user_name = comment.author ? auto_link(comment.author) : "Anonymous"
+              h4(user_name, :class => "active_admin_comment_author")
+              span(pretty_format(comment.created_at))
+            end
+            div :class => "active_admin_comment_body" do
+              simple_format(comment.body)
+            end
+            div :style => "clear:both;"
+          end
+        end
+
+        def build_empty_message
+          span :class => "empty" do
+            "No comments yet."
+          end
+        end
+
+        def comment_form_url
+          send(:"#{active_admin_namespace.name}_comments_path")
+        end
+
+        def build_comment_form
+          self << active_admin_form_for(ActiveAdmin::Comment.new, :url => comment_form_url, :html => {:class => "inline_form"}) do |form|
+            form.inputs do
+              form.input :resource_type, :value => @record.class.base_class.name.to_s, :as => :hidden
+              form.input :resource_id, :value => @record.id, :as => :hidden
+              form.input :body, :input_html => {:size => "80x8"}, :label => false
+            end
+            form.buttons do
+              form.commit_button 'Add Comment'
+            end
+          end
+        end
+
+        def default_id_for_prefix
+          'active_admin_comments_for'
+        end
+      end
+
+    end
+  end
+end

data/lib/active_admin/component.rb

@@ -0,0 +1,22 @@
+module ActiveAdmin
+  class Component < Arbre::HTML::Div
+
+    # By default components render a div
+    def tag_name
+      'div'
+    end
+
+    def initialize(*)
+      super
+      add_class default_class_name
+    end
+
+    protected
+
+    # By default, add a css class named after the ruby class
+    def default_class_name
+      self.class.name.demodulize.underscore
+    end
+
+  end
+end

data/lib/active_admin/controller_action.rb

@@ -0,0 +1,12 @@
+module ActiveAdmin
+  class ControllerAction
+    attr_reader :name
+    def initialize(name, options = {})
+      @name, @options = name, options
+    end
+
+    def http_verb
+      @options[:method] ||= :get
+    end
+  end
+end

data/lib/active_admin/csv_builder.rb

@@ -0,0 +1,45 @@
+module ActiveAdmin
+  # CSVBuilder stores CSV configuration
+  #
+  # Usage example:
+  #
+  #   csv_builder = CSVBuilder.new
+  #   csv_builder.column :id
+  #   csv_builder.column("Name") { |resource| resource.full_name }
+  #
+  class CSVBuilder
+
+    # Return a default CSVBuilder for a resource
+    # The CSVBuilder's columns would be Id followed by this
+    # resource's content columns
+    def self.default_for_resource(resource)
+      new.tap do |csv_builder|
+        csv_builder.column(:id)
+        resource.content_columns.each do |content_column|
+          csv_builder.column(content_column.name.to_sym)
+        end
+      end
+    end
+
+    attr_reader :columns
+
+    def initialize(&block)
+      @columns = []
+      instance_eval &block if block_given?
+    end
+
+    # Add a column
+    def column(name, &block)
+      @columns << Column.new(name, block)
+    end
+
+    class Column
+      attr_reader :name, :data
+      
+      def initialize(name, block = nil)
+        @name = name.is_a?(Symbol) ? name.to_s.titleize : name
+        @data = block || name.to_sym
+      end
+    end
+  end
+end