radius-spec 0.4.0 → 0.8.0

data/lib/radius/spec/model_factory.rb

@@ -268,6 +268,7 @@ module Radius
         def safe_transform(value)
           return value.call if value.is_a?(Proc)
           return value if value.frozen?
+
           value.dup
         end
 
@@ -426,53 +427,63 @@ module Radius
 
       # Convenience wrapper for building, and persisting, a model template.
       #
-      # This is a thin wrapper around `build(name, attrs).tap(&:save!)`. The
-      # persistence message `save!` will only be called on objects which
-      # respond to it.
-      #
-      # ### Avoid for New Code
+      # This is a thin wrapper around:
       #
-      # It is strongly suggested that you avoid using `create` for new code.
-      # Instead be explicit about when and how objects are persisted. This
-      # allows you to have fine grain control over how your data is setup.
+      # ```ruby
+      # build(name, attrs, &block).tap(&:save!)
+      # ```
       #
-      # We suggest that you create instances which need to be persisted before
-      # your specs using the following syntax:
+      # The persistence message `save!` will only be called on objects which
+      # respond to it.
       #
-      # ```ruby
-      # let(:an_instance) { build("AnyClass") }
+      # @note It is generally suggested that you avoid using `build!` for new
+      #   code. Instead be explicit about when and how objects are persisted.
+      #   This allows you to have fine grain control over how your data is
+      #   setup.
       #
-      # before do
-      #   an_instance.save!
-      # end
-      # ```
+      #   We suggest that you create instances which need to be persisted
+      #   before your specs using the following syntax:
       #
-      # Alternatively if you really want for the instance be lazy instantiated,
-      # and persisted, pass the appropriate persistence method as the block:
+      #   ```ruby
+      #   let(:an_instance) { build("AnyClass") }
       #
-      # ```ruby
-      # let(:an_instance) { build("AnyClass", &:save!) }
-      # ```
+      #   before do
+      #     an_instance.save!
+      #   end
+      #   ```
       #
       # @param (see .build)
       # @return (see .build)
       # @raise (see .build)
       # @see .build
       # @see .define_factory
-      def create(name, custom_attrs = {}, &block)
+      # @since 0.5.0
+      def build!(name, custom_attrs = {}, &block)
         instance = build(name, custom_attrs, &block)
         instance.save! if instance.respond_to?(:save!)
         instance
       end
+
+      # Legacy helper provided for backwards compatibility support.
+      #
+      # This provides the same behavior as {.build!} and will be removed in a
+      # future release.
+      #
+      # @param (see .build)
+      # @return (see .build)
+      # @raise (see .build)
+      # @see .build
+      # @see .define_factory
+      def create(name, custom_attrs = {}, &block)
+        build!(name, custom_attrs, &block)
+      end
     end
   end
 end
 
 # Try to load the factories defined for the specs
-# rubocop:disable Lint/HandleExceptions
 begin
   require 'support/model_factories'
 rescue LoadError
   # Ignore as this is an optional convenience feature
 end
-# rubocop:enable Lint/HandleExceptions

data/lib/radius/spec/rails.rb

@@ -7,7 +7,7 @@ require 'rspec/rails'
 
 RSpec.configure do |config|
   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  config.fixture_path = ::Rails.root.join("spec", "fixtures")
+  config.fixture_path = ::Rails.root.join("spec", "fixtures").to_path
 
   # If you're not using ActiveRecord, or you'd prefer not to run each of your
   # examples within a transaction, remove the following line or assign false

data/lib/radius/spec/rspec/negated_matchers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Define negated matchers for use with composable matchers and compound
+# expectations.
+#
+# @see https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/composing-matchers
+# @see https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/compound-expectations
+RSpec::Matchers.define_negated_matcher :exclude, :include
+RSpec::Matchers.define_negated_matcher :excluding, :including
+RSpec::Matchers.define_negated_matcher :not_eq, :eq
+
+# Allows us to check that a block doesn't raise an exception while also
+# checking for other changes using compound expectations; since you can't chain
+# a negative (`not_to`) with any other matchers
+#
+# @see https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/compound-expectations
+RSpec::Matchers.define_negated_matcher :not_change, :change
+RSpec::Matchers.define_negated_matcher :not_raise_error, :raise_error
+RSpec::Matchers.define_negated_matcher :not_raise_exception, :raise_exception

data/lib/radius/spec/rspec.rb

@@ -109,6 +109,11 @@ RSpec.configure do |config|
     config.include Radius::Spec::ModelFactory, :model_factory, :model_factories
   end
 
+  config.when_first_matching_example_defined(:tempfile, :tmpfile) do
+    require 'radius/spec/tempfile'
+    config.include Radius::Spec::Tempfile, :tempfile, :tmpfile
+  end
+
   config.when_first_matching_example_defined(type: :controller) do
     require 'radius/spec/model_factory'
     config.include Radius::Spec::ModelFactory, type: :controller
@@ -124,6 +129,11 @@ RSpec.configure do |config|
     config.include Radius::Spec::ModelFactory, type: :job
   end
 
+  config.when_first_matching_example_defined(type: :mailer) do
+    require 'radius/spec/model_factory'
+    config.include Radius::Spec::ModelFactory, type: :mailer
+  end
+
   config.when_first_matching_example_defined(type: :model) do
     require 'radius/spec/model_factory'
     config.include Radius::Spec::ModelFactory, type: :model
@@ -138,4 +148,14 @@ RSpec.configure do |config|
     require 'radius/spec/model_factory'
     config.include Radius::Spec::ModelFactory, type: :system
   end
+
+  config.when_first_matching_example_defined(:webmock) do
+    require 'webmock/rspec'
+  end
+
+  config.when_first_matching_example_defined(:vcr, :vcr_record, :vcr_record_new) do
+    require 'radius/spec/vcr'
+  end
 end
+
+require 'radius/spec/rspec/negated_matchers'

data/lib/radius/spec/tempfile.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'tempfile'
+
+module Radius
+  module Spec
+    # Temporary file helpers
+    #
+    # 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.
+    #
+    # To make these helpers available require them after the gem:
+    #
+    # ```ruby
+    # require 'radius/spec'
+    # require 'radius/spec/tempfile'
+    # ```
+    #
+    # ### Including Helpers in Specs
+    #
+    # 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
+    #   - manually include the helper methods in the specs
+    #   - use metadata to auto load this feature and include it in the specs
+    #
+    # When using the metadata option you do not need to explicitly require the
+    # module. This gem registers metadata with the RSpec configuration when it
+    # loads and `RSpec` is defined. When the matching metadata is first used it
+    # will automatically require and include the helpers.
+    #
+    # Any of following metadata will include the factory helpers:
+    #
+    #   - `:tempfile`
+    #   - `:tmpfile`
+    #
+    # @example use a helper directly in specs
+    #   require 'radius/spec/tempfile'
+    #
+    #   RSpec.describe AnyClass do
+    #     it "includes the file helpers" do
+    #       Radius::Spec::Tempfile.using_tempfile do |pathname|
+    #         code_under_test pathname
+    #         expect(pathname.read).to eq "Any written data"
+    #       end
+    #     end
+    #   end
+    # @example manually include the helpers
+    #   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
+    # @example use metadata to auto include the helpers
+    #   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
+    # @since 0.5.0
+    module Tempfile
+    module_function
+
+      # Convenience wrapper for managaing temporary files.
+      #
+      # This creates a temporary file and yields its path to the provided
+      # block. When the block returns the temporary file is deleted.
+      #
+      # ### Optional Parameters
+      #
+      # The block is required. All other parameters are optional. All
+      # parameters except `data` are Ruby version dependent and will be
+      # forwarded directly to the stdlib's
+      # {https://ruby-doc.org/stdlib/libdoc/tempfile/rdoc/Tempfile.html#method-c-create
+      # `Tempfile.create`}. The when the `data` parameter is provided it's
+      # contents will be written to the temporary file prior to yielding to the
+      # block.
+      #
+      # @example creating a tempfile to pass to code
+      #   def write_hello_world(filepath)
+      #     File.write filepath, "Hello World"
+      #   end
+      #
+      #   Radius::Spec::Tempfile.using_tempfile do |pathname|
+      #     write_hello_world pathname
+      #   end
+      # @example creating a file stub
+      #   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."
+      #     code_under_test stubpath
+      #   end
+      # @example creating a file stub inline
+      #   Radius::Spec::Tempfile.using_tempfile(data: <<~TEXT) do |stubpath|
+      #     Any file stub data text.
+      #   TEXT
+      #     # File.read(stubpath)
+      #     # => "Any file stub data text.\n"
+      #     code_under_test stubpath
+      #   end
+      # @example creating a file stub inline without trailing newline
+      #   Radius::Spec::Tempfile.using_tempfile(data: <<~TEXT.chomp) do |stubpath|
+      #     Any file stub data text.
+      #   TEXT
+      #     # File.read(stubpath)
+      #     # => "Any file stub data text."
+      #     code_under_test stubpath
+      #   end
+      # @example writing binary data inline
+      #   Radius::Spec::Tempfile.using_tempfile(encoding: Encoding::BINARY, data: <<~BIN.chomp) do |binpath|
+      #     \xC8\x90\xC5\x9D\xE1\xB9\x95\xC4\x93\xC4\x89
+      #   BIN
+      #     # File.read(binpath)
+      #     # => "Ȑŝṕēĉ"
+      #     code_under_test binpath
+      #   end
+      # @param args [Object] addition file creation options
+      #
+      #   Passed directly to {https://ruby-doc.org/stdlib/libdoc/tempfile/rdoc/Tempfile.html#method-c-create
+      #   `Tempfile.create`}; see the stdlib docs for details on available
+      #   options.
+      # @param data [String] stub data to write to the file before yielding
+      # @param kwargs [Hash{Symbol => Object}] addition file creation options
+      #
+      #   Passed directly to {https://ruby-doc.org/stdlib/libdoc/tempfile/rdoc/Tempfile.html#method-c-create
+      #   `Tempfile.create`}; see the stdlib docs for details on available
+      #   options.
+      # @yieldparam pathname [Pathname] {https://ruby-doc.org/stdlib/libdoc/pathname/rdoc/Pathname.html path}
+      #   of the created temporary file
+      # @note A block must be provided
+      # @see https://ruby-doc.org/stdlib/libdoc/pathname/rdoc/Pathname.html Pathname
+      # @see https://ruby-doc.org/stdlib/libdoc/tempfile/rdoc/Tempfile.html Tempfile
+      def using_tempfile(*args, data: nil, **kwargs)
+        args << 'tmpfile' if args.empty?
+        ::Tempfile.create(*args, **kwargs) do |f|
+          f.write(data)
+          f.close
+          yield Pathname(f.path)
+        end
+      end
+    end
+  end
+end

data/lib/radius/spec/vcr.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'webmock/rspec'
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/cassettes"
+  config.hook_into :webmock
+  config.configure_rspec_metadata!
+  config.ignore_localhost = true
+
+  record_mode = case
+                when RSpec.configuration.files_to_run.one?
+                  # When developing new features we often run new specs in
+                  # isolation as we write the code. This is the time to allow
+                  # creating the cassettes.
+                  :once
+                when ENV['CI']
+                  # Never let CI record
+                  :none
+                else
+                  # Default to blocking new requests to catch issues
+                  :none
+                end
+  config.default_cassette_options = {
+    record: record_mode,
+
+    # Required for working proxy
+    update_content_length_header: true,
+
+    # Raise errors when recorded cassettes no longer match interactions
+    allow_unused_http_interactions: false,
+  }
+
+  # Filter out common sensitive or environment specific data
+  %w[
+    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
+  ].each do |secret|
+    config.filter_sensitive_data("<#{secret}>") { ENV[secret] }
+
+    config.filter_sensitive_data("<#{secret}_FORM>") {
+      URI.encode_www_form_component(ENV[secret]) if ENV[secret]
+    }
+
+    config.filter_sensitive_data("<#{secret}_URI>") {
+      ERB::Util.url_encode(ENV[secret]) if ENV[secret]
+    }
+
+    config.filter_sensitive_data('<AUTHORIZATION_HEADER>') { |interaction|
+      interaction.request.headers['Authorization']&.first
+    }
+  end
+end
+
+RSpec.configure do |config|
+  {
+    vcr_record: :once,
+    vcr_record_new: :new_episodes,
+  }.each do |tag, record_mode|
+    config.define_derived_metadata(tag) do |metadata|
+      case metadata[:vcr]
+      when nil, true
+        metadata[:vcr] = { record: record_mode }
+      when Hash
+        metadata[:vcr][:record] = record_mode
+      else
+        raise "Unknown VCR metadata value: #{metadata[:vcr].inspect}"
+      end
+    end
+  end
+
+  config.define_derived_metadata(:focus) do |metadata|
+    # VCR is flagged as falsey
+    next if metadata.key?(:vcr) && !metadata[:vcr]
+
+    case metadata[:vcr]
+    when nil, true
+      metadata[:vcr] = { record: :once }
+    when Hash
+      metadata[:vcr][:record] ||= :once
+    else
+      raise "Unknown VCR metadata value: #{metadata[:vcr].inspect}"
+    end
+  end
+end
+
+# Try to any custom VCR config for the app
+begin
+  require 'support/vcr'
+rescue LoadError
+  # Ignore as this is an optional convenience feature
+end

data/lib/radius/spec/version.rb

@@ -2,6 +2,6 @@
 
 module Radius
   module Spec
-    VERSION = "0.4.0"
+    VERSION = "0.8.0"
   end
 end

data/radius-spec.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata      = {
     "bug_tracker_uri" => "https://github.com/RadiusNetworks/radius-spec/issues",
-    "changelog_uri"   => "https://github.com/RadiusNetworks/radius-spec/blob/v#{Radius::Spec::VERSION}/CHANGELOG.md",
+    "changelog_uri" => "https://github.com/RadiusNetworks/radius-spec/blob/v#{Radius::Spec::VERSION}/CHANGELOG.md",
     "source_code_uri" => "https://github.com/RadiusNetworks/radius-spec/tree/v#{Radius::Spec::VERSION}",
   }
   spec.summary       = "Radius Networks RSpec setup and plug-ins"
@@ -21,18 +21,19 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/RadiusNetworks/radius-spec"
   spec.license       = "Apache-2.0"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f|
     f.match(%r{^(test|spec|features)/})
-  end
+  }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.5" # rubocop:disable Gemspec/RequiredRubyVersion
 
   spec.add_runtime_dependency "rspec", "~> 3.7"
-  spec.add_runtime_dependency "rubocop", "~> 0.58.1"
+  spec.add_runtime_dependency "rubocop", "~> 0.82.0"
+  spec.add_runtime_dependency "rubocop-rails", "~> 2.5.2"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "bundler", ">= 2.2.10"
+  spec.add_development_dependency "rake", ">= 12.0", "< 14.0"
 end