quirkey-qadmin 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-01-07
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,44 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+init.rb
+lib/qadmin.rb
+lib/qadmin/controller.rb
+lib/qadmin/helper.rb
+lib/qadmin/views/edit.html.erb
+lib/qadmin/views/index.html.erb
+lib/qadmin/views/new.html.erb
+lib/qadmin/views/show.html.erb
+rails/init.rb
+rails_generators/qadmin/USAGE
+rails_generators/qadmin/qadmin_generator.rb
+rails_generators/qadmin/templates/_form.html.erb
+rails_generators/qadmin/templates/controller.rb
+rails_generators/qadmin/templates/functional_test.rb
+rails_generators/qadmin/templates/images/icon_destroy.png
+rails_generators/qadmin/templates/images/icon_down.gif
+rails_generators/qadmin/templates/images/icon_edit.png
+rails_generators/qadmin/templates/images/icon_export.png
+rails_generators/qadmin/templates/images/icon_find.png
+rails_generators/qadmin/templates/images/icon_import.png
+rails_generators/qadmin/templates/images/icon_list.png
+rails_generators/qadmin/templates/images/icon_new.png
+rails_generators/qadmin/templates/images/icon_next.gif
+rails_generators/qadmin/templates/images/icon_prev.gif
+rails_generators/qadmin/templates/images/icon_show.png
+rails_generators/qadmin/templates/images/icon_sort.png
+rails_generators/qadmin/templates/images/icon_up.gif
+rails_generators/qadmin/templates/images/indicator_medium.gif
+rails_generators/qadmin/templates/layout.html.erb
+rails_generators/qadmin/templates/shoulda_functional_test.rb
+rails_generators/qadmin/templates/style.css
+script/console
+script/destroy
+script/generate
+script/txt2html
+test/test_generator_helper.rb
+test/test_helper.rb
+test/test_qadmin_controller.rb
+test/test_qadmin_generator.rb

data/PostInstall.txt

@@ -0,0 +1 @@
+For more information on qadmin, see http://github.com/quirkey/qadmin

data/README.rdoc

@@ -0,0 +1,64 @@
+= qadmin
+
+http://github.com/quirkey/qadmin
+
+== DESCRIPTION:
+
+An [almost] one command solution for adding admin interfaces/resources to a Rails app. 
+
+== FEATURES/PROBLEMS:
+
+Qadmin is a partial extraction of 2+ years of building Rails admin systems. A lot of the code comes from a Rails plugin I wrote (private) called quirkey_tools. 
+
+The system consists currently of two parts: a generator, and a set of macros.
+
+The generator is =~ the Rails resource generator, but instead of plopping all the code for the different standard resource actions into the controller and templates, it uses the #qadmin macro to include the standard resource actions.
+
+== SYNOPSIS:
+
+(Coming soon)
+
+== REQUIREMENTS:
+
+Right now, a rails app, but the eventual goal is to make it framework agnostic (work with Sinatra, etc, too)..
+
+== INSTALL:
+
+Qadmin can be installed as a gem or a plugin.
+
+=== As a gem
+
+  sudo gem install qadmin --source=http://gems.github.com
+
+Then in your config/environment.rb
+
+  config.gem 'qadmin'
+  
+=== As a plugin
+
+  ./script/plugin install git://github.com/quirkey/qadmin.git  
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Aaron Quint, Quirkey NYC, LLC
+
+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/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/qadmin'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('qadmin', Qadmin::VERSION) do |p|
+  p.developer('Aaron Quint', 'aaron@quirkey.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = 'quirkey'
+  p.extra_deps         = [
+    ['activesupport','>= 2.2.0']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "rails", "init")

data/lib/qadmin/controller.rb

@@ -0,0 +1,121 @@
+module Qadmin
+  module Controller
+
+    module Macros
+      
+      def qadmin(options = {})
+        self.cattr_accessor :model_name, :model_instance_name, :model_collection_name, :model_human_name, :available_actions
+        self.available_actions     = [:index, :show, :new, :create, :edit, :update, :destroy]
+        self.available_actions     = [options[:only]].flatten    if options[:only]
+        self.available_actions    -= [options[:exclude]].flatten if options[:exclude]
+        self.model_name            = self.to_s.demodulize.gsub(/Controller/,'').singularize
+        self.model_instance_name   = model_name.underscore
+        self.model_collection_name = model_instance_name.pluralize    
+        self.model_human_name      = model_instance_name.humanize
+        self.append_view_paths(File.join(File.dirname(__FILE__), 'views'))
+        define_admin_actions(available_actions, options)
+      end
+
+      private
+      def define_admin_actions(actions, options = {})
+        action_method_code = {
+          :index => %{
+          def index
+            @#{model_collection_name} = #{model_name}.paginate(:page => (params[:page] || 1))
+            respond_to do |format|
+              format.html
+              format.xml
+            end
+          end
+          },
+          :show => %{
+          def show
+            @#{model_instance_name} = #{model_name}.find(params[:id])
+            respond_to do |format|
+              format.html
+              format.xml
+            end
+          end
+          },
+          :new => %{
+          def new
+            @#{model_instance_name} = #{model_name}.new
+
+            respond_to do |format|
+              format.html # new.html.erb
+              format.xml  { render :xml => @#{model_instance_name} }
+            end
+          end
+          },
+          :create => %{
+          def create
+            @#{model_instance_name} = #{model_name}.new(params[:#{model_instance_name}])
+            respond_to do |format|
+              if @#{model_instance_name}.save
+                flash[:message] = '#{model_human_name} was successfully created.'
+                format.html { redirect_to(#{model_instance_name}_path(@#{model_instance_name})) }
+                format.xml  { render :xml => @#{model_instance_name}, :status => :created, :location => @#{model_instance_name} }
+              else
+                format.html { render :action => "new" }
+                format.xml  { render :xml => @#{model_instance_name}.errors }
+              end
+            end
+          end
+          },
+          :edit => %{
+          def edit
+            @#{model_instance_name} = #{model_name}.find(params[:id])
+          end
+          },
+          :update => %{
+          def update
+            @#{model_instance_name} = #{model_name}.find(params[:id])
+
+            respond_to do |format|
+              if @#{model_instance_name}.update_attributes(params[:#{model_instance_name}])
+                flash[:message] = '#{model_human_name} was successfully updated.'
+                format.html { redirect_to(#{model_instance_name}_path(@#{model_instance_name})) }
+                format.xml  { head :ok }
+              else
+                format.html { render :action => "edit" }
+                format.xml  { render :xml => @#{model_instance_name}.errors }
+              end
+            end
+          end
+          },
+          :destroy => %{
+          def destroy
+            @#{model_instance_name} = #{model_name}.find(params[:id])
+            @#{model_instance_name}.destroy
+            flash[:message] = "#{model_human_name} \#{@#{model_instance_name}} was deleted"
+            respond_to do |format|
+              format.html { redirect_to(#{model_collection_name}_path) }
+              format.xml  { head :ok }
+            end
+          end
+          }
+        }
+        action_code = actions.collect {|a| action_method_code[a.to_sym] }.join("\n")
+        self.class_eval(action_code)
+      end
+    end
+
+
+    # GET /<%= controller_file_path %>/new
+    # GET /<%= controller_file_path %>/new.xml
+    
+    # GET /<%= controller_file_path %>/1/edit
+    
+    # POST /<%= controller_file_path %>
+    # POST /<%= controller_file_path %>.xml
+    
+    # PUT /<%= controller_file_path %>/1
+    # PUT /<%= controller_file_path %>/1.xml
+
+    
+    # DELETE /<%= controller_file_path %>/1
+    # DELETE /<%= controller_file_path %>/1.xml
+
+
+  end
+end

data/lib/qadmin/helper.rb

@@ -0,0 +1,59 @@
+module Qadmin
+  module Helper
+    
+    def fieldset(legend = nil, options = {}, &block)
+      content_tag(:fieldset, options) do
+        content_tag(:legend, legend) if legend
+        yield
+      end
+    end
+
+    def admin_controls(name, options = {}, &block)
+      return if respond_to?(:overlay?) && overlay?
+      controller     = options[:controller] || name.to_s.tableize
+      assumed_object = self.instance_variable_get "@#{name}"
+      obj            = options[:object] || assumed_object || nil
+      parent         = options[:parent] || false
+
+      parent_link_attributes = parent ? {parent.class.to_s.foreign_key => parent.id} : {}
+      general_link_attributes = {:controller => controller}.merge(parent_link_attributes)
+
+      control_links = {
+        :index      => link_to(image_tag('admin/icon_list.png') + " Back to List", general_link_attributes.merge(:action => 'index')),
+        :new        => link_to(image_tag('admin/icon_new.png') + " New", general_link_attributes.merge(:action => 'new')),
+        :edit       => link_to(image_tag('admin/icon_edit.png') + " Edit", general_link_attributes.merge(:action => 'edit', :id => obj)),
+        :show       => link_to(image_tag('admin/icon_show.png') + " View", general_link_attributes.merge(:action => 'show', :id => obj)),
+        :destroy    => link_to(image_tag('admin/icon_destroy.png') + " Delete", general_link_attributes.merge(:action => 'destroy', :id => obj), :confirm => 'Are you sure?', :method => :delete),
+        :ports      => link_to(image_tag('admin/icon_export.png') + " Import/Export", general_link_attributes.merge(:action => 'ports'))
+      }
+
+      control_sets = {
+        :index => [:new],
+        :new   => [:index],
+        :edit  => [:index,:new,:show,:destroy],
+        :show  => [:index,:new,:edit,:destroy]
+      }
+
+      control_set = (options[:for] ? control_sets[options[:for]] : options[:controls])
+      control_set << :ports if options[:ports]
+      controls = Array(control_set).collect {|c| control_links[c] }.compact
+
+      html = ""
+      html << %{<ul class="admin_controls">}
+      controls.each {|control| html << li(control) }
+      if block_given?
+        html << capture(&block)
+        html << %{</ul>}
+        concat(html,block.binding)
+      else
+        html << %{</ul>}
+        html
+      end
+    end
+
+    def alt_rows
+      %{class="#{cycle('alt', '')}"}
+    end
+
+  end
+end

data/lib/qadmin/views/edit.html.erb

@@ -0,0 +1,12 @@
+<h2>Editing <%= singular_name.humanize.capitalize %></h2>
+
+<%%= admin_controls :<%= table_name %>, :for => :edit, :object => @<%= singular_name %> %>
+
+<%%= error_messages_for :<%= singular_name %> %>
+
+<%% form_for(@<%= singular_name %>) do |f| %>
+  <%%= render :partial => 'form', :locals => {:f => f, :<%= singular_name %> => @<%= singular_name %>} %>
+  <p><%%= f.submit "Update" %></p>
+<%% end %>
+
+<%%= admin_controls :<%= table_name %>, :for => :edit, :object => @<%= singular_name %> %>

data/lib/qadmin/views/index.html.erb

@@ -0,0 +1,31 @@
+<h2><%= plural_name.humanize.capitalize %></h2>
+
+<%%= admin_controls :<%= table_name %>, :for => :index %>
+
+<%%= will_paginate(@<%= plural_name %>) %>
+<table>
+  <tr>
+<% attributes.each_with_index do |attribute, i| -%>
+    <th<% if i == 0 -%> class="first_col"<% end -%>><%%= sorterable_link :<%= attribute.name -%> %></th>
+<% end -%>
+	<th>View</th>
+	<th>Edit</th>
+	<th>Delete</th>
+  </tr>
+  
+<%%  @<%= plural_name %>.each do |<%= singular_name %>| %>
+  <tr id="<%%= dom_id(<%= singular_name %>) %>" <%%= alt_rows %>>
+<% attributes.each_with_index do |attribute, i| -%>
+    <% if i == 0 -%><td class="first_col"><%%= link_to <%= singular_name %>.<%= attribute.name %>, <%= table_name.singularize %>_path(<%= singular_name %>)  %></td><%- else -%>
+   <td><%%= h <%= singular_name %>.<%= attribute.name %> %></td>
+	<%- end -%>
+<% end -%>
+    <td><%%= link_to image_tag('admin/icon_show.png'), <%= table_name.singularize %>_path(<%= singular_name %>) %></td>
+    <td><%%= link_to image_tag('admin/icon_edit.png'), edit_<%= table_name.singularize %>_path(<%= singular_name %>) %></td>
+    <td><%%= link_to image_tag('admin/icon_destroy.png'), <%= table_name.singularize %>_path(<%= singular_name %>), :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<%% end %>
+</table>
+<%%= will_paginate(@<%= plural_name %>) %>
+
+<%%= admin_controls :<%= table_name %>, :for => :index %>

data/lib/qadmin/views/new.html.erb

@@ -0,0 +1,12 @@
+<h2><%= singular_name.humanize.capitalize %>: New</h2>
+
+<%%= admin_controls :<%= table_name %>, :for => :new %>
+
+<%%= error_messages_for :<%= singular_name %> %>
+
+<%% form_for(@<%= singular_name %>) do |f| %>
+  <%%= render :partial => 'form', :locals => {:f => f, :<%= singular_name %> => @<%= singular_name %>} %>
+  <p><%%= f.submit "Create" %></p>
+<%% end %>
+
+<%%= admin_controls :<%= table_name %>, :for => :new %>

data/lib/qadmin/views/show.html.erb

@@ -0,0 +1,14 @@
+<h2><%= plural_name.humanize.capitalize %>: <%%= @<%= singular_name %>.to_s %></h2>
+
+<%%= admin_controls :<%= table_name %>, :for => :show, :object => @<%= singular_name %> %>
+
+<div id="<%%= dom_id(@<%= singular_name %>) %>">
+	<div class="fields_group">
+	<% attributes.each do |attribute| -%>
+	<h5><%= attribute.human_name %>:</h5>
+	<%%=h @<%= singular_name %>.<%= attribute.name %> %>
+	<% end -%>
+	</div>
+</div>
+
+<%%= admin_controls :<%= table_name %>, :for => :show, :object => @<%= singular_name %> %>

data/lib/qadmin.rb

@@ -0,0 +1,13 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+unless defined?(ActiveSupport)
+  require 'active_support'
+end
+
+module Qadmin
+  VERSION = '0.1.0'
+end
+
+require 'qadmin/helper'
+require 'qadmin/controller'

data/rails/init.rb

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), '..', 'qadmin/qadmin')
+
+ActionController::Base.send(:extend, Qadmin::Base)
+ActionView::Base.send(:include, Qadmin::Helper)

data/rails_generators/qadmin/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/rails_generators/qadmin/qadmin_generator.rb

@@ -0,0 +1,94 @@
+class QadminGenerator < Rails::Generator::NamedBase
+  attr_reader   :controller_name,
+  :controller_class_path,
+  :controller_file_path,
+  :controller_class_nesting,
+  :controller_class_nesting_depth,
+  :controller_class_name,
+  :controller_singular_name,
+  :controller_plural_name
+  alias_method  :controller_file_name,  :controller_singular_name
+  alias_method  :controller_table_name, :controller_plural_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+
+    @controller_name = @args.shift || @name.pluralize
+
+    base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
+    @controller_class_name_without_nesting, @controller_singular_name, @controller_plural_name = inflect_names(base_name)
+
+    if @controller_class_nesting.empty?
+      @controller_class_name = @controller_class_name_without_nesting
+    else
+      @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
+    end
+  end
+
+  def manifest
+    record do |m|
+      klass # checks for class definition
+      # Check for class naming collisions.
+      m.class_collisions(controller_class_path, "#{controller_class_name}Controller")
+
+      # Controller, helper, views, and test directories.
+      m.directory(File.join('app','controllers', controller_class_path))
+      m.directory(File.join('app', 'helpers', controller_class_path))
+      m.directory(File.join('app', 'views', controller_class_path, controller_file_name))
+      m.directory(File.join('test', 'functional', controller_class_path))
+      m.directory(File.join('public','images','admin'))
+
+      #copy form over too
+      m.template("_form.html.erb",File.join('app','views', controller_class_path, controller_file_name, "_form.html.erb"))
+
+      # Layout and stylesheet.
+      m.template('layout.html.erb', File.join('app','views','layouts', "admin.html.erb"))
+      m.template('style.css', 'public/stylesheets/admin.css')
+
+      m.template(
+      'controller.rb', File.join('app','controllers', controller_class_path, "#{controller_file_name}_controller.rb")
+      )
+
+      m.template('shoulda_functional_test.rb', File.join('test','functional', controller_class_path, "#{controller_file_name}_controller_test.rb"))
+
+      m.route_resources controller_file_name
+
+      # Copy Icons
+      Dir[File.join(File.dirname(__FILE__),'templates','images/*')].each do |image|
+        m.file File.join('images',File.basename(image)), File.join('public','images','admin',File.basename(image))
+      end
+
+    end
+  end
+  
+  protected
+  # Override with your own usage banner.
+  def banner
+    "Usage: #{$0} qadmin ModelName"
+  end
+
+  def scaffold_views
+    %w[ index show new edit ]
+  end
+
+  def model_name 
+    class_name.demodulize
+  end
+
+  def klass
+    begin
+      require "#{file_name}" unless defined?(model_name.constantize)
+    rescue
+      raise "You must define the class #{model_name} before running qscaffold"
+    end
+    model_name.constantize
+  end
+
+  def attributes
+    klass.content_columns
+  end
+
+  def ignore_attributes
+    %w{created_at updated_at}.push klass.protected_attributes
+  end
+end

data/rails_generators/qadmin/templates/_form.html.erb

@@ -0,0 +1,7 @@
+<%% fieldset do %>
+<% attributes.each do |attribute| -%>
+<% unless ignore_attributes.include?(attribute.name) -%>
+<p><label><%= attribute.human_name %></label><%%= f.text_field :<%= attribute.name %> %></p>
+<% end -%>
+<% end -%>
+<%% end %>

data/rails_generators/qadmin/templates/controller.rb

@@ -0,0 +1,6 @@
+class <%= controller_class_name %>Controller < ApplicationController
+  #before_filter :login_required
+  #layout 'admin'
+  qadmin
+
+end

data/rails_generators/qadmin/templates/functional_test.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__) + '<%= '/..' * controller_class_nesting_depth %>/../test_helper'
+require '<%= controller_file_path %>_controller'
+
+# Re-raise errors caught by the controller.
+class <%= controller_class_name %>Controller; def rescue_action(e) raise e end; end
+
+class <%= controller_class_name %>ControllerTest < Test::Unit::TestCase
+  fixtures :<%= model_name.tableize %>#, :users
+
+  def setup
+    @controller = <%= controller_class_name %>Controller.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    #login_as(:aaron)
+    @<%= file_name %> = <%= model_name.tableize %>(!!FIXTURENAME)
+  end
+
+  # def test_should_require_login
+  #   logout
+  #   get :index
+  #   assert_redirected_to_login
+  # end
+
+  def test_should_get_index
+    get :index
+    assert_response :success
+    assert assigns(:<%= model_name.tableize %>)
+  end
+
+  def test_should_get_new
+    get :new
+    assert_response :success
+    assert_select 'form'
+  end
+  
+  def test_should_create_<%= file_name %>
+    assert_difference '<%= model_name %>.count' do
+      post :create, :<%= file_name %> => <%= file_name %>_params
+      assert_redirected_to <%= table_name.singularize %>_path(assigns(:<%= file_name %>))
+    end
+  end
+
+  def test_should_show_<%= file_name %>
+    get :show, :id => @<%= file_name %>.id
+    assert_response :success
+    assert assigns(:<%= file_name %>)
+  end
+
+  def test_should_get_edit
+    get :edit, :id =>  @<%= file_name %>.id
+    assert_response :success
+    assert assigns(:<%= file_name %>)
+    assert_select 'form'
+  end
+  
+  def test_should_update_<%= file_name %>
+    assert_no_difference '<%= model_name %>.count' do
+      put :update, :id => @<%= file_name %>.id, :<%= file_name %> => <%= file_name %>_params
+      assert_redirected_to <%= table_name.singularize %>_path(assigns(:<%= file_name %>))
+    end
+  end
+  
+  def test_should_destroy_<%= file_name %>
+    assert_difference '<%= model_name %>.count', -1 do
+      delete :destroy, :id => @<%= file_name %>.id
+      assert_redirected_to <%= table_name %>_path
+    end
+  end
+  
+  
+  protected
+  def <%= file_name %>_params(options = {})
+    {
+      <%= attributes.collect { |a| ":#{a.name} => #{a.default}" }.join(', ') %>
+    }.update(options)
+  end
+end