active_model_serializers 0.9.8 → 0.10.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (135) hide show
  1. checksums.yaml +5 -5
  2. data/.gitignore +21 -0
  3. data/.travis.yml +27 -0
  4. data/CHANGELOG.md +8 -200
  5. data/CONTRIBUTING.md +23 -12
  6. data/Gemfile +17 -0
  7. data/{MIT-LICENSE → LICENSE.txt} +3 -2
  8. data/README.md +151 -781
  9. data/Rakefile +12 -0
  10. data/active_model_serializers.gemspec +26 -0
  11. data/lib/action_controller/serialization.rb +30 -75
  12. data/lib/active_model/serializer.rb +192 -252
  13. data/lib/active_model/serializer/adapter.rb +87 -0
  14. data/lib/active_model/serializer/adapter/fragment_cache.rb +78 -0
  15. data/lib/active_model/serializer/adapter/json.rb +52 -0
  16. data/lib/active_model/serializer/adapter/json/fragment_cache.rb +15 -0
  17. data/lib/active_model/serializer/adapter/json_api.rb +152 -0
  18. data/lib/active_model/serializer/adapter/json_api/fragment_cache.rb +22 -0
  19. data/lib/active_model/serializer/adapter/null.rb +11 -0
  20. data/lib/active_model/serializer/array_serializer.rb +32 -0
  21. data/lib/active_model/serializer/configuration.rb +13 -0
  22. data/lib/active_model/serializer/fieldset.rb +40 -0
  23. data/lib/active_model/serializer/version.rb +1 -1
  24. data/lib/active_model_serializers.rb +5 -7
  25. data/lib/generators/serializer/USAGE +6 -0
  26. data/lib/{active_model/serializer/generators → generators}/serializer/serializer_generator.rb +8 -8
  27. data/lib/{active_model/serializer/generators → generators}/serializer/templates/serializer.rb +2 -2
  28. data/test/action_controller/adapter_selector_test.rb +51 -0
  29. data/test/action_controller/explicit_serializer_test.rb +110 -0
  30. data/test/action_controller/json_api_linked_test.rb +173 -0
  31. data/test/action_controller/serialization_scope_name_test.rb +63 -0
  32. data/test/action_controller/serialization_test.rb +365 -0
  33. data/test/adapter/fragment_cache_test.rb +27 -0
  34. data/test/adapter/json/belongs_to_test.rb +41 -0
  35. data/test/adapter/json/collection_test.rb +59 -0
  36. data/test/adapter/json/has_many_test.rb +36 -0
  37. data/test/adapter/json_api/belongs_to_test.rb +147 -0
  38. data/test/adapter/json_api/collection_test.rb +89 -0
  39. data/test/adapter/json_api/has_many_embed_ids_test.rb +45 -0
  40. data/test/adapter/json_api/has_many_explicit_serializer_test.rb +98 -0
  41. data/test/adapter/json_api/has_many_test.rb +106 -0
  42. data/test/adapter/json_api/has_one_test.rb +59 -0
  43. data/test/adapter/json_api/linked_test.rb +257 -0
  44. data/test/adapter/json_test.rb +34 -0
  45. data/test/adapter/null_test.rb +25 -0
  46. data/test/adapter_test.rb +43 -0
  47. data/test/array_serializer_test.rb +29 -0
  48. data/test/fixtures/poro.rb +125 -142
  49. data/test/serializers/adapter_for_test.rb +50 -0
  50. data/test/serializers/associations_test.rb +106 -0
  51. data/test/serializers/attribute_test.rb +23 -0
  52. data/test/serializers/attributes_test.rb +28 -0
  53. data/test/serializers/cache_test.rb +128 -0
  54. data/test/serializers/configuration_test.rb +15 -0
  55. data/test/serializers/fieldset_test.rb +26 -0
  56. data/test/serializers/generators_test.rb +59 -0
  57. data/test/serializers/meta_test.rb +78 -0
  58. data/test/serializers/options_test.rb +21 -0
  59. data/test/serializers/serializer_for_test.rb +56 -0
  60. data/test/serializers/urls_test.rb +26 -0
  61. data/test/test_helper.rb +21 -4
  62. metadata +121 -159
  63. data/DESIGN.textile +0 -586
  64. data/lib/action_controller/serialization_test_case.rb +0 -79
  65. data/lib/active_model/array_serializer.rb +0 -68
  66. data/lib/active_model/default_serializer.rb +0 -28
  67. data/lib/active_model/serializable.rb +0 -59
  68. data/lib/active_model/serializable/utils.rb +0 -16
  69. data/lib/active_model/serializer/association.rb +0 -58
  70. data/lib/active_model/serializer/association/has_many.rb +0 -39
  71. data/lib/active_model/serializer/association/has_one.rb +0 -25
  72. data/lib/active_model/serializer/config.rb +0 -31
  73. data/lib/active_model/serializer/generators/resource_override.rb +0 -13
  74. data/lib/active_model/serializer/generators/serializer/USAGE +0 -9
  75. data/lib/active_model/serializer/generators/serializer/scaffold_controller_generator.rb +0 -14
  76. data/lib/active_model/serializer/generators/serializer/templates/controller.rb +0 -93
  77. data/lib/active_model/serializer/railtie.rb +0 -22
  78. data/lib/active_model/serializer_support.rb +0 -5
  79. data/lib/active_model_serializers/model/caching.rb +0 -25
  80. data/test/benchmark/app.rb +0 -60
  81. data/test/benchmark/benchmarking_support.rb +0 -67
  82. data/test/benchmark/bm_active_record.rb +0 -41
  83. data/test/benchmark/setup.rb +0 -75
  84. data/test/benchmark/tmp/miniprofiler/mp_timers_6eqewtfgrhitvq5gqm25 +0 -0
  85. data/test/benchmark/tmp/miniprofiler/mp_timers_8083sx03hu72pxz1a4d0 +0 -0
  86. data/test/benchmark/tmp/miniprofiler/mp_timers_fyz2gsml4z0ph9kpoy1c +0 -0
  87. data/test/benchmark/tmp/miniprofiler/mp_timers_hjry5rc32imd42oxoi48 +0 -0
  88. data/test/benchmark/tmp/miniprofiler/mp_timers_m8fpoz2cvt3g9agz0bs3 +0 -0
  89. data/test/benchmark/tmp/miniprofiler/mp_timers_p92m2drnj1i568u3sta0 +0 -0
  90. data/test/benchmark/tmp/miniprofiler/mp_timers_qg52tpca3uesdfguee9i +0 -0
  91. data/test/benchmark/tmp/miniprofiler/mp_timers_s15t1a6mvxe0z7vjv790 +0 -0
  92. data/test/benchmark/tmp/miniprofiler/mp_timers_x8kal3d17nfds6vp4kcj +0 -0
  93. data/test/benchmark/tmp/miniprofiler/mp_views_127.0.0.1 +0 -0
  94. data/test/fixtures/active_record.rb +0 -96
  95. data/test/fixtures/template.html.erb +0 -1
  96. data/test/integration/action_controller/namespaced_serialization_test.rb +0 -105
  97. data/test/integration/action_controller/serialization_test.rb +0 -287
  98. data/test/integration/action_controller/serialization_test_case_test.rb +0 -71
  99. data/test/integration/active_record/active_record_test.rb +0 -94
  100. data/test/integration/generators/resource_generator_test.rb +0 -26
  101. data/test/integration/generators/scaffold_controller_generator_test.rb +0 -64
  102. data/test/integration/generators/serializer_generator_test.rb +0 -41
  103. data/test/test_app.rb +0 -14
  104. data/test/tmp/app/assets/javascripts/accounts.js +0 -2
  105. data/test/tmp/app/assets/stylesheets/accounts.css +0 -4
  106. data/test/tmp/app/controllers/accounts_controller.rb +0 -2
  107. data/test/tmp/app/helpers/accounts_helper.rb +0 -2
  108. data/test/tmp/app/serializers/account_serializer.rb +0 -3
  109. data/test/tmp/config/routes.rb +0 -1
  110. data/test/unit/active_model/array_serializer/except_test.rb +0 -18
  111. data/test/unit/active_model/array_serializer/key_format_test.rb +0 -18
  112. data/test/unit/active_model/array_serializer/meta_test.rb +0 -53
  113. data/test/unit/active_model/array_serializer/only_test.rb +0 -18
  114. data/test/unit/active_model/array_serializer/options_test.rb +0 -16
  115. data/test/unit/active_model/array_serializer/root_test.rb +0 -102
  116. data/test/unit/active_model/array_serializer/scope_test.rb +0 -24
  117. data/test/unit/active_model/array_serializer/serialization_test.rb +0 -216
  118. data/test/unit/active_model/default_serializer_test.rb +0 -13
  119. data/test/unit/active_model/serializer/associations/build_serializer_test.rb +0 -36
  120. data/test/unit/active_model/serializer/associations_test.rb +0 -49
  121. data/test/unit/active_model/serializer/attributes_test.rb +0 -57
  122. data/test/unit/active_model/serializer/config_test.rb +0 -91
  123. data/test/unit/active_model/serializer/filter_test.rb +0 -69
  124. data/test/unit/active_model/serializer/has_many_polymorphic_test.rb +0 -189
  125. data/test/unit/active_model/serializer/has_many_test.rb +0 -265
  126. data/test/unit/active_model/serializer/has_one_and_has_many_test.rb +0 -27
  127. data/test/unit/active_model/serializer/has_one_polymorphic_test.rb +0 -196
  128. data/test/unit/active_model/serializer/has_one_test.rb +0 -253
  129. data/test/unit/active_model/serializer/key_format_test.rb +0 -25
  130. data/test/unit/active_model/serializer/meta_test.rb +0 -39
  131. data/test/unit/active_model/serializer/options_test.rb +0 -42
  132. data/test/unit/active_model/serializer/root_test.rb +0 -117
  133. data/test/unit/active_model/serializer/scope_test.rb +0 -49
  134. data/test/unit/active_model/serializer/url_helpers_test.rb +0 -35
  135. data/test/unit/active_model/serilizable_test.rb +0 -50
@@ -1,79 +0,0 @@
1
- module ActionController
2
- module SerializationAssertions
3
- extend ActiveSupport::Concern
4
-
5
- included do
6
- setup :setup_serialization_subscriptions
7
- teardown :teardown_serialization_subscriptions
8
- end
9
-
10
- def setup_serialization_subscriptions
11
- @serializers = Hash.new(0)
12
-
13
- ActiveSupport::Notifications.subscribe("!serialize.active_model_serializers") do |name, start, finish, id, payload|
14
- serializer = payload[:serializer]
15
- @serializers[serializer] += 1
16
- end
17
- end
18
-
19
- def teardown_serialization_subscriptions
20
- ActiveSupport::Notifications.unsubscribe("!serialize.active_model_serializers")
21
- end
22
-
23
- def process(*args)
24
- @serializers = Hash.new(0)
25
- super
26
- end
27
-
28
- # Asserts that the request was rendered with the appropriate serializers.
29
- #
30
- # # assert that the "PostSerializer" serializer was rendered
31
- # assert_serializer "PostSerializer"
32
- #
33
- # # assert that the instance of PostSerializer was rendered
34
- # assert_serializer PostSerializer
35
- #
36
- # # assert that the "PostSerializer" serializer was rendered
37
- # assert_serializer :post_serializer
38
- #
39
- # # assert that the rendered serializer starts with "Post"
40
- # assert_serializer %r{\APost.+\Z}
41
- #
42
- # # assert that no serializer was rendered
43
- # assert_serializer nil
44
- #
45
- #
46
- def assert_serializer(options = {}, message = nil)
47
- # Force body to be read in case the template is being streamed.
48
- response.body
49
-
50
- rendered = @serializers
51
- msg = message || "expecting <#{options.inspect}> but rendering with <#{rendered.keys}>"
52
-
53
- matches_serializer = case options
54
- when lambda { |options| options.kind_of?(Class) && options < ActiveModel::Serializer }
55
- rendered.any? do |serializer, count|
56
- options.name == serializer
57
- end
58
- when Symbol
59
- options = options.to_s.camelize
60
- rendered.any? do |serializer, count|
61
- serializer == options
62
- end
63
- when String
64
- !options.empty? && rendered.any? do |serializer, count|
65
- serializer == options
66
- end
67
- when Regexp
68
- rendered.any? do |serializer, count|
69
- serializer.match(options)
70
- end
71
- when NilClass
72
- rendered.blank?
73
- else
74
- raise ArgumentError, "assert_serializer only accepts a String, Symbol, Regexp, ActiveModel::Serializer, or nil"
75
- end
76
- assert matches_serializer, msg
77
- end
78
- end
79
- end
@@ -1,68 +0,0 @@
1
- require 'active_model/default_serializer'
2
- require 'active_model/serializable'
3
-
4
- module ActiveModel
5
- class ArraySerializer
6
- include Serializable
7
-
8
- class << self
9
- attr_accessor :_root
10
- alias root _root=
11
- alias root= _root=
12
- end
13
-
14
- def initialize(object, options={})
15
- @object = object
16
- @scope = options[:scope]
17
- @root = options.fetch(:root, self.class._root)
18
- @polymorphic = options.fetch(:polymorphic, false)
19
- @meta_key = options[:meta_key] || :meta
20
- @meta = options[@meta_key]
21
- @each_serializer = options[:each_serializer]
22
- @resource_name = options[:resource_name]
23
- @only = options[:only] ? Array(options[:only]) : nil
24
- @except = options[:except] ? Array(options[:except]) : nil
25
- @context = options[:context]
26
- @namespace = options[:namespace]
27
- @key_format = options[:key_format] || options[:each_serializer].try(:key_format)
28
- end
29
- attr_accessor :object, :scope, :root, :meta_key, :meta, :key_format, :context
30
-
31
- def json_key
32
- key = root.nil? ? @resource_name : root
33
-
34
- key_format == :lower_camel && key.present? ? key.camelize(:lower) : key
35
- end
36
-
37
- def serializer_for(item)
38
- serializer_class = @each_serializer || Serializer.serializer_for(item, namespace: @namespace) || DefaultSerializer
39
- serializer_class.new(item, scope: scope, key_format: key_format, context: @context, only: @only, except: @except, polymorphic: @polymorphic, namespace: @namespace)
40
- end
41
-
42
- def serializable_object(options={})
43
- @object.map do |item|
44
- serializer_for(item).serializable_object_with_notification(options)
45
- end
46
- end
47
- alias_method :serializable_array, :serializable_object
48
-
49
- def embedded_in_root_associations
50
- @object.each_with_object({}) do |item, hash|
51
- serializer_for(item).embedded_in_root_associations.each_pair do |type, objects|
52
- next if !objects || objects.flatten.empty?
53
-
54
- if hash.has_key?(type)
55
- case hash[type] when Hash
56
- hash[type].deep_merge!(objects){ |key, old, new| (Array(old) + Array(new)).uniq }
57
- else
58
- hash[type].concat(objects).uniq!
59
- end
60
- else
61
- hash[type] = objects
62
- end
63
- end
64
- end
65
- end
66
-
67
- end
68
- end
@@ -1,28 +0,0 @@
1
- require 'active_model/serializable'
2
-
3
- module ActiveModel
4
- # DefaultSerializer
5
- #
6
- # Provides a constant interface for all items
7
- class DefaultSerializer
8
- include ActiveModel::Serializable
9
-
10
- attr_reader :object
11
-
12
- def initialize(object, options={})
13
- @object = object
14
- @wrap_in_array = options[:_wrap_in_array]
15
- end
16
-
17
- def as_json(options={})
18
- instrument do
19
- return [] if @object.nil? && @wrap_in_array
20
- hash = @object.as_json
21
- @wrap_in_array ? [hash] : hash
22
- end
23
- end
24
-
25
- alias serializable_hash as_json
26
- alias serializable_object as_json
27
- end
28
- end
@@ -1,59 +0,0 @@
1
- require 'active_model/serializable/utils'
2
-
3
- module ActiveModel
4
- module Serializable
5
- INSTRUMENTATION_KEY = '!serialize.active_model_serializers'.freeze
6
-
7
- def self.included(base)
8
- base.extend Utils
9
- end
10
-
11
- def as_json(options={})
12
- instrument do
13
- if root = options.fetch(:root, json_key)
14
- hash = { root => serializable_object(options) }
15
- hash.merge!(serializable_data)
16
- hash
17
- else
18
- serializable_object(options)
19
- end
20
- end
21
- end
22
-
23
- def serializable_object_with_notification(options={})
24
- instrument { serializable_object(options) }
25
- end
26
-
27
- def serializable_data
28
- embedded_in_root_associations.tap do |hash|
29
- if respond_to?(:meta) && meta
30
- hash[meta_key] = meta
31
- end
32
- end
33
- end
34
-
35
- def namespace
36
- if module_name = get_namespace
37
- Serializer.serializers_cache.fetch_or_store(module_name) do
38
- Utils._const_get(module_name)
39
- end
40
- end
41
- end
42
-
43
- def embedded_in_root_associations
44
- {}
45
- end
46
-
47
- private
48
-
49
- def get_namespace
50
- modules = self.class.name.split('::')
51
- modules[0..-2].join('::') if modules.size > 1
52
- end
53
-
54
- def instrument(&block)
55
- payload = { serializer: self.class.name }
56
- ActiveSupport::Notifications.instrument(INSTRUMENTATION_KEY, payload, &block)
57
- end
58
- end
59
- end
@@ -1,16 +0,0 @@
1
- module ActiveModel
2
- module Serializable
3
- module Utils
4
- extend self
5
-
6
- def _const_get(const)
7
- begin
8
- method = RUBY_VERSION >= '2.0' ? :const_get : :qualified_const_get
9
- Object.send method, const
10
- rescue NameError
11
- const.safe_constantize
12
- end
13
- end
14
- end
15
- end
16
- end
@@ -1,58 +0,0 @@
1
- require 'active_model/default_serializer'
2
- require 'active_model/serializer/association/has_one'
3
- require 'active_model/serializer/association/has_many'
4
-
5
- module ActiveModel
6
- class Serializer
7
- class Association
8
- def initialize(name, options={})
9
- if options.has_key?(:include)
10
- ActiveSupport::Deprecation.warn <<-WARN
11
- ** Notice: include was renamed to embed_in_root. **
12
- WARN
13
- end
14
-
15
- @name = name.to_s
16
- @options = options
17
- self.embed = options.fetch(:embed) { CONFIG.embed }
18
- @polymorphic = options.fetch(:polymorphic, false)
19
- @embed_in_root = options.fetch(:embed_in_root) { options.fetch(:include) { CONFIG.embed_in_root } }
20
- @key_format = options.fetch(:key_format) { CONFIG.key_format }
21
- @embed_key = options[:embed_key] || :id
22
- @key = options[:key]
23
- @embedded_key = options[:root] || name
24
- @embed_in_root_key = options.fetch(:embed_in_root_key) { CONFIG.embed_in_root_key }
25
- @embed_namespace = options.fetch(:embed_namespace) { CONFIG.embed_namespace }
26
-
27
- serializer = @options[:serializer]
28
- @serializer_from_options = serializer.is_a?(String) ? serializer.constantize : serializer
29
- end
30
-
31
- attr_reader :name, :embed_ids, :embed_objects, :polymorphic
32
- attr_accessor :embed_in_root, :embed_key, :key, :embedded_key, :root_key, :serializer_from_options, :options, :key_format, :embed_in_root_key, :embed_namespace
33
- alias embed_ids? embed_ids
34
- alias embed_objects? embed_objects
35
- alias embed_in_root? embed_in_root
36
- alias embed_in_root_key? embed_in_root_key
37
- alias embed_namespace? embed_namespace
38
- alias polymorphic? polymorphic
39
-
40
- def embed=(embed)
41
- @embed_ids = embed == :id || embed == :ids
42
- @embed_objects = embed == :object || embed == :objects
43
- end
44
-
45
- def serializer_from_object(object, options = {})
46
- Serializer.serializer_for(object, options)
47
- end
48
-
49
- def default_serializer
50
- DefaultSerializer
51
- end
52
-
53
- def build_serializer(object, options = {})
54
- serializer_class(object, options).new(object, options.merge(self.options))
55
- end
56
- end
57
- end
58
- end
@@ -1,39 +0,0 @@
1
- module ActiveModel
2
- class Serializer
3
- class Association
4
- class HasMany < Association
5
- def initialize(name, *args)
6
- super
7
- @root_key = @embedded_key.to_s
8
- @key ||= case CONFIG.default_key_type
9
- when :name then name.to_s.pluralize
10
- else "#{name.to_s.singularize}_ids"
11
- end
12
- end
13
-
14
- def serializer_class(object, _)
15
- if use_array_serializer?
16
- ArraySerializer
17
- else
18
- serializer_from_options
19
- end
20
- end
21
-
22
- def options
23
- if use_array_serializer?
24
- { each_serializer: serializer_from_options }.merge! super
25
- else
26
- super
27
- end
28
- end
29
-
30
- private
31
-
32
- def use_array_serializer?
33
- !serializer_from_options ||
34
- serializer_from_options && !(serializer_from_options <= ArraySerializer)
35
- end
36
- end
37
- end
38
- end
39
- end
@@ -1,25 +0,0 @@
1
- module ActiveModel
2
- class Serializer
3
- class Association
4
- class HasOne < Association
5
- def initialize(name, *args)
6
- super
7
- @root_key = @embedded_key.to_s.pluralize
8
- @key ||= case CONFIG.default_key_type
9
- when :name then name.to_s.singularize
10
- else "#{name}_id"
11
- end
12
- end
13
-
14
- def serializer_class(object, options = {})
15
- (serializer_from_options unless object.nil?) || serializer_from_object(object, options) || default_serializer
16
- end
17
-
18
- def build_serializer(object, options = {})
19
- options[:_wrap_in_array] = embed_in_root?
20
- super
21
- end
22
- end
23
- end
24
- end
25
- end
@@ -1,31 +0,0 @@
1
- module ActiveModel
2
- class Serializer
3
- class Config
4
- def initialize(data = {})
5
- @data = data
6
- end
7
-
8
- def each(&block)
9
- @data.each(&block)
10
- end
11
-
12
- def clear
13
- @data.clear
14
- end
15
-
16
- def method_missing(name, *args)
17
- name = name.to_s
18
- return @data[name] if @data.include?(name)
19
- match = name.match(/\A(.*?)([?=]?)\Z/)
20
- case match[2]
21
- when "="
22
- @data[match[1]] = args.first
23
- when "?"
24
- !!@data[match[1]]
25
- end
26
- end
27
- end
28
-
29
- CONFIG = Config.new('embed' => :objects) # :nodoc:
30
- end
31
- end
@@ -1,13 +0,0 @@
1
- require 'rails/generators'
2
- require 'rails/generators/rails/resource/resource_generator'
3
-
4
- module Rails
5
- module Generators
6
- class ResourceGenerator
7
- def add_serializer
8
- invoke 'serializer'
9
- end
10
- end
11
- end
12
- end
13
-
@@ -1,9 +0,0 @@
1
- Description:
2
- Generates a serializer for the given resource with tests.
3
-
4
- Example:
5
- `rails generate serializer Account name created_at`
6
-
7
- For TestUnit it creates:
8
- Serializer: app/serializers/account_serializer.rb
9
- TestUnit: test/unit/account_serializer_test.rb
@@ -1,14 +0,0 @@
1
- require 'rails/generators'
2
- require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
3
-
4
- module Rails
5
- module Generators
6
- class ScaffoldControllerGenerator
7
- if Rails::VERSION::MAJOR >= 4
8
- source_root File.expand_path('../templates', __FILE__)
9
-
10
- hook_for :serializer, default: true, type: :boolean
11
- end
12
- end
13
- end
14
- end