rails-rfc6570 3.3.0 → 3.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (138) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +3 -1
  4. data/lib/rails/rfc6570/version.rb +1 -1
  5. data/lib/rails/rfc6570.rb +10 -29
  6. data/spec/dummy/config/application.rb +5 -1
  7. data/spec/dummy/config/environments/test.rb +1 -1
  8. data/spec/rails/rfc6570/extensions/route_set_spec.rb +29 -0
  9. data/spec/rails/rfc6570/helper_spec.rb +44 -0
  10. data/spec/rails/rfc6570/visitor_spec.rb +12 -0
  11. data/spec/spec_helper.rb +6 -0
  12. data/vendor/bundle/ruby/3.4.0/bundler/gems/rubocop-config-67802c9d1826/LICENSE +21 -0
  13. data/vendor/bundle/ruby/3.4.0/bundler/gems/rubocop-config-67802c9d1826/README.md +23 -0
  14. data/vendor/bundle/ruby/3.4.0/bundler/gems/rubocop-config-67802c9d1826/rubocop-config.gemspec +31 -0
  15. data/vendor/bundle/ruby/3.4.0/gems/actionpack-8.0.1/CHANGELOG.md +205 -0
  16. data/vendor/bundle/ruby/3.4.0/gems/actionpack-8.0.1/MIT-LICENSE +21 -0
  17. data/vendor/bundle/ruby/3.4.0/gems/actionpack-8.0.1/README.rdoc +57 -0
  18. data/vendor/bundle/ruby/3.4.0/gems/actionview-8.0.1/CHANGELOG.md +67 -0
  19. data/vendor/bundle/ruby/3.4.0/gems/actionview-8.0.1/MIT-LICENSE +21 -0
  20. data/vendor/bundle/ruby/3.4.0/gems/actionview-8.0.1/README.rdoc +40 -0
  21. data/vendor/bundle/ruby/3.4.0/gems/activesupport-8.0.1/CHANGELOG.md +157 -0
  22. data/vendor/bundle/ruby/3.4.0/gems/activesupport-8.0.1/MIT-LICENSE +20 -0
  23. data/vendor/bundle/ruby/3.4.0/gems/activesupport-8.0.1/README.rdoc +40 -0
  24. data/vendor/bundle/ruby/3.4.0/gems/addressable-2.8.7/CHANGELOG.md +301 -0
  25. data/vendor/bundle/ruby/3.4.0/gems/addressable-2.8.7/LICENSE.txt +202 -0
  26. data/vendor/bundle/ruby/3.4.0/gems/addressable-2.8.7/README.md +121 -0
  27. data/vendor/bundle/ruby/3.4.0/gems/addressable-2.8.7/addressable.gemspec +28 -0
  28. data/vendor/bundle/ruby/3.4.0/gems/base64-0.2.0/LICENSE.txt +22 -0
  29. data/vendor/bundle/ruby/3.4.0/gems/base64-0.2.0/README.md +48 -0
  30. data/vendor/bundle/ruby/3.4.0/gems/benchmark-0.4.0/README.md +138 -0
  31. data/vendor/bundle/ruby/3.4.0/gems/benchmark-0.4.0/benchmark.gemspec +32 -0
  32. data/vendor/bundle/ruby/3.4.0/gems/bigdecimal-3.1.9/LICENSE +56 -0
  33. data/vendor/bundle/ruby/3.4.0/gems/bigdecimal-3.1.9/bigdecimal.gemspec +57 -0
  34. data/vendor/bundle/ruby/3.4.0/gems/builder-3.3.0/MIT-LICENSE +20 -0
  35. data/vendor/bundle/ruby/3.4.0/gems/builder-3.3.0/README.md +258 -0
  36. data/vendor/bundle/ruby/3.4.0/gems/builder-3.3.0/builder.gemspec +49 -0
  37. data/vendor/bundle/ruby/3.4.0/gems/concurrent-ruby-1.3.5/CHANGELOG.md +603 -0
  38. data/vendor/bundle/ruby/3.4.0/gems/concurrent-ruby-1.3.5/LICENSE.txt +21 -0
  39. data/vendor/bundle/ruby/3.4.0/gems/concurrent-ruby-1.3.5/README.md +407 -0
  40. data/vendor/bundle/ruby/3.4.0/gems/connection_pool-2.5.0/LICENSE +20 -0
  41. data/vendor/bundle/ruby/3.4.0/gems/connection_pool-2.5.0/README.md +167 -0
  42. data/vendor/bundle/ruby/3.4.0/gems/connection_pool-2.5.0/connection_pool.gemspec +24 -0
  43. data/vendor/bundle/ruby/3.4.0/gems/crass-1.0.6/LICENSE +18 -0
  44. data/vendor/bundle/ruby/3.4.0/gems/crass-1.0.6/README.md +192 -0
  45. data/vendor/bundle/ruby/3.4.0/gems/crass-1.0.6/crass.gemspec +31 -0
  46. data/vendor/bundle/ruby/3.4.0/gems/diff-lcs-1.5.1/README.rdoc +84 -0
  47. data/vendor/bundle/ruby/3.4.0/gems/drb-2.2.1/LICENSE.txt +22 -0
  48. data/vendor/bundle/ruby/3.4.0/gems/drb-2.2.1/drb.gemspec +41 -0
  49. data/vendor/bundle/ruby/3.4.0/gems/erubi-1.13.1/CHANGELOG +111 -0
  50. data/vendor/bundle/ruby/3.4.0/gems/erubi-1.13.1/MIT-LICENSE +21 -0
  51. data/vendor/bundle/ruby/3.4.0/gems/erubi-1.13.1/README.rdoc +151 -0
  52. data/vendor/bundle/ruby/3.4.0/gems/i18n-1.14.7/MIT-LICENSE +20 -0
  53. data/vendor/bundle/ruby/3.4.0/gems/i18n-1.14.7/README.md +127 -0
  54. data/vendor/bundle/ruby/3.4.0/gems/logger-1.6.5/README.md +104 -0
  55. data/vendor/bundle/ruby/3.4.0/gems/logger-1.6.5/logger.gemspec +28 -0
  56. data/vendor/bundle/ruby/3.4.0/gems/loofah-2.24.0/CHANGELOG.md +591 -0
  57. data/vendor/bundle/ruby/3.4.0/gems/loofah-2.24.0/MIT-LICENSE.txt +23 -0
  58. data/vendor/bundle/ruby/3.4.0/gems/loofah-2.24.0/README.md +410 -0
  59. data/vendor/bundle/ruby/3.4.0/gems/minitest-5.25.4/README.rdoc +835 -0
  60. data/vendor/bundle/ruby/3.4.0/gems/nokogiri-1.18.2-x86_64-linux-gnu/LICENSE-DEPENDENCIES.md +2224 -0
  61. data/vendor/bundle/ruby/3.4.0/gems/nokogiri-1.18.2-x86_64-linux-gnu/LICENSE.md +9 -0
  62. data/vendor/bundle/ruby/3.4.0/gems/nokogiri-1.18.2-x86_64-linux-gnu/README.md +293 -0
  63. data/vendor/bundle/ruby/3.4.0/gems/public_suffix-6.0.1/CHANGELOG.md +491 -0
  64. data/vendor/bundle/ruby/3.4.0/gems/public_suffix-6.0.1/LICENSE.txt +22 -0
  65. data/vendor/bundle/ruby/3.4.0/gems/public_suffix-6.0.1/README.md +222 -0
  66. data/vendor/bundle/ruby/3.4.0/gems/racc-1.8.1/README.ja.rdoc +58 -0
  67. data/vendor/bundle/ruby/3.4.0/gems/racc-1.8.1/README.rdoc +60 -0
  68. data/vendor/bundle/ruby/3.4.0/gems/rack-3.1.9/CHANGELOG.md +1006 -0
  69. data/vendor/bundle/ruby/3.4.0/gems/rack-3.1.9/MIT-LICENSE +20 -0
  70. data/vendor/bundle/ruby/3.4.0/gems/rack-3.1.9/README.md +328 -0
  71. data/vendor/bundle/ruby/3.4.0/gems/rack-test-2.2.0/MIT-LICENSE.txt +20 -0
  72. data/vendor/bundle/ruby/3.4.0/gems/rack-test-2.2.0/README.md +139 -0
  73. data/vendor/bundle/ruby/3.4.0/gems/rails-dom-testing-2.2.0/MIT-LICENSE +23 -0
  74. data/vendor/bundle/ruby/3.4.0/gems/rails-dom-testing-2.2.0/README.md +91 -0
  75. data/vendor/bundle/ruby/3.4.0/gems/rails-html-sanitizer-1.6.2/CHANGELOG.md +255 -0
  76. data/vendor/bundle/ruby/3.4.0/gems/rails-html-sanitizer-1.6.2/MIT-LICENSE +23 -0
  77. data/vendor/bundle/ruby/3.4.0/gems/rails-html-sanitizer-1.6.2/README.md +267 -0
  78. data/vendor/bundle/ruby/3.4.0/gems/rake-13.2.1/MIT-LICENSE +21 -0
  79. data/vendor/bundle/ruby/3.4.0/gems/rake-13.2.1/README.rdoc +155 -0
  80. data/vendor/bundle/ruby/3.4.0/gems/rake-13.2.1/rake.gemspec +101 -0
  81. data/vendor/bundle/ruby/3.4.0/gems/rake-release-1.3.0/LICENSE +21 -0
  82. data/vendor/bundle/ruby/3.4.0/gems/rake-release-1.3.0/README.md +107 -0
  83. data/vendor/bundle/ruby/3.4.0/gems/rake-release-1.3.0/rake-release.gemspec +23 -0
  84. data/vendor/bundle/ruby/3.4.0/gems/rspec-3.13.0/LICENSE.md +27 -0
  85. data/vendor/bundle/ruby/3.4.0/gems/rspec-3.13.0/README.md +47 -0
  86. data/vendor/bundle/ruby/3.4.0/gems/rspec-core-3.13.2/LICENSE.md +26 -0
  87. data/vendor/bundle/ruby/3.4.0/gems/rspec-core-3.13.2/README.md +389 -0
  88. data/vendor/bundle/ruby/3.4.0/gems/rspec-expectations-3.13.3/LICENSE.md +25 -0
  89. data/vendor/bundle/ruby/3.4.0/gems/rspec-expectations-3.13.3/README.md +326 -0
  90. data/vendor/bundle/ruby/3.4.0/gems/rspec-mocks-3.13.2/LICENSE.md +25 -0
  91. data/vendor/bundle/ruby/3.4.0/gems/rspec-mocks-3.13.2/README.md +465 -0
  92. data/vendor/bundle/ruby/3.4.0/gems/rspec-support-3.13.2/LICENSE.md +23 -0
  93. data/vendor/bundle/ruby/3.4.0/gems/rspec-support-3.13.2/README.md +40 -0
  94. data/vendor/bundle/ruby/3.4.0/gems/securerandom-0.4.1/README.md +72 -0
  95. data/vendor/bundle/ruby/3.4.0/gems/tzinfo-2.0.6/LICENSE +19 -0
  96. data/vendor/bundle/ruby/3.4.0/gems/tzinfo-2.0.6/README.md +406 -0
  97. data/vendor/bundle/ruby/3.4.0/gems/uri-1.0.2/README.md +55 -0
  98. data/vendor/bundle/ruby/3.4.0/gems/useragent-0.16.11/LICENSE +20 -0
  99. data/vendor/bundle/ruby/3.4.0/gems/useragent-0.16.11/README.md +42 -0
  100. data/vendor/bundle/ruby/3.4.0/specifications/actionpack-8.0.1.gemspec +36 -0
  101. data/vendor/bundle/ruby/3.4.0/specifications/actionview-8.0.1.gemspec +33 -0
  102. data/vendor/bundle/ruby/3.4.0/specifications/activesupport-8.0.1.gemspec +38 -0
  103. data/vendor/bundle/ruby/3.4.0/specifications/addressable-2.8.7.gemspec +30 -0
  104. data/vendor/bundle/ruby/3.4.0/specifications/base64-0.2.0.gemspec +23 -0
  105. data/vendor/bundle/ruby/3.4.0/specifications/benchmark-0.4.0.gemspec +23 -0
  106. data/vendor/bundle/ruby/3.4.0/specifications/bigdecimal-3.1.9.gemspec +25 -0
  107. data/vendor/bundle/ruby/3.4.0/specifications/builder-3.3.0.gemspec +22 -0
  108. data/vendor/bundle/ruby/3.4.0/specifications/concurrent-ruby-1.3.5.gemspec +24 -0
  109. data/vendor/bundle/ruby/3.4.0/specifications/connection_pool-2.5.0.gemspec +28 -0
  110. data/vendor/bundle/ruby/3.4.0/specifications/crass-1.0.6.gemspec +27 -0
  111. data/vendor/bundle/ruby/3.4.0/specifications/diff-lcs-1.5.1.gemspec +37 -0
  112. data/vendor/bundle/ruby/3.4.0/specifications/drb-2.2.1.gemspec +22 -0
  113. data/vendor/bundle/ruby/3.4.0/specifications/erubi-1.13.1.gemspec +29 -0
  114. data/vendor/bundle/ruby/3.4.0/specifications/i18n-1.14.7.gemspec +26 -0
  115. data/vendor/bundle/ruby/3.4.0/specifications/logger-1.6.5.gemspec +22 -0
  116. data/vendor/bundle/ruby/3.4.0/specifications/loofah-2.24.0.gemspec +27 -0
  117. data/vendor/bundle/ruby/3.4.0/specifications/minitest-5.25.4.gemspec +31 -0
  118. data/vendor/bundle/ruby/3.4.0/specifications/nokogiri-1.18.2-x86_64-linux-gnu.gemspec +31 -0
  119. data/vendor/bundle/ruby/3.4.0/specifications/public_suffix-6.0.1.gemspec +24 -0
  120. data/vendor/bundle/ruby/3.4.0/specifications/racc-1.8.1.gemspec +28 -0
  121. data/vendor/bundle/ruby/3.4.0/specifications/rack-3.1.9.gemspec +31 -0
  122. data/vendor/bundle/ruby/3.4.0/specifications/rack-session-2.1.0.gemspec +30 -0
  123. data/vendor/bundle/ruby/3.4.0/specifications/rack-test-2.2.0.gemspec +29 -0
  124. data/vendor/bundle/ruby/3.4.0/specifications/rails-dom-testing-2.2.0.gemspec +28 -0
  125. data/vendor/bundle/ruby/3.4.0/specifications/rails-html-sanitizer-1.6.2.gemspec +27 -0
  126. data/vendor/bundle/ruby/3.4.0/specifications/rake-13.2.1.gemspec +26 -0
  127. data/vendor/bundle/ruby/3.4.0/specifications/rake-release-1.3.0.gemspec +26 -0
  128. data/vendor/bundle/ruby/3.4.0/specifications/rspec-3.13.0.gemspec +31 -0
  129. data/vendor/bundle/ruby/3.4.0/specifications/rspec-core-3.13.2.gemspec +39 -0
  130. data/vendor/bundle/ruby/3.4.0/specifications/rspec-expectations-3.13.3.gemspec +33 -0
  131. data/vendor/bundle/ruby/3.4.0/specifications/rspec-mocks-3.13.2.gemspec +33 -0
  132. data/vendor/bundle/ruby/3.4.0/specifications/rspec-support-3.13.2.gemspec +29 -0
  133. data/vendor/bundle/ruby/3.4.0/specifications/securerandom-0.4.1.gemspec +23 -0
  134. data/vendor/bundle/ruby/3.4.0/specifications/tzinfo-2.0.6.gemspec +30 -0
  135. data/vendor/bundle/ruby/3.4.0/specifications/uri-1.0.2.gemspec +23 -0
  136. data/vendor/bundle/ruby/3.4.0/specifications/useragent-0.16.11.gemspec +25 -0
  137. metadata +130 -8
  138. data/spec/dummy/log/test.log +0 -432
@@ -0,0 +1,465 @@
1
+ # RSpec Mocks [![Build Status](https://github.com/rspec/rspec-mocks/workflows/RSpec%20CI/badge.svg)](https://github.com/rspec/rspec-mocks/actions) [![Code Climate](https://codeclimate.com/github/rspec/rspec-mocks.svg)](https://codeclimate.com/github/rspec/rspec-mocks)
2
+ rspec-mocks is a test-double framework for rspec with support for method stubs,
3
+ fakes, and message expectations on generated test-doubles and real objects
4
+ alike.
5
+
6
+ ## Install
7
+
8
+ gem install rspec # for rspec-core, rspec-expectations, rspec-mocks
9
+ gem install rspec-mocks # for rspec-mocks only
10
+
11
+ Want to run against the `main` branch? You'll need to include the dependent
12
+ RSpec repos as well. Add the following to your `Gemfile`:
13
+
14
+ ```ruby
15
+ %w[rspec-core rspec-expectations rspec-mocks rspec-support].each do |lib|
16
+ gem lib, :git => "https://github.com/rspec/#{lib}.git", :branch => 'main'
17
+ end
18
+ ```
19
+ ## Contributing
20
+
21
+ Once you've set up the environment, you'll need to cd into the working
22
+ directory of whichever repo you want to work in. From there you can run the
23
+ specs and cucumber features, and make patches.
24
+
25
+ NOTE: You do not need to use rspec-dev to work on a specific RSpec repo. You
26
+ can treat each RSpec repo as an independent project.
27
+
28
+ For information about contributing to RSpec, please refer to the following markdown files:
29
+ * [Build details](BUILD_DETAIL.md)
30
+ * [Code of Conduct](CODE_OF_CONDUCT.md)
31
+ * [Detailed contributing guide](CONTRIBUTING.md)
32
+ * [Development setup guide](DEVELOPMENT.md)
33
+
34
+ ## Test Doubles
35
+
36
+ A test double is an object that stands in for another object in your system
37
+ during a code example. Use the `double` method, passing in an optional identifier, to create one:
38
+
39
+ ```ruby
40
+ book = double("book")
41
+ ```
42
+
43
+ Most of the time you will want some confidence that your doubles resemble an
44
+ existing object in your system. Verifying doubles are provided for this
45
+ purpose. If the existing object is available, they will prevent you from adding
46
+ stubs and expectations for methods that do not exist or that have an invalid
47
+ number of parameters.
48
+
49
+ ```ruby
50
+ book = instance_double("Book", :pages => 250)
51
+ ```
52
+
53
+ Verifying doubles have some clever tricks to enable you to both test in
54
+ isolation without your dependencies loaded while still being able to validate
55
+ them against real objects. More detail is available in [their
56
+ documentation](https://github.com/rspec/rspec-mocks/blob/main/features/verifying_doubles).
57
+
58
+ Verifying doubles can also accept custom identifiers, just like double(), e.g.:
59
+
60
+ ```ruby
61
+ books = []
62
+ books << instance_double("Book", :rspec_book, :pages => 250)
63
+ books << instance_double("Book", "(Untitled)", :pages => 5000)
64
+
65
+ puts books.inspect # with names, it's clearer which were actually added
66
+ ```
67
+
68
+ ## Method Stubs
69
+
70
+ A method stub is an implementation that returns a pre-determined value. Method
71
+ stubs can be declared on test doubles or real objects using the same syntax.
72
+ rspec-mocks supports 3 forms for declaring method stubs:
73
+
74
+ ```ruby
75
+ allow(book).to receive(:title) { "The RSpec Book" }
76
+ allow(book).to receive(:title).and_return("The RSpec Book")
77
+ allow(book).to receive_messages(
78
+ :title => "The RSpec Book",
79
+ :subtitle => "Behaviour-Driven Development with RSpec, Cucumber, and Friends")
80
+ ```
81
+
82
+ You can also use this shortcut, which creates a test double and declares a
83
+ method stub in one statement:
84
+
85
+ ```ruby
86
+ book = double("book", :title => "The RSpec Book")
87
+ ```
88
+
89
+ The first argument is a name, which is used for documentation and appears in
90
+ failure messages. If you don't care about the name, you can leave it out,
91
+ making the combined instantiation/stub declaration very terse:
92
+
93
+ ```ruby
94
+ double(:foo => 'bar')
95
+ ```
96
+
97
+ This is particularly nice when providing a list of test doubles to a method
98
+ that iterates through them:
99
+
100
+ ```ruby
101
+ order.calculate_total_price(double(:price => 1.99), double(:price => 2.99))
102
+ ```
103
+
104
+ ### Stubbing a chain of methods
105
+
106
+ You can use `receive_message_chain` in place of `receive` to stub a chain of messages:
107
+
108
+ ```ruby
109
+ allow(double).to receive_message_chain("foo.bar") { :baz }
110
+ allow(double).to receive_message_chain(:foo, :bar => :baz)
111
+ allow(double).to receive_message_chain(:foo, :bar) { :baz }
112
+
113
+ # Given any of the above forms:
114
+ double.foo.bar # => :baz
115
+ ```
116
+
117
+ Chains can be arbitrarily long, which makes it quite painless to violate the Law of Demeter in violent ways, so you should consider any use of `receive_message_chain` a code smell. Even though not all code smells indicate real problems (think fluent interfaces), `receive_message_chain` still results in brittle examples. For example, if you write `allow(foo).to receive_message_chain(:bar, :baz => 37)` in a spec and then the implementation calls `foo.baz.bar`, the stub will not work.
118
+
119
+ ## Consecutive return values
120
+
121
+ When a stub might be invoked more than once, you can provide additional
122
+ arguments to `and_return`. The invocations cycle through the list. The last
123
+ value is returned for any subsequent invocations:
124
+
125
+ ```ruby
126
+ allow(die).to receive(:roll).and_return(1, 2, 3)
127
+ die.roll # => 1
128
+ die.roll # => 2
129
+ die.roll # => 3
130
+ die.roll # => 3
131
+ die.roll # => 3
132
+ ```
133
+
134
+ To return an array in a single invocation, declare an array:
135
+
136
+ ```ruby
137
+ allow(team).to receive(:players).and_return([double(:name => "David")])
138
+ ```
139
+
140
+ ## Message Expectations
141
+
142
+ A message expectation is an expectation that the test double will receive a
143
+ message some time before the example ends. If the message is received, the
144
+ expectation is satisfied. If not, the example fails.
145
+
146
+ ```ruby
147
+ validator = double("validator")
148
+ expect(validator).to receive(:validate) { "02134" }
149
+ zipcode = Zipcode.new("02134", validator)
150
+ zipcode.valid?
151
+ ```
152
+
153
+ ## Test Spies
154
+
155
+ Verifies the given object received the expected message during the course of
156
+ the test. For a message to be verified, the given object must be setup to spy
157
+ on it, either by having it explicitly stubbed or by being a null object double
158
+ (e.g. `double(...).as_null_object`). Convenience methods are provided to easily
159
+ create null object doubles for this purpose:
160
+
161
+ ```ruby
162
+ spy("invitation") # => same as `double("invitation").as_null_object`
163
+ instance_spy("Invitation") # => same as `instance_double("Invitation").as_null_object`
164
+ class_spy("Invitation") # => same as `class_double("Invitation").as_null_object`
165
+ object_spy("Invitation") # => same as `object_double("Invitation").as_null_object`
166
+ ```
167
+
168
+ Verifying messages received in this way implements the Test Spy pattern.
169
+
170
+ ```ruby
171
+ invitation = spy('invitation')
172
+
173
+ user.accept_invitation(invitation)
174
+
175
+ expect(invitation).to have_received(:accept)
176
+
177
+ # You can also use other common message expectations. For example:
178
+ expect(invitation).to have_received(:accept).with(mailer)
179
+ expect(invitation).to have_received(:accept).twice
180
+ expect(invitation).to_not have_received(:accept).with(mailer)
181
+
182
+ # One can specify a return value on the spy the same way one would a double.
183
+ invitation = spy('invitation', :accept => true)
184
+ expect(invitation).to have_received(:accept).with(mailer)
185
+ expect(invitation.accept).to eq(true)
186
+ ```
187
+
188
+ Note that `have_received(...).with(...)` is unable to work properly when
189
+ passed arguments are mutated after the spy records the received message.
190
+ For example, this does not work properly:
191
+
192
+ ```ruby
193
+ greeter = spy("greeter")
194
+
195
+ message = "Hello"
196
+ greeter.greet_with(message)
197
+ message << ", World"
198
+
199
+ expect(greeter).to have_received(:greet_with).with("Hello")
200
+ ```
201
+
202
+ ## Nomenclature
203
+
204
+ ### Mock Objects and Test Stubs
205
+
206
+ The names Mock Object and Test Stub suggest specialized Test Doubles. i.e.
207
+ a Test Stub is a Test Double that only supports method stubs, and a Mock
208
+ Object is a Test Double that supports message expectations and method
209
+ stubs.
210
+
211
+ There is a lot of overlapping nomenclature here, and there are many
212
+ variations of these patterns (fakes, spies, etc). Keep in mind that most of
213
+ the time we're talking about method-level concepts that are variations of
214
+ method stubs and message expectations, and we're applying to them to _one_
215
+ generic kind of object: a Test Double.
216
+
217
+ ### Test-Specific Extension
218
+
219
+ a.k.a. Partial Double, a Test-Specific Extension is an extension of a
220
+ real object in a system that is instrumented with test-double like
221
+ behaviour in the context of a test. This technique is very common in Ruby
222
+ because we often see class objects acting as global namespaces for methods.
223
+ For example, in Rails:
224
+
225
+ ```ruby
226
+ person = double("person")
227
+ allow(Person).to receive(:find) { person }
228
+ ```
229
+
230
+ In this case we're instrumenting Person to return the person object we've
231
+ defined whenever it receives the `find` message. We can also set a message
232
+ expectation so that the example fails if `find` is not called:
233
+
234
+ ```ruby
235
+ person = double("person")
236
+ expect(Person).to receive(:find) { person }
237
+ ```
238
+
239
+ RSpec replaces the method we're stubbing or mocking with its own
240
+ test-double-like method. At the end of the example, RSpec verifies any message
241
+ expectations, and then restores the original methods.
242
+
243
+ ## Expecting Arguments
244
+
245
+ ```ruby
246
+ expect(double).to receive(:msg).with(*args)
247
+ expect(double).to_not receive(:msg).with(*args)
248
+ ```
249
+
250
+ You can set multiple expectations for the same message if you need to:
251
+
252
+ ```ruby
253
+ expect(double).to receive(:msg).with("A", 1, 3)
254
+ expect(double).to receive(:msg).with("B", 2, 4)
255
+ ```
256
+
257
+ ## Argument Matchers
258
+
259
+ Arguments that are passed to `with` are compared with actual arguments
260
+ received using ===. In cases in which you want to specify things about the
261
+ arguments rather than the arguments themselves, you can use any of the
262
+ matchers that ship with rspec-expectations. They don't all make syntactic
263
+ sense (they were primarily designed for use with RSpec::Expectations), but
264
+ you are free to create your own custom RSpec::Matchers.
265
+
266
+ rspec-mocks also adds some keyword Symbols that you can use to
267
+ specify certain kinds of arguments:
268
+
269
+ ```ruby
270
+ expect(double).to receive(:msg).with(no_args)
271
+ expect(double).to receive(:msg).with(any_args)
272
+ expect(double).to receive(:msg).with(1, any_args) # any args acts like an arg splat and can go anywhere
273
+ expect(double).to receive(:msg).with(1, kind_of(Numeric), "b") #2nd argument can be any kind of Numeric
274
+ expect(double).to receive(:msg).with(1, boolean(), "b") #2nd argument can be true or false
275
+ expect(double).to receive(:msg).with(1, /abc/, "b") #2nd argument can be any String matching the submitted Regexp
276
+ expect(double).to receive(:msg).with(1, anything(), "b") #2nd argument can be anything at all
277
+ expect(double).to receive(:msg).with(1, duck_type(:abs, :div), "b") #2nd argument can be object that responds to #abs and #div
278
+ expect(double).to receive(:msg).with(hash_including(:a => 5)) # first arg is a hash with a: 5 as one of the key-values
279
+ expect(double).to receive(:msg).with(array_including(5)) # first arg is an array with 5 as one of the key-values
280
+ expect(double).to receive(:msg).with(hash_excluding(:a => 5)) # first arg is a hash without a: 5 as one of the key-values
281
+ expect(double).to receive(:msg).with(start_with('a')) # any matcher, custom or from rspec-expectations
282
+ expect(double).to receive(:msg).with(satisfy { |data| data.dig(:a, :b, :c) == 5 }) # assert anything you want
283
+ ```
284
+
285
+ ## Receive Counts
286
+
287
+ ```ruby
288
+ expect(double).to receive(:msg).once
289
+ expect(double).to receive(:msg).twice
290
+ expect(double).to receive(:msg).exactly(n).time
291
+ expect(double).to receive(:msg).exactly(n).times
292
+ expect(double).to receive(:msg).at_least(:once)
293
+ expect(double).to receive(:msg).at_least(:twice)
294
+ expect(double).to receive(:msg).at_least(n).time
295
+ expect(double).to receive(:msg).at_least(n).times
296
+ expect(double).to receive(:msg).at_most(:once)
297
+ expect(double).to receive(:msg).at_most(:twice)
298
+ expect(double).to receive(:msg).at_most(n).time
299
+ expect(double).to receive(:msg).at_most(n).times
300
+ ```
301
+
302
+ ## Ordering
303
+
304
+ ```ruby
305
+ expect(double).to receive(:msg).ordered
306
+ expect(double).to receive(:other_msg).ordered
307
+ # This will fail if the messages are received out of order
308
+ ```
309
+
310
+ This can include the same message with different arguments:
311
+
312
+ ```ruby
313
+ expect(double).to receive(:msg).with("A", 1, 3).ordered
314
+ expect(double).to receive(:msg).with("B", 2, 4).ordered
315
+ ```
316
+
317
+ ## Setting Responses
318
+
319
+ Whether you are setting a message expectation or a method stub, you can
320
+ tell the object precisely how to respond. The most generic way is to pass
321
+ a block to `receive`:
322
+
323
+ ```ruby
324
+ expect(double).to receive(:msg) { value }
325
+ ```
326
+
327
+ When the double receives the `msg` message, it evaluates the block and returns
328
+ the result.
329
+
330
+ ```ruby
331
+ expect(double).to receive(:msg).and_return(value)
332
+ expect(double).to receive(:msg).exactly(3).times.and_return(value1, value2, value3)
333
+ # returns value1 the first time, value2 the second, etc
334
+ expect(double).to receive(:msg).and_raise(error)
335
+ # `error` can be an instantiated object (e.g. `StandardError.new(some_arg)`) or a class (e.g. `StandardError`)
336
+ # if it is a class, it must be instantiable with no args
337
+ expect(double).to receive(:msg).and_throw(:msg)
338
+ expect(double).to receive(:msg).and_yield(values, to, yield)
339
+ expect(double).to receive(:msg).and_yield(values, to, yield).and_yield(some, other, values, this, time)
340
+ # for methods that yield to a block multiple times
341
+ ```
342
+
343
+ Any of these responses can be applied to a stub as well
344
+
345
+ ```ruby
346
+ allow(double).to receive(:msg).and_return(value)
347
+ allow(double).to receive(:msg).and_return(value1, value2, value3)
348
+ allow(double).to receive(:msg).and_raise(error)
349
+ allow(double).to receive(:msg).and_throw(:msg)
350
+ allow(double).to receive(:msg).and_yield(values, to, yield)
351
+ allow(double).to receive(:msg).and_yield(values, to, yield).and_yield(some, other, values, this, time)
352
+ ```
353
+
354
+ ## Arbitrary Handling
355
+
356
+ Once in a while you'll find that the available expectations don't solve the
357
+ particular problem you are trying to solve. Imagine that you expect the message
358
+ to come with an Array argument that has a specific length, but you don't care
359
+ what is in it. You could do this:
360
+
361
+ ```ruby
362
+ expect(double).to receive(:msg) do |arg|
363
+ expect(arg.size).to eq 7
364
+ end
365
+ ```
366
+
367
+ If the method being stubbed itself takes a block, and you need to yield to it
368
+ in some special way, you can use this:
369
+
370
+ ```ruby
371
+ expect(double).to receive(:msg) do |&arg|
372
+ begin
373
+ arg.call
374
+ ensure
375
+ # cleanup
376
+ end
377
+ end
378
+ ```
379
+
380
+ ## Delegating to the Original Implementation
381
+
382
+ When working with a partial mock object, you may occasionally
383
+ want to set a message expectation without interfering with how
384
+ the object responds to the message. You can use `and_call_original`
385
+ to achieve this:
386
+
387
+ ```ruby
388
+ expect(Person).to receive(:find).and_call_original
389
+ Person.find # => executes the original find method and returns the result
390
+ ```
391
+
392
+ ## Combining Expectation Details
393
+
394
+ Combining the message name with specific arguments, receive counts and responses
395
+ you can get quite a bit of detail in your expectations:
396
+
397
+ ```ruby
398
+ expect(double).to receive(:<<).with("illegal value").once.and_raise(ArgumentError)
399
+ ```
400
+
401
+ While this is a good thing when you really need it, you probably don't really
402
+ need it! Take care to specify only the things that matter to the behavior of
403
+ your code.
404
+
405
+ ## Stubbing and Hiding Constants
406
+
407
+ See the [mutating constants
408
+ README](https://github.com/rspec/rspec-mocks/blob/main/features/mutating_constants/README.md)
409
+ for info on this feature.
410
+
411
+ ## Use `before(:example)`, not `before(:context)`
412
+
413
+ Stubs in `before(:context)` are not supported. The reason is that all stubs and mocks get cleared out after each example, so any stub that is set in `before(:context)` would work in the first example that happens to run in that group, but not for any others.
414
+
415
+ Instead of `before(:context)`, use `before(:example)`.
416
+
417
+ ## Settings mocks or stubs on any instance of a class
418
+
419
+ rspec-mocks provides two methods, `allow_any_instance_of` and
420
+ `expect_any_instance_of`, that will allow you to stub or mock any instance
421
+ of a class. They are used in place of `allow` or `expect`:
422
+
423
+ ```ruby
424
+ allow_any_instance_of(Widget).to receive(:name).and_return("Wibble")
425
+ expect_any_instance_of(Widget).to receive(:name).and_return("Wobble")
426
+ ```
427
+
428
+ These methods add the appropriate stub or expectation to all instances of
429
+ `Widget`.
430
+
431
+ This feature is sometimes useful when working with legacy code, though in
432
+ general we discourage its use for a number of reasons:
433
+
434
+ * The `rspec-mocks` API is designed for individual object instances, but this
435
+ feature operates on entire classes of objects. As a result there are some
436
+ semantically confusing edge cases. For example in
437
+ `expect_any_instance_of(Widget).to receive(:name).twice` it isn't clear
438
+ whether each specific instance is expected to receive `name` twice, or if two
439
+ receives total are expected. (It's the former.)
440
+ * Using this feature is often a design smell. It may be
441
+ that your test is trying to do too much or that the object under test is too
442
+ complex.
443
+ * It is the most complicated feature of `rspec-mocks`, and has historically
444
+ received the most bug reports. (None of the core team actively use it,
445
+ which doesn't help.)
446
+
447
+
448
+ ## Further Reading
449
+
450
+ There are many different viewpoints about the meaning of mocks and stubs. If
451
+ you are interested in learning more, here is some recommended reading:
452
+
453
+ * Mock Objects: http://www.mockobjects.com/
454
+ * Endo-Testing: http://www.ccs.neu.edu/research/demeter/related-work/extreme-programming/MockObjectsFinal.PDF
455
+ * Mock Roles, Not Objects: http://www.jmock.org/oopsla2004.pdf
456
+ * Test Double: http://www.martinfowler.com/bliki/TestDouble.html
457
+ * Test Double Patterns: http://xunitpatterns.com/Test%20Double%20Patterns.html
458
+ * Mocks aren't stubs: http://www.martinfowler.com/articles/mocksArentStubs.html
459
+
460
+ ## Also see
461
+
462
+ * [https://github.com/rspec/rspec](https://github.com/rspec/rspec)
463
+ * [https://github.com/rspec/rspec-core](https://github.com/rspec/rspec-core)
464
+ * [https://github.com/rspec/rspec-expectations](https://github.com/rspec/rspec-expectations)
465
+ * [https://github.com/rspec/rspec-rails](https://github.com/rspec/rspec-rails)
@@ -0,0 +1,23 @@
1
+ The MIT License (MIT)
2
+ ====================
3
+
4
+ * Copyright © 2013 David Chelimsky, Myron Marston, Jon Rowe, Sam Phippen, Xavier Shay, Bradley Schaefer
5
+
6
+ Permission is hereby granted, free of charge, to any person obtaining
7
+ a copy of this software and associated documentation files (the
8
+ "Software"), to deal in the Software without restriction, including
9
+ without limitation the rights to use, copy, modify, merge, publish,
10
+ distribute, sublicense, and/or sell copies of the Software, and to
11
+ permit persons to whom the Software is furnished to do so, subject to
12
+ the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be
15
+ included in all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
21
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
22
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
23
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,40 @@
1
+ # RSpec::Support [![Build Status](https://github.com/rspec/rspec-support/workflows/RSpec%20CI/badge.svg)](https://github.com/rspec/rspec-support/actions)
2
+
3
+ `RSpec::Support` provides common functionality to `RSpec::Core`,
4
+ `RSpec::Expectations` and `RSpec::Mocks`. It is considered
5
+ suitable for internal use only at this time.
6
+
7
+ ## Installation / Usage
8
+
9
+ Install one or more of the `RSpec` gems.
10
+
11
+ Want to run against the `main` branch? You'll need to include the dependent
12
+ RSpec repos as well. Add the following to your `Gemfile`:
13
+
14
+ ```ruby
15
+ %w[rspec-core rspec-expectations rspec-mocks rspec-support].each do |lib|
16
+ gem lib, :git => "https://github.com/rspec/#{lib}.git", :branch => 'main'
17
+ end
18
+ ```
19
+
20
+ ## Contributing
21
+
22
+ Once you've set up the environment, you'll need to cd into the working
23
+ directory of whichever repo you want to work in. From there you can run the
24
+ specs and cucumber features, and make patches.
25
+
26
+ NOTE: You do not need to use rspec-dev to work on a specific RSpec repo. You
27
+ can treat each RSpec repo as an independent project.
28
+
29
+ - [Build details](BUILD_DETAIL.md)
30
+ - [Code of Conduct](CODE_OF_CONDUCT.md)
31
+ - [Detailed contributing guide](CONTRIBUTING.md)
32
+ - [Development setup guide](DEVELOPMENT.md)
33
+
34
+ ## Patches
35
+
36
+ Please submit a pull request or a github issue. If you submit an issue, please
37
+ include a link to either of:
38
+
39
+ * a gist (or equivalent) of the patch
40
+ * a branch or commit in your github fork of the repo
@@ -0,0 +1,72 @@
1
+ # Securerandom
2
+
3
+ This library is an interface to secure random number generators which are
4
+ suitable for generating session keys in HTTP cookies, etc.
5
+
6
+ ## Installation
7
+
8
+ Add this line to your application's Gemfile:
9
+
10
+ ```ruby
11
+ gem 'securerandom'
12
+ ```
13
+
14
+ And then execute:
15
+
16
+ $ bundle install
17
+
18
+ Or install it yourself as:
19
+
20
+ $ gem install securerandom
21
+
22
+ ## Usage
23
+
24
+ Generate random hexadecimal strings:
25
+
26
+ ```ruby
27
+ require 'securerandom'
28
+
29
+ SecureRandom.hex(10) #=> "52750b30ffbc7de3b362"
30
+ SecureRandom.hex(10) #=> "92b15d6c8dc4beb5f559"
31
+ SecureRandom.hex(13) #=> "39b290146bea6ce975c37cfc23"
32
+ ```
33
+
34
+ Generate random base64 strings:
35
+
36
+ ```ruby
37
+ SecureRandom.base64(10) #=> "EcmTPZwWRAozdA=="
38
+ SecureRandom.base64(10) #=> "KO1nIU+p9DKxGg=="
39
+ SecureRandom.base64(12) #=> "7kJSM/MzBJI+75j8"
40
+ ```
41
+
42
+ Generate random binary strings:
43
+
44
+ ```ruby
45
+ SecureRandom.random_bytes(10) #=> "\016\t{\370g\310pbr\301"
46
+ SecureRandom.random_bytes(10) #=> "\323U\030TO\234\357\020\a\337"
47
+ ```
48
+
49
+ Generate alphanumeric strings:
50
+
51
+ ```ruby
52
+ SecureRandom.alphanumeric(10) #=> "S8baxMJnPl"
53
+ SecureRandom.alphanumeric(10) #=> "aOxAg8BAJe"
54
+ ```
55
+
56
+ Generate UUIDs:
57
+
58
+ ```ruby
59
+ SecureRandom.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
60
+ SecureRandom.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
61
+ ```
62
+
63
+ ## Development
64
+
65
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
66
+
67
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
68
+
69
+ ## Contributing
70
+
71
+ Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/securerandom.
72
+
@@ -0,0 +1,19 @@
1
+ Copyright (c) 2005-2023 Philip Ross
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy of
4
+ this software and associated documentation files (the "Software"), to deal in
5
+ the Software without restriction, including without limitation the rights to
6
+ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
7
+ of the Software, and to permit persons to whom the Software is furnished to do
8
+ so, subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in all
11
+ copies or substantial portions of the Software.
12
+
13
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19
+ THE SOFTWARE.