qadmin 0.2.0

data/History.txt

@@ -0,0 +1,9 @@
+== 0.2.0 2009-03-20
+
+* 1 major enhancement:
+  * First full release
+  
+== 0.0.1 2009-01-07
+
+* 1 major enhancement:
+  * Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+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/Manifest.txt

@@ -0,0 +1,52 @@
+History.txt
+LICENSE
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+init.rb
+lib/qadmin.rb
+lib/qadmin/assets/form_builder.rb
+lib/qadmin/configuration.rb
+lib/qadmin/controller.rb
+lib/qadmin/form_builder.rb
+lib/qadmin/helper.rb
+lib/qadmin/option_set.rb
+lib/qadmin/overlay.rb
+lib/qadmin/page_titles.rb
+lib/qadmin/templates.rb
+lib/qadmin/views/content_forms/_attachments_form.erb
+lib/qadmin/views/content_forms/_photos_form.erb
+lib/qadmin/views/content_forms/_videos_form.erb
+lib/qadmin/views/default/edit.erb
+lib/qadmin/views/default/index.erb
+lib/qadmin/views/default/new.erb
+lib/qadmin/views/default/show.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/_instance.html.erb
+rails_generators/qadmin/templates/controller.rb
+rails_generators/qadmin/templates/functional_test.rb
+rails_generators/qadmin/templates/images/icon_asc.gif
+rails_generators/qadmin/templates/images/icon_desc.gif
+rails_generators/qadmin/templates/images/icon_destroy.png
+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/indicator_medium.gif
+rails_generators/qadmin/templates/layout.html.erb
+rails_generators/qadmin/templates/style.css
+test/test_generator_helper.rb
+test/test_helper.rb
+test/test_qadmin_controller.rb
+test/test_qadmin_generator.rb
+test/test_qadmin_option_set.rb

data/PostInstall.txt

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

data/README.rdoc

@@ -0,0 +1,39 @@
+= qadmin
+
+http://github.com/quirkey/qadmin
+
+== DESCRIPTION:
+
+An [almost] one command solution for adding admin interfaces/resources to a Rails app. 
+
+== SYNOPSIS:
+
+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.
+
+For full details and usage please see the website at:
+
+http://code.quirkey.com/qadmin
+
+== 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:
+
+MIT-LICENSE - See LICENSE

data/Rakefile

@@ -0,0 +1,31 @@
+%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.summary = p.description = "An [almost] one command solution for adding admin interfaces/resources to a Rails app."
+  p.extra_deps         = [
+    ['activesupport','>= 2.3.2'],
+    ['restful_query','>= 0.2.0']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"],
+    ['Shoulda', ">= 1.2.0"]
+  ]
+  
+  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.rb

@@ -0,0 +1,20 @@
+$:.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.2.0'
+end
+
+%w{
+  option_set
+  configuration
+  helper
+  overlay
+  page_titles
+  templates
+  controller
+}.each {|lib| require "qadmin/#{lib}" }

data/lib/qadmin/assets/form_builder.rb

@@ -0,0 +1,36 @@
+module Qadmin
+  module Assets
+    module FormBuilder
+      
+      def asset_selector(method, options = {})
+  
+        id = "#{object_name}_#{method}"
+        form_name = "#{object_name}[#{method}]"
+
+        options.reverse_merge!({
+          :id => id,
+          :form_name => form_name,
+          :name => object_name,
+          :method => method,
+          :object => object,
+          :current => object.send(method),
+          :label => false,
+          :resize_type => object_name.tableize,
+          :multiple => true
+        })
+        @template.render(:partial => 'assets/asset_selector', :locals => options)
+      end
+
+      def asset_browser(id, options = {})
+        options.reverse_merge!({
+          :id => id,
+          :label => false,
+          :resize_type => ''
+        })
+        @template.render(:partial => 'shared/file_browser', :locals => options)
+      end
+      
+    end
+    
+  end
+end

data/lib/qadmin/configuration.rb

@@ -0,0 +1,48 @@
+module Qadmin
+  class Configuration
+    
+    attr_accessor :controller_klass,
+                  :model_name, 
+                  :model_instance_name, 
+                  :model_collection_name, 
+                  :model_human_name, 
+                  :available_actions, 
+                  :display_columns,
+                  :column_headers,
+                  :multipart_forms,
+                  :default_scope,
+                  :ports,
+                  :controls
+    
+    def initialize(options = {})
+      extract_model_from_options(options)
+      self.available_actions = Qadmin::OptionSet.new([:index, :show, :new, :create, :edit, :update, :destroy], options[:available_actions] || {})
+      self.display_columns   = Qadmin::OptionSet.new(model_column_names, options[:display_columns] || {})
+      self.multipart_forms   = options[:multipart_forms] || false
+      self.default_scope     = options[:default_scope]   || false
+      self.ports             = options[:ports]           || false
+      self.controls          = options[:controls]        || []
+      self.column_headers    = HashWithIndifferentAccess.new(options[:column_headers] || {})
+    end
+    
+    def model_klass
+      self.model_name.constantize
+    end
+    
+    protected
+    def extract_model_from_options(options = {})
+      self.controller_klass      = options[:controller_klass]
+      self.model_name            = options[:model_name] || controller_klass.to_s.demodulize.gsub(/Controller/,'').singularize
+      self.model_instance_name   = options[:model_instance_name] || model_name.underscore
+      self.model_collection_name = options[:model_collection_name] || model_instance_name.pluralize    
+      self.model_human_name      = options[:model_human_name] || model_instance_name.humanize
+    end
+    
+    def model_column_names
+      model_klass.column_names
+    rescue
+      []
+    end
+    
+  end
+end

data/lib/qadmin/controller.rb

@@ -0,0 +1,139 @@
+module Qadmin
+  module Controller
+
+    module Macros
+      
+      
+      def qadmin(options = {})
+        self.cattr_accessor :qadmin_configuration
+        self.qadmin_configuration = Qadmin::Configuration.new({:controller_klass => self}.merge(options))
+        self.delegate :model_name, :model_klass, :model_collection_name, :model_instance_name, :model_human_name, :to => lambda { self.class.qadmin_configuration }
+        yield(self.qadmin_configuration) if block_given?
+        include Qadmin::Templates
+        include Qadmin::Overlay
+        self.append_view_path(File.join(File.dirname(__FILE__), 'views'))
+        define_admin_actions(qadmin_configuration.available_actions, options)
+      end
+      
+      private
+      
+      def define_admin_actions(actions, options = {})
+        config = self.qadmin_configuration
+        action_method_code = {
+          :index => %{
+          def index
+            logger.info 'Qadmin: Default /index'
+            scope = qadmin_configuration.model_klass
+            scope = scope.send(qadmin_configuration.default_scope) if qadmin_configuration.default_scope
+            scope =  scope.restful_query(params[:query]) if #{config.model_name}.can_query?
+            @model_collection = @#{config.model_collection_name} = scope.paginate(:page => (params[:page] || 1), :per_page => (params[:per_page] || 25))
+            logger.warn 'controller params:' + params.inspect
+            respond_to do |format|
+              format.html { render_template_for_section }
+              format.xml
+            end
+          end
+          },
+          :show => %{
+          def show
+            logger.info 'Qadmin: Default /show'
+            @model_instance = @#{config.model_instance_name} = #{config.model_name}.find(params[:id])
+            respond_to do |format|
+              format.html { render_template_for_section }
+              format.xml
+            end
+          end
+          },
+          :new => %{
+          def new
+            logger.info 'Qadmin: Default /new'
+            @model_instance = @#{config.model_instance_name} = #{config.model_name}.new
+            respond_to do |format|
+              format.html { render_template_for_section }
+              format.xml  { render :xml => @#{config.model_instance_name} }
+            end
+          end
+          },
+          :create => %{
+          def create
+            logger.info 'Qadmin: Default /create'
+            @model_instance = @#{config.model_instance_name} = #{config.model_name}.new(params[:#{config.model_instance_name}])
+            respond_to do |format|
+              if @#{config.model_instance_name}.save
+                flash[:message] = '#{config.model_human_name} was successfully created.'
+                format.html { redirect_to(#{config.model_instance_name}_path(@#{config.model_instance_name})) }
+                format.xml  { render :xml => @#{config.model_instance_name}, :status => :created, :location => @#{config.model_instance_name} }
+              else
+                format.html { render_template_for_section('new') }
+                format.xml  { render :xml => @#{config.model_instance_name}.errors }
+              end
+            end
+          end
+          },
+          :edit => %{
+          def edit
+            logger.info 'Qadmin: Default /edit'
+            @model_instance = @#{config.model_instance_name} = #{config.model_name}.find(params[:id])
+            respond_to do |format|
+              format.html { render_template_for_section }
+              format.xml  { redirect_to #{config.model_instance_name}_path(@#{config.model_instance_name}) }
+            end
+          end
+          },
+          :update => %{
+          def update
+            logger.info 'Qadmin: Default /update'
+            @model_instance = @#{config.model_instance_name} = #{config.model_name}.find(params[:id])
+
+            respond_to do |format|
+              if @#{config.model_instance_name}.update_attributes(params[:#{config.model_instance_name}])
+                flash[:message] = '#{config.model_human_name} was successfully updated.'
+                format.html { redirect_to(#{config.model_instance_name}_path(@#{config.model_instance_name})) }
+                format.xml  { head :ok }
+              else
+                format.html { render_template_for_section("edit") }
+                format.xml  { render :xml => @#{config.model_instance_name}.errors }
+              end
+            end
+          end
+          },
+          :destroy => %{
+          def destroy
+            logger.info 'Qadmin: Default /destroy'
+            @model_instance =  @#{config.model_instance_name} = #{config.model_name}.find(params[:id])
+            @#{config.model_instance_name}.destroy
+            flash[:message] = "#{config.model_human_name} \#{@#{config.model_instance_name}} was deleted"
+            respond_to do |format|
+              format.html { redirect_to(#{config.model_collection_name}_path) }
+              format.xml  { head :ok }
+            end
+          end
+          }
+        }
+        action_code = actions.collect {|a| action_method_code[a.to_sym] }.join("\n")
+        helper_methods = %{
+          delegate :model_name, :model_klass, :model_collection_name, :model_instance_name, :model_human_name, :to => :qadmin_configuration
+          helper_method :qadmin_configuration, :model_name, :model_instance_name, :model_collection_name, :model_human_name, :available_actions
+        }
+        additional_methods = %{
+          def add_form
+            @origin_div = params[:from]
+            @num = params[:num]
+            @content_type = params[:content_type] || model_instance_name
+            obj = @origin_div.to_s.singularize
+            respond_to do |format|
+              format.js {
+                render :update do |page|
+                  page.insert_html :bottom, @origin_div, :partial => "content_forms/\#{obj}_form", :locals => {obj => nil, :index => @num, :content_type => @content_type}
+                end
+              }
+            end
+          end
+        }
+        action_code = helper_methods << action_code << additional_methods
+        self.class_eval(action_code)
+      end
+    end
+
+  end
+end

data/lib/qadmin/form_builder.rb

@@ -0,0 +1,23 @@
+module Qadmin
+  class FormBuilder < ::ActionView::Helpers::FormBuilder
+    include Qadmin::Assets::FormBuilder
+    
+    def content_form(form_name, options = {})
+      locals = options.reverse_merge({:content_type => object_name, :content => object, :f => self, :options => options})
+      @template.render(:partial => "content_forms/#{form_name}_form", :locals => locals)
+    end
+   
+    def text_field_with_hint(method, options = {})
+      if object.send(method).blank?
+        options[:class] = if options[:class]
+          options[:class] << ' hinted'
+        else 
+          'hinted'
+        end
+        options[:value] = options.delete(:hint)
+      end
+      text_field(method, options)
+    end
+   
+  end
+end

data/lib/qadmin/helper.rb

@@ -0,0 +1,128 @@
+module Qadmin  
+  module Helper    
+    
+    def fieldset(legend = nil, options = {}, &block)
+      concat(content_tag(:fieldset, options) do
+        html = ''
+        html << content_tag(:legend, legend) if legend
+        html << capture(&block)
+        html
+      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')),
+        :export      => link_to(image_tag('admin/icon_export.png') + " Export", general_link_attributes.merge(:action => 'export'))
+      }
+
+      control_sets = {
+        :index => [:new],
+        :new   => [:index],
+        :edit  => [:index,:new,:show,:destroy],
+        :show  => [:index,:new,:edit,:destroy]
+      }
+      
+      control_set = (options[:controls] || []).dup
+      control_set.unshift(control_sets[options[:for]]) if options[:for]
+      control_set << :ports if options[:ports]
+      controls = [control_set].flatten.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)
+      else
+        html << %{</ul>}
+        html
+      end
+    end
+    
+    def sortable_column_header(attribute_name, text = nil, options = {})
+      link_text = text || self.qadmin_configuration.column_headers[attribute_name] || attribute_name.to_s.humanize
+      return link_text unless qadmin_configuration.model_klass.can_query?
+      query_parser = model_restful_query_parser(options)
+      query_param = options[:query_param] || :query
+      logger.warn 'params:' +  self.params[query_param].inspect
+      logger.warn 'parser:' + query_parser.inspect
+      sorting_this = query_parser.sort(attribute_name)
+      logger.warn "sorting #{attribute_name}:" + sorting_this.inspect
+      link_text << " #{image_tag("admin/icon_#{sorting_this.direction.downcase}.gif")}" if sorting_this
+      query_parser.set_sort(attribute_name, sorting_this ? sorting_this.next_direction : 'desc')
+      link_to link_text, self.params.dup.merge(query_param => query_parser.to_query_hash), :class => 'sortable_column_header'
+    end
+    
+    def model_restful_query_parser(options = {})
+      query_param = options[:query_param] || :query
+      qadmin_configuration.model_klass.restful_query_parser(params[query_param], options)
+    end
+        
+    def admin_table(collection, options = {})
+      html = '<table>'
+      html <<	'<tr>'
+      attributes = options[:attributes] || self.qadmin_configuration.display_columns
+      model_column_types = SuperHash.new
+      attributes.each do |attribute_name|
+        column = self.qadmin_configuration.model_klass.columns.detect {|c| c.name == attribute_name.to_s }
+        model_column_types[attribute_name] = column.type if column
+      end
+      attributes.each_with_index do |attribute, i|
+        html << (i == 0 ? '<th class="first_col">' : '<th>')
+        html << sortable_column_header(attribute)
+        html << '</th>'
+      end
+      html << %{
+        <th>View</th>
+        <th>Edit</th>
+        <th>Delete</th>
+        </tr>
+      }
+      collection.each do |instance|
+        html << %{<tr id="#{dom_id(instance)}" #{alt_rows}>}
+        attributes.each_with_index do |attribute, i|
+          raw_value = instance.send(attribute)
+          value = case model_column_types[attribute]
+          when :boolean
+            yes?(raw_value)
+          when :text
+            truncate_words(raw_value, 10, ". . . #{link_to('More', send("#{model_instance_name}_path", instance))}")
+          else
+            h(raw_value)
+          end
+          if i == 0
+            html << %{<td class="first_col">#{link_to(value, send("#{model_instance_name}_path", instance))}</td>}
+          else
+            html << %{<td>#{value}</td>}
+          end
+        end
+        html << %{<td>#{link_to(image_tag('admin/icon_show.png'), send("#{model_instance_name}_path", instance))}</td>}
+        html << %{<td>#{link_to(image_tag('admin/icon_edit.png'), send("edit_#{model_instance_name}_path", instance))}</td>}
+        html << %{<td>#{link_to(image_tag('admin/icon_destroy.png'), send("#{model_instance_name}_path", instance), :confirm => 'Are you sure?', :method => :delete)}</td>}
+        html << '</tr>'
+      end
+      html << '</table>'
+    end
+
+    def alt_rows
+      %{class="#{cycle('alt', '')}"}
+    end
+
+  end
+end