MIT-LICENSE
README.rdoc
app/models/user_group.rb
app/views/orders/_orders.erb
app/views/orders/index.html.erb
app/views/orders/index.js.rjs
db/migrate/20080906191540_create_user_groups.rb
db/migrate/20080906191555_users_to_user_groups.rb
db/migrate/20080906205538_create_sessions.rb
test/fixtures/user_groups.yml
test/unit/user_group_test.rb
@@ -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
app/controllers/application.rb
@@ -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
end
end
\ No newline at end of file
app/controllers/orders_controller.rb
@@ -7,8 +7,9 @@ class UsersController < ApplicationController
#
# 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
end
app/controllers/users_controller.rb
@@ -1,3 +1,4 @@
class User < ActiveRecord::Base
+ belongs_to :user_group
has_many :orders
end
app/models/user.rb
@@ -5,6 +5,23 @@
<%= calendar_date_select_includes %>
</head>
<body>
+ <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="http://github.com/binarylogic/searchgasm_example">Source code for this example</a> | Tutorial on this example | <a href="http://github.com/binarylogic/searchgasm">Searchgasm source / repository</a> | <a href="http://searchgasm.rubyforge.org">Searchgasm documentation</a></strong><br />
+ <br />
+ <% if controller_name == "users" %>
+ Non AJAX Example
+ <% else %>
+ <%= link_to "Non AJAX example", users_path %>
+ <% end %>
+ |
+ <% if controller_name == "orders" %>
+ AJAX Example
+ <% else %>
+ <%= link_to "AJAX example", orders_path %>
+ <% end %><br />
+ <br />
<%= yield %>
</body>
</html>
\ No newline at end of file
app/views/layouts/application.html.erb
@@ -2,35 +2,50 @@
You can pass your search object right into form_for or remote_form_for and it will do the rest. Just like passing an ActiveRecord attribute. Use it the same way:
Need to scope the search? form_for([@current_user, @search])
+Need to namespace the search? form_for([:admin, @search])
Want to specify your own url? form_for(@search, :url => whatever_path)
Need to specify your own name? form_for(:whatever, @search)
-The beauty of this is that it recoginizes that its a search object and helps you out. It adds 3 hidden fields for you:
+The beauty of this is that it recognizes that its a search object and helps you out. It adds 3 hidden fields for you:
1. order_by
2. order_as
2. per_page
-This way when people start a new search those 3 things will be "remembered" and the results will be displayed in that manner.
+This way when people start a new search those 3 things will be "remembered" and the results will be displayed in that manner. If you don't want to include these simply do:
+
+form_for(@search, :hidden_fields => [])
+
+or
+
+form_for(@search, :hidden_fields => :per_page) for only the per_page option
+
+or
+
+form_for(@search, :hidden_fields => [:order_by, :order_as]) for only the order_by and order_as options
+
+For more information please see Searchgasmm::Helpers::FormHelper
-->
+
<% form_for @search do |f| %>
<fieldset>
- <legend>Search</legend>
+ <legend>Search Users</legend>
<% f.fields_for @search.conditions do |users| %>
<!--
You can specify ANY of the conditions available on ANY of the attributes. Adding a condition and having it be a part
of the search is as simple as adding another form element.
-->
- First name:<br />
+ First name keywords:<br />
<%= users.text_field :first_name_keywords %><br />
<br />
+ <!-- This is a custom condition, checkout config/initializers/searchgasm.rb -->
First name sounds like: (try "bin", this is a custom condition, checkout config/initializers/searchgasm.rb)<br />
<%= users.text_field :first_name_sounds_like %><br />
<br />
- Last name:<br />
+ Last name keywords:<br />
<%= users.text_field :last_name_keywords %><br />
<br />
@@ -56,6 +71,12 @@ This way when people start a new search those 3 things will be "remembered" and
$<%= orders.text_field :total_gt %><br />
<br />
<% end %>
+
+ <% users.fields_for users.object.user_group do |user_group| %>
+ Belongs to user group with name that starts with:<br />
+ <%= user_group.text_field :name_starts_with %><br />
+ <br />
+ <% end %>
<%= f.submit "Search" %>
<% end %>
</fieldset>
@@ -63,23 +84,42 @@ This way when people start a new search those 3 things will be "remembered" and
<% if @users_count > 0 %>
<%= @users_count %> users found
- <table>
+ <table border="1" cellpadding="5">
<tr>
<!--
- order_by allows you to create a link to order the data by that coloumn. You aren't limited to the local columns. Since users belong to user groups we could do
+ order_by allows you to create a link to order the data by that coloumn. You aren't limited to the local columns. If users belonged to user groups we could do:
order_by(:user_group => :name)
- You can traverse through your relationships to define how things are ordered. There are a lot of options for this to allow you to customize it to your liking. Please
- glance at the Searchgasm::Helpers module for a list of options.
+ If user groups belongs to accounts we could do:
+
+ order_by(:user_group => {:account => :name})
+
+ You can traverse through your relationships to define how things are ordered.
+
+ All that order_by does is create a bunch of options and then spit it out as a link. If for some reason you don't want it to output a link you can pass it a block and do anything you want:
+
+ <%= order_by(:id) { |options| link_to(options[:text], options[:url]) } %>
+
+ or
+
+ <% order_by(:id) do |options| %><%= link_to(options[:text], options[:url]) %><% end %>
+
+ The options variable passes back the same options you are allowed to input, but with values.
+
+ There are a lot of options for this to allow you to customize it to your liking. Please
+ glance at the Searchgasm::Helpers::SearchHelper module for a list of options.
-->
<th><%= order_by :id %></th>
- <th><%= order_by :first_name %></th>
- <th><%= order_by :last_name %></th>
- <th><%= order_by :email %></th>
+ <th><%= order_by :user_group => :name %></th> <!-- order user_groups.name ASC -->
+ <th><% order_by(:first_name) do |options| %><%= link_to(options[:text], options[:url]) %><% end %></th>
+ <th><%= order_by(:last_name) { |options| link_to(options[:text], options[:url]) } %></th>
+ <th><%= order_by [:email, :first_name] %></th> <!-- order email ASC, first_name ASC -->
+ </tr>
<% @users.each do |user| %>
<tr>
<td><%= user.id %></td>
+ <td><%= user.user_group ? user.user_group.name : "-" %></td>
<td><%= user.first_name %></td>
<td><%= user.last_name %></td>
<td><%= user.email %></td>
@@ -90,12 +130,12 @@ This way when people start a new search those 3 things will be "remembered" and
<br />
<br />
<!--
- Per page returns a select with the different options. This is very customizable, you can change just about anything. Please take a look at the Searchgasm::Helpers documentation for options
+ Per page returns a select with the different options. You can return links by passing :type => :links option, or just like order by, you can pass it a block and it will spit out the result of the block. This is very customizable, you can do anything you want with this. Please take a look at the Searchgasm::Helpers::SearchHelper documentation for options
-->
Per page: <%= per_page %>
<!--
- Page returns a drop down with the page options. You can change this from a drop down to a links. It's completely customizable. Please take a look at the Searchgasm::Helpers documentation for options
+ Page returns a drop down with the page options. You can return a flickr like navigation by passing :type => :links option, or just like order by, you can pass it a block and it will spit out the result of the block. It's completely customizable. Please take a look at the Searchgasm::Helpers::SearchHelper documentation for options
-->
<% if @search.page_count > 1 %>
<br />
app/views/users/index.html.erb
@@ -50,15 +50,15 @@ Rails::Initializer.run do |config|
# If you change this key, all old sessions will become invalid!
# Make sure the secret is at least 30 characters and all random,
# no regular words or you'll be exposed to dictionary attacks.
- config.action_controller.session = {
- :session_key => '_searchgasm_example_session',
- :secret => '4d7db02f53d3bccd73428357072797fb6b04507ad3ef08f0abc589c2f1a6ee8f10e71bdbbc357f8fd50a7620f4bb433836e18017517a9df9df70c910fa3006c8'
- }
+ #config.action_controller.session = {
+ # :session_key => '_searchgasm_example_session',
+ # :secret => '4d7db02f53d3bccd73428357072797fb6b04507ad3ef08f0abc589c2f1a6ee8f10e71bdbbc357f8fd50a7620f4bb433836e18017517a9df9df70c910fa3006c8'
+ #}
# Use the database for sessions instead of the cookie-based default,
# which shouldn't be used to store highly confidential information
# (create the session table with "rake db:sessions:create")
- # config.action_controller.session_store = :active_record_store
+ config.action_controller.session_store = :active_record_store
# Use SQL instead of Active Record's schema dumper when creating the test database.
# This is necessary if your schema can't be completely dumped by the schema dumper,
config/environment.rb
README
dff13c816498d695040eb20bf737aa9ce17d5ac5
Ben Johnson
bjohnson@binarylogic.com
http://github.com/binarylogic/searchlogic_example/commit/afb04fd9d32e04fb6f6e71e37ebd4da5554f983e
afb04fd9d32e04fb6f6e71e37ebd4da5554f983e
2008-09-06T18:49:49-07:00
2008-09-06T18:49:49-07:00
Completed example
867242222e0b00a9a1f2d7e206045beb905ab156
Ben Johnson
bjohnson@binarylogic.com