admin_assistant 1.0.0 → 1.0.1

data/test_rails_app/README

@@ -0,0 +1,256 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create 
+database-backed web applications according to the Model-View-Control pattern. 
+
+This pattern splits the view (also called the presentation) into "dumb" templates
+that are primarily responsible for inserting pre-built data in between HTML tags.
+The model contains the "smart" domain objects (such as Account, Product, Person,
+Post) that holds all the business logic and knows how to persist themselves to
+a database. The controller handles the incoming requests (such as Save New Account,
+Update Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel and lighttpd if they are installed, otherwise
+Rails will use WEBrick, the webserver that ships with Ruby. When you run script/server,
+Rails will check if Mongrel exists, then lighttpd and finally fall back to WEBrick. This ensures
+that you can always get up and running quickly.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+If Mongrel is not installed, Rails will look for lighttpd. It's considerably faster than
+Mongrel and WEBrick and also suited for production use, but requires additional
+installation and currently only works well on OS X/Unix (Windows users are encouraged
+to start with Mongrel). We recommend version 1.4.11 and higher. You can download it from
+http://www.lighttpd.net.
+
+And finally, if neither Mongrel or lighttpd are installed, Rails will use the built-in Ruby
+web server, WEBrick. WEBrick is a small Ruby web server suitable for development, but not
+for production.
+
+But of course its also possible to run Rails on any platform that supports FCGI.
+Apache, LiteSpeed, IIS are just a few. For more information on FCGI,
+please visit: http://wiki.rubyonrails.com/rails/pages/FastCGI
+
+
+== Apache .htaccess example
+
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# 
+# Example:
+#   RewriteCond %{REQUEST_URI} ^/notrails.*
+#   RewriteRule .* - [L]
+
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# 
+# For better performance replace the dispatcher with the fastcgi one
+#
+# Example:
+#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+#
+# Example:
+#   Alias /myrailsapp /path/to/myrailsapp/public
+#   RewriteBase /myrailsapp
+
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# 
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong.  Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files.  Have "tail -f" commands running
+on the server.log and development.log. Rails will automatically display debugging
+and runtime information to these files. Debugging info will also be shown in the
+browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your Mongrel or
+Webrick server with --debugger. This means that you can break out of execution at any point
+in the code, investigate and change the model, AND then resume execution! 
+You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
+Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
+You would be connected to the database with the credentials defined in database.yml.
+Starting the script without arguments will connect you to the development database. Passing an
+argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from ApplicationController
+  which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the common
+  header/footer method of wrapping views. In your views, define a layout using the
+  <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
+  call <% yield %> to render the view using this layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are generated
+  for you automatically when using script/generate for controllers. Helpers can be used to
+  wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files. This should be
+  set as the DOCUMENT_ROOT of your web server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  If the app has frozen rails, those gems also go here, under vendor/rails/.
+  This directory is in the load path.

data/test_rails_app/Rakefile

@@ -0,0 +1,13 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'
+
+task :default => [:spec, :test]
+

data/test_rails_app/app/controllers/admin/appointments2_controller.rb

@@ -0,0 +1,15 @@
+class Admin::Appointments2Controller < ApplicationController
+  layout 'admin'
+
+  admin_assistant_for Appointment do |a|
+    a.form.multi = true
+  end
+  
+  protected
+  
+  def time_from_form(time)
+    time['1-3i'] =~ /(\d{4})-(\d{2})-(\d{2})/
+    utc_args = [$1, $2, $3, time['4i'], time['5i']]
+    Time.utc(*(utc_args.map(&:to_i))) unless utc_args.any?(&:blank?)
+  end
+end

data/test_rails_app/app/controllers/admin/appointments_controller.rb

@@ -0,0 +1,11 @@
+class Admin::AppointmentsController < ApplicationController
+  layout 'admin'
+
+  admin_assistant_for Appointment do |a|
+    a.form.multi = true
+    a.index.search do |search|
+      search.columns :subject, :time, :user
+      search[:time].compare_to_range = true
+    end
+  end
+end

data/test_rails_app/app/controllers/admin/blog_posts2_controller.rb

@@ -0,0 +1,138 @@
+class Admin::BlogPosts2Controller < ApplicationController
+  layout 'admin'
+
+  admin_assistant_for BlogPost do |a|
+    a[:user].label = 'Author'
+    
+    # When showing the textile field, say 'Yes' and 'No' instead of 'true'
+    # and 'false'
+    a[:textile].boolean_labels = %w(Yes No)
+        
+    # For the index view:
+    a.index do |index|
+      # Only show these columns
+      index.columns :user, :title, :tags, :published_at, :textile
+      
+      # Add the link 'All' to the top-right corner
+      index.actions['All'] = {:all => '1'}
+      
+      # Sort by published_at descending, then updated_at descending
+      index.sort_by "published_at desc, updated_at desc"
+      
+      # Show only 10 blog posts per page
+      index.per_page 10
+      
+      # Let's have specific fields for searching
+      index.search :id, :title, :body, :textile, :user
+      
+      # Make the author field a link
+      index[:user].link_to_args do |blog_post|
+        { :controller => 'admin/users', :action => 'edit',
+          :id => blog_post.user_id }
+      end
+
+      index.header do |params|
+        if params[:all]
+          "Blog posts (all)"
+        else
+          "Blog posts (unpublished)"
+        end
+      end
+    end
+    
+    # For any form page:
+    a.form do |form|
+      # Only show inputs for these fields
+      form.columns :user, :title, :body, :tags, :textile, :publish
+      
+      # 'publish' isn't defined on BlogPost, we have to specify that it's a
+      # check box
+      form[:publish].input = :check_box
+      
+      # In addition to the 'Create'/'Update' button at the bottom, we also have
+      # a 'Preview' button
+      form.submit_buttons << 'Preview'
+      
+      form[:publish].description =
+          "Click this and published_at will be set automatically"
+        
+      form[:user].select_options = {:include_blank => false}
+      
+      form[:body].text_area_options = {:cols => 20, :rows => 40}
+    end
+    
+    # Only show some columns on the show page
+    a.show.columns :user, :title, :body, :tags, :textile, :published_at
+  end
+  
+  protected
+  
+  # This is run after all saves, whether they're creates or updates
+  def after_save(blog_post)
+    unless blog_post.tags.empty?
+      blog_post.update_attribute(:tags_string, blog_post.tags.map(&:tag).join(','))
+    end
+  end
+  
+  # This is run before all saves, whether they're creates or updates
+  def before_save(blog_post)
+    if params[:blog_post][:publish] == '1' && blog_post.published_at.nil?
+      blog_post.published_at = Time.now.utc
+    end
+  end
+  
+  # This is run in the controller context, just before render is called
+  def before_render_for_index
+    if @index.records.any?
+      @var_set_by_before_render_for_index_hook = 'Confirmed that we have some records'
+    end
+  end
+  
+  # By default, only show unpublished blog posts unless params[:all] is
+  # passed in
+  def conditions_for_index
+    "published_at is null" unless params[:all]
+  end
+
+  # After a successful save, redirect to the edit page with preview=1 to show
+  # the preview pane. The HTML for the preview pane is generated in
+  # app/views/admin/blog_posts2/_after_form.html.erb
+  def destination_after_save(blog_post, params)
+    if params[:commit] == 'Preview'
+      {:action => 'edit', :id => blog_post.id, :preview => '1',
+       :origin => params[:origin]}
+    end
+  end
+  
+  # Preprocesses the 'tags' string from the form to an array of Tag objects.
+  # That way admin_assistant can say
+  #
+  #   blog_post.tags = params[:tags]
+  #
+  # and this will work fine with the BlogPost#tags association
+  def tags_from_form(tags_string, record_params, errors)
+    tags = tags_string.split(/\s+/).map { |tag_str|
+      Tag.find_by_tag(tag_str) || Tag.create(:tag => tag_str)
+    }
+    bad_tags = tags.select { |t| !t.valid? }
+    unless bad_tags.empty?
+      error_str = if bad_tags.size == 1
+        "contain invalid string '#{bad_tags.first.tag}'"
+      else
+        "contain invalid strings " +
+            bad_tags.map { |t| "'#{t.tag}'" }.join(',')
+      end
+      errors.add(:tags, error_str)
+    end
+    tags
+  end
+  
+  def validate(blog_post)
+    pub_str = params[:blog_post][:publish]
+    unless pub_str.nil? or [true, false, '0', '1'].include?(pub_str)
+      blog_post.errors.add(
+        :publish, "can't be \"#{params[:blog_post][:publish]}\""
+      )
+    end
+  end
+end

data/test_rails_app/app/controllers/admin/blog_posts3_controller.rb

@@ -0,0 +1,76 @@
+class Admin::BlogPosts3Controller < ApplicationController
+  layout 'admin'
+
+  admin_assistant_for BlogPost do |a|
+    a.model_class_name = 'post'
+    
+    a[:has_short_title].boolean_labels = %w(Yes No)
+    a[:published?].boolean_labels = %w(Yes No)
+
+    a.index do |index|
+      index.columns :id, :title, :created_at, :updated_at, :body, :textile,
+                    :published?, :user
+                    
+      index[:textile].ajax_toggle = false
+      
+      index.actions['All'] = {:all => '1'}
+      index.actions['Short title'] = {:short_title => '1'}
+      index.actions['Blank body'] = {:blank_body => '1'}
+      
+      # By default, only show unpublished blog posts unless params[:all] is
+      # passed in. This needs to work with or without use of the field search
+      # feature
+      index.conditions do |params|
+        if params[:all]
+        elsif params[:blank_body]
+          "(body is null or body = '')"
+        elsif params[:short_title]
+          "length(title) < 10"
+        else
+          'published_at is null'
+        end
+      end
+      
+      index.cache_total_entries 12.hours
+      
+      # Extended search configuration
+      index.search do |search|
+        search.columns :id, :title, :body, :textile, :user, :has_short_title
+        search[:body].blank_checkbox = true
+        search[:has_short_title].field_type = :boolean
+        search[:has_short_title].conditions do |has_short_title|
+          if has_short_title
+            "length(title) < 10"
+          elsif has_short_title == false
+            "length(title) >= 10"
+          end
+        end
+        search[:id].comparators = false
+        search[:user].match_text_fields_for_association
+      end
+      
+      # sort by user by default
+      index.sort_by :user
+    end
+    
+    a.form do |form|
+      form.columns_for_new  :title, :user, :published_at
+      form.columns_for_edit :title, :user, :published_at, :body, :merged_into
+      form[:published_at].datetime_select_options =
+          {:include_blank => false, :start_year => 2009}
+      form[:published_at].default do |controller|
+        controller.time_now_utc
+      end
+    end
+  end
+  
+  def time_now_utc
+    Time.now.utc
+  end
+  
+  protected
+  
+  def before_validation(blog_post)
+    blog_post.title = '(draft)' if blog_post.title.blank?
+  end
+end

data/test_rails_app/app/controllers/admin/blog_posts4_controller.rb

@@ -0,0 +1,21 @@
+class Admin::BlogPosts4Controller < ApplicationController
+  layout 'admin'
+
+  admin_assistant_for BlogPost do |a|
+    a[:published_at].strftime_format = "%b %d, %Y %H:%M:%S"
+    
+    a.index do |index|
+      index.columns :user, :title, :tags, :published_at, :textile
+      index.search :id, :title, :body, :textile, :user, :published_at
+      
+      index.total_entries do
+        25
+      end
+    end
+    
+    a.form do |form|
+      form.columns :title, :body, :textile, :published_at, :user, :virtual_text
+      form[:virtual_text].input = :text_area
+    end
+  end
+end

data/test_rails_app/app/controllers/admin/blog_posts5_controller.rb

@@ -0,0 +1,27 @@
+class Admin::BlogPosts5Controller < ApplicationController
+  layout 'admin'
+
+  admin_assistant_for BlogPost do |a|
+    a.index do |index|
+      index.conditions do |params|
+        "user_id = #{params[:filter]}" unless params[:filter].blank?
+      end
+      
+      index.columns :user, :title, :tags, :published_at, :textile
+      
+      index.search.include_params_in_form = true
+    end
+    
+    a.form.columns :user, :title, :title_alt
+  end
+  
+  protected
+  
+  def title_from_form(title_str, record_params)
+    if title_str.blank?
+      record_params[:title_alt]
+    else
+      title_str
+    end
+  end
+end

data/test_rails_app/app/controllers/admin/blog_posts6_controller.rb

@@ -0,0 +1,10 @@
+class Admin::BlogPosts6Controller < ApplicationController
+  layout 'admin'
+
+  admin_assistant_for BlogPost do |a|
+    a.actions.delete :create
+    a.actions.delete :update
+    a.actions.delete :show
+  end
+  
+end

data/test_rails_app/app/controllers/admin/blog_posts_controller.rb

@@ -0,0 +1,8 @@
+class Admin::BlogPostsController < ApplicationController
+  layout 'admin'
+  
+  # silly class method defined on application.rb, should be available here
+  do_something
+
+  admin_assistant_for BlogPost
+end

data/test_rails_app/app/controllers/admin/blog_posts_custom_new_and_edit_controller.rb

@@ -0,0 +1,15 @@
+class Admin::BlogPostsCustomNewAndEditController < ApplicationController
+  layout 'admin'
+  
+  admin_assistant_for BlogPost do |a|
+    a.actions :index, :show, :destroy
+  end
+  
+  def new
+    render :text => 'custom form for new'
+  end
+  
+  def edit
+    render :text => 'custom form for edit'
+  end
+end

data/test_rails_app/app/controllers/admin/blog_posts_read_only_controller.rb

@@ -0,0 +1,19 @@
+class Admin::BlogPostsReadOnlyController < ApplicationController
+  layout 'admin'
+  
+  admin_assistant_for BlogPost do |a|
+    a.model_class_name = 'blog post'
+    a.actions :index, :show
+    
+    a.show do |show|
+      show.columns :user, :title, :body
+      show.model_class_name do |blog_post|
+        if blog_post.published?
+          'published blog post'
+        else
+          'unpublished blog post'
+        end
+      end
+    end
+  end
+end

data/test_rails_app/app/controllers/admin/bookmarks_controller.rb

@@ -0,0 +1,11 @@
+class Admin::BookmarksController < ApplicationController
+  layout 'admin'
+
+  admin_assistant_for Bookmark do |a|
+    a[:bookmarkable].polymorphic_types = [BlogPost, Comment, Product, User]    
+
+    a.index.search :user, :bookmarkable
+    
+    a.form[:user].select_options = {:include_blank => false}
+  end
+end

data/test_rails_app/app/controllers/admin/comments2_controller.rb

@@ -0,0 +1,14 @@
+class Admin::Comments2Controller < ApplicationController
+  layout 'admin'
+
+  admin_assistant_for Comment do |a|
+    a.index do |index|
+      index.conditions 'blog_posts.published_at is not null'
+      index.include    :blog_post
+    end
+    
+    a.form do |form|
+      form[:comment].write_once
+    end
+  end
+end

data/test_rails_app/app/controllers/admin/comments_controller.rb

@@ -0,0 +1,12 @@
+class Admin::CommentsController < ApplicationController
+  layout 'admin'
+
+  admin_assistant_for Comment do |a|
+    a.form[:comment].read_only
+    
+    a.index do |index|
+      index.conditions "comment like '%smart%'"
+      index.search.default_search_matches_on << :id
+    end
+  end
+end

data/test_rails_app/app/controllers/admin/file_column_images2_controller.rb

@@ -0,0 +1,10 @@
+class Admin::FileColumnImages2Controller < ApplicationController
+  layout 'admin'
+
+  admin_assistant_for FileColumnImage do |a|
+    a.index do |i|
+      i.columns :image
+      i[:image].image_size = '300x500'
+    end
+  end
+end

data/test_rails_app/app/controllers/admin/file_column_images_controller.rb

@@ -0,0 +1,6 @@
+class Admin::FileColumnImagesController < ApplicationController
+  layout 'admin'
+
+  admin_assistant_for FileColumnImage do |a|
+  end
+end