app/models/list.rb test/fixtures/lists.yml test/unit/list_test.rb @@ -1,6 +1,7 @@ class ListitemsController < ApplicationController before_filter :activation_required, :only=>[:new, :create, :edit, :update, :destroy] + before_filter :setup def new pre_new @@ -13,7 +14,7 @@ class ListitemsController < ApplicationController pre_new @success = @listitem.save if @success - message = "The #{@listitem.item.class.name} was added to your “#{@listitem.title}” list." + message = "The #{@listitem.item.class.name} was added to your “#{@list.title}” list." respond_to do |format| format.html do flash[:notice] = message @@ -23,7 +24,7 @@ class ListitemsController < ApplicationController format.xml { render :xml=>@listitem.to_xml } end else - flash.now[:error] = "Unable to add the #{@listitem.item.class.name} to your “#{@listitem.title}” list." + flash.now[:error] = "Unable to add the #{@listitem.item.class.name} to your “#{@list.title}” list." respond_to do |format| format.html { render :action=>'new' } format.js {} @@ -45,14 +46,14 @@ class ListitemsController < ApplicationController def destroy @listitem = Listitem.find(params[:id]) - if @listitem.user == current_user or current_user.admin? + if @listitem.list.user == current_user or current_user.admin? @listitem.destroy @success = true end respond_to do |format| format.html do if @success - flash[:notice] = "The #{@listitem.item.class.name} has been removed from your “#{@listitem.title}” list." + flash[:notice] = "The #{@listitem.item.class.name} has been removed from your “#{@list.title}” list." redirect_to lists_path else flash[:error] = 'That is not a list you have access to modify.' @@ -61,8 +62,8 @@ class ListitemsController < ApplicationController end format.js do if @success - @listitem_count = Listitem.count_user_list(current_user, @listitem.title) - flash.now[:notice] = "The #{@listitem.item.class.name} has been removed from your “#{@listitem.title}” list." + @listitem_count = @list.listitems.count + flash.now[:notice] = "The #{@listitem.item.class.name} has been removed from your “#{@list.title}” list." else flash.now[:error] = 'That is not a list you have access to modify.' end @@ -73,15 +74,28 @@ class ListitemsController < ApplicationController missing end + protected + def setup + if params[:list_id].blank? + @list = List.find_default_list_for_user(current_user) + else + @list = List.find(params[:list_id]) rescue ActiveRecord::RecordNotFound + end + if @list.nil? + @list = List.new(:title=>'') + @list.user = current_user + end + @section = 'lists' + @page_title = @list.nil? ? '' : "#{@list.title}: " + end + def pre_new - @listitem = Listitem.new(params[:listitem]) + @listitem = @list.listitems.new(params[:listitem]) @listitem.item_type ||= params[:item_type] @listitem.item_id ||= params[:item_id] - @listitem.title ||= params[:title] - @listitem.user = current_user - @page_title = 'Add item to your list' + @page_title += 'Add item to your list' if @listitem.item.nil? @err_msg = 'No item was specified — nothing to add to a list.' raise Wayground::NilObject app/controllers/listitems_controller.rb @@ -3,17 +3,18 @@ class ListsController < ApplicationController def index @page_title = 'Your Lists' - @lists = Listitem.find_lists_for_user(current_user) + @lists = List.find(:all, :conditions=>List.search_conditions(:user=>current_user), + :order=>List.default_order, :include=>List.default_include) end def show - @page_title = "Your List: #{h(params[:id])}" - @listitems = Listitem.find(:all, :order=>Listitem.default_order, - :conditions=>Listitem.search_conditions(:title=>params[:id]), - :include=>Listitem.default_include) - if !@listitems or @listitems.size < 1 + @list = List.find(params[:id], :conditions=>List.search_conditions({:u=>current_user})) + @page_title = (@list.user == current_user ? 'Your' : "#{@list.user.title}’s") + " List: #{@list.title}" + if @list.listitems.size < 1 flash.now[:notice] = 'The list is empty.' end + rescue ActiveRecord::RecordNotFound + missing end # deletes all the rows in the listitems table that match the current_user and the list title (id) app/controllers/lists_controller.rb @@ -2,42 +2,39 @@ class Listitem < ActiveRecord::Base attr_accessible :item_id, :item_type, :title + validates_presence_of :list validates_presence_of :item - validates_presence_of :user - validates_format_of :title, :with=>/\A([A-Za-z0-9]([A-Za-z0-9 \-]*[A-Za-z0-9])?)?\z/, :allow_nil=>true, - :message=>'can only use letters, numbers, spaces and dashes; and must start and end with letters or numbers' - # an item cannot be added more than once to a given user’s list - validates_uniqueness_of :title, :scope=>[:user_id, :item_type, :item_id] + #validates_presence_of :user + # an item cannot be added more than once to a given list + validates_uniqueness_of :item_id, :scope=>[:list_id, :item_type] # TODO: validate that the user has access to the item + belongs_to :list belongs_to :item, :polymorphic=>true - belongs_to :user + #belongs_to :user + def self.default_include nil # unfortunately, we can’t eager-load :item because it’s polymorphic end def self.default_order(p={}) (p[:recent].blank? ? '' : 'listitems.updated_at DESC, ') + - 'listitems.created_at' + 'listitems.position' end # Returns a conditions array for find. # p is a hash of parameters: - # - :key is a search restriction key - # - :u is the current_user to use to determine access to private items. - # - :title is the list title to match + ## - :key is a search restriction key + ## - :u is the current_user to use to determine access to private items. + ## - :title is the list title to match # strs is a list of condition strings (with ‘?’ for params) to be joined by “AND” # vals is a list of condition values to be appended to the result array (matching ‘?’ in the strs) def self.search_conditions(p={}, strs=[], vals=[]) + #if p[:u] + # strs << 'listitems.user_id = ?' + # vals << p[:u] + #end # TODO: support keyword searching in a list of items - unless p[:title].blank? - strs << 'listitems.title = ?' - vals << p[:title] - end - if p[:u] - strs << 'listitems.user_id = ?' - vals << p[:u] - end #unless p[:key].blank? # strs << 'listitems.title LIKE ?' # vals << "%#{p[:key]}%" @@ -45,19 +42,20 @@ class Listitem < ActiveRecord::Base strs.size > 0 ? [strs.join(' AND ')] + vals : nil end - def self.find_lists_for_user(u) - lists = find_by_sql("SELECT listitems.title FROM listitems " + - "WHERE listitems.user_id = #{u.id} " + - "GROUP BY listitems.title ORDER BY listitems.title") + + def before_save + if self.position.nil? or self.position == 0 + autoset_position + end end - def self.count_user_list(u, title) - Listitem.count(:conditions=> - ['listitems.user_id = ? AND listitems.title = ?', u.id, title]) + def autoset_position + last_item = list.listitems.find(:last, :order=>'listitems.position') + self.position = last_item.position + 1 end # standard Wayground instance methods for displayable items def css_class(name_prefix='') - "#{name_prefix}list" + self.item.css_class(name_prefix) end end app/models/listitem.rb @@ -2,9 +2,9 @@ class CreateLists < ActiveRecord::Migration def self.up create_table :lists, :force=>true, :options=>'COMMENT="Allows users to save their own custom lists of items." ENGINE=InnoDB CHARSET=utf8' do |t| - t.belongs_to :user, :null=>false - t.string :title - t.boolean :is_public, :default=>false + t.belongs_to :user, :null=>false # owner of the List + t.string :title, :null=>false # name of the List + t.boolean :is_public, :null=>false, :default=>false # if false, only User (owner) can see it t.timestamps end change_table :lists do |t| @@ -13,15 +13,15 @@ class CreateLists < ActiveRecord::Migration create_table :listitems, :force=>true, :options=>'COMMENT="Items for custom lists." ENGINE=InnoDB CHARSET=utf8' do |t| + t.belongs_to :list, :null=>false t.belongs_to :item, :null=>false, :polymorphic=>true - t.belongs_to :user, :null=>false - t.string :title + #t.belongs_to :user, :null=>false # User who added this item to the List + t.integer :position, :null=>false t.timestamps end change_table :listitems do |t| + t.index [:list_id, :position], :name=>'list' t.index [:item_type, :item_id], :name=>'item' - t.index [:user_id, :item_type, :item_id], :name=>'user' - t.index [:user_id, :title, :item_type, :item_id], :name=>'title', :unique=>true end end db/migrate/012_create_lists.rb @@ -1,22 +1,21 @@ # Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html one: + list: one item: one (Event) - user: login - title: Test List + position: 1 two: + list: two item: two (Page) - user: login - title: Test List + position: 1 destroy_this: - item: one (Event) - user: regular - title: Destroy This + list: one + item: two (Event) + position: 2 destroy_this2: - item: two (Page) - user: regular - title: Destroy This - + list: two + item: one (Page) + position: 2 test/fixtures/listitems.yml @@ -1,7 +1,7 @@ require 'test_helper' class ListitemsControllerTest < ActionController::TestCase - fixtures :listitems, :users, :events, :pages, :weblinks + fixtures :lists, :listitems, :users, :events, :pages, :weblinks def setup @controller = ListitemsController.new @@ -21,14 +21,12 @@ class ListitemsControllerTest < ActionController::TestCase test "create" do assert_difference(Listitem, :count, 1) do - post :create, {:listitem=>{:title=>'Test List', - :item_type=>'Weblink', :item_id=>weblinks(:one).id}}, - {:user=>users(:regular).id} + post :create, {:list_id=>lists(:one).id, + :listitem=>{:item_type=>'Weblink', :item_id=>weblinks(:one).id}}, + {:user=>users(:login).id} end - assert assigns(:listitem) assert assigns(:listitem).is_a?(Listitem) assert_equal weblinks(:one), assigns(:listitem).item - assert_equal users(:regular), assigns(:listitem).user assert flash[:notice] assert_response :redirect assert_redirected_to({:controller=>'weblinks', :action=>'show', :id=>weblinks(:one)}) @@ -37,7 +35,7 @@ class ListitemsControllerTest < ActionController::TestCase end test "create no params" do assert_difference(Listitem, :count, 0) do - post :create, {:listitem=>{}}, {:user=>users(:regular).id} + post :create, {:list_id=>lists(:one).id, :listitem=>{}}, {:user=>users(:login).id} end assert assigns(:listitem) assert assigns(:listitem).is_a?(Listitem) @@ -50,15 +48,14 @@ class ListitemsControllerTest < ActionController::TestCase # create a listitem to be destroyed listitem = nil assert_difference(Listitem, :count, 1) do - listitem = Listitem.new({:title=>'Delete This', - :item_type=>'Page', :item_id=>pages(:one).id}) - listitem.user = users(:regular) + listitem = lists(:one).listitems.new + listitem.item = pages(:three) listitem.save! end # destroy the listitem assert_difference(Listitem, :count, -1) do @request.accept = "text/html" - delete :destroy, {:id=>listitem.id}, {:user=>users(:regular).id} + delete :destroy, {:id=>listitem.id}, {:user=>users(:login).id} end assert flash[:notice] assert_response :redirect @@ -68,9 +65,8 @@ class ListitemsControllerTest < ActionController::TestCase # create a listitem to be destroyed listitem = nil assert_difference(Listitem, :count, 1) do - listitem = Listitem.new({:title=>'Delete This', - :item_type=>'Page', :item_id=>pages(:one).id}) - listitem.user = users(:regular) + listitem = lists(:one).listitems.new + listitem.item = pages(:three) listitem.save! end # destroy the listitem @@ -115,15 +111,14 @@ class ListitemsControllerTest < ActionController::TestCase # create a listitem to be destroyed listitem = nil assert_difference(Listitem, :count, 1) do - listitem = Listitem.new({:title=>'Delete This', - :item_type=>'Page', :item_id=>pages(:one).id}) - listitem.user = users(:regular) + listitem = lists(:one).listitems.new + listitem.item = pages(:three) listitem.save! end # destroy the listitem assert_difference(Listitem, :count, -1) do @request.accept = "text/javascript" - delete :destroy, {:id=>listitem.id}, {:user=>users(:regular).id} + delete :destroy, {:id=>listitem.id}, {:user=>users(:login).id} end assert flash[:notice] assert_response :success test/functional/listitems_controller_test.rb @@ -1,7 +1,7 @@ require 'test_helper' class ListsControllerTest < ActionController::TestCase - fixtures :listitems, :users, :events, :pages, :weblinks + fixtures :lists, :listitems, :users, :events, :pages, :weblinks def setup @controller = ListsController.new @@ -19,73 +19,73 @@ class ListsControllerTest < ActionController::TestCase # ACTIONS - test "index" do - assert_efficient_sql do - get :index, {}, {:user=>users(:login).id} - end - assert_equal 'Your Lists', assigns(:page_title) - assert_equal 1, assigns(:lists).size - assert_nil flash[:notice] - assert_response :success - # view result - assert_template 'index' - assert_select 'div#flash:empty' - assert_select 'div#content' do - # TODO: test html content for test_events_index - assigns(:lists).each do |list| - assert_select "li", list.title - end - end - end - - test "show" do +# test "index" do # assert_efficient_sql do - get :show, {:id=>listitems(:one).title}, {:user=>users(:login).id} +# get :index, {}, {:user=>users(:login).id} # end - assert_equal "Your List: #{listitems(:one).title}", assigns(:page_title) - assert_equal 2, assigns(:listitems).size - assert_nil flash[:notice] - assert_response :success - # view result - assert_template 'show' - assert_select 'div#flash:empty' - assert_select 'div#content' do - # TODO: test html content for test_events_index - assigns(:listitems).each do |listitem| - assert_select "li#listitem_#{listitem.id}", listitem.item.title - end - end - end - test "show empty list" do +# assert_equal 'Your Lists', assigns(:page_title) +# assert_equal 1, assigns(:lists).size +# assert_nil flash[:notice] +# assert_response :success +# # view result +# assert_template 'index' +# assert_select 'div#flash:empty' +# assert_select 'div#content' do +# # TODO: test html content for test_events_index +# assigns(:lists).each do |list| +# assert_select "li", list.title +# end +# end +# end +# +# test "show" do +## assert_efficient_sql do +# get :show, {:id=>listitems(:one).title}, {:user=>users(:login).id} +## end +# assert_equal "Your List: #{listitems(:one).title}", assigns(:page_title) +# assert_equal 2, assigns(:listitems).size +# assert_nil flash[:notice] +# assert_response :success +# # view result +# assert_template 'show' +# assert_select 'div#flash:empty' +# assert_select 'div#content' do +# # TODO: test html content for test_events_index +# assigns(:listitems).each do |listitem| +# assert_select "li#listitem_#{listitem.id}", listitem.item.title +# end +# end +# end +# test "show empty list" do +## assert_efficient_sql do +# get :show, {:id=>'Non-existent list'}, {:user=>users(:login).id} +## end +# assert_equal "Your List: Non-existent list", assigns(:page_title) +# assert_equal 0, assigns(:listitems).size +# assert flash[:notice] +# assert_response :success +# assert_template 'show' +# end +# +# test "destroy" do +# conditions = ['listitems.user_id = ? AND listitems.title = ?', +# users(:regular).id, listitems(:destroy_this).title] +# assert Listitem.count(:conditions=>conditions) > 0 # assert_efficient_sql do - get :show, {:id=>'Non-existent list'}, {:user=>users(:login).id} +# delete :destroy, {:id=>listitems(:destroy_this).title}, +# {:user=>users(:regular).id} # end - assert_equal "Your List: Non-existent list", assigns(:page_title) - assert_equal 0, assigns(:listitems).size - assert flash[:notice] - assert_response :success - assert_template 'show' - end - - test "destroy" do - conditions = ['listitems.user_id = ? AND listitems.title = ?', - users(:regular).id, listitems(:destroy_this).title] - assert Listitem.count(:conditions=>conditions) > 0 - assert_efficient_sql do - delete :destroy, {:id=>listitems(:destroy_this).title}, - {:user=>users(:regular).id} - end - assert_equal 0, Listitem.count(:conditions=>conditions) - assert flash[:notice] - assert_response :redirect - assert_redirected_to lists_path - end - test "destroy empty list" do - assert_efficient_sql do - delete :destroy, {:id=>'non-existent list'}, {:user=>users(:regular).id} - end - assert flash[:error] - assert_response :redirect - assert_redirected_to lists_path - end +# assert_equal 0, Listitem.count(:conditions=>conditions) +# assert flash[:notice] +# assert_response :redirect +# assert_redirected_to lists_path +# end +# test "destroy empty list" do +# assert_efficient_sql do +# delete :destroy, {:id=>'non-existent list'}, {:user=>users(:regular).id} +# end +# assert flash[:error] +# assert_response :redirect +# assert_redirected_to lists_path +# end end test/functional/lists_controller_test.rb @@ -1,7 +1,7 @@ require 'test_helper' class ListitemTest < ActiveSupport::TestCase - fixtures :listitems, :pages, :users, :events + fixtures :lists, :listitems, :pages, :users, :events # Replace this with your real tests. test "associations" do @@ -12,80 +12,18 @@ class ListitemTest < ActiveSupport::TestCase # VALIDATIONS test "validation with all values set" do - li = Listitem.new(:title=>'test1') - li.item = pages(:one) - li.user = users(:login) + li = lists(:one).listitems.new() + li.item = pages(:three) assert_valid li end test "validation fails in absence of item" do - li = Listitem.new(:title=>'test2') - li.user = users(:login) + li = lists(:one).listitems.new() assert_validation_fails_for(li, ['item']) end - test "validation fails in absence of user" do - li = Listitem.new(:title=>'test3') - li.item = pages(:one) - assert_validation_fails_for(li, ['user']) - end - test "validation passes in absence of title" do - li = Listitem.new() - li.item = pages(:one) - li.user = users(:login) - assert_valid li - end - test "validation passes with empty title" do - li = Listitem.new(:title=>'') - li.item = pages(:one) - li.user = users(:login) - assert_valid li - end - test "validation passes with space in title" do - li = Listitem.new(:title=>"test 4") - li.item = pages(:one) - li.user = users(:login) - assert_valid li - end - test "validation fails with space at beginning of title" do - li = Listitem.new(:title=>" test5") - li.item = pages(:one) - li.user = users(:login) - assert_validation_fails_for(li, ['title']) - end - test "validation fails with space at end of title" do - li = Listitem.new(:title=>"test6 ") - li.item = pages(:one) - li.user = users(:login) - assert_validation_fails_for(li, ['title']) - end - test "validation passes with dash in title" do - li = Listitem.new(:title=>"test-7") - li.item = pages(:one) - li.user = users(:login) - assert_valid li - end - test "validation fails with dash at beginning of title" do - li = Listitem.new(:title=>"-test8") - li.item = pages(:one) - li.user = users(:login) - assert_validation_fails_for(li, ['title']) - end - test "validation fails with dash at end of title" do - li = Listitem.new(:title=>"test9-") - li.item = pages(:one) - li.user = users(:login) - assert_validation_fails_for(li, ['title']) - end - test "validation fails with CR in title" do - li = Listitem.new(:title=>"\r") - li.item = pages(:one) - li.user = users(:login) - assert_validation_fails_for(li, ['title']) - end test "validation fails for duplicate entry" do - li = Listitem.new(:title=>listitems(:one).title) + li = listitems(:one).list.listitems.new() li.item = listitems(:one).item - li.user = listitems(:one).user - assert_validation_fails_for(li, ['title']) + assert_validation_fails_for(li, ['item_id']) end @@ -96,10 +34,10 @@ class ListitemTest < ActiveSupport::TestCase end test "default order" do - assert_equal 'listitems.created_at', Listitem.default_order + assert_equal 'listitems.position', Listitem.default_order end test "default order recent" do - assert_equal 'listitems.updated_at DESC, listitems.created_at', + assert_equal 'listitems.updated_at DESC, listitems.position', Listitem.default_order(:recent=>true) end @@ -109,61 +47,33 @@ class ListitemTest < ActiveSupport::TestCase test "search conditions custom" do assert_equal ['a AND b',1,2], Listitem.search_conditions({}, ['a','b'], [1,2]) end - test "search conditions title" do - assert_equal ['listitems.title = ?', 'Title'], - Listitem.search_conditions({:title=>'Title'}) - end - test "search conditions user" do - assert_equal ['listitems.user_id = ?', 1], - Listitem.search_conditions({:u=>1}) - end test "search conditions all" do - assert_equal ['a AND b AND listitems.title = ? AND listitems.user_id = ?', - 1, 2, 'Title', 3], - Listitem.search_conditions({:title=>'Title', :u=>3}, ['a','b'], [1,2]) + assert_equal ['a AND b', + 1, 2], + Listitem.search_conditions({}, ['a','b'], [1,2]) end - test "find lists for user" do - lists = Listitem.find_lists_for_user(users(:login)) - assert_equal 1, lists.size - assert_equal 'Test List', lists[0].title - end - test "find lists for user with no lists" do - assert_equal [], Listitem.find_lists_for_user(users(:another)) - end - test "find lists for user with nil user" do - assert_raise RuntimeError do - Listitem.find_lists_for_user(nil) - end - end - def self.count_user_list(u, title) - Listitem.count(:conditions=> - ['listitems.user_id = ? AND listitems.title = ?', u.id, title]) - end + # INSTANCE METHODS - test "count items in user list" do - assert_equal 2, Listitem.count_user_list(listitems(:one).user, listitems(:one).title) - end - test "count items in empty user list" do - assert_equal 0, Listitem.count_user_list(listitems(:one).user, 'non-existent list') - end - test "count items in user list for wrong user" do - assert_equal 0, Listitem.count_user_list(users(:another), listitems(:one).title) - end - test "count items in user list for no user" do - assert_raise RuntimeError do - Listitem.count_user_list(nil, listitems(:one).title) - end + test "before save sets position" do + li = lists(:one).listitems.new() + li.item = events(:searchable) + li.save! + assert_equal 3, li.position + li.destroy end - - # INSTANCE METHODS + test "autoset_position" do + li = lists(:one).listitems.new() + li.autoset_position + assert_equal 3, li.position + end test "css class" do - assert_equal 'list', listitems(:one).css_class + assert_equal 'event', listitems(:one).css_class end test "css class with prefix" do - assert_equal 'test-list', listitems(:one).css_class('test-') + assert_equal 'test-event', listitems(:one).css_class('test-') end end test/unit/listitem_test.rb 90674375a60404a258a231658699accd7cc1add5 Grant Neufeld grant@grantneufeld.ca http://github.com/grantneufeld/wayground/commit/7d9e1b692500e6b32f94552269cc943c321262dd 7d9e1b692500e6b32f94552269cc943c321262dd 2009-03-29T14:17:02-07:00 2009-03-29T14:17:02-07:00 List and Listitem models and controllers. Not fully complete yet, but a lot more stuff implemented. 05669e9a998b56a0e5db74a23d268fd0d022a4e6 Grant Neufeld grant@grantneufeld.ca