quirkey-qadmin 0.1.1 → 0.2.0

data/History.txt

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

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

@@ -1,24 +1,37 @@
 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/views/edit.html.erb
-lib/qadmin/views/index.html.erb
-lib/qadmin/views/new.html.erb
-lib/qadmin/views/show.html.erb
+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_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
@@ -29,16 +42,11 @@ 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
+test/test_qadmin_generator.rb
+test/test_qadmin_option_set.rb

data/PostInstall.txt

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

data/README.rdoc

@@ -6,7 +6,7 @@ http://github.com/quirkey/qadmin
 
 An [almost] one command solution for adding admin interfaces/resources to a Rails app. 
 
-== FEATURES/PROBLEMS:
+== 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. 
 
@@ -14,13 +14,9 @@ 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:
+For full details and usage please see the website at:
 
-Right now, a rails app, but the eventual goal is to make it framework agnostic (work with Sinatra, etc, too)..
+http://code.quirkey.com/qadmin
 
 == INSTALL:
 
@@ -40,25 +36,4 @@ Then in your config/environment.rb
 
 == 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.
+MIT-LICENSE - See LICENSE

data/Rakefile

@@ -8,12 +8,14 @@ $hoe = Hoe.new('qadmin', Qadmin::VERSION) do |p|
   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.2.0'],
-    ['restful_query','>= 0.1.0']
+    ['activesupport','>= 2.3.2'],
+    ['restful_query','>= 0.2.0']
   ]
   p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
+    ['newgem', ">= #{::Newgem::VERSION}"],
+    ['Shoulda', ">= 1.2.0"]
   ]
   
   p.clean_globs |= %w[**/.DS_Store tmp *.log]

data/lib/qadmin.rb

@@ -6,13 +6,15 @@ unless defined?(ActiveSupport)
 end
 
 module Qadmin
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end
 
 %w{
-  options
+  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

@@ -5,25 +5,29 @@ module Qadmin
       
       
       def qadmin(options = {})
-        extend ::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.extract_model_from_options(options)
-        self.append_view_path(File.join(File.dirname(__FILE__), 'views'))
+        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
-        define_admin_actions(available_actions, options)
+        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
-            @model_collection = @#{model_collection_name} = #{model_name}.paginate(:page => (params[:page] || 1))
+            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
@@ -32,65 +36,75 @@ module Qadmin
           },
           :show => %{
           def show
-            @model_instance = @#{model_instance_name} = #{model_name}.find(params[:id])
+            logger.info 'Qadmin: Default /show'
+            @model_instance = @#{config.model_instance_name} = #{config.model_name}.find(params[:id])
             respond_to do |format|
-              format.html
+              format.html { render_template_for_section }
               format.xml
             end
           end
           },
           :new => %{
           def new
-            @model_instance = @#{model_instance_name} = #{model_name}.new
+            logger.info 'Qadmin: Default /new'
+            @model_instance = @#{config.model_instance_name} = #{config.model_name}.new
             respond_to do |format|
-              format.html # new.html.erb
-              format.xml  { render :xml => @#{model_instance_name} }
+              format.html { render_template_for_section }
+              format.xml  { render :xml => @#{config.model_instance_name} }
             end
           end
           },
           :create => %{
           def create
-            @model_instance = @#{model_instance_name} = #{model_name}.new(params[:#{model_instance_name}])
+            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 @#{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} }
+              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 :action => "new" }
-                format.xml  { render :xml => @#{model_instance_name}.errors }
+                format.html { render_template_for_section('new') }
+                format.xml  { render :xml => @#{config.model_instance_name}.errors }
               end
             end
           end
           },
           :edit => %{
           def edit
-            @model_instance = @#{model_instance_name} = #{model_name}.find(params[:id])
+            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
-            @model_instance = @#{model_instance_name} = #{model_name}.find(params[:id])
+            logger.info 'Qadmin: Default /update'
+            @model_instance = @#{config.model_instance_name} = #{config.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})) }
+              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 :action => "edit" }
-                format.xml  { render :xml => @#{model_instance_name}.errors }
+                format.html { render_template_for_section("edit") }
+                format.xml  { render :xml => @#{config.model_instance_name}.errors }
               end
             end
           end
           },
           :destroy => %{
           def destroy
-            @model_instance =  @#{model_instance_name} = #{model_name}.find(params[:id])
-            @#{model_instance_name}.destroy
-            flash[:message] = "#{model_human_name} \#{@#{model_instance_name}} was deleted"
+            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(#{model_collection_name}_path) }
+              format.html { redirect_to(#{config.model_collection_name}_path) }
               format.xml  { head :ok }
             end
           end
@@ -98,9 +112,25 @@ module Qadmin
         }
         action_code = actions.collect {|a| action_method_code[a.to_sym] }.join("\n")
         helper_methods = %{
-          helper_method :model_name, :model_instance_name, :model_collection_name, :model_human_name, :model_klass, :available_actions
+          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
+        action_code = helper_methods << action_code << additional_methods
         self.class_eval(action_code)
       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