@@ -17,7 +17,7 @@ module SortableTable define_sort_order(acceptable_columns, mappings) end - def pop_hash_from_list(*args) + def pop_hash_from_list(args) if args.last.is_a?(Hash) args.pop else @@ -27,7 +27,7 @@ module SortableTable def join_array_and_hash_values(array, hash) array.collect { |each| each.to_s } + - hash.values.collect { |each| each.to_s } + hash.keys.collect { |each| each.to_s } end def define_sort_order(acceptable_columns, mappings) @@ -89,7 +89,5 @@ module SortableTable end end - end + end end - - lib/sortable_table/app/controllers/application_controller.rb @@ -1,6 +1,28 @@ module SortableTable module Shoulda + class Attribute + def initialize(attr) + @attr = attr + end + + def complex? + @attr.is_a?(Hash) + end + + def name + complex? ? @attr.keys.first : @attr + end + + def values + @attr.values.flatten + end + + def to_s + name.to_s + end + end + def should_sort_by(attribute, options = {}, &block) collection = get_collection_name(options[:collection]) model_under_test = get_model_under_test(attribute, options[:model_name]) @@ -8,6 +30,8 @@ module SortableTable block = block || default_sorting_block(model_under_test, attribute) action = options[:action] || default_sorting_action + attribute = Attribute.new(attribute) + %w(ascending descending).each do |direction| should "sort by #{attribute.to_s} #{direction}" do # sanity checks @@ -15,10 +39,10 @@ module SortableTable assert_db_records_exist_for(model_under_test) # exercise - action.bind(self).call(attribute.to_s, direction) + action.bind(self).call(attribute.name.to_s, direction) # sanity check - assert_collection_can_be_tested_for_sorting(collection, attribute) + assert_collection_can_be_tested_for_sorting(collection, attribute, &block) # verification assert_collection_is_sorted(collection, direction, &block) @@ -75,34 +99,14 @@ module SortableTable end def get_model_under_test(attribute, override) - if override - model_name = override - else - model_name = if attribute_includes_table?(attribute) - get_model_from_attribute(attribute) - else - get_model_under_test_from_test_name - end - end - model_name.singularize.camelize.constantize + model_name = override || get_model_under_test_from_test_name + model_name.classify.constantize end def get_model_under_test_from_test_name model_name_from_test_name = self.name.gsub(/ControllerTest/, '') remove_namespacing(model_name_from_test_name) end - - def attribute_includes_table?(attribute) - attribute.to_s.include?(".") - end - - def get_model_from_attribute(attribute) - if attribute.is_a?(Hash) - attribute.values.first.split(".").first - else - attribute.split(".").first - end - end def remove_namespacing(string) while string.include?('/') @@ -145,15 +149,15 @@ module SortableTable "need at least 2 #{model_under_test} records in the db to test sorting" end - def assert_collection_can_be_tested_for_sorting(collection, attribute) + def assert_collection_can_be_tested_for_sorting(collection, attribute, &block) assert_not_nil assigns(collection), "assigns(:#{collection}) is nil" assert assigns(collection).size >= 2, "cannot test sorting without at least 2 sortable objects. " << "assigns(:#{collection}) is #{assigns(collection).inspect}" - values = assigns(collection).collect(&attribute).uniq + values = assigns(collection).collect(&block).uniq assert values.size >= 2, - "need at least 2 distinct #{attribute} values to test sorting\n" << + "need at least 2 distinct #{attribute.name} values to test sorting\n" << "found values: #{values.inspect}" end @@ -167,10 +171,26 @@ module SortableTable end def assert_attribute_defined(attribute, model_under_test) - column = model_under_test. + if attribute.complex? + attribute.values.each do |attr| + if attr.include?('.') + model, attr = attr.split('.') + model = model.classify.constantize + assert_db_column_exists(attr, model) + else + assert_db_column_exists(attr, model_under_test) + end + end + else + assert_db_column_exists(attribute, model_under_test) + end + end + + def assert_db_column_exists(attribute, model) + column = model. columns. detect {|column| column.name == attribute.to_s } - assert_not_nil column, "No such column: #{model_under_test}##{attribute}" + assert_not_nil column, "No such column: #{model}##{attribute}" end end end shoulda_macros/sortable_table.rb @@ -4,7 +4,7 @@ class Admin::UsersController < ApplicationController :age_and_name => ["age", "users.name"] def index - @users = User.find :all, :order => sort_order + @users = User.find :all, :include => :group, :order => sort_order end end test/rails_root/app/controllers/admin/users_controller.rb @@ -4,13 +4,13 @@ class UsersController < ApplicationController :age_and_name => ["age", "users.name"] def index - @users = User.find :all, :order => sort_order("ascending") + @users = User.find :all, :include => :group, :order => sort_order("ascending") end - + def show @users = User.find :all, :order => sort_order end - + def members @members = User.find :all, :order => sort_order end test/rails_root/app/controllers/users_controller.rb @@ -25,7 +25,8 @@ Rails::Initializer.run do |config| config.gem 'mocha', :version => '>= 0.9.3' - config.gem 'quietbacktrace', + config.gem 'thoughtbot-quietbacktrace', + :lib => 'quietbacktrace', :version => '>= 0.1.1' config.gem 'thoughtbot-factory_girl', :lib => 'factory_girl', test/rails_root/config/environment.rb @@ -1,3 +1,5 @@ +UNSORTED_NUMBERS = [1, 6, 2, 5, 4, 8, 10, 9, 3, 7] + Factory.define :user do |user| user.email { Factory.next :email } user.name { Factory.next :name } @@ -6,17 +8,25 @@ Factory.define :user do |user| end Factory.define :group do |group| - group.name { Factory.next :name } + group.name { Factory.next(:unsorted_name) } +end + +Factory.sequence :email do |n| + "email#{n}@example.com" +end + +Factory.sequence :name do |n| + "name#{n}" end -Factory.sequence :email do |each| - "email#{each}@example.com" +Factory.sequence :unsorted_number do |n| + UNSORTED_NUMBERS[n % UNSORTED_NUMBERS.size] end -Factory.sequence :name do |each| - "name#{each}" +Factory.sequence :age do |n| + 20 + Factory.next(:unsorted_number) end -Factory.sequence :age do |each| - each +Factory.sequence :unsorted_name do |n| + "name#{Factory.next(:unsorted_number)}#{n}" end test/rails_root/test/factories/user_factory.rb @@ -9,8 +9,13 @@ class Admin::UsersControllerTest < ActionController::TestCase should_sort_by_attributes :name, :email - # TODO: this was unimplemented - # should_sort_by_attributes :group => "groups.name" + should_sort_by :group => 'groups.name' do |user| + user.group.name + end + + should_sort_by :age_and_name => ["age", "users.name"] do |user| + "#{user.age}#{user.name}" + end context "GET to #index" do setup { get :index } @@ -19,4 +24,3 @@ class Admin::UsersControllerTest < ActionController::TestCase end end - test/rails_root/test/functional/admin/users_controller_test.rb @@ -14,17 +14,19 @@ class UsersControllerTest < ActionController::TestCase should_sort_by_attributes :name, :admin - # TODO: this was unimplemented - # should_sort_by_attributes :group => "groups.name" + should_sort_by :group => 'groups.name' do |user| + user.group.name + end + + should_sort_by :age_and_name => ["age", "users.name"] do |user| + "#{user.age}#{user.name}" + end # block form to test an action other than :index - should_sort_by_attributes :age do |sort, order| + should_sort_by_attributes :email do |sort, order| get :show, :sort => sort, :order => order end - # TODO: - # should_sort_by :age_and_name => ["age", "users.name"] - context "with a non-standard collection name" do action = lambda { |sort, order| get :members, :sort => sort, :order => order } should_sort_by :name, { :collection => "members", @@ -78,4 +80,3 @@ class UsersControllerTest < ActionController::TestCase end end - test/rails_root/test/functional/users_controller_test.rb f919126f665528c38cc8c2a32dd1e6500f8054cf Jason Morrison jasonmorrison@jason-morrisons-macbook.local http://github.com/JackDanger/sortable_table/commit/67104346e9a6b90aa7395eed0339c45f9343cc16 67104346e9a6b90aa7395eed0339c45f9343cc16 2009-02-27T13:06:51-08:00 2009-02-27T13:06:51-08:00 Supporting complex attributes in sortable_attributes (merging patch from Eugene Bolshakov) 17fbc131225bf6796aaf286769fb031e28e7f364 Jason Morrison jasonmorrison@jason-morrisons-macbook.local