github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/ruby-client/spec_helper.mustache (about)

     1  # load the gem
     2  require '{{{gemName}}}'
     3  require 'webmock/rspec'
     4  
     5  # The following  was generated by the `rspec --init` command. Conventionally, all
     6  # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
     7  # The generated `.rspec` file contains `--require spec_helper` which will cause
     8  # this file to always be loaded, without a need to explicitly require it in any
     9  # files.
    10  #
    11  # Given that it is always loaded, you are encouraged to keep this file as
    12  # light-weight as possible. Requiring heavyweight dependencies from this file
    13  # will add to the boot time of your test suite on EVERY test run, even for an
    14  # individual file that may not need all of that loaded. Instead, consider making
    15  # a separate helper file that requires the additional dependencies and performs
    16  # the additional setup, and require it from the spec files that actually need
    17  # it.
    18  #
    19  # The `.rspec` file also contains a few flags that are not defaults but that
    20  # users commonly want.
    21  #
    22  # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
    23  RSpec.configure do |config|
    24    # rspec-expectations config goes here. You can use an alternate
    25    # assertion/expectation library such as wrong or the stdlib/minitest
    26    # assertions if you prefer.
    27    config.expect_with :rspec do |expectations|
    28      # This option will default to `true` in RSpec 4. It makes the `description`
    29      # and `failure_message` of custom matchers include text for helper methods
    30      # defined using `chain`, e.g.:
    31      #     be_bigger_than(2).and_smaller_than(4).description
    32      #     # => "be bigger than 2 and smaller than 4"
    33      # ...rather than:
    34      #     # => "be bigger than 2"
    35      expectations.include_chain_clauses_in_custom_matcher_descriptions = true
    36    end
    37  
    38    # rspec-mocks config goes here. You can use an alternate test double
    39    # library (such as bogus or mocha) by changing the `mock_with` option here.
    40    config.mock_with :rspec do |mocks|
    41      # Prevents you from mocking or stubbing a method that does not exist on
    42      # a real object. This is generally recommended, and will default to
    43      # `true` in RSpec 4.
    44      mocks.verify_partial_doubles = true
    45    end
    46  
    47  # The settings below are suggested to provide a good initial experience
    48  # with RSpec, but feel free to customize to your heart's content.
    49  =begin
    50    # These two settings work together to allow you to limit a spec run
    51    # to individual examples or groups you care about by tagging them with
    52    # `:focus` metadata. When nothing is tagged with `:focus`, all examples
    53    # get run.
    54    config.filter_run :focus
    55    config.run_all_when_everything_filtered = true
    56  
    57    # Allows RSpec to persist some state between runs in order to support
    58    # the `--only-failures` and `--next-failure` CLI options. We recommend
    59    # you configure your source control system to ignore this file.
    60    config.example_status_persistence_file_path = "spec/examples.txt"
    61  
    62    # Limits the available syntax to the non-monkey patched syntax that is
    63    # recommended. For more details, see:
    64    #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
    65    #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
    66    #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
    67    config.disable_monkey_patching!
    68  
    69    # This setting enables warnings. It's recommended, but in some cases may
    70    # be too noisy due to issues in dependencies.
    71    config.warnings = true
    72  
    73    # Many RSpec users commonly either run the entire suite or an individual
    74    # file, and it's useful to allow more verbose output when running an
    75    # individual spec file.
    76    if config.files_to_run.one?
    77      # Use the documentation formatter for detailed output,
    78      # unless a formatter has already been configured
    79      # (e.g. via a command-line flag).
    80      config.default_formatter = 'doc'
    81    end
    82  
    83    # Print the 10 slowest examples and example groups at the
    84    # end of the spec run, to help surface which specs are running
    85    # particularly slow.
    86    config.profile_examples = 10
    87  
    88    # Run specs in random order to surface order dependencies. If you find an
    89    # order dependency and want to debug it, you can fix the order by providing
    90    # the seed, which is printed after each run.
    91    #     --seed 1234
    92    config.order = :random
    93  
    94    # Seed global randomization in this process using the `--seed` CLI option.
    95    # Setting this allows you to use `--seed` to deterministically reproduce
    96    # test failures related to randomization by passing the same `--seed` value
    97    # as the one that triggered the failure.
    98    Kernel.srand config.seed
    99  =end
   100  end