Browse files

Completed example

  • Loading branch information...
1 parent dff13c8 commit afb04fd9d32e04fb6f6e71e37ebd4da5554f983e @binarylogic committed Sep 7, 2008
@@ -0,0 +1,20 @@
+Copyright (c) 2007 Ben Johnson of Binary Logic (
+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.
@@ -1,256 +0,0 @@
-== 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
-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
-== 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:
-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
-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:
-== 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
-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
-"#{} Destroyed 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
-Also, Ruby documentation can be found at including:
-* The Learning Ruby (Pickaxe) Book:
-* Learn to Program: (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'
- 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
- Holds all the code that's specific to this particular application.
- 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.
- Holds models that should be named like post.rb.
- Most models will descend from ActiveRecord::Base.
- 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.
- 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.
- 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.
- Configuration files for the Rails environment, the routing map, the database, and other dependencies.
- Contains the database schema in schema.rb. db/migrate contains all
- the sequence of Migrations for your schema.
- This directory is where your application documentation will be stored when generated
- using <tt>rake doc:app</tt>
- 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.
- 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.
- Helper scripts for automation and generation.
- 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.
- 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.
@@ -0,0 +1,20 @@
+= Searchgasm Example
+This is an example of how to use Searchgasm in a rails app. Searchgasm is simple searching, ordering, and pagination all in one plugin.
+Checkout Searchgasm here:
+Quick tutoiral on how to build this application here:
+=== Key files
+Here are the files you want to glance at:
+1. app/controllers/users_controller.rb
+2. app/views/users
+3. app/controllers/orders_controller.rb (same as users, but AJAX)
+4. app/views/orders
+5. config/initializers/searchgasm.rb
+Copyright (c) 2008 [Ben Johnson]( of [Binary Logic](, released under the MIT license
@@ -6,7 +6,7 @@ class ApplicationController < ActionController::Base
# See ActionController::RequestForgeryProtection for details
# Uncomment the :secret if you're not using the cookie session store
- protect_from_forgery # :secret => 'e619585c1ea01344f19d504e61dd6e3d'
+ #protect_from_forgery # :secret => 'e619585c1ea01344f19d504e61dd6e3d'
# See ActionController::Base for details
# Uncomment this to filter the contents of submitted sensitive data parameters
@@ -1,12 +1,7 @@
class OrdersController < ApplicationController
def index
- # This creates a new search object to search for users. It's safe to pass params into here because
- # new_search and new_conditions are protected, meaning the structure of the params hash is run through
- # checks to ensure there is no SQL injection or anything invalid. This ultimately allows you to create a controllers action
- # that searches, orders, and paginates in 2 lines.
- @search = User.new_search(params[:search])
- # .all takes pagination into account. .count tells you how many records will be returned disregarding the limit and offset options.
- @users, @users_count = @search.all, @search.count
+ # Please see users_controller.rb for comments and information on this code.
+ @search = Order.new_search(params[:search])
+ @orders, @orders_count = @search.all, @search.count
@@ -7,8 +7,9 @@ def index
# This also gives people using your site as a service some real flexibility when it comes to searching. The sky is the limit on how they want to search, unless you restrict them.
# Restricting conditions works similar to ActiveRecord's attr_protected and attr_accessible. See the documentation for more details.
@search = User.new_search(params[:search])
# .all takes pagination into account. .count tells you how many records will be returned disregarding the limit and offset options.
@users, @users_count = @search.all, @search.count
@@ -1,3 +1,4 @@
class User < ActiveRecord::Base
+ belongs_to :user_group
has_many :orders
@@ -0,0 +1,3 @@
+class UserGroup < ActiveRecord::Base
+ has_many :users
@@ -5,6 +5,23 @@
<%= calendar_date_select_includes %>
+ <h1 style="font-size: 1.5em">Searchgasm example</h1>
+ This is a simple / plain example of how to implement Searchgasm into a rails application. As you can see it supports searching, ordering, and pagination all in one plugin. Here are some helpful links:<br />
+ <br />
+ <strong><a href="">Source code for this example</a>&nbsp;&nbsp;|&nbsp;&nbsp;Tutorial on this example&nbsp;&nbsp;|&nbsp;&nbsp;<a href="">Searchgasm source / repository</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="">Searchgasm documentation</a></strong><br />
+ <br />
+ <% if controller_name == "users" %>
+ Non AJAX Example
+ <% else %>
+ <%= link_to "Non AJAX example", users_path %>
+ <% end %>
+ &nbsp;&nbsp;|&nbsp;&nbsp;
+ <% if controller_name == "orders" %>
+ AJAX Example
+ <% else %>
+ <%= link_to "AJAX example", orders_path %>
+ <% end %><br />
+ <br />
<%= yield %>
Oops, something went wrong.

0 comments on commit afb04fd

Please sign in to comment.