admin_interface 1.0.0 → 1.2.0

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.rdoc

@@ -16,6 +16,12 @@ Add following to your Gemfile
     gem 'admin_interface'
   end
 
+AdminInterface uses several gems. So put these in your Gemfile
+
+  gem 'inherited_resources'
+  gem 'meta_search'
+  gem 'kaminari'
+
 Or install as plugin from Github.
 
   rails plugin install git://github.com/joost/admin_interface.git
@@ -38,7 +44,7 @@ Next, add following routes to config/routes.rb.
     root :to => 'base#index'
     # Add the following after you've used the admin_scaffold generator
     resources :model do
-      delete 'delete_all', :on => :collection
+      delete 'destroy_all', :on => :collection
     end
   end
 
@@ -71,14 +77,17 @@ 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)
+Add this to a initializer or in 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>"
+    "<span class='field_with_errors'>#{html_tag}</span>".html_safe
   end
 
+Note that this might affect the rest of your application. A different solution is
+welcome!
+
 == Kudos
 
 Kudos, credits or whatever you like more go to:

data/admin_interface.gemspec

@@ -2,16 +2,21 @@
 $:.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']
+Gem::Specification.new do |spec|
+  spec.name = "admin_interface"
+  spec.version = '1.2.0'
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "A Rails admin interface generator. Theme stolen from Redmine."
+  spec.email = "joost@joopp.com"
+  spec.homepage = "http://github.com/joost/admin_interface"
+  spec.description = "A Rails admin interface generator. Theme stolen from Redmine. Similar to web-app-theme but better ;)."
+  spec.authors = ['Joost Hietbrink']
 
-  s.files = `git ls-files`.split("\n")
-  s.require_paths = ["lib"]
+  # kaminari (pagination), meta_search (search), inherited_resources (coolness)
+  spec.add_dependency('kaminari', '>= 0.12.4')
+  spec.add_dependency('meta_search', '>= 1.1.0.pre2')
+  spec.add_dependency('inherited_resources', '>= 1.2.2')
+
+  spec.files = `git ls-files`.split("\n")
+  spec.require_paths = ["lib"]
 end

data/lib/admin_interface.rb

@@ -0,0 +1,7 @@
+# Configure Rails 3.1 to include assets.
+module AdminInterface
+
+  class Engine < ::Rails::Engine
+  end
+
+end

data/lib/generators/admin_interface/admin_interface_generator.rb

@@ -2,12 +2,12 @@ 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_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")
@@ -16,24 +16,29 @@ class AdminInterfaceGenerator < Rails::Generators::Base
 
   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")
+    copy_file("views/index.html.erb", "app/views/admin/base/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_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")
+    copy_file("helpers/admin/base_helper.rb", "app/helpers/admin/base_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 add_admin_route
+    route "namespace :admin do"
+    route "  root :to => 'base#index"
+    route "  # resources :some_model do"
+    route "  #   delete 'delete_all', :on => :collection"
+    route "  # end"
+    route "end"
+  end
 
   def show_readme
     readme("INSTALL")

data/lib/generators/admin_interface/templates/INSTALL

@@ -1,10 +1 @@
-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.
+See the README file on what to add to your routes.rb file!

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

@@ -1,92 +1,27 @@
 class Admin::ResourceController < Admin::BaseController
 
-  before_filter :filter_load_resources, :only => [:index]
-  before_filter :filter_load_resource, :only => [:show, :edit, :update, :destroy]
+  inherit_resources # gem
+  defaults :route_prefix => 'admin'
 
-  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
+  # inherited_resources options
+  # nested_belongs_to :user, :optional => true
 
   def destroy_all
     destroyed_resources = resource_class.destroy_all(:id => params[:ids])
     flash[:notice] = "#{destroyed_resources.size} objects destroyed."
-    redirect_to :action => :index
+    redirect_to :back
   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]
+  # Overwrites inherited_resources gem version.
+  # Use meta_search and kaminari gem to load collection
+  def collection
+    @search ||= end_of_association_chain.search(params[:search])
+    get_collection_ivar || begin
+      c = @search.page(params[:page]).per(params[:per])
+      set_collection_ivar(c.respond_to?(:scoped) ? c.scoped : c)
+    end
   end
 
 end

data/lib/generators/admin_interface/templates/helpers/admin/base_helper.rb

@@ -0,0 +1,77 @@
+module Admin::BaseHelper
+
+# Following methods are ripped from RedMine but very nice!
+
+  # Overwrites content_for helper to set has_content?.
+  def content_for(name, content = nil, &block)
+    @has_content ||= {}
+    @has_content[name] = true
+    super(name, content, &block)
+  end
+
+  # Returns if we have content for a specific yield.
+  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
+
+# Following are other helper methods.
+
+  def true_false_image(boolean)
+    raise ArgumentError, "Expected a Boolean as argument!" unless boolean.is_a?(FalseClass) || boolean.is_a?(TrueClass)
+    image_tag("admin/#{boolean}.png")
+  end
+
+  # Overwrites l helper.
+  # Make the I18n localize method work with nil dates!
+  # Attribute must be Date, DateTime or Time object or nil :)
+  # Returns '' if attribute is nil.
+  def l(time)
+    time.nil? ? '' : I18n.l(time)
+  end
+
+# Following are extra helper for kaminari gem (pagination).
+# It shows similar to Redmine.
+
+  # Shows paginate, paginate_info and perinate.
+  # Like: '1 2 3 4 5 ... Next › Last » (1-25/4028) | Per page: 25, 50, 100'
+  def navigate(collection)
+    return if collection.blank?
+    html = paginate(collection) + paginate_info(collection) + ' | ' + perinate(collection)
+    content_tag(:div, html.html_safe, :class => 'navigation').html_safe
+  end
+
+  # Shows pagination info like '(51-75/815)'.
+  # Uses I18n 'en.views.pagination_info' translation key.
+  def paginate_info(collection)
+    return if collection.blank?
+    first = collection.offset_value + 1
+    last = [collection.offset_value + collection.limit_value, collection.total_count].min
+    total = collection.total_count
+    html = I18n.t('views.pagination_info', :default => "(%{first}-%{last}/%{total})", :first => first, :last => last, :total => total)
+    content_tag(:nav, html.html_safe, :class => 'pagination info').html_safe
+  end
+
+  # Shows a 'Per page: 25 50 100'.
+  # Uses I18n 'en.views.perinate' translation key.
+  def perinate(collection, options = {})
+    return if collection.blank?
+    options.reverse_merge!(:values => [25, 50, 100])
+    page = (collection.offset_value / collection.limit_value).to_i + 1
+    html = I18n.t('views.perinate', :default => "Per page: ")
+    html += options[:values].collect do |value|
+      page = (collection.offset_value / value).to_i + 1 # This makes sure we always show the same first entry
+      link_to_if(value != collection.limit_value, value, params.merge(:per => value, :page => page))
+    end.join(', ')
+    content_tag(:nav, html.html_safe, :class => 'perination').html_safe
+  end
+
+end

data/lib/generators/admin_interface/templates/views/layout.html.erb

@@ -4,9 +4,8 @@
   <head>
     <meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
     <title>Admin</title>
-    <%= stylesheet_link_tag('admin') %>
-    <%= javascript_include_tag :defaults %>
-    <%= javascript_include_tag 'jquery.admin.js' %>
+    <%= stylesheet_link_tag 'admin' %>
+    <%= javascript_include_tag :application, 'jquery.admin.js' %>
     <%= csrf_meta_tag %> 
   </head>
   <body>
@@ -24,9 +23,9 @@
         <div id="main-menu">
           <div class="tabs" id="admin_tabnav">
             <ul>
-              <%= content_tag(:li, link_to('Overview', '/admin', :class => ((controller_name == 'admin') ? 'selected' : ''))) %>
+              <%= content_tag(:li, link_to('Overview', '/admin', :class => ((controller_name == 'base') ? 'selected' : ''))) %>
               <% Admin::BaseController.tabs.each do |tab| %>
-                <%= content_tag(:li, link_to(tab.humanize, {:controller => "admin/#{tab}"}, :class => ((controller_name == tab) ? 'active' : ''))) %>
+                <%= content_tag(:li, link_to(tab.humanize, [:admin, tab], :class => ((controller_name == tab) ? 'selected' : ''))) %>
               <% end %>
             </ul>
           </div>

data/lib/generators/admin_scaffold/admin_scaffold_generator.rb

@@ -20,6 +20,15 @@ class AdminScaffoldGenerator < Rails::Generators::NamedBase
   alias_method  :controller_file_name,  :controller_file_name
   alias_method  :controller_table_name, :controller_plural_name
 
+  def check_class_collisions # TODO
+    # Check for class naming collisions.
+    # class_collisions class_path, "Admin::#{class_name}Controller"
+  end
+
+  def copy_controller_files
+    template 'controller.rb', File.join(CONTROLLER_PATH, class_path, "#{controller_file_name}_controller.rb")
+  end
+
   def create_admin_scaffold
     @name = file_name
     

data/lib/generators/admin_scaffold/templates/INSTALL

@@ -1,8 +1 @@
-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
-
+See the README file on what to add to your routes.rb file!

data/lib/generators/admin_scaffold/templates/view_index.html.erb

@@ -1,8 +1,20 @@
 <div class="contextual">
   <%%= link_to 'New <%= singular_name %>', new_admin_<%= singular_name %>_path, :class => 'icon icon-add' %>
+  | <%%= form_for @search, :url => collection_url do |f| %>
+      <%%
+        # Check https://github.com/ernie/meta_search for options.
+        # Simply change :id_equals into :name_contains, etc.
+      %>
+      <%%= f.text_field :id_equals, :placeholder => 'Search by ID' %>
+    <%% end %>
 </div>
 
-<h2><%= plural_name.humanize %></h2>
+<h2>
+  <%= # FIXME: parent? doesn't always work :S
+    link_to(parent.to_s, [:admin, parent]) + " &gt;".html_safe if defined?(parent) && parent?
+   %>
+  <%= plural_name.humanize %>
+</h2>
 
 <%% if @<%= plural_name %>.blank? %>
   <p class="nodata">No data to display</p>
@@ -12,11 +24,7 @@
     <tr>
       <th class="checkbox"><%%= image_tag "admin/true.png" %></th>
   <% for attribute in attributes -%>
-    <% if defined?(Searchlogic) -%>
-      <th><%%= order(@search, {:by => :<%= attribute.name %>}) %></th>
-    <% else -%>
-      <th><%= attribute.human_name %></th>
-    <% end -%>
+      <th><%%= sort_link(@search, :<%= attribute.name %>) %></th>
   <% end -%>
       <th></th>
     </tr>
@@ -50,10 +58,4 @@
 <%% end %>
 </table>
 <%% end %>
-<%
-  # Remove unneeded stuff here
-  if defined?(Searchlogic) || defined?(WillPaginate)
-    # If you have WillPaginate installed (you should!)
- %>
-    <%%= will_paginate(@<%= plural_name %>) %>
-<% end %>
+<%%= navigate(@<%= plural_name %>) %>