overlook 0.0.1

data/app/assets/stylesheets/admin.css

@@ -0,0 +1,12 @@
+/*
+ *= require admin/bootstrap
+ *= require_self
+*/
+
+body { padding-top: 60px; }
+div.sidebar { padding: 8px 0; }
+td.options div.btn-group { width: 110px; }
+table.table td { vertical-align: middle; }
+td.center { text-align: center; }
+td.right { text-align: right; }
+

data/app/controllers/admin/application_controller.rb

@@ -0,0 +1,3 @@
+class Admin::ApplicationController < ApplicationController
+  layout 'admin'
+end

data/app/controllers/admin/articles_controller.rb

@@ -0,0 +1,82 @@
+require 'csv'
+
+class Admin::ArticlesController < Admin::ApplicationController
+  # filters
+  before_filter :load_article, only: [:show, :edit, :update, :destroy]
+  
+  # index
+  def index
+    @articles = Article.search(params[:q]).sorty(params)
+    
+    respond_to do |format|
+      format.html do
+        @articles = @articles.page(params[:page])
+      end
+      
+      format.csv do
+        data = CSV.generate do |csv|
+          columns = Article.columns.map(&:name)
+          csv << columns.map(&:titleize)
+          
+          @articles.map do |article|
+            csv << columns.map{|c| article.send(c)}
+          end
+        end
+        
+        filename = "articles-#{Time.now.strftime('%d-%m-%Y')}.csv"
+        send_data(data, filename: filename, type: 'text/csv')
+      end
+    end
+  end
+  
+  # show
+  def show
+    
+  end
+  
+  # new
+  def new
+    @article = Article.new
+  end
+  
+  # create
+  def create
+    @article = Article.new(params[:article])
+    
+    if @article.save
+      redirect_to admin_articles_url, notice: "Article has been created"
+    else
+      render :new
+    end
+  end
+  
+  # edit
+  def edit
+    
+  end
+  
+  # update
+  def update
+    if @article.update_attributes(params[:article])
+      redirect_to admin_articles_url, notice: "Article has been updated"
+    else
+      render :edit
+    end
+  end
+  
+  # destroy
+  def destroy
+    @article.destroy
+    
+    respond_to do |format|
+      format.html { redirect_to :back, notice: "Article has been deleted" }
+      format.js
+    end
+  end
+  
+  protected
+  
+  def load_article
+    @article = Article.find(params[:id])
+  end
+end

data/app/controllers/admin/users_controller.rb

@@ -0,0 +1,76 @@
+require 'csv'
+
+class Admin::UsersController < Admin::ApplicationController
+  # filters
+  before_filter :load_user, only: [:edit, :update, :destroy]
+  
+  # index
+  def index
+    @users = User.search(params[:q]).sorty(params)
+    
+    respond_to do |format|
+      format.html do
+        @users = @users.page(params[:page])
+      end
+      format.csv do
+        data = CSV.generate do |csv|
+          columns = User.columns.map(&:name)
+          csv << columns.map(&:titleize)
+          
+          @users.map do |user|
+            csv << columns.map{|c| user.send(c)}
+          end
+        end
+        
+        filename = "users-#{Time.now.strftime('%d-%m-%Y')}.csv"
+        send_data(data, filename: filename, type: 'text/csv')
+      end
+    end
+  end
+  
+  # new
+  def new
+    @user = User.new
+  end
+  
+  # create
+  def create
+    @user = User.new(params[:user])
+    
+    if @user.save
+      redirect_to admin_users_url, notice: "User has been created"
+    else
+      render :new
+    end
+  end
+  
+  # edit
+  def edit
+    
+  end
+  
+  # update
+  def update
+    if @user.update_attributes(params[:user])
+      redirect_to admin_users_url, notice: "User has been updated"
+    else
+      render :edit
+    end
+  end
+  
+  # destroy
+  def destroy
+    @user.destroy
+    
+    respond_to do |format|
+      format.html { redirect_to :back, notice: "User has been deleted" }
+      format.js
+    end
+  end
+  
+  protected
+  
+  def load_user
+    @user = User.find(params[:id])
+  end
+end

data/app/helpers/admin/application_helper.rb

@@ -0,0 +1,26 @@
+module Admin::ApplicationHelper 
+  def flash_messages
+    classes = { notice: 'success', warning: 'warning', error: 'error' }
+    
+    output = flash.map do |name, message|
+      if message.present?
+        class_name = ['alert', "alert-#{classes[name]}"].join(' ')
+        message << '<a class="close" data-dismiss="alert">&times;</a>'
+        
+        content_tag(:div, class: 'span12') do
+          content_tag(:div, raw(message), class: class_name)
+        end
+      end
+    end
+    
+    raw(output.join)
+  end
+  
+  def nav(name)
+    class_name = params[:controller].eql?("admin/#{name}") ? 'active' : nil
+    
+    content_tag(:li, class: class_name) do
+      link_to(name.to_s.titleize, "/admin/#{name}")
+    end
+  end
+end

data/app/views/kaminari/admin/_gap.html.erb

@@ -0,0 +1,8 @@
+<%# Non-link tag that stands for skipped pages...
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<li class="disabled"><a href="#"><%= raw(t 'views.pagination.truncate') %></a></li>

data/app/views/kaminari/admin/_next_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "Next" page
+  - available local variables
+    url:           url to the next page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<li class="<%= 'disabled' if current_page.last? %>">
+  <%= link_to raw("&raquo;"), url, :rel => 'next', :remote => remote %>
+</li>

data/app/views/kaminari/admin/_page.html.erb

@@ -0,0 +1,12 @@
+<%# Link showing page number
+  - available local variables
+    page:          a page object for "this" page
+    url:           url to this page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<li class="<%= 'active' if page.current? %>">
+  <%= link_to page, url, opts = { :remote => remote, :rel => page.next? ? 'next' : page.prev? ? 'prev' : nil} %>
+</li>

data/app/views/kaminari/admin/_paginator.html.erb

@@ -0,0 +1,23 @@
+<%# The container tag
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+    paginator:     the paginator that renders the pagination tags inside
+-%>
+<%= paginator.render do -%>
+  <div class="pagination pagination-centered">
+    <ul>
+      <%= prev_page_tag unless current_page.first? %>
+      <% each_page do |page| -%>
+        <% if page.left_outer? || page.right_outer? || page.inside_window? -%>
+          <%= page_tag page %>
+        <% elsif !page.was_truncated? -%>
+          <%= gap_tag %>
+        <% end -%>
+      <% end -%>
+      <%= next_page_tag unless current_page.last? %>
+    </ul>
+  </div>
+<% end -%>

data/app/views/kaminari/admin/_prev_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "Previous" page
+  - available local variables
+    url:           url to the previous page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<li class="<%= 'disabled' if current_page.first? %>">
+  <%= link_to raw("&laquo;"), url, :rel => 'prev', :remote => remote %>
+</li>

data/app/views/layouts/admin.html.erb

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title><%= @page_title || 'Admin' %></title>
+    <%= stylesheet_link_tag "admin", media: "all" %>
+    <%= csrf_meta_tags %>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  </head>
+  <body>
+    <div class="navbar navbar-fixed-top">
+      <div class="navbar-inner">
+        <div class="container">
+          <a class="brand" href="/admin">Admin</a>
+          <ul class="nav">
+            <%= nav(:users) %>
+            <%= nav(:articles) %>
+          </ul>
+        </div>
+      </div>
+    </div>
+    <div class="container">
+      <div class="row">
+        <%= flash_messages %>
+        <%= yield %>
+      </div>
+    </div>
+    <%= javascript_include_tag "admin" %>
+  </body>
+</html>

data/lib/generators/overlook/admin/admin_generator.rb

@@ -0,0 +1,60 @@
+module Overlook
+  class AdminGenerator < Rails::Generators::NamedBase
+    # source
+    source_root File.expand_path('../templates', __FILE__)
+  
+    def add_route
+      inject_into_file 'config/routes.rb', "\n    resources :#{table_name}", {
+        after: /namespace :admin do$/
+      }
+    end
+  
+    def add_navigation
+      inject_into_file 'app/views/layouts/admin.html.erb', "\n            <%= nav(:#{table_name}) %>", {
+        after: /<ul class="nav">/
+      }
+    end
+  
+    def copy_controller_file
+      template "controller.rb", "app/controllers/admin/#{plural_file_name}_controller.rb"
+    end
+  
+    def copy_view_files
+      template "index.html.erb", "app/views/admin/#{plural_file_name}/index.html.erb"
+      template "show.html.erb", "app/views/admin/#{plural_file_name}/show.html.erb"
+      template "new.html.erb", "app/views/admin/#{plural_file_name}/new.html.erb"
+      template "edit.html.erb", "app/views/admin/#{plural_file_name}/edit.html.erb"
+      template "form.html.erb", "app/views/admin/#{plural_file_name}/_form.html.erb"
+      template "partial.html.erb", "app/views/admin/#{plural_file_name}/_#{file_name}.html.erb"
+      template "sidebar.html.erb", "app/views/admin/#{plural_file_name}/_sidebar.html.erb"
+      template "breadcrumb.html.erb", "app/views/admin/#{plural_file_name}/_breadcrumb.html.erb"
+      template "destroy.js.erb", "app/views/admin/#{plural_file_name}/destroy.js.erb"
+    end
+  
+    protected
+  
+    def name_attribute(klass)
+      klass = klass.new
+  
+      methods = %w[title name subject login user_name screen_name first_name id].map do |attribute|
+        klass.respond_to?(attribute) ? attribute : nil
+      end
+    
+      methods.compact.first
+    end
+  
+    def listing_columns
+      self.columns.select do |column|
+        ![:text].include?(column.type)
+      end
+    end
+  
+    def columns
+      columns = class_name.constantize.columns
+    
+      columns.select do |column|
+        !column.name[/^id$/]
+      end
+    end
+  end
+end

data/lib/generators/overlook/admin/templates/breadcrumb.html.erb

@@ -0,0 +1,14 @@
+<ul class="breadcrumb">
+  <li><a href="/admin">Admin</a> <span class="divider">/</span></li>
+  <%% if params[:action] != 'index' %>
+    <%% if params[:action] == 'show' %>
+      <li><a href="/admin/<%= table_name %>"><%= plural_name.titleize %></a> <span class="divider">/</span></li>
+      <li class="active"><%%= @<%= file_name %>.<%= name_attribute(class_name.constantize) %> %></li>
+    <%% else %>
+      <li><a href="/admin/<%= table_name %>"><%= plural_name.titleize %></a> <span class="divider">/</span></li>
+      <li class="active"><%%= params[:action].titleize %></li>
+    <%% end %>
+  <%% else %>
+    <li class="active"><%= plural_name.titleize %></li>
+  <%% end %>
+</ul>

data/lib/generators/overlook/admin/templates/controller.rb

@@ -0,0 +1,82 @@
+require 'csv'
+
+class Admin::<%= class_name.pluralize %>Controller < Admin::ApplicationController
+  # filters
+  before_filter :load_<%= file_name %>, only: [:show, :edit, :update, :destroy]
+  
+  # index
+  def index
+    @<%= table_name %> = <%= class_name %>.search(params[:q]).sorty(params)
+    
+    respond_to do |format|
+      format.html do
+        @<%= table_name %> = @<%= table_name %>.page(params[:page])
+      end
+      
+      format.csv do
+        data = CSV.generate do |csv|
+          columns = <%= class_name %>.columns.map(&:name)
+          csv << columns.map(&:titleize)
+          
+          @<%= table_name %>.map do |<%= file_name %>|
+            csv << columns.map{|c| <%= file_name %>.send(c)}
+          end
+        end
+        
+        filename = "<%= table_name %>-#{Time.now.strftime('%d-%m-%Y')}.csv"
+        send_data(data, filename: filename, type: 'text/csv')
+      end
+    end
+  end
+  
+  # show
+  def show
+    
+  end
+  
+  # new
+  def new
+    @<%= file_name %> = <%= class_name %>.new
+  end
+  
+  # create
+  def create
+    @<%= file_name %> = <%= class_name %>.new(params[:<%= file_name %>])
+    
+    if @<%= file_name %>.save
+      redirect_to admin_<%= table_name %>_url, notice: "<%= human_name %> has been created"
+    else
+      render :new
+    end
+  end
+  
+  # edit
+  def edit
+    
+  end
+  
+  # update
+  def update
+    if @<%= file_name %>.update_attributes(params[:<%= file_name %>])
+      redirect_to admin_<%= table_name %>_url, notice: "<%= human_name %> has been updated"
+    else
+      render :edit
+    end
+  end
+  
+  # destroy
+  def destroy
+    @<%= file_name %>.destroy
+    
+    respond_to do |format|
+      format.html { redirect_to :back, notice: "<%= human_name %> has been deleted" }
+      format.js
+    end
+  end
+  
+  protected
+  
+  def load_<%= file_name %>
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+  end
+end

data/lib/generators/overlook/admin/templates/destroy.js.erb

@@ -0,0 +1 @@
+$('#<%%= dom_id(@<%= file_name %>)%>').remove();

data/lib/generators/overlook/admin/templates/edit.html.erb

@@ -0,0 +1,12 @@
+<%% @page_title = 'Edit <%= singular_name.titleize %>' %>
+
+<div class="span9">
+  <%%= render 'breadcrumb' %>
+  <div class="page-header">
+    <h2>Edit <%= singular_name.titleize %></h2>
+  </div>
+  <%%= render 'form' %>
+</div>
+<div class="span3">
+  <%%= render 'sidebar' %>
+</div>

data/lib/generators/overlook/admin/templates/form.html.erb

@@ -0,0 +1,21 @@
+<%%= simple_form_for([:admin, @<%= file_name %>], html: { multipart: true, class: 'form-horizontal' }) do |f| %>
+<% columns.each do |column| -%>
+<% if column.type == :text -%>
+  <%%= f.input :<%= column.name %>, as: :text, input_html: { rows: 10, columns: 100, class: 'span6' } %>
+<% elsif [:string].include?(column.type) -%>
+  <%%= f.input :<%= column.name %>, as: :<%= column.type %>, input_html: { class: 'span4' } %>
+<% elsif (association = column.name[/^(.*)_id$/, 1]) -%>
+  <%%= f.association :<%= association %>, input_html: { class: 'span2' } %>
+<% elsif [:integer].include?(column.type) -%>
+  <%%= f.input :<%= column.name %>, as: :<%= column.type %>, input_html: { class: 'span1' } %>
+<% elsif [:date, :datetime].include?(column.type) -%>
+  <%%= f.input :<%= column.name %>, as: :<%= column.type %>, order: [:day, :month, :year], input_html: { class: 'span1' } %>
+<% else -%>
+  <%%= f.input :<%= column.name %>, as: :<%= column.type %> %>
+<% end -%>
+<% end -%>
+  <div class="form-actions">
+    <%%= f.button :submit, class: 'btn btn-primary' %>
+    <%%= link_to('Cancel', admin_<%= table_name %>_path, class: 'btn') %>
+  </div>
+<%% end %>

data/lib/generators/overlook/admin/templates/index.html.erb

@@ -0,0 +1,44 @@
+<%% @page_title = '<%= plural_name.titleize %>' %>
+
+<div class="span9">
+  <%%= render 'breadcrumb' %>
+  <div class="page-header">
+    <h2><%= plural_name.titleize %></h2>
+  </div>
+  <%% if @<%= table_name %>.present? %>
+    <%% if params[:q].present? %>
+      <div class="alert">
+        Showing search results for <strong><%%= params[:q] %></strong>
+      </div>
+    <%% end %>
+    <table class="table table-striped">
+      <thead>
+        <tr>
+<% listing_columns.each do |column| -%>
+<% if column.name[/_id$/] -%>
+          <th><%%= sorty('<%= (relation = column.name[/^(.*)_id$/, 1]) %>.<%= name_attribute(relation.classify.constantize) %>', label: '<%= column.name[/^(.*)_id$/, 1].titleize %>') %></th>
+<% elsif column.type == :boolean -%>
+          <th class="center"><%%= sorty(:<%= column.name %>) %></th>
+<% elsif [:integer, :float].include?(column.type) -%>
+          <th class="right"><%%= sorty(:<%= column.name %>) %></th>
+<% else -%>
+          <th><%%= sorty(:<%= column.name %>) %></th>
+<% end -%>
+<% end -%>
+          <th class="options"></th>
+        </tr>
+      </thead>
+      <tbody>
+        <%%= render(@<%= table_name %>) %>
+      </tbody>
+    </table>
+    <%%= paginate(@<%= table_name %>, theme: 'admin') %>
+  <%% else %>
+    <div class="alert">
+      There are currently no <%= plural_name %> <%% if params[:q] %>for <strong><%%= params[:q] %></strong><%% end %>
+    </div>
+  <%% end %>
+</div>
+<div class="span3">
+  <%%= render 'sidebar' %>
+</div>

data/lib/generators/overlook/admin/templates/new.html.erb

@@ -0,0 +1,12 @@
+<%% @page_title = 'New <%= singular_name.titleize %>' %>
+
+<div class="span9">
+  <%%= render 'breadcrumb' %>
+  <div class="page-header">
+    <h2>New <%= plural_name.titleize %></h2>
+  </div>
+  <%%= render 'form' %>
+</div>
+<div class="span3">
+  <%%= render 'sidebar' %>
+</div>

data/lib/generators/overlook/admin/templates/partial.html.erb

@@ -0,0 +1,30 @@
+<tr id="<%%= dom_id(<%= file_name %>) %>">
+<% listing_columns.each do |column| -%>
+<% if column.name[/email/] -%>
+  <td><%%= mail_to(<%= file_name %>.<%= column.name %>) %></td>
+<% elsif column.name[/url|website/] -%>
+  <td><%%= link_to(<%= file_name %>.<%= column.name %>, <%= file_name %>.<%= column.name %>, target: '_blank') %></td>
+<% elsif (relation = column.name[/^(.*)_id$/, 1]) -%>
+  <td><%%= <%= file_name %>.<%= column.name[/^(.*)_id$/, 1] %>.<%= name_attribute(relation.classify.constantize) %> %></td>
+<% elsif column.type == :date -%>
+  <td><%%= <%= file_name %>.<%= column.name %>.strftime('%d/%m/%Y') %></td>
+<% elsif column.type == :datetime -%>
+  <td><%%= <%= file_name %>.<%= column.name %>.strftime('%d/%m/%Y %H:%M') %></td>
+<% elsif column.type == :boolean -%>
+  <td class="center"><%%= <%= file_name %>.<%= column.name %> ? 'Yes' : 'No' %></td>
+<% elsif column.type == :text -%>
+  <td><%%= <%= file_name %>.<%= column.name %>.truncate(30) %></td>
+<% elsif [:integer, :float].include?(column.type) -%>
+  <td class="right"><%%= <%= file_name %>.<%= column.name %> %></td>
+<% else -%>
+  <td><%%= <%= file_name %>.<%= column.name %> %></td>
+<% end -%>
+<% end -%>
+  <td class="options">
+    <div class="btn-group">
+      <%%= link_to('view', [:admin, <%= file_name %>], class: 'btn btn-mini') %>
+      <%%= link_to('edit', [:edit, :admin, <%= file_name %>], class: 'btn btn-mini') %>
+      <%%= link_to('delete', [:admin, <%= file_name %>], method: :delete, remote: true, confirm: 'Are you sure?', class: 'btn btn-mini btn-danger') %>
+    </div>
+  </td>
+</tr>

data/lib/generators/overlook/admin/templates/show.html.erb

@@ -0,0 +1,17 @@
+<%% @page_title = '<%= singular_name.titleize %> Details' %>
+
+<div class="span9">
+  <%%= render 'breadcrumb' %>
+  <div class="page-header">
+    <h2><%%= @<%= file_name %>.<%= name_attribute(class_name.constantize) %> %></h2>
+  </div>
+  <dl class="dl-horizontal">
+<% columns.each do |column| -%>
+    <dt><%= column.name.humanize %></dt>
+    <dd><%%= @<%= file_name %>.<%= column.name %> %></dd>
+<% end -%>
+  </dl>
+</div>
+<div class="span3">
+  <%%= render 'sidebar' %>
+</div>

data/lib/generators/overlook/admin/templates/sidebar.html.erb

@@ -0,0 +1,30 @@
+<div class="well sidebar">
+  <ul class="nav nav-list">
+    <li class="nav-header">
+      <%= singular_name.titleize %> Options
+    </li>
+    <li> 
+      <a href="<%%= admin_<%= table_name %>_path %>"><i class="icon-list"></i> List <%= plural_name %></a>
+    </li>
+    <li> 
+      <a href="<%%= new_admin_<%= file_name %>_path %>"><i class="icon-plus"></i> New <%= singular_name %></a>
+    </li>
+    <li> 
+      <a href="<%%= admin_<%= table_name %>_path(format: :csv) %>"><i class="icon-download"></i> Download CSV</a>
+    </li>
+    <%% if params[:action] == 'edit' %>
+      <li> 
+        <a href="<%%= admin_<%= file_name %>_path(@<%= file_name %>) %>"><i class="icon-search"></i> View this <%= singular_name %></a>
+      </li>
+    <%% end %>
+    <%% if params[:action] == 'show' %>
+      <li> 
+        <a href="<%%= edit_admin_<%= file_name %>_path(@<%= file_name %>) %>"><i class="icon-pencil"></i> Edit this <%= singular_name %></a>
+      </li>
+    <%% end %>
+  </ul>
+</div>
+<form class="form-search well" action="<%%= admin_<%= table_name %>_path %>">
+  <input type="text" class="input-medium search-query" name="q" value="<%%= params[:q] %>" placeholder="Search <%= plural_name %>...">
+  <button type="submit" class="btn btn-primary">Go</button>
+</form>

data/lib/generators/overlook/install/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Installs the assets needed for the generated admin
+
+Example:
+    rails generate overlook