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
|
require 'test_helper'
require 'active_support/inflector'
require 'jbuilder'
def jbuild(*args, &block)
Jbuilder.new(*args, &block).attributes!
end
Comment = Struct.new(:content, :id)
class NonEnumerable
def initialize(collection)
@collection = collection
end
delegate :map, :count, to: :@collection
end
class VeryBasicWrapper < BasicObject
def initialize(thing)
@thing = thing
end
def method_missing(name, *args, &block)
@thing.send name, *args, &block
end
end
# This is not Struct, because structs are Enumerable
class Person
attr_reader :name, :age
def initialize(name, age)
@name, @age = name, age
end
end
class RelationMock
include Enumerable
def each(&block)
[Person.new('Bob', 30), Person.new('Frank', 50)].each(&block)
end
def empty?
false
end
end
class JbuilderTest < ActiveSupport::TestCase
teardown do
Jbuilder.send :class_variable_set, '@@key_formatter', nil
end
test 'single key' do
result = jbuild do |json|
json.content 'hello'
end
assert_equal 'hello', result['content']
end
test 'single key with false value' do
result = jbuild do |json|
json.content false
end
assert_equal false, result['content']
end
test 'single key with nil value' do
result = jbuild do |json|
json.content nil
end
assert result.has_key?('content')
assert_nil result['content']
end
test 'multiple keys' do
result = jbuild do |json|
json.title 'hello'
json.content 'world'
end
assert_equal 'hello', result['title']
assert_equal 'world', result['content']
end
test 'extracting from object' do
person = Struct.new(:name, :age).new('David', 32)
result = jbuild do |json|
json.extract! person, :name, :age
end
assert_equal 'David', result['name']
assert_equal 32, result['age']
end
test 'extracting from object using call style' do
person = Struct.new(:name, :age).new('David', 32)
result = jbuild do |json|
json.(person, :name, :age)
end
assert_equal 'David', result['name']
assert_equal 32, result['age']
end
test 'extracting from hash' do
person = {:name => 'Jim', :age => 34}
result = jbuild do |json|
json.extract! person, :name, :age
end
assert_equal 'Jim', result['name']
assert_equal 34, result['age']
end
test 'nesting single child with block' do
result = jbuild do |json|
json.author do
json.name 'David'
json.age 32
end
end
assert_equal 'David', result['author']['name']
assert_equal 32, result['author']['age']
end
test 'empty block handling' do
result = jbuild do |json|
json.foo 'bar'
json.author do
end
end
assert_equal 'bar', result['foo']
assert !result.key?('author')
end
test 'blocks are additive' do
result = jbuild do |json|
json.author do
json.name 'David'
end
json.author do
json.age 32
end
end
assert_equal 'David', result['author']['name']
assert_equal 32, result['author']['age']
end
test 'nested blocks are additive' do
result = jbuild do |json|
json.author do
json.name do
json.first 'David'
end
end
json.author do
json.name do
json.last 'Heinemeier Hansson'
end
end
end
assert_equal 'David', result['author']['name']['first']
assert_equal 'Heinemeier Hansson', result['author']['name']['last']
end
test 'support merge! method' do
result = jbuild do |json|
json.merge! 'foo' => 'bar'
end
assert_equal 'bar', result['foo']
end
test 'support merge! method in a block' do
result = jbuild do |json|
json.author do
json.merge! 'name' => 'Pavel'
end
end
assert_equal 'Pavel', result['author']['name']
end
test 'support merge! method with Jbuilder instance' do
obj = jbuild do |json|
json.foo 'bar'
end
result = jbuild do |json|
json.merge! obj
end
assert_equal 'bar', result['foo']
end
test 'blocks are additive via extract syntax' do
person = Person.new('Pavel', 27)
result = jbuild do |json|
json.author person, :age
json.author person, :name
end
assert_equal 'Pavel', result['author']['name']
assert_equal 27, result['author']['age']
end
test 'arrays are additive' do
result = jbuild do |json|
json.array! %w[foo]
json.array! %w[bar]
end
assert_equal %w[foo bar], result
end
test 'nesting multiple children with block' do
result = jbuild do |json|
json.comments do
json.child! { json.content 'hello' }
json.child! { json.content 'world' }
end
end
assert_equal 'hello', result['comments'].first['content']
assert_equal 'world', result['comments'].second['content']
end
test 'nesting single child with inline extract' do
person = Person.new('David', 32)
result = jbuild do |json|
json.author person, :name, :age
end
assert_equal 'David', result['author']['name']
assert_equal 32, result['author']['age']
end
test 'nesting multiple children from array' do
comments = [ Comment.new('hello', 1), Comment.new('world', 2) ]
result = jbuild do |json|
json.comments comments, :content
end
assert_equal ['content'], result['comments'].first.keys
assert_equal 'hello', result['comments'].first['content']
assert_equal 'world', result['comments'].second['content']
end
test 'nesting multiple children from array when child array is empty' do
comments = []
result = jbuild do |json|
json.name 'Parent'
json.comments comments, :content
end
assert_equal 'Parent', result['name']
assert_equal [], result['comments']
end
test 'nesting multiple children from array with inline loop' do
comments = [ Comment.new('hello', 1), Comment.new('world', 2) ]
result = jbuild do |json|
json.comments comments do |comment|
json.content comment.content
end
end
assert_equal ['content'], result['comments'].first.keys
assert_equal 'hello', result['comments'].first['content']
assert_equal 'world', result['comments'].second['content']
end
test 'handles nil-collections as empty arrays' do
result = jbuild do |json|
json.comments nil do |comment|
json.content comment.content
end
end
assert_equal [], result['comments']
end
test 'nesting multiple children from a non-Enumerable that responds to #map' do
comments = NonEnumerable.new([ Comment.new('hello', 1), Comment.new('world', 2) ])
result = jbuild do |json|
json.comments comments, :content
end
assert_equal ['content'], result['comments'].first.keys
assert_equal 'hello', result['comments'].first['content']
assert_equal 'world', result['comments'].second['content']
end
test 'nesting multiple children from a non-Enumerable that responds to #map with inline loop' do
comments = NonEnumerable.new([ Comment.new('hello', 1), Comment.new('world', 2) ])
result = jbuild do |json|
json.comments comments do |comment|
json.content comment.content
end
end
assert_equal ['content'], result['comments'].first.keys
assert_equal 'hello', result['comments'].first['content']
assert_equal 'world', result['comments'].second['content']
end
test 'array! casts array-like objects to array before merging' do
wrapped_array = VeryBasicWrapper.new(%w[foo bar])
result = jbuild do |json|
json.array! wrapped_array
end
assert_equal %w[foo bar], result
end
test 'nesting multiple children from array with inline loop on root' do
comments = [ Comment.new('hello', 1), Comment.new('world', 2) ]
result = jbuild do |json|
json.call(comments) do |comment|
json.content comment.content
end
end
assert_equal 'hello', result.first['content']
assert_equal 'world', result.second['content']
end
test 'array nested inside nested hash' do
result = jbuild do |json|
json.author do
json.name 'David'
json.age 32
json.comments do
json.child! { json.content 'hello' }
json.child! { json.content 'world' }
end
end
end
assert_equal 'hello', result['author']['comments'].first['content']
assert_equal 'world', result['author']['comments'].second['content']
end
test 'array nested inside array' do
result = jbuild do |json|
json.comments do
json.child! do
json.authors do
json.child! do
json.name 'david'
end
end
end
end
end
assert_equal 'david', result['comments'].first['authors'].first['name']
end
test 'directly set an array nested in another array' do
data = [ { :department => 'QA', :not_in_json => 'hello', :names => ['John', 'David'] } ]
result = jbuild do |json|
json.array! data do |object|
json.department object[:department]
json.names do
json.array! object[:names]
end
end
end
assert_equal 'David', result[0]['names'].last
assert !result[0].key?('not_in_json')
end
test 'nested jbuilder objects' do
to_nest = Jbuilder.new{ |json| json.nested_value 'Nested Test' }
result = jbuild do |json|
json.value 'Test'
json.nested to_nest
end
expected = {'value' => 'Test', 'nested' => {'nested_value' => 'Nested Test'}}
assert_equal expected, result
end
test 'nested jbuilder object via set!' do
to_nest = Jbuilder.new{ |json| json.nested_value 'Nested Test' }
result = jbuild do |json|
json.value 'Test'
json.set! :nested, to_nest
end
expected = {'value' => 'Test', 'nested' => {'nested_value' => 'Nested Test'}}
assert_equal expected, result
end
test 'top-level array' do
comments = [ Comment.new('hello', 1), Comment.new('world', 2) ]
result = jbuild do |json|
json.array! comments do |comment|
json.content comment.content
end
end
assert_equal 'hello', result.first['content']
assert_equal 'world', result.second['content']
end
test 'it allows using next in array block to skip value' do
comments = [ Comment.new('hello', 1), Comment.new('skip', 2), Comment.new('world', 3) ]
result = jbuild do |json|
json.array! comments do |comment|
next if comment.id == 2
json.content comment.content
end
end
assert_equal 2, result.length
assert_equal 'hello', result.first['content']
assert_equal 'world', result.second['content']
end
test 'extract attributes directly from array' do
comments = [ Comment.new('hello', 1), Comment.new('world', 2) ]
result = jbuild do |json|
json.array! comments, :content, :id
end
assert_equal 'hello', result.first['content']
assert_equal 1, result.first['id']
assert_equal 'world', result.second['content']
assert_equal 2, result.second['id']
end
test 'empty top-level array' do
comments = []
result = jbuild do |json|
json.array! comments do |comment|
json.content comment.content
end
end
assert_equal [], result
end
test 'dynamically set a key/value' do
result = jbuild do |json|
json.set! :each, 'stuff'
end
assert_equal 'stuff', result['each']
end
test 'dynamically set a key/nested child with block' do
result = jbuild do |json|
json.set! :author do
json.name 'David'
json.age 32
end
end
assert_equal 'David', result['author']['name']
assert_equal 32, result['author']['age']
end
test 'dynamically sets a collection' do
comments = [ Comment.new('hello', 1), Comment.new('world', 2) ]
result = jbuild do |json|
json.set! :comments, comments, :content
end
assert_equal ['content'], result['comments'].first.keys
assert_equal 'hello', result['comments'].first['content']
assert_equal 'world', result['comments'].second['content']
end
test 'query like object' do
result = jbuild do |json|
json.relations RelationMock.new, :name, :age
end
assert_equal 2, result['relations'].length
assert_equal 'Bob', result['relations'][0]['name']
assert_equal 50, result['relations'][1]['age']
end
test 'initialize via options hash' do
jbuilder = Jbuilder.new(key_formatter: 1, ignore_nil: 2)
assert_equal 1, jbuilder.instance_eval{ @key_formatter }
assert_equal 2, jbuilder.instance_eval{ @ignore_nil }
end
test 'key_format! with parameter' do
result = jbuild do |json|
json.key_format! camelize: [:lower]
json.camel_style 'for JS'
end
assert_equal ['camelStyle'], result.keys
end
test 'key_format! with parameter not as an array' do
result = jbuild do |json|
json.key_format! :camelize => :lower
json.camel_style 'for JS'
end
assert_equal ['camelStyle'], result.keys
end
test 'key_format! propagates to child elements' do
result = jbuild do |json|
json.key_format! :upcase
json.level1 'one'
json.level2 do
json.value 'two'
end
end
assert_equal 'one', result['LEVEL1']
assert_equal 'two', result['LEVEL2']['VALUE']
end
test 'key_format! resets after child element' do
result = jbuild do |json|
json.level2 do
json.key_format! :upcase
json.value 'two'
end
json.level1 'one'
end
assert_equal 'two', result['level2']['VALUE']
assert_equal 'one', result['level1']
end
test 'key_format! can be changed in child elements' do
result = jbuild do |json|
json.key_format! camelize: :lower
json.level_one do
json.key_format! :upcase
json.value 'two'
end
end
assert_equal ['levelOne'], result.keys
assert_equal ['VALUE'], result['levelOne'].keys
end
test 'key_format! can be changed in array!' do
result = jbuild do |json|
json.key_format! camelize: :lower
json.level_one do
json.array! [{value: 'two'}] do |object|
json.key_format! :upcase
json.value object[:value]
end
end
end
assert_equal ['levelOne'], result.keys
assert_equal ['VALUE'], result['levelOne'][0].keys
end
test 'key_format! with no parameter' do
result = jbuild do |json|
json.key_format! :upcase
json.lower 'Value'
end
assert_equal ['LOWER'], result.keys
end
test 'key_format! with multiple steps' do
result = jbuild do |json|
json.key_format! :upcase, :pluralize
json.pill 'foo'
end
assert_equal ['PILLs'], result.keys
end
test 'key_format! with lambda/proc' do
result = jbuild do |json|
json.key_format! ->(key){ key + ' and friends' }
json.oats 'foo'
end
assert_equal ['oats and friends'], result.keys
end
test 'key_format! is not applied deeply by default' do
names = { first_name: 'camel', last_name: 'case' }
result = jbuild do |json|
json.key_format! camelize: :lower
json.set! :all_names, names
end
assert_equal %i[first_name last_name], result['allNames'].keys
end
test 'applying key_format! deeply can be enabled per scope' do
names = { first_name: 'camel', last_name: 'case' }
result = jbuild do |json|
json.key_format! camelize: :lower
json.scope do
json.deep_format_keys!
json.set! :all_names, names
end
json.set! :all_names, names
end
assert_equal %w[firstName lastName], result['scope']['allNames'].keys
assert_equal %i[first_name last_name], result['allNames'].keys
end
test 'applying key_format! deeply can be disabled per scope' do
names = { first_name: 'camel', last_name: 'case' }
result = jbuild do |json|
json.key_format! camelize: :lower
json.deep_format_keys!
json.set! :all_names, names
json.scope do
json.deep_format_keys! false
json.set! :all_names, names
end
end
assert_equal %w[firstName lastName], result['allNames'].keys
assert_equal %i[first_name last_name], result['scope']['allNames'].keys
end
test 'applying key_format! deeply can be enabled globally' do
names = { first_name: 'camel', last_name: 'case' }
Jbuilder.deep_format_keys true
result = jbuild do |json|
json.key_format! camelize: :lower
json.set! :all_names, names
end
assert_equal %w[firstName lastName], result['allNames'].keys
Jbuilder.send(:class_variable_set, '@@deep_format_keys', false)
end
test 'deep key_format! with merge!' do
hash = { camel_style: 'for JS' }
result = jbuild do |json|
json.key_format! camelize: :lower
json.deep_format_keys!
json.merge! hash
end
assert_equal ['camelStyle'], result.keys
end
test 'deep key_format! with merge! deep' do
hash = { camel_style: { sub_attr: 'for JS' } }
result = jbuild do |json|
json.key_format! camelize: :lower
json.deep_format_keys!
json.merge! hash
end
assert_equal ['subAttr'], result['camelStyle'].keys
end
test 'deep key_format! with set! array of hashes' do
names = [{ first_name: 'camel', last_name: 'case' }]
result = jbuild do |json|
json.key_format! camelize: :lower
json.deep_format_keys!
json.set! :names, names
end
assert_equal %w[firstName lastName], result['names'][0].keys
end
test 'deep key_format! with set! extracting hash from object' do
comment = Struct.new(:author).new({ first_name: 'camel', last_name: 'case' })
result = jbuild do |json|
json.key_format! camelize: :lower
json.deep_format_keys!
json.set! :comment, comment, :author
end
assert_equal %w[firstName lastName], result['comment']['author'].keys
end
test 'deep key_format! with array! of hashes' do
names = [{ first_name: 'camel', last_name: 'case' }]
result = jbuild do |json|
json.key_format! camelize: :lower
json.deep_format_keys!
json.array! names
end
assert_equal %w[firstName lastName], result[0].keys
end
test 'deep key_format! with merge! array of hashes' do
names = [{ first_name: 'camel', last_name: 'case' }]
new_names = [{ first_name: 'snake', last_name: 'case' }]
result = jbuild do |json|
json.key_format! camelize: :lower
json.deep_format_keys!
json.array! names
json.merge! new_names
end
assert_equal %w[firstName lastName], result[1].keys
end
test 'deep key_format! is applied to hash extracted from object' do
comment = Struct.new(:author).new({ first_name: 'camel', last_name: 'case' })
result = jbuild do |json|
json.key_format! camelize: :lower
json.deep_format_keys!
json.extract! comment, :author
end
assert_equal %w[firstName lastName], result['author'].keys
end
test 'deep key_format! is applied to hash extracted from hash' do
comment = {author: { first_name: 'camel', last_name: 'case' }}
result = jbuild do |json|
json.key_format! camelize: :lower
json.deep_format_keys!
json.extract! comment, :author
end
assert_equal %w[firstName lastName], result['author'].keys
end
test 'deep key_format! is applied to hash extracted directly from array' do
comments = [Struct.new(:author).new({ first_name: 'camel', last_name: 'case' })]
result = jbuild do |json|
json.key_format! camelize: :lower
json.deep_format_keys!
json.array! comments, :author
end
assert_equal %w[firstName lastName], result[0]['author'].keys
end
test 'default key_format!' do
Jbuilder.key_format camelize: :lower
result = jbuild{ |json| json.camel_style 'for JS' }
assert_equal ['camelStyle'], result.keys
end
test 'do not use default key formatter directly' do
Jbuilder.key_format
jbuild{ |json| json.key 'value' }
formatter = Jbuilder.send(:class_variable_get, '@@key_formatter')
cache = formatter.instance_variable_get('@cache')
assert_empty cache
end
test 'ignore_nil! without a parameter' do
result = jbuild do |json|
json.ignore_nil!
json.test nil
end
assert_empty result.keys
end
test 'ignore_nil! with parameter' do
result = jbuild do |json|
json.ignore_nil! true
json.name 'Bob'
json.dne nil
end
assert_equal ['name'], result.keys
result = jbuild do |json|
json.ignore_nil! false
json.name 'Bob'
json.dne nil
end
assert_equal ['name', 'dne'], result.keys
end
test 'default ignore_nil!' do
Jbuilder.ignore_nil
result = jbuild do |json|
json.name 'Bob'
json.dne nil
end
assert_equal ['name'], result.keys
Jbuilder.send(:class_variable_set, '@@ignore_nil', false)
end
test 'nil!' do
result = jbuild do |json|
json.key 'value'
json.nil!
end
assert_nil result
end
test 'null!' do
result = jbuild do |json|
json.key 'value'
json.null!
end
assert_nil result
end
test 'null! in a block' do
result = jbuild do |json|
json.author do
json.name 'David'
end
json.author do
json.null!
end
end
assert result.key?('author')
assert_nil result['author']
end
test 'empty attributes respond to empty?' do
attributes = Jbuilder.new.attributes!
assert attributes.empty?
assert attributes.blank?
assert !attributes.present?
end
test 'throws ArrayError when trying to add a key to an array' do
assert_raise Jbuilder::ArrayError do
jbuild do |json|
json.array! %w[foo bar]
json.fizz "buzz"
end
end
end
test 'throws NullError when trying to add properties to null' do
assert_raise Jbuilder::NullError do
jbuild do |json|
json.null!
json.foo 'bar'
end
end
end
test 'throws NullError when trying to add properties to null using block syntax' do
assert_raise Jbuilder::NullError do
jbuild do |json|
json.author do
json.null!
end
json.author do
json.name "Pavel"
end
end
end
end
test "throws MergeError when trying to merge array with non-empty hash" do
assert_raise Jbuilder::MergeError do
jbuild do |json|
json.name "Daniel"
json.merge! []
end
end
end
test "throws MergeError when trying to merge hash with array" do
assert_raise Jbuilder::MergeError do
jbuild do |json|
json.array!
json.merge!({})
end
end
end
test "throws MergeError when trying to merge invalid objects" do
assert_raise Jbuilder::MergeError do
jbuild do |json|
json.name "Daniel"
json.merge! "Nope"
end
end
end
if RUBY_VERSION >= "2.2.10"
test "respects JSON encoding customizations" do
# Active Support overrides Time#as_json for custom formatting.
# Ensure we call #to_json on the final attributes instead of JSON.dump.
result = JSON.load(Jbuilder.encode { |json| json.time Time.parse("2018-05-13 11:51:00.485 -0400") })
assert_equal "2018-05-13T11:51:00.485-04:00", result["time"]
end
end
end
|