admin_views 0.1

data/Changelog

@@ -0,0 +1,2 @@
+* 0.1
+ - Initial version

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Conor Hunt <conor.hunt@gmail.com>
+
+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.md

@@ -0,0 +1,49 @@
+Admin Views
+=================
+
+A Rails generator to create admin scaffolding for a model.
+
+The generator is pretty opinionated, because I wrote this after I became tired of writing the same
+code over and over. It expects that your admin controllers will reside under app/controllers/admin and
+use namespaced restful routes. It also expects a base admin controller named Admin::AdminController, but
+this is a single edit in the generated controller if you do not use that.
+
+Install
+-------
+
+    gem install admin_views
+
+This library uses the will\_paginate and formtastic gems.
+
+Usage
+-----
+
+Create the model that you need, make sure the db table is generated too. Then:
+
+    script/generate admin_views User
+
+This will generate:
+
+    app/controllers/admin/users_controller.rb
+    app/views/admin/users/_form.html.erb
+    app/views/admin/users/_user.html.erb
+    app/views/admin/users/edit.html.erb
+    app/views/admin/users/index.html.erb
+    app/views/admin/users/new.html.erb
+    app/views/admin/users/show.html.erb
+
+Add the model resource route to your routes.rb. Example:
+
+    map.namespace :admin do |admin|
+      admin.resources :users
+      admin.root :controller => 'users'
+    end
+
+Edit the generated index.html.erb and \_user.html.erb to only display the fields that you need.
+By default they show all fields for the model. Same with the \_form.html.erb and show.html.erb.
+
+COPYRIGHT
+---------
+
+Copyright (c) 2010 Conor Hunt <conor.hunt@gmail.com>
+Released under the MIT license

data/generators/admin_views/admin_views_generator.rb

@@ -0,0 +1,31 @@
+require 'active_support/inflector'
+
+class AdminViewsGenerator < Rails::Generator::NamedBase
+  include ActiveSupport::Inflector
+
+  attr_reader :model_class, :model_name, :model_plural, :columns
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+
+    @model_class = name
+    @model_name = underscore(@model_class)
+    @model_plural = underscore(pluralize(@model_class))
+    @columns = Object.const_get(@model_class).columns
+  end
+
+  def manifest
+    record do |m|
+      m.directory("app/controllers/admin")
+      m.template('controllers/controller.rb', "app/controllers/admin/#{model_plural}_controller.rb")
+
+      m.directory("app/views/admin/#{model_plural}")
+      m.template('views/_form.html.erb', "app/views/admin/#{model_plural}/_form.html.erb")
+      m.template('views/_model.html.erb', "app/views/admin/#{model_plural}/_#{model_name}.html.erb")
+      m.template('views/edit.html.erb', "app/views/admin/#{model_plural}/edit.html.erb")
+      m.template('views/index.html.erb', "app/views/admin/#{model_plural}/index.html.erb")
+      m.template('views/new.html.erb', "app/views/admin/#{model_plural}/new.html.erb")
+      m.template('views/show.html.erb', "app/views/admin/#{model_plural}/show.html.erb")
+    end
+  end
+end

data/generators/admin_views/templates/controllers/controller.rb

@@ -0,0 +1,56 @@
+class Admin::<%= pluralize(model_class) %>Controller < Admin::AdminController
+  # GET /admin/<%= model_plural %>
+  def index
+    if params[:search]
+      # TODO: By default search all text fields
+      @<%= model_plural %> = <%= model_class %>.paginate(:all, :page => params[:page])
+    else
+      @<%= model_plural %> = <%= model_class %>.paginate(:all, :page => params[:page])
+    end
+  end
+ 
+  # GET /admin/<%= model_plural %>/1
+  def show
+    @<%= model_name %> = <%= model_class %>.find(params[:id])
+  end
+ 
+  # GET /admin/<%= model_plural %>/new
+  def new
+    @<%= model_name %> = <%= model_class %>.new
+  end
+ 
+  # GET /admin/<%= model_plural %>/1/edit
+  def edit
+    @<%= model_name %> = <%= model_class %>.find(params[:id])
+  end
+ 
+  # POST /admin/<%= model_plural %>
+  def create
+    @<%= model_name %> = <%= model_class %>.new(params[:<%= model_name %>])
+ 
+    if @<%= model_name %>.save
+      redirect_to(@<%= model_name %>, :notice => '<%= class_name %> was successfully created.')
+    else
+      render :action => "new"
+    end
+  end
+ 
+  # PUT /admin/<%= model_plural %>/1
+  def update
+    @<%= model_name %> = <%= model_class %>.find(params[:id])
+ 
+    if @<%= model_name %>.update_attributes(params[:<%= model_name %>])
+      redirect_to(admin_<%= model_plural %>_url(@<%= model_name %>), :notice => '<%= model_class %> was successfully updated.')
+    else
+      render :action => "edit"
+    end
+  end
+ 
+  # DELETE /admin/<%= model_plural %>/1
+  def destroy
+    @<%= model_name %> = <%= model_class %>.find(params[:id])
+    @<%= model_name %>.destroy
+
+    redirect_to(admin_<%= model_plural %>_url)
+  end
+end

data/generators/admin_views/templates/views/_form.html.erb

@@ -0,0 +1,8 @@
+<%% semantic_form_for [:admin, @<%= model_name %>] do |form| %>
+<% # http://github.com/justinfrench/formtastic %>
+<% for col in columns -%>
+  <%%= form.input :<%= col.name %> -%>
+<% end -%>
+
+  <%%= form.buttons :commit %>
+<%% end %>

data/generators/admin_views/templates/views/_model.html.erb

@@ -0,0 +1,9 @@
+<tr id="<%= model_name %>_<%%= <%= model_name %>.id %>">
+<% for col in columns -%>
+  <td><%%= h <%= model_name %>.<%= col.name %> %></td>
+<% end -%>
+  <td>
+    <%%= link_to "Edit", edit_admin_<%= model_name %>_path(<%= model_name %>) %>
+    <%%= link_to "Delete", admin_<%= model_name %>_path(<%= model_name %>), :method => :delete, :confirm => "Are you sure?" %>
+  </td>
+</tr>

data/generators/admin_views/templates/views/edit.html.erb

@@ -0,0 +1,3 @@
+<h2>Edit <%= model_class %></h2>
+
+<%%= render :partial => "form" %>

data/generators/admin_views/templates/views/index.html.erb

@@ -0,0 +1,20 @@
+<div id="create-link" style="float: right; font-size: 1.2em; font-weight: bold">
+  <%%= link_to "Create New <%= model_class %>", new_admin_<%= model_name %>_path %>
+</div>
+
+<div id="search">
+  
+</div>
+
+<h2><%= model_class %></h2>
+<table>
+  <tr>
+<% for col in columns -%>
+    <th><%= col.human_name %></th>
+<% end -%>
+    <th></th>
+  </tr>
+  <%%= render @<%= model_plural %> %>
+</table>
+
+<%%= will_paginate @<%= model_plural %> %>

data/generators/admin_views/templates/views/new.html.erb

@@ -0,0 +1,3 @@
+<h2>Create New <%= model_class %></h2>
+
+<%%= render :partial => "form" %>

data/generators/admin_views/templates/views/show.html.erb

@@ -0,0 +1,11 @@
+<h2><%= model_class %> <%%= @<%= model_name %>.id %></h2>
+<div id="create-link" style="float: right; font-size: 1.2em; font-weight: bold">
+  <%%= link_to "Show All <%= pluralize(model_class) %>", admin_<%= model_plural %>_path %>
+  <%%= link_to "Edit <%= model_class %>", edit_admin_<%= model_name %>_path(@<%= model_name %>) %>
+</div>
+
+<table>
+<% for col in columns -%>
+  <tr><td><%= col.human_name %></td><td><%%= h @<%= model_name %>.<%= col.name %> %></td></tr>
+<% end -%>
+</table>

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: admin_views
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Conor Hunt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-22 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: will_paginate
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.12
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: formtastic
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.7
+    version: 
+description: Rails generator to create admin views for models
+email: conor.hunt@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- LICENSE
+- Changelog
+- generators/admin_views/admin_views_generator.rb
+- generators/admin_views/templates/controllers/controller.rb
+- generators/admin_views/templates/views/_form.html.erb
+- generators/admin_views/templates/views/_model.html.erb
+- generators/admin_views/templates/views/edit.html.erb
+- generators/admin_views/templates/views/index.html.erb
+- generators/admin_views/templates/views/new.html.erb
+- generators/admin_views/templates/views/show.html.erb
+has_rdoc: true
+homepage: http://github.com/conorh/admin_views
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rails generator to create admin views for models
+test_files: []
+