radius-spec 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 199cf6c21d0f54935244a6f92f77bfd2292648ae7817e0dc6d2556dca0cddb40
-  data.tar.gz: fe88a096f2fac711be28918c786242796616375dfd5f7d038210c577104866a2
+  metadata.gz: a6155ce5b3b86485b3a2011fbf15cd2ad268e0f74639986260057d1fcfccdff8
+  data.tar.gz: 0556fe666ef3b4522f32e5f1edaa004ef344bc7a7f47283cc7b49656d3c04950
 SHA512:
-  metadata.gz: d881caef9047764de02e3e59a2de2722c620ecfd4c55c825d19d6ac2a90dceeb8e229a52363120991fd6c166737ddfef8f49e3b3b74621da9eed27318dfc221b
-  data.tar.gz: c8a090b6431ec6c6d3439b4947ac4640ddeb10f9b48c6c29c992e7207c0a71f1e5db48c26d630fdc95830be79b62c99ed1b2d4599eccd28c61a206615cf2de12
+  metadata.gz: fdc10a35535a2b7b39e2ae261fa98d45fbc87c6579366861935c04cc5d15d317182b00c0daaf1414ef457f3e26952fde8cf7b728db924c9befea0c9fd8238d1a
+  data.tar.gz: 176adf989c35360f4e137da3757aeda641414fe29ee50800c69c3d2091342451375e03ed8db3987a3cee5f6d7841ec58da71e8bee4d67854f5a4e043527f7477

data/.rubocop.yml

@@ -1,12 +1,14 @@
 inherit_mode:
   merge:
     - Exclude
+    - IgnoredPatterns
 
 inherit_from: common_rubocop.yml
 
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
   Exclude:
+    - 'benchmarks/**/*'
     - 'lib/radius/spec/rspec.rb'
 
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
@@ -14,3 +16,7 @@ Metrics/BlockLength:
 Metrics/LineLength:
   Exclude:
     - 'radius-spec.gemspec'
+
+Style/Documentation:
+  Exclude:
+    - 'benchmarks/**/*'

data/.travis.yml

@@ -1,15 +1,14 @@
-sudo: false
 language: ruby
 cache: bundler
-before_install:
-  - gem update --system
-  - gem install bundler
 bundler_args: --jobs=3 --retry=3 --without documentation debug
+before_script:
+  - "bin/ci-code-review"
 script: bin/ci
 rvm:
+  - 2.6
   - 2.5
   - ruby-head
-matrix:
+jobs:
   allow_failures:
     - rvm: ruby-head
   fast_finish: true

data/.yardopts

@@ -1,4 +1,5 @@
 --markup markdown
+--markup-provider redcarpet
 --no-private
 -
 CHANGELOG.md

data/CHANGELOG.md

@@ -1,3 +1,124 @@
+## 0.6.0 (August 6, 2020)
+
+[Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.5.0...v0.6.0)
+
+### Enhancements
+
+- Exclude more bundler binstubs from Rubocop (Aaron Kromer, #18, #20)
+- Exclude `chdir` and `Capybara.register_driver` configuration blocks from
+  `Metrics/BlockLength` checks (Aaron Kromer, #18)
+- Exclude gem specs from block and line length metrics (Aaron Kromer, #20)
+- Standardize on key style of `Layout/AlignHash` (Aaron Kromer, #18)
+- Upgrade to Rubocop 0.62.x (Aaron Kromer, #21)
+
+### Bug Fixes
+
+None
+
+
+## 0.5.0 (September 26, 2018)
+
+[Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.4.0...v0.5.0)
+
+### Enhancements
+
+- Add common VCR configuration (Aaron Kromer, #16)
+  - Filters out `Authorization` headers
+  - Filters out the following sensitive/environment varying `ENV` values, as
+    well as their URL and form encoded variants:
+    - `AWS_ACCESS_KEY_ID`
+    - `AWS_SECRET_ACCESS_KEY`
+    - `GOOGLE_CLIENT_ID`
+    - `GOOGLE_CLIENT_SECRET`
+    - `RADIUS_OAUTH_PROVIDER_APP_ID`
+    - `RADIUS_OAUTH_PROVIDER_APP_SECRET`
+    - `RADIUS_OAUTH_PROVIDER_URL`
+- Add "temp file" helpers for working with file stubs (Aaron Kromer, #15)
+- Upgrade to Rubocop 0.59.x (Aaron Kromer, #14)
+- Adjust common Rubocop configuration (Aaron Kromer, #14)
+  - `Layout/EmptyLineAfterGuardClause` is enabled by default
+  - Enable `Rails/SaveBang` to highlight potential lurking issues
+  - Expand `Rails/FindBy` and `Rails/FindEach` to check all `/app` and `/lib`
+  - Add more functional methods
+    - `default_scope`
+    - `filter_sensitive_data`
+- Add `build!` factory method to compliment `build` to help resolving Rubocop
+  violations for `Rails/SaveBang` (Aaron Kromer, #14)
+- Load model factory for specs tagged with 'type: :mailer' (Aaron Kromer, #11)
+- Include the following negated RSpec matchers (Aaron Kromer, #12)
+  - `exclude` / `excluding`
+  - `not_eq`
+  - `not_change`
+  - `not_raise_error` / `not_raise_exception`
+
+### Bug Fixes
+
+- Fix `NoMethodError: undefined method 'strip'` when the fixture path is a
+  `Pathname` object (Aaron Kromer, #13)
+
+
+## 0.4.0 (July 10, 2018)
+
+[Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.3.0...v0.4.0)
+
+### Enhancements
+
+- Upgrade to Rubocop 0.58.x (Aaron Kromer, #10)
+- Add more custom extra details for customized cops (Aaron Kromer, #10)
+- Adjust common Rubocop configuration
+  - Disable `Naming/BinaryOperatorParameterName` (Aaron Kromer, #7)
+  - Disable `Style/RedundantReturn` (Aaron Kromer, #7)
+  - Allow optional leading underscores for memoized instance variable names to
+    support modules wanting to reduce conflicts / collisions. (Aaron Kromer, #10)
+- Adjust common Rubocop Rails configuration (Aaron Kromer, #7)
+  - Exclude Rails controllers from Rubocop's `Metrics/MethodLength` due to
+    `respond_to` / `format` and permitted params methods
+  - Disable `Rails/HasAndBelongsToMany`
+  - Exclude Rails app `config/routes.rb` from `Metrics/BlockLength`
+
+### Bug Fixes
+
+- Add more functional methods to Rubocop config (Aaron Kromer, #7)
+  - `create`
+  - `create!`
+  - `build`
+  - `build!`
+- Support running system specs in isolation (Aaron Kromer, #9)
+
+
+## 0.3.0 (June 15, 2018)
+
+[Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.2.1...v0.3.0)
+
+### Breaking Change
+
+- Lock Rubocop to a minor release version in gemspec (Aaron Kromer, #5)
+
+### Enhancements
+
+- Adjust common Rubocop configuration (Aaron Kromer, #5)
+  - Customize `Style/AndOr` to flag only conditionals allowing `and` / `or` for
+    control flow
+  - Add `find` to functional method blocks
+  - Disable `Style/DoubleNegation` as this is a common Ruby idiom
+  - Disable `Style/StringLiteralsInInterpolation` to stay consistent with our
+    no preferences for single versus double quotes
+
+### Bug Fixes
+
+- Remove `Include` from common Rubocop all cops configuration to fix issues
+  with Rubocop 0.56.0+ not seeing all expected files. (Aaron Kromer, #5)
+
+
+## 0.2.1 (May 17, 2018)
+
+[Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.2.0...v0.2.1)
+
+### Bug Fixes
+
+-  Fix warning about overriding parameter (Aaron Kromer, #4)
+
+
 ## 0.2.0 (May 17, 2018)
 
 [Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.1.1...v0.2.0)
@@ -26,7 +147,7 @@
 
 ### Bug Fixes
 
-- Fix `NameError: undefined local variable or method `config` for Rails RSpec
+- Fix `NameError: undefined local variable or method config` for Rails RSpec
   configuration (Aaron Kromer, #1)
 - Fix model factory build issue in which registered template attributes, which
   use symbol keys, are not replaced by custom attributes using string keys

data/Gemfile

@@ -7,16 +7,20 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in radius-spec.gemspec
 gemspec
 
-group :debug do
-  gem "pry-byebug", "~> 3.6", require: false
-  gem "travis", require: false
+group :benchmark, optional: true do
+  gem 'activesupport', require: false
+  gem 'benchmark-ips', require: false
+  # TODO: See if this gem has an update in the future as it's gemspec is too
+  # strict and it was blocking other gems from installing / updating
+  gem 'kalibera', require: false, git: 'https://github.com/cupakromer/libkalibera.git'
 end
 
-group :development do
-  gem "rubocop", "~> 0.53", require: false
+group :debug do
+  gem "pry-byebug", "~> 3.6", require: false
 end
 
 group :documentation do
+  gem 'redcarpet', require: false
   gem 'yard', '~> 0.9', require: false
 end
 

data/README.md

@@ -92,11 +92,20 @@ end
 
 ### Common Rubocop Config
 
-Projects can inherit from the [base Rubocop config](.rubocop.yml) by using
-either the remote raw URL or dependency gem formats:
+Projects can inherit from the [base Rubocop config](.rubocop.yml). This can be
+accomplished by using either the remote raw URL or dependency gem formats. With
+either method we also strongly suggest setting the `inherit_mode` to `merge`
+for both `Exclude` and `IgnoredPatterns`. This way you can append additional
+exceptions without overwriting the defaults.
+
+#### Inherit from Gem (Recommended Method)
 
 ```yaml
-# Recommended Method
+inherit_mode:
+  merge:
+    - Exclude
+    - IgnoredPatterns
+
 inherit_gem:
   radius-spec:
     - common_rubocop.yml
@@ -104,7 +113,14 @@ inherit_gem:
     - common_rubocop_rails.yml
 ```
 
+#### Inherit from URL
+
 ```yaml
+inherit_mode:
+  merge:
+    - Exclude
+    - IgnoredPatterns
+
 # Available for projects which cannot include this gem (i.e. Ruby < 2.5)
 inherit_from:
   - https://raw.githubusercontent.com/RadiusNetworks/radius-spec/master/common_rubocop.yml
@@ -120,6 +136,8 @@ When using the raw URL you may need to add the following to the project's
 .rubocop-https---raw-githubusercontent-com-RadiusNetworks-radius-spec-master-common-rubocop-yml
 ```
 
+#### General Inheritance Notes
+
 Be sure to include the project's local `.rubocop_todo.yml` **after** inheriting
 the base configuration so that they take precedence. Also, use the directive
 `inherit_mode` to specify which array configurations to merge together instead
@@ -137,6 +155,7 @@ inherit_from: .rubocop_todo.yml
 inherit_mode:
   merge:
     - Exclude
+    - IgnoredPatterns
 
 Style/For:
   inherit_mode:
@@ -230,7 +249,7 @@ constant so no changes need to be made if that's your preference.
 
 Attribute keys may be defined using either strings or symbols. However, they
 will be stored internally as symbols. This means that when an object instance
-is create using the factory the attribute hash will be provided to `new` with
+is created using the factory the attribute hash will be provided to `new` with
 symbol keys.
 
 ##### Dynamic Attribute Values (i.e. Generators)
@@ -399,26 +418,26 @@ There are a few behaviors to note for using the builder:
 
 ##### Optional Block
 
-Both `build` and `create` support providing an optional block. This block is
+Both `build` and `build!` support providing an optional block. This block is
 passed directly to `new` when creating the object. This is to support the
 common Ruby idiom of yielding `self` within initialize:
 
-  ```ruby
-  class AnyClass
-    def initialize(attrs = {})
-      # setup attrs
-      yield self if block_given?
-    end
+```ruby
+class AnyClass
+  def initialize(attrs = {})
+    # setup attrs
+    yield self if block_given?
   end
+end
 
-  RSpec.describe AnyClass, :model_factory do
-    it "passes the block to the object initializer" do
-      block_capture = nil
-      an_object = build("AnyClass") { |instance| block_capture = instance }
-      expect(block_capture).to be an_object
-    end
+RSpec.describe AnyClass, :model_factory do
+  it "passes the block to the object initializer" do
+    block_capture = nil
+    an_object = build("AnyClass") { |instance| block_capture = instance }
+    expect(block_capture).to be an_object
   end
-  ```
+end
+```
 
 Since Ruby always supports passing a block to a method, even if the method does
 not use the block, it's possible the block will not run if the class being
@@ -432,29 +451,328 @@ this feature.
 
 We suggest that you create instances using the following syntax:
 
-  ```ruby
-  created_instance = build("AnyClass").tap(&:save!)
-  ```
+```ruby
+let(:an_instance) { build("AnyClass") }
+
+before do
+  an_instance.save!
+end
+```
 
 Or alternatively:
 
-  ```ruby
-  let(:an_instance) { build("AnyClass") }
-
-  before do
-    an_instance.save!
-  end
-  ```
+```ruby
+created_instance = build("AnyClass")
+created_instance.save!
+```
 
 This way it is explicit what objects need to be persisted and in what order.
 
-However, many of our existing projects use a legacy `create` helper. This is
-simply a wrapper around `build.tap(&:save!)`, but it supports omitting the
-`save!` call for objects which do not support it.
+This can get tedious at times, especially for those who only need to create an
+object to embed as an attribute of another object:
+
+```ruby
+collaborator = build("AnotherClass")
+collaborator.save!
+
+# collaborator is not used against directly after this line
+created_instance = build("AnyClass", collaborator: collaborator)
+created_instance.save!
+```
+
+For these cases the `build!` helper is available. This is simply an alias for
+`build.tap(&:save!)`, but it supports omitting the `save!` call for objects
+which do not support it. While it provides a safety guarantee that `save!` will
+be called (instead of potentially `save`) it is less explicit.
+
+```ruby
+created_instance = build("AnyClass", collaborator: build!("AnotherClass"))
+created_instance.save!
+```
+
+We still discourage the use of `build!` directly in `let` blocks for all of the
+above mentioned reasons.
+
+##### Legacy "Creating" Instances
+
+Many of our existing projects use a legacy `create` helper. This is simply an
+alias for `build!`. It is provided only for backwards compatibility support and
+will be removed in a future release. New code should not use this method.
+
+```ruby
+created_instance = create("AnyClass")
+```
+
+### Negated Matchers
+
+This gem defines the following [negated matchers](https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/define-negated-matcher)
+to allow for use [composing matchers](https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/composing-matchers)
+and with [compound expectations](https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/compound-expectations).
+
+| Matcher               | Inverse Of |
+|-----------------------|------------|
+| `exclude`             | [`include`](https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/built-in-matchers/include-matcher) |
+| `excluding`           | [`including`](https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/built-in-matchers/include-matcher) |
+| `not_eq`              | [`eq`](https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/built-in-matchers/equality-matchers#compare-using-eq-(==)) |
+| `not_change`          | [`change`](https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/built-in-matchers/change-matcher) |
+| `not_raise_error`     | [`raise_error`](https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/built-in-matchers/raise-error-matcher) |
+| `not_raise_exception` | [`raise_exception`](https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/built-in-matchers/raise-error-matcher) |
+
+#### Composing Matchers
+
+There is no equivalent of `not_to` for composed matchers when only a subset of
+the values needs to be negated. The negated matchers allow this type of fine
+grain comparison:
+
+```ruby
+x = [1, 2, :value]
+expect(x).to contain_exactly(be_odd, be_even, not_eq(:target))
+```
+
+This also works for verifying / stubbing a message with argument constraints:
+
+```ruby
+allow(obj).to receive(:meth).with(1, 2, not_eq(5))
+obj.meth(1, 2, 3)
+expect(obj).to have_received(:meth).with(not_eq(2), 2, 3)
+```
+
+This is great for verifying option hashes:
+
+```ruby
+expect(obj).to have_received(:meth).with(
+  some_value,
+  excluding(:some_opt, :another_opt),
+)
+```
+
+#### Compound Negated Matchers
+
+Normally it's not possible to chain to a negative match:
+
+```ruby
+a = b = 0
+expect {
+  a = 1
+}.not_to change {
+  b
+}.from(0).and change {
+  a
+}.to(1)
+```
+
+Fails with:
+
+    NotImplementedError:
+      `expect(...).not_to matcher.and matcher` is not supported, since it creates
+      a bit of an ambiguity. Instead, define negated versions of whatever
+      matchers you wish to negate with `RSpec::Matchers.define_negated_matcher`
+      and use `expect(...).to matcher.and matcher`.
+
+Per the error the negated matcher allows for the following:
+
+```ruby
+a = b = 0
+expect {
+  a = 1
+}.to change {
+  a
+}.to(1).and not_change {
+  b
+}.from(0)
+```
+
+Similarly, complex expectations can be set on lists:
+
+```ruby
+a = %i[red blue green]
+expect(a).to include(:red).and exclude(:yellow)
+expect(a).to exclude(:yellow).and include(:red)
+```
+
+### Working with Temp Files
+
+These helpers are meant to ease the creation of temporary files to either stub
+the data out or provide a location for data to be saved then verified.
+
+In the case of file stubs, using these helpers allows you to co-locate the file
+data with the specs. This makes it easy for someone to read the spec and
+understand the test case; instead of having to find a fixture file and look at
+its data. This also makes it easy to change the data between specs, allowing
+them to focus on just what they need.
+
+#### Usage
+
+There are multiple ways you can use these helpers. Which method you choose
+depends on how much perceived magic/syntactic sugar you want:
+
+  - Call the helpers directly on the module:
+
+    ```ruby
+    require 'radius/spec/tempfile'
+
+    def write_hello_world(filepath)
+      File.write filepath, "Hello World"
+    end
+
+    Radius::Spec::Tempfile.using_tempfile do |pathname|
+      write_hello_world pathname
+      File.read(pathname)
+      # => "Hello World"
+    end
+    ```
+  - Include the helper methods explicitly:
+
+    ```ruby
+    require 'radius/spec/tempfile'
+
+    RSpec.describe AnyClass do
+      include Radius::Spec::Tempfile
+
+      it "includes the file helpers" do
+        using_tempfile do |pathname|
+          code_under_test pathname
+          expect(pathname.read).to eq "Any written data"
+        end
+      end
+    end
+    ```
+  - Include the helper methods via metadata:
+
+    ```ruby
+    RSpec.describe AnyClass do
+      it "includes the file helpers", :tempfile do
+        using_tempfile do |pathname|
+          code_under_test pathname
+          expect(pathname.read).to eq "Any written data"
+        end
+      end
+    end
+    ```
+
+    When using this metadata option you do not need to explicitly require the
+    tempfile feature. This gem registers metadata with the RSpec configuration
+    when it loads and `RSpec` is defined. When the metadata is first used it
+    will automatically require the tempfile feature and include the helpers.
+
+    Any of following metadata will include the factory helpers:
+
+      - `:tempfile`
+      - `:tmpfile`
+
+There are a few additional behaviors to note:
+
+  - Data can be stubbed by the helper through the `data` keyword arg:
+
+    ```ruby
+    stub_data = "Any file stub data text."
+    Radius::Spec::Tempfile.using_tempfile(data: stub_data) do |stubpath|
+      File.read(stubpath)
+      # => "Any file stub data text."
+    end
+    ```
+
+    It can even be inlined using heredocs:
+
+    ```ruby
+    Radius::Spec::Tempfile.using_tempfile(data: <<~TEXT) do |stubpath|
+      Any file stub data text.
+    TEXT
+      # Yard formats heredoc args oddly
+      File.read(stubpath)
+      # => "Any file stub data text.\n"
+    end
+    ```
+
+    > NOTE: That when inlining like this heredocs add an extra new line. To
+    > remove it use `.chomp` on the kwarg:
+    >
+    > ```ruby
+    > using_tempfile(data: <<~TEXT.chomp) do |pathname|
+    >   This has no newline.
+    > TEXT
+    >   # ...
+    > end
+    > ```
+
+  - Additional arguments and options are forwarded directly to
+    [Tempfile.create](https://ruby-doc.org/stdlib/libdoc/tempfile/rdoc/Tempfile.html#method-c-create)
+
+    This allows you to set custom file extensions:
+
+    ```ruby
+    Radius::Spec::Tempfile.using_tempfile(%w[custom_name .myext]) do |pathname|
+      pathname.extname
+      # => ".myext"
+    end
+    ```
+
+    Or change the file encoding:
+
+    ```ruby
+    Radius::Spec::Tempfile.using_tempfile(encoding: "ISO-8859-1", data: <<~DATA) do |pathname|
+      Résumé
+    DATA
+      # Yard formats heredoc args oddly
+      File.read(pathname)
+      # => "R\xE9sum\xE9\n"
+    end
+    ```
+
+### Common VCR Configuration
+
+A project must include both [`vcr`](https://rubygems.org/gems/vcr) and
+[`webmock`](https://rubygems.org/gems/webmock) to use this configuration.
+Neither of those gems will be installed as dependencies of this gem. This is
+intended to give projects more flexibility in choosing which additional features
+they will use.
+
+The main `radius/spec/rspec` setup will load the common VCR configuration
+automatically when a spec is tagged with the `:vcr` metadata. This will
+configure VCR to:
+
+  - save specs to `/spec/cassettes`
+
+  - use record mode `once` when a single spec or spec file is run
+
+    This helps ease the development of new specs without requiring any
+    configuration / setting changes.
+
+  - uses record mode `none` otherwise, along setting VCR to fail when unused
+    interactions remain in a cassette
+
+    This is intended to better alert developers to unexpected side effects of
+    changes as any addition or removal of a request will cause a failure.
+
+  - all `Authorization` HTTP headers are filtered by default
+
+    This is a common oversight when recording specs. Often token based
+    authentication is picked up by the other filtered environment settings, but
+    basic authentication is not. Additionally, certain types of digest
+    authentication may cause specs to leak state. This filtering guards all of
+    these cases from accidental credential leak.
+
+  - the following common sensitive, or often environment variable, settings are
+    filtered
+
+    Those settings which often change between developer machines, and even the
+    CI server, can cause for flaky specs. It may also be frustrating for
+    developers to have to adjust their local systems to match others just to
+    get a few specs to pass. This is intended to help mitigate those issues:
+
+    - `AWS_ACCESS_KEY_ID`
+    - `AWS_SECRET_ACCESS_KEY`
+    - `GOOGLE_CLIENT_ID`
+    - `GOOGLE_CLIENT_SECRET`
+    - `RADIUS_OAUTH_PROVIDER_APP_ID`
+    - `RADIUS_OAUTH_PROVIDER_APP_SECRET`
+    - `RADIUS_OAUTH_PROVIDER_URL`
+
+  - a project's local `support/vcr.rb` file will be loaded after the common
+    VCR configuration loads; if it's available
 
-  ```ruby
-  created_instance = create("AnyClass")
-  ```
+    This allows projects to overwrite common settings if they need to, as well,
+    as add on addition settings or filtering of data.
 
 ## Development