activeadmin 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.bundle
+spec/rails
+*.sqlite3-journal
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,16 @@
+# These resources are needed to setup the test env
+source 'http://rubygems.org'
+
+# Rails & ActiveAdmin Dependencies
+gem 'rails',          '3.0.0'
+gem 'sqlite3-ruby',   :require => 'sqlite3'
+gem 'haml',           '3.0.18'
+gem 'formtastic',     '1.1.0.beta'
+gem 'will_paginate',  '3.0.pre2'
+gem "meta_search",    '0.9.2'
+gem 'inherited_views'
+gem 'jeweler'
+
+# Testing Dependencies
+gem 'rspec',          '2.0.0.beta.20'
+gem 'rspec-rails',    '2.0.0.beta.20'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Greg Bell, VersaPay Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,201 @@
+= Active Admin
+
+Active Admin is a tool to facilitate the generation of administration style interfaces.
+
+
+== Goals
+
+Although Active Admin is very young in its development cycle, here are its current goals:
+
+1. Build a toolset to quickly create template-able administration interfaces
+2. Allow the toolset to be entirely customizable (ie: we use standard rails coding practices
+   which can be overridden at any point)
+3. Design an interface which looks great!
+4. Build administration interfaces for common rails plugins as gems and share with the 
+   community (ie: devise admin)
+
+
+== Status
+
+Active Admin is very young. Although the code is well tested and is being used in production,
+the project is under heavy development. Once we get it to a point that has a relatively stable api,
+we will begin numbered releases starting with a 0.1 release.
+
+== Installation (Rails 3)
+
+Add the following to your Gemfile:
+
+  gem 'formtastic',     :git => "git://github.com/justinfrench/formtastic.git", :branch => 'rails3'
+  gem 'will_paginate',  :git => "git://github.com/mislav/will_paginate.git", :branch => 'rails3'
+  gem 'meta_search',    :git => "git://github.com/ernie/meta_search.git"
+  gem 'active_admin',   :git => "git://github.com/gregbell/active_admin.git"
+
+Then, run the installer:
+
+  rails generate active_admin:install
+
+This will create an initializer which is used for configuring defaults used by Active Admin as well
+as a new folder at app/admin to put all your admin configurations. Note: All ruby files in 
+the Active Admin load path get loaded into the rails application.
+
+== Usage
+
+Let's build up an example using a Post model and the provided admin generator.
+
+  rails generate active_admin:resource post
+  
+That's all you need to get a full CRUD, beautiful administration interface!
+
+The generator will create a new file app/admin/posts.rb that will
+look like the following:
+
+  ActiveAdmin.register Post
+
+=== Customize the Index Page
+
+By default, the index page is a table with each of the models content columns and links to
+show, edit and delete the object. There are many ways to customize what gets displayed:
+
+==== Simple Columns
+
+If all you need to do is change the columns which get displayed, you can do so by passing
+them to the columns method:
+
+  ActiveAdmin.register Post do
+    
+    index do |display|
+      display.columns :title, :comments_count, :created_at
+    end
+
+  end
+
+Or you can pass them in individually:
+
+  ActiveAdmin.register Post do
+    
+    index do |display|
+
+      # This will title the column 'Title' and call the #title method on each object
+      display.column :title
+
+      # This will title the column 'How many comments?' and call the #comments_count method on each object
+      display.column 'How many comments?', :comments_count
+
+      # You can add methods to the table builder which builds common things (ie: selectable checkboxes)
+      display.default_actions
+
+    end
+
+  end
+  
+==== Advanced Columns
+
+Sometimes calling methods just isn't enough and you need to write some view specific code. For
+example, say we wanted a colum called Title which holds a link to the posts admin screen.
+
+You can pass a block to a column which will then be rendered within the context of the view
+for each of the objects in the collection.
+
+  
+  ActiveAdmin.register Post do
+    
+    index do |display|
+      display.column("Title"){|post| link_to post.title, admin_post_path(post) }
+    end
+
+  end
+
+The block gets called once for each resource in the collection. The resource gets passed into
+the block as an argument.
+
+==== Sorting
+
+The index views in Active Admin include sorting by default. 
+  
+  ActiveAdmin.register Post do
+    
+    index do |display|
+
+      # A column created by a method call assumes its sortable
+      display.column :id
+
+      # If a column is defined using a block, you must pass the key to turn on sorting. The key
+      # is the attribute which gets used to sort objects using Active Record.
+      display.column("Title", :sortable => :title){|post| link_to post.title, admin_post_path(post) }
+
+      # Turn off sorting by passing false
+      display.column :do_not_sort_me, :sortable => false
+
+    end
+
+  end
+
+
+=== Customize the Form
+
+Active Admin gives complete control over the output of the form by creating a thin DSL on top of
+the fabulous DSL created by Formtastic (http://github.com/justinfrench/formtastic).
+  
+  ActiveAdmin.register Post do
+    
+    form do |f|
+      f.inputs "Details" do
+        f.input :title
+        f.input :published_at, :label => "Publish Post At"
+        f.input :category
+      end
+      f.inputs "Content" do
+        f.input :body
+      end
+      f.buttons
+    end
+
+  end
+
+Please view the documentation for Formtastic to see all the wonderful things you can do:
+http://github.com/justinfrench/formtastic
+
+
+== Tools Being Used
+
+We believe strongly in not writing code unless we have to, so Active Admin is built using many 
+other open source projects:
+
+InheritedResources::
+  Inherited Resources speeds up development by making your controllers inherit all restful 
+  actions so you just have to focus on what is important.
+InheritedViews::
+  Inherited Views is a thin addition to Inherited Resources which adds in html views to the mix
+Formtastic::
+  A DSL for semantically building amazing forms.
+WillPaginate::
+  Pagination for rails apps
+
+
+== Contributors
+
+* Greg Bell       http://github.com/gregbell
+* Philippe Creux  http://github.com/pcreux
+* Sam Vincent     http://github.com/samvincent
+* Matt Vague      http://github.com/mattvague
+* Dan Kubb        http://github.com/dkubb
+
+
+== Roadmap & Issue Tracking
+
+We are using the awesome Lighthouse ticketing system. The project can be found at:
+http://activeadmin.lighthouseapp.com
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Greg Bell, VersaPay Corporation. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,71 @@
+require 'rubygems'
+require "bundler"
+Bundler.setup
+
+require 'rake'
+
+desc "Creates a test rails app for the specs to run against"
+task :setup do
+  system("mkdir spec/rails") unless File.exists?("spec/rails")
+  system "bundle exec rails new spec/rails/rails-3.0.0 -m spec/support/rails_template.rb"
+end
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rcov = true
+end
+
+task :default => :spec
+
+namespace :spec do
+  
+  desc "Run specs for all versions of rails"
+  task :all do
+    puts "Runing for Rails 2.3.5"
+    out = `rake spec`
+    puts out
+    puts "Running for Rails 3"
+    out = `rake spec RAILS=3.0.0`
+    puts out
+  end
+  
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "active_admin #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "activeadmin"
+    gem.summary = "The administration framework for Ruby on Rails."
+    gem.description = "The administration framework for Ruby on Rails."
+    gem.email = "gregdbell@gmail.com"
+    gem.homepage = "http://github.com/gregbell/active_admin"
+    gem.authors = ["Greg Bell"]
+
+    gem.files.exclude 'spec/rails'
+    gem.test_files.exclude 'spec/rails'
+
+    require File.join(File.dirname(File.expand_path(__FILE__)), 'lib', 'active_admin', 'version')
+    gem.version = ActiveAdmin::VERSION
+
+    gem.add_dependency 'rails',           '>= 3.0.0'
+    gem.add_dependency 'formtastic',      '>= 1.1.0.beta'
+    gem.add_dependency 'will_paginate',   '>= 3.0.pre2'
+    gem.add_dependency "meta_search",     '>= 0.9.2'
+    gem.add_dependency 'inherited_views'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/active_admin.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+ 
+require 'active_admin/version' 
+
+Gem::Specification.new do |s|
+  s.name        = "active_admin"
+  s.version     = ActiveAdmin::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Greg Bell"]
+  s.email       = ["gregdbell@gmail.com"]
+  s.homepage    = "http://github.com/gregbell/active_admin"
+  s.summary     = "The missing administration framework for Ruby on Rails"
+  s.description = "ActiveAdmin DRY's your administration UI so that you can concentrate on what's actually important" 
+
+  s.add_dependency 'inherited_views', '>= 0.0.1'
+  s.add_dependency 'meta_search'
+  
+  s.files        = Dir.glob("lib/**/*") + %w(LICENSE README.rdoc)
+  s.require_path = 'lib'
+end

data/lib/active_admin.rb

@@ -0,0 +1,229 @@
+require 'meta_search'
+
+module ActiveAdmin
+  
+  autoload :VERSION,              'active_admin/version'
+  autoload :Namespace,            'active_admin/namespace'
+  autoload :Resource,             'active_admin/resource'
+  autoload :ResourceController,   'active_admin/resource_controller'
+  autoload :Dashboards,           'active_admin/dashboards'
+  autoload :Renderer,             'active_admin/renderer'
+  autoload :TableBuilder,         'active_admin/table_builder'
+  autoload :FormBuilder,          'active_admin/form_builder'
+  autoload :TabsRenderer,         'active_admin/tabs_renderer'
+  autoload :ViewHelpers,          'active_admin/view_helpers'
+  autoload :Breadcrumbs,          'active_admin/breadcrumbs'
+  autoload :Filters,              'active_admin/filters'
+  autoload :PageConfig,           'active_admin/page_config'
+  autoload :Pages,                'active_admin/pages'
+  autoload :Sidebar,              'active_admin/sidebar'
+  autoload :ActionItems,          'active_admin/action_items'
+  autoload :AssetRegistration,    'active_admin/asset_registration'
+  autoload :Menu,                 'active_admin/menu'
+  autoload :MenuItem,             'active_admin/menu_item'
+  autoload :ActionBuilder,        'active_admin/action_builder'
+
+  extend AssetRegistration
+
+  # The default namespace to put controllers and routes inside. Set this
+  # in config/initializers/active_admin.rb using:
+  # 
+  #   ActiveAdmin.default_namespace = :super_admin
+  #
+  @@default_namespace = :admin
+  mattr_accessor :default_namespace
+
+  # The default number of resources to display on index pages
+  @@default_per_page = 30
+  mattr_accessor :default_per_page
+
+  # The default sort order for index pages
+  @@default_sort_order = 'id_desc'
+  mattr_accessor :default_sort_order
+
+  # A hash of all the registered namespaces
+  @@namespaces = {}
+  mattr_accessor :namespaces
+
+  # The title which get's displayed in the main layout
+  @@site_title = ""
+  mattr_accessor :site_title
+
+  # Load paths for admin configurations. Add folders to this load path
+  # to load up other resources for administration. External gems can
+  # include thier paths in this load path to provide active_admin UIs
+  @@load_paths = [File.expand_path('app/admin', Rails.root)]
+  mattr_accessor :load_paths
+
+  # Stores if everything has been loaded or we need to reload
+  @@loaded = false
+
+  # A hash containing a menu for each of our namespaces
+  @@menus = {}
+  mattr_accessor :menus
+
+  # The class to use to render the tabs in the interface
+  @@tabs_renderer = ActiveAdmin::TabsRenderer
+  mattr_accessor :tabs_renderer
+
+  class << self
+
+    # Get's called within the initializer
+    def setup
+      # Register the default assets
+      register_stylesheet 'active_admin.css'
+      register_javascript 'active_admin_vendor.js'
+      register_javascript 'active_admin.js'
+
+      # Since we're dealing with all our own file loading, we need
+      # to remove our paths from the ActiveSupport autoload paths.
+      # If not, file nameing becomes very important and can cause clashes.
+      ActiveSupport::Dependencies.autoload_paths.reject!{|path| load_paths.include?(path) }
+
+      # Don't eagerload our configs, we'll deal with them ourselves
+      Rails.application.config.eager_load_paths = Rails.application.config.eager_load_paths.reject do |path| 
+        load_paths.include?(path)
+      end
+
+      # Dispatch request which gets triggered once in production
+      # and on every require in development mode
+      ActionDispatch::Callbacks.to_prepare :active_admin do
+        ActiveAdmin.unload!
+        # Because every time we load, the routes may have changed
+        # we must ensure to load the routes each request (in dev)
+        Rails.application.reload_routes!
+      end
+
+      yield self
+    end
+
+    # Registers a brand new configuration for the given resource.
+    #
+    # TODO: Setup docs for registration options
+    def register(resource, options = {}, &block)
+      namespace_name = options[:namespace] == false ? :root : (options[:namespace] || default_namespace)
+      namespace = namespaces[namespace_name] ||= Namespace.new(namespace_name)
+      namespace.register(resource, options, &block)
+    end
+
+    # Returns true if all the configuration files have been loaded.
+    def loaded?
+      @@loaded
+    end
+
+    # Removes all the controllers that were defined by registering
+    # resources for administration.
+    #
+    # We remove them, then load them on each request in development
+    # to allow for changes without having to restart the server.
+    def unload!
+      namespaces.values.each{|namespace| namespace.unload! }
+      @@loaded = false
+    end
+
+    # Loads all of the ruby files that are within the load path of
+    # ActiveAdmin.load_paths. This should load all of the administration
+    # UIs so that they are available for the router to proceed.
+    #
+    # The files are only loaded if we haven't already loaded all the files
+    # and they aren't marked for re-loading. To mark the files for re-loading
+    # you must first call ActiveAdmin.unload!
+    def load!
+      unless loaded?
+        load_paths.flatten.compact.uniq.each do |path|
+          Dir["#{path}/*.rb"].each{|f| load f }
+        end
+        @@loaded = true
+        return true
+      end
+      false
+    end
+
+    # Creates all the necessary routes for the ActiveAdmin configurations
+    #
+    # Use this within the routes.rb file:
+    #
+    #   Application.routes.draw do |map|
+    #     ActiveAdmin.routes(self)
+    #   end
+    #
+    def routes(router)
+      # Ensure that all the configurations (which define the routes)
+      # are all loaded
+      load!
+
+      # Define any necessary dashboard routes
+      router.instance_exec(namespaces.values) do |namespaces|
+        namespaces.each do |namespace|
+          if namespace.root?
+            match '/' => 'dashboard#index', :as => 'dashboard'
+          else
+            name = namespace.name
+            match name.to_s => "#{name}/dashboard#index", :as => "#{name.to_s}_dashboard"
+          end
+        end
+      end
+
+      # Now define the routes for each resource
+      router.instance_exec(namespaces) do |namespaces|
+        resources = namespaces.values.collect{|n| n.resources.values }.flatten
+        resources.each do |config|
+
+          # Define the block the will get eval'd within the namespace
+          route_definition_block = Proc.new do
+            resources config.underscored_resource_name.pluralize do
+
+              # Define any member actions
+              member do
+                config.member_actions.each do |action|
+                  # eg: get :comment
+                  send(action.http_verb, action.name)
+                end
+              end
+
+              # Define any collection actions
+              collection do
+                config.collection_actions.each do |action|
+                  send(action.http_verb, action.name)
+                end
+              end
+            end
+          end
+
+          if config.namespace.root?
+            instance_eval(&route_definition_block)
+          else
+            namespace config.namespace.name do
+              instance_eval(&route_definition_block)
+            end
+          end
+        end
+      end
+    end
+
+    #
+    # Add before, around and after filters to each registered resource.
+    #
+    # eg:
+    #
+    #   ActiveAdmin.before_filter :authenticate_admin!
+    #
+    def before_filter(*args, &block)
+      ResourceController.before_filter(*args, &block)
+    end
+
+    def after_filter(*args, &block)
+      ResourceController.after_filter(*args, &block)
+    end
+
+    def around_filter(*args, &block)
+      ResourceController.around_filter(*args, &block)
+    end
+
+    # Helper method to add a dashboard section
+    def dashboard_section(name, options = {}, &block)
+      ActiveAdmin::Dashboards.add_section(name, options, &block)
+    end
+
+  end
+end