active_model_serializers 0.10.7 → 0.10.12

Sign up to get free protection for your applications and to get access to all the features.
Files changed (213) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +62 -1
  3. data/README.md +20 -20
  4. data/lib/action_controller/serialization.rb +11 -1
  5. data/lib/active_model/serializable_resource.rb +2 -0
  6. data/lib/active_model/serializer.rb +33 -18
  7. data/lib/active_model/serializer/adapter.rb +2 -0
  8. data/lib/active_model/serializer/adapter/attributes.rb +2 -0
  9. data/lib/active_model/serializer/adapter/base.rb +2 -0
  10. data/lib/active_model/serializer/adapter/json.rb +2 -0
  11. data/lib/active_model/serializer/adapter/json_api.rb +2 -0
  12. data/lib/active_model/serializer/adapter/null.rb +2 -0
  13. data/lib/active_model/serializer/array_serializer.rb +2 -0
  14. data/lib/active_model/serializer/association.rb +2 -0
  15. data/lib/active_model/serializer/attribute.rb +2 -0
  16. data/lib/active_model/serializer/belongs_to_reflection.rb +2 -0
  17. data/lib/active_model/serializer/collection_serializer.rb +6 -6
  18. data/lib/active_model/serializer/concerns/caching.rb +7 -2
  19. data/lib/active_model/serializer/error_serializer.rb +2 -0
  20. data/lib/active_model/serializer/errors_serializer.rb +2 -0
  21. data/lib/active_model/serializer/field.rb +2 -0
  22. data/lib/active_model/serializer/fieldset.rb +3 -1
  23. data/lib/active_model/serializer/has_many_reflection.rb +2 -0
  24. data/lib/active_model/serializer/has_one_reflection.rb +2 -0
  25. data/lib/active_model/serializer/lazy_association.rb +6 -2
  26. data/lib/active_model/serializer/link.rb +23 -0
  27. data/lib/active_model/serializer/lint.rb +2 -0
  28. data/lib/active_model/serializer/null.rb +2 -0
  29. data/lib/active_model/serializer/reflection.rb +9 -4
  30. data/lib/active_model/serializer/version.rb +3 -1
  31. data/lib/active_model_serializers.rb +20 -10
  32. data/lib/active_model_serializers/adapter.rb +3 -1
  33. data/lib/active_model_serializers/adapter/attributes.rb +23 -0
  34. data/lib/active_model_serializers/adapter/base.rb +2 -0
  35. data/lib/active_model_serializers/adapter/json.rb +2 -0
  36. data/lib/active_model_serializers/adapter/json_api.rb +14 -9
  37. data/lib/active_model_serializers/adapter/json_api/deserialization.rb +2 -0
  38. data/lib/active_model_serializers/adapter/json_api/error.rb +2 -0
  39. data/lib/active_model_serializers/adapter/json_api/jsonapi.rb +2 -0
  40. data/lib/active_model_serializers/adapter/json_api/link.rb +2 -0
  41. data/lib/active_model_serializers/adapter/json_api/meta.rb +2 -0
  42. data/lib/active_model_serializers/adapter/json_api/pagination_links.rb +2 -0
  43. data/lib/active_model_serializers/adapter/json_api/relationship.rb +2 -0
  44. data/lib/active_model_serializers/adapter/json_api/resource_identifier.rb +3 -1
  45. data/lib/active_model_serializers/adapter/null.rb +2 -0
  46. data/lib/active_model_serializers/callbacks.rb +2 -0
  47. data/lib/active_model_serializers/deprecate.rb +2 -0
  48. data/lib/active_model_serializers/deserialization.rb +2 -0
  49. data/lib/active_model_serializers/json_pointer.rb +2 -0
  50. data/lib/active_model_serializers/logging.rb +2 -0
  51. data/lib/active_model_serializers/lookup_chain.rb +2 -0
  52. data/lib/active_model_serializers/model.rb +2 -0
  53. data/lib/active_model_serializers/model/caching.rb +25 -0
  54. data/lib/active_model_serializers/railtie.rb +4 -0
  55. data/lib/active_model_serializers/register_jsonapi_renderer.rb +2 -0
  56. data/lib/active_model_serializers/serializable_resource.rb +4 -2
  57. data/lib/active_model_serializers/serialization_context.rb +2 -0
  58. data/lib/active_model_serializers/test.rb +2 -0
  59. data/lib/active_model_serializers/test/schema.rb +2 -0
  60. data/lib/active_model_serializers/test/serializer.rb +2 -0
  61. data/lib/generators/rails/resource_override.rb +2 -0
  62. data/lib/generators/rails/serializer_generator.rb +2 -0
  63. data/lib/grape/active_model_serializers.rb +2 -0
  64. data/lib/grape/formatters/active_model_serializers.rb +2 -0
  65. data/lib/grape/helpers/active_model_serializers.rb +2 -0
  66. data/lib/tasks/rubocop.rake +2 -0
  67. metadata +70 -295
  68. data/.github/ISSUE_TEMPLATE.md +0 -29
  69. data/.github/PULL_REQUEST_TEMPLATE.md +0 -15
  70. data/.gitignore +0 -35
  71. data/.rubocop.yml +0 -105
  72. data/.simplecov +0 -110
  73. data/.travis.yml +0 -52
  74. data/CODE_OF_CONDUCT.md +0 -74
  75. data/CONTRIBUTING.md +0 -105
  76. data/Gemfile +0 -72
  77. data/Rakefile +0 -74
  78. data/active_model_serializers.gemspec +0 -63
  79. data/appveyor.yml +0 -28
  80. data/bin/bench +0 -171
  81. data/bin/bench_regression +0 -316
  82. data/bin/rubocop +0 -38
  83. data/bin/serve_benchmark +0 -39
  84. data/docs/README.md +0 -41
  85. data/docs/STYLE.md +0 -58
  86. data/docs/general/adapters.md +0 -269
  87. data/docs/general/caching.md +0 -58
  88. data/docs/general/configuration_options.md +0 -185
  89. data/docs/general/deserialization.md +0 -100
  90. data/docs/general/fields.md +0 -31
  91. data/docs/general/getting_started.md +0 -133
  92. data/docs/general/instrumentation.md +0 -40
  93. data/docs/general/key_transforms.md +0 -40
  94. data/docs/general/logging.md +0 -21
  95. data/docs/general/rendering.md +0 -293
  96. data/docs/general/serializers.md +0 -483
  97. data/docs/how-open-source-maintained.jpg +0 -0
  98. data/docs/howto/add_pagination_links.md +0 -138
  99. data/docs/howto/add_relationship_links.md +0 -140
  100. data/docs/howto/add_root_key.md +0 -62
  101. data/docs/howto/grape_integration.md +0 -42
  102. data/docs/howto/outside_controller_use.md +0 -66
  103. data/docs/howto/passing_arbitrary_options.md +0 -27
  104. data/docs/howto/serialize_poro.md +0 -73
  105. data/docs/howto/test.md +0 -154
  106. data/docs/howto/upgrade_from_0_8_to_0_10.md +0 -265
  107. data/docs/integrations/ember-and-json-api.md +0 -147
  108. data/docs/integrations/grape.md +0 -19
  109. data/docs/jsonapi/errors.md +0 -56
  110. data/docs/jsonapi/schema.md +0 -151
  111. data/docs/jsonapi/schema/schema.json +0 -366
  112. data/docs/rfcs/0000-namespace.md +0 -106
  113. data/docs/rfcs/template.md +0 -15
  114. data/test/action_controller/adapter_selector_test.rb +0 -62
  115. data/test/action_controller/explicit_serializer_test.rb +0 -135
  116. data/test/action_controller/json/include_test.rb +0 -246
  117. data/test/action_controller/json_api/deserialization_test.rb +0 -112
  118. data/test/action_controller/json_api/errors_test.rb +0 -40
  119. data/test/action_controller/json_api/fields_test.rb +0 -66
  120. data/test/action_controller/json_api/linked_test.rb +0 -202
  121. data/test/action_controller/json_api/pagination_test.rb +0 -124
  122. data/test/action_controller/json_api/transform_test.rb +0 -189
  123. data/test/action_controller/lookup_proc_test.rb +0 -49
  124. data/test/action_controller/namespace_lookup_test.rb +0 -232
  125. data/test/action_controller/serialization_scope_name_test.rb +0 -235
  126. data/test/action_controller/serialization_test.rb +0 -472
  127. data/test/active_model_serializers/adapter_for_test.rb +0 -208
  128. data/test/active_model_serializers/json_pointer_test.rb +0 -22
  129. data/test/active_model_serializers/logging_test.rb +0 -77
  130. data/test/active_model_serializers/model_test.rb +0 -142
  131. data/test/active_model_serializers/railtie_test_isolated.rb +0 -68
  132. data/test/active_model_serializers/register_jsonapi_renderer_test_isolated.rb +0 -161
  133. data/test/active_model_serializers/serialization_context_test_isolated.rb +0 -71
  134. data/test/active_model_serializers/test/schema_test.rb +0 -131
  135. data/test/active_model_serializers/test/serializer_test.rb +0 -62
  136. data/test/active_record_test.rb +0 -9
  137. data/test/adapter/attributes_test.rb +0 -40
  138. data/test/adapter/deprecation_test.rb +0 -100
  139. data/test/adapter/json/belongs_to_test.rb +0 -45
  140. data/test/adapter/json/collection_test.rb +0 -104
  141. data/test/adapter/json/has_many_test.rb +0 -53
  142. data/test/adapter/json/transform_test.rb +0 -93
  143. data/test/adapter/json_api/belongs_to_test.rb +0 -155
  144. data/test/adapter/json_api/collection_test.rb +0 -96
  145. data/test/adapter/json_api/errors_test.rb +0 -76
  146. data/test/adapter/json_api/fields_test.rb +0 -96
  147. data/test/adapter/json_api/has_many_explicit_serializer_test.rb +0 -96
  148. data/test/adapter/json_api/has_many_test.rb +0 -173
  149. data/test/adapter/json_api/has_one_test.rb +0 -80
  150. data/test/adapter/json_api/include_data_if_sideloaded_test.rb +0 -213
  151. data/test/adapter/json_api/json_api_test.rb +0 -33
  152. data/test/adapter/json_api/linked_test.rb +0 -413
  153. data/test/adapter/json_api/links_test.rb +0 -95
  154. data/test/adapter/json_api/pagination_links_test.rb +0 -206
  155. data/test/adapter/json_api/parse_test.rb +0 -137
  156. data/test/adapter/json_api/relationship_test.rb +0 -397
  157. data/test/adapter/json_api/resource_meta_test.rb +0 -100
  158. data/test/adapter/json_api/toplevel_jsonapi_test.rb +0 -82
  159. data/test/adapter/json_api/transform_test.rb +0 -512
  160. data/test/adapter/json_api/type_test.rb +0 -193
  161. data/test/adapter/json_test.rb +0 -46
  162. data/test/adapter/null_test.rb +0 -22
  163. data/test/adapter/polymorphic_test.rb +0 -218
  164. data/test/adapter_test.rb +0 -67
  165. data/test/array_serializer_test.rb +0 -22
  166. data/test/benchmark/app.rb +0 -65
  167. data/test/benchmark/benchmarking_support.rb +0 -67
  168. data/test/benchmark/bm_active_record.rb +0 -81
  169. data/test/benchmark/bm_adapter.rb +0 -38
  170. data/test/benchmark/bm_caching.rb +0 -119
  171. data/test/benchmark/bm_lookup_chain.rb +0 -83
  172. data/test/benchmark/bm_transform.rb +0 -45
  173. data/test/benchmark/config.ru +0 -3
  174. data/test/benchmark/controllers.rb +0 -83
  175. data/test/benchmark/fixtures.rb +0 -219
  176. data/test/cache_test.rb +0 -651
  177. data/test/collection_serializer_test.rb +0 -127
  178. data/test/fixtures/active_record.rb +0 -113
  179. data/test/fixtures/poro.rb +0 -225
  180. data/test/generators/scaffold_controller_generator_test.rb +0 -24
  181. data/test/generators/serializer_generator_test.rb +0 -75
  182. data/test/grape_test.rb +0 -196
  183. data/test/lint_test.rb +0 -49
  184. data/test/logger_test.rb +0 -20
  185. data/test/poro_test.rb +0 -9
  186. data/test/serializable_resource_test.rb +0 -79
  187. data/test/serializers/association_macros_test.rb +0 -37
  188. data/test/serializers/associations_test.rb +0 -468
  189. data/test/serializers/attribute_test.rb +0 -153
  190. data/test/serializers/attributes_test.rb +0 -52
  191. data/test/serializers/caching_configuration_test_isolated.rb +0 -170
  192. data/test/serializers/configuration_test.rb +0 -32
  193. data/test/serializers/fieldset_test.rb +0 -14
  194. data/test/serializers/meta_test.rb +0 -202
  195. data/test/serializers/options_test.rb +0 -32
  196. data/test/serializers/read_attribute_for_serialization_test.rb +0 -79
  197. data/test/serializers/reflection_test.rb +0 -427
  198. data/test/serializers/root_test.rb +0 -21
  199. data/test/serializers/serialization_test.rb +0 -55
  200. data/test/serializers/serializer_for_test.rb +0 -136
  201. data/test/serializers/serializer_for_with_namespace_test.rb +0 -88
  202. data/test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json +0 -6
  203. data/test/support/isolated_unit.rb +0 -84
  204. data/test/support/rails5_shims.rb +0 -53
  205. data/test/support/rails_app.rb +0 -38
  206. data/test/support/schemas/active_model_serializers/test/schema_test/my/index.json +0 -6
  207. data/test/support/schemas/active_model_serializers/test/schema_test/my/show.json +0 -6
  208. data/test/support/schemas/custom/show.json +0 -7
  209. data/test/support/schemas/hyper_schema.json +0 -93
  210. data/test/support/schemas/render_using_json_api.json +0 -43
  211. data/test/support/schemas/simple_json_pointers.json +0 -10
  212. data/test/support/serialization_testing.rb +0 -79
  213. data/test/test_helper.rb +0 -70
@@ -1,67 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModelSerializers
4
- class AdapterTest < ActiveSupport::TestCase
5
- def setup
6
- profile = Profile.new
7
- @serializer = ProfileSerializer.new(profile)
8
- @adapter = ActiveModelSerializers::Adapter::Base.new(@serializer)
9
- end
10
-
11
- def test_serializable_hash_is_abstract_method
12
- assert_raises(NotImplementedError) do
13
- @adapter.serializable_hash(only: [:name])
14
- end
15
- end
16
-
17
- def test_serialization_options_ensures_option_is_a_hash
18
- adapter = Class.new(ActiveModelSerializers::Adapter::Base) do
19
- def serializable_hash(options = nil)
20
- serialization_options(options)
21
- end
22
- end.new(@serializer)
23
- assert_equal({}, adapter.serializable_hash(nil))
24
- assert_equal({}, adapter.serializable_hash({}))
25
- ensure
26
- ActiveModelSerializers::Adapter.adapter_map.delete_if { |k, _| k =~ /class/ }
27
- end
28
-
29
- def test_serialization_options_ensures_option_is_one_of_valid_options
30
- adapter = Class.new(ActiveModelSerializers::Adapter::Base) do
31
- def serializable_hash(options = nil)
32
- serialization_options(options)
33
- end
34
- end.new(@serializer)
35
- filtered_options = { now: :see_me, then: :not }
36
- valid_options = ActiveModel::Serializer::SERIALIZABLE_HASH_VALID_KEYS.each_with_object({}) do |option, result|
37
- result[option] = option
38
- end
39
- assert_equal(valid_options, adapter.serializable_hash(filtered_options.merge(valid_options)))
40
- ensure
41
- ActiveModelSerializers::Adapter.adapter_map.delete_if { |k, _| k =~ /class/ }
42
- end
43
-
44
- def test_serializer
45
- assert_equal @serializer, @adapter.serializer
46
- end
47
-
48
- def test_create_adapter
49
- adapter = ActiveModelSerializers::Adapter.create(@serializer)
50
- assert_equal ActiveModelSerializers::Adapter::Attributes, adapter.class
51
- end
52
-
53
- def test_create_adapter_with_override
54
- adapter = ActiveModelSerializers::Adapter.create(@serializer, adapter: :json_api)
55
- assert_equal ActiveModelSerializers::Adapter::JsonApi, adapter.class
56
- end
57
-
58
- def test_inflected_adapter_class_for_known_adapter
59
- ActiveSupport::Inflector.inflections(:en) { |inflect| inflect.acronym 'API' }
60
- klass = ActiveModelSerializers::Adapter.adapter_class(:json_api)
61
-
62
- ActiveSupport::Inflector.inflections.acronyms.clear
63
-
64
- assert_equal ActiveModelSerializers::Adapter::JsonApi, klass
65
- end
66
- end
67
- end
@@ -1,22 +0,0 @@
1
- require 'test_helper'
2
- require_relative 'collection_serializer_test'
3
-
4
- module ActiveModel
5
- class Serializer
6
- class ArraySerializerTest < CollectionSerializerTest
7
- extend Minitest::Assertions
8
- def self.run_one_method(*)
9
- _, stderr = capture_io do
10
- super
11
- end
12
- if stderr !~ /NOTE: ActiveModel::Serializer::ArraySerializer.new is deprecated/
13
- fail Minitest::Assertion, stderr
14
- end
15
- end
16
-
17
- def collection_serializer
18
- ArraySerializer
19
- end
20
- end
21
- end
22
- end
@@ -1,65 +0,0 @@
1
- # https://github.com/rails-api/active_model_serializers/pull/872
2
- # approx ref 792fb8a9053f8db3c562dae4f40907a582dd1720 to test against
3
- require 'bundler/setup'
4
-
5
- require 'rails'
6
- require 'active_model'
7
- require 'active_support'
8
- require 'active_support/json'
9
- require 'action_controller'
10
- require 'action_controller/test_case'
11
- require 'action_controller/railtie'
12
- abort "Rails application already defined: #{Rails.application.class}" if Rails.application
13
-
14
- class NullLogger < Logger
15
- def initialize(*_args)
16
- end
17
-
18
- def add(*_args, &_block)
19
- end
20
- end
21
- class BenchmarkLogger < ActiveSupport::Logger
22
- def initialize
23
- @file = StringIO.new
24
- super(@file)
25
- end
26
-
27
- def messages
28
- @file.rewind
29
- @file.read
30
- end
31
- end
32
- # ref: https://gist.github.com/bf4/8744473
33
- class BenchmarkApp < Rails::Application
34
- # Set up production configuration
35
- config.eager_load = true
36
- config.cache_classes = true
37
- # CONFIG: CACHE_ON={on,off}
38
- config.action_controller.perform_caching = ENV['CACHE_ON'] != 'off'
39
- config.action_controller.cache_store = ActiveSupport::Cache.lookup_store(:memory_store)
40
-
41
- config.active_support.test_order = :random
42
- config.secret_token = 'S' * 30
43
- config.secret_key_base = 'abc123'
44
- config.consider_all_requests_local = false
45
-
46
- # otherwise deadlock occurred
47
- config.middleware.delete 'Rack::Lock'
48
-
49
- # to disable log files
50
- config.logger = NullLogger.new
51
- config.active_support.deprecation = :log
52
- config.log_level = :info
53
- end
54
-
55
- require 'active_model_serializers'
56
-
57
- # Initialize app before any serializers are defined, for running across revisions.
58
- # ref: https://github.com/rails-api/active_model_serializers/pull/1478
59
- Rails.application.initialize!
60
- # HACK: Serializer::cache depends on the ActionController-dependent configs being set.
61
- ActiveSupport.on_load(:action_controller) do
62
- require_relative 'fixtures'
63
- end
64
-
65
- require_relative 'controllers'
@@ -1,67 +0,0 @@
1
- require 'benchmark/ips'
2
- require 'json'
3
-
4
- # Add benchmarking runner from ruby-bench-suite
5
- # https://github.com/ruby-bench/ruby-bench-suite/blob/master/rails/benchmarks/support/benchmark_rails.rb
6
- module Benchmark
7
- module ActiveModelSerializers
8
- module TestMethods
9
- def request(method, path)
10
- response = Rack::MockRequest.new(BenchmarkApp).send(method, path)
11
- if response.status.in?([404, 500])
12
- fail "omg, #{method}, #{path}, '#{response.status}', '#{response.body}'"
13
- end
14
- response
15
- end
16
- end
17
-
18
- # extend Benchmark with an `ams` method
19
- def ams(label = nil, time:, disable_gc: true, warmup: 3, &block)
20
- fail ArgumentError.new, 'block should be passed' unless block_given?
21
-
22
- if disable_gc
23
- GC.disable
24
- else
25
- GC.enable
26
- end
27
-
28
- report = Benchmark.ips(time, warmup, true) do |x|
29
- x.report(label) { yield }
30
- end
31
-
32
- entry = report.entries.first
33
-
34
- output = {
35
- label: label,
36
- version: ::ActiveModel::Serializer::VERSION.to_s,
37
- rails_version: ::Rails.version.to_s,
38
- iterations_per_second: entry.ips,
39
- iterations_per_second_standard_deviation: entry.error_percentage,
40
- total_allocated_objects_per_iteration: count_total_allocated_objects(&block)
41
- }.to_json
42
-
43
- puts output
44
- output
45
- end
46
-
47
- def count_total_allocated_objects
48
- if block_given?
49
- key =
50
- if RUBY_VERSION < '2.2'
51
- :total_allocated_object
52
- else
53
- :total_allocated_objects
54
- end
55
-
56
- before = GC.stat[key]
57
- yield
58
- after = GC.stat[key]
59
- after - before
60
- else
61
- -1
62
- end
63
- end
64
- end
65
-
66
- extend Benchmark::ActiveModelSerializers
67
- end
@@ -1,81 +0,0 @@
1
- require_relative './benchmarking_support'
2
- require_relative './app'
3
-
4
- time = 10
5
- disable_gc = true
6
-
7
- # This is to disable any key transform effects that may impact performance
8
- ActiveModelSerializers.config.key_transform = :unaltered
9
-
10
- ###########################################
11
- # Setup active record models
12
- ##########################################
13
- require 'active_record'
14
- require 'sqlite3'
15
-
16
- # For debugging SQL output
17
- # ActiveRecord::Base.logger = Logger.new(STDERR)
18
-
19
- # Change the following to reflect your database settings
20
- ActiveRecord::Base.establish_connection(
21
- adapter: 'sqlite3',
22
- database: ':memory:'
23
- )
24
-
25
- # Don't show migration output when constructing fake db
26
- ActiveRecord::Migration.verbose = false
27
-
28
- ActiveRecord::Schema.define do
29
- create_table :authors, force: true do |t|
30
- t.string :name
31
- end
32
-
33
- create_table :posts, force: true do |t|
34
- t.text :body
35
- t.string :title
36
- t.references :author
37
- end
38
-
39
- create_table :profiles, force: true do |t|
40
- t.text :project_url
41
- t.text :bio
42
- t.date :birthday
43
- t.references :author
44
- end
45
- end
46
-
47
- class Author < ActiveRecord::Base
48
- has_one :profile
49
- has_many :posts
50
- end
51
-
52
- class Post < ActiveRecord::Base
53
- belongs_to :author
54
- end
55
-
56
- class Profile < ActiveRecord::Base
57
- belongs_to :author
58
- end
59
-
60
- # Build out the data to serialize
61
- author = Author.create(name: 'Preston Sego')
62
- Profile.create(project_url: 'https://github.com/NullVoxPopuli', author: author)
63
- 50.times do
64
- Post.create(
65
- body: 'something about how password restrictions are evil, and less secure, and with the math to prove it.',
66
- title: 'Your bank is does not know how to do security',
67
- author: author
68
- )
69
- end
70
-
71
- Benchmark.ams('AR: attributes', time: time, disable_gc: disable_gc) do
72
- ActiveModelSerializers::SerializableResource.new(author, adapter: :attributes, include: 'profile,posts').serializable_hash
73
- end
74
-
75
- Benchmark.ams('AR: json', time: time, disable_gc: disable_gc) do
76
- ActiveModelSerializers::SerializableResource.new(author, adapter: :json, include: 'profile,posts').serializable_hash
77
- end
78
-
79
- Benchmark.ams('AR: JSON API', time: time, disable_gc: disable_gc) do
80
- ActiveModelSerializers::SerializableResource.new(author, adapter: :json_api, include: 'profile,posts').serializable_hash
81
- end
@@ -1,38 +0,0 @@
1
- require_relative './benchmarking_support'
2
- require_relative './app'
3
-
4
- time = 10
5
- disable_gc = true
6
- ActiveModelSerializers.config.key_transform = :unaltered
7
- has_many_relationships = (0..60).map do |i|
8
- HasManyRelationship.new(id: i, body: 'ZOMG A HAS MANY RELATIONSHIP')
9
- end
10
- has_one_relationship = HasOneRelationship.new(
11
- id: 42,
12
- first_name: 'Joao',
13
- last_name: 'Moura'
14
- )
15
- primary_resource = PrimaryResource.new(
16
- id: 1337,
17
- title: 'New PrimaryResource',
18
- virtual_attribute: nil,
19
- body: 'Body',
20
- has_many_relationships: has_many_relationships,
21
- has_one_relationship: has_one_relationship
22
- )
23
- serializer = PrimaryResourceSerializer.new(primary_resource)
24
-
25
- Benchmark.ams('attributes', time: time, disable_gc: disable_gc) do
26
- attributes = ActiveModelSerializers::Adapter::Attributes.new(serializer)
27
- attributes.as_json
28
- end
29
-
30
- Benchmark.ams('json_api', time: time, disable_gc: disable_gc) do
31
- json_api = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
32
- json_api.as_json
33
- end
34
-
35
- Benchmark.ams('json', time: time, disable_gc: disable_gc) do
36
- json = ActiveModelSerializers::Adapter::Json.new(serializer)
37
- json.as_json
38
- end
@@ -1,119 +0,0 @@
1
- require_relative './benchmarking_support'
2
- require_relative './app'
3
-
4
- # https://github.com/ruby-bench/ruby-bench-suite/blob/8ad567f7e43a044ae48c36833218423bb1e2bd9d/rails/benchmarks/actionpack_router.rb
5
- class ApiAssertion
6
- include Benchmark::ActiveModelSerializers::TestMethods
7
- class BadRevisionError < StandardError; end
8
-
9
- def valid?
10
- caching = get_caching
11
- caching[:body].delete('meta')
12
- non_caching = get_non_caching
13
- non_caching[:body].delete('meta')
14
- assert_responses(caching, non_caching)
15
- rescue BadRevisionError => e
16
- msg = { error: e.message }
17
- STDERR.puts msg
18
- STDOUT.puts msg
19
- exit 1
20
- end
21
-
22
- def get_status(on_off = 'on'.freeze)
23
- get("/status/#{on_off}")
24
- end
25
-
26
- def clear
27
- get('/clear')
28
- end
29
-
30
- def get_caching(on_off = 'on'.freeze)
31
- get("/caching/#{on_off}")
32
- end
33
-
34
- def get_fragment_caching(on_off = 'on'.freeze)
35
- get("/fragment_caching/#{on_off}")
36
- end
37
-
38
- def get_non_caching(on_off = 'on'.freeze)
39
- get("/non_caching/#{on_off}")
40
- end
41
-
42
- def debug(msg = '')
43
- if block_given? && ENV['DEBUG'] =~ /\Atrue|on|0\z/i
44
- STDERR.puts yield
45
- else
46
- STDERR.puts msg
47
- end
48
- end
49
-
50
- private
51
-
52
- def assert_responses(caching, non_caching)
53
- assert_equal(caching[:code], 200, "Caching response failed: #{caching}")
54
- assert_equal(caching[:body], expected, "Caching response format failed: \n+ #{caching[:body]}\n- #{expected}")
55
- assert_equal(caching[:content_type], 'application/json; charset=utf-8', "Caching response content type failed: \n+ #{caching[:content_type]}\n- application/json")
56
- assert_equal(non_caching[:code], 200, "Non caching response failed: #{non_caching}")
57
- assert_equal(non_caching[:body], expected, "Non Caching response format failed: \n+ #{non_caching[:body]}\n- #{expected}")
58
- assert_equal(non_caching[:content_type], 'application/json; charset=utf-8', "Non caching response content type failed: \n+ #{non_caching[:content_type]}\n- application/json")
59
- end
60
-
61
- def get(url)
62
- response = request(:get, url)
63
- { code: response.status, body: JSON.load(response.body), content_type: response.content_type }
64
- end
65
-
66
- def expected
67
- @expected ||=
68
- {
69
- 'primary_resource' => {
70
- 'id' => 1337,
71
- 'title' => 'New PrimaryResource',
72
- 'body' => 'Body',
73
- 'virtual_attribute' => {
74
- 'id' => 999,
75
- 'name' => 'Free-Range Virtual Attribute'
76
- },
77
- 'has_one_relationship' => {
78
- 'id' => 42,
79
- 'first_name' => 'Joao',
80
- 'last_name' => 'Moura'
81
- },
82
- 'has_many_relationships' => [
83
- {
84
- 'id' => 1,
85
- 'body' => 'ZOMG A HAS MANY RELATIONSHIP'
86
- }
87
- ]
88
- }
89
- }
90
- end
91
-
92
- def assert_equal(expected, actual, message)
93
- return true if expected == actual
94
- if ENV['FAIL_ASSERTION'] =~ /\Atrue|on|0\z/i # rubocop:disable Style/GuardClause
95
- fail BadRevisionError, message
96
- else
97
- STDERR.puts message unless ENV['SUMMARIZE']
98
- end
99
- end
100
- end
101
- assertion = ApiAssertion.new
102
- assertion.valid?
103
- assertion.debug { assertion.get_status }
104
-
105
- time = 10
106
- {
107
- 'caching on: caching serializers: gc off' => { disable_gc: true, send: [:get_caching, 'on'] },
108
- 'caching on: fragment caching serializers: gc off' => { disable_gc: true, send: [:get_fragment_caching, 'on'] },
109
- 'caching on: non-caching serializers: gc off' => { disable_gc: true, send: [:get_non_caching, 'on'] },
110
- 'caching off: caching serializers: gc off' => { disable_gc: true, send: [:get_caching, 'off'] },
111
- 'caching off: fragment caching serializers: gc off' => { disable_gc: true, send: [:get_fragment_caching, 'off'] },
112
- 'caching off: non-caching serializers: gc off' => { disable_gc: true, send: [:get_non_caching, 'off'] }
113
- }.each do |label, options|
114
- assertion.clear
115
- Benchmark.ams(label, time: time, disable_gc: options[:disable_gc]) do
116
- assertion.send(*options[:send])
117
- end
118
- assertion.debug { assertion.get_status(options[:send][-1]) }
119
- end