1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
|
require 'test_helper'
HasScope::ALLOWED_TYPES[:date] = [[String], -> v { Date.parse(v) rescue nil }]
class Tree; end
class TreesController < ApplicationController
has_scope :color, :unless => :show_all_colors?
has_scope :only_tall, :type => :boolean, :only => :index, :if => :restrict_to_only_tall_trees?
has_scope :shadown_range, :default => 10, :except => [ :index, :show, :new ]
has_scope :root_type, :as => :root, :allow_blank => true
has_scope :planted_before, :default => proc { Date.today }
has_scope :planted_after, :type => :date
has_scope :calculate_height, :default => proc {|c| c.session[:height] || 20 }, :only => :new
has_scope :paginate, :type => :hash
has_scope :args_paginate, :type => :hash, :using => [:page, :per_page]
has_scope :categories, :type => :array
has_scope :title, :in => :q
has_scope :content, :in => :q
has_scope :conifer, type: :boolean, :allow_blank => true
has_scope :only_short, :type => :boolean do |controller, scope|
scope.only_really_short!(controller.object_id)
end
has_scope :by_category do |controller, scope, value|
scope.by_given_category(controller.object_id, value + "_id")
end
def index
@trees = apply_scopes(Tree).all
end
def new
@tree = apply_scopes(Tree).new
end
def show
@tree = apply_scopes(Tree).find(params[:id])
end
alias :edit :show
protected
def restrict_to_only_tall_trees?
true
end
def show_all_colors?
false
end
if ActionPack::VERSION::MAJOR >= 5
def default_render
render body: action_name
end
else
# TODO: Remove this when we only support Rails 5.
def default_render
render text: action_name
end
end
end
class BonsaisController < TreesController
has_scope :categories, :if => :categories?
protected
def categories?
false
end
end
class HasScopeTest < ActionController::TestCase
tests TreesController
def test_boolean_scope_is_called_when_boolean_param_is_true
Tree.expects(:only_tall).with().returns(Tree).in_sequence
Tree.expects(:all).returns([mock_tree]).in_sequence
get :index, :only_tall => 'true'
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ :only_tall => true }, current_scopes)
end
def test_boolean_scope_is_not_called_when_boolean_param_is_false
Tree.expects(:only_tall).never
Tree.expects(:all).returns([mock_tree])
get :index, :only_tall => 'false'
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ }, current_scopes)
end
def test_boolean_scope_with_allow_blank_is_called_when_boolean_param_is_true
Tree.expects(:conifer).with(true).returns(Tree).in_sequence
Tree.expects(:all).returns([mock_tree]).in_sequence
get :index, :conifer => 'true'
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ :conifer => true }, current_scopes)
end
def test_boolean_scope_with_allow_blank_is_called_when_boolean_param_is_false
Tree.expects(:conifer).with(false).returns(Tree).in_sequence
Tree.expects(:all).returns([mock_tree]).in_sequence
get :index, :conifer => 'not_true'
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ :conifer => false }, current_scopes)
end
def test_boolean_scope_with_allow_blank_is_not_called_when_boolean_param_is_not_present
Tree.expects(:conifer).never
Tree.expects(:all).returns([mock_tree])
get :index
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ }, current_scopes)
end
def test_scope_is_called_only_on_index
Tree.expects(:only_tall).never
Tree.expects(:find).with('42').returns(mock_tree)
get :show, :only_tall => 'true', :id => '42'
assert_equal(mock_tree, assigns(:@tree))
assert_equal({ }, current_scopes)
end
def test_scope_is_skipped_when_if_option_is_false
@controller.stubs(:restrict_to_only_tall_trees?).returns(false)
Tree.expects(:only_tall).never
Tree.expects(:all).returns([mock_tree])
get :index, :only_tall => 'true'
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ }, current_scopes)
end
def test_scope_is_skipped_when_unless_option_is_true
@controller.stubs(:show_all_colors?).returns(true)
Tree.expects(:color).never
Tree.expects(:all).returns([mock_tree])
get :index, :color => 'blue'
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ }, current_scopes)
end
def test_scope_is_called_except_on_index
Tree.expects(:shadown_range).never
Tree.expects(:all).returns([mock_tree])
get :index, :shadown_range => 20
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ }, current_scopes)
end
def test_scope_is_called_with_arguments
Tree.expects(:color).with('blue').returns(Tree).in_sequence
Tree.expects(:all).returns([mock_tree]).in_sequence
get :index, :color => 'blue'
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ :color => 'blue' }, current_scopes)
end
def test_scope_is_not_called_if_blank
Tree.expects(:color).never
Tree.expects(:all).returns([mock_tree]).in_sequence
get :index, :color => ''
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ }, current_scopes)
end
def test_scope_is_called_when_blank_if_allow_blank_is_given
Tree.expects(:root_type).with('').returns(Tree)
Tree.expects(:all).returns([mock_tree]).in_sequence
get :index, :root => ''
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ :root => '' }, current_scopes)
end
def test_multiple_scopes_are_called
Tree.expects(:only_tall).with().returns(Tree)
Tree.expects(:color).with('blue').returns(Tree)
Tree.expects(:all).returns([mock_tree])
get :index, :color => 'blue', :only_tall => 'true'
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ :color => 'blue', :only_tall => true }, current_scopes)
end
def test_scope_of_type_hash
hash = { "page" => "1", "per_page" => "10" }
Tree.expects(:paginate).with(hash).returns(Tree)
Tree.expects(:all).returns([mock_tree])
get :index, :paginate => hash
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ paginate: hash }, current_scopes)
end
def test_scope_of_type_hash_with_using
hash = { "page" => "1", "per_page" => "10" }
Tree.expects(:args_paginate).with("1", "10").returns(Tree)
Tree.expects(:all).returns([mock_tree])
get :index, :args_paginate => hash
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ :args_paginate => hash }, current_scopes)
end
def test_hash_with_blank_values_is_ignored
hash = { "page" => "", "per_page" => "" }
Tree.expects(:paginate).never
Tree.expects(:all).returns([mock_tree])
get :index, :paginate => hash
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ }, current_scopes)
end
def test_nested_hash_with_blank_values_is_ignored
hash = { "parent" => {"children" => ""} }
Tree.expects(:paginate).never
Tree.expects(:all).returns([mock_tree])
get :index, :paginate => hash
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ }, current_scopes)
end
def test_nested_blank_array_param_is_ignored
hash = { "parent" => [""] }
Tree.expects(:paginate).never
Tree.expects(:all).returns([mock_tree])
get :index, :paginate => hash
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ }, current_scopes)
end
def test_scope_of_type_array
array = %w(book kitchen sport)
Tree.expects(:categories).with(array).returns(Tree)
Tree.expects(:all).returns([mock_tree])
get :index, :categories => array
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ :categories => array }, current_scopes)
end
def test_array_of_blank_values_is_ignored
Tree.expects(:categories).never
Tree.expects(:all).returns([mock_tree])
get :index, :categories => [""]
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ }, current_scopes)
end
def test_scope_of_invalid_type_silently_fails
Tree.expects(:all).returns([mock_tree])
get :index, :paginate => "1"
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ }, current_scopes)
end
def test_scope_is_called_with_default_value
Tree.expects(:shadown_range).with(10).returns(Tree).in_sequence
Tree.expects(:find).with('42').returns(mock_tree).in_sequence
get :edit, :id => '42'
assert_equal(mock_tree, assigns(:@tree))
assert_equal({ :shadown_range => 10 }, current_scopes)
end
def test_default_scope_value_can_be_overwritten
Tree.expects(:shadown_range).with('20').returns(Tree).in_sequence
Tree.expects(:find).with('42').returns(mock_tree).in_sequence
get :edit, :id => '42', :shadown_range => '20'
assert_equal(mock_tree, assigns(:@tree))
assert_equal({ :shadown_range => '20' }, current_scopes)
end
def test_scope_with_different_key
Tree.expects(:root_type).with('outside').returns(Tree).in_sequence
Tree.expects(:find).with('42').returns(mock_tree).in_sequence
get :show, :id => '42', :root => 'outside'
assert_equal(mock_tree, assigns(:@tree))
assert_equal({ :root => 'outside' }, current_scopes)
end
def test_scope_with_default_value_as_a_proc_without_argument
Date.expects(:today).returns("today")
Tree.expects(:planted_before).with("today").returns(Tree)
Tree.expects(:all).returns([mock_tree])
get :index
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ :planted_before => "today" }, current_scopes)
end
def test_scope_with_default_value_as_proc_with_argument
session[:height] = 100
Tree.expects(:calculate_height).with(100).returns(Tree).in_sequence
Tree.expects(:new).returns(mock_tree).in_sequence
get :new
assert_equal(mock_tree, assigns(:@tree))
assert_equal({ :calculate_height => 100 }, current_scopes)
end
def test_scope_with_custom_type
parsed = Date.civil(2014,11,11)
Tree.expects(:planted_after).with(parsed).returns(Tree)
Tree.expects(:all).returns([mock_tree])
get :index, :planted_after => "2014-11-11"
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ :planted_after => parsed }, current_scopes)
end
def test_scope_with_boolean_block
Tree.expects(:only_really_short!).with(@controller.object_id).returns(Tree)
Tree.expects(:all).returns([mock_tree])
get :index, :only_short => 'true'
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ :only_short => true }, current_scopes)
end
def test_scope_with_other_block_types
Tree.expects(:by_given_category).with(@controller.object_id, 'for_id').returns(Tree)
Tree.expects(:all).returns([mock_tree])
get :index, :by_category => 'for'
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ :by_category => 'for' }, current_scopes)
end
def test_scope_with_nested_hash_and_in_option
hash = { 'title' => 'the-title', 'content' => 'the-content' }
Tree.expects(:title).with('the-title').returns(Tree)
Tree.expects(:content).with('the-content').returns(Tree)
Tree.expects(:all).returns([mock_tree])
get :index, q: hash
assert_equal([mock_tree], assigns(:@trees))
assert_equal({ q: hash }, current_scopes)
end
def test_overwritten_scope
assert_nil(TreesController.scopes_configuration[:categories][:if])
assert_equal(:categories?, BonsaisController.scopes_configuration[:categories][:if])
end
protected
if ActionPack::VERSION::MAJOR >= 5
# TODO: Remove this when we only support Rails 5.
def get(action, params = {})
super action, params: params
end
end
def mock_tree(stubs={})
@mock_tree ||= mock(stubs)
end
def current_scopes
@controller.send :current_scopes
end
def assigns(ivar)
@controller.instance_variable_get(ivar)
end
end
class TreeHugger
include HasScope
has_scope :color
def by_color
apply_scopes(Tree, :color => 'blue')
end
end
class HasScopeOutsideControllerTest < ActiveSupport::TestCase
def test_has_scope_usable_outside_controller
Tree.expects(:color).with('blue')
TreeHugger.new.by_color
end
end
|