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 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
|
require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
require 'active_model'
if defined?(ActiveModel::VERSION) && ActiveModel::VERSION::MAJOR >= 4
require 'rails/observers/active_model/active_model'
require 'active_model/mass_assignment_security'
else
require 'active_model/observing'
end
require 'active_support/all'
module ActiveModelTest
class BaseTestCase < Test::Unit::TestCase
def default_test
end
protected
# Creates a new ActiveModel model (and the associated table)
def new_model(&block)
# Simple ActiveModel superclass
parent = Class.new do
def self.model_attribute(name)
define_method(name) { instance_variable_defined?("@#{name}") ? instance_variable_get("@#{name}") : nil }
define_method("#{name}=") do |value|
send("#{name}_will_change!") if self.class <= ActiveModel::Dirty && value != send(name)
instance_variable_set("@#{name}", value)
end
end
def self.create
object = new
object.save
object
end
def initialize(attrs = {})
attrs.each {|attr, value| send("#{attr}=", value)}
@changed_attributes = {}
end
def attributes
@attributes ||= {}
end
def save
@changed_attributes = {}
true
end
end
model = Class.new(parent) do
def self.name
'ActiveModelTest::Foo'
end
model_attribute :state
end
model.class_eval(&block) if block_given?
model
end
# Creates a new ActiveModel observer
def new_observer(model, &block)
observer = Class.new(ActiveModel::Observer) do
attr_accessor :notifications
def initialize
super
@notifications = []
end
end
observer.observe(model)
observer.class_eval(&block) if block_given?
observer
end
end
class IntegrationTest < BaseTestCase
def test_should_have_an_integration_name
assert_equal :active_model, StateMachine::Integrations::ActiveModel.integration_name
end
def test_should_be_available
assert StateMachine::Integrations::ActiveModel.available?
end
def test_should_match_if_class_includes_observing_feature
assert StateMachine::Integrations::ActiveModel.matches?(new_model { include ActiveModel::Observing })
end
def test_should_match_if_class_includes_validations_feature
assert StateMachine::Integrations::ActiveModel.matches?(new_model { include ActiveModel::Validations })
end
def test_should_not_match_if_class_does_not_include_active_model_features
assert !StateMachine::Integrations::ActiveModel.matches?(new_model)
end
def test_should_have_no_defaults
assert_equal({}, StateMachine::Integrations::ActiveModel.defaults)
end
def test_should_have_a_locale_path
assert_not_nil StateMachine::Integrations::ActiveModel.locale_path
end
end
class MachineByDefaultTest < BaseTestCase
def setup
@model = new_model
@machine = StateMachine::Machine.new(@model, :integration => :active_model)
end
def test_should_not_have_action
assert_nil @machine.action
end
def test_should_use_transactions
assert_equal true, @machine.use_transactions
end
def test_should_not_have_any_before_callbacks
assert_equal 0, @machine.callbacks[:before].size
end
def test_should_not_have_any_after_callbacks
assert_equal 0, @machine.callbacks[:after].size
end
end
class MachineWithStatesTest < BaseTestCase
def setup
@model = new_model
@machine = StateMachine::Machine.new(@model)
@machine.state :first_gear
end
def test_should_humanize_name
assert_equal 'first gear', @machine.state(:first_gear).human_name
end
end
class MachineWithStaticInitialStateTest < BaseTestCase
def setup
@model = new_model
@machine = StateMachine::Machine.new(@model, :initial => :parked, :integration => :active_model)
end
def test_should_set_initial_state_on_created_object
record = @model.new
assert_equal 'parked', record.state
end
end
class MachineWithDynamicInitialStateTest < BaseTestCase
def setup
@model = new_model
@machine = StateMachine::Machine.new(@model, :initial => lambda {|object| :parked}, :integration => :active_model)
@machine.state :parked
end
def test_should_set_initial_state_on_created_object
record = @model.new
assert_equal 'parked', record.state
end
end
class MachineWithEventsTest < BaseTestCase
def setup
@model = new_model
@machine = StateMachine::Machine.new(@model)
@machine.event :shift_up
end
def test_should_humanize_name
assert_equal 'shift up', @machine.event(:shift_up).human_name
end
end
class MachineWithModelStateAttributeTest < BaseTestCase
def setup
@model = new_model
@machine = StateMachine::Machine.new(@model, :initial => :parked, :integration => :active_model)
@machine.other_states(:idling)
@record = @model.new
end
def test_should_have_an_attribute_predicate
assert @record.respond_to?(:state?)
end
def test_should_raise_exception_for_predicate_without_parameters
assert_raise(ArgumentError) { @record.state? }
end
def test_should_return_false_for_predicate_if_does_not_match_current_value
assert !@record.state?(:idling)
end
def test_should_return_true_for_predicate_if_matches_current_value
assert @record.state?(:parked)
end
def test_should_raise_exception_for_predicate_if_invalid_state_specified
assert_raise(IndexError) { @record.state?(:invalid) }
end
end
class MachineWithNonModelStateAttributeUndefinedTest < BaseTestCase
def setup
@model = new_model do
def initialize
end
end
@machine = StateMachine::Machine.new(@model, :status, :initial => :parked, :integration => :active_model)
@machine.other_states(:idling)
@record = @model.new
end
def test_should_not_define_a_reader_attribute_for_the_attribute
assert !@record.respond_to?(:status)
end
def test_should_not_define_a_writer_attribute_for_the_attribute
assert !@record.respond_to?(:status=)
end
def test_should_define_an_attribute_predicate
assert @record.respond_to?(:status?)
end
end
class MachineWithInitializedStateTest < BaseTestCase
def setup
@model = new_model
@machine = StateMachine::Machine.new(@model, :initial => :parked, :integration => :active_model)
@machine.state :idling
end
def test_should_allow_nil_initial_state_when_static
@machine.state nil
record = @model.new(:state => nil)
assert_nil record.state
end
def test_should_allow_nil_initial_state_when_dynamic
@machine.state nil
@machine.initial_state = lambda {:parked}
record = @model.new(:state => nil)
assert_nil record.state
end
def test_should_allow_different_initial_state_when_static
record = @model.new(:state => 'idling')
assert_equal 'idling', record.state
end
def test_should_allow_different_initial_state_when_dynamic
@machine.initial_state = lambda {:parked}
record = @model.new(:state => 'idling')
assert_equal 'idling', record.state
end
def test_should_use_default_state_if_protected
@model.class_eval do
include ActiveModel::MassAssignmentSecurity
attr_protected :state
def initialize(attrs = {})
initialize_state_machines do
sanitize_for_mass_assignment(attrs).each {|attr, value| send("#{attr}=", value)} if attrs
@changed_attributes = {}
end
end
end
record = @model.new(:state => 'idling')
assert_equal 'parked', record.state
record = @model.new(nil)
assert_equal 'parked', record.state
end
end
class MachineMultipleTest < BaseTestCase
def setup
@model = new_model do
model_attribute :status
end
@state_machine = StateMachine::Machine.new(@model, :initial => :parked, :integration => :active_model)
@status_machine = StateMachine::Machine.new(@model, :status, :initial => :idling, :integration => :active_model)
end
def test_should_should_initialize_each_state
record = @model.new
assert_equal 'parked', record.state
assert_equal 'idling', record.status
end
end
class MachineWithDirtyAttributesTest < BaseTestCase
def setup
@model = new_model do
include ActiveModel::Dirty
define_attribute_methods [:state]
end
@machine = StateMachine::Machine.new(@model, :initial => :parked)
@machine.event :ignite
@machine.state :idling
@record = @model.create
@transition = StateMachine::Transition.new(@record, @machine, :ignite, :parked, :idling)
@transition.perform
end
def test_should_include_state_in_changed_attributes
assert_equal %w(state), @record.changed
end
def test_should_track_attribute_change
assert_equal %w(parked idling), @record.changes['state']
end
def test_should_not_reset_changes_on_multiple_transitions
transition = StateMachine::Transition.new(@record, @machine, :ignite, :idling, :idling)
transition.perform
assert_equal %w(parked idling), @record.changes['state']
end
end
class MachineWithDirtyAttributesDuringLoopbackTest < BaseTestCase
def setup
@model = new_model do
include ActiveModel::Dirty
define_attribute_methods [:state]
end
@machine = StateMachine::Machine.new(@model, :initial => :parked)
@machine.event :park
@record = @model.create
@transition = StateMachine::Transition.new(@record, @machine, :park, :parked, :parked)
@transition.perform
end
def test_should_not_include_state_in_changed_attributes
assert_equal [], @record.changed
end
def test_should_not_track_attribute_changes
assert_equal nil, @record.changes['state']
end
end
class MachineWithDirtyAttributesAndCustomAttributeTest < BaseTestCase
def setup
@model = new_model do
include ActiveModel::Dirty
model_attribute :status
define_attribute_methods [:status]
end
@machine = StateMachine::Machine.new(@model, :status, :initial => :parked)
@machine.event :ignite
@machine.state :idling
@record = @model.create
@transition = StateMachine::Transition.new(@record, @machine, :ignite, :parked, :idling)
@transition.perform
end
def test_should_include_state_in_changed_attributes
assert_equal %w(status), @record.changed
end
def test_should_track_attribute_change
assert_equal %w(parked idling), @record.changes['status']
end
def test_should_not_reset_changes_on_multiple_transitions
transition = StateMachine::Transition.new(@record, @machine, :ignite, :idling, :idling)
transition.perform
assert_equal %w(parked idling), @record.changes['status']
end
end
class MachineWithDirtyAttributeAndCustomAttributesDuringLoopbackTest < BaseTestCase
def setup
@model = new_model do
include ActiveModel::Dirty
model_attribute :status
define_attribute_methods [:status]
end
@machine = StateMachine::Machine.new(@model, :status, :initial => :parked)
@machine.event :park
@record = @model.create
@transition = StateMachine::Transition.new(@record, @machine, :park, :parked, :parked)
@transition.perform
end
def test_should_not_include_state_in_changed_attributes
assert_equal [], @record.changed
end
def test_should_not_track_attribute_changes
assert_equal nil, @record.changes['status']
end
end
class MachineWithDirtyAttributeAndStateEventsTest < BaseTestCase
def setup
@model = new_model do
include ActiveModel::Dirty
define_attribute_methods [:state]
end
@machine = StateMachine::Machine.new(@model, :action => :save, :initial => :parked)
@machine.event :ignite
@record = @model.create
@record.state_event = 'ignite'
end
def test_should_not_include_state_in_changed_attributes
assert_equal [], @record.changed
end
def test_should_not_track_attribute_change
assert_equal nil, @record.changes['state']
end
end
class MachineWithCallbacksTest < BaseTestCase
def setup
@model = new_model
@machine = StateMachine::Machine.new(@model, :initial => :parked, :integration => :active_model)
@machine.other_states :idling
@machine.event :ignite
@record = @model.new(:state => 'parked')
@transition = StateMachine::Transition.new(@record, @machine, :ignite, :parked, :idling)
end
def test_should_run_before_callbacks
called = false
@machine.before_transition {called = true}
@transition.perform
assert called
end
def test_should_pass_record_to_before_callbacks_with_one_argument
record = nil
@machine.before_transition {|arg| record = arg}
@transition.perform
assert_equal @record, record
end
def test_should_pass_record_and_transition_to_before_callbacks_with_multiple_arguments
callback_args = nil
@machine.before_transition {|*args| callback_args = args}
@transition.perform
assert_equal [@record, @transition], callback_args
end
def test_should_run_before_callbacks_outside_the_context_of_the_record
context = nil
@machine.before_transition {context = self}
@transition.perform
assert_equal self, context
end
def test_should_run_after_callbacks
called = false
@machine.after_transition {called = true}
@transition.perform
assert called
end
def test_should_pass_record_to_after_callbacks_with_one_argument
record = nil
@machine.after_transition {|arg| record = arg}
@transition.perform
assert_equal @record, record
end
def test_should_pass_record_and_transition_to_after_callbacks_with_multiple_arguments
callback_args = nil
@machine.after_transition {|*args| callback_args = args}
@transition.perform
assert_equal [@record, @transition], callback_args
end
def test_should_run_after_callbacks_outside_the_context_of_the_record
context = nil
@machine.after_transition {context = self}
@transition.perform
assert_equal self, context
end
def test_should_run_around_callbacks
before_called = false
after_called = false
ensure_called = 0
@machine.around_transition do |block|
before_called = true
begin
block.call
ensure
ensure_called += 1
end
after_called = true
end
@transition.perform
assert before_called
assert after_called
assert_equal ensure_called, 1
end
def test_should_include_transition_states_in_known_states
@machine.before_transition :to => :first_gear, :do => lambda {}
assert_equal [:parked, :idling, :first_gear], @machine.states.map {|state| state.name}
end
def test_should_allow_symbolic_callbacks
callback_args = nil
klass = class << @record; self; end
klass.send(:define_method, :after_ignite) do |*args|
callback_args = args
end
@machine.before_transition(:after_ignite)
@transition.perform
assert_equal [@transition], callback_args
end
def test_should_allow_string_callbacks
class << @record
attr_reader :callback_result
end
@machine.before_transition('@callback_result = [1, 2, 3]')
@transition.perform
assert_equal [1, 2, 3], @record.callback_result
end
end
class MachineWithFailedBeforeCallbacksTest < BaseTestCase
def setup
@callbacks = []
@model = new_model
@machine = StateMachine::Machine.new(@model, :integration => :active_model)
@machine.state :parked, :idling
@machine.event :ignite
@machine.before_transition {@callbacks << :before_1; false}
@machine.before_transition {@callbacks << :before_2}
@machine.after_transition {@callbacks << :after}
@machine.around_transition {|block| @callbacks << :around_before; block.call; @callbacks << :around_after}
@record = @model.new(:state => 'parked')
@transition = StateMachine::Transition.new(@record, @machine, :ignite, :parked, :idling)
@result = @transition.perform
end
def test_should_not_be_successful
assert !@result
end
def test_should_not_change_current_state
assert_equal 'parked', @record.state
end
def test_should_not_run_further_callbacks
assert_equal [:before_1], @callbacks
end
end
class MachineWithFailedAfterCallbacksTest < BaseTestCase
def setup
@callbacks = []
@model = new_model
@machine = StateMachine::Machine.new(@model, :integration => :active_model)
@machine.state :parked, :idling
@machine.event :ignite
@machine.after_transition {@callbacks << :after_1; false}
@machine.after_transition {@callbacks << :after_2}
@machine.around_transition {|block| @callbacks << :around_before; block.call; @callbacks << :around_after}
@record = @model.new(:state => 'parked')
@transition = StateMachine::Transition.new(@record, @machine, :ignite, :parked, :idling)
@result = @transition.perform
end
def test_should_be_successful
assert @result
end
def test_should_change_current_state
assert_equal 'idling', @record.state
end
def test_should_not_run_further_after_callbacks
assert_equal [:around_before, :around_after, :after_1], @callbacks
end
end
class MachineWithValidationsTest < BaseTestCase
def setup
@model = new_model { include ActiveModel::Validations }
@machine = StateMachine::Machine.new(@model, :action => :save)
@machine.state :parked
@record = @model.new
end
def test_should_invalidate_using_errors
I18n.backend = I18n::Backend::Simple.new if Object.const_defined?(:I18n)
@record.state = 'parked'
@machine.invalidate(@record, :state, :invalid_transition, [[:event, 'park']])
assert_equal ['State cannot transition via "park"'], @record.errors.full_messages
end
def test_should_auto_prefix_custom_attributes_on_invalidation
@machine.invalidate(@record, :event, :invalid)
assert_equal ['State event is invalid'], @record.errors.full_messages
end
def test_should_clear_errors_on_reset
@record.state = 'parked'
@record.errors.add(:state, 'is invalid')
@machine.reset(@record)
assert_equal [], @record.errors.full_messages
end
def test_should_be_valid_if_state_is_known
@record.state = 'parked'
assert @record.valid?
end
def test_should_not_be_valid_if_state_is_unknown
@record.state = 'invalid'
assert !@record.valid?
assert_equal ['State is invalid'], @record.errors.full_messages
end
end
class MachineWithValidationsAndCustomAttributeTest < BaseTestCase
def setup
@model = new_model { include ActiveModel::Validations }
@machine = StateMachine::Machine.new(@model, :status, :attribute => :state)
@machine.state :parked
@record = @model.new
end
def test_should_add_validation_errors_to_custom_attribute
@record.state = 'invalid'
assert !@record.valid?
assert_equal ['State is invalid'], @record.errors.full_messages
@record.state = 'parked'
assert @record.valid?
end
end
class MachineErrorsTest < BaseTestCase
def setup
@model = new_model { include ActiveModel::Validations }
@machine = StateMachine::Machine.new(@model)
@record = @model.new
end
def test_should_be_able_to_describe_current_errors
@record.errors.add(:id, 'cannot be blank')
@record.errors.add(:state, 'is invalid')
assert_equal ['Id cannot be blank', 'State is invalid'], @machine.errors_for(@record).split(', ').sort
end
def test_should_describe_as_halted_with_no_errors
assert_equal 'Transition halted', @machine.errors_for(@record)
end
end
class MachineWithStateDrivenValidationsTest < BaseTestCase
def setup
@model = new_model do
include ActiveModel::Validations
attr_accessor :seatbelt
end
@machine = StateMachine::Machine.new(@model)
@machine.state :first_gear, :second_gear do
validates_presence_of :seatbelt
end
@machine.other_states :parked
end
def test_should_be_valid_if_validation_fails_outside_state_scope
record = @model.new(:state => 'parked', :seatbelt => nil)
assert record.valid?
end
def test_should_be_invalid_if_validation_fails_within_state_scope
record = @model.new(:state => 'first_gear', :seatbelt => nil)
assert !record.valid?
end
def test_should_be_valid_if_validation_succeeds_within_state_scope
record = @model.new(:state => 'second_gear', :seatbelt => true)
assert record.valid?
end
end
class ObserverUpdateTest < BaseTestCase
def setup
@model = new_model { include ActiveModel::Observing }
@machine = StateMachine::Machine.new(@model)
@machine.state :parked, :idling
@machine.event :ignite
@record = @model.new(:state => 'parked')
@transition = StateMachine::Transition.new(@record, @machine, :ignite, :parked, :idling)
@observer_update = StateMachine::Integrations::ActiveModel::ObserverUpdate.new(:before_transition, @record, @transition)
end
def test_should_have_method
assert_equal :before_transition, @observer_update.method
end
def test_should_have_object
assert_equal @record, @observer_update.object
end
def test_should_have_transition
assert_equal @transition, @observer_update.transition
end
def test_should_include_object_and_transition_in_args
assert_equal [@record, @transition], @observer_update.args
end
def test_should_use_record_class_as_class
assert_equal @model, @observer_update.class
end
end
class MachineWithObserversTest < BaseTestCase
def setup
@model = new_model { include ActiveModel::Observing }
@machine = StateMachine::Machine.new(@model)
@machine.state :parked, :idling
@machine.event :ignite
@record = @model.new(:state => 'parked')
@transition = StateMachine::Transition.new(@record, @machine, :ignite, :parked, :idling)
end
def test_should_call_all_transition_callback_permutations
callbacks = [
:before_ignite_from_parked_to_idling,
:before_ignite_from_parked,
:before_ignite_to_idling,
:before_ignite,
:before_transition_state_from_parked_to_idling,
:before_transition_state_from_parked,
:before_transition_state_to_idling,
:before_transition_state,
:before_transition
]
observer = new_observer(@model) do
callbacks.each do |callback|
define_method(callback) do |*args|
notifications << callback
end
end
end
instance = observer.instance
@transition.perform
assert_equal callbacks, instance.notifications
end
def test_should_call_no_transition_callbacks_when_observers_disabled
return unless ActiveModel::VERSION::MAJOR >= 3 && ActiveModel::VERSION::MINOR >= 1
callbacks = [
:before_ignite,
:before_transition
]
observer = new_observer(@model) do
callbacks.each do |callback|
define_method(callback) do |*args|
notifications << callback
end
end
end
instance = observer.instance
@model.observers.disable(observer) do
@transition.perform
end
assert_equal [], instance.notifications
end
def test_should_pass_record_and_transition_to_before_callbacks
observer = new_observer(@model) do
def before_transition(*args)
notifications << args
end
end
instance = observer.instance
@transition.perform
assert_equal [[@record, @transition]], instance.notifications
end
def test_should_pass_record_and_transition_to_after_callbacks
observer = new_observer(@model) do
def after_transition(*args)
notifications << args
end
end
instance = observer.instance
@transition.perform
assert_equal [[@record, @transition]], instance.notifications
end
def test_should_call_methods_outside_the_context_of_the_record
observer = new_observer(@model) do
def before_ignite(*args)
notifications << self
end
end
instance = observer.instance
@transition.perform
assert_equal [instance], instance.notifications
end
def test_should_support_nil_from_states
callbacks = [
:before_ignite_from_nil_to_idling,
:before_ignite_from_nil,
:before_transition_state_from_nil_to_idling,
:before_transition_state_from_nil
]
observer = new_observer(@model) do
callbacks.each do |callback|
define_method(callback) do |*args|
notifications << callback
end
end
end
instance = observer.instance
transition = StateMachine::Transition.new(@record, @machine, :ignite, nil, :idling)
transition.perform
assert_equal callbacks, instance.notifications
end
def test_should_support_nil_to_states
callbacks = [
:before_ignite_from_parked_to_nil,
:before_ignite_to_nil,
:before_transition_state_from_parked_to_nil,
:before_transition_state_to_nil
]
observer = new_observer(@model) do
callbacks.each do |callback|
define_method(callback) do |*args|
notifications << callback
end
end
end
instance = observer.instance
transition = StateMachine::Transition.new(@record, @machine, :ignite, :parked, nil)
transition.perform
assert_equal callbacks, instance.notifications
end
end
class MachineWithNamespacedObserversTest < BaseTestCase
def setup
@model = new_model { include ActiveModel::Observing }
@machine = StateMachine::Machine.new(@model, :state, :namespace => 'alarm')
@machine.state :active, :off
@machine.event :enable
@record = @model.new(:state => 'off')
@transition = StateMachine::Transition.new(@record, @machine, :enable, :off, :active)
end
def test_should_call_namespaced_before_event_method
observer = new_observer(@model) do
def before_enable_alarm(*args)
notifications << args
end
end
instance = observer.instance
@transition.perform
assert_equal [[@record, @transition]], instance.notifications
end
def test_should_call_namespaced_after_event_method
observer = new_observer(@model) do
def after_enable_alarm(*args)
notifications << args
end
end
instance = observer.instance
@transition.perform
assert_equal [[@record, @transition]], instance.notifications
end
end
class MachineWithFailureCallbacksTest < BaseTestCase
def setup
@model = new_model { include ActiveModel::Observing }
@machine = StateMachine::Machine.new(@model)
@machine.state :parked, :idling
@machine.event :ignite
@record = @model.new(:state => 'parked')
@transition = StateMachine::Transition.new(@record, @machine, :ignite, :parked, :idling)
@notifications = []
# Create callbacks
@machine.before_transition {false}
@machine.after_failure {@notifications << :callback_after_failure}
# Create observer callbacks
observer = new_observer(@model) do
def after_failure_to_ignite(*args)
notifications << :observer_after_failure_ignite
end
def after_failure_to_transition(*args)
notifications << :observer_after_failure_transition
end
end
instance = observer.instance
instance.notifications = @notifications
@transition.perform
end
def test_should_invoke_callbacks_in_specific_order
expected = [
:callback_after_failure,
:observer_after_failure_ignite,
:observer_after_failure_transition
]
assert_equal expected, @notifications
end
end
class MachineWithMixedCallbacksTest < BaseTestCase
def setup
@model = new_model { include ActiveModel::Observing }
@machine = StateMachine::Machine.new(@model)
@machine.state :parked, :idling
@machine.event :ignite
@record = @model.new(:state => 'parked')
@transition = StateMachine::Transition.new(@record, @machine, :ignite, :parked, :idling)
@notifications = []
# Create callbacks
@machine.before_transition {@notifications << :callback_before_transition}
@machine.after_transition {@notifications << :callback_after_transition}
@machine.around_transition {|block| @notifications << :callback_around_before_transition; block.call; @notifications << :callback_around_after_transition}
# Create observer callbacks
observer = new_observer(@model) do
def before_ignite(*args)
notifications << :observer_before_ignite
end
def before_transition(*args)
notifications << :observer_before_transition
end
def after_ignite(*args)
notifications << :observer_after_ignite
end
def after_transition(*args)
notifications << :observer_after_transition
end
end
instance = observer.instance
instance.notifications = @notifications
@transition.perform
end
def test_should_invoke_callbacks_in_specific_order
expected = [
:callback_before_transition,
:callback_around_before_transition,
:observer_before_ignite,
:observer_before_transition,
:callback_around_after_transition,
:callback_after_transition,
:observer_after_ignite,
:observer_after_transition
]
assert_equal expected, @notifications
end
end
class MachineWithInternationalizationTest < BaseTestCase
def setup
I18n.backend = I18n::Backend::Simple.new
# Initialize the backend
I18n.backend.translate(:en, 'activemodel.errors.messages.invalid_transition', :event => 'ignite', :value => 'idling')
@model = new_model { include ActiveModel::Validations }
end
def test_should_use_defaults
I18n.backend.store_translations(:en, {
:activemodel => {:errors => {:messages => {:invalid_transition => 'cannot %{event}'}}}
})
machine = StateMachine::Machine.new(@model, :action => :save)
machine.state :parked, :idling
machine.event :ignite
record = @model.new(:state => 'idling')
machine.invalidate(record, :state, :invalid_transition, [[:event, 'ignite']])
assert_equal ['State cannot ignite'], record.errors.full_messages
end
def test_should_allow_customized_error_key
I18n.backend.store_translations(:en, {
:activemodel => {:errors => {:messages => {:bad_transition => 'cannot %{event}'}}}
})
machine = StateMachine::Machine.new(@model, :action => :save, :messages => {:invalid_transition => :bad_transition})
machine.state :parked, :idling
record = @model.new
record.state = 'idling'
machine.invalidate(record, :state, :invalid_transition, [[:event, 'ignite']])
assert_equal ['State cannot ignite'], record.errors.full_messages
end
def test_should_allow_customized_error_string
machine = StateMachine::Machine.new(@model, :action => :save, :messages => {:invalid_transition => 'cannot %{event}'})
machine.state :parked, :idling
record = @model.new(:state => 'idling')
machine.invalidate(record, :state, :invalid_transition, [[:event, 'ignite']])
assert_equal ['State cannot ignite'], record.errors.full_messages
end
def test_should_allow_customized_state_key_scoped_to_class_and_machine
I18n.backend.store_translations(:en, {
:activemodel => {:state_machines => {:'active_model_test/foo' => {:state => {:states => {:parked => 'shutdown'}}}}}
})
machine = StateMachine::Machine.new(@model)
machine.state :parked
assert_equal 'shutdown', machine.state(:parked).human_name
end
def test_should_allow_customized_state_key_scoped_to_class
I18n.backend.store_translations(:en, {
:activemodel => {:state_machines => {:'active_model_test/foo' => {:states => {:parked => 'shutdown'}}}}
})
machine = StateMachine::Machine.new(@model)
machine.state :parked
assert_equal 'shutdown', machine.state(:parked).human_name
end
def test_should_allow_customized_state_key_scoped_to_machine
I18n.backend.store_translations(:en, {
:activemodel => {:state_machines => {:state => {:states => {:parked => 'shutdown'}}}}
})
machine = StateMachine::Machine.new(@model)
machine.state :parked
assert_equal 'shutdown', machine.state(:parked).human_name
end
def test_should_allow_customized_state_key_unscoped
I18n.backend.store_translations(:en, {
:activemodel => {:state_machines => {:states => {:parked => 'shutdown'}}}
})
machine = StateMachine::Machine.new(@model)
machine.state :parked
assert_equal 'shutdown', machine.state(:parked).human_name
end
def test_should_support_nil_state_key
I18n.backend.store_translations(:en, {
:activemodel => {:state_machines => {:states => {:nil => 'empty'}}}
})
machine = StateMachine::Machine.new(@model)
assert_equal 'empty', machine.state(nil).human_name
end
def test_should_allow_customized_event_key_scoped_to_class_and_machine
I18n.backend.store_translations(:en, {
:activemodel => {:state_machines => {:'active_model_test/foo' => {:state => {:events => {:park => 'stop'}}}}}
})
machine = StateMachine::Machine.new(@model)
machine.event :park
assert_equal 'stop', machine.event(:park).human_name
end
def test_should_allow_customized_event_key_scoped_to_class
I18n.backend.store_translations(:en, {
:activemodel => {:state_machines => {:'active_model_test/foo' => {:events => {:park => 'stop'}}}}
})
machine = StateMachine::Machine.new(@model)
machine.event :park
assert_equal 'stop', machine.event(:park).human_name
end
def test_should_allow_customized_event_key_scoped_to_machine
I18n.backend.store_translations(:en, {
:activemodel => {:state_machines => {:state => {:events => {:park => 'stop'}}}}
})
machine = StateMachine::Machine.new(@model)
machine.event :park
assert_equal 'stop', machine.event(:park).human_name
end
def test_should_allow_customized_event_key_unscoped
I18n.backend.store_translations(:en, {
:activemodel => {:state_machines => {:events => {:park => 'stop'}}}
})
machine = StateMachine::Machine.new(@model)
machine.event :park
assert_equal 'stop', machine.event(:park).human_name
end
def test_should_only_add_locale_once_in_load_path
assert_equal 1, I18n.load_path.select {|path| path =~ %r{active_model/locale\.rb$}}.length
# Create another ActiveModel model that will triger the i18n feature
new_model
assert_equal 1, I18n.load_path.select {|path| path =~ %r{active_model/locale\.rb$}}.length
end
def test_should_add_locale_to_beginning_of_load_path
@original_load_path = I18n.load_path
I18n.backend = I18n::Backend::Simple.new
app_locale = File.dirname(__FILE__) + '/../../files/en.yml'
default_locale = File.dirname(__FILE__) + '/../../../debian/ruby-state-machine/usr/lib/ruby/vendor_ruby/state_machine/integrations/active_model/locale.rb'
I18n.load_path = [app_locale]
StateMachine::Machine.new(@model)
assert_equal [default_locale, app_locale].map {|path| File.expand_path(path)}, I18n.load_path.map {|path| File.expand_path(path)}
ensure
I18n.load_path = @original_load_path
end
def test_should_prefer_other_locales_first
@original_load_path = I18n.load_path
I18n.backend = I18n::Backend::Simple.new
I18n.load_path = [File.dirname(__FILE__) + '/../../files/en.yml']
machine = StateMachine::Machine.new(@model)
machine.state :parked, :idling
machine.event :ignite
record = @model.new(:state => 'idling')
machine.invalidate(record, :state, :invalid_transition, [[:event, 'ignite']])
assert_equal ['State cannot ignite'], record.errors.full_messages
ensure
I18n.load_path = @original_load_path
end
end
end
|