File: inline_test.rb

package info (click to toggle)
ruby-representable 3.0.4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 896 kB
  • sloc: ruby: 6,432; makefile: 3
file content (272 lines) | stat: -rw-r--r-- 8,688 bytes parent folder | download
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
require 'test_helper'

class InlineTest < Minitest::Spec
  let(:song)    { Song.new("Alive") }
  let(:request) { representer.prepare(OpenStruct.new(:song => song)) }

  {
    :hash => [Representable::Hash, {"song"=>{"name"=>"Alive"}}, {"song"=>{"name"=>"You've Taken Everything"}}],
    :json => [Representable::JSON, "{\"song\":{\"name\":\"Alive\"}}", "{\"song\":{\"name\":\"You've Taken Everything\"}}"],
    :xml  => [Representable::XML, "<open_struct>\n  <song>\n    <name>Alive</name>\n  </song>\n</open_struct>", "<open_struct><song><name>You've Taken Everything</name></song>/open_struct>"],
    :yaml => [Representable::YAML, "---\nsong:\n  name: Alive\n", "---\nsong:\n  name: You've Taken Everything\n"],
  }.each do |format, cfg|
    mod, output, input = cfg

    describe "[#{format}] with :class" do
      representer!(:module => mod) do
        property :song, :class => Song do
          property :name
        end
      end

      let(:format) { format }

      it { render(request).must_equal_document output }
      it { parse(request, input).song.name.must_equal "You've Taken Everything"}
    end
  end

  {
    :hash => [Representable::Hash, {"songs"=>[{"name"=>"Alive"}]}, {"songs"=>[{"name"=>"You've Taken Everything"}]}],
    :json => [Representable::JSON, "{\"songs\":[{\"name\":\"Alive\"}]}", "{\"songs\":[{\"name\":\"You've Taken Everything\"}]}"],
    :xml  => [Representable::XML, "<open_struct>\n  <song>\n    <name>Alive</name>\n  </song>\n</open_struct>", "<open_struct><song><name>You've Taken Everything</name></song></open_struct>", { :as => :song }],
    :yaml => [Representable::YAML, "---\nsongs:\n- name: Alive\n", "---\nsongs:\n- name: You've Taken Everything\n"],
  }.each do |format, cfg|
    mod, output, input, collection_options = cfg
    collection_options ||= {}

    describe "[#{format}] collection with :class" do
      let(:request) { representer.prepare(OpenStruct.new(:songs => [song])) }

      representer!(:module => mod) do
        collection :songs, collection_options.merge(:class => Song) do
          property :name
        end
      end

      let(:format) { format } # FIXME: why do we have to define this?

      it { render(request).must_equal_document output }
      it { parse(request, input).songs.first.name.must_equal "You've Taken Everything"}
    end
  end

  describe "without :class" do
    representer! do
      property :song do
        property :name
      end
    end

    it { request.to_hash.must_equal({"song"=>{"name"=>"Alive"}}) }
  end


  for_formats(
    :hash => [Representable::Hash, {}],
    # :xml  => [Representable::XML, "<open_struct>\n  <song>\n    <name>Alive</name>\n  </song>\n</open_struct>", "<open_struct><song><name>You've Taken Everything</name></song>/open_struct>"],
    # :yaml => [Representable::YAML, "---\nsong:\n  name: Alive\n", "---\nsong:\n  name: You've Taken Everything\n"],
  ) do |format, mod, input|

    describe "parsing [#{format}] where nested property missing" do
      representer!(:module => mod) do
        property :song do
          property :name
        end
      end

      it "doesn't change represented object" do
        request.send("from_#{format}", input).song.must_equal song
      end
    end
  end


  describe "inheriting from outer representer" do
    let(:request) { Struct.new(:song, :requester).new(song, "Josephine") }

    [false, true].each do |is_decorator| # test for module and decorator.
      representer!(:decorator => is_decorator) do
        property :requester

        property :song, :class => Song do
          property :name
        end
      end

      let(:decorator) { representer.prepare(request) }

      it { decorator.to_hash.must_equal({"requester"=>"Josephine", "song"=>{"name"=>"Alive"}}) }
      it { decorator.from_hash({"song"=>{"name"=>"You've Taken Everything"}}).song.name.must_equal "You've Taken Everything"}
    end
  end

  describe "object pollution" do
    representer!(:decorator => true) do
      property :song do
        property :name
      end
    end

    it "uses an inline decorator and doesn't alter represented" do
      representer.prepare(Struct.new(:song).new(song)).to_hash
      song.wont_be_kind_of Representable
    end
  end

  # TODO: should be in extend:/decorator: test.
  # FIXME: this tests :getter{represented}+:extend - represented gets extended twice and the inline decorator overrides original config.
  # for_formats(
  #   :hash => [Representable::Hash, {"album" => {"artist" => {"label"=>"Epitaph"}}}],
  #   # :xml  => [Representable::XML, "<open_struct></open_struct>"],
  #   #:yaml => [Representable::YAML, "---\nlabel:\n  label: Epitaph\n  owner: Brett Gurewitz\n"]
  # ) do |format, mod, output, input|

  #   module ArtistRepresenter
  #     include Representable::JSON
  #     property :label
  #   end

  #   describe ":getter with inline representer" do
  #     let(:format) { format }

  #     representer!(:module => mod) do
  #       self.representation_wrap = :album

  #       property :artist, :getter => lambda { |args| represented }, :extend => ArtistRepresenter
  #     end

  #     let(:album) { OpenStruct.new(:label => "Epitaph").extend(representer) }

  #     it "renders nested Album-properties in separate section" do
  #       render(album).must_equal_document output
  #     end
  #   end
  # end


  for_formats({
      :hash => [Representable::Hash, {"album" => {"artist" => {"label"=>"Epitaph"}}}],
      # :xml  => [Representable::XML, "<open_struct></open_struct>"],
      #:yaml => [Representable::YAML, "---\nlabel:\n  label: Epitaph\n  owner: Brett Gurewitz\n"]
    }) do |format, mod, output, input|

    class ArtistDecorator < Representable::Decorator
      include Representable::JSON
      property :label
    end

    describe ":getter with :decorator" do
      let(:format) { format }

      representer!(:module => mod) do
        self.representation_wrap = "album"

        property :artist, :getter => lambda { |args| represented }, :decorator => ArtistDecorator
      end

      let(:album) { OpenStruct.new(:label => "Epitaph").extend(representer) }

      it "renders nested Album-properties in separate section" do
        render(album).must_equal_document output
      end
    end
  end


  # test helper methods within inline representer
  for_formats({
    :hash => [Representable::Hash, {"song"=>{"name"=>"ALIVE"}}],
    :xml  => [Representable::XML, "<request>\n  <song>\n    <name>ALIVE</name>\n  </song>\n</request>"],
    :yaml => [Representable::YAML, "---\nsong:\n  name: ALIVE\n"],
  }) do |format, mod, output|

    describe "helper method within inline representer [#{format}]" do
      let(:format) { format }

      representer!(:module => mod, :decorator => true) do
        self.representation_wrap = :request if format == :xml

        property :requester
        property :song do
          property :name, :exec_context => :decorator

          define_method :name do
            represented.name.upcase
          end

          self.representation_wrap = :song if format == :xml
        end
      end

      let(:request) { representer.prepare(OpenStruct.new(:song => Song.new("Alive"))) }

      it do
        render(request).must_equal_document output
      end
    end
  end


  describe "include module in inline representers" do
    representer! do
      extension = Module.new do
        include Representable::Hash
        property :title
      end

      property :song do
        include extension
        property :artist
      end
    end

    it do OpenStruct.new(:song => OpenStruct.new(:title => "The Fever And The Sound", :artist => "Strung Out")).extend(representer).
      to_hash.
      must_equal({"song"=>{"artist"=>"Strung Out", "title"=>"The Fever And The Sound"}})
    end
  end


  # define method in inline representer
  describe "define method in inline representer" do
    Mod = Module.new do
      include Representable::Hash

      def song
        "Object.new"
      end

      property :song do
        property :duration

        def duration
          "6:53"
        end
      end
    end

    it { Object.new.extend(Mod).to_hash.must_equal("song"=>{"duration"=>"6:53"}) }
  end

  # define method inline with Decorator
  describe "define method inline with Decorator" do
    dec = Class.new(Representable::Decorator) do
      include Representable::Hash

      def song
        "Object.new"
      end

      property :song, :exec_context => :decorator do
        property :duration, :exec_context => :decorator

        def duration
          "6:53"
        end
      end
    end

    it { dec.new(Object.new).to_hash.must_equal("song"=>{"duration"=>"6:53"}) }
  end
end