admin_interface 1.0.0

data/README.rdoc

@@ -0,0 +1,87 @@
+= AdminInterface
+
+A Rails admin interface generator for Rails 3. Theme stolen from Redmine. Similar to web-app-theme.
+
+== More info
+
+Generator to create some nifty admin scaffolds. It can work with SearchLogic and WillPaginate.
+It also has admin authentication really well implemented.
+
+== Install
+
+Add following to your Gemfile
+
+  group :development, :test do
+    # Generators
+    gem 'admin_interface'
+  end
+
+Or install as plugin from Github.
+
+  rails plugin install git://github.com/joost/admin_interface.git
+  
+== Usage / Example
+
+=== Generate the initial framework (layout, etc.)
+
+  rails generate admin_interface
+  
+This will:
+* But some images (stolen from Redmine) into public/images/admin/
+* Create an Admin::BaseController in app/controllers/admin/base_controller.rb
+* Create a layout in app/views/layouts/admin.html.erb
+* Add some jQuery javascripts and CSS
+
+Next, add following routes to config/routes.rb.
+
+  namespace :admin do
+    root :to => 'base#index'
+    # Add the following after you've used the admin_scaffold generator
+    resources :model do
+      delete 'delete_all', :on => :collection
+    end
+  end
+
+Change the app/controllers/admin/base_controller.rb to have a before filter
+only allowing admins to access it.
+
+=== Generate admin models and controllers
+
+Create a scaffold for a model, for example:
+
+  rails generate admin_scaffold post
+  rails generate admin_scaffold post title:string body:text published:boolean
+  rails generate admin_scaffold purchase order_id:integer amount:decimal
+
+This will:
+* Create stuff similar to original Rails scaffold generator but for admin interface.
+* NOT create model since you probably have it already.
+
+Pass the name of the model (in singular form), either CamelCased or
+under_scored, as the first argument, and an optional list of attribute
+pairs.
+
+Attribute pairs are column_name:sql_type arguments specifying the
+model's attributes. Timestamps are added by default, so you don't have to
+specify them by hand as 'created_at:datetime updated_at:datetime'.
+
+=== See it in action
+
+Go to /admin and you can see everything in action.
+
+== Error messages
+
+Add this to your environment.rb (see: http://railscasts.com/episodes/39-customize-field-error)
+This will make sure the admin errors will show in correct styling.
+
+  # Change the error from div to span
+  ActionView::Base.field_error_proc = Proc.new do |html_tag, instance_tag|
+    "<span class='fieldWithErrors'>#{html_tag}</span>"
+  end
+
+== Kudos
+
+Kudos, credits or whatever you like more go to:
+* Jean-Philippe Lang (creator of {Redmine}[http://www.redmine.org/]).
+  
+Copyright (c) 2010 Joost Hietbrink, released under the MIT license

data/admin_interface.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "devise/version"
+
+Gem::Specification.new do |s|
+  s.name = "admin_interface"
+  s.version = '1.0.0'
+  s.platform = Gem::Platform::RUBY
+  s.summary = "A Rails admin interface generator. Theme stolen from Redmine."
+  s.email = "joost@joopp.com"
+  s.homepage = "http://github.com/joost/admin_interface"
+  s.description = "A Rails admin interface generator. Theme stolen from Redmine. Similar to web-app-theme."
+  s.authors = ['Joost Hietbrink']
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+end

data/lib/generators/admin_interface/USAGE

@@ -0,0 +1 @@
+Nothing much to say.. just run it.

data/lib/generators/admin_interface/admin_interface_generator.rb

@@ -0,0 +1,42 @@
+class AdminInterfaceGenerator < Rails::Generators::Base
+
+  source_root File.expand_path("../templates", __FILE__)
+
+  def copy_image_files
+    # Images
+    # Copy all images to public/images/admin
+    admin_image_dir = File.join('public', 'images', 'admin')
+    directory('images', admin_image_dir)
+  end
+
+  def copy_controller_files
+    copy_file("controllers/base_controller.rb", "app/controllers/admin/base_controller.rb")
+    copy_file("controllers/resource_controller.rb", "app/controllers/admin/resource_controller.rb")    
+  end
+
+  def copy_view_files
+    copy_file("views/layout.html.erb", "app/views/layouts/admin.html.erb")
+    copy_file("views/index.html.erb", "app/views/admin/index.html.erb")
+  end
+
+  def copy_javascript_files
+    copy_file("javascripts/jquery.admin.js", "public/javascripts/jquery.admin.js")
+  end
+
+  def copy_stylesheet_files
+    copy_file("views/admin.css", "public/stylesheets/admin.css")
+  end
+
+  def copy_helper_files
+    copy_file("helpers/admin_helper.rb", "app/helpers/admin_helper.rb")
+  end
+
+  # def add_admin_route
+  #   route("namespace :admin do\n    root :to => 'base#index'\n    # resources :some_model do\n    #   delete 'delete_all', :on => :collection\n    # end\n  end")
+  # end
+
+  def show_readme
+    readme("INSTALL")
+  end
+
+end

data/lib/generators/admin_interface/templates/INSTALL

@@ -0,0 +1,10 @@
+Add following routes to config/routes.rb
+
+  map.admin 'admin', :controller => 'admin'
+  map.namespace :admin do |admin|
+    # Add the following after you've used the admin_scaffold generator
+    # admin.resources :model, :collection => {:destroy_all => :delete}
+  end
+
+Change the app/controllers/admin_controller.rb to have a before filter
+only allowing admins to access it.

data/lib/generators/admin_interface/templates/controllers/base_controller.rb

@@ -0,0 +1,32 @@
+# The AdminController is the parent class that makes sure all administrator actions
+# require a logged-in User with an admin Role.
+class Admin::BaseController < ApplicationController
+
+  layout 'admin'
+
+  # Replace this with your own authentication / authorization stuff
+  before_filter :http_authentication
+  # Example when using Devise gem
+  # before_filter :authenticate_admin!
+
+  # Add controller names you want to include as tab. Eg.
+  #  @@tabs = %w(messages) # if you created a Admin::MessagesController using the admin_scaffold generator.
+  cattr_accessor :tabs
+  @@tabs = %w()
+
+  #  GET /admin/
+  def index
+  end
+
+private
+
+  ADMIN_USERNAME = 'admin'
+  ADMIN_PASSWORD = 'admin'
+
+  def http_authentication
+    authenticate_or_request_with_http_basic do |username, password|
+      username == ADMIN_USERNAME && password == ADMIN_PASSWORD
+    end
+  end
+
+end

data/lib/generators/admin_interface/templates/controllers/resource_controller.rb

@@ -0,0 +1,92 @@
+class Admin::ResourceController < Admin::BaseController
+
+  before_filter :filter_load_resources, :only => [:index]
+  before_filter :filter_load_resource, :only => [:show, :edit, :update, :destroy]
+
+  def index
+    @resources = resource_class.paginate(:page => params[:page], :per_page => params[:per_page])
+  end
+
+  def show
+  end
+
+  def new
+    @resource = resource_class.new
+    instance_variable_set("@#{resource_instance_variable_name}", @resource)
+  end
+
+  def edit
+  end
+
+  def create
+    @resource = resource_class.new(params_hash_for_resource)
+    instance_variable_set("@#{resource_instance_variable_name}", @resource)
+
+    if @resource.save
+      redirect_to([:admin, @resource], :notice => 'Object was successfully created.')
+    else
+      render :action => "new"
+    end
+  end
+
+  def update
+    if @resource.update_attributes(params_hash_for_resource)
+      redirect_to([:admin, @resource], :notice => 'Object was successfully updated.')
+    else
+      render :action => "edit"
+    end
+  end
+
+  def destroy
+    @resource.destroy
+
+    redirect_to :action => :index
+  end
+
+  def destroy_all
+    destroyed_resources = resource_class.destroy_all(:id => params[:ids])
+    flash[:notice] = "#{destroyed_resources.size} objects destroyed."
+    redirect_to :action => :index
+  end
+
+protected
+
+  def current_resources
+    @resources ||= resource_class.paginate(:page => params[:page], :per_page => params[:per_page])
+  end
+
+  def current_resource
+    @resource ||= resource_class.find(params[:id])
+  end
+
+  def resource_class
+    controller_name.singularize.camelize.constantize
+  end
+
+  def filter_load_resources
+    instance_variable_set("@#{resources_instance_variable_name}", current_resources)
+  end
+
+  def filter_load_resource
+    instance_variable_set("@#{resource_instance_variable_name}", current_resource)
+  end
+
+  def resources_instance_variable_name
+    instance_variable_name
+  end
+
+  def resource_instance_variable_name
+    instance_variable_name.singularize
+  end
+
+  # The name of the instance variable that load_object should assign to.
+  # By default this is the controller_name.
+  def instance_variable_name
+    controller_name
+  end
+
+  def params_hash_for_resource
+    params[resource_instance_variable_name]
+  end
+
+end

data/lib/generators/admin_interface/templates/helpers/admin_helper.rb

@@ -0,0 +1,24 @@
+module AdminHelper
+
+  # Following methods are ripped from RedMine but very nice!
+
+  def content_for(name, content = nil, &block)
+    @has_content ||= {}
+    @has_content[name] = true
+    super(name, content, &block)
+  end
+
+  def has_content?(name)
+    (@has_content && @has_content[name]) || false
+  end
+
+  # Renders flash messages
+  def render_flash_messages
+    flash_string = ''
+    flash.each do |k,v|
+      flash_string << content_tag('div', v, :class => "flash #{k}")
+    end
+    flash_string.html_safe
+  end
+
+end

data/lib/generators/admin_interface/templates/images/22x22/.svn/all-wcprops

@@ -0,0 +1,89 @@
+K 25
+svn:wc:ra_dav:version-url
+V 43
+/svn/!svn/ver/752/trunk/public/images/22x22
+END
+plugin.png
+K 25
+svn:wc:ra_dav:version-url
+V 54
+/svn/!svn/ver/752/trunk/public/images/22x22/plugin.png
+END
+file.png
+K 25
+svn:wc:ra_dav:version-url
+V 52
+/svn/!svn/ver/157/trunk/public/images/22x22/file.png
+END
+settings.png
+K 25
+svn:wc:ra_dav:version-url
+V 56
+/svn/!svn/ver/167/trunk/public/images/22x22/settings.png
+END
+role.png
+K 25
+svn:wc:ra_dav:version-url
+V 52
+/svn/!svn/ver/157/trunk/public/images/22x22/role.png
+END
+users.png
+K 25
+svn:wc:ra_dav:version-url
+V 53
+/svn/!svn/ver/157/trunk/public/images/22x22/users.png
+END
+comment.png
+K 25
+svn:wc:ra_dav:version-url
+V 55
+/svn/!svn/ver/529/trunk/public/images/22x22/comment.png
+END
+authent.png
+K 25
+svn:wc:ra_dav:version-url
+V 55
+/svn/!svn/ver/157/trunk/public/images/22x22/authent.png
+END
+notifications.png
+K 25
+svn:wc:ra_dav:version-url
+V 61
+/svn/!svn/ver/157/trunk/public/images/22x22/notifications.png
+END
+projects.png
+K 25
+svn:wc:ra_dav:version-url
+V 56
+/svn/!svn/ver/157/trunk/public/images/22x22/projects.png
+END
+workflow.png
+K 25
+svn:wc:ra_dav:version-url
+V 56
+/svn/!svn/ver/157/trunk/public/images/22x22/workflow.png
+END
+info.png
+K 25
+svn:wc:ra_dav:version-url
+V 52
+/svn/!svn/ver/157/trunk/public/images/22x22/info.png
+END
+options.png
+K 25
+svn:wc:ra_dav:version-url
+V 55
+/svn/!svn/ver/157/trunk/public/images/22x22/options.png
+END
+package.png
+K 25
+svn:wc:ra_dav:version-url
+V 55
+/svn/!svn/ver/164/trunk/public/images/22x22/package.png
+END
+tracker.png
+K 25
+svn:wc:ra_dav:version-url
+V 55
+/svn/!svn/ver/157/trunk/public/images/22x22/tracker.png
+END

data/lib/generators/admin_interface/templates/images/22x22/.svn/entries

@@ -0,0 +1,210 @@
+8
+
+dir
+2744
+http://redmine.rubyforge.org/svn/trunk/public/images/22x22
+http://redmine.rubyforge.org/svn
+
+
+
+2007-09-23T17:19:27.414302Z
+752
+jplang
+
+
+svn:special svn:externals svn:needs-lock
+
+
+
+
+
+
+
+
+
+
+
+e93f8b46-1217-0410-a6f0-8f06a7374b81
+
+plugin.png
+file
+
+
+
+
+2009-05-16T12:05:29.000000Z
+32ae7e9669b540005c55e2fd631ae82f
+2007-09-23T17:19:27.414302Z
+752
+jplang
+has-props
+
+file.png
+file
+
+
+
+
+2009-05-16T12:05:29.000000Z
+77b52b5eaca4d4d49c2e45e7bb4517ac
+2007-01-08T19:21:59.140156Z
+157
+jplang
+has-props
+
+settings.png
+file
+
+
+
+
+2009-05-16T12:05:29.000000Z
+be61e0c45535750b21d00fdc958384cf
+2007-01-21T11:50:22.864544Z
+167
+jplang
+has-props
+
+role.png
+file
+
+
+
+
+2009-05-16T12:05:29.000000Z
+8f90fc8e800d46206b3535c34909547a
+2007-01-08T19:21:59.140156Z
+157
+jplang
+has-props
+
+users.png
+file
+
+
+
+
+2009-05-16T12:05:29.000000Z
+ecd3405a134857f862a7728c1e37bcb0
+2007-01-08T19:21:59.140156Z
+157
+jplang
+has-props
+
+comment.png
+file
+
+
+
+
+2009-05-16T12:05:29.000000Z
+751aecd22b463fe4195dc0ca48b7f346
+2007-05-13T17:09:56.765659Z
+529
+jplang
+has-props
+
+authent.png
+file
+
+
+
+
+2009-05-16T12:05:29.000000Z
+044dc1865020a28ee079d589a56502f9
+2007-01-08T19:21:59.140156Z
+157
+jplang
+has-props
+
+notifications.png
+file
+
+
+
+
+2009-05-16T12:05:29.000000Z
+122667ef626bce599397e1dcc1f71ec7
+2007-01-08T19:21:59.140156Z
+157
+jplang
+has-props
+
+projects.png
+file
+
+
+
+
+2009-05-16T12:05:29.000000Z
+09496465ad3e12b20daf7755facbb76b
+2007-01-08T19:21:59.140156Z
+157
+jplang
+has-props
+
+workflow.png
+file
+
+
+
+
+2009-05-16T12:05:29.000000Z
+0153917416905d5bde62a73eb4c664db
+2007-01-08T19:21:59.140156Z
+157
+jplang
+has-props
+
+info.png
+file
+
+
+
+
+2009-05-16T12:05:29.000000Z
+e57082db2c35e65f200e2bc8a59bc58d
+2007-01-08T19:21:59.140156Z
+157
+jplang
+has-props
+
+options.png
+file
+
+
+
+
+2009-05-16T12:05:29.000000Z
+7aa134d4b5879703730cfd508407ddb2
+2007-01-08T19:21:59.140156Z
+157
+jplang
+has-props
+
+package.png
+file
+
+
+
+
+2009-05-16T12:05:29.000000Z
+17099a3ca91a9e1ed7eb96d009258990
+2007-01-15T20:14:06.587659Z
+164
+jplang
+has-props
+
+tracker.png
+file
+
+
+
+
+2009-05-16T12:05:29.000000Z
+f7bc5d71c8659e3f1154c6e479e78e10
+2007-01-08T19:21:59.140156Z
+157
+jplang
+has-props
+