rspec-side_effects 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 0d4c1faa5a5a16d11a789cfb49dfc5553888e9dd
4
+ data.tar.gz: 416e8e2d16b05bb667faf2d78fd61de198a1094e
5
+ SHA512:
6
+ metadata.gz: 8ae7e359642a787e43fdd684f8077ecdbeaa0d6aa15e5ce636cbc8872e2ad00728b8ac73068d9fbbf021d9d7ce9e430d2438fcb78d4a40a7a63c9a3307ec847e
7
+ data.tar.gz: 6bd7444350e204568d342c97ab0813236a1da58af02e38aee2e554d122ec1b71d5a04657a425479f72e90a185d517871af54195cbf2d5b0259a65b5816820995
data/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.rubocop.yml ADDED
@@ -0,0 +1,7 @@
1
+ require: rubocop-rspec
2
+
3
+ Metrics/MethodLength:
4
+ Max: 20
5
+
6
+ RSpec/EmptyExampleGroup:
7
+ Enabled: false
data/.travis.yml ADDED
@@ -0,0 +1,19 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.1
4
+ - 2.2
5
+ - 2.3
6
+ - 2.4
7
+ - 2.5
8
+ - ruby-head
9
+ matrix:
10
+ allow_failures:
11
+ - rvm: ruby-head
12
+ - rvm: 2.4
13
+ os: osx
14
+ os:
15
+ - linux
16
+ - osx
17
+ sudo: false
18
+ after_success:
19
+ - bundle exec codeclimate-test-reporter
data/CHANGELOG.md ADDED
@@ -0,0 +1,12 @@
1
+ # Change Log
2
+ All notable changes to this project will be documented in this file.
3
+
4
+ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
5
+ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
6
+
7
+ ## [Unreleased]
8
+
9
+ ## 0.0.1 - 2018-05-02
10
+ ### Added
11
+ - Add the its_side_effects_are helper, as well as its aliases it_has_side_effects
12
+ and specify_side_effects
data/CONTRIBUTING.md ADDED
@@ -0,0 +1,24 @@
1
+ # Contributing
2
+
3
+ To contribute,
4
+
5
+ 1. Fork this repository.
6
+ 1. Work on your changes within a topic branch.
7
+ 1. Create a pull request
8
+
9
+ Pull requests are accepted under the discretion of the SidecarDevTools maintainer(s). Improve the chances your PR will be merged by following the requirements and guidelines below. For any questions, please e-mail developers@sugarcrm.com.
10
+
11
+ ## REQUIREMENTS
12
+
13
+ * By creating a pull request, you are agreeing to [SugarCRM Open Source Contributor terms](CONTRIBUTOR_TERMS.md).
14
+
15
+ ## GUIDELINES
16
+
17
+ * Make sure your pull contains quality code. We will certainly provide constructive feedback on works in progress but we will not merge incomplete pull requests.
18
+ * Make sure your pull is fully documented. For Javascript, we use jsdoc.
19
+ * Reference related Github Issues within commit comments and pull request comment where appropriate.
20
+ * Squash out minor or "typo" commits in your pull using `git commit -a` or `git rebase -i`.
21
+
22
+ ## BUGS
23
+
24
+ File bugs or feature requests using Github Issue Tracker.
@@ -0,0 +1,40 @@
1
+ # Contributor Terms (Version May 1, 2015)
2
+
3
+ Thank you for your interest in contributing to this SugarCRM Inc. (“SugarCRM”) open source project (the “Project”). By posting or submitting your ideas, code, documentation or other material to SugarCRM for this Project (“Your Contribution”), you agree to these Contributor Terms (these “Terms”). If you are an individual acting as a representative of a corporation or other legal entity making Your Contribution(s), then you represent and agree that you have the authority to accept these Terms on behalf of such corporation or other legal entity and all provisions of these Terms will bind that corporation or other legal entity as if it were named in these Terms in place of you.
4
+
5
+ ## Voluntary Participation
6
+
7
+ You understand that Your Contributions are entirely voluntary and may expose Your Contributions to public display in a non-confidential manner. SugarCRM reserves the right (but has no obligation) to review, reject, use or modify Your Contributions.
8
+
9
+ ## Ownership; License Back to You
10
+
11
+ In consideration for the potential inclusion or use of Your Contributions in SugarCRM products or services and the license back described in more detail below, you assign and agree to assign to SugarCRM all your rights, title, and interest worldwide in all intellectual property rights in Your Contributions, including all patents, copyrights and related moral rights (collectively, the “**Assigned IP Rights**”). SugarCRM has the right to record an assignment of the Assigned IP Rights from you to SugarCRM. If the Assigned IP Rights are not assignable by you for any reason, you agree to not to enforce, either directly or indirectly, and agree to waive any enforcement of the Assigned IP Rights against SugarCRM, its affiliates and any of its sublicensees or anyone in its sales or distribution channel.
12
+
13
+ SugarCRM grants a license back to you to use Your Contributions under the terms and conditions of the Apache License, version 2.0. This license is limited to Your Contributions only (as delivered to by you to SugarCRM) and does not provide any rights or grant to you any licenses in or to any other SugarCRM products or services or any modifications that SugarCRM may later make to Your Contributions. All rights not expressly granted in these Terms are reserved by SugarCRM.
14
+
15
+ ## Responsibility for Your Contributions
16
+
17
+ You represent to SugarCRM that:
18
+
19
+ 1. Each of Your Contributions are your original creation;
20
+ 2. You have the legal right to assign ownership in Your Contributions to SugarCRM, as contemplated in these Terms or, if applicable, you have permission from your employer to make Your Contributions on behalf of that employer, that your employer has waived such rights for Your Contributions to SugarCRM;
21
+ 3. You are legally entitled to assign the rights and waive enforcement of any rights you have, as contemplated in these Terms; and
22
+ 4. To the best of your knowledge, Your Contributions do not and will not violate any third party’s intellectual property rights, including any patents, copyrights or related moral rights.
23
+
24
+ You agree to notify SugarCRM of any facts or circumstances of which you become aware that would make your representations in these Terms inaccurate in any manner.
25
+
26
+ If you wish to submit work that is not your original creation, you may submit it to SugarCRM separately from any of Your Contributions, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
27
+
28
+ ## Disclaimers; Limitations of Liability
29
+
30
+ YOUR CONTRIBUTIONS AND SUGARCRM’S GRANT OF A LICENSE TO YOU FOR YOUR CONTRIBUTIONS ARE ALL PROVIDED TO THE OTHER PARTY ON AN “AS IS” BASIS AND WITHOUT ANY WARRANTY OF ANY KIND. EACH PARTY DISCLAIMS ALL EXPRESS AND IMPLIED WARRANTIES, INCLUDING THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
31
+
32
+ IN NO EVENT SHALL EITHER PARTY BE LIABLE TO THE OTHER PARTY FOR ANY CONSEQUENTIAL, SPECIAL, INCIDENTAL OR INDIRECT DAMAGES OF ANY KIND ARISING OUT OF THE USE OF YOUR CONTRIBUTIONS, EVEN IF THAT PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. IN NO EVENT SHALL SUGARCRM HAVE ANY LIABILITY TO YOU FOR ANY CLAIM, WHETHER IN CONTRACT, TORT OR ANY OTHER THEORY OF LIABILITY.
33
+
34
+ ## Right to Change Terms
35
+
36
+ SugarCRM reserves the right to update and change these Terms from time to time without prior notice to you, so please check this file frequently for updates and changes.
37
+
38
+ ## General Terms
39
+
40
+ These Terms and its rights or obligations cannot be assigned by you, by operation of law or otherwise, to any third party without SugarCRM’s prior written consent. These Terms will be governed by and under the laws of the State of California, United States, without giving effect to conflicts of law principles. If any provision of these Terms is found invalid, unlawful or otherwise unenforceable under applicable law, such provision will be replaced to the extent possible with a provision that comes closest to the intent of the original provision and all other provisions of these Terms shall continue in full force and effect. The waiver or failure of SugarCRM to enforce any of these Terms shall not be deemed a waiver of any further right under these Terms. The right to require performance of any duty hereunder is not barred by any prior waiver, forbearance or dealing. These Terms constitute the entire agreement between the parties with respect to the subject matter of these Terms, and supersede and merge all prior and contemporaneous proposals, understandings and all other agreements, oral and written, between the parties relating to the subject matter of these Terms.
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in rspec-side_effects.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,202 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright {yyyy} {name of copyright owner}
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
202
+
data/README.md ADDED
@@ -0,0 +1,89 @@
1
+ # Rspec::SideEffects
2
+
3
+ [![Gem Version](https://badge.fury.io/rb/rspec-side_effects.svg)](http://badge.fury.io/rb/rspec-side_effects)
4
+ [![Dependency Status](https://gemnasium.com/sugarcrm/rspec-side_effects.svg)](https://gemnasium.com/sugarcrm/rspec-side_effects)
5
+ [![Build Status](https://travis-ci.org/sugarcrm/rspec-side_effects.svg?branch=master)](https://travis-ci.org/sugarcrm/rspec-side_effects)
6
+ [![Code Climate](https://codeclimate.com/github/sugarcrm/rspec-side_effects/badges/gpa.svg)](https://codeclimate.com/github/sugarcrm/rspec-side_effects)
7
+ [![Test Coverage](https://codeclimate.com/github/sugarcrm/rspec-side_effects/badges/coverage.svg)](https://codeclimate.com/github/sugarcrm/rspec-side_effects/coverage)
8
+ [![Inline docs](http://inch-ci.org/github/sugarcrm/rspec-side_effects.svg)](http://inch-ci.org/github/sugarcrm/rspec-side_effects)
9
+ [![License](http://img.shields.io/badge/license-Apache2-green.svg?style=flat)](LICENSE)
10
+
11
+ RSpec extension for check the side effects of your specifications.
12
+
13
+ ## Installation
14
+
15
+ Add this line to your application's Gemfile:
16
+
17
+ ```ruby
18
+ gem 'rspec-side_effects'
19
+ ```
20
+
21
+ And then execute:
22
+
23
+ $ bundle
24
+
25
+ Or install it yourself as:
26
+
27
+ $ gem install rspec-side_effects
28
+
29
+ ## Usage
30
+
31
+ This gem is intended to replace explicitly calling the *subject* before checking
32
+ its side effects. It might be used when testing things like:
33
+ * method which works directly with a database
34
+ * method which works directly with a file system
35
+ * method which integrates mocked objects
36
+
37
+ There are several aliases for *it_has_side_effects_are* which can be used to
38
+ communicate different things.
39
+
40
+ ```
41
+ subject { test_class.test }
42
+
43
+ its_side_effects_are do
44
+ # Check a side effect, such as writing to the file system.
45
+ # Check a have_received expectation
46
+ end
47
+ ```
48
+
49
+ Or leave out the block and only check expectations which are already setup.
50
+
51
+ ```
52
+ subject { test_class.test }
53
+
54
+ before do
55
+ # Setup an expecation for the method call
56
+ end
57
+
58
+ end
59
+
60
+ it_has_side_effects
61
+ ```
62
+
63
+ Both of these examples are testing methods where you do not care about the
64
+ return value. When you do care about the return value and the side effects, you
65
+ can do that too.
66
+
67
+ ```
68
+ subject { test_class.test }
69
+
70
+ it { is_expected.to eq(:result) }
71
+ its_side_effects_are do
72
+ # Check a side effect, such as writing to the file system.
73
+ # Check a have_received expectation
74
+ end
75
+ ```
76
+
77
+ ## Development
78
+
79
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
80
+
81
+ 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).
82
+
83
+ ## Contributing
84
+
85
+ See [CONTRIBUTING](CONTRIBUTING.md) for how you can contribute changes back into this project.
86
+
87
+ ## Acknowledgments
88
+
89
+ Copyright 2018 [SugarCRM Inc.](http://sugarcrm.com), released under the Apache2 License.
data/Rakefile ADDED
@@ -0,0 +1,26 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+ require 'rubocop/rake_task'
4
+ require 'pathname'
5
+
6
+ RSpec::Core::RakeTask.new(:spec) do |task|
7
+ task.rspec_opts = '--warnings'
8
+ end
9
+
10
+ RuboCop::RakeTask.new(:rubocop) do |task|
11
+ rubocop_report_pathname =
12
+ Pathname(Rake.application.original_dir).join('tmp', 'rubocop.txt')
13
+ rubocop_report_pathname.dirname.mkpath
14
+ task.requires << 'rubocop-rspec'
15
+ task.options =
16
+ %w[
17
+ --display-cop-names
18
+ --extra-details
19
+ --display-style-guide
20
+ --fail-level error
21
+ --format progress
22
+ --format simple --out
23
+ ].push(rubocop_report_pathname.to_s)
24
+ end
25
+
26
+ task default: %i[spec rubocop]
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'rspec/side_effects'
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require 'irb'
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,5 @@
1
+ module Rspec
2
+ module SideEffects
3
+ VERSION = '0.1.0'.freeze
4
+ end
5
+ end
@@ -0,0 +1,34 @@
1
+ require 'rspec/side_effects/version'
2
+
3
+ module Rspec
4
+ # This module will allow the side effects of RSpec examples to be written more
5
+ # clearly and consistently.
6
+ #
7
+ # @example
8
+ module SideEffects
9
+ def its_side_effects_are(*options, &block)
10
+ its_caller = caller.reject { |file_line| file_line =~ /its_side_effects/ }
11
+ if options.last.is_a?(Hash)
12
+ options.last.merge(called: its_caller)
13
+ else
14
+ options.push(called: its_caller)
15
+ end
16
+
17
+ describe('side effects', *options) do
18
+ if block
19
+ before { subject }
20
+ example(nil, :aggregate_failures, *options, &block)
21
+ else
22
+ example(nil, {}) { subject }
23
+ end
24
+ end
25
+ end
26
+
27
+ alias it_has_side_effects its_side_effects_are
28
+ alias specify_side_effects its_side_effects_are
29
+ end
30
+ end
31
+
32
+ RSpec.configure do |config|
33
+ config.extend(Rspec::SideEffects)
34
+ end
@@ -0,0 +1,39 @@
1
+
2
+ lib = File.expand_path('lib', __dir__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'rspec/side_effects/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'rspec-side_effects'
8
+ spec.version = Rspec::SideEffects::VERSION
9
+ spec.authors = ['Andrew Sullivan Cant']
10
+ spec.email = ['mail@andrewsullivancant.ca']
11
+
12
+ spec.summary = 'RSpec extension for examples with side effects.'
13
+ spec.description = 'DSL to make testing side effects clear and explicit.'
14
+ spec.homepage = 'http://github.com/sugarcrm/rspec-side_effects'
15
+ spec.license = 'Apache-2.0'
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
21
+ spec.bindir = 'exe'
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ['lib']
24
+
25
+ spec.required_ruby_version = '>= 2.1.0'
26
+
27
+ spec.add_runtime_dependency 'rspec-core', '>= 2.99.0'
28
+
29
+ spec.add_development_dependency 'bundler', '~> 1.14'
30
+ spec.add_development_dependency 'rake', '~> 10.0'
31
+ spec.add_development_dependency 'rspec', '~> 3.0'
32
+
33
+ # Dependencies whose APIs we do not really depend upon, and can be upgraded
34
+ # without limiting.
35
+ spec.add_development_dependency 'codeclimate-test-reporter'
36
+ spec.add_development_dependency 'rubocop'
37
+ spec.add_development_dependency 'rubocop-rspec'
38
+ spec.add_development_dependency 'simplecov'
39
+ end
metadata ADDED
@@ -0,0 +1,172 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: rspec-side_effects
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Andrew Sullivan Cant
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-05-02 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rspec-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: 2.99.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: 2.99.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.14'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.14'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: codeclimate-test-reporter
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rubocop
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rubocop-rspec
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: simplecov
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ description: DSL to make testing side effects clear and explicit.
126
+ email:
127
+ - mail@andrewsullivancant.ca
128
+ executables: []
129
+ extensions: []
130
+ extra_rdoc_files: []
131
+ files:
132
+ - ".gitignore"
133
+ - ".rspec"
134
+ - ".rubocop.yml"
135
+ - ".travis.yml"
136
+ - CHANGELOG.md
137
+ - CONTRIBUTING.md
138
+ - CONTRIBUTOR_TERMS.md
139
+ - Gemfile
140
+ - LICENSE.txt
141
+ - README.md
142
+ - Rakefile
143
+ - bin/console
144
+ - bin/setup
145
+ - lib/rspec/side_effects.rb
146
+ - lib/rspec/side_effects/version.rb
147
+ - rspec-side_effects.gemspec
148
+ homepage: http://github.com/sugarcrm/rspec-side_effects
149
+ licenses:
150
+ - Apache-2.0
151
+ metadata: {}
152
+ post_install_message:
153
+ rdoc_options: []
154
+ require_paths:
155
+ - lib
156
+ required_ruby_version: !ruby/object:Gem::Requirement
157
+ requirements:
158
+ - - ">="
159
+ - !ruby/object:Gem::Version
160
+ version: 2.1.0
161
+ required_rubygems_version: !ruby/object:Gem::Requirement
162
+ requirements:
163
+ - - ">="
164
+ - !ruby/object:Gem::Version
165
+ version: '0'
166
+ requirements: []
167
+ rubyforge_project:
168
+ rubygems_version: 2.6.12
169
+ signing_key:
170
+ specification_version: 4
171
+ summary: RSpec extension for examples with side effects.
172
+ test_files: []