easy_admin_ui 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.tmproj
+pkg

data/README

@@ -0,0 +1,104 @@
+Description
+===========
+
+A very simple admin UI. If you need something more fancy look at ActiveScaffold.
+
+Requirements
+============
+
+ * make_resourceful
+ * formtastic
+ * will_paginate
+ 
+Tested with Rails 2.3.8.
+
+To Do
+=====
+
+Some things are currently hardwired. It assumes you have your controllers below
+admin/. I.e. admin_users_path.
+
+Installation
+============
+
+ $ gem install easy_admin_ui
+ 
+To use the rake tasks add:
+
+ require 'easy_admin_ui/tasks'
+ 
+to your Rakefile.
+
+How to use
+==========
+
+In your controller:
+
+class Admin::UsersController < ActionController::Base
+  easy_admin :per_page => 50,
+    :order => 'created_at',
+    :page_title => 'Users',
+    :columns => ['Login', 'Email', 'Created'],
+    :show_actions => true,
+    :skip_new => true
+end
+
+The model is infered by the make_resourceful plugin which is why we don't need
+to specify it here. However, the object(s) returned will be named @item or
+@items (for :index).
+
+Then you need a partial below users/ named '_user.html.erb':
+
+<%=
+  table_row(:id => "tr_user_#{user.id}", :class => "#{cyc = cycle("even", "odd")}",
+    :cells => [
+      h(user.login),
+      h(user.email),
+      date_hm(user.created_at),
+    ],
+    :actions => [
+      admin_edit_link(user),
+      admin_delete_link_with_confirmation(user)
+    ])
+-%>
+
+Copy icons:
+
+ $ rake easy_admin_ui:copy_assets
+
+Manually copy the sample CSS.
+
+You need to provide the _form.html.erb partials yourself.
+
+You can always override the default templates by providing templates yourself.
+
+Callbacks
+=========
+
+Index page only:
+
+ _index_after_title.html.erb
+ _index_after_table.html.erb
+
+New/edit pages:
+
+ _modify_after_title.html.erb
+ _modify_after_form.html.erb
+
+If these exist the more specific partials below will not be rendered.
+
+Edit page only:
+
+ _edit_after_title.html.erb
+ _edit_after_form.html.erb
+
+New page only:
+
+ _new_after_title.html.erb
+ _new_after_form.html.erb
+
+Will be included on all actions no matter if other partials were present or
+not:
+
+ _after_title.html.erb
+ _after.html.erb

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name           = "easy_admin_ui"
+    gem.summary        = "Easy Admin UI."
+    gem.description    = "Very simple DRY admin UI."
+    gem.email          = "martin@wulffeld.org"
+    gem.homepage       = "http://github.com/wulffeld/easy_admin_ui"
+    gem.authors        = ["Martin Moen Wulffeld"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/assets/css/easy_admin_ui.css

@@ -0,0 +1,69 @@
+/* Copy this to your main CSS if you like. */
+
+/** easy start **/
+table.easy {
+	border-collapse: normal;
+	margin-top: 4px;
+}
+
+table.easy th,
+table.easy td {
+	font-family: "Helvetica Neue", Verdana, Arial, sans-serif;
+	font-size: 12px;
+	line-height: 14px;
+}
+
+table.easy td p {
+	margin: 0 0 10px 0;
+}
+
+table.easy th.wrap,
+table.easy td.wrap {
+	white-space: normal;
+}
+
+/* Header cells. */
+table.easy thead th {
+	background-color: #E6E6E6;
+	color: inherit;
+	border: 1px solid #FFF;
+	padding: 3px;
+}
+
+table.easy thead td.textright {
+	text-align: right;
+}
+
+/* Body cells. */
+table.easy tbody td.blank {
+	background-color: inherit;
+	color: inherit;
+	border: none;
+}
+
+table.easy tbody td {
+ 	background-color: #FFF;
+	color: #333;
+	width: auto;
+	border-top: 1px dotted #DDD;
+	padding: 4px 3px;
+}
+
+table.easy tbody td.act {
+  margin: 0;
+	padding-top: 2px;
+	padding-bottom: 0;
+	min-width: 150px;
+}
+
+table.easy th.date,
+table.easy td.date {
+  width: 80px;
+}
+
+table.easy th.datetime,
+table.easy td.datetime {
+  width: 110px;
+}
+
+/** easy end **/

data/easy_admin_ui.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{easy_admin_ui}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Moen Wulffeld"]
+  s.date = %q{2010-07-27}
+  s.description = %q{Very simple DRY admin UI.}
+  s.email = %q{martin@wulffeld.org}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "assets/css/easy_admin_ui.css",
+     "assets/icons/classify.png",
+     "assets/icons/connect.png",
+     "assets/icons/delete.png",
+     "assets/icons/disconnect.png",
+     "assets/icons/pencil.png",
+     "assets/icons/show.png",
+     "easy_admin_ui.gemspec",
+     "lib/easy_admin_ui.rb",
+     "lib/easy_admin_ui/core_ext.rb",
+     "lib/easy_admin_ui/tasks.rb",
+     "lib/easy_admin_ui/view_helpers.rb",
+     "tasks/easy_admin_ui.rake",
+     "templates/easy_admin_ui/edit.html.erb",
+     "templates/easy_admin_ui/index.html.erb",
+     "templates/easy_admin_ui/new.html.erb"
+  ]
+  s.homepage = %q{http://github.com/wulffeld/easy_admin_ui}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Easy Admin UI.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/easy_admin_ui/core_ext.rb

@@ -0,0 +1,93 @@
+module EasyAdminUi
+  module CoreExt
+    def self.included(base)
+      base.extend ClassMethods
+    end
+  
+    module ClassMethods
+      attr_accessor :options
+    
+      def easy_admin(options = {})
+        @options = options
+
+        make_resourceful do
+          actions :all
+    
+          response_for :index do |format|
+            format.html do
+              @options = options
+              override = File.join('app/views', self.controller_path, 'index.html.erb')
+              if File.exists?(override)
+                render :template => override
+              else
+                render :template => 'easy_admin_ui/index'
+              end
+            end
+          end
+
+          response_for :show do |format|
+            format.html { redirect_to :action => 'index' }
+          end
+
+          [:new, :create_fails].each do |new_action|
+            response_for new_action do |format|
+              format.html do
+                override = File.join(controller_full_path, 'new.html.erb')
+                if File.exists?(override)
+                  render :template => override
+                else
+                  render :template => 'easy_admin_ui/new'
+                end
+              end
+            end
+          end
+
+          [:edit, :update_fails].each do |edit_action|
+            response_for edit_action do |format|
+              format.html do
+                override = File.join(controller_full_path, 'edit.html.erb')
+                if File.exists?(override)
+                  render :template => override
+                else
+                  render :template => 'easy_admin_ui/edit'
+                end
+              end
+            end
+          end
+
+          response_for :destroy do |format|
+            format.js do
+              render :update do |page|
+                page.remove "tr_#{current_model_name.underscore}_#{@item.id}"
+              end
+            end
+          end
+        end
+
+        class_eval do
+          def options
+            self.class.options
+          end
+
+          def current_objects
+            @items = current_model.paginate(:page => params[:page], :per_page => options[:per_page], :order => options[:order])
+          end
+
+          def current_object
+            @item ||= current_model.find(params[:id]) if params[:id]
+            @item ||= current_model.new(params[current_model_name.underscore.to_sym])
+          end
+
+          def instance_variable_name
+            'item'
+          end
+
+          helper_method :controller_full_path
+          def controller_full_path
+            File.join 'app/views', self.controller_path
+          end
+        end
+      end
+    end
+  end
+end

data/lib/easy_admin_ui/tasks.rb

@@ -0,0 +1,11 @@
+# require 'easy_admin_ui/tasks' in your Rakefile.
+
+namespace :easy_admin_ui do
+  desc "Copies assets to public/images/icons/"
+  task :copy_assets do
+    FileUtils.mkdir_p "#{RAILS_ROOT}/public/images/icons/"
+      
+    Dir.chdir(File.dirname(__FILE__) + '/../assets/')
+    FileUtils.cp_r(Dir.glob('icons/*.*'), "#{RAILS_ROOT}/public/images/icons/", :verbose => true)
+  end
+end

data/lib/easy_admin_ui/view_helpers.rb

@@ -0,0 +1,86 @@
+module EasyAdminUi
+  module ViewHelpers
+    def wpaginate(collection)
+      will_paginate(collection, :previous_label => t('will_paginate.previous'), :next_label => t('will_paginate.next'))
+    end
+
+    def table_head(titles, actions, options = {:class => "easy"})
+      concat("<table class='#{options[:class]}' id='#{options[:id]}'>" +
+        content_tag(:thead,
+          content_tag(:tr, (
+              titles.map do |title, th_class|
+                th_class ||= []
+                content_tag(:th,
+                  [
+                    if th_class.include?('sortable')
+                      content_tag(:div,
+                        link_to('', '#', :class => 'sort_up') +
+                        link_to('', '#', :class => 'sort_down'),
+                        :class => 'sort')
+                    else
+                      nil
+                    end,
+                    title
+                  ].compact.join(''),
+                  :class => th_class)
+              end
+            ).join('') + (actions ? content_tag(:th, '', :class => 'actions') : '')
+          )
+        )
+      )
+      options[:body_id] ? concat("<tbody id=\"#{options[:body_id]}\">") : concat('<tbody>')
+      yield
+      concat('</tbody></table>')
+    end
+
+    def table_row(options = {})
+      options[:actions] ||= []
+
+      content_tag(:tr,
+        [
+          # Could pass:
+          #
+          # [category.created_at, {:class => '', :onmouseover => "javascript: blah"}]
+          # [category.created_at, 'my_class_name']
+          #
+          options[:cells].map do |txt, cell_opts|
+            cell_opts = {:class => cell_opts} if cell_opts.is_a?(String)
+            cell_opts ||= {}
+            content_tag(:td, txt, cell_opts)
+          end,
+          options[:actions].blank? ? '' : content_tag(:td, options[:actions].join(' '), :class => "act")
+        ].join(' '),
+        :id => options[:id], :class => ["#{cyc = cycle("even", "odd")}", options[:class]].join(' '))
+    end
+
+    def right_align(content)
+      [content, 'aright']
+    end
+
+    def admin_show_link(item)
+      link_to(image_tag("/images/icons/show.png"), :action => 'show', :id => item)
+    end
+
+    def admin_new_link
+      content_tag(:span, ' - ' + link_to('New', :action => 'new'))
+    end
+
+    def admin_edit_link(item)
+      link_to(image_tag("/images/icons/pencil.png"), :action => 'edit', :id => item)
+    end
+
+    # Use if below /admin/.
+    def admin_delete_link_with_confirmation(obj, delete_path=nil)
+      delete_path ||= eval("admin_#{obj.class.to_s.underscore}_path(obj)")
+      delete_link_with_confirmation(obj, delete_path)
+    end
+
+    def delete_link_with_confirmation(obj, delete_path=nil)
+      delete_path ||= eval("#{obj.class.to_s.underscore.singularize}_path(obj)")
+      link_to_function(image_tag('/images/icons/delete.png'), "$('cnf_#{obj.id}').show();") + ' ' +
+        raw('<span id="cnf_' + obj.id.to_s + '" class="conf_link" style="display: none;">Are you sure? ') +
+        link_to_remote("Yes", :url => delete_path, :method => :delete) + ' ' +
+        link_to_function("No", "$('cnf_#{obj.id}').hide();") + raw('</span>')
+    end
+  end
+end

data/lib/easy_admin_ui.rb

@@ -0,0 +1,12 @@
+require 'easy_admin_ui/core_ext'
+require 'easy_admin_ui/view_helpers'
+
+ActionController::Base.view_paths = ["app/views", File.dirname(__FILE__) + "/../templates"]
+
+ActionController::Base.class_eval do
+  include EasyAdminUi::CoreExt
+end
+
+ActionView::Base.class_eval do
+  include EasyAdminUi::ViewHelpers
+end

data/tasks/easy_admin_ui.rake

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'easy_admin_ui/tasks'

data/templates/easy_admin_ui/edit.html.erb

@@ -0,0 +1,30 @@
+<h1>Editing <%= @item.class.to_s.tableize.singularize.humanize %></h1>
+
+<% if File.exists?(File.join(controller_full_path, '_modify_after_title.html.erb')) -%>
+  <%= render :partial => 'modify_after_title' %>
+<% elsif File.exists?(File.join(controller_full_path, '_edit_after_title.html.erb')) -%>
+  <%= render :partial => 'edit_after_title' %>
+<% end -%>
+
+<% if File.exists?(File.join(controller_full_path, '_after_title.html.erb')) -%>
+  <%= render :partial => 'after_title' %>
+<% end -%>
+
+<% semantic_form_for(@item, :url => eval("admin_#{@item.class.to_s.underscore}_path(@item)"), :html => { :multipart => true }) do |f| %>
+  <% f.inputs do %>
+    <%= render :partial => 'form', :locals => {:f => f} %>
+  <% end -%>
+  <% f.buttons do %>
+    <%= f.commit_button 'Submit' %>
+  <% end -%>
+<% end -%>
+
+<% if File.exists?(File.join(controller_full_path, '_modify_after_form.html.erb')) -%>
+  <%= render :partial => 'modify_after_form' %>
+<% elsif File.exists?(File.join(controller_full_path, '_edit_after_form.html.erb')) -%>
+  <%= render :partial => 'edit_after_form' %>
+<% end -%>
+
+<% if File.exists?(File.join(controller_full_path, '_after_form.html.erb')) -%>
+  <%= render :partial => 'after_form' %>
+<% end -%>

data/templates/easy_admin_ui/index.html.erb

@@ -0,0 +1,21 @@
+<h1><%= @options[:page_title] %> <%= admin_new_link unless @options[:skip_new] %></h1>
+
+<% if File.exists?(File.join(controller_full_path, '_index_after_title.html.erb')) -%>
+  <%= render :partial => 'index_after_title' %>
+<% elsif File.exists?(File.join(controller_full_path, '_after_title.html.erb')) -%>
+  <%= render :partial => 'after_title' %>
+<% end -%>
+
+<%= wpaginate @items if @items.respond_to?(:total_pages) %>
+
+<% table_head(@options[:columns], @options[:actions]) do %>
+  <%= render @items %>
+<% end -%>
+
+<%= wpaginate @items if @items.respond_to?(:total_pages) %>
+
+<% if File.exists?(File.join(controller_full_path, '_index_after_table.html.erb')) -%>
+  <%= render :partial => 'index_after_table' %>
+<% elsif File.exists?(File.join(controller_full_path, '_after_table.html.erb')) -%>
+  <%= render :partial => 'after_table' %>
+<% end -%>

data/templates/easy_admin_ui/new.html.erb

@@ -0,0 +1,30 @@
+<h1>New <%= @item.class.to_s.tableize.singularize.humanize %></h1>
+
+<% if File.exists?(File.join(controller_full_path, '_modify_after_title.html.erb')) -%>
+  <%= render :partial => 'modify_after_title' %>
+<% elsif File.exists?(File.join(controller_full_path, '_new_after_title.html.erb')) -%>
+  <%= render :partial => 'new_after_title' %>
+<% end -%>
+
+<% if File.exists?(File.join(controller_full_path, '_after_title.html.erb')) -%>
+  <%= render :partial => 'after_title' %>
+<% end -%>
+
+<% semantic_form_for(@item, :url => eval("admin_#{@item.class.to_s.underscore.pluralize}_path"), :html => { :multipart => true }) do |f| %>
+  <% f.inputs do %>
+    <%= render :partial => 'form', :locals => {:f => f} %>
+  <% end -%>
+  <% f.buttons do %>
+    <%= f.commit_button 'Submit' %>
+  <% end -%>
+<% end -%>
+
+<% if File.exists?(File.join(controller_full_path, '_modify_after_form.html.erb')) -%>
+  <%= render :partial => 'modify_after_form' %>
+<% elsif File.exists?(File.join(controller_full_path, '_new_after_form.html.erb')) -%>
+  <%= render :partial => 'new_after_form' %>
+<% end -%>
+
+<% if File.exists?(File.join(controller_full_path, '_after_form.html.erb')) -%>
+  <%= render :partial => 'after_form' %>
+<% end -%>

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: easy_admin_ui
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Martin Moen Wulffeld
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-27 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Very simple DRY admin UI.
+email: martin@wulffeld.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- README
+- Rakefile
+- VERSION
+- assets/css/easy_admin_ui.css
+- assets/icons/classify.png
+- assets/icons/connect.png
+- assets/icons/delete.png
+- assets/icons/disconnect.png
+- assets/icons/pencil.png
+- assets/icons/show.png
+- easy_admin_ui.gemspec
+- lib/easy_admin_ui.rb
+- lib/easy_admin_ui/core_ext.rb
+- lib/easy_admin_ui/tasks.rb
+- lib/easy_admin_ui/view_helpers.rb
+- tasks/easy_admin_ui.rake
+- templates/easy_admin_ui/edit.html.erb
+- templates/easy_admin_ui/index.html.erb
+- templates/easy_admin_ui/new.html.erb
+has_rdoc: true
+homepage: http://github.com/wulffeld/easy_admin_ui
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Easy Admin UI.
+test_files: []
+