Add RSpec

.rubocop.yml

@@ -1,6 +1,7 @@
 require:
   - rubocop-performance
   - rubocop-rake
+  - rubocop-rspec
 
 AllCops:
   TargetRubyVersion: 3.0
@@ -32,6 +33,18 @@ Metrics/ParameterLists:
   Exclude:
     - 'lib/diversipub/main.rb'
 
+RSpec/ContextWording:
+  Prefixes:
+    - 'and'
+    - 'for'
+    - 'using'
+    - 'when'
+    - 'with'
+    - 'without'
+
+RSpec/ExampleLength:
+  CountAsOne: ['array', 'hash', 'heredoc']
+
 Style/AndOr:
   EnforcedStyle: conditionals
 

.simplecov

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+if ENV['SKIP_COVERAGE'].to_s.empty?
+  SimpleCov.start do
+    # TODO: minimum_coverage 95
+
+    add_filter '/spec/'
+  end
+end

Gemfile

@@ -4,3 +4,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in diversipub.gemspec
 gemspec
+
+gem 'simplecov', require: false

Rakefile

@@ -3,10 +3,15 @@
 require 'bundler/gem_tasks'
 
 CLEAN << '.yardoc'
+CLEAN << 'coverage'
 CLEAN << 'doc'
+CLEAN << 'spec/examples.txt'
 
 desc 'Run default checks'
-task default: %i[lint]
+task default: %i[test lint]
+
+desc 'Run tests'
+task test: :spec
 
 desc 'Run code analysis tools'
 task lint: %i[rubocop yard:cov]
@@ -14,6 +19,13 @@ task lint: %i[rubocop yard:cov]
 desc 'Fix code style (rubocop --auto-correct)'
 task fix: 'rubocop:auto_correct'
 
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new
+rescue LoadError
+  nil
+end
+
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new

diversipub.gemspec

@@ -50,7 +50,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler',             '~> 2.4'
   spec.add_development_dependency 'pry',                 '~> 0.14'
   spec.add_development_dependency 'rake',                '~> 13.0'
+  spec.add_development_dependency 'rspec',               '~> 3.12'
+  spec.add_development_dependency 'rubocop',             '~> 1.50'
   spec.add_development_dependency 'rubocop-performance', '~> 1.13'
   spec.add_development_dependency 'rubocop-rake',        '~> 0.6'
+  spec.add_development_dependency 'rubocop-rspec',       '~> 2.7'
+  spec.add_development_dependency 'simplecov',           '~> 0.22'
   spec.add_development_dependency 'yard',                '~> 0.9'
 end

spec/lib/diversipub_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Diversipub do
+  describe '::VERSION' do
+    specify do
+      expect(described_class::VERSION).to match(/\A\d+\.\d+\.\d+\z/)
+    end
+  end
+end

spec/spec_helper.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# This should be on the top of the file.
+require 'simplecov'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'diversipub'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end